CfnFlowLogProps

class aws_cdk.aws_ec2.CfnFlowLogProps(*, resource_id, resource_type, deliver_cross_account_role=None, deliver_logs_permission_arn=None, destination_options=None, log_destination=None, log_destination_type=None, log_format=None, log_group_name=None, max_aggregation_interval=None, tags=None, traffic_type=None)

Bases: object

Properties for defining a CfnFlowLog.

Parameters:

resource_id (str) – The ID of the resource to monitor. For example, if the resource type is VPC , specify the ID of the VPC.
resource_type (str) – The type of resource to monitor.
deliver_cross_account_role (Optional[str]) – The ARN of the IAM role that allows the service to publish flow logs across accounts.
deliver_logs_permission_arn (Optional[str]) – 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.
destination_options (Any) – The destination options.
log_destination (Optional[str]) – The destination for the flow log data. The meaning of this parameter depends on the destination type. - 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
log_destination_type (Optional[str]) – The type of destination for the flow log data. Default: cloud-watch-logs
log_format (Optional[str]) – The fields to include in the flow log record, in the order in which they should appear. 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.
log_group_name (Optional[str]) – 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 .
max_aggregation_interval (Union[int, float, None]) – The maximum interval of time during which a flow of packets is captured and aggregated into a flow log record. 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
tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – The tags to apply to the flow logs.
traffic_type (Optional[str]) – 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.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-flowlog.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_ec2 as ec2

# destination_options: Any

cfn_flow_log_props = ec2.CfnFlowLogProps(
    resource_id="resourceId",
    resource_type="resourceType",

    # the properties below are optional
    deliver_cross_account_role="deliverCrossAccountRole",
    deliver_logs_permission_arn="deliverLogsPermissionArn",
    destination_options=destination_options,
    log_destination="logDestination",
    log_destination_type="logDestinationType",
    log_format="logFormat",
    log_group_name="logGroupName",
    max_aggregation_interval=123,
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    traffic_type="trafficType"
)

Attributes

deliver_cross_account_role

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

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-flowlog.html#cfn-ec2-flowlog-delivercrossaccountrole

deliver_logs_permission_arn

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.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-flowlog.html#cfn-ec2-flowlog-deliverlogspermissionarn

destination_options

The destination options.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-flowlog.html#cfn-ec2-flowlog-destinationoptions

log_destination

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

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

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-flowlog.html#cfn-ec2-flowlog-logdestination

log_destination_type

The type of destination for the flow log data.

Default: cloud-watch-logs

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-flowlog.html#cfn-ec2-flowlog-logdestinationtype

log_format

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

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.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-flowlog.html#cfn-ec2-flowlog-logformat

log_group_name

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 .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-flowlog.html#cfn-ec2-flowlog-loggroupname

max_aggregation_interval

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

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