Package software.amazon.awscdk.services.ec2

Interface FlowLogOptions

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Subinterfaces:

FlowLogProps

All Known Implementing Classes:

FlowLogOptions.Jsii$Proxy, FlowLogProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.97.0 (build 729de35)",
           date="2024-04-24T21:00:28.836Z")
@Stability(Stable)
public interface FlowLogOptions
extends software.amazon.jsii.JsiiSerializable

Options to add a flow log to a VPC.

Example:

 Vpc vpc = new Vpc(this, "Vpc");
 vpc.addFlowLog("FlowLogS3", FlowLogOptions.builder()
         .destination(FlowLogDestination.toS3())
         .build());
 // Only reject traffic and interval every minute.
 vpc.addFlowLog("FlowLogCloudWatch", FlowLogOptions.builder()
         .trafficType(FlowLogTrafficType.REJECT)
         .maxAggregationInterval(FlowLogMaxAggregationInterval.ONE_MINUTE)
         .build());
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static FlowLogOptions.Builder	builder()
default FlowLogDestination	getDestination()	Specifies the type of destination to which the flow log data is to be published.
default List<LogFormat>	getLogFormat()	The fields to include in the flow log record, in the order in which they should appear.
default FlowLogMaxAggregationInterval	getMaxAggregationInterval()	The maximum interval of time during which a flow of packets is captured and aggregated into a flow log record.
default FlowLogTrafficType	getTrafficType()	The type of traffic to log.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getDestination

@Stability(Stable)
@Nullable
default FlowLogDestination getDestination()

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()

getLogFormat

@Stability(Stable)
@Nullable
default List<LogFormat> getLogFormat()

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.

getMaxAggregationInterval

@Stability(Stable)
@Nullable
default FlowLogMaxAggregationInterval getMaxAggregationInterval()

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.

See Also:

• https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-flowlog.html#cfn-ec2-flowlog-maxaggregationinterval

getTrafficType

@Stability(Stable)
@Nullable
default FlowLogTrafficType getTrafficType()

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

See Also:

• https://docs.aws.amazon.com/vpc/latest/tgw/working-with-flow-logs.html

builder

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

Returns:

a FlowLogOptions.Builder of FlowLogOptions