CreateFlowLogsCommand

Use a bare-bones client and the command you need to make an API call.

CreateFlowLogsCommandInput

[CreateFlowLogsCommandInput](@aws-sdk/client-ec2!CreateFlowLogsCommandInput:Interface)

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 <a href="https://docs.aws.amazon.com/vpc/latest/userguide/flow-log-records.html">Flow log records</a> 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 <a href="https://docs.aws.amazon.com/vpc/latest/userguide/flow-logs.html">VPC Flow Logs</a> in the Amazon VPC User Guide.

ResourceIds

The IDs of the resources to monitor. For example, if the resource type is <code>VPC</code>, specify the IDs of the VPCs. Constraints: Maximum of 25 for transit gateway resource types. Maximum of 1000 for the other resource types.

ResourceType

ClientToken

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see <a href="https://docs.aws.amazon.com/ec2/latest/devguide/ec2-api-idempotency.html">How to ensure idempotency</a>.

DeliverCrossAccountRole

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

DeliverLogsPermissionArn

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 <code>cloud-watch-logs</code>, or if the destination type is <code>kinesis-data-firehose</code> and the delivery stream and the resources to monitor are in different accounts.

DestinationOptions

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 <code>DryRunOperation</code>. Otherwise, it is <code>UnauthorizedOperation</code>.

LogDestination

The destination for the flow log data. The meaning of this parameter depends on the destination type. <ul> <li> If the destination type is <code>cloud-watch-logs</code>, specify the ARN of a CloudWatch Logs log group. For example: arn:aws:logs:region:account_id:log-group:my_group Alternatively, use the <code>LogGroupName</code> parameter. </li> <li> If the destination type is <code>s3</code>, 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 <code>AWSLogs</code> as a subfolder name. </li> <li> If the destination type is <code>kinesis-data-firehose</code>, specify the ARN of a Kinesis Data Firehose delivery stream. For example: arn:aws:firehose:region:account_id:deliverystream:my_stream </li> </ul>

LogDestinationType

The type of destination for the flow log data. Default: <code>cloud-watch-logs</code>

LogFormat

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 <a href="https://docs.aws.amazon.com/vpc/latest/userguide/flow-log-records.html">Flow log records</a> in the Amazon VPC User Guide or <a href="https://docs.aws.amazon.com/vpc/latest/tgw/tgw-flow-logs.html#flow-log-records">Transit Gateway Flow Log records</a> in the Amazon Web Services Transit Gateway Guide. Specify the fields using the <code>${field-id}</code> format, separated by spaces.

LogGroupName

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 <code>cloud-watch-logs</code>.

MaxAggregationInterval

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 <a href="https://docs.aws.amazon.com/ec2/latest/instancetypes/ec2-nitro-instances.html">Nitro-based instance</a>, the aggregation interval is always 60 seconds or less, regardless of the value that you specify. Default: 600

TagSpecifications

The tags to apply to the flow logs.

TrafficType

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.

The input for [CreateFlowLogsCommand](@aws-sdk/client-ec2!CreateFlowLogsCommand:Class).

$metadata

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

FlowLogIds

Unsuccessful

Information about the flow logs that could not be created successfully.

CreateFlowLogsCommandOutput

The output of [CreateFlowLogsCommand](@aws-sdk/client-ec2!CreateFlowLogsCommand:Class).

$fault

$response

$retryable

(constructor)

options

Constructs a new instance of the <code>ServiceException</code> class

[Symbol.hasInstance]

instance

Custom instanceof check to support the operator for ServiceException base class

isInstance

value

Checks if a value is an instance of ServiceException (duck typed)

EC2ServiceException

Base exception class for all service exceptions from EC2 service.