ec2_create_flow_logs {aws.ecx}

Create Flow Logs

Description

Create Flow Logs

Usage

ec2_create_flow_logs(
  ResourceId,
  ResourceType,
  TrafficType,
  DryRun = NULL,
  ClientToken = NULL,
  DeliverLogsPermissionArn = NULL,
  LogGroupName = NULL,
  LogDestinationType = NULL,
  LogDestination = NULL,
  LogFormat = NULL,
  TagSpecification = NULL,
  MaxAggregationInterval = 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

ResourceId

List. The ID of the subnet, network interface, or VPC for which you want to create a flow log.

ResourceType

Character. The type of resource for which to create the flow log.

TrafficType

Character. The type of traffic to log.

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]

DeliverLogsPermissionArn

Character. The ARN for the IAM role that permits Amazon EC2 to publish flow logs to a CloudWatch Logs log...[optional]

LogGroupName

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

LogDestinationType

Character. Specifies the type of destination to which the flow log data is to be published.[optional]

LogDestination

Character. Specifies the destination to which the flow log data is to be published.[optional]

LogFormat

Character. The fields to include in the flow log record, in the order in which they should appear.[optional]

TagSpecification

List. The tags to apply to the flow logs.[optional]

MaxAggregationInterval

Integer. The maximum interval of time during which a flow of packets is captured and aggregated into a flow...[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

ResourceId

The ID of the subnet, network interface, or VPC for which you want to create a flow log.

Constraints: Maximum of 1000 resources

ResourceType

The type of resource for which to create the flow log. For example, if you specified a VPC ID for the ResourceId property, specify VPC for this property.

TrafficType

The type of traffic to log. You can log traffic that the resource accepts or rejects, or all traffic.

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.

DeliverLogsPermissionArn

The ARN for the IAM role that permits Amazon EC2 to publish flow logs to a CloudWatch Logs log group in your account.

If you specify LogDestinationType as s3, do not specify DeliverLogsPermissionArn or LogGroupName.

LogGroupName

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

If you specify LogDestinationType as s3, do not specify DeliverLogsPermissionArn or LogGroupName.

LogDestinationType

Specifies the type of destination to which the flow log data is to be published. Flow log data can be published to CloudWatch Logs or Amazon S3. To publish flow log data to CloudWatch Logs, specify cloud-watch-logs. To publish flow log data to Amazon S3, specify s3.

If you specify LogDestinationType as s3, do not specify DeliverLogsPermissionArn or LogGroupName.

Default: cloud-watch-logs

LogDestination

Specifies the destination to which the flow log data is to be published. Flow log data can be published to a CloudWatch Logs log group or an Amazon S3 bucket. The value specified for this parameter depends on the value specified for LogDestinationType.

If LogDestinationType is not specified or cloud-watch-logs, specify the Amazon Resource Name (ARN) of the CloudWatch Logs log group. For example, to publish to a log group called my-logs, specify arn:aws:logs:us-east-1:123456789012:log-group:my-logs. Alternatively, use LogGroupName instead.

If LogDestinationType is s3, specify the ARN of the Amazon S3 bucket. You can also specify a subfolder in the bucket. To specify a subfolder in the bucket, use the following ARN format: ⁠bucket_ARN/subfolder_name/⁠. For example, to specify a subfolder named my-logs in a bucket named my-bucket, use the following ARN: ⁠arn:aws:s3:::my-bucket/my-logs/⁠. You cannot use AWSLogs as a subfolder name. This is a reserved term.

LogFormat

The fields to include in the flow log record, in the order in which they should appear. For a list of available fields, see Flow Log Records. If you omit this parameter, the flow log is created using the default format. If you specify this parameter, you must specify at least one field.

Specify the fields using the ⁠${field-id}⁠ format, separated by spaces. For the AWS CLI, use single quotation marks (\' \') to surround the parameter value.

TagSpecification

The tags to apply to the flow logs.

MaxAggregationInterval

The maximum interval of time during which a flow of packets is captured and aggregated into a flow log record. You can specify 60 seconds (1 minute) or 600 seconds (10 minutes).

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