Amazon Elastic Compute Cloud
API Reference (API Version 2016-11-15)

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 Virtual Private Cloud 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 Virtual Private Cloud User Guide.

Request Parameters

The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see Common Query Parameters.

ClientToken

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

Type: String

Required: No

DeliverLogsPermissionArn

The ARN for the IAM role that's used to post flow logs to a log group.

Type: String

Required: No

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.

Type: Boolean

Required: No

LogDestination

Specifies the destination to which the flow log data is to be published. Flow log data can be published to an 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.

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.

Type: String

Required: No

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.

Default: cloud-watch-logs

Type: String

Valid Values: cloud-watch-logs | s3

Required: No

LogGroupName

The name of the log group.

Type: String

Required: No

ResourceId.N

One or more subnet, network interface, or VPC IDs.

Constraints: Maximum of 1000 resources

Type: Array of strings

Required: Yes

ResourceType

The type of resource on which to create the flow log.

Type: String

Valid Values: VPC | Subnet | NetworkInterface

Required: Yes

TrafficType

The type of traffic to log.

Type: String

Valid Values: ACCEPT | REJECT | ALL

Required: Yes

Response Elements

The following elements are returned by the service.

clientToken

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

Type: String

flowLogIdSet

The IDs of the flow logs.

Type: Array of strings

requestId

The ID of the request.

Type: String

unsuccessful

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

Type: Array of UnsuccessfulItem objects

Errors

For information about the errors that are common to all actions, see Common Client Errors.

Examples

Example 1

This example creates a flow log that captures all rejected traffic for network interface eni-aa22bb33 and publishes the data to an CloudWatch Logs log group named my-flow-logs in account 123456789101, using the IAM role publishFlowLogs.

Sample Request

https://ec2.amazonaws.com/?Action=CreateFlowLogs &ResourceType=NetworkInterface &TrafficType=REJECT &ResourceId.1=eni-aa22bb33 &DeliverLogsPermissionArn=arn:aws:iam::123456789101:role/publishFlowLogs &LogDestinationType=cloud-watch-logs &LogDestination=arn:aws:logs:us-east-1:123456789101:log-group:my-flow-logs &AUTHPARAMS

Sample Response

<CreateFlowLogsResponse xmlns="http://ec2.amazonaws.com/doc/2016-11-15/"> <requestId>2d96dae3-504b-4fc4-bf50-266EXAMPLE</requestId> <unsuccessful/> <flowLogIdSet> <item>fl-1a2b3c4d</item> </flowLogIdSet> </CreateFlowLogsResponse>

Example 2

This example creates a flow log that captures all traffic for network interface eni-aa22bb33 and publishes the data to an Amazon S3 bucket named my-bucket in account 123456789101.

Sample Request

https://ec2.amazonaws.com/?Action=CreateFlowLogs &ResourceType=NetworkInterface &TrafficType=ALL &ResourceId.1=eni-aa22bb33 &LogDestinationType=s3 &LogDestination=arn:aws:s3:::my-flow-log-bucket &AUTHPARAMS

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: