Package software.amazon.awscdk.cfnpropertymixins.services.ec2

Class CfnTrafficMirrorSessionPropsMixin.Builder

java.lang.Object

software.amazon.awscdk.cfnpropertymixins.services.ec2.CfnTrafficMirrorSessionPropsMixin.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnTrafficMirrorSessionPropsMixin>

Enclosing class:

CfnTrafficMirrorSessionPropsMixin

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

A fluent builder for CfnTrafficMirrorSessionPropsMixin.

Method Summary

Modifier and Type	Method	Description
CfnTrafficMirrorSessionPropsMixin	build()
static CfnTrafficMirrorSessionPropsMixin.Builder	create()
static CfnTrafficMirrorSessionPropsMixin.Builder	create(CfnPropertyMixinOptions options)
CfnTrafficMirrorSessionPropsMixin.Builder	description(String description)	The description of the Traffic Mirror session.
CfnTrafficMirrorSessionPropsMixin.Builder	networkInterfaceId(String networkInterfaceId)	The ID of the source network interface.
CfnTrafficMirrorSessionPropsMixin.Builder	ownerId(String ownerId)	The ID of the account that owns the Traffic Mirror session.
CfnTrafficMirrorSessionPropsMixin.Builder	packetLength(Number packetLength)	The number of bytes in each packet to mirror.
CfnTrafficMirrorSessionPropsMixin.Builder	sessionNumber(Number sessionNumber)	The session number determines the order in which sessions are evaluated when an interface is used by multiple sessions.
CfnTrafficMirrorSessionPropsMixin.Builder	tags(List<? extends CfnTag> tags)	The tags to assign to a Traffic Mirror session.
CfnTrafficMirrorSessionPropsMixin.Builder	trafficMirrorFilterId(String trafficMirrorFilterId)	The ID of the Traffic Mirror filter.
CfnTrafficMirrorSessionPropsMixin.Builder	trafficMirrorTargetId(String trafficMirrorTargetId)	The ID of the Traffic Mirror target.
CfnTrafficMirrorSessionPropsMixin.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 CfnTrafficMirrorSessionPropsMixin.Builder create(CfnPropertyMixinOptions options)

Parameters:

options - Mixin options.

Returns:

a new instance of CfnTrafficMirrorSessionPropsMixin.Builder.

create

@Stability(Stable)
public static CfnTrafficMirrorSessionPropsMixin.Builder create()

Returns:

a new instance of CfnTrafficMirrorSessionPropsMixin.Builder.

description

@Stability(Stable)
public CfnTrafficMirrorSessionPropsMixin.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

networkInterfaceId

@Stability(Stable)
public CfnTrafficMirrorSessionPropsMixin.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

ownerId

@Stability(Stable)
public CfnTrafficMirrorSessionPropsMixin.Builder ownerId(String ownerId)

The ID of the account that owns the Traffic Mirror session.

Parameters:

ownerId - The ID of the account that owns 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-ownerid

packetLength

@Stability(Stable)
public CfnTrafficMirrorSessionPropsMixin.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

sessionNumber

@Stability(Stable)
public CfnTrafficMirrorSessionPropsMixin.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

tags

@Stability(Stable)
public CfnTrafficMirrorSessionPropsMixin.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

trafficMirrorFilterId

@Stability(Stable)
public CfnTrafficMirrorSessionPropsMixin.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 CfnTrafficMirrorSessionPropsMixin.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

virtualNetworkId

@Stability(Stable)
public CfnTrafficMirrorSessionPropsMixin.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 CfnTrafficMirrorSessionPropsMixin build()

Specified by:

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

Returns:

a newly built instance of CfnTrafficMirrorSessionPropsMixin.