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

Class: Aws::EC2::Types::ModifyTrafficMirrorSessionRequest

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

Overview

Note:

When passing ModifyTrafficMirrorSessionRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  traffic_mirror_session_id: "TrafficMirrorSessionId", # required
  traffic_mirror_target_id: "TrafficMirrorTargetId",
  traffic_mirror_filter_id: "TrafficMirrorFilterId",
  packet_length: 1,
  session_number: 1,
  virtual_network_id: 1,
  description: "String",
  remove_fields: ["packet-length"], # accepts packet-length, description, virtual-network-id
  dry_run: false,
}

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#description ⇒ String

The description to assign to the Traffic Mirror session.

Returns:

  • (String) —

    The description to assign to 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.

#packet_length ⇒ Integer

The number of bytes in each packet to mirror. These are bytes after the VXLAN header. To mirror a subset, set this to the length (in bytes) 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. Do not specify this parameter when you want to mirror the entire packet.

Returns:

  • (Integer) —

    The number of bytes in each packet to mirror.

#remove_fields ⇒ Array<String>

The properties that you want to remove from the Traffic Mirror session.

When you remove a property from a Traffic Mirror session, the property is set to the default.

Returns:

  • (Array<String>) —

    The properties that you want to remove from the Traffic Mirror session.

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

#traffic_mirror_filter_id ⇒ String

The ID of the Traffic Mirror filter.

Returns:

  • (String) —

    The ID of the Traffic Mirror filter.

#traffic_mirror_session_id ⇒ String

The ID of the Traffic Mirror session.

Returns:

  • (String) —

    The ID of the Traffic Mirror session.

#traffic_mirror_target_id ⇒ String

The Traffic Mirror target. The target must be in the same VPC as the source, or have a VPC peering connection with the source.

Returns:

  • (String) —

    The Traffic Mirror target.

#virtual_network_id ⇒ Integer

The virtual network ID of the Traffic Mirror session.

Returns:

  • (Integer) —

    The virtual network ID of the Traffic Mirror session.