Skip to content

Route

Source code in docs_src/capo_ec2/types/route.py 
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
class Route(TypedDict, closed=True):
    destination_cidr_block: NotRequired["capo_ec2.types.string.String"]
    """<p>The IPv4 CIDR block used for the destination match.</p>"""
    destination_ipv6_cidr_block: NotRequired["capo_ec2.types.string.String"]
    """<p>The IPv6 CIDR block used for the destination match.</p>"""
    destination_prefix_list_id: NotRequired["capo_ec2.types.string.String"]
    """<p>The prefix of the Amazon Web Services service.</p>"""
    egress_only_internet_gateway_id: NotRequired["capo_ec2.types.string.String"]
    """<p>The ID of the egress-only internet gateway.</p>"""
    gateway_id: NotRequired["capo_ec2.types.string.String"]
    """<p>The ID of a gateway attached to your VPC.</p>"""
    instance_id: NotRequired["capo_ec2.types.string.String"]
    """<p>The ID of a NAT instance in your VPC.</p>"""
    instance_owner_id: NotRequired["capo_ec2.types.string.String"]
    """<p>The ID of Amazon Web Services account that owns the instance.</p>"""
    nat_gateway_id: NotRequired["capo_ec2.types.string.String"]
    """<p>The ID of a NAT gateway.</p>"""
    transit_gateway_id: NotRequired["capo_ec2.types.string.String"]
    """<p>The ID of a transit gateway.</p>"""
    local_gateway_id: NotRequired["capo_ec2.types.string.String"]
    """<p>The ID of the local gateway.</p>"""
    carrier_gateway_id: NotRequired[
        "capo_ec2.types.carrier_gateway_id.CarrierGatewayId"
    ]
    """<p>The ID of the carrier gateway.</p>"""
    network_interface_id: NotRequired["capo_ec2.types.string.String"]
    """<p>The ID of the network interface.</p>"""
    origin: NotRequired["capo_ec2.types.route_origin.RouteOrigin"]
    """<p>Describes how the route was created.</p> <ul> <li> <p> <code>CreateRouteTable</code> - The route was automatically created when the route table was created.</p> </li> <li> <p> <code>CreateRoute</code> - The route was manually added to the route table.</p> </li> <li> <p> <code>EnableVgwRoutePropagation</code> - The route was propagated by route propagation.</p> </li> <li> <p> <code>Advertisement</code> - The route was created dynamically by Amazon VPC Route Server.</p> </li> </ul>"""
    state: NotRequired["capo_ec2.types.route_state.RouteState"]
    """<p>The state of the route. The <code>blackhole</code> state indicates that the route's target isn't available (for example, the specified gateway isn't attached to the VPC, or the specified NAT instance has been terminated).</p>"""
    vpc_peering_connection_id: NotRequired["capo_ec2.types.string.String"]
    """<p>The ID of a VPC peering connection.</p>"""
    core_network_arn: NotRequired["capo_ec2.types.core_network_arn.CoreNetworkArn"]
    """<p>The Amazon Resource Name (ARN) of the core network.</p>"""
    odb_network_arn: NotRequired["capo_ec2.types.odb_network_arn.OdbNetworkArn"]
    """<p>The Amazon Resource Name (ARN) of the ODB network.</p>"""
    ip_address: NotRequired["capo_ec2.types.string.String"]
    """<p>The next hop IP address for routes propagated by VPC Route Server into VPC route tables.</p>"""

carrier_gateway_id instance-attribute 

carrier_gateway_id: NotRequired[CarrierGatewayId]

The ID of the carrier gateway.

core_network_arn instance-attribute 

core_network_arn: NotRequired[CoreNetworkArn]

The Amazon Resource Name (ARN) of the core network.

destination_cidr_block instance-attribute 

destination_cidr_block: NotRequired[String]

The IPv4 CIDR block used for the destination match.

destination_ipv6_cidr_block instance-attribute 

destination_ipv6_cidr_block: NotRequired[String]

The IPv6 CIDR block used for the destination match.

destination_prefix_list_id instance-attribute 

destination_prefix_list_id: NotRequired[String]

The prefix of the Amazon Web Services service.

egress_only_internet_gateway_id instance-attribute 

egress_only_internet_gateway_id: NotRequired[String]

The ID of the egress-only internet gateway.

gateway_id instance-attribute 

gateway_id: NotRequired[String]

The ID of a gateway attached to your VPC.

instance_id instance-attribute 

instance_id: NotRequired[String]

The ID of a NAT instance in your VPC.

instance_owner_id instance-attribute 

instance_owner_id: NotRequired[String]

The ID of Amazon Web Services account that owns the instance.

ip_address instance-attribute 

ip_address: NotRequired[String]

The next hop IP address for routes propagated by VPC Route Server into VPC route tables.

local_gateway_id instance-attribute 

local_gateway_id: NotRequired[String]

The ID of the local gateway.

nat_gateway_id instance-attribute 

nat_gateway_id: NotRequired[String]

The ID of a NAT gateway.

network_interface_id instance-attribute 

network_interface_id: NotRequired[String]

The ID of the network interface.

odb_network_arn instance-attribute 

odb_network_arn: NotRequired[OdbNetworkArn]

The Amazon Resource Name (ARN) of the ODB network.

origin instance-attribute 

origin: NotRequired[RouteOrigin]

Describes how the route was created.

  • 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.

  • Advertisement - The route was created dynamically by Amazon VPC Route Server.

state instance-attribute 

state: NotRequired[RouteState]

The state of the route. The blackhole state indicates that the route's target isn't available (for example, the specified gateway isn't attached to the VPC, or the specified NAT instance has been terminated).

transit_gateway_id instance-attribute 

transit_gateway_id: NotRequired[String]

The ID of a transit gateway.

vpc_peering_connection_id instance-attribute 

vpc_peering_connection_id: NotRequired[String]

The ID of a VPC peering connection.