software.amazon.awscdk.services.ec2

Interface CfnTrafficMirrorSessionProps

All Known Implementing Classes:

CfnTrafficMirrorSessionProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.58.0 (build f8ba112)",
           date="2022-05-20T22:19:59.246Z")
public interface CfnTrafficMirrorSessionProps

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();
 

Nested Class Summary

Nested Classes

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

Method Summary

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

Method Detail

getNetworkInterfaceId

java.lang.String getNetworkInterfaceId()

The ID of the source network interface.

getSessionNumber

java.lang.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.

getTrafficMirrorFilterId

java.lang.String getTrafficMirrorFilterId()

The ID of the Traffic Mirror filter.

getTrafficMirrorTargetId

java.lang.String getTrafficMirrorTargetId()

The ID of the Traffic Mirror target.

getDescription

default java.lang.String getDescription()

The description of the Traffic Mirror session.

getPacketLength

default java.lang.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.

getTags

default java.util.List<CfnTag> getTags()

The tags to assign to a Traffic Mirror session.

getVirtualNetworkId

default java.lang.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.

builder

static CfnTrafficMirrorSessionProps.Builder builder()

Returns:

a CfnTrafficMirrorSessionProps.Builder of CfnTrafficMirrorSessionProps