CfnFlowLog¶
-
class
aws_cdk.aws_ec2.
CfnFlowLog
(scope, id, *, 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:
aws_cdk.core.CfnResource
A CloudFormation
AWS::EC2::FlowLog
.Specifies a VPC flow log that captures IP traffic for a specified network interface, subnet, or VPC. To view the log data, use Amazon CloudWatch Logs (CloudWatch Logs) to help troubleshoot connection issues. For example, you can use a flow log to investigate why certain traffic isn’t reaching an instance, which can help you diagnose overly restrictive security group rules. For more information, see VPC Flow Logs in the Amazon VPC User Guide .
- CloudformationResource
AWS::EC2::FlowLog
- 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 = ec2.CfnFlowLog(self, "MyCfnFlowLog", 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" )] )
Create a new
AWS::EC2::FlowLog
.- Parameters
scope (
Construct
) –scope in which this resource is defined.
id (
str
) –scoped id of the resource.
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
[CfnTag
]]) – The tags to apply to the flow logs.
Methods
-
add_deletion_override
(path)¶ Syntactic sugar for
addOverride(path, undefined)
.- Parameters
path (
str
) – The path of the value to delete.- Return type
None
-
add_depends_on
(target)¶ Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.
- Parameters
target (
CfnResource
) –- Return type
None
-
add_metadata
(key, value)¶ Add a value to the CloudFormation Resource Metadata.
- Parameters
key (
str
) –value (
Any
) –
- See
https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.
- Return type
None
-
add_override
(path, value)¶ Adds an override to the synthesized CloudFormation resource.
To add a property override, either use
addPropertyOverride
or prefixpath
with “Properties.” (i.e.Properties.TopicName
).If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.
To include a literal
.
in the property name, prefix with a\
. In most programming languages you will need to write this as"\\."
because the\
itself will need to be escaped.For example:
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"]) cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")
would add the overrides Example:
"Properties": { "GlobalSecondaryIndexes": [ { "Projection": { "NonKeyAttributes": [ "myattribute" ] ... } ... }, { "ProjectionType": "INCLUDE" ... }, ] ... }
The
value
argument toaddOverride
will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.- Parameters
path (
str
) –The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
value (
Any
) –The value. Could be primitive or complex.
- Return type
None
-
add_property_deletion_override
(property_path)¶ Adds an override that deletes the value of a property from the resource definition.
- Parameters
property_path (
str
) – The path to the property.- Return type
None
-
add_property_override
(property_path, value)¶ Adds an override to a resource property.
Syntactic sugar for
addOverride("Properties.<...>", value)
.- Parameters
property_path (
str
) – The path of the property.value (
Any
) – The value.
- Return type
None
-
apply_removal_policy
(policy=None, *, apply_to_update_replace_policy=None, default=None)¶ Sets the deletion policy of the resource based on the removal policy specified.
The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.
The resource can be deleted (
RemovalPolicy.DESTROY
), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN
).- Parameters
policy (
Optional
[RemovalPolicy
]) –apply_to_update_replace_policy (
Optional
[bool
]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: truedefault (
Optional
[RemovalPolicy
]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resoure, please consult that specific resource’s documentation.
- Return type
None
-
get_att
(attribute_name)¶ Returns a token for an runtime attribute of this resource.
Ideally, use generated attribute accessors (e.g.
resource.arn
), but this can be used for future compatibility in case there is no generated attribute.- Parameters
attribute_name (
str
) – The name of the attribute.- Return type
-
get_metadata
(key)¶ Retrieve a value value from the CloudFormation Resource Metadata.
- Parameters
key (
str
) –- See
https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.
- Return type
Any
-
inspect
(inspector)¶ Examines the CloudFormation resource and discloses attributes.
- Parameters
inspector (
TreeInspector
) –tree inspector to collect and process attributes.
- Return type
None
-
override_logical_id
(new_logical_id)¶ Overrides the auto-generated logical ID with a specific ID.
- Parameters
new_logical_id (
str
) – The new logical ID to use for this stack element.- Return type
None
-
to_string
()¶ Returns a string representation of this construct.
- Return type
str
- Returns
a string representation of this resource
Attributes
-
CFN_RESOURCE_TYPE_NAME
= 'AWS::EC2::FlowLog'¶
-
attr_id
¶ The ID of the flow log.
For example,
fl-123456abc123abc1
.- CloudformationAttribute
Id
- Return type
str
-
cfn_options
¶ Options for this resource, such as condition, update policy etc.
- Return type
-
cfn_resource_type
¶ AWS resource type.
- Return type
str
-
creation_stack
¶ return:
the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.
- Return type
List
[str
]
-
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
]
-
logical_id
¶ The logical ID for this CloudFormation stack element.
The logical ID of the element is calculated from the path of the resource node in the construct tree.
To override this value, use
overrideLogicalId(newLogicalId)
.- Return type
str
- Returns
the logical ID as a stringified token. This value will only get resolved during synthesis.
-
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
]
-
node
¶ The construct tree node associated with this construct.
- Return type
-
ref
¶ Return a string that will be resolved to a CloudFormation
{ Ref }
for this element.If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through
Lazy.any({ produce: resource.ref })
.- Return type
str
-
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.
-
stack
¶ The stack in which this element is defined.
CfnElements must be defined within a stack scope (directly or indirectly).
- Return type
The tags to apply to the flow logs.
-
traffic_type
¶ The type of traffic to log.
You can log traffic that the resource accepts or rejects, or all traffic.
Static Methods
-
classmethod
is_cfn_element
(x)¶ Returns
true
if a construct is a stack element (i.e. part of the synthesized cloudformation template).Uses duck-typing instead of
instanceof
to allow stack elements from different versions of this library to be included in the same stack.- Parameters
x (
Any
) –- Return type
bool
- Returns
The construct as a stack element or undefined if it is not a stack element.
-
classmethod
is_cfn_resource
(construct)¶ Check whether the given construct is a CfnResource.
- Parameters
construct (
IConstruct
) –- Return type
bool
-
classmethod
is_construct
(x)¶ Return whether the given object is a Construct.
- Parameters
x (
Any
) –- Return type
bool