CfnNetworkInsightsAnalysis¶
-
class
aws_cdk.aws_ec2.
CfnNetworkInsightsAnalysis
(scope, id, *, network_insights_path_id, filter_in_arns=None, tags=None)¶ Bases:
aws_cdk.core.CfnResource
A CloudFormation
AWS::EC2::NetworkInsightsAnalysis
.Specifies a network insights analysis.
- CloudformationResource
AWS::EC2::NetworkInsightsAnalysis
- 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_analysis = ec2.CfnNetworkInsightsAnalysis(self, "MyCfnNetworkInsightsAnalysis", network_insights_path_id="networkInsightsPathId", # the properties below are optional filter_in_arns=["filterInArns"], tags=[CfnTag( key="key", value="value" )] )
Create a new
AWS::EC2::NetworkInsightsAnalysis
.- Parameters
scope (
Construct
) –scope in which this resource is defined.
id (
str
) –scoped id of the resource.
network_insights_path_id (
str
) – The ID of the path.filter_in_arns (
Optional
[Sequence
[str
]]) – The Amazon Resource Names (ARN) of the resources that the path must traverse.tags (
Optional
[Sequence
[CfnTag
]]) – The tags to apply.
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::NetworkInsightsAnalysis'¶
-
attr_alternate_path_hints
¶ Potential intermediate components.
- CloudformationAttribute
AlternatePathHints
- Return type
-
attr_explanations
¶ The explanations.
For more information, see Reachability Analyzer explanation codes .
- CloudformationAttribute
Explanations
- Return type
-
attr_forward_path_components
¶ The components in the path from source to destination.
- CloudformationAttribute
ForwardPathComponents
- Return type
-
attr_network_insights_analysis_arn
¶ The Amazon Resource Name (ARN) of the network insights analysis.
- CloudformationAttribute
NetworkInsightsAnalysisArn
- Return type
str
-
attr_network_insights_analysis_id
¶ The ID of the network insights analysis.
- CloudformationAttribute
NetworkInsightsAnalysisId
- Return type
str
-
attr_network_path_found
¶ Indicates whether the destination is reachable from the source.
- CloudformationAttribute
NetworkPathFound
- Return type
-
attr_return_path_components
¶ The components in the path from destination to source.
- CloudformationAttribute
ReturnPathComponents
- Return type
-
attr_start_date
¶ The time the analysis started.
- CloudformationAttribute
StartDate
- Return type
str
-
attr_status
¶ The status of the network insights analysis.
- CloudformationAttribute
Status
- Return type
str
-
attr_status_message
¶ The status message, if the status is
failed
.- CloudformationAttribute
StatusMessage
- 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
]
-
filter_in_arns
¶ The Amazon Resource Names (ARN) of the resources that the path must traverse.
-
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.
-
network_insights_path_id
¶ The ID of the path.
-
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
-
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.
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
AlternatePathHintProperty¶
-
class
CfnNetworkInsightsAnalysis.
AlternatePathHintProperty
(*, component_arn=None, component_id=None)¶ Bases:
object
Describes an potential intermediate component of a feasible path.
- Parameters
component_arn (
Optional
[str
]) – The Amazon Resource Name (ARN) of the component.component_id (
Optional
[str
]) – The ID of the component.
- 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 alternate_path_hint_property = ec2.CfnNetworkInsightsAnalysis.AlternatePathHintProperty( component_arn="componentArn", component_id="componentId" )
Attributes
-
component_arn
¶ The Amazon Resource Name (ARN) of the component.
-
component_id
¶ The ID of the component.
AnalysisAclRuleProperty¶
-
class
CfnNetworkInsightsAnalysis.
AnalysisAclRuleProperty
(*, cidr=None, egress=None, port_range=None, protocol=None, rule_action=None, rule_number=None)¶ Bases:
object
Describes a network access control (ACL) rule.
- Parameters
cidr (
Optional
[str
]) – The IPv4 address range, in CIDR notation.egress (
Union
[bool
,IResolvable
,None
]) – Indicates whether the rule is an outbound rule.port_range (
Union
[IResolvable
,PortRangeProperty
,None
]) – The range of ports.protocol (
Optional
[str
]) – The protocol.rule_action (
Optional
[str
]) – Indicates whether to allow or deny traffic that matches the rule.rule_number (
Union
[int
,float
,None
]) – The rule number.
- 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 analysis_acl_rule_property = ec2.CfnNetworkInsightsAnalysis.AnalysisAclRuleProperty( cidr="cidr", egress=False, port_range=ec2.CfnNetworkInsightsAnalysis.PortRangeProperty( from=123, to=123 ), protocol="protocol", rule_action="ruleAction", rule_number=123 )
Attributes
-
cidr
¶ The IPv4 address range, in CIDR notation.
-
egress
¶ Indicates whether the rule is an outbound rule.
-
port_range
¶ The range of ports.
-
protocol
¶ The protocol.
-
rule_action
¶ Indicates whether to allow or deny traffic that matches the rule.
-
rule_number
¶ The rule number.
AnalysisComponentProperty¶
-
class
CfnNetworkInsightsAnalysis.
AnalysisComponentProperty
(*, arn=None, id=None)¶ Bases:
object
Describes a path component.
- Parameters
arn (
Optional
[str
]) – The Amazon Resource Name (ARN) of the component.id (
Optional
[str
]) – The ID of the component.
- 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 analysis_component_property = ec2.CfnNetworkInsightsAnalysis.AnalysisComponentProperty( arn="arn", id="id" )
Attributes
-
arn
¶ The Amazon Resource Name (ARN) of the component.
-
id
¶ The ID of the component.
AnalysisLoadBalancerListenerProperty¶
-
class
CfnNetworkInsightsAnalysis.
AnalysisLoadBalancerListenerProperty
(*, instance_port=None, load_balancer_port=None)¶ Bases:
object
Describes a load balancer listener.
- Parameters
instance_port (
Union
[int
,float
,None
]) – [Classic Load Balancers] The back-end port for the listener.load_balancer_port (
Union
[int
,float
,None
]) – The port on which the load balancer is listening.
- 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 analysis_load_balancer_listener_property = ec2.CfnNetworkInsightsAnalysis.AnalysisLoadBalancerListenerProperty( instance_port=123, load_balancer_port=123 )
Attributes
-
instance_port
¶ [Classic Load Balancers] The back-end port for the listener.
-
load_balancer_port
¶ The port on which the load balancer is listening.
AnalysisLoadBalancerTargetProperty¶
-
class
CfnNetworkInsightsAnalysis.
AnalysisLoadBalancerTargetProperty
(*, address=None, availability_zone=None, instance=None, port=None)¶ Bases:
object
Describes a load balancer target.
- Parameters
address (
Optional
[str
]) – The IP address.availability_zone (
Optional
[str
]) – The Availability Zone.instance (
Union
[IResolvable
,AnalysisComponentProperty
,None
]) – Information about the instance.port (
Union
[int
,float
,None
]) – The port on which the target is listening.
- 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 analysis_load_balancer_target_property = ec2.CfnNetworkInsightsAnalysis.AnalysisLoadBalancerTargetProperty( address="address", availability_zone="availabilityZone", instance=ec2.CfnNetworkInsightsAnalysis.AnalysisComponentProperty( arn="arn", id="id" ), port=123 )
Attributes
-
address
¶ The IP address.
-
availability_zone
¶ The Availability Zone.
-
instance
¶ Information about the instance.
-
port
¶ The port on which the target is listening.
AnalysisPacketHeaderProperty¶
-
class
CfnNetworkInsightsAnalysis.
AnalysisPacketHeaderProperty
(*, destination_addresses=None, destination_port_ranges=None, protocol=None, source_addresses=None, source_port_ranges=None)¶ Bases:
object
Describes a header.
Reflects any changes made by a component as traffic passes through. The fields of an inbound header are null except for the first component of a path.
- Parameters
destination_addresses (
Optional
[Sequence
[str
]]) – The destination addresses.destination_port_ranges (
Union
[IResolvable
,Sequence
[Union
[IResolvable
,PortRangeProperty
]],None
]) – The destination port ranges.protocol (
Optional
[str
]) – The protocol.source_addresses (
Optional
[Sequence
[str
]]) – The source addresses.source_port_ranges (
Union
[IResolvable
,Sequence
[Union
[IResolvable
,PortRangeProperty
]],None
]) – The source port ranges.
- 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 analysis_packet_header_property = ec2.CfnNetworkInsightsAnalysis.AnalysisPacketHeaderProperty( destination_addresses=["destinationAddresses"], destination_port_ranges=[ec2.CfnNetworkInsightsAnalysis.PortRangeProperty( from=123, to=123 )], protocol="protocol", source_addresses=["sourceAddresses"], source_port_ranges=[ec2.CfnNetworkInsightsAnalysis.PortRangeProperty( from=123, to=123 )] )
Attributes
-
destination_addresses
¶ The destination addresses.
-
destination_port_ranges
¶ The destination port ranges.
-
protocol
¶ The protocol.
-
source_addresses
¶ The source addresses.
-
source_port_ranges
¶ The source port ranges.
AnalysisRouteTableRouteProperty¶
-
class
CfnNetworkInsightsAnalysis.
AnalysisRouteTableRouteProperty
(*, destination_cidr=None, destination_prefix_list_id=None, egress_only_internet_gateway_id=None, gateway_id=None, instance_id=None, nat_gateway_id=None, network_interface_id=None, origin=None, transit_gateway_id=None, vpc_peering_connection_id=None)¶ Bases:
object
Describes a route table route.
- Parameters
destination_cidr (
Optional
[str
]) – The destination IPv4 address, in CIDR notation.destination_prefix_list_id (
Optional
[str
]) – The prefix of the AWS service .egress_only_internet_gateway_id (
Optional
[str
]) – The ID of an egress-only internet gateway.gateway_id (
Optional
[str
]) – The ID of the gateway, such as an internet gateway or virtual private gateway.instance_id (
Optional
[str
]) – The ID of the instance, such as a NAT instance.nat_gateway_id (
Optional
[str
]) – The ID of a NAT gateway.network_interface_id (
Optional
[str
]) – The ID of a network interface.origin (
Optional
[str
]) – Describes how the route was created. The following are the possible values:. - CreateRouteTable - The route was automatically created when the route table was created. - CreateRoute - The route was manually added to the route table. - EnableVgwRoutePropagation - The route was propagated by route propagation.transit_gateway_id (
Optional
[str
]) – The ID of a transit gateway.vpc_peering_connection_id (
Optional
[str
]) – The ID of a VPC peering connection.
- 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 analysis_route_table_route_property = ec2.CfnNetworkInsightsAnalysis.AnalysisRouteTableRouteProperty( destination_cidr="destinationCidr", destination_prefix_list_id="destinationPrefixListId", egress_only_internet_gateway_id="egressOnlyInternetGatewayId", gateway_id="gatewayId", instance_id="instanceId", nat_gateway_id="natGatewayId", network_interface_id="networkInterfaceId", origin="origin", transit_gateway_id="transitGatewayId", vpc_peering_connection_id="vpcPeeringConnectionId" )
Attributes
-
destination_cidr
¶ The destination IPv4 address, in CIDR notation.
-
destination_prefix_list_id
¶ The prefix of the AWS service .
-
egress_only_internet_gateway_id
¶ The ID of an egress-only internet gateway.
-
gateway_id
¶ The ID of the gateway, such as an internet gateway or virtual private gateway.
-
instance_id
¶ The ID of the instance, such as a NAT instance.
-
nat_gateway_id
¶ The ID of a NAT gateway.
-
network_interface_id
¶ The ID of a network interface.
-
origin
¶ .
CreateRouteTable - The route was automatically created when the route table was created.
CreateRoute - The route was manually added to the route table.
EnableVgwRoutePropagation - The route was propagated by route propagation.
- Link
- Type
Describes how the route was created. The following are the possible values
- Return type
Optional
[str
]
-
transit_gateway_id
¶ The ID of a transit gateway.
-
vpc_peering_connection_id
¶ The ID of a VPC peering connection.
AnalysisSecurityGroupRuleProperty¶
-
class
CfnNetworkInsightsAnalysis.
AnalysisSecurityGroupRuleProperty
(*, cidr=None, direction=None, port_range=None, prefix_list_id=None, protocol=None, security_group_id=None)¶ Bases:
object
Describes a security group rule.
- Parameters
cidr (
Optional
[str
]) – The IPv4 address range, in CIDR notation.direction (
Optional
[str
]) – The direction. The following are the possible values:. - egress - ingressport_range (
Union
[IResolvable
,PortRangeProperty
,None
]) – The port range.prefix_list_id (
Optional
[str
]) – The prefix list ID.protocol (
Optional
[str
]) – The protocol name.security_group_id (
Optional
[str
]) – The security group ID.
- 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 analysis_security_group_rule_property = ec2.CfnNetworkInsightsAnalysis.AnalysisSecurityGroupRuleProperty( cidr="cidr", direction="direction", port_range=ec2.CfnNetworkInsightsAnalysis.PortRangeProperty( from=123, to=123 ), prefix_list_id="prefixListId", protocol="protocol", security_group_id="securityGroupId" )
Attributes
-
cidr
¶ The IPv4 address range, in CIDR notation.
-
direction
¶ .
egress
ingress
- Link
- Type
The direction. The following are the possible values
- Return type
Optional
[str
]
-
port_range
¶ The port range.
-
prefix_list_id
¶ The prefix list ID.
-
protocol
¶ The protocol name.
-
security_group_id
¶ The security group ID.
ExplanationProperty¶
-
class
CfnNetworkInsightsAnalysis.
ExplanationProperty
(*, acl=None, acl_rule=None, address=None, addresses=None, attached_to=None, availability_zones=None, cidrs=None, classic_load_balancer_listener=None, component=None, customer_gateway=None, destination=None, destination_vpc=None, direction=None, elastic_load_balancer_listener=None, explanation_code=None, ingress_route_table=None, internet_gateway=None, load_balancer_arn=None, load_balancer_listener_port=None, load_balancer_target=None, load_balancer_target_group=None, load_balancer_target_groups=None, load_balancer_target_port=None, missing_component=None, nat_gateway=None, network_interface=None, packet_field=None, port=None, port_ranges=None, prefix_list=None, protocols=None, route_table=None, route_table_route=None, security_group=None, security_group_rule=None, security_groups=None, source_vpc=None, state=None, subnet=None, subnet_route_table=None, vpc=None, vpc_endpoint=None, vpc_peering_connection=None, vpn_connection=None, vpn_gateway=None)¶ Bases:
object
Describes an explanation code for an unreachable path.
For more information, see Reachability Analyzer explanation codes .
- Parameters
acl (
Union
[IResolvable
,AnalysisComponentProperty
,None
]) – The network ACL.acl_rule (
Union
[IResolvable
,AnalysisAclRuleProperty
,None
]) – The network ACL rule.address (
Optional
[str
]) – The IPv4 address, in CIDR notation.addresses (
Optional
[Sequence
[str
]]) – The IPv4 addresses, in CIDR notation.attached_to (
Union
[IResolvable
,AnalysisComponentProperty
,None
]) – The resource to which the component is attached.availability_zones (
Optional
[Sequence
[str
]]) – The Availability Zones.cidrs (
Optional
[Sequence
[str
]]) – The CIDR ranges.classic_load_balancer_listener (
Union
[IResolvable
,AnalysisLoadBalancerListenerProperty
,None
]) – The listener for a Classic Load Balancer.component (
Union
[IResolvable
,AnalysisComponentProperty
,None
]) – The component.customer_gateway (
Union
[IResolvable
,AnalysisComponentProperty
,None
]) – The customer gateway.destination (
Union
[IResolvable
,AnalysisComponentProperty
,None
]) – The destination.destination_vpc (
Union
[IResolvable
,AnalysisComponentProperty
,None
]) – The destination VPC.direction (
Optional
[str
]) – The direction. The following are the possible values:. - egress - ingresselastic_load_balancer_listener (
Union
[IResolvable
,AnalysisComponentProperty
,None
]) – The load balancer listener.explanation_code (
Optional
[str
]) – The explanation code.ingress_route_table (
Union
[IResolvable
,AnalysisComponentProperty
,None
]) – The route table.internet_gateway (
Union
[IResolvable
,AnalysisComponentProperty
,None
]) – The internet gateway.load_balancer_arn (
Optional
[str
]) – The Amazon Resource Name (ARN) of the load balancer.load_balancer_listener_port (
Union
[int
,float
,None
]) – The listener port of the load balancer.load_balancer_target (
Union
[IResolvable
,AnalysisLoadBalancerTargetProperty
,None
]) – The target.load_balancer_target_group (
Union
[IResolvable
,AnalysisComponentProperty
,None
]) – The target group.load_balancer_target_groups (
Union
[IResolvable
,Sequence
[Union
[IResolvable
,AnalysisComponentProperty
]],None
]) – The target groups.load_balancer_target_port (
Union
[int
,float
,None
]) – The target port.missing_component (
Optional
[str
]) – The missing component.nat_gateway (
Union
[IResolvable
,AnalysisComponentProperty
,None
]) – The NAT gateway.network_interface (
Union
[IResolvable
,AnalysisComponentProperty
,None
]) – The network interface.packet_field (
Optional
[str
]) – The packet field.port (
Union
[int
,float
,None
]) – The port.port_ranges (
Union
[IResolvable
,Sequence
[Union
[IResolvable
,PortRangeProperty
]],None
]) – The port ranges.prefix_list (
Union
[IResolvable
,AnalysisComponentProperty
,None
]) – The prefix list.protocols (
Optional
[Sequence
[str
]]) – The protocols.route_table (
Union
[IResolvable
,AnalysisComponentProperty
,None
]) – The route table.route_table_route (
Union
[IResolvable
,AnalysisRouteTableRouteProperty
,None
]) – The route table route.security_group (
Union
[IResolvable
,AnalysisComponentProperty
,None
]) – The security group.security_group_rule (
Union
[IResolvable
,AnalysisSecurityGroupRuleProperty
,None
]) – The security group rule.security_groups (
Union
[IResolvable
,Sequence
[Union
[IResolvable
,AnalysisComponentProperty
]],None
]) – The security groups.source_vpc (
Union
[IResolvable
,AnalysisComponentProperty
,None
]) – The source VPC.state (
Optional
[str
]) – The state.subnet (
Union
[IResolvable
,AnalysisComponentProperty
,None
]) – The subnet.subnet_route_table (
Union
[IResolvable
,AnalysisComponentProperty
,None
]) – The route table for the subnet.vpc (
Union
[IResolvable
,AnalysisComponentProperty
,None
]) – The component VPC.vpc_endpoint (
Union
[IResolvable
,AnalysisComponentProperty
,None
]) – The VPC endpoint.vpc_peering_connection (
Union
[IResolvable
,AnalysisComponentProperty
,None
]) – The VPC peering connection.vpn_connection (
Union
[IResolvable
,AnalysisComponentProperty
,None
]) – The VPN connection.vpn_gateway (
Union
[IResolvable
,AnalysisComponentProperty
,None
]) – The VPN gateway.
- 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 explanation_property = ec2.CfnNetworkInsightsAnalysis.ExplanationProperty( acl=ec2.CfnNetworkInsightsAnalysis.AnalysisComponentProperty( arn="arn", id="id" ), acl_rule=ec2.CfnNetworkInsightsAnalysis.AnalysisAclRuleProperty( cidr="cidr", egress=False, port_range=ec2.CfnNetworkInsightsAnalysis.PortRangeProperty( from=123, to=123 ), protocol="protocol", rule_action="ruleAction", rule_number=123 ), address="address", addresses=["addresses"], attached_to=ec2.CfnNetworkInsightsAnalysis.AnalysisComponentProperty( arn="arn", id="id" ), availability_zones=["availabilityZones"], cidrs=["cidrs"], classic_load_balancer_listener=ec2.CfnNetworkInsightsAnalysis.AnalysisLoadBalancerListenerProperty( instance_port=123, load_balancer_port=123 ), component=ec2.CfnNetworkInsightsAnalysis.AnalysisComponentProperty( arn="arn", id="id" ), customer_gateway=ec2.CfnNetworkInsightsAnalysis.AnalysisComponentProperty( arn="arn", id="id" ), destination=ec2.CfnNetworkInsightsAnalysis.AnalysisComponentProperty( arn="arn", id="id" ), destination_vpc=ec2.CfnNetworkInsightsAnalysis.AnalysisComponentProperty( arn="arn", id="id" ), direction="direction", elastic_load_balancer_listener=ec2.CfnNetworkInsightsAnalysis.AnalysisComponentProperty( arn="arn", id="id" ), explanation_code="explanationCode", ingress_route_table=ec2.CfnNetworkInsightsAnalysis.AnalysisComponentProperty( arn="arn", id="id" ), internet_gateway=ec2.CfnNetworkInsightsAnalysis.AnalysisComponentProperty( arn="arn", id="id" ), load_balancer_arn="loadBalancerArn", load_balancer_listener_port=123, load_balancer_target=ec2.CfnNetworkInsightsAnalysis.AnalysisLoadBalancerTargetProperty( address="address", availability_zone="availabilityZone", instance=ec2.CfnNetworkInsightsAnalysis.AnalysisComponentProperty( arn="arn", id="id" ), port=123 ), load_balancer_target_group=ec2.CfnNetworkInsightsAnalysis.AnalysisComponentProperty( arn="arn", id="id" ), load_balancer_target_groups=[ec2.CfnNetworkInsightsAnalysis.AnalysisComponentProperty( arn="arn", id="id" )], load_balancer_target_port=123, missing_component="missingComponent", nat_gateway=ec2.CfnNetworkInsightsAnalysis.AnalysisComponentProperty( arn="arn", id="id" ), network_interface=ec2.CfnNetworkInsightsAnalysis.AnalysisComponentProperty( arn="arn", id="id" ), packet_field="packetField", port=123, port_ranges=[ec2.CfnNetworkInsightsAnalysis.PortRangeProperty( from=123, to=123 )], prefix_list=ec2.CfnNetworkInsightsAnalysis.AnalysisComponentProperty( arn="arn", id="id" ), protocols=["protocols"], route_table=ec2.CfnNetworkInsightsAnalysis.AnalysisComponentProperty( arn="arn", id="id" ), route_table_route=ec2.CfnNetworkInsightsAnalysis.AnalysisRouteTableRouteProperty( destination_cidr="destinationCidr", destination_prefix_list_id="destinationPrefixListId", egress_only_internet_gateway_id="egressOnlyInternetGatewayId", gateway_id="gatewayId", instance_id="instanceId", nat_gateway_id="natGatewayId", network_interface_id="networkInterfaceId", origin="origin", transit_gateway_id="transitGatewayId", vpc_peering_connection_id="vpcPeeringConnectionId" ), security_group=ec2.CfnNetworkInsightsAnalysis.AnalysisComponentProperty( arn="arn", id="id" ), security_group_rule=ec2.CfnNetworkInsightsAnalysis.AnalysisSecurityGroupRuleProperty( cidr="cidr", direction="direction", port_range=ec2.CfnNetworkInsightsAnalysis.PortRangeProperty( from=123, to=123 ), prefix_list_id="prefixListId", protocol="protocol", security_group_id="securityGroupId" ), security_groups=[ec2.CfnNetworkInsightsAnalysis.AnalysisComponentProperty( arn="arn", id="id" )], source_vpc=ec2.CfnNetworkInsightsAnalysis.AnalysisComponentProperty( arn="arn", id="id" ), state="state", subnet=ec2.CfnNetworkInsightsAnalysis.AnalysisComponentProperty( arn="arn", id="id" ), subnet_route_table=ec2.CfnNetworkInsightsAnalysis.AnalysisComponentProperty( arn="arn", id="id" ), vpc=ec2.CfnNetworkInsightsAnalysis.AnalysisComponentProperty( arn="arn", id="id" ), vpc_endpoint=ec2.CfnNetworkInsightsAnalysis.AnalysisComponentProperty( arn="arn", id="id" ), vpc_peering_connection=ec2.CfnNetworkInsightsAnalysis.AnalysisComponentProperty( arn="arn", id="id" ), vpn_connection=ec2.CfnNetworkInsightsAnalysis.AnalysisComponentProperty( arn="arn", id="id" ), vpn_gateway=ec2.CfnNetworkInsightsAnalysis.AnalysisComponentProperty( arn="arn", id="id" ) )
Attributes
-
acl
¶ The network ACL.
-
acl_rule
¶ The network ACL rule.
-
address
¶ The IPv4 address, in CIDR notation.
-
addresses
¶ The IPv4 addresses, in CIDR notation.
-
attached_to
¶ The resource to which the component is attached.
-
availability_zones
¶ The Availability Zones.
-
cidrs
¶ The CIDR ranges.
-
classic_load_balancer_listener
¶ The listener for a Classic Load Balancer.
-
component
¶ The component.
-
customer_gateway
¶ The customer gateway.
-
destination
¶ The destination.
-
destination_vpc
¶ The destination VPC.
-
direction
¶ .
egress
ingress
- Link
- Type
The direction. The following are the possible values
- Return type
Optional
[str
]
-
elastic_load_balancer_listener
¶ The load balancer listener.
-
explanation_code
¶ The explanation code.
-
ingress_route_table
¶ The route table.
-
internet_gateway
¶ The internet gateway.
-
load_balancer_arn
¶ The Amazon Resource Name (ARN) of the load balancer.
-
load_balancer_listener_port
¶ The listener port of the load balancer.
-
load_balancer_target
¶ The target.
-
load_balancer_target_group
¶ The target group.
-
load_balancer_target_groups
¶ The target groups.
-
load_balancer_target_port
¶ The target port.
-
missing_component
¶ The missing component.
-
nat_gateway
¶ The NAT gateway.
-
network_interface
¶ The network interface.
-
packet_field
¶ The packet field.
-
port
¶ The port.
-
port_ranges
¶ The port ranges.
-
prefix_list
¶ The prefix list.
-
protocols
¶ The protocols.
-
route_table
¶ The route table.
-
route_table_route
¶ The route table route.
-
security_group
¶ The security group.
-
security_group_rule
¶ The security group rule.
-
security_groups
¶ The security groups.
-
source_vpc
¶ The source VPC.
-
state
¶ The state.
-
subnet
¶ The subnet.
-
subnet_route_table
¶ The route table for the subnet.
-
vpc
¶ The component VPC.
-
vpc_endpoint
¶ The VPC endpoint.
-
vpc_peering_connection
¶ The VPC peering connection.
-
vpn_connection
¶ The VPN connection.
-
vpn_gateway
¶ The VPN gateway.
PathComponentProperty¶
-
class
CfnNetworkInsightsAnalysis.
PathComponentProperty
(*, acl_rule=None, component=None, destination_vpc=None, inbound_header=None, outbound_header=None, route_table_route=None, security_group_rule=None, sequence_number=None, source_vpc=None, subnet=None, vpc=None)¶ Bases:
object
Describes a path component.
- Parameters
acl_rule (
Union
[IResolvable
,AnalysisAclRuleProperty
,None
]) – The network ACL rule.component (
Union
[IResolvable
,AnalysisComponentProperty
,None
]) – The component.destination_vpc (
Union
[IResolvable
,AnalysisComponentProperty
,None
]) – The destination VPC.inbound_header (
Union
[IResolvable
,AnalysisPacketHeaderProperty
,None
]) – The inbound header.outbound_header (
Union
[IResolvable
,AnalysisPacketHeaderProperty
,None
]) – The outbound header.route_table_route (
Union
[IResolvable
,AnalysisRouteTableRouteProperty
,None
]) – The route table route.security_group_rule (
Union
[IResolvable
,AnalysisSecurityGroupRuleProperty
,None
]) – The security group rule.sequence_number (
Union
[int
,float
,None
]) – The sequence number.source_vpc (
Union
[IResolvable
,AnalysisComponentProperty
,None
]) – The source VPC.subnet (
Union
[IResolvable
,AnalysisComponentProperty
,None
]) – The subnet.vpc (
Union
[IResolvable
,AnalysisComponentProperty
,None
]) – The component VPC.
- 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_component_property = ec2.CfnNetworkInsightsAnalysis.PathComponentProperty( acl_rule=ec2.CfnNetworkInsightsAnalysis.AnalysisAclRuleProperty( cidr="cidr", egress=False, port_range=ec2.CfnNetworkInsightsAnalysis.PortRangeProperty( from=123, to=123 ), protocol="protocol", rule_action="ruleAction", rule_number=123 ), component=ec2.CfnNetworkInsightsAnalysis.AnalysisComponentProperty( arn="arn", id="id" ), destination_vpc=ec2.CfnNetworkInsightsAnalysis.AnalysisComponentProperty( arn="arn", id="id" ), inbound_header=ec2.CfnNetworkInsightsAnalysis.AnalysisPacketHeaderProperty( destination_addresses=["destinationAddresses"], destination_port_ranges=[ec2.CfnNetworkInsightsAnalysis.PortRangeProperty( from=123, to=123 )], protocol="protocol", source_addresses=["sourceAddresses"], source_port_ranges=[ec2.CfnNetworkInsightsAnalysis.PortRangeProperty( from=123, to=123 )] ), outbound_header=ec2.CfnNetworkInsightsAnalysis.AnalysisPacketHeaderProperty( destination_addresses=["destinationAddresses"], destination_port_ranges=[ec2.CfnNetworkInsightsAnalysis.PortRangeProperty( from=123, to=123 )], protocol="protocol", source_addresses=["sourceAddresses"], source_port_ranges=[ec2.CfnNetworkInsightsAnalysis.PortRangeProperty( from=123, to=123 )] ), route_table_route=ec2.CfnNetworkInsightsAnalysis.AnalysisRouteTableRouteProperty( destination_cidr="destinationCidr", destination_prefix_list_id="destinationPrefixListId", egress_only_internet_gateway_id="egressOnlyInternetGatewayId", gateway_id="gatewayId", instance_id="instanceId", nat_gateway_id="natGatewayId", network_interface_id="networkInterfaceId", origin="origin", transit_gateway_id="transitGatewayId", vpc_peering_connection_id="vpcPeeringConnectionId" ), security_group_rule=ec2.CfnNetworkInsightsAnalysis.AnalysisSecurityGroupRuleProperty( cidr="cidr", direction="direction", port_range=ec2.CfnNetworkInsightsAnalysis.PortRangeProperty( from=123, to=123 ), prefix_list_id="prefixListId", protocol="protocol", security_group_id="securityGroupId" ), sequence_number=123, source_vpc=ec2.CfnNetworkInsightsAnalysis.AnalysisComponentProperty( arn="arn", id="id" ), subnet=ec2.CfnNetworkInsightsAnalysis.AnalysisComponentProperty( arn="arn", id="id" ), vpc=ec2.CfnNetworkInsightsAnalysis.AnalysisComponentProperty( arn="arn", id="id" ) )
Attributes
-
acl_rule
¶ The network ACL rule.
-
component
¶ The component.
-
destination_vpc
¶ The destination VPC.
-
inbound_header
¶ The inbound header.
-
outbound_header
¶ The outbound header.
-
route_table_route
¶ The route table route.
-
security_group_rule
¶ The security group rule.
-
sequence_number
¶ The sequence number.
-
source_vpc
¶ The source VPC.
-
subnet
¶ The subnet.
-
vpc
¶ The component VPC.
PortRangeProperty¶
-
class
CfnNetworkInsightsAnalysis.
PortRangeProperty
(*, from_=None, to=None)¶ Bases:
object
Describes a range of ports.
- Parameters
from – The first port in the range.
to (
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 port_range_property = ec2.CfnNetworkInsightsAnalysis.PortRangeProperty( from=123, to=123 )
Attributes
-
from_
¶ The first port in the range.
-
to
¶ The last port in the range.
- Link
- Return type
Union
[int
,float
,None
]