TrafficMirrorSession

• Implements: ITrafficMirrorSession

This class encapsulates and extends the ROS resource type ALIYUN::VPC::TrafficMirrorSession.

Initializers

import ros_cdk_vpc
ros_cdk_vpc.TrafficMirrorSession(
  scope: Construct,
  id: str,
  priority: typing.Union[typing.Union[int, float], IResolvable],
  traffic_mirror_filter_id: typing.Union[str, IResolvable],
  traffic_mirror_source_ids: typing.Union[IResolvable, typing.List[typing.Union[str, IResolvable]]],
  traffic_mirror_target_id: typing.Union[str, IResolvable],
  traffic_mirror_target_type: typing.Union[str, IResolvable],
  enabled: typing.Union[bool, IResolvable] = None,
  packet_length: typing.Union[typing.Union[int, float], IResolvable] = None,
  resource_group_id: typing.Union[str, IResolvable] = None,
  tag: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, RosTag]]] = None,
  traffic_mirror_session_description: typing.Union[str, IResolvable] = None,
  traffic_mirror_session_name: typing.Union[str, IResolvable] = None,
  virtual_network_id: typing.Union[typing.Union[int, float], IResolvable] = None,
  enable_resource_property_constraint: bool = None
)

scope^Required

• Type: ros_cdk_core.Construct

id^Required

• Type: str

priority^Required

• Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

Property priority: The priority of the traffic mirror session.

Valid values: 1 to 32766. A smaller value indicates a higher priority. You cannot specify identical priorities for traffic mirror sessions that are created in the same region by using the same account.

traffic_mirror_filter_id^Required

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property trafficMirrorFilterId: The ID of the filter.

traffic_mirror_source_ids^Required

• Type: typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[str, ros_cdk_core.IResolvable]]]

Property trafficMirrorSourceIds: undefined.

traffic_mirror_target_id^Required

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property trafficMirrorTargetId: The ID of the traffic mirror destination.

You can specify only an elastic network interface (ENI) or a Server Load Balancer (SLB) instance as a traffic mirror destination.

traffic_mirror_target_type^Required

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property trafficMirrorTargetType: The type of the traffic mirror destination.

Valid values:

• NetworkInterface: an ENI
• SLB: an SLB instance

enabled^Optional

• Type: typing.Union[bool, ros_cdk_core.IResolvable]

Property enabled: Specifies whether to enable the traffic mirror session.

Valid values:

• false (default): does not enable the traffic mirror session.
• true: enables the traffic mirror session.

packet_length^Optional

• Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

Property packetLength: The maximum transmission unit (MTU).

Default value: 1500.

resource_group_id^Optional

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property resourceGroupId: The ID of the resource group to which the mirrored traffic belongs.

tag^Optional

• Type: typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, ros_cdk_core.RosTag]]]

Property tag:.

traffic_mirror_session_description^Optional

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property trafficMirrorSessionDescription: The description of the traffic mirror session.

The description must be 1 to 256 characters in length and cannot start with http:// or https://.

traffic_mirror_session_name^Optional

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property trafficMirrorSessionName: The name of the traffic mirror session.

The name must be 1 to 128 characters in length and cannot start with http:// or https://.

virtual_network_id^Optional

• Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

Property virtualNetworkId: The VXLAN network identifier (VNI).

Valid values: 0 to 16777215. You can use VNIs to identify mirrored traffic from different sessions at the traffic mirror destination. You can specify a custom VNI or use a random VNI allocated by the system. If you want the system to randomly allocate a VNI, do not enter a value.

enable_resource_property_constraint^Optional

• Type: bool

Methods

to_string

def to_string() -> str

Returns a string representation of this construct.

synthesize

def synthesize(
  session: ISynthesisSession
) -> None

Allows this construct to emit artifacts into the cloud assembly during synthesis.

This method is usually implemented by framework-level constructs such as Stack and Asset as they participate in synthesizing the cloud assembly.

session^Required

• Type: ros_cdk_core.ISynthesisSession

The synthesis session.

add_condition

def add_condition(
  condition: RosCondition
) -> None

condition^Required

• Type: ros_cdk_core.RosCondition

add_count

def add_count(
  count: typing.Union[typing.Union[int, float], IResolvable]
) -> None

count^Required

• Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

add_dependency

def add_dependency(
  resource: Resource
) -> None

resource^Required

• Type: ros_cdk_core.Resource

add_resource_desc

def add_resource_desc(
  desc: str
) -> None

desc^Required

• Type: str

apply_removal_policy

def apply_removal_policy(
  policy: RemovalPolicy
) -> None

policy^Required

• Type: ros_cdk_core.RemovalPolicy

fetch_condition

def fetch_condition() -> RosCondition

fetch_dependency

def fetch_dependency() -> typing.List[str]

fetch_resource_desc

def fetch_resource_desc() -> str

get_att

def get_att(
  name: str
) -> IResolvable

name^Required

• Type: str

set_metadata

def set_metadata(
  key: str,
  value: typing.Any
) -> None

key^Required

• Type: str

value^Required

• Type: typing.Any

Static Functions

is_construct

import ros_cdk_vpc
ros_cdk_vpc.TrafficMirrorSession.is_construct(
  x: typing.Any
)

Return whether the given object is a Construct.

x^Required

• Type: typing.Any

Properties

node^Required

node: ConstructNode

• Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.

env^Required

env: IResourceEnvironment

• Type: ros_cdk_core.IResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

ref^Required

ref: str

• Type: str

stack^Required

stack: Stack

• Type: ros_cdk_core.Stack

The stack in which this resource is defined.

resource^Optional

resource: RosResource

• Type: ros_cdk_core.RosResource

attr_traffic_mirror_session_id^Required

attr_traffic_mirror_session_id: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Attribute TrafficMirrorSessionId: The ID of the traffic mirror session.

props^Required

props: TrafficMirrorSessionProps

• Type: TrafficMirrorSessionProps