FlowLogOptions

class aws_cdk.aws_ec2.FlowLogOptions(*, destination=None, log_format=None, max_aggregation_interval=None, traffic_type=None)

Bases: object

Options to add a flow log to a VPC.

Parameters
  • destination (Optional[FlowLogDestination]) – 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()

  • log_format (Optional[Sequence[LogFormat]]) – 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.

  • max_aggregation_interval (Optional[FlowLogMaxAggregationInterval]) – The maximum interval of time during which a flow of packets is captured and aggregated into a flow log record. Default: FlowLogMaxAggregationInterval.TEN_MINUTES

  • traffic_type (Optional[FlowLogTrafficType]) – The type of traffic to log. You can log traffic that the resource accepts or rejects, or all traffic. Default: ALL

ExampleMetadata

infused

Example:

# Example automatically generated from non-compiling source. May contain errors.
vpc = ec2.Vpc(self, "Vpc")

vpc.add_flow_log("FlowLogS3",
    destination=ec2.FlowLogDestination.to_s3()
)

# Only reject traffic and interval every minute.
vpc.add_flow_log("FlowLogCloudWatch",
    traffic_type=ec2.FlowLogTrafficType.REJECT,
    max_aggregation_interval=FlowLogMaxAggregationInterval.ONE_MINUTE
)

Attributes

destination

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

Return type

Optional[FlowLogDestination]

log_format

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.

Return type

Optional[List[LogFormat]]

max_aggregation_interval

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

Default

FlowLogMaxAggregationInterval.TEN_MINUTES

Return type

Optional[FlowLogMaxAggregationInterval]

traffic_type

The type of traffic to log.

You can log traffic that the resource accepts or rejects, or all traffic.

Default

ALL

Return type

Optional[FlowLogTrafficType]