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 TypeMethodDescriptionbuild()
description
(String description) The description of the Traffic Mirror session.networkInterfaceId
(String networkInterfaceId) The ID of the source network interface.packetLength
(Number packetLength) The number of bytes in each packet to mirror.sessionNumber
(Number sessionNumber) The session number determines the order in which sessions are evaluated when an interface is used by multiple sessions.The tags to assign to a Traffic Mirror session.trafficMirrorFilterId
(String trafficMirrorFilterId) The ID of the Traffic Mirror filter.trafficMirrorTargetId
(String trafficMirrorTargetId) The ID of the Traffic Mirror target.virtualNetworkId
(Number virtualNetworkId) The VXLAN ID for the Traffic Mirror session.
-
Method Details
-
create
- Parameters:
scope
-- scope in which this resource is defined.
id
-- scoped id of the resource.
- 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
-
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
-
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
-
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
-
description
The description of the Traffic Mirror session.- Parameters:
description
- The description of the Traffic Mirror session. This parameter is required.- Returns:
this
-
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.- Parameters:
packetLength
- The number of bytes in each packet to mirror. This parameter is required.- Returns:
this
-
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
-
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
-
build
- Specified by:
build
in interfacesoftware.amazon.jsii.Builder<CfnTrafficMirrorSession>
- Returns:
- a newly built instance of
CfnTrafficMirrorSession
.
-