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

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 ModifyTrafficMirrorSessionRequest data as a 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,
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#descriptionString

The description to assign to the Traffic Mirror session.

Returns:

  • (String)


36421
36422
36423
36424
36425
36426
36427
36428
36429
36430
36431
36432
36433
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 36421

class ModifyTrafficMirrorSessionRequest < Struct.new(
  :traffic_mirror_session_id,
  :traffic_mirror_target_id,
  :traffic_mirror_filter_id,
  :packet_length,
  :session_number,
  :virtual_network_id,
  :description,
  :remove_fields,
  :dry_run)
  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)


36421
36422
36423
36424
36425
36426
36427
36428
36429
36430
36431
36432
36433
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 36421

class ModifyTrafficMirrorSessionRequest < Struct.new(
  :traffic_mirror_session_id,
  :traffic_mirror_target_id,
  :traffic_mirror_filter_id,
  :packet_length,
  :session_number,
  :virtual_network_id,
  :description,
  :remove_fields,
  :dry_run)
  SENSITIVE = []
  include Aws::Structure
end

#packet_lengthInteger

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)


36421
36422
36423
36424
36425
36426
36427
36428
36429
36430
36431
36432
36433
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 36421

class ModifyTrafficMirrorSessionRequest < Struct.new(
  :traffic_mirror_session_id,
  :traffic_mirror_target_id,
  :traffic_mirror_filter_id,
  :packet_length,
  :session_number,
  :virtual_network_id,
  :description,
  :remove_fields,
  :dry_run)
  SENSITIVE = []
  include Aws::Structure
end

#remove_fieldsArray<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>)


36421
36422
36423
36424
36425
36426
36427
36428
36429
36430
36431
36432
36433
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 36421

class ModifyTrafficMirrorSessionRequest < Struct.new(
  :traffic_mirror_session_id,
  :traffic_mirror_target_id,
  :traffic_mirror_filter_id,
  :packet_length,
  :session_number,
  :virtual_network_id,
  :description,
  :remove_fields,
  :dry_run)
  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)


36421
36422
36423
36424
36425
36426
36427
36428
36429
36430
36431
36432
36433
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 36421

class ModifyTrafficMirrorSessionRequest < Struct.new(
  :traffic_mirror_session_id,
  :traffic_mirror_target_id,
  :traffic_mirror_filter_id,
  :packet_length,
  :session_number,
  :virtual_network_id,
  :description,
  :remove_fields,
  :dry_run)
  SENSITIVE = []
  include Aws::Structure
end

#traffic_mirror_filter_idString

The ID of the Traffic Mirror filter.

Returns:

  • (String)


36421
36422
36423
36424
36425
36426
36427
36428
36429
36430
36431
36432
36433
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 36421

class ModifyTrafficMirrorSessionRequest < Struct.new(
  :traffic_mirror_session_id,
  :traffic_mirror_target_id,
  :traffic_mirror_filter_id,
  :packet_length,
  :session_number,
  :virtual_network_id,
  :description,
  :remove_fields,
  :dry_run)
  SENSITIVE = []
  include Aws::Structure
end

#traffic_mirror_session_idString

The ID of the Traffic Mirror session.

Returns:

  • (String)


36421
36422
36423
36424
36425
36426
36427
36428
36429
36430
36431
36432
36433
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 36421

class ModifyTrafficMirrorSessionRequest < Struct.new(
  :traffic_mirror_session_id,
  :traffic_mirror_target_id,
  :traffic_mirror_filter_id,
  :packet_length,
  :session_number,
  :virtual_network_id,
  :description,
  :remove_fields,
  :dry_run)
  SENSITIVE = []
  include Aws::Structure
end

#traffic_mirror_target_idString

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)


36421
36422
36423
36424
36425
36426
36427
36428
36429
36430
36431
36432
36433
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 36421

class ModifyTrafficMirrorSessionRequest < Struct.new(
  :traffic_mirror_session_id,
  :traffic_mirror_target_id,
  :traffic_mirror_filter_id,
  :packet_length,
  :session_number,
  :virtual_network_id,
  :description,
  :remove_fields,
  :dry_run)
  SENSITIVE = []
  include Aws::Structure
end

#virtual_network_idInteger

The virtual network ID of the Traffic Mirror session.

Returns:

  • (Integer)


36421
36422
36423
36424
36425
36426
36427
36428
36429
36430
36431
36432
36433
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 36421

class ModifyTrafficMirrorSessionRequest < Struct.new(
  :traffic_mirror_session_id,
  :traffic_mirror_target_id,
  :traffic_mirror_filter_id,
  :packet_length,
  :session_number,
  :virtual_network_id,
  :description,
  :remove_fields,
  :dry_run)
  SENSITIVE = []
  include Aws::Structure
end