CfnFlowLogProps¶
-
class
aws_cdk.aws_ec2.
CfnFlowLogProps
(*, resource_id, resource_type, traffic_type, 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)¶ Bases:
object
Properties for defining a
CfnFlowLog
.- Parameters
resource_id (
str
) – The ID of the subnet, network interface, or VPC for which you want to create a flow log.resource_type (
str
) – The type of resource for which to create the flow log. For example, if you specified a VPC ID for theResourceId
property, specifyVPC
for this property.traffic_type (
str
) – The type of traffic to log. You can log traffic that the resource accepts or rejects, or all traffic.deliver_logs_permission_arn (
Optional
[str
]) – The ARN for the IAM role that permits Amazon EC2 to publish flow logs to a CloudWatch Logs log group in your account. If you specifyLogDestinationType
ass3
, do not specifyDeliverLogsPermissionArn
orLogGroupName
.destination_options (
Optional
[Any
]) – The destination options. The following options are supported:. -FileFormat
- The format for the flow log (plain-text
|parquet
). The default isplain-text
. -HiveCompatiblePartitions
- Indicates whether to use Hive-compatible prefixes for flow logs stored in Amazon S3 (true
|false
). The default isfalse
. -PerHourPartition
- Indicates whether to partition the flow log per hour (true
|false
). The default isfalse
.log_destination (
Optional
[str
]) – The destination to which the flow log data is to be published. Flow log data can be published to a CloudWatch Logs log group or an Amazon S3 bucket. The value specified for this parameter depends on the value specified forLogDestinationType
. IfLogDestinationType
is not specified orcloud-watch-logs
, specify the Amazon Resource Name (ARN) of the CloudWatch Logs log group. For example, to publish to a log group calledmy-logs
, specifyarn:aws:logs:us-east-1:123456789012:log-group:my-logs
. Alternatively, useLogGroupName
instead. If LogDestinationType iss3
, specify the ARN of the Amazon S3 bucket. You can also specify a subfolder in the bucket. To specify a subfolder in the bucket, use the following ARN format:bucket_ARN/subfolder_name/
. For example, to specify a subfolder namedmy-logs
in a bucket namedmy-bucket
, use the following ARN:arn:aws:s3:::my-bucket/my-logs/
. You cannot useAWSLogs
as a subfolder name. This is a reserved term.log_destination_type (
Optional
[str
]) – 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. To publish flow log data to CloudWatch Logs, specifycloud-watch-logs
. To publish flow log data to Amazon S3, specifys3
. If you specifyLogDestinationType
ass3
, do not specifyDeliverLogsPermissionArn
orLogGroupName
. 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. For a list of available fields, see Flow Log Records . If you omit this parameter, the flow log is created using the default format. If you specify this parameter, you must specify at least one field. 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. If you specifyLogDestinationType
ass3
, do not specifyDeliverLogsPermissionArn
orLogGroupName
.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. You can specify 60 seconds (1 minute) or 600 seconds (10 minutes). 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: 600tags (
Optional
[Sequence
[Union
[CfnTag
,Dict
[str
,Any
]]]]) – The tags to apply to the flow logs.
- Link
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. import aws_cdk.aws_ec2 as ec2 # destination_options: Any cfn_flow_log_props = ec2.CfnFlowLogProps( resource_id="resourceId", resource_type="resourceType", traffic_type="trafficType", # the properties below are optional 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" )] )
Attributes
-
deliver_logs_permission_arn
¶ The ARN for the IAM role that permits Amazon EC2 to publish flow logs to a CloudWatch Logs log group in your account.
If you specify
LogDestinationType
ass3
, do not specifyDeliverLogsPermissionArn
orLogGroupName
.
-
destination_options
¶ .
FileFormat
- The format for the flow log (plain-text
|parquet
). The default isplain-text
.HiveCompatiblePartitions
- Indicates whether to use Hive-compatible prefixes for flow logs stored in Amazon S3 (true
|false
). The default isfalse
.PerHourPartition
- Indicates whether to partition the flow log per hour (true
|false
). The default isfalse
.
- Link
- Type
The destination options. The following options are supported
- Return type
Any
-
log_destination
¶ The destination to which the flow log data is to be published.
Flow log data can be published to a CloudWatch Logs log group or an Amazon S3 bucket. The value specified for this parameter depends on the value specified for
LogDestinationType
.If
LogDestinationType
is not specified orcloud-watch-logs
, specify the Amazon Resource Name (ARN) of the CloudWatch Logs log group. For example, to publish to a log group calledmy-logs
, specifyarn:aws:logs:us-east-1:123456789012:log-group:my-logs
. Alternatively, useLogGroupName
instead.If LogDestinationType is
s3
, specify the ARN of the Amazon S3 bucket. You can also specify a subfolder in the bucket. To specify a subfolder in the bucket, use the following ARN format:bucket_ARN/subfolder_name/
. For example, to specify a subfolder namedmy-logs
in a bucket namedmy-bucket
, use the following ARN:arn:aws:s3:::my-bucket/my-logs/
. You cannot useAWSLogs
as a subfolder name. This is a reserved term.- Link
- Return type
Optional
[str
]
-
log_destination_type
¶ 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. To publish flow log data to CloudWatch Logs, specify
cloud-watch-logs
. To publish flow log data to Amazon S3, specifys3
.If you specify
LogDestinationType
ass3
, do not specifyDeliverLogsPermissionArn
orLogGroupName
.Default:
cloud-watch-logs
-
log_format
¶ The fields to include in the flow log record, in the order in which they should appear.
For a list of available fields, see Flow Log Records . If you omit this parameter, the flow log is created using the default format. If you specify this parameter, you must specify at least one field.
Specify the fields using the
${field-id}
format, separated by spaces.- Link
- Return type
Optional
[str
]
-
log_group_name
¶ The name of a new or existing CloudWatch Logs log group where Amazon EC2 publishes your flow logs.
If you specify
LogDestinationType
ass3
, do not specifyDeliverLogsPermissionArn
orLogGroupName
.- Link
- Return type
Optional
[str
]
-
max_aggregation_interval
¶ The maximum interval of time during which a flow of packets is captured and aggregated into a flow log record.
You can specify 60 seconds (1 minute) or 600 seconds (10 minutes).
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
- Link
- Return type
Union
[int
,float
,None
]
-
resource_id
¶ The ID of the subnet, network interface, or VPC for which you want to create a flow log.
-
resource_type
¶ The type of resource for which to create the flow log.
For example, if you specified a VPC ID for the
ResourceId
property, specifyVPC
for this property.
The tags to apply to the flow logs.
- Link
- Return type
Optional
[List
[CfnTag
]]
-
traffic_type
¶ The type of traffic to log.
You can log traffic that the resource accepts or rejects, or all traffic.