com.amazonaws.services.ec2.model

Class ModifyTrafficMirrorSessionRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.ec2.model.ModifyTrafficMirrorSessionRequest

All Implemented Interfaces:

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

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

See Also:

Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
ModifyTrafficMirrorSessionRequest()

Method Summary

Modifier and Type	Method and Description
ModifyTrafficMirrorSessionRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getDescription() The description to assign to the Traffic Mirror session.
Request<ModifyTrafficMirrorSessionRequest>	getDryRunRequest() This method is intended for internal use only.
Integer	getPacketLength() The number of bytes in each packet to mirror.
List<String>	getRemoveFields() The properties that you want to remove from the Traffic Mirror session.
Integer	getSessionNumber() The session number determines the order in which sessions are evaluated when an interface is used by multiple sessions.
String	getTrafficMirrorFilterId() The ID of the Traffic Mirror filter.
String	getTrafficMirrorSessionId() The ID of the Traffic Mirror session.
String	getTrafficMirrorTargetId() The Traffic Mirror target.
Integer	getVirtualNetworkId() The virtual network ID of the Traffic Mirror session.
int	hashCode()
void	setDescription(String description) The description to assign to the Traffic Mirror session.
void	setPacketLength(Integer packetLength) The number of bytes in each packet to mirror.
void	setRemoveFields(Collection<String> removeFields) The properties that you want to remove from the Traffic Mirror session.
void	setSessionNumber(Integer sessionNumber) The session number determines the order in which sessions are evaluated when an interface is used by multiple sessions.
void	setTrafficMirrorFilterId(String trafficMirrorFilterId) The ID of the Traffic Mirror filter.
void	setTrafficMirrorSessionId(String trafficMirrorSessionId) The ID of the Traffic Mirror session.
void	setTrafficMirrorTargetId(String trafficMirrorTargetId) The Traffic Mirror target.
void	setVirtualNetworkId(Integer virtualNetworkId) The virtual network ID of the Traffic Mirror session.
String	toString() Returns a string representation of this object.
ModifyTrafficMirrorSessionRequest	withDescription(String description) The description to assign to the Traffic Mirror session.
ModifyTrafficMirrorSessionRequest	withPacketLength(Integer packetLength) The number of bytes in each packet to mirror.
ModifyTrafficMirrorSessionRequest	withRemoveFields(Collection<String> removeFields) The properties that you want to remove from the Traffic Mirror session.
ModifyTrafficMirrorSessionRequest	withRemoveFields(String... removeFields) The properties that you want to remove from the Traffic Mirror session.
ModifyTrafficMirrorSessionRequest	withRemoveFields(TrafficMirrorSessionField... removeFields) The properties that you want to remove from the Traffic Mirror session.
ModifyTrafficMirrorSessionRequest	withSessionNumber(Integer sessionNumber) The session number determines the order in which sessions are evaluated when an interface is used by multiple sessions.
ModifyTrafficMirrorSessionRequest	withTrafficMirrorFilterId(String trafficMirrorFilterId) The ID of the Traffic Mirror filter.
ModifyTrafficMirrorSessionRequest	withTrafficMirrorSessionId(String trafficMirrorSessionId) The ID of the Traffic Mirror session.
ModifyTrafficMirrorSessionRequest	withTrafficMirrorTargetId(String trafficMirrorTargetId) The Traffic Mirror target.
ModifyTrafficMirrorSessionRequest	withVirtualNetworkId(Integer virtualNetworkId) The virtual network ID of 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

ModifyTrafficMirrorSessionRequest

public ModifyTrafficMirrorSessionRequest()

Method Detail

setTrafficMirrorSessionId

public void setTrafficMirrorSessionId(String trafficMirrorSessionId)

The ID of the Traffic Mirror session.

Parameters:

trafficMirrorSessionId - The ID of the Traffic Mirror session.

getTrafficMirrorSessionId

public String getTrafficMirrorSessionId()

The ID of the Traffic Mirror session.

Returns:

The ID of the Traffic Mirror session.

withTrafficMirrorSessionId

public ModifyTrafficMirrorSessionRequest withTrafficMirrorSessionId(String trafficMirrorSessionId)

The ID of the Traffic Mirror session.

Parameters:

trafficMirrorSessionId - The ID of the Traffic Mirror session.

Returns:

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

setTrafficMirrorTargetId

public void setTrafficMirrorTargetId(String trafficMirrorTargetId)

The Traffic Mirror target. The target must be in the same VPC as the source, or have a VPC peering connection with the source.

Parameters:

trafficMirrorTargetId - The Traffic Mirror target. The target must be in the same VPC as the source, or have a VPC peering connection with the source.

getTrafficMirrorTargetId

public String getTrafficMirrorTargetId()

The Traffic Mirror target. The target must be in the same VPC as the source, or have a VPC peering connection with the source.

Returns:

The Traffic Mirror target. The target must be in the same VPC as the source, or have a VPC peering connection with the source.

withTrafficMirrorTargetId

public ModifyTrafficMirrorSessionRequest withTrafficMirrorTargetId(String trafficMirrorTargetId)

The Traffic Mirror target. The target must be in the same VPC as the source, or have a VPC peering connection with the source.

Parameters:

trafficMirrorTargetId - The Traffic Mirror target. The target must be in the same VPC as the source, or have a VPC peering connection with the source.

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 ModifyTrafficMirrorSessionRequest 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. To mirror a subset, set this to the length (in bytes) 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. Do not specify this parameter when you want to mirror the entire packet.

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. To mirror a subset, set this to the length (in bytes) 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. Do not specify this parameter when you want to mirror the entire packet.

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. To mirror a subset, set this to the length (in bytes) 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. Do not specify this parameter when you want to mirror the entire packet.

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. To mirror a subset, set this to the length (in bytes) 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. Do not specify this parameter when you want to mirror the entire packet.

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 ModifyTrafficMirrorSessionRequest withPacketLength(Integer packetLength)

The number of bytes in each packet to mirror. These are bytes after the VXLAN header. To mirror a subset, set this to the length (in bytes) 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. Do not specify this parameter when you want to mirror the entire packet.

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. To mirror a subset, set this to the length (in bytes) 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. Do not specify this parameter when you want to mirror the entire packet.

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 ModifyTrafficMirrorSessionRequest 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 virtual network ID of the Traffic Mirror session.

Parameters:

virtualNetworkId - The virtual network ID of the Traffic Mirror session.

getVirtualNetworkId

public Integer getVirtualNetworkId()

The virtual network ID of the Traffic Mirror session.

Returns:

The virtual network ID of the Traffic Mirror session.

withVirtualNetworkId

public ModifyTrafficMirrorSessionRequest withVirtualNetworkId(Integer virtualNetworkId)

The virtual network ID of the Traffic Mirror session.

Parameters:

virtualNetworkId - The virtual network ID of the Traffic Mirror session.

Returns:

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

setDescription

public void setDescription(String description)

The description to assign to the Traffic Mirror session.

Parameters:

description - The description to assign to the Traffic Mirror session.

getDescription

public String getDescription()

The description to assign to the Traffic Mirror session.

Returns:

The description to assign to the Traffic Mirror session.

withDescription

public ModifyTrafficMirrorSessionRequest withDescription(String description)

The description to assign to the Traffic Mirror session.

Parameters:

description - The description to assign to the Traffic Mirror session.

Returns:

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

getRemoveFields

public List<String> getRemoveFields()

The properties that you want to remove from the Traffic Mirror session.

When you remove a property from a Traffic Mirror session, the property is set to the default.

Returns:

The properties that you want to remove from the Traffic Mirror session.

When you remove a property from a Traffic Mirror session, the property is set to the default.

See Also:

TrafficMirrorSessionField

setRemoveFields

public void setRemoveFields(Collection<String> removeFields)

The properties that you want to remove from the Traffic Mirror session.

When you remove a property from a Traffic Mirror session, the property is set to the default.

Parameters:

removeFields - The properties that you want to remove from the Traffic Mirror session.

When you remove a property from a Traffic Mirror session, the property is set to the default.

See Also:

TrafficMirrorSessionField

withRemoveFields

public ModifyTrafficMirrorSessionRequest withRemoveFields(String... removeFields)

The properties that you want to remove from the Traffic Mirror session.

When you remove a property from a Traffic Mirror session, the property is set to the default.

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

Parameters:

removeFields - The properties that you want to remove from the Traffic Mirror session.

When you remove a property from a Traffic Mirror session, the property is set to the default.

Returns:

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

See Also:

TrafficMirrorSessionField

withRemoveFields

public ModifyTrafficMirrorSessionRequest withRemoveFields(Collection<String> removeFields)

The properties that you want to remove from the Traffic Mirror session.

When you remove a property from a Traffic Mirror session, the property is set to the default.

Parameters:

removeFields - The properties that you want to remove from the Traffic Mirror session.

When you remove a property from a Traffic Mirror session, the property is set to the default.

Returns:

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

See Also:

TrafficMirrorSessionField

withRemoveFields

public ModifyTrafficMirrorSessionRequest withRemoveFields(TrafficMirrorSessionField... removeFields)

The properties that you want to remove from the Traffic Mirror session.

When you remove a property from a Traffic Mirror session, the property is set to the default.

Parameters:

removeFields - The properties that you want to remove from the Traffic Mirror session.

When you remove a property from a Traffic Mirror session, the property is set to the default.

Returns:

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

See Also:

TrafficMirrorSessionField

getDryRunRequest

public Request<ModifyTrafficMirrorSessionRequest> 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<ModifyTrafficMirrorSessionRequest>

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