Skip to content

/AWS1/CL_EC2=>CREATETRAFFICMIRRORSESSION()

About CreateTrafficMirrorSession

Creates a Traffic Mirror session.

A Traffic Mirror session actively copies packets from a Traffic Mirror source to a Traffic Mirror target. Create a filter, and then assign it to the session to define a subset of the traffic to mirror, for example all TCP traffic.

The Traffic Mirror source and the Traffic Mirror target (monitoring appliances) can be in the same VPC, or in a different VPC connected via VPC peering or a transit gateway.

By default, no traffic is mirrored. Use CreateTrafficMirrorFilter to create filter rules that specify the traffic to mirror.

Method Signature

IMPORTING

Required arguments:

iv_networkinterfaceid TYPE /AWS1/EC2NETWORKINTERFACEID /AWS1/EC2NETWORKINTERFACEID

The ID of the source network interface.

iv_trafficmirrortargetid TYPE /AWS1/EC2TRAFFICMIRRORTARGETID /AWS1/EC2TRAFFICMIRRORTARGETID

The ID of the Traffic Mirror target.

iv_trafficmirrorfilterid TYPE /AWS1/EC2TRAFFICMIRRORFILTERID /AWS1/EC2TRAFFICMIRRORFILTERID

The ID of the Traffic Mirror filter.

iv_sessionnumber TYPE /AWS1/EC2INTEGER /AWS1/EC2INTEGER

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.

Optional arguments:

iv_packetlength TYPE /AWS1/EC2INTEGER /AWS1/EC2INTEGER

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.

iv_virtualnetworkid TYPE /AWS1/EC2INTEGER /AWS1/EC2INTEGER

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.

iv_description TYPE /AWS1/EC2STRING /AWS1/EC2STRING

The description of the Traffic Mirror session.

it_tagspecifications TYPE /AWS1/CL_EC2TAGSPECIFICATION=>TT_TAGSPECIFICATIONLIST TT_TAGSPECIFICATIONLIST

The tags to assign to a Traffic Mirror session.

iv_dryrun TYPE /AWS1/EC2BOOLEAN /AWS1/EC2BOOLEAN

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.

iv_clienttoken TYPE /AWS1/EC2STRING /AWS1/EC2STRING

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

RETURNING

oo_output TYPE REF TO /aws1/cl_ec2cretrfmirrsessrs /AWS1/CL_EC2CRETRFMIRRSESSRS

Domain /AWS1/RT_ACCOUNT_ID
Primitive Type NUMC

Examples

Syntax Example

This is an example of the syntax for calling the method. It includes every possible argument and initializes every possible value. The data provided is not necessarily semantically accurate (for example the value "string" may be provided for something that is intended to be an instance ID, or in some cases two arguments may be mutually exclusive). The syntax shows the ABAP syntax for creating the various data structures.

DATA(lo_result) = lo_client->/aws1/if_ec2~createtrafficmirrorsession(
  it_tagspecifications = VALUE /aws1/cl_ec2tagspecification=>tt_tagspecificationlist(
    (
      new /aws1/cl_ec2tagspecification(
        it_tags = VALUE /aws1/cl_ec2tag=>tt_taglist(
          (
            new /aws1/cl_ec2tag(
              iv_key = |string|
              iv_value = |string|
            )
          )
        )
        iv_resourcetype = |string|
      )
    )
  )
  iv_clienttoken = |string|
  iv_description = |string|
  iv_dryrun = ABAP_TRUE
  iv_networkinterfaceid = |string|
  iv_packetlength = 123
  iv_sessionnumber = 123
  iv_trafficmirrorfilterid = |string|
  iv_trafficmirrortargetid = |string|
  iv_virtualnetworkid = 123
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lo_trafficmirrorsession = lo_result->get_trafficmirrorsession( ).
  IF lo_trafficmirrorsession IS NOT INITIAL.
    lv_string = lo_trafficmirrorsession->get_trafficmirrorsessionid( ).
    lv_string = lo_trafficmirrorsession->get_trafficmirrortargetid( ).
    lv_string = lo_trafficmirrorsession->get_trafficmirrorfilterid( ).
    lv_string = lo_trafficmirrorsession->get_networkinterfaceid( ).
    lv_string = lo_trafficmirrorsession->get_ownerid( ).
    lv_integer = lo_trafficmirrorsession->get_packetlength( ).
    lv_integer = lo_trafficmirrorsession->get_sessionnumber( ).
    lv_integer = lo_trafficmirrorsession->get_virtualnetworkid( ).
    lv_string = lo_trafficmirrorsession->get_description( ).
    LOOP AT lo_trafficmirrorsession->get_tags( ) into lo_row.
      lo_row_1 = lo_row.
      IF lo_row_1 IS NOT INITIAL.
        lv_string = lo_row_1->get_key( ).
        lv_string = lo_row_1->get_value( ).
      ENDIF.
    ENDLOOP.
  ENDIF.
  lv_string = lo_result->get_clienttoken( ).
ENDIF.