@huaweicloudos/pulumi
Version:
A Pulumi package for creating and managing Huaweicloud cloud resources.
232 lines (231 loc) • 8.43 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Manages a VPC traffic mirror session resource within HuaweiCloud.
*
* ## Import
*
* The traffic mirror session can be imported using `id`, e.g. bash
*
* ```sh
* $ pulumi import huaweicloud:Vpc/trafficMirrorSession:TrafficMirrorSession test <id>
* ```
*/
export declare class TrafficMirrorSession extends pulumi.CustomResource {
/**
* Get an existing TrafficMirrorSession resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param state Any extra arguments used during the lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, state?: TrafficMirrorSessionState, opts?: pulumi.CustomResourceOptions): TrafficMirrorSession;
/**
* Returns true if the given object is an instance of TrafficMirrorSession. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is TrafficMirrorSession;
/**
* The creation time of the traffic mirror session.
*/
readonly createdAt: pulumi.Output<string>;
/**
* Specifies the description of the traffic mirror session.
*/
readonly description: pulumi.Output<string | undefined>;
/**
* Specifies whether the mirror session is enabled. Defaults to **true**.
*/
readonly enabled: pulumi.Output<boolean | undefined>;
/**
* Specifies the name of the traffic mirror session.
*/
readonly name: pulumi.Output<string>;
/**
* Specifies the maximum transmission unit (MTU).
* The valid value is range from `1` to `1,460`, defaults to `96`.
*/
readonly packetLength: pulumi.Output<number>;
/**
* Specifies the mirror session priority. The value range is **1-32766**.
* A smaller value indicates a higher priority.
*/
readonly priority: pulumi.Output<number>;
/**
* Specifies the region in which to create the resource.
* If omitted, the provider-level region will be used.
* Changing this creates a new resource.
*/
readonly region: pulumi.Output<string>;
/**
* Specifies the traffic mirror filter ID used in the session.
*/
readonly trafficMirrorFilterId: pulumi.Output<string>;
/**
* Specifies the mirror source IDs.
* An elastic network interface can be used as a mirror source.
*/
readonly trafficMirrorSources: pulumi.Output<string[]>;
/**
* Specifies the mirror target ID.
*/
readonly trafficMirrorTargetId: pulumi.Output<string>;
/**
* Specifies the mirror target type. The value can be:
* + **eni**: elastic network interface;
* + **elb**: private network load balancer;
*/
readonly trafficMirrorTargetType: pulumi.Output<string>;
/**
* Specifies the mirror source type. The value can be **eni**(elastic network interface).
*/
readonly type: pulumi.Output<string>;
/**
* The latest update time of the traffic mirror session.
*/
readonly updatedAt: pulumi.Output<string>;
/**
* Specifies the VNI, which is used to distinguish mirrored traffic of
* different sessions. The valid value is range from `0` to `16,777,215`, defaults to `1`.
*/
readonly virtualNetworkId: pulumi.Output<number>;
/**
* Create a TrafficMirrorSession resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args: TrafficMirrorSessionArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering TrafficMirrorSession resources.
*/
export interface TrafficMirrorSessionState {
/**
* The creation time of the traffic mirror session.
*/
createdAt?: pulumi.Input<string>;
/**
* Specifies the description of the traffic mirror session.
*/
description?: pulumi.Input<string>;
/**
* Specifies whether the mirror session is enabled. Defaults to **true**.
*/
enabled?: pulumi.Input<boolean>;
/**
* Specifies the name of the traffic mirror session.
*/
name?: pulumi.Input<string>;
/**
* Specifies the maximum transmission unit (MTU).
* The valid value is range from `1` to `1,460`, defaults to `96`.
*/
packetLength?: pulumi.Input<number>;
/**
* Specifies the mirror session priority. The value range is **1-32766**.
* A smaller value indicates a higher priority.
*/
priority?: pulumi.Input<number>;
/**
* Specifies the region in which to create the resource.
* If omitted, the provider-level region will be used.
* Changing this creates a new resource.
*/
region?: pulumi.Input<string>;
/**
* Specifies the traffic mirror filter ID used in the session.
*/
trafficMirrorFilterId?: pulumi.Input<string>;
/**
* Specifies the mirror source IDs.
* An elastic network interface can be used as a mirror source.
*/
trafficMirrorSources?: pulumi.Input<pulumi.Input<string>[]>;
/**
* Specifies the mirror target ID.
*/
trafficMirrorTargetId?: pulumi.Input<string>;
/**
* Specifies the mirror target type. The value can be:
* + **eni**: elastic network interface;
* + **elb**: private network load balancer;
*/
trafficMirrorTargetType?: pulumi.Input<string>;
/**
* Specifies the mirror source type. The value can be **eni**(elastic network interface).
*/
type?: pulumi.Input<string>;
/**
* The latest update time of the traffic mirror session.
*/
updatedAt?: pulumi.Input<string>;
/**
* Specifies the VNI, which is used to distinguish mirrored traffic of
* different sessions. The valid value is range from `0` to `16,777,215`, defaults to `1`.
*/
virtualNetworkId?: pulumi.Input<number>;
}
/**
* The set of arguments for constructing a TrafficMirrorSession resource.
*/
export interface TrafficMirrorSessionArgs {
/**
* Specifies the description of the traffic mirror session.
*/
description?: pulumi.Input<string>;
/**
* Specifies whether the mirror session is enabled. Defaults to **true**.
*/
enabled?: pulumi.Input<boolean>;
/**
* Specifies the name of the traffic mirror session.
*/
name?: pulumi.Input<string>;
/**
* Specifies the maximum transmission unit (MTU).
* The valid value is range from `1` to `1,460`, defaults to `96`.
*/
packetLength?: pulumi.Input<number>;
/**
* Specifies the mirror session priority. The value range is **1-32766**.
* A smaller value indicates a higher priority.
*/
priority: pulumi.Input<number>;
/**
* Specifies the region in which to create the resource.
* If omitted, the provider-level region will be used.
* Changing this creates a new resource.
*/
region?: pulumi.Input<string>;
/**
* Specifies the traffic mirror filter ID used in the session.
*/
trafficMirrorFilterId: pulumi.Input<string>;
/**
* Specifies the mirror source IDs.
* An elastic network interface can be used as a mirror source.
*/
trafficMirrorSources: pulumi.Input<pulumi.Input<string>[]>;
/**
* Specifies the mirror target ID.
*/
trafficMirrorTargetId: pulumi.Input<string>;
/**
* Specifies the mirror target type. The value can be:
* + **eni**: elastic network interface;
* + **elb**: private network load balancer;
*/
trafficMirrorTargetType: pulumi.Input<string>;
/**
* Specifies the mirror source type. The value can be **eni**(elastic network interface).
*/
type?: pulumi.Input<string>;
/**
* Specifies the VNI, which is used to distinguish mirrored traffic of
* different sessions. The valid value is range from `0` to `16,777,215`, defaults to `1`.
*/
virtualNetworkId?: pulumi.Input<number>;
}