You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing CreateTrafficMirrorSessionRequest as input to an Aws::Client method, you can use a vanilla 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, egress-only-internet-gateway, 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",
}

See Also:

Instance Attribute Summary collapse

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.

Returns:

  • (String) —

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

#description ⇒ String

The description of the Traffic Mirror session.

Returns:

  • (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. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

Returns:

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

Returns:

  • (String) —

    The ID of the source network interface.

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

Returns:

  • (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. The first session with a matching filter is the one that mirrors the packets.

Valid values are 1-32766.

Returns:

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

Returns:

#traffic_mirror_filter_id ⇒ String

The ID of the Traffic Mirror filter.

Returns:

  • (String) —

    The ID of the Traffic Mirror filter.

#traffic_mirror_target_id ⇒ String

The ID of the Traffic Mirror target.

Returns:

  • (String) —

    The ID of the Traffic Mirror target.

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

Returns:

  • (Integer) —

    The VXLAN ID for the Traffic Mirror session.