aws-cdk-lib.aws_ec2.FlowLog

FlowLog L2 construct

A VPC flow log.

Construct›Resource›FlowLog

implements

• IResource,
• IFlowLog,
• IEnvironmentAware,
• IFlowLogRef,
• IConstruct,
• 1 more

  • IDependable

CloudFormation

AWS::EC2::FlowLog

L1 type

CfnFlowLog

Source

aws-ec2/lib/vpc-flow-logs.ts

Type last changed

v2.238.0 · 9 Feb 2026

Example

declare const tgw: ec2.CfnTransitGateway;

new ec2.FlowLog(this, 'TransitGatewayFlowLog', {
  resourceType: ec2.FlowLogResourceType.fromTransitGatewayId(tgw.ref)
})

# tgw: ec2.CfnTransitGateway


ec2.FlowLog(self, "TransitGatewayFlowLog",
    resource_type=ec2.FlowLogResourceType.from_transit_gateway_id(tgw.ref)
)

CfnTransitGateway tgw;


FlowLog.Builder.create(this, "TransitGatewayFlowLog")
        .resourceType(FlowLogResourceType.fromTransitGatewayId(tgw.getRef()))
        .build();

// Install: dotnet add package Amazon.CDK.Lib
CfnTransitGateway tgw;


new FlowLog(this, "TransitGatewayFlowLog", new FlowLogProps {
    ResourceType = FlowLogResourceType.FromTransitGatewayId(tgw.Ref)
});

// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
var tgw CfnTransitGateway


ec2.NewFlowLog(this, jsii.String("TransitGatewayFlowLog"), &FlowLogProps{
	ResourceType: ec2.FlowLogResourceType_FromTransitGatewayId(tgw.ref),
})

Initializer

new FlowLog(scope: Construct, id: string, props: FlowLogProps)

FlowLog(scope: Construct, id: str, props: FlowLogProps)

new FlowLog(Construct scope, String id, FlowLogProps props)

new FlowLog(Construct scope, string id, FlowLogProps props)

NewFlowLog(Scope Construct, Id *string, Props FlowLogProps)

Construct Props

destination?optionalFlowLogDestinationdestination?optionalFlowLogDestinationdestination?optionalFlowLogDestinationDestination?optionalFlowLogDestinationDestination?optionalFlowLogDestination#

Specifies the type of destination to which the flow log data is to be published.

Default: FlowLogDestinationType.toCloudWatchLogs()

Flow log data can be published to CloudWatch Logs or Amazon S3

flowLogName?optionalstringflow_log_name?optionalstrflowLogName?optionalStringFlowLogName?optionalstringFlowLogName?optional*string#

The name of the FlowLog.

Default: CDK generated name

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

logFormat?optionalLogFormat[]log_format?optionaltyping.List[LogFormat]logFormat?optionalList<LogFormat>LogFormat?optionalLogFormat[]LogFormat?optional*[]LogFormat#

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

Default: default log format is used.

notes

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

maxAggregationInterval?optionalFlowLogMaxAggregationIntervalmax_aggregation_interval?optionalFlowLogMaxAggregationIntervalmaxAggregationInterval?optionalFlowLogMaxAggregationIntervalMaxAggregationInterval?optionalFlowLogMaxAggregationIntervalMaxAggregationInterval?optionalFlowLogMaxAggregationInterval#

The maximum interval of time during which a flow of packets is captured and aggregated into a flow log record.

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

When creating flow logs for a Transit Gateway or Transit Gateway Attachment, this property must be ONE_MINUTES.

resourceTypeFlowLogResourceTyperesource_typeFlowLogResourceTyperesourceTypeFlowLogResourceTypeResourceTypeFlowLogResourceTypeResourceTypeFlowLogResourceTyperequired#

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

trafficType?optionalFlowLogTrafficTypetraffic_type?optionalFlowLogTrafficTypetrafficType?optionalFlowLogTrafficTypeTrafficType?optionalFlowLogTrafficTypeTrafficType?optionalFlowLogTrafficType= ALL#

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.

Properties

bucket?may be undefinedIBucketbucket?may be undefinedIBucketbucket?may be undefinedIBucketBucket?may be undefinedIBucketBucket?may be undefinedIBucket#

The S3 bucket to publish flow logs to.

deliveryStream?may be undefinedIDeliveryStreamRefdelivery_stream?may be undefinedIDeliveryStreamRefdeliveryStream?may be undefinedIDeliveryStreamRefDeliveryStream?may be undefinedIDeliveryStreamRefDeliveryStream?may be undefinedIDeliveryStreamRef#

The Amazon Data Firehose delivery stream to publish flow logs to.

deliveryStreamArn?may be undefinedstringdelivery_stream_arn?may be undefinedstrdeliveryStreamArn?may be undefinedStringDeliveryStreamArn?may be undefinedstringDeliveryStreamArn?may be undefined*stringdeprecated#

Use deliveryStream

envResourceEnvironmentenvResourceEnvironmentenvResourceEnvironmentEnvResourceEnvironmentEnvResourceEnvironmentrequired#

