Skip to content

Explanation

Source code in docs_src/capo_ec2/types/explanation.py
class Explanation(TypedDict, closed=True):
    acl: NotRequired["capo_ec2.types.analysis_component.AnalysisComponent"]
    """<p>The network ACL.</p>"""
    acl_rule: NotRequired["capo_ec2.types.analysis_acl_rule.AnalysisAclRule"]
    """<p>The network ACL rule.</p>"""
    address: NotRequired["capo_ec2.types.ip_address.IpAddress"]
    """<p>The IPv4 address, in CIDR notation.</p>"""
    addresses: NotRequired["capo_ec2.types.ip_address_list.IpAddressList"]
    """<p>The IPv4 addresses, in CIDR notation.</p>"""
    attached_to: NotRequired["capo_ec2.types.analysis_component.AnalysisComponent"]
    """<p>The resource to which the component is attached.</p>"""
    availability_zones: NotRequired["capo_ec2.types.value_string_list.ValueStringList"]
    """<p>The Availability Zones.</p>"""
    availability_zone_ids: NotRequired[
        "capo_ec2.types.value_string_list.ValueStringList"
    ]
    """<p>The IDs of the Availability Zones.</p>"""
    cidrs: NotRequired["capo_ec2.types.value_string_list.ValueStringList"]
    """<p>The CIDR ranges.</p>"""
    component: NotRequired["capo_ec2.types.analysis_component.AnalysisComponent"]
    """<p>The component.</p>"""
    customer_gateway: NotRequired["capo_ec2.types.analysis_component.AnalysisComponent"]
    """<p>The customer gateway.</p>"""
    destination: NotRequired["capo_ec2.types.analysis_component.AnalysisComponent"]
    """<p>The destination.</p>"""
    destination_vpc: NotRequired["capo_ec2.types.analysis_component.AnalysisComponent"]
    """<p>The destination VPC.</p>"""
    direction: NotRequired["capo_ec2.types.string.String"]
    """<p>The direction. The following are the possible values:</p> <ul> <li> <p>egress</p> </li> <li> <p>ingress</p> </li> </ul>"""
    explanation_code: NotRequired["capo_ec2.types.string.String"]
    """<p>The explanation code.</p>"""
    ingress_route_table: NotRequired[
        "capo_ec2.types.analysis_component.AnalysisComponent"
    ]
    """<p>The route table.</p>"""
    internet_gateway: NotRequired["capo_ec2.types.analysis_component.AnalysisComponent"]
    """<p>The internet gateway.</p>"""
    load_balancer_arn: NotRequired["capo_ec2.types.resource_arn.ResourceArn"]
    """<p>The Amazon Resource Name (ARN) of the load balancer.</p>"""
    classic_load_balancer_listener: NotRequired[
        "capo_ec2.types.analysis_load_balancer_listener.AnalysisLoadBalancerListener"
    ]
    """<p>The listener for a Classic Load Balancer.</p>"""
    load_balancer_listener_port: NotRequired["capo_ec2.types.port.Port"]
    """<p>The listener port of the load balancer.</p>"""
    load_balancer_target: NotRequired[
        "capo_ec2.types.analysis_load_balancer_target.AnalysisLoadBalancerTarget"
    ]
    """<p>The target.</p>"""
    load_balancer_target_group: NotRequired[
        "capo_ec2.types.analysis_component.AnalysisComponent"
    ]
    """<p>The target group.</p>"""
    load_balancer_target_groups: NotRequired[
        "capo_ec2.types.analysis_component_list.AnalysisComponentList"
    ]
    """<p>The target groups.</p>"""
    load_balancer_target_port: NotRequired["capo_ec2.types.port.Port"]
    """<p>The target port.</p>"""
    elastic_load_balancer_listener: NotRequired[
        "capo_ec2.types.analysis_component.AnalysisComponent"
    ]
    """<p>The load balancer listener.</p>"""
    missing_component: NotRequired["capo_ec2.types.string.String"]
    """<p>The missing component.</p>"""
    nat_gateway: NotRequired["capo_ec2.types.analysis_component.AnalysisComponent"]
    """<p>The NAT gateway.</p>"""
    network_interface: NotRequired[
        "capo_ec2.types.analysis_component.AnalysisComponent"
    ]
    """<p>The network interface.</p>"""
    packet_field: NotRequired["capo_ec2.types.string.String"]
    """<p>The packet field.</p>"""
    vpc_peering_connection: NotRequired[
        "capo_ec2.types.analysis_component.AnalysisComponent"
    ]
    """<p>The VPC peering connection.</p>"""
    port: NotRequired["capo_ec2.types.port.Port"]
    """<p>The port.</p>"""
    port_ranges: NotRequired["capo_ec2.types.port_range_list.PortRangeList"]
    """<p>The port ranges.</p>"""
    prefix_list: NotRequired["capo_ec2.types.analysis_component.AnalysisComponent"]
    """<p>The prefix list.</p>"""
    protocols: NotRequired["capo_ec2.types.string_list.StringList"]
    """<p>The protocols.</p>"""
    route_table_route: NotRequired[
        "capo_ec2.types.analysis_route_table_route.AnalysisRouteTableRoute"
    ]
    """<p>The route table route.</p>"""
    route_table: NotRequired["capo_ec2.types.analysis_component.AnalysisComponent"]
    """<p>The route table.</p>"""
    security_group: NotRequired["capo_ec2.types.analysis_component.AnalysisComponent"]
    """<p>The security group.</p>"""
    security_group_rule: NotRequired[
        "capo_ec2.types.analysis_security_group_rule.AnalysisSecurityGroupRule"
    ]
    """<p>The security group rule.</p>"""
    security_groups: NotRequired[
        "capo_ec2.types.analysis_component_list.AnalysisComponentList"
    ]
    """<p>The security groups.</p>"""
    source_vpc: NotRequired["capo_ec2.types.analysis_component.AnalysisComponent"]
    """<p>The source VPC.</p>"""
    state: NotRequired["capo_ec2.types.string.String"]
    """<p>The state.</p>"""
    subnet: NotRequired["capo_ec2.types.analysis_component.AnalysisComponent"]
    """<p>The subnet.</p>"""
    subnet_route_table: NotRequired[
        "capo_ec2.types.analysis_component.AnalysisComponent"
    ]
    """<p>The route table for the subnet.</p>"""
    vpc: NotRequired["capo_ec2.types.analysis_component.AnalysisComponent"]
    """<p>The component VPC.</p>"""
    vpc_endpoint: NotRequired["capo_ec2.types.analysis_component.AnalysisComponent"]
    """<p>The VPC endpoint.</p>"""
    vpn_connection: NotRequired["capo_ec2.types.analysis_component.AnalysisComponent"]
    """<p>The VPN connection.</p>"""
    vpn_gateway: NotRequired["capo_ec2.types.analysis_component.AnalysisComponent"]
    """<p>The VPN gateway.</p>"""
    transit_gateway: NotRequired["capo_ec2.types.analysis_component.AnalysisComponent"]
    """<p>The transit gateway.</p>"""
    transit_gateway_route_table: NotRequired[
        "capo_ec2.types.analysis_component.AnalysisComponent"
    ]
    """<p>The transit gateway route table.</p>"""
    transit_gateway_route_table_route: NotRequired[
        "capo_ec2.types.transit_gateway_route_table_route.TransitGatewayRouteTableRoute"
    ]
    """<p>The transit gateway route table route.</p>"""
    transit_gateway_attachment: NotRequired[
        "capo_ec2.types.analysis_component.AnalysisComponent"
    ]
    """<p>The transit gateway attachment.</p>"""
    component_account: NotRequired["capo_ec2.types.component_account.ComponentAccount"]
    """<p>The Amazon Web Services account for the component.</p>"""
    component_region: NotRequired["capo_ec2.types.component_region.ComponentRegion"]
    """<p>The Region for the component.</p>"""
    firewall_stateless_rule: NotRequired[
        "capo_ec2.types.firewall_stateless_rule.FirewallStatelessRule"
    ]
    """<p>The Network Firewall stateless rule.</p>"""
    firewall_stateful_rule: NotRequired[
        "capo_ec2.types.firewall_stateful_rule.FirewallStatefulRule"
    ]
    """<p>The Network Firewall stateful rule.</p>"""

