Package software.amazon.awscdk.services.ec2

Interface CfnTrafficMirrorSessionProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnTrafficMirrorSessionProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.98.0 (build 00b106d)",
           date="2024-05-08T21:35:05.996Z")
@Stability(Stable)
public interface CfnTrafficMirrorSessionProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnTrafficMirrorSession.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.ec2.*;
 CfnTrafficMirrorSessionProps cfnTrafficMirrorSessionProps = CfnTrafficMirrorSessionProps.builder()
         .networkInterfaceId("networkInterfaceId")
         .sessionNumber(123)
         .trafficMirrorFilterId("trafficMirrorFilterId")
         .trafficMirrorTargetId("trafficMirrorTargetId")
         // the properties below are optional
         .description("description")
         .packetLength(123)
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .virtualNetworkId(123)
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnTrafficMirrorSessionProps.Builder	A builder for CfnTrafficMirrorSessionProps
static final class	CfnTrafficMirrorSessionProps.Jsii$Proxy	An implementation for CfnTrafficMirrorSessionProps

Method Summary

Modifier and Type	Method	Description
static CfnTrafficMirrorSessionProps.Builder	builder()
default String	getDescription()	The description of the Traffic Mirror session.
String	getNetworkInterfaceId()	The ID of the source network interface.
default Number	getPacketLength()	The number of bytes in each packet to mirror.
Number	getSessionNumber()	The session number determines the order in which sessions are evaluated when an interface is used by multiple sessions.
default List<CfnTag>	getTags()	The tags to assign to a Traffic Mirror session.
String	getTrafficMirrorFilterId()	The ID of the Traffic Mirror filter.
String	getTrafficMirrorTargetId()	The ID of the Traffic Mirror target.
default Number	getVirtualNetworkId()	The VXLAN ID for the Traffic Mirror session.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getNetworkInterfaceId

@Stability(Stable)
@NotNull
String getNetworkInterfaceId()

The ID of the source network interface.

See Also:

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

getSessionNumber

@Stability(Stable)
@NotNull
Number getSessionNumber()

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.

See Also:

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

getTrafficMirrorFilterId

@Stability(Stable)
@NotNull
String getTrafficMirrorFilterId()

The ID of the Traffic Mirror filter.

See Also:

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

getTrafficMirrorTargetId

@Stability(Stable)
@NotNull
String getTrafficMirrorTargetId()

The ID of the Traffic Mirror target.

See Also:

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

getDescription

@Stability(Stable)
@Nullable
default String getDescription()

The description of the Traffic Mirror session.

See Also:

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

getPacketLength

@Stability(Stable)
@Nullable
default Number getPacketLength()

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.

See Also:

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

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

The tags to assign to a Traffic Mirror session.

See Also:

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

getVirtualNetworkId

@Stability(Stable)
@Nullable
default Number getVirtualNetworkId()

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.

See Also:

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

builder

@Stability(Stable)
static CfnTrafficMirrorSessionProps.Builder builder()

Returns:

a CfnTrafficMirrorSessionProps.Builder of CfnTrafficMirrorSessionProps