TrafficMirrorSession

This class encapsulates and extends the ROS resource type ALIYUN::VPC::TrafficMirrorSession, which is used to create a traffic image session.

Initializers

import com.aliyun.ros.cdk.vpc.TrafficMirrorSession;
TrafficMirrorSession.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .priority(java.lang.Number)
    .priority(IResolvable)
    .trafficMirrorFilterId(java.lang.String)
    .trafficMirrorFilterId(IResolvable)
    .trafficMirrorSourceIds(IResolvable)
    .trafficMirrorSourceIds(java.util.List<java.lang.String)
    .trafficMirrorSourceIds(IResolvable>)
    .trafficMirrorTargetId(java.lang.String)
    .trafficMirrorTargetId(IResolvable)
    .trafficMirrorTargetType(java.lang.String)
    .trafficMirrorTargetType(IResolvable)
//  .enabled(java.lang.Boolean)
//  .enabled(IResolvable)
//  .packetLength(java.lang.Number)
//  .packetLength(IResolvable)
//  .resourceGroupId(java.lang.String)
//  .resourceGroupId(IResolvable)
//  .tag(IResolvable)
//  .tag(java.util.List<IResolvable)
//  .tag(RosTag>)
//  .trafficMirrorSessionDescription(java.lang.String)
//  .trafficMirrorSessionDescription(IResolvable)
//  .trafficMirrorSessionName(java.lang.String)
//  .trafficMirrorSessionName(IResolvable)
//  .virtualNetworkId(java.lang.Number)
//  .virtualNetworkId(IResolvable)
    .build();

Name	Type	Description
scope	com.aliyun.ros.cdk.core.Construct	No description.
id	java.lang.String	No description.
enableResourcePropertyConstraint	java.lang.Boolean	No description.
priority	java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable	Property priority: The priority of the traffic mirror session.
trafficMirrorFilterId	java.lang.String OR com.aliyun.ros.cdk.core.IResolvable	Property trafficMirrorFilterId: The ID of the filter.
trafficMirrorSourceIds	com.aliyun.ros.cdk.core.IResolvable OR java.util.List	Property trafficMirrorSourceIds: undefined.
trafficMirrorTargetId	java.lang.String OR com.aliyun.ros.cdk.core.IResolvable	Property trafficMirrorTargetId: The ID of the traffic mirror destination.
trafficMirrorTargetType	java.lang.String OR com.aliyun.ros.cdk.core.IResolvable	Property trafficMirrorTargetType: The type of the traffic mirror destination.
enabled	java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable	Property enabled: Specifies whether to enable the traffic mirror session.
packetLength	java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable	Property packetLength: The maximum transmission unit (MTU).
resourceGroupId	java.lang.String OR com.aliyun.ros.cdk.core.IResolvable	Property resourceGroupId: The ID of the resource group to which the mirrored traffic belongs.
tag	com.aliyun.ros.cdk.core.IResolvable OR java.util.List	Property tag:.
trafficMirrorSessionDescription	java.lang.String OR com.aliyun.ros.cdk.core.IResolvable	Property trafficMirrorSessionDescription: The description of the traffic mirror session.
trafficMirrorSessionName	java.lang.String OR com.aliyun.ros.cdk.core.IResolvable	Property trafficMirrorSessionName: The name of the traffic mirror session.
virtualNetworkId	java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable	Property virtualNetworkId: The VXLAN network identifier (VNI).

---

scope^Required

• Type: com.aliyun.ros.cdk.core.Construct

---

id^Required

• Type: java.lang.String

---

enableResourcePropertyConstraint^Optional

• Type: java.lang.Boolean

---

priority^Required

• Type: java.lang.Number OR com.aliyun.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.

---

trafficMirrorFilterId^Required

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property trafficMirrorFilterId: The ID of the filter.

---

trafficMirrorSourceIds^Required

• Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.List

