Package software.amazon.awscdk.services.ec2

Interface FlowLogDestinationConfig

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

FlowLogDestinationConfig.Jsii$Proxy

@Generated(value="jsii-pacmak/1.126.0 (build 206d44b)",
           date="2026-02-09T14:39:09.800Z")
@Stability(Stable)
public interface FlowLogDestinationConfig
extends software.amazon.jsii.JsiiSerializable

Flow Log Destination configuration.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.ec2.*;
 import software.amazon.awscdk.services.iam.*;
 import software.amazon.awscdk.services.s3.*;
 import software.amazon.awscdk.interfaces.kinesisfirehose.*;
 import software.amazon.awscdk.interfaces.logs.*;
 Bucket bucket;
 IDeliveryStreamRef deliveryStreamRef;
 ILogGroupRef logGroupRef;
 Role role;
 FlowLogDestinationConfig flowLogDestinationConfig = FlowLogDestinationConfig.builder()
         .logDestinationType(FlowLogDestinationType.CLOUD_WATCH_LOGS)
         // the properties below are optional
         .deliveryStream(deliveryStreamRef)
         .deliveryStreamArn("deliveryStreamArn")
         .destinationOptions(DestinationOptions.builder()
                 .fileFormat(FlowLogFileFormat.PLAIN_TEXT)
                 .hiveCompatiblePartitions(false)
                 .perHourPartition(false)
                 .build())
         .iamRole(role)
         .keyPrefix("keyPrefix")
         .logGroup(logGroupRef)
         .s3Bucket(bucket)
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	FlowLogDestinationConfig.Builder	A builder for FlowLogDestinationConfig
static final class	FlowLogDestinationConfig.Jsii$Proxy	An implementation for FlowLogDestinationConfig

Method Summary

Modifier and Type	Method	Description
static FlowLogDestinationConfig.Builder	builder()
default IDeliveryStreamRef	getDeliveryStream()	The Amazon Data Firehose delivery stream to publish the flow logs to.
default String	getDeliveryStreamArn()	Deprecated. use deliveryStream
default DestinationOptions	getDestinationOptions()	Options for writing flow logs to a supported destination.
default IRole	getIamRole()	The IAM role that allows Amazon EC2 to publish flow logs to the log destination.
default String	getKeyPrefix()	S3 bucket key prefix to publish the flow logs to.
FlowLogDestinationType	getLogDestinationType()	The type of destination to publish the flow logs to.
default ILogGroupRef	getLogGroup()	The CloudWatch Logs Log Group to publish the flow logs to.
default IBucket	getS3Bucket()	S3 bucket to publish the flow logs to.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getLogDestinationType

@Stability(Stable)
@NotNull
FlowLogDestinationType getLogDestinationType()

The type of destination to publish the flow logs to.

Default: - CLOUD_WATCH_LOGS

getDeliveryStream

@Stability(Stable)
@Nullable
default IDeliveryStreamRef getDeliveryStream()

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

Default: - undefined

getDeliveryStreamArn

@Stability(Deprecated)
@Deprecated
@Nullable
default String getDeliveryStreamArn()

Deprecated.

use deliveryStream

(deprecated) The ARN of Amazon Data Firehose delivery stream to publish the flow logs to.

Default: - undefined

getDestinationOptions

@Stability(Stable)
@Nullable
default DestinationOptions getDestinationOptions()

Options for writing flow logs to a supported destination.

Default: - undefined

getIamRole

@Stability(Stable)
@Nullable
default IRole getIamRole()

The IAM role that allows Amazon EC2 to publish flow logs to the log destination.

Required if the destination type is CloudWatch logs, or if the destination type is Amazon Data Firehose delivery stream and the delivery stream and the VPC are in different accounts.

Default: - default IAM role is created for you if the destination type is CloudWatch logs

getKeyPrefix

@Stability(Stable)
@Nullable
default String getKeyPrefix()

S3 bucket key prefix to publish the flow logs to.

Default: - undefined

getLogGroup

@Stability(Stable)
@Nullable
default ILogGroupRef getLogGroup()

The CloudWatch Logs Log Group to publish the flow logs to.

Default: - default log group is created for you

getS3Bucket

@Stability(Stable)
@Nullable
default IBucket getS3Bucket()

S3 bucket to publish the flow logs to.

Default: - undefined

builder

@Stability(Stable)
static FlowLogDestinationConfig.Builder builder()

Returns:

a FlowLogDestinationConfig.Builder of FlowLogDestinationConfig