Interface CreateTrafficMirrorSessionRequest.Builder
-
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<CreateTrafficMirrorSessionRequest.Builder,CreateTrafficMirrorSessionRequest>
,Ec2Request.Builder
,SdkBuilder<CreateTrafficMirrorSessionRequest.Builder,CreateTrafficMirrorSessionRequest>
,SdkPojo
,SdkRequest.Builder
- Enclosing class:
- CreateTrafficMirrorSessionRequest
public static interface CreateTrafficMirrorSessionRequest.Builder extends Ec2Request.Builder, SdkPojo, CopyableBuilder<CreateTrafficMirrorSessionRequest.Builder,CreateTrafficMirrorSessionRequest>
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description CreateTrafficMirrorSessionRequest.Builder
clientToken(String clientToken)
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.CreateTrafficMirrorSessionRequest.Builder
description(String description)
The description of the Traffic Mirror session.CreateTrafficMirrorSessionRequest.Builder
dryRun(Boolean dryRun)
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response.CreateTrafficMirrorSessionRequest.Builder
networkInterfaceId(String networkInterfaceId)
The ID of the source network interface.CreateTrafficMirrorSessionRequest.Builder
overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
CreateTrafficMirrorSessionRequest.Builder
overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
CreateTrafficMirrorSessionRequest.Builder
packetLength(Integer packetLength)
The number of bytes in each packet to mirror.CreateTrafficMirrorSessionRequest.Builder
sessionNumber(Integer sessionNumber)
The session number determines the order in which sessions are evaluated when an interface is used by multiple sessions.CreateTrafficMirrorSessionRequest.Builder
tagSpecifications(Collection<TagSpecification> tagSpecifications)
The tags to assign to a Traffic Mirror session.CreateTrafficMirrorSessionRequest.Builder
tagSpecifications(Consumer<TagSpecification.Builder>... tagSpecifications)
The tags to assign to a Traffic Mirror session.CreateTrafficMirrorSessionRequest.Builder
tagSpecifications(TagSpecification... tagSpecifications)
The tags to assign to a Traffic Mirror session.CreateTrafficMirrorSessionRequest.Builder
trafficMirrorFilterId(String trafficMirrorFilterId)
The ID of the Traffic Mirror filter.CreateTrafficMirrorSessionRequest.Builder
trafficMirrorTargetId(String trafficMirrorTargetId)
The ID of the Traffic Mirror target.CreateTrafficMirrorSessionRequest.Builder
virtualNetworkId(Integer virtualNetworkId)
The VXLAN ID for the Traffic Mirror session.-
Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
-
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
-
Methods inherited from interface software.amazon.awssdk.services.ec2.model.Ec2Request.Builder
build
-
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
-
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
-
-
-
Method Detail
-
networkInterfaceId
CreateTrafficMirrorSessionRequest.Builder networkInterfaceId(String networkInterfaceId)
The ID of the source network interface.
- Parameters:
networkInterfaceId
- The ID of the source network interface.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
trafficMirrorTargetId
CreateTrafficMirrorSessionRequest.Builder trafficMirrorTargetId(String trafficMirrorTargetId)
The ID of the Traffic Mirror target.
- Parameters:
trafficMirrorTargetId
- The ID of the Traffic Mirror target.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
trafficMirrorFilterId
CreateTrafficMirrorSessionRequest.Builder trafficMirrorFilterId(String trafficMirrorFilterId)
The ID of the Traffic Mirror filter.
- Parameters:
trafficMirrorFilterId
- The ID of the Traffic Mirror filter.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
packetLength
CreateTrafficMirrorSessionRequest.Builder packetLength(Integer 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 aPacketLength
greater than 8500 will result in an error response.- Parameters:
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 aPacketLength
greater than 8500 will result in an error response.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
sessionNumber
CreateTrafficMirrorSessionRequest.Builder sessionNumber(Integer 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. The first session with a matching filter is the one that mirrors the packets.Valid values are 1-32766.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
virtualNetworkId
CreateTrafficMirrorSessionRequest.Builder virtualNetworkId(Integer 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. For more information about the VXLAN protocol, see RFC 7348. If you do not specify aVirtualNetworkId
, an account-wide unique id is chosen at random.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
description
CreateTrafficMirrorSessionRequest.Builder description(String description)
The description of the Traffic Mirror session.
- Parameters:
description
- The description of the Traffic Mirror session.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
tagSpecifications
CreateTrafficMirrorSessionRequest.Builder tagSpecifications(Collection<TagSpecification> tagSpecifications)
The tags to assign to a Traffic Mirror session.
- Parameters:
tagSpecifications
- The tags to assign to a Traffic Mirror session.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
tagSpecifications
CreateTrafficMirrorSessionRequest.Builder tagSpecifications(TagSpecification... tagSpecifications)
The tags to assign to a Traffic Mirror session.
- Parameters:
tagSpecifications
- The tags to assign to a Traffic Mirror session.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
tagSpecifications
CreateTrafficMirrorSessionRequest.Builder tagSpecifications(Consumer<TagSpecification.Builder>... tagSpecifications)
The tags to assign to a Traffic Mirror session.
This is a convenience method that creates an instance of theTagSpecification.Builder
avoiding the need to create one manually viaTagSpecification.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed to#tagSpecifications(List
.) - Parameters:
tagSpecifications
- a consumer that will call methods onTagSpecification.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
#tagSpecifications(java.util.Collection
)
-
dryRun
CreateTrafficMirrorSessionRequest.Builder dryRun(Boolean dryRun)
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is
DryRunOperation
. Otherwise, it isUnauthorizedOperation
.- Parameters:
dryRun
- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation
. Otherwise, it isUnauthorizedOperation
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
clientToken
CreateTrafficMirrorSessionRequest.Builder clientToken(String clientToken)
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.
- Parameters:
clientToken
- Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
overrideConfiguration
CreateTrafficMirrorSessionRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
-
overrideConfiguration
CreateTrafficMirrorSessionRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
-
-