acl instance-attribute

acl: NotRequired[AnalysisComponent]

The network ACL.

acl_rule instance-attribute

acl_rule: NotRequired[AnalysisAclRule]

The network ACL rule.

address instance-attribute

address: NotRequired[IpAddress]

The IPv4 address, in CIDR notation.

addresses instance-attribute

addresses: NotRequired[IpAddressList]

The IPv4 addresses, in CIDR notation.

attached_to instance-attribute

attached_to: NotRequired[AnalysisComponent]

The resource to which the component is attached.

availability_zone_ids instance-attribute

availability_zone_ids: NotRequired[ValueStringList]

The IDs of the Availability Zones.

availability_zones instance-attribute

availability_zones: NotRequired[ValueStringList]

The Availability Zones.

cidrs instance-attribute

cidrs: NotRequired[ValueStringList]

The CIDR ranges.

classic_load_balancer_listener instance-attribute

classic_load_balancer_listener: NotRequired[AnalysisLoadBalancerListener]

The listener for a Classic Load Balancer.

component instance-attribute

component: NotRequired[AnalysisComponent]

The component.

component_account instance-attribute

component_account: NotRequired[ComponentAccount]

The Amazon Web Services account for the component.

component_region instance-attribute

component_region: NotRequired[ComponentRegion]

