Package software.amazon.awssdk.services.ec2.model

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 Details

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

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

    • 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 the TagSpecification.Builder avoiding the need to create one manually via TagSpecification.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to tagSpecifications(List<TagSpecification>).

      Parameters:
      tagSpecifications - a consumer that will call methods on TagSpecification.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

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

      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 is DryRunOperation. Otherwise, it is UnauthorizedOperation.
      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)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      CreateTrafficMirrorSessionRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.