Class: Aws::EC2::Types::CreateTrafficMirrorSessionRequest

Inherits:

Struct

• Object
• Struct
• Aws::EC2::Types::CreateTrafficMirrorSessionRequest

Includes:

Structure

Defined in:

lib/aws-sdk-ec2/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #client_token ⇒ String

  Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

• #description ⇒ String

  The description of the Traffic Mirror session.

• #dry_run ⇒ Boolean

  Checks whether you have the required permissions for the action, without actually making the request, and provides an error response.

• #network_interface_id ⇒ String

  The ID of the source network interface.

• #packet_length ⇒ Integer

  The number of bytes in each packet to mirror.

• #session_number ⇒ Integer

  The session number determines the order in which sessions are evaluated when an interface is used by multiple sessions.

• #tag_specifications ⇒ Array<Types::TagSpecification>

  The tags to assign to a Traffic Mirror session.

• #traffic_mirror_filter_id ⇒ String

  The ID of the Traffic Mirror filter.

• #traffic_mirror_target_id ⇒ String

  The ID of the Traffic Mirror target.

• #virtual_network_id ⇒ Integer

  The VXLAN ID for the Traffic Mirror session.

Instance Attribute Details

#client_token ⇒ String

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

**A suitable default value is auto-generated.** You should normally not need to pass this option.

[1]: docs.aws.amazon.com/ec2/latest/devguide/ec2-api-idempotency.html

Returns:

• (String)

# File 'lib/aws-sdk-ec2/types.rb', line 12180

class CreateTrafficMirrorSessionRequest < Struct.new(
  :network_interface_id,
  :traffic_mirror_target_id,
  :traffic_mirror_filter_id,
  :packet_length,
  :session_number,
  :virtual_network_id,
  :description,
  :tag_specifications,
  :dry_run,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ String

The description of the Traffic Mirror session.

Returns:

• (String)

# File 'lib/aws-sdk-ec2/types.rb', line 12180

class CreateTrafficMirrorSessionRequest < Struct.new(
  :network_interface_id,
  :traffic_mirror_target_id,
  :traffic_mirror_filter_id,
  :packet_length,
  :session_number,
  :virtual_network_id,
  :description,
  :tag_specifications,
  :dry_run,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#dry_run ⇒ Boolean

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:

• (Boolean)

# File 'lib/aws-sdk-ec2/types.rb', line 12180

class CreateTrafficMirrorSessionRequest < Struct.new(
  :network_interface_id,
  :traffic_mirror_target_id,
  :traffic_mirror_filter_id,
  :packet_length,
  :session_number,
  :virtual_network_id,
  :description,
  :tag_specifications,
  :dry_run,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#network_interface_id ⇒ String

The ID of the source network interface.

Returns:

• (String)

# File 'lib/aws-sdk-ec2/types.rb', line 12180

class CreateTrafficMirrorSessionRequest < Struct.new(
  :network_interface_id,
  :traffic_mirror_target_id,
  :traffic_mirror_filter_id,
  :packet_length,
  :session_number,
  :virtual_network_id,
  :description,
  :tag_specifications,
  :dry_run,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#packet_length ⇒ Integer

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:

• (Integer)

# File 'lib/aws-sdk-ec2/types.rb', line 12180

class CreateTrafficMirrorSessionRequest < Struct.new(
  :network_interface_id,
  :traffic_mirror_target_id,
  :traffic_mirror_filter_id,
  :packet_length,
  :session_number,
  :virtual_network_id,
  :description,
  :tag_specifications,
  :dry_run,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#session_number ⇒ Integer

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:

• (Integer)

# File 'lib/aws-sdk-ec2/types.rb', line 12180

class CreateTrafficMirrorSessionRequest < Struct.new(
  :network_interface_id,
  :traffic_mirror_target_id,
  :traffic_mirror_filter_id,
  :packet_length,
  :session_number,
  :virtual_network_id,
  :description,
  :tag_specifications,
  :dry_run,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#tag_specifications ⇒ Array<Types::TagSpecification>

The tags to assign to a Traffic Mirror session.

Returns:

• (Array<Types::TagSpecification>)

# File 'lib/aws-sdk-ec2/types.rb', line 12180

class CreateTrafficMirrorSessionRequest < Struct.new(
  :network_interface_id,
  :traffic_mirror_target_id,
  :traffic_mirror_filter_id,
  :packet_length,
  :session_number,
  :virtual_network_id,
  :description,
  :tag_specifications,
  :dry_run,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#traffic_mirror_filter_id ⇒ String

The ID of the Traffic Mirror filter.

Returns:

• (String)

# File 'lib/aws-sdk-ec2/types.rb', line 12180

class CreateTrafficMirrorSessionRequest < Struct.new(
  :network_interface_id,
  :traffic_mirror_target_id,
  :traffic_mirror_filter_id,
  :packet_length,
  :session_number,
  :virtual_network_id,
  :description,
  :tag_specifications,
  :dry_run,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#traffic_mirror_target_id ⇒ String

The ID of the Traffic Mirror target.

Returns:

• (String)

# File 'lib/aws-sdk-ec2/types.rb', line 12180

class CreateTrafficMirrorSessionRequest < Struct.new(
  :network_interface_id,
  :traffic_mirror_target_id,
  :traffic_mirror_filter_id,
  :packet_length,
  :session_number,
  :virtual_network_id,
  :description,
  :tag_specifications,
  :dry_run,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#virtual_network_id ⇒ Integer

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.

[1]: datatracker.ietf.org/doc/html/rfc7348

Returns:

• (Integer)

# File 'lib/aws-sdk-ec2/types.rb', line 12180

class CreateTrafficMirrorSessionRequest < Struct.new(
  :network_interface_id,
  :traffic_mirror_target_id,
  :traffic_mirror_filter_id,
  :packet_length,
  :session_number,
  :virtual_network_id,
  :description,
  :tag_specifications,
  :dry_run,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end