com.amazonaws.services.ec2.model

Class CreateTrafficMirrorSessionRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.ec2.model.CreateTrafficMirrorSessionRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, DryRunSupportedRequest<CreateTrafficMirrorSessionRequest>, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CreateTrafficMirrorSessionRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable, DryRunSupportedRequest<CreateTrafficMirrorSessionRequest>

See Also:

Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
CreateTrafficMirrorSessionRequest()

Method Summary

Modifier and Type	Method and Description
CreateTrafficMirrorSessionRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getClientToken() Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
String	getDescription() The description of the Traffic Mirror session.
Request<CreateTrafficMirrorSessionRequest>	getDryRunRequest() This method is intended for internal use only.
String	getNetworkInterfaceId() The ID of the source network interface.
Integer	getPacketLength() The number of bytes in each packet to mirror.
Integer	getSessionNumber() The session number determines the order in which sessions are evaluated when an interface is used by multiple sessions.
List<TagSpecification>	getTagSpecifications() 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.
Integer	getVirtualNetworkId() The VXLAN ID for the Traffic Mirror session.
int	hashCode()
void	setClientToken(String clientToken) Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
void	setDescription(String description) The description of the Traffic Mirror session.
void	setNetworkInterfaceId(String networkInterfaceId) The ID of the source network interface.
void	setPacketLength(Integer packetLength) The number of bytes in each packet to mirror.
void	setSessionNumber(Integer sessionNumber) The session number determines the order in which sessions are evaluated when an interface is used by multiple sessions.
void	setTagSpecifications(Collection<TagSpecification> tagSpecifications) The tags to assign to a Traffic Mirror session.
void	setTrafficMirrorFilterId(String trafficMirrorFilterId) The ID of the Traffic Mirror filter.
void	setTrafficMirrorTargetId(String trafficMirrorTargetId) The ID of the Traffic Mirror target.
void	setVirtualNetworkId(Integer virtualNetworkId) The VXLAN ID for the Traffic Mirror session.
String	toString() Returns a string representation of this object.
CreateTrafficMirrorSessionRequest	withClientToken(String clientToken) Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
CreateTrafficMirrorSessionRequest	withDescription(String description) The description of the Traffic Mirror session.
CreateTrafficMirrorSessionRequest	withNetworkInterfaceId(String networkInterfaceId) The ID of the source network interface.
CreateTrafficMirrorSessionRequest	withPacketLength(Integer packetLength) The number of bytes in each packet to mirror.
CreateTrafficMirrorSessionRequest	withSessionNumber(Integer sessionNumber) The session number determines the order in which sessions are evaluated when an interface is used by multiple sessions.
CreateTrafficMirrorSessionRequest	withTagSpecifications(Collection<TagSpecification> tagSpecifications) The tags to assign to a Traffic Mirror session.
CreateTrafficMirrorSessionRequest	withTagSpecifications(TagSpecification... tagSpecifications) The tags to assign to a Traffic Mirror session.
CreateTrafficMirrorSessionRequest	withTrafficMirrorFilterId(String trafficMirrorFilterId) The ID of the Traffic Mirror filter.
CreateTrafficMirrorSessionRequest	withTrafficMirrorTargetId(String trafficMirrorTargetId) The ID of the Traffic Mirror target.
CreateTrafficMirrorSessionRequest	withVirtualNetworkId(Integer virtualNetworkId) The VXLAN ID for the Traffic Mirror session.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CreateTrafficMirrorSessionRequest

public CreateTrafficMirrorSessionRequest()

Method Detail

setNetworkInterfaceId

public void setNetworkInterfaceId(String networkInterfaceId)

The ID of the source network interface.

Parameters:

networkInterfaceId - The ID of the source network interface.

getNetworkInterfaceId

public String getNetworkInterfaceId()

The ID of the source network interface.

Returns:

The ID of the source network interface.

withNetworkInterfaceId

public CreateTrafficMirrorSessionRequest withNetworkInterfaceId(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.

setTrafficMirrorTargetId

public void setTrafficMirrorTargetId(String trafficMirrorTargetId)

The ID of the Traffic Mirror target.

Parameters:

trafficMirrorTargetId - The ID of the Traffic Mirror target.

getTrafficMirrorTargetId

public String getTrafficMirrorTargetId()

The ID of the Traffic Mirror target.

Returns:

The ID of the Traffic Mirror target.

withTrafficMirrorTargetId

public CreateTrafficMirrorSessionRequest withTrafficMirrorTargetId(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.

setTrafficMirrorFilterId

public void setTrafficMirrorFilterId(String trafficMirrorFilterId)

The ID of the Traffic Mirror filter.

Parameters:

trafficMirrorFilterId - The ID of the Traffic Mirror filter.

getTrafficMirrorFilterId

public String getTrafficMirrorFilterId()

The ID of the Traffic Mirror filter.

Returns:

The ID of the Traffic Mirror filter.

withTrafficMirrorFilterId

public CreateTrafficMirrorSessionRequest withTrafficMirrorFilterId(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.

setPacketLength

public void setPacketLength(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 a PacketLength 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 a PacketLength greater than 8500 will result in an error response.

getPacketLength

public Integer 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.

Returns:

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.

withPacketLength

public CreateTrafficMirrorSessionRequest withPacketLength(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 a PacketLength 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 a PacketLength greater than 8500 will result in an error response.

Returns:

Returns a reference to this object so that method calls can be chained together.

setSessionNumber

public void setSessionNumber(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.

getSessionNumber

public Integer 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.

Returns:

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.

withSessionNumber

public CreateTrafficMirrorSessionRequest withSessionNumber(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.

setVirtualNetworkId

public void setVirtualNetworkId(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 a VirtualNetworkId, an account-wide unique ID is chosen at random.

getVirtualNetworkId

public Integer 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.

Returns:

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.

withVirtualNetworkId

public CreateTrafficMirrorSessionRequest withVirtualNetworkId(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 a VirtualNetworkId, an account-wide unique ID is chosen at random.

Returns:

Returns a reference to this object so that method calls can be chained together.

setDescription

public void setDescription(String description)

The description of the Traffic Mirror session.

Parameters:

description - The description of the Traffic Mirror session.

getDescription

public String getDescription()

The description of the Traffic Mirror session.

Returns:

The description of the Traffic Mirror session.

withDescription

public CreateTrafficMirrorSessionRequest withDescription(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.

getTagSpecifications

public List<TagSpecification> getTagSpecifications()

The tags to assign to a Traffic Mirror session.

Returns:

The tags to assign to a Traffic Mirror session.

setTagSpecifications

public void setTagSpecifications(Collection<TagSpecification> tagSpecifications)

The tags to assign to a Traffic Mirror session.

Parameters:

tagSpecifications - The tags to assign to a Traffic Mirror session.

withTagSpecifications

public CreateTrafficMirrorSessionRequest withTagSpecifications(TagSpecification... tagSpecifications)

The tags to assign to a Traffic Mirror session.

NOTE: This method appends the values to the existing list (if any). Use setTagSpecifications(java.util.Collection) or withTagSpecifications(java.util.Collection) if you want to override the existing values.

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.

withTagSpecifications

public CreateTrafficMirrorSessionRequest withTagSpecifications(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.

setClientToken

public void setClientToken(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.

getClientToken

public String getClientToken()

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.

Returns:

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.

withClientToken

public CreateTrafficMirrorSessionRequest withClientToken(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.

getDryRunRequest

public Request<CreateTrafficMirrorSessionRequest> getDryRunRequest()

This method is intended for internal use only. Returns the marshaled request configured with additional parameters to enable operation dry-run.

Specified by:

getDryRunRequest in interface DryRunSupportedRequest<CreateTrafficMirrorSessionRequest>

toString

public String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public CreateTrafficMirrorSessionRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()