aws-cdk-lib.aws_ec2.CfnFlowLogProps

CfnFlowLogProps Struct

Properties for defining a CfnFlowLog.

CfnFlowLogProps

used as props by

• CfnFlowLog

Source

Generated code

Type last changed

v2.260.0 · 16 Jun 2026

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_ec2 as ec2 } from 'aws-cdk-lib';

declare const destinationOptions: any;
const cfnFlowLogProps: ec2.CfnFlowLogProps = {
  resourceId: 'resourceId',
  resourceType: 'resourceType',

  // the properties below are optional
  deliverCrossAccountRole: 'deliverCrossAccountRole',
  deliverLogsPermissionArn: 'deliverLogsPermissionArn',
  destinationOptions: destinationOptions,
  logDestination: 'logDestination',
  logDestinationType: 'logDestinationType',
  logFormat: 'logFormat',
  logGroupName: 'logGroupName',
  maxAggregationInterval: 123,
  tagFieldSpecifications: [{
    resourceType: 'resourceType',
    tagKeys: ['tagKeys'],
  }],
  tags: [{
    key: 'key',
    value: 'value',
  }],
  trafficType: 'trafficType',
};

Properties

deliverCrossAccountRolestringdeliver_cross_account_rolestrdeliverCrossAccountRoleStringDeliverCrossAccountRolestringDeliverCrossAccountRole*string#

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

deliverLogsPermissionArnstring | IRoleRefdeliver_logs_permission_arntyping.Union[str, IRoleRef]deliverLogsPermissionArnStringDeliverLogsPermissionArnstringDeliverLogsPermissionArninterface{}#

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.

destinationOptionsanydestination_optionsAnydestinationOptionsObjectDestinationOptionsobjectDestinationOptionsinterface{}#

The destination options.

logDestinationstring | ILogGroupRef | IBucketReflog_destinationtyping.Union[str, ILogGroupRef, IBucketRef]logDestinationStringLogDestinationstringLogDestinationinterface{}#

The destination for the flow log data. The meaning of this parameter depends on the destination type.

notes

• 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

logDestinationTypestringlog_destination_typestrlogDestinationTypeStringLogDestinationTypestringLogDestinationType*string#

The type of destination for the flow log data.

Default: cloud-watch-logs

logFormatstringlog_formatstrlogFormatStringLogFormatstringLogFormat*string#

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

notes

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 AWS Transit Gateway Guide .

Specify the fields using the ${field-id} format, separated by spaces.

logGroupNamestring | ILogGroupReflog_group_nametyping.Union[str, ILogGroupRef]logGroupNameStringLogGroupNamestringLogGroupNameinterface{}#

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 .

maxAggregationIntervalnumbermax_aggregation_intervalint | floatmaxAggregationIntervalNumberMaxAggregationIntervaldoubleMaxAggregationInterval*float64#

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

notes

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

resourceIdstring | ISubnetRef | ITransitGatewayRef | IVPCRefresource_idtyping.Union[str, ISubnetRef, ITransitGatewayRef, IVPCRef]resourceIdStringResourceIdstringResourceIdinterface{}required#

The ID of the resource to monitor.

For example, if the resource type is VPC , specify the ID of the VPC.

resourceTypestringresource_typestrresourceTypeStringResourceTypestringResourceType*stringrequired#

The type of resource to monitor.

tagFieldSpecificationsIResolvable | IResolvable | CfnFlowLog.TagFieldSpecificationProperty[]tag_field_specificationstyping.Union[IResolvable, typing.List[typing.Union[IResolvable, TagFieldSpecificationProperty]]]tagFieldSpecificationsIResolvableTagFieldSpecificationsIResolvableTagFieldSpecificationsinterface{}#

The resource types and associated tags for EC2 resources associated with the EC2 Tags feature for log enrichment.

tagsCfnTag[]tagstyping.List[CfnTag]tagsList<CfnTag>TagsCfnTag[]Tags*[]CfnTag#

The tags to apply to the flow logs.

trafficTypestringtraffic_typestrtrafficTypeStringTrafficTypestringTrafficType*string#

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.