Skip to content

/AWS1/IF_EC2=>CREATEFLOWLOGS()

About CreateFlowLogs

Creates one or more flow logs to capture information about IP traffic for a specific network interface, subnet, or VPC.

Flow log data for a monitored network interface is recorded as flow log records, which are log events consisting of fields that describe the traffic flow. For more information, see Flow log records in the Amazon VPC User Guide.

When publishing to CloudWatch Logs, flow log records are published to a log group, and each network interface has a unique log stream in the log group. When publishing to Amazon S3, flow log records for all of the monitored network interfaces are published to a single log file object that is stored in the specified bucket.

For more information, see VPC Flow Logs in the Amazon VPC User Guide.

Method Signature

METHODS /AWS1/IF_EC2~CREATEFLOWLOGS
  IMPORTING
    !IV_DRYRUN TYPE /AWS1/EC2BOOLEAN OPTIONAL
    !IV_CLIENTTOKEN TYPE /AWS1/EC2STRING OPTIONAL
    !IV_DELIVERLOGSPERMISSIONARN TYPE /AWS1/EC2STRING OPTIONAL
    !IV_DELIVERCROSSACCOUNTROLE TYPE /AWS1/EC2STRING OPTIONAL
    !IV_LOGGROUPNAME TYPE /AWS1/EC2STRING OPTIONAL
    !IT_RESOURCEIDS TYPE /AWS1/CL_EC2FLOWLOGRESRCIDS_W=>TT_FLOWLOGRESOURCEIDS OPTIONAL
    !IV_RESOURCETYPE TYPE /AWS1/EC2FLOWLOGSRESOURCETYPE OPTIONAL
    !IV_TRAFFICTYPE TYPE /AWS1/EC2TRAFFICTYPE OPTIONAL
    !IV_LOGDESTINATIONTYPE TYPE /AWS1/EC2LOGDESTINATIONTYPE OPTIONAL
    !IV_LOGDESTINATION TYPE /AWS1/EC2STRING OPTIONAL
    !IV_LOGFORMAT TYPE /AWS1/EC2STRING OPTIONAL
    !IT_TAGSPECIFICATIONS TYPE /AWS1/CL_EC2TAGSPECIFICATION=>TT_TAGSPECIFICATIONLIST OPTIONAL
    !IV_MAXAGGREGATIONINTERVAL TYPE /AWS1/EC2INTEGER OPTIONAL
    !IO_DESTINATIONOPTIONS TYPE REF TO /AWS1/CL_EC2DSTOPTIONSREQUEST OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_ec2createflowlogsrslt
  RAISING
    /AWS1/CX_EC2CLIENTEXC
    /AWS1/CX_EC2SERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

it_resourceids TYPE /AWS1/CL_EC2FLOWLOGRESRCIDS_W=>TT_FLOWLOGRESOURCEIDS TT_FLOWLOGRESOURCEIDS

The IDs of the resources to monitor. For example, if the resource type is VPC, specify the IDs of the VPCs.

Constraints: Maximum of 25 for transit gateway resource types. Maximum of 1000 for the other resource types.

iv_resourcetype TYPE /AWS1/EC2FLOWLOGSRESOURCETYPE /AWS1/EC2FLOWLOGSRESOURCETYPE

The type of resource to monitor.

Optional arguments:

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.

iv_deliverlogspermissionarn TYPE /AWS1/EC2STRING /AWS1/EC2STRING

The ARN of the IAM role that allows Amazon EC2 to publish flow logs to the log destination.

This parameter is required if the destination type is cloud-watch-logs, or if the destination type is kinesis-data-firehose and the delivery stream and the resources to monitor are in different accounts.

iv_delivercrossaccountrole TYPE /AWS1/EC2STRING /AWS1/EC2STRING

The ARN of the IAM role that allows Amazon EC2 to publish flow logs across accounts.

iv_loggroupname TYPE /AWS1/EC2STRING /AWS1/EC2STRING

The name of a new or existing CloudWatch Logs log group where Amazon EC2 publishes your flow logs.

This parameter is valid only if the destination type is cloud-watch-logs.

iv_traffictype TYPE /AWS1/EC2TRAFFICTYPE /AWS1/EC2TRAFFICTYPE

The type of traffic to monitor (accepted traffic, rejected traffic, or all traffic). This parameter is not supported for transit gateway resource types. It is required for the other resource types.

iv_logdestinationtype TYPE /AWS1/EC2LOGDESTINATIONTYPE /AWS1/EC2LOGDESTINATIONTYPE

The type of destination for the flow log data.

Default: cloud-watch-logs

iv_logdestination TYPE /AWS1/EC2STRING /AWS1/EC2STRING

The destination for the flow log data. The meaning of this parameter depends on the destination type.

  • If the destination type is cloud-watch-logs, specify the ARN of a CloudWatch Logs log group. For example:

    arn:aws:logs:region:account_id:log-group:my_group

    Alternatively, use the LogGroupName parameter.

  • If the destination type is s3, specify the ARN of an S3 bucket. For example:

    arn:aws:s3:::my_bucket/my_subfolder/

    The subfolder is optional. Note that you can't use AWSLogs as a subfolder name.

  • If the destination type is kinesis-data-firehose, specify the ARN of a Kinesis Data Firehose delivery stream. For example:

    arn:aws:firehose:region:account_id:deliverystream:my_stream

iv_logformat TYPE /AWS1/EC2STRING /AWS1/EC2STRING

The fields to include in the flow log record. List the fields in the order in which they should appear. If you omit this parameter, the flow log is created using the default format. If you specify this parameter, you must include at least one field. For more information about the available fields, see Flow log records in the Amazon VPC User Guide or Transit Gateway Flow Log records in the Amazon Web Services Transit Gateway Guide.

Specify the fields using the ${field-id} format, separated by spaces.

it_tagspecifications TYPE /AWS1/CL_EC2TAGSPECIFICATION=>TT_TAGSPECIFICATIONLIST TT_TAGSPECIFICATIONLIST

The tags to apply to the flow logs.

iv_maxaggregationinterval TYPE /AWS1/EC2INTEGER /AWS1/EC2INTEGER

The maximum interval of time during which a flow of packets is captured and aggregated into a flow log record. The possible values are 60 seconds (1 minute) or 600 seconds (10 minutes). This parameter must be 60 seconds for transit gateway resource types.

When a network interface is attached to a Nitro-based instance, the aggregation interval is always 60 seconds or less, regardless of the value that you specify.

Default: 600

io_destinationoptions TYPE REF TO /AWS1/CL_EC2DSTOPTIONSREQUEST /AWS1/CL_EC2DSTOPTIONSREQUEST

The destination options.

RETURNING

oo_output TYPE REF TO /aws1/cl_ec2createflowlogsrslt /AWS1/CL_EC2CREATEFLOWLOGSRSLT

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->createflowlogs(
  io_destinationoptions = new /aws1/cl_ec2dstoptionsrequest(
    iv_fileformat = |string|
    iv_hivecompatiblepartitions = ABAP_TRUE
    iv_perhourpartition = ABAP_TRUE
  )
  it_resourceids = VALUE /aws1/cl_ec2flowlogresrcids_w=>tt_flowlogresourceids(
    ( new /aws1/cl_ec2flowlogresrcids_w( |string| ) )
  )
  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_delivercrossaccountrole = |string|
  iv_deliverlogspermissionarn = |string|
  iv_dryrun = ABAP_TRUE
  iv_logdestination = |string|
  iv_logdestinationtype = |string|
  iv_logformat = |string|
  iv_loggroupname = |string|
  iv_maxaggregationinterval = 123
  iv_resourcetype = |string|
  iv_traffictype = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_string = lo_result->get_clienttoken( ).
  LOOP AT lo_result->get_flowlogids( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_string = lo_row_1->get_value( ).
    ENDIF.
  ENDLOOP.
  LOOP AT lo_result->get_unsuccessful( ) into lo_row_2.
    lo_row_3 = lo_row_2.
    IF lo_row_3 IS NOT INITIAL.
      lo_unsuccessfulitemerror = lo_row_3->get_error( ).
      IF lo_unsuccessfulitemerror IS NOT INITIAL.
        lv_string = lo_unsuccessfulitemerror->get_code( ).
        lv_string = lo_unsuccessfulitemerror->get_message( ).
      ENDIF.
      lv_string = lo_row_3->get_resourceid( ).
    ENDIF.
  ENDLOOP.
ENDIF.