Navigation Guide
You are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.

CreateFlowLogsCommand

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.

Example Syntax

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

import { EC2Client, CreateFlowLogsCommand } from "@aws-sdk/client-ec2"; // ES Modules import
// const { EC2Client, CreateFlowLogsCommand } = require("@aws-sdk/client-ec2"); // CommonJS import
const client = new EC2Client(config);
const input = { // CreateFlowLogsRequest
  DryRun: true || false,
  ClientToken: "STRING_VALUE",
  DeliverLogsPermissionArn: "STRING_VALUE",
  DeliverCrossAccountRole: "STRING_VALUE",
  LogGroupName: "STRING_VALUE",
  ResourceIds: [ // FlowLogResourceIds // required
    "STRING_VALUE",
  ],
  ResourceType: "VPC" || "Subnet" || "NetworkInterface" || "TransitGateway" || "TransitGatewayAttachment", // required
  TrafficType: "ACCEPT" || "REJECT" || "ALL",
  LogDestinationType: "cloud-watch-logs" || "s3" || "kinesis-data-firehose",
  LogDestination: "STRING_VALUE",
  LogFormat: "STRING_VALUE",
  TagSpecifications: [ // TagSpecificationList
    { // TagSpecification
      ResourceType: "capacity-reservation" || "client-vpn-endpoint" || "customer-gateway" || "carrier-gateway" || "coip-pool" || "declarative-policies-report" || "dedicated-host" || "dhcp-options" || "egress-only-internet-gateway" || "elastic-ip" || "elastic-gpu" || "export-image-task" || "export-instance-task" || "fleet" || "fpga-image" || "host-reservation" || "image" || "import-image-task" || "import-snapshot-task" || "instance" || "instance-event-window" || "internet-gateway" || "ipam" || "ipam-pool" || "ipam-scope" || "ipv4pool-ec2" || "ipv6pool-ec2" || "key-pair" || "launch-template" || "local-gateway" || "local-gateway-route-table" || "local-gateway-virtual-interface" || "local-gateway-virtual-interface-group" || "local-gateway-route-table-vpc-association" || "local-gateway-route-table-virtual-interface-group-association" || "natgateway" || "network-acl" || "network-interface" || "network-insights-analysis" || "network-insights-path" || "network-insights-access-scope" || "network-insights-access-scope-analysis" || "placement-group" || "prefix-list" || "replace-root-volume-task" || "reserved-instances" || "route-table" || "security-group" || "security-group-rule" || "snapshot" || "spot-fleet-request" || "spot-instances-request" || "subnet" || "subnet-cidr-reservation" || "traffic-mirror-filter" || "traffic-mirror-session" || "traffic-mirror-target" || "transit-gateway" || "transit-gateway-attachment" || "transit-gateway-connect-peer" || "transit-gateway-multicast-domain" || "transit-gateway-policy-table" || "transit-gateway-route-table" || "transit-gateway-route-table-announcement" || "volume" || "vpc" || "vpc-endpoint" || "vpc-endpoint-connection" || "vpc-endpoint-service" || "vpc-endpoint-service-permission" || "vpc-peering-connection" || "vpn-connection" || "vpn-gateway" || "vpc-flow-log" || "capacity-reservation-fleet" || "traffic-mirror-filter-rule" || "vpc-endpoint-connection-device-type" || "verified-access-instance" || "verified-access-group" || "verified-access-endpoint" || "verified-access-policy" || "verified-access-trust-provider" || "vpn-connection-device-type" || "vpc-block-public-access-exclusion" || "ipam-resource-discovery" || "ipam-resource-discovery-association" || "instance-connect-endpoint" || "verified-access-endpoint-target" || "ipam-external-resource-verification-token",
      Tags: [ // TagList
        { // Tag
          Key: "STRING_VALUE",
          Value: "STRING_VALUE",
        },
      ],
    },
  ],
  MaxAggregationInterval: Number("int"),
  DestinationOptions: { // DestinationOptionsRequest
    FileFormat: "plain-text" || "parquet",
    HiveCompatiblePartitions: true || false,
    PerHourPartition: true || false,
  },
};
const command = new CreateFlowLogsCommand(input);
const response = await client.send(command);
// { // CreateFlowLogsResult
//   ClientToken: "STRING_VALUE",
//   FlowLogIds: [ // ValueStringList
//     "STRING_VALUE",
//   ],
//   Unsuccessful: [ // UnsuccessfulItemSet
//     { // UnsuccessfulItem
//       Error: { // UnsuccessfulItemError
//         Code: "STRING_VALUE",
//         Message: "STRING_VALUE",
//       },
//       ResourceId: "STRING_VALUE",
//     },
//   ],
// };

CreateFlowLogsCommand Input

See CreateFlowLogsCommandInput for more details

Parameter	Type	Description
`ResourceIds` Required	`string[] \| undefined`	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.
`ResourceType` Required	`FlowLogsResourceType \| undefined`	The type of resource to monitor.
`ClientToken`	`string \| undefined`	Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency .
`DeliverCrossAccountRole`	`string \| undefined`	The ARN of the IAM role that allows Amazon EC2 to publish flow logs across accounts.
`DeliverLogsPermissionArn`	`string \| undefined`	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.
`DestinationOptions`	`DestinationOptionsRequest \| undefined`	The destination options.
`DryRun`	`boolean \| undefined`	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`.
`LogDestination`	`string \| undefined`	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
`LogDestinationType`	`LogDestinationType \| undefined`	The type of destination for the flow log data. Default: `cloud-watch-logs`
`LogFormat`	`string \| undefined`	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.
`LogGroupName`	`string \| undefined`	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`.
`MaxAggregationInterval`	`number \| undefined`	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
`TagSpecifications`	`TagSpecification[] \| undefined`	The tags to apply to the flow logs.
`TrafficType`	`TrafficType \| undefined`	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.

CreateFlowLogsCommand Output

See CreateFlowLogsCommandOutput for details

Parameter	Type	Description
`$metadata` Required	`ResponseMetadata`	Metadata pertaining to this request.
`ClientToken`	`string \| undefined`	Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
`FlowLogIds`	`string[] \| undefined`	The IDs of the flow logs.
`Unsuccessful`	`UnsuccessfulItem[] \| undefined`	Information about the flow logs that could not be created successfully.

Throws

Name	Fault	Details
EC2ServiceException		Base exception class for all service exceptions from EC2 service.

Getting Started

References

CreateFlowLogsCommand

Example Syntax

CreateFlowLogsCommand Input

CreateFlowLogsCommand Output

Throws

Table of Contents

Search