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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb

Overview

Note:

When making an API call, you may pass CreateTrafficMirrorSessionRequest data as a hash:

{
  network_interface_id: "NetworkInterfaceId", # required
  traffic_mirror_target_id: "TrafficMirrorTargetId", # required
  traffic_mirror_filter_id: "TrafficMirrorFilterId", # required
  packet_length: 1,
  session_number: 1, # required
  virtual_network_id: 1,
  description: "String",
  tag_specifications: [
    {
      resource_type: "client-vpn-endpoint", # accepts client-vpn-endpoint, customer-gateway, dedicated-host, dhcp-options, elastic-ip, elastic-gpu, export-image-task, export-instance-task, fleet, fpga-image, host-reservation, image, import-image-task, import-snapshot-task, instance, internet-gateway, key-pair, launch-template, local-gateway-route-table-vpc-association, natgateway, network-acl, network-interface, placement-group, reserved-instances, route-table, security-group, snapshot, spot-fleet-request, spot-instances-request, subnet, traffic-mirror-filter, traffic-mirror-session, traffic-mirror-target, transit-gateway, transit-gateway-attachment, transit-gateway-multicast-domain, transit-gateway-route-table, volume, vpc, vpc-peering-connection, vpn-connection, vpn-gateway, vpc-flow-log
      tags: [
        {
          key: "String",
          value: "String",
        },
      ],
    },
  ],
  dry_run: false,
  client_token: "String",
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#client_tokenString

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.

Returns:

  • (String)


8348
8349
8350
8351
8352
8353
8354
8355
8356
8357
8358
8359
8360
8361
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 8348

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

#descriptionString

The description of the Traffic Mirror session.

Returns:

  • (String)


8348
8349
8350
8351
8352
8353
8354
8355
8356
8357
8358
8359
8360
8361
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 8348

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_runBoolean

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)


8348
8349
8350
8351
8352
8353
8354
8355
8356
8357
8358
8359
8360
8361
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 8348

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_idString

The ID of the source network interface.

Returns:

  • (String)


8348
8349
8350
8351
8352
8353
8354
8355
8356
8357
8358
8359
8360
8361
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 8348

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_lengthInteger

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:

  • (Integer)


8348
8349
8350
8351
8352
8353
8354
8355
8356
8357
8358
8359
8360
8361
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 8348

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_numberInteger

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)


8348
8349
8350
8351
8352
8353
8354
8355
8356
8357
8358
8359
8360
8361
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 8348

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_specificationsArray<Types::TagSpecification>

The tags to assign to a Traffic Mirror session.

Returns:



8348
8349
8350
8351
8352
8353
8354
8355
8356
8357
8358
8359
8360
8361
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 8348

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_idString

The ID of the Traffic Mirror filter.

Returns:

  • (String)


8348
8349
8350
8351
8352
8353
8354
8355
8356
8357
8358
8359
8360
8361
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 8348

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_idString

The ID of the Traffic Mirror target.

Returns:

  • (String)


8348
8349
8350
8351
8352
8353
8354
8355
8356
8357
8358
8359
8360
8361
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 8348

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_idInteger

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:

  • (Integer)


8348
8349
8350
8351
8352
8353
8354
8355
8356
8357
8358
8359
8360
8361
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 8348

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