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.84.0 (build 5404dcf)", date="2023-06-19T16:30:39.060Z") @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();

  • Method Details

    • getNetworkInterfaceId

      @Stability(Stable) @NotNull String getNetworkInterfaceId()
      The ID of the source network interface.

    • 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.

    • getTrafficMirrorFilterId

      @Stability(Stable) @NotNull String getTrafficMirrorFilterId()
      The ID of the Traffic Mirror filter.

    • getTrafficMirrorTargetId

      @Stability(Stable) @NotNull String getTrafficMirrorTargetId()
      The ID of the Traffic Mirror target.

    • getDescription

      @Stability(Stable) @Nullable default String getDescription()
      The description of the Traffic Mirror session.

    • 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.

    • getTags

      @Stability(Stable) @Nullable default List<CfnTag> getTags()
      The tags to assign to a Traffic Mirror session.

    • 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.

    • builder

      @Stability(Stable) static CfnTrafficMirrorSessionProps.Builder builder()
      Returns:
      a CfnTrafficMirrorSessionProps.Builder of CfnTrafficMirrorSessionProps