Property trafficMirrorSourceIds: undefined.

---

trafficMirrorTargetId^Required

• Type: java.lang.String OR com.aliyun.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.

---

trafficMirrorTargetType^Required

• Type: java.lang.String OR com.aliyun.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: java.lang.Boolean OR com.aliyun.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.

---

packetLength^Optional

• Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

Property packetLength: The maximum transmission unit (MTU).

Default value: 1500.

---

resourceGroupId^Optional

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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

---

tag^Optional

• Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.List

Property tag:.

---

trafficMirrorSessionDescription^Optional

• Type: java.lang.String OR com.aliyun.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://.

---

trafficMirrorSessionName^Optional

• Type: java.lang.String OR com.aliyun.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://.

---

virtualNetworkId^Optional

• Type: java.lang.Number OR com.aliyun.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.

---

Methods

Name	Description
toString	Returns a string representation of this construct.
synthesize	Allows this construct to emit artifacts into the cloud assembly during synthesis.
addCondition	No description.
addCount	No description.
addDependency	No description.
addResourceDesc	No description.
applyRemovalPolicy	No description.
getAtt	No description.
setMetadata	No description.

---

toString

public java.lang.String toString()

Returns a string representation of this construct.

synthesize

public void synthesize(ISynthesisSession session)

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: com.aliyun.ros.cdk.core.ISynthesisSession

The synthesis session.

---

addCondition

public void addCondition(RosCondition condition)

condition^Required

• Type: com.aliyun.ros.cdk.core.RosCondition

---

addCount

public void addCount(java.lang.Number OR IResolvable count)

count^Required

• Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

---

addDependency

public void addDependency(Resource resource)

resource^Required

• Type: com.aliyun.ros.cdk.core.Resource

---

addResourceDesc

public void addResourceDesc(java.lang.String desc)

desc^Required

• Type: java.lang.String

---

applyRemovalPolicy

public void applyRemovalPolicy(RemovalPolicy policy)

policy^Required

• Type: com.aliyun.ros.cdk.core.RemovalPolicy

---

getAtt

public IResolvable getAtt(java.lang.String name)

name^Required

• Type: java.lang.String

---

setMetadata

public void setMetadata(java.lang.String key, java.lang.Object value)

key^Required

• Type: java.lang.String

---

value^Required

• Type: java.lang.Object

---

Static Functions

Name	Description
isConstruct	Return whether the given object is a Construct.

---

isConstruct

import com.aliyun.ros.cdk.vpc.TrafficMirrorSession;
TrafficMirrorSession.isConstruct(java.lang.Object x)

Return whether the given object is a Construct.

x^Required

• Type: java.lang.Object

---

Properties

Name	Type	Description
node	com.aliyun.ros.cdk.core.ConstructNode	The construct tree node associated with this construct.
ref	java.lang.String	No description.
stack	com.aliyun.ros.cdk.core.Stack	The stack in which this resource is defined.
resource	com.aliyun.ros.cdk.core.RosResource	No description.
attrTrafficMirrorSessionId	com.aliyun.ros.cdk.core.IResolvable	Attribute TrafficMirrorSessionId: The ID of the traffic mirror session.

---

node^Required

public ConstructNode getNode();

• Type: com.aliyun.ros.cdk.core.ConstructNode

The construct tree node associated with this construct.

---

ref^Required

public java.lang.String getRef();

• Type: java.lang.String

---

stack^Required

public Stack getStack();

• Type: com.aliyun.ros.cdk.core.Stack

The stack in which this resource is defined.

---

resource^Optional

public RosResource getResource();

• Type: com.aliyun.ros.cdk.core.RosResource

---

attrTrafficMirrorSessionId^Required

public IResolvable getAttrTrafficMirrorSessionId();

• Type: com.aliyun.ros.cdk.core.IResolvable

Attribute TrafficMirrorSessionId: The ID of the traffic mirror session.

---