Skip to content

Modify Traffic Mirror Session

ec2_modify_traffic_mirror_session R Documentation

Modifies a Traffic Mirror session

Description

Modifies a Traffic Mirror session.

Usage

ec2_modify_traffic_mirror_session(TrafficMirrorSessionId,
  TrafficMirrorTargetId, TrafficMirrorFilterId, PacketLength,
  SessionNumber, VirtualNetworkId, Description, RemoveFields, DryRun)

Arguments

TrafficMirrorSessionId

[required] The ID of the Traffic Mirror session.

TrafficMirrorTargetId

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

TrafficMirrorFilterId

The ID of the Traffic Mirror filter.

PacketLength

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.

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.

SessionNumber

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.

VirtualNetworkId

The virtual network ID of the Traffic Mirror session.

Description

The description to assign to the Traffic Mirror session.

RemoveFields

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.

DryRun

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.

Value

A list with the following syntax: 

list(
  TrafficMirrorSession = list(
    TrafficMirrorSessionId = "string",
    TrafficMirrorTargetId = "string",
    TrafficMirrorFilterId = "string",
    NetworkInterfaceId = "string",
    OwnerId = "string",
    PacketLength = 123,
    SessionNumber = 123,
    VirtualNetworkId = 123,
    Description = "string",
    Tags = list(
      list(
        Key = "string",
        Value = "string"
      )
    )
  )
)

Request syntax

svc$modify_traffic_mirror_session(
  TrafficMirrorSessionId = "string",
  TrafficMirrorTargetId = "string",
  TrafficMirrorFilterId = "string",
  PacketLength = 123,
  SessionNumber = 123,
  VirtualNetworkId = 123,
  Description = "string",
  RemoveFields = list(
    "packet-length"|"description"|"virtual-network-id"
  ),
  DryRun = TRUE|FALSE
)