The Region for the component.

customer_gateway instance-attribute

customer_gateway: NotRequired[AnalysisComponent]

The customer gateway.

destination instance-attribute

destination: NotRequired[AnalysisComponent]

The destination.

destination_vpc instance-attribute

destination_vpc: NotRequired[AnalysisComponent]

The destination VPC.

direction instance-attribute

direction: NotRequired[String]

The direction. The following are the possible values:

  • egress

  • ingress

elastic_load_balancer_listener instance-attribute

elastic_load_balancer_listener: NotRequired[AnalysisComponent]

The load balancer listener.

explanation_code instance-attribute

explanation_code: NotRequired[String]

The explanation code.

firewall_stateful_rule instance-attribute

firewall_stateful_rule: NotRequired[FirewallStatefulRule]

The Network Firewall stateful rule.

firewall_stateless_rule instance-attribute

firewall_stateless_rule: NotRequired[FirewallStatelessRule]

The Network Firewall stateless rule.

ingress_route_table instance-attribute

ingress_route_table: NotRequired[AnalysisComponent]

The route table.

internet_gateway instance-attribute

internet_gateway: NotRequired[AnalysisComponent]

The internet gateway.

load_balancer_arn instance-attribute

load_balancer_arn: NotRequired[ResourceArn]

The Amazon Resource Name (ARN) of the load balancer.

load_balancer_listener_port instance-attribute

load_balancer_listener_port: NotRequired[Port]

The listener port of the load balancer.

load_balancer_target instance-attribute

load_balancer_target: NotRequired[AnalysisLoadBalancerTarget]

The target.

load_balancer_target_group instance-attribute

load_balancer_target_group: NotRequired[AnalysisComponent]

The target group.

load_balancer_target_groups instance-attribute

load_balancer_target_groups: NotRequired[AnalysisComponentList]

The target groups.

load_balancer_target_port instance-attribute

load_balancer_target_port: NotRequired[Port]

The target port.

missing_component instance-attribute

missing_component: NotRequired[String]

The missing component.

nat_gateway instance-attribute

nat_gateway: NotRequired[AnalysisComponent]

The NAT gateway.

network_interface instance-attribute

network_interface: NotRequired[AnalysisComponent]

The network interface.

packet_field instance-attribute

packet_field: NotRequired[String]

The packet field.

port instance-attribute

port: NotRequired[Port]

The port.

port_ranges instance-attribute

port_ranges: NotRequired[PortRangeList]

The port ranges.

prefix_list instance-attribute

prefix_list: NotRequired[AnalysisComponent]

The prefix list.

protocols instance-attribute

protocols: NotRequired[StringList]

The protocols.

route_table instance-attribute

route_table: NotRequired[AnalysisComponent]

The route table.

route_table_route instance-attribute

route_table_route: NotRequired[AnalysisRouteTableRoute]

The route table route.

security_group instance-attribute

security_group: NotRequired[AnalysisComponent]

The security group.

security_group_rule instance-attribute

security_group_rule: NotRequired[AnalysisSecurityGroupRule]

The security group rule.

security_groups instance-attribute

security_groups: NotRequired[AnalysisComponentList]

The security groups.

source_vpc instance-attribute

source_vpc: NotRequired[AnalysisComponent]

The source VPC.

state instance-attribute

state: NotRequired[String]

The state.

subnet instance-attribute

subnet: NotRequired[AnalysisComponent]

The subnet.

subnet_route_table instance-attribute

subnet_route_table: NotRequired[AnalysisComponent]

The route table for the subnet.

transit_gateway instance-attribute

transit_gateway: NotRequired[AnalysisComponent]

The transit gateway.

transit_gateway_attachment instance-attribute

transit_gateway_attachment: NotRequired[AnalysisComponent]

The transit gateway attachment.

transit_gateway_route_table instance-attribute

transit_gateway_route_table: NotRequired[AnalysisComponent]

The transit gateway route table.

transit_gateway_route_table_route instance-attribute

transit_gateway_route_table_route: NotRequired[TransitGatewayRouteTableRoute]

The transit gateway route table route.

vpc instance-attribute

vpc: NotRequired[AnalysisComponent]

The component VPC.

vpc_endpoint instance-attribute

vpc_endpoint: NotRequired[AnalysisComponent]

The VPC endpoint.

vpc_peering_connection instance-attribute

vpc_peering_connection: NotRequired[AnalysisComponent]

The VPC peering connection.

vpn_connection instance-attribute

vpn_connection: NotRequired[AnalysisComponent]

The VPN connection.

vpn_gateway instance-attribute

vpn_gateway: NotRequired[AnalysisComponent]

The VPN gateway.