The environment this resource belongs to.

notes

For resources that are created and managed in a Stack (those created by creating new class instances like new Role(), new Bucket(), etc.), this is always the same as the environment of the stack they belong to.

For referenced resources (those obtained from referencing methods like Role.fromRoleArn(), Bucket.fromBucketName(), etc.), they might be different than the stack they were imported into.

flowLogIdstringflow_log_idstrflowLogIdStringFlowLogIdstringFlowLogId*stringrequired#

The Id of the VPC Flow Log.

flowLogRefFlowLogReferenceflow_log_refFlowLogReferenceflowLogRefFlowLogReferenceFlowLogRefFlowLogReferenceFlowLogRefFlowLogReferencerequired#

A reference to a FlowLog resource.

iamRole?may be undefinedIRoleiam_role?may be undefinedIRoleiamRole?may be undefinedIRoleIamRole?may be undefinedIRoleIamRole?may be undefinedIRole#

The iam role used to publish logs to CloudWatch.

keyPrefix?may be undefinedstringkey_prefix?may be undefinedstrkeyPrefix?may be undefinedStringKeyPrefix?may be undefinedstringKeyPrefix?may be undefined*string#

S3 bucket key prefix to publish the flow logs under.

logGroup?may be undefinedILogGrouplog_group?may be undefinedILogGrouplogGroup?may be undefinedILogGroupLogGroup?may be undefinedILogGroupLogGroup?may be undefinedILogGroup#

The CloudWatch Logs LogGroup to publish flow logs to.

nodeNodenodeNodenodeNodeNodeNodeNodeNoderequired#

The tree node.

PROPERTY_INJECTION_IDstringproperty_injection_idstrPROPERTY_INJECTION_IDStringPROPERTY_INJECTION_IDstringPROPERTY_INJECTION_ID*stringrequiredstatic#

Uniquely identifies this class.

stackStackstackStackstackStackStackStackStackStackrequired#

The stack in which this resource is defined.

Methods

applyCrossStackReferenceStrength(strength: ReferenceStrength): voiddef apply_cross_stack_reference_strength(self, strength: ReferenceStrength) -> Nonepublic void applyCrossStackReferenceStrength(ReferenceStrength strength)public void ApplyCrossStackReferenceStrength(ReferenceStrength strength)func ApplyCrossStackReferenceStrength(Strength ReferenceStrength)#

Override the cross-stack reference strength for this resource.

notes · 1 parameter

When set, any cross-stack reference to this resource will use the specified mechanism instead of the global default determined by the @aws-cdk/core:defaultCrossStackReferences context key. This is useful for selectively weakening specific references to avoid the "deadly embrace" problem without changing the app-wide default.

Parameters

• strengthstrengthstrengthstrengthStrength — - The reference strength to use for this resource.

applyRemovalPolicy(policy: RemovalPolicy): voiddef apply_removal_policy(self, policy: RemovalPolicy) -> Nonepublic void applyRemovalPolicy(RemovalPolicy policy)public void ApplyRemovalPolicy(RemovalPolicy policy)func ApplyRemovalPolicy(Policy RemovalPolicy)#

Apply the given removal policy to this resource.

notes

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

fromFlowLogId(scope: Construct, id: string, flowLogId: string): IFlowLog@staticmethod def from_flow_log_id(scope: Construct, id: str, flow_log_id: str) -> IFlowLogpublic static IFlowLog fromFlowLogId(Construct scope, String id, String flowLogId)public static IFlowLog FromFlowLogId(Construct scope, string id, string flowLogId)func FromFlowLogId(Scope Construct, Id *string, FlowLogId *string) IFlowLogstatic#

Import a Flow Log by it's Id.

isConstruct(x: any): boolean@staticmethod def is_construct(x: Any) -> boolpublic static Boolean isConstruct(Object x)public static bool IsConstruct(object x)func IsConstruct(X interface{}) *boolstatic#

Checks if `x` is a construct.

notes · 1 parameter · returns

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

Parameters

• xxxxX — Any object.

Returns: true if x is an object created from a class which extends Construct.

isOwnedResource(construct: IConstruct): boolean@staticmethod def is_owned_resource(construct: IConstruct) -> boolpublic static Boolean isOwnedResource(IConstruct construct)public static bool IsOwnedResource(IConstruct construct)func IsOwnedResource(Construct IConstruct) *boolstatic#

Returns true if the construct was created by CDK, and false otherwise.

isResource(construct: IConstruct): boolean@staticmethod def is_resource(construct: IConstruct) -> boolpublic static Boolean isResource(IConstruct construct)public static bool IsResource(IConstruct construct)func IsResource(Construct IConstruct) *boolstatic#

Check whether the given construct is a Resource.

toString(): stringdef to_string(self, ) -> strpublic String toString()public string ToString()func ToString() *string#

Returns a string representation of this construct.

with(...mixins: IMixin[]): IConstructdef with(self, mixins: IMixin) -> IConstructpublic IConstruct with(IMixin mixins)public IConstruct With(IMixin mixins)func With(Mixins IMixin) IConstruct#

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.