Skip to contents

Creates a Traffic Mirror session

Source: R/ec2_operations.R
ec2_create_traffic_mirror_session.Rd

Creates a Traffic Mirror session.

See https://www.paws-r-sdk.com/docs/ec2_create_traffic_mirror_session/ for full documentation.

Usage

ec2_create_traffic_mirror_session(
  NetworkInterfaceId,
  TrafficMirrorTargetId,
  TrafficMirrorFilterId,
  PacketLength = NULL,
  SessionNumber,
  VirtualNetworkId = NULL,
  Description = NULL,
  TagSpecifications = NULL,
  DryRun = NULL,
  ClientToken = NULL
)

Arguments

NetworkInterfaceId

[required] The ID of the source network interface.

TrafficMirrorTargetId

[required] The ID of the Traffic Mirror target.

TrafficMirrorFilterId

[required] The ID of the Traffic Mirror filter.

PacketLength

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.

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

[required] 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 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.

Description

The description of the Traffic Mirror session.

TagSpecifications

The tags to assign to a Traffic Mirror session.

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.

ClientToken

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.