AWS Fundamentals Logo
AWS Fundamentals
L2 Construct

FlowLog

A VPC flow log.

Import

import { FlowLog } from 'aws-cdk-lib/aws-ec2';

Or use the module namespace:

import * as ec2 from 'aws-cdk-lib/aws-ec2';
// ec2.FlowLog

Properties

Configuration passed to the constructor as FlowLogProps.

resourceTypeRequired
FlowLogResourceType

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

flowLogNameOptional
string

The name of the FlowLog. Since the FlowLog resource doesn't support providing a physical name, the value provided here will be recorded in the `Name` tag.

Default: CDK generated name

4 properties inherited from FlowLogOptions
destinationOptionalinherited from FlowLogOptions
FlowLogDestination

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

Default: FlowLogDestinationType.toCloudWatchLogs()

logFormatOptionalinherited from FlowLogOptions
LogFormat[]

The fields to include in the flow log record, in the order in which they should appear. If multiple fields are specified, they will be separated by spaces. For full control over the literal log format string, pass a single field constructed with `LogFormat.custom()`. See https://docs.aws.amazon.com/vpc/latest/userguide/flow-logs.html#flow-log-records

Default: - default log format is used.

maxAggregationIntervalOptionalinherited from FlowLogOptions
FlowLogMaxAggregationInterval

The maximum interval of time during which a flow of packets is captured and aggregated into a flow log record. When creating flow logs for a Transit Gateway or Transit Gateway Attachment, this property must be ONE_MINUTES.

Default: - FlowLogMaxAggregationInterval.ONE_MINUTES if creating flow logs for Transit Gateway, otherwise FlowLogMaxAggregationInterval.TEN_MINUTES.

trafficTypeOptionalinherited from FlowLogOptions
FlowLogTrafficType

The type of traffic to log. You can log traffic that the resource accepts or rejects, or all traffic. When the target is either `TransitGateway` or `TransitGatewayAttachment`, setting the traffic type is not possible.

Default: ALL

Get the Amazon EC2 Cheat Sheet

Everything you need to know about Amazon EC2 on one page. HD quality, print-friendly.

Download Free Infographic

Quick Facts

LevelL2 (Higher-level)
Moduleaws-ec2
Properties6

Related Constructs

Explore This Service

External Links