software.amazon.awssdk.services.ec2.model

Class CreateTrafficMirrorSessionRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.ec2.model.Ec2Request

software.amazon.awssdk.services.ec2.model.CreateTrafficMirrorSessionRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateTrafficMirrorSessionRequest.Builder,CreateTrafficMirrorSessionRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class CreateTrafficMirrorSessionRequest
extends Ec2Request
implements ToCopyableBuilder<CreateTrafficMirrorSessionRequest.Builder,CreateTrafficMirrorSessionRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateTrafficMirrorSessionRequest.Builder

Method Summary

Modifier and Type	Method and Description
static CreateTrafficMirrorSessionRequest.Builder	builder()
String	clientToken() Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
String	description() The description of the Traffic Mirror session.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasTagSpecifications() For responses, this returns true if the service returned a value for the TagSpecifications property.
String	networkInterfaceId() The ID of the source network interface.
Integer	packetLength() The number of bytes in each packet to mirror.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateTrafficMirrorSessionRequest.Builder>	serializableBuilderClass()
Integer	sessionNumber() The session number determines the order in which sessions are evaluated when an interface is used by multiple sessions.
List<TagSpecification>	tagSpecifications() The tags to assign to a Traffic Mirror session.
CreateTrafficMirrorSessionRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.
String	trafficMirrorFilterId() The ID of the Traffic Mirror filter.
String	trafficMirrorTargetId() The ID of the Traffic Mirror target.
Integer	virtualNetworkId() The VXLAN ID for the Traffic Mirror session.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

networkInterfaceId

public final String networkInterfaceId()

The ID of the source network interface.

Returns:

The ID of the source network interface.

trafficMirrorTargetId

public final String trafficMirrorTargetId()

The ID of the Traffic Mirror target.

Returns:

The ID of the Traffic Mirror target.

trafficMirrorFilterId

public final String trafficMirrorFilterId()

The ID of the Traffic Mirror filter.

Returns:

The ID of the Traffic Mirror filter.

packetLength

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

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.

sessionNumber

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

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.

virtualNetworkId

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

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.

description

public final String description()

The description of the Traffic Mirror session.

Returns:

The description of the Traffic Mirror session.

hasTagSpecifications

public final boolean hasTagSpecifications()

For responses, this returns true if the service returned a value for the TagSpecifications property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

tagSpecifications

public final List<TagSpecification> tagSpecifications()

The tags to assign to a Traffic Mirror session.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTagSpecifications() method.

Returns:

The tags to assign to a Traffic Mirror session.

clientToken

public final String clientToken()

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.

toBuilder

public CreateTrafficMirrorSessionRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateTrafficMirrorSessionRequest.Builder,CreateTrafficMirrorSessionRequest>

Specified by:

toBuilder in class Ec2Request

builder

public static CreateTrafficMirrorSessionRequest.Builder builder()

serializableBuilderClass

public static Class<? extends CreateTrafficMirrorSessionRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final 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

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo