Package 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("software.amazon.awssdk:codegen") public final class CreateTrafficMirrorSessionRequest extends Ec2Request implements ToCopyableBuilder<CreateTrafficMirrorSessionRequest.Builder,CreateTrafficMirrorSessionRequest>

  • Method Details

    • 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.

      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.

    • 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.

    • dryRun

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

      Returns:
      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 is UnauthorizedOperation.

    • 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

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo