CfnNetworkInsightsPath
- class aws_cdk.aws_ec2.CfnNetworkInsightsPath(scope, id, *, protocol, source, destination=None, destination_ip=None, destination_port=None, filter_at_destination=None, filter_at_source=None, source_ip=None, tags=None)
Bases:
CfnResourceA CloudFormation
AWS::EC2::NetworkInsightsPath.Specifies a path to analyze for reachability.
VPC Reachability Analyzer enables you to analyze and debug network reachability between two resources in your virtual private cloud (VPC). For more information, see the Reachability Analyzer User Guide .
- CloudformationResource:
AWS::EC2::NetworkInsightsPath
- Link:
- 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 cfn_network_insights_path = ec2.CfnNetworkInsightsPath(self, "MyCfnNetworkInsightsPath", protocol="protocol", source="source", # the properties below are optional destination="destination", destination_ip="destinationIp", destination_port=123, filter_at_destination=ec2.CfnNetworkInsightsPath.PathFilterProperty( destination_address="destinationAddress", destination_port_range=ec2.CfnNetworkInsightsPath.FilterPortRangeProperty( from_port=123, to_port=123 ), source_address="sourceAddress", source_port_range=ec2.CfnNetworkInsightsPath.FilterPortRangeProperty( from_port=123, to_port=123 ) ), filter_at_source=ec2.CfnNetworkInsightsPath.PathFilterProperty( destination_address="destinationAddress", destination_port_range=ec2.CfnNetworkInsightsPath.FilterPortRangeProperty( from_port=123, to_port=123 ), source_address="sourceAddress", source_port_range=ec2.CfnNetworkInsightsPath.FilterPortRangeProperty( from_port=123, to_port=123 ) ), source_ip="sourceIp", tags=[CfnTag( key="key", value="value" )] )
Create a new
AWS::EC2::NetworkInsightsPath.- Parameters:
scope (
Construct) –scope in which this resource is defined.
id (
str) –scoped id of the resource.
protocol (
str) – The protocol.source (
str) – The ID or ARN of the source. If the resource is in another account, you must specify an ARN.destination (
Optional[str]) – The ID or ARN of the destination. If the resource is in another account, you must specify an ARN.destination_ip (
Optional[str]) – The IP address of the destination.destination_port (
Union[int,float,None]) – The destination port.filter_at_destination (
Union[IResolvable,PathFilterProperty,Dict[str,Any],None]) – Scopes the analysis to network paths that match specific filters at the destination. If you specify this parameter, you can’t specify the parameter for the destination IP address.filter_at_source (
Union[IResolvable,PathFilterProperty,Dict[str,Any],None]) – Scopes the analysis to network paths that match specific filters at the source. If you specify this parameter, you can’t specify the parameters for the source IP address or the destination port.source_ip (
Optional[str]) – The IP address of the source.tags (
Optional[Sequence[Union[CfnTag,Dict[str,Any]]]]) – The tags to add to the path.
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:
- Return type:
None
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.
- add_override(path, value)
Adds an override to the synthesized CloudFormation resource.
To add a property override, either use
addPropertyOverrideor prefixpathwith “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
valueargument toaddOverridewill 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:
- Return type:
Any
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.
- 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::NetworkInsightsPath'
- attr_created_date
The time stamp when the path was created.
- CloudformationAttribute:
CreatedDate
- attr_destination_arn
The Amazon Resource Name (ARN) of the destination.
- CloudformationAttribute:
DestinationArn
- attr_network_insights_path_arn
The Amazon Resource Name (ARN) of the path.
- CloudformationAttribute:
NetworkInsightsPathArn
- attr_network_insights_path_id
The ID of the path.
- CloudformationAttribute:
NetworkInsightsPathId
- attr_source_arn
The Amazon Resource Name (ARN) of the source.
- CloudformationAttribute:
SourceArn
- cfn_options
Options for this resource, such as condition, update policy etc.
- cfn_resource_type
AWS resource type.
- 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.
- destination
The ID or ARN of the destination.
If the resource is in another account, you must specify an ARN.
- destination_ip
The IP address of the destination.
- destination_port
The destination port.
- filter_at_destination
Scopes the analysis to network paths that match specific filters at the destination.
If you specify this parameter, you can’t specify the parameter for the destination IP address.
- filter_at_source
Scopes the analysis to network paths that match specific filters at the source.
If you specify this parameter, you can’t specify the parameters for the source IP address or the destination port.
- 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).- Returns:
the logical ID as a stringified token. This value will only get resolved during synthesis.
- node
The construct tree node associated with this construct.
- protocol
The protocol.
- 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 }).
- source
The ID or ARN of the source.
If the resource is in another account, you must specify an ARN.
- source_ip
The IP address of the source.
- stack
The stack in which this element is defined.
CfnElements must be defined within a stack scope (directly or indirectly).
- tags
The tags to add to the path.
Static Methods
- classmethod is_cfn_element(x)
Returns
trueif a construct is a stack element (i.e. part of the synthesized cloudformation template).Uses duck-typing instead of
instanceofto 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
FilterPortRangeProperty
- class CfnNetworkInsightsPath.FilterPortRangeProperty(*, from_port=None, to_port=None)
Bases:
objectDescribes a port range.
- Parameters:
from_port (
Union[int,float,None]) – The first port in the range.to_port (
Union[int,float,None]) – The last port in the range.
- Link:
- 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 filter_port_range_property = ec2.CfnNetworkInsightsPath.FilterPortRangeProperty( from_port=123, to_port=123 )
Attributes
- from_port
The first port in the range.
PathFilterProperty
- class CfnNetworkInsightsPath.PathFilterProperty(*, destination_address=None, destination_port_range=None, source_address=None, source_port_range=None)
Bases:
objectDescribes a set of filters for a path analysis.
Use path filters to scope the analysis when there can be multiple resulting paths.
- Parameters:
destination_address (
Optional[str]) – The destination IPv4 address.destination_port_range (
Union[IResolvable,FilterPortRangeProperty,Dict[str,Any],None]) – The destination port range.source_address (
Optional[str]) – The source IPv4 address.source_port_range (
Union[IResolvable,FilterPortRangeProperty,Dict[str,Any],None]) – The source port range.
- Link:
- 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 path_filter_property = ec2.CfnNetworkInsightsPath.PathFilterProperty( destination_address="destinationAddress", destination_port_range=ec2.CfnNetworkInsightsPath.FilterPortRangeProperty( from_port=123, to_port=123 ), source_address="sourceAddress", source_port_range=ec2.CfnNetworkInsightsPath.FilterPortRangeProperty( from_port=123, to_port=123 ) )
Attributes
- destination_address
The destination IPv4 address.
- destination_port_range
The destination port range.
- source_address
The source IPv4 address.
- source_port_range
The source port range.