ec2_create_traffic_mirror_session {aws.ecx}

Create Traffic Mirror Session

Description

Create Traffic Mirror Session

Usage

ec2_create_traffic_mirror_session(
  NetworkInterfaceId,
  TrafficMirrorTargetId,
  TrafficMirrorFilterId,
  SessionNumber,
  PacketLength = NULL,
  VirtualNetworkId = NULL,
  Description = NULL,
  TagSpecification = NULL,
  DryRun = NULL,
  ClientToken = NULL,
  simplify = TRUE,
  others = list(),
  print_on_error = aws_get_print_on_error(),
  retry_time = aws_get_retry_time(),
  network_timeout = aws_get_network_timeout(),
  region = aws_get_region()
)

Arguments

NetworkInterfaceId

Character. The ID of the source network interface.

TrafficMirrorTargetId

Character. The ID of the Traffic Mirror target.

TrafficMirrorFilterId

Character. The ID of the Traffic Mirror filter.

SessionNumber

Integer. The session number determines the order in which sessions are evaluated when an interface is used...

PacketLength

Integer. The number of bytes in each packet to mirror.[optional]

VirtualNetworkId

Integer. The VXLAN ID for the Traffic Mirror session.[optional]

Description

Character. The description of the Traffic Mirror session.[optional]

TagSpecification

List. The tags to assign to a Traffic Mirror session.[optional]

DryRun

Logical. Checks whether you have the required permissions for the action, without actually making the request,...[optional]

ClientToken

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

simplify

Logical. Whether to simplify the result and handle nextToken in the response[optional]

others

Named list. The parameters that are not included in the function parameters and need to be added into the request[optional]

print_on_error

Logical. Whether to show an error message when a network error occurs.

retry_time

Integer. Number of retries for a REST request when encounter the network issue. If the request has been sent retry_time times but still not be able to get the response, an error will be thrown.

network_timeout

Numeric. Number of seconds to wait for a REST response until giving up. Can not be less than 1 ms.

region

Character. The region of the AWS service.

Value

A list object or a character vector

NetworkInterfaceId

The ID of the source network interface.

TrafficMirrorTargetId

The ID of the Traffic Mirror target.

TrafficMirrorFilterId

The ID of the Traffic Mirror filter.

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.

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.

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.

TagSpecification

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.