AWS CDK Reference

Appearance

v2.277.0

FlowLogProps Struct ​

Properties of a VPC Flow Log.

Source
aws-ec2/lib/vpc-flow-logs.ts
Type last changed
v2.90.0 · 4 Aug 2023

Example ​

ts
declare const tgw: ec2.CfnTransitGateway;

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


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


FlowLog.Builder.create(this, "TransitGatewayFlowLog")
        .resourceType(FlowLogResourceType.fromTransitGatewayId(tgw.getRef()))
        .build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
CfnTransitGateway tgw;


new FlowLog(this, "TransitGatewayFlowLog", new FlowLogProps {
    ResourceType = FlowLogResourceType.FromTransitGatewayId(tgw.Ref)
});
go
// 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),
})

Properties ​

destinationoptionalFlowLogDestinationdestinationoptionalFlowLogDestinationdestinationoptionalFlowLogDestinationDestinationoptionalFlowLogDestinationDestinationoptionalFlowLogDestination#
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

flowLogNameoptionalstringflow_log_nameoptionalstrflowLogNameoptionalStringFlowLogNameoptionalstringFlowLogNameoptional*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.

logFormatoptionalLogFormat[]log_formatoptionaltyping.List[LogFormat]logFormatoptionalList<LogFormat>LogFormatoptionalLogFormat[]LogFormatoptional*[]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

maxAggregationIntervaloptionalFlowLogMaxAggregationIntervalmax_aggregation_intervaloptionalFlowLogMaxAggregationIntervalmaxAggregationIntervaloptionalFlowLogMaxAggregationIntervalMaxAggregationIntervaloptionalFlowLogMaxAggregationIntervalMaxAggregationIntervaloptionalFlowLogMaxAggregationInterval#
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.
trafficTypeoptionalFlowLogTrafficTypetraffic_typeoptionalFlowLogTrafficTypetrafficTypeoptionalFlowLogTrafficTypeTrafficTypeoptionalFlowLogTrafficTypeTrafficTypeoptionalFlowLogTrafficType= 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.