Package software.amazon.awscdk.services.ec2

Class CfnTrafficMirrorSession.Builder

java.lang.Object

software.amazon.awscdk.services.ec2.CfnTrafficMirrorSession.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnTrafficMirrorSession>

Enclosing class:

CfnTrafficMirrorSession

@Stability(Stable)
public static final class CfnTrafficMirrorSession.Builder
extends Object
implements software.amazon.jsii.Builder<CfnTrafficMirrorSession>

A fluent builder for CfnTrafficMirrorSession.

Method Summary

Modifier and Type	Method	Description
CfnTrafficMirrorSession	build()
static CfnTrafficMirrorSession.Builder	create(software.constructs.Construct scope, String id)
CfnTrafficMirrorSession.Builder	description(String description)	The description of the Traffic Mirror session.
CfnTrafficMirrorSession.Builder	networkInterfaceId(String networkInterfaceId)	The ID of the source network interface.
CfnTrafficMirrorSession.Builder	packetLength(Number packetLength)	The number of bytes in each packet to mirror.
CfnTrafficMirrorSession.Builder	sessionNumber(Number sessionNumber)	The session number determines the order in which sessions are evaluated when an interface is used by multiple sessions.
CfnTrafficMirrorSession.Builder	tags(List<? extends CfnTag> tags)	The tags to assign to a Traffic Mirror session.
CfnTrafficMirrorSession.Builder	trafficMirrorFilterId(String trafficMirrorFilterId)	The ID of the Traffic Mirror filter.
CfnTrafficMirrorSession.Builder	trafficMirrorTargetId(String trafficMirrorTargetId)	The ID of the Traffic Mirror target.
CfnTrafficMirrorSession.Builder	virtualNetworkId(Number virtualNetworkId)	The VXLAN ID for the Traffic Mirror session.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

create

@Stability(Stable)
public static CfnTrafficMirrorSession.Builder create(software.constructs.Construct scope,
 String id)

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

Returns:

a new instance of CfnTrafficMirrorSession.Builder.

networkInterfaceId

@Stability(Stable)
public CfnTrafficMirrorSession.Builder networkInterfaceId(String networkInterfaceId)

The ID of the source network interface.

Parameters:

networkInterfaceId - The ID of the source network interface. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trafficmirrorsession.html#cfn-ec2-trafficmirrorsession-networkinterfaceid

sessionNumber

@Stability(Stable)
public CfnTrafficMirrorSession.Builder sessionNumber(Number sessionNumber)

The session number determines the order in which sessions are evaluated when an interface is used by multiple sessions.

The first session with a matching filter is the one that mirrors the packets.

Valid values are 1-32766.

Parameters:

sessionNumber - The session number determines the order in which sessions are evaluated when an interface is used by multiple sessions. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trafficmirrorsession.html#cfn-ec2-trafficmirrorsession-sessionnumber

trafficMirrorFilterId

@Stability(Stable)
public CfnTrafficMirrorSession.Builder trafficMirrorFilterId(String trafficMirrorFilterId)

The ID of the Traffic Mirror filter.

Parameters:

trafficMirrorFilterId - The ID of the Traffic Mirror filter. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trafficmirrorsession.html#cfn-ec2-trafficmirrorsession-trafficmirrorfilterid

trafficMirrorTargetId

@Stability(Stable)
public CfnTrafficMirrorSession.Builder trafficMirrorTargetId(String trafficMirrorTargetId)

The ID of the Traffic Mirror target.

Parameters:

trafficMirrorTargetId - The ID of the Traffic Mirror target. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trafficmirrorsession.html#cfn-ec2-trafficmirrorsession-trafficmirrortargetid

description

@Stability(Stable)
public CfnTrafficMirrorSession.Builder description(String description)

The description of the Traffic Mirror session.

Parameters:

description - The description of the Traffic Mirror session. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trafficmirrorsession.html#cfn-ec2-trafficmirrorsession-description

packetLength

@Stability(Stable)
public CfnTrafficMirrorSession.Builder packetLength(Number packetLength)

The number of bytes in each packet to mirror.

These are bytes after the VXLAN header. Do not specify this parameter when you want to mirror the entire packet. To mirror a subset of the packet, set this to the length (in bytes) that you want to mirror. For example, if you set this value to 100, then the first 100 bytes that meet the filter criteria are copied to the target.

If you do not want to mirror the entire packet, use the PacketLength parameter to specify the number of bytes in each packet to mirror.

For sessions with Network Load Balancer (NLB) Traffic Mirror targets the default PacketLength will be set to 8500. Valid values are 1-8500. Setting a PacketLength greater than 8500 will result in an error response.

Parameters:

packetLength - The number of bytes in each packet to mirror. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trafficmirrorsession.html#cfn-ec2-trafficmirrorsession-packetlength

tags

@Stability(Stable)
public CfnTrafficMirrorSession.Builder tags(List<? extends CfnTag> tags)

The tags to assign to a Traffic Mirror session.

Parameters:

tags - The tags to assign to a Traffic Mirror session. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trafficmirrorsession.html#cfn-ec2-trafficmirrorsession-tags

virtualNetworkId

@Stability(Stable)
public CfnTrafficMirrorSession.Builder virtualNetworkId(Number virtualNetworkId)

The VXLAN ID for the Traffic Mirror session.

For more information about the VXLAN protocol, see RFC 7348 . If you do not specify a VirtualNetworkId , an account-wide unique id is chosen at random.

Parameters:

virtualNetworkId - The VXLAN ID for the Traffic Mirror session. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trafficmirrorsession.html#cfn-ec2-trafficmirrorsession-virtualnetworkid

build

@Stability(Stable)
public CfnTrafficMirrorSession build()

Specified by:

build in interface software.amazon.jsii.Builder<CfnTrafficMirrorSession>

Returns:

a newly built instance of CfnTrafficMirrorSession.