Skip to content

IpamDiscoveredRoute

Source code in docs_src/capo_ec2/types/ipam_discovered_route.py
class IpamDiscoveredRoute(TypedDict, closed=True):
    ipam_resource_discovery_id: NotRequired[
        "capo_ec2.types.ipam_resource_discovery_id.IpamResourceDiscoveryId"
    ]
    """<p>The ID of the IPAM resource discovery that discovered the route.</p>"""
    resource_region: NotRequired["capo_ec2.types.string.String"]
    """<p>The Amazon Web Services Region where the route was discovered.</p>"""
    resource_owner_id: NotRequired["capo_ec2.types.string.String"]
    """<p>The ID of the resource owner.</p>"""
    cidr: NotRequired["capo_ec2.types.string.String"]
    """<p>The IP address prefix of the discovered route in CIDR notation.</p>"""
    asn: NotRequired["capo_ec2.types.string.String"]
    """<p>The Autonomous System Number (ASN) that originates the route.</p>"""
    state: NotRequired["capo_ec2.types.ipam_byoip_cidr_state.IpamByoipCidrState"]
    """<p>The state of the BYOIP CIDR. Possible values:</p> <ul> <li> <p> <code>advertised</code> - The CIDR is being advertised.</p> </li> <li> <p> <code>deprovisioned</code> - The CIDR has been deprovisioned.</p> </li> <li> <p> <code>failed-deprovision</code> - Deprovisioning failed.</p> </li> <li> <p> <code>failed-provision</code> - Provisioning failed.</p> </li> <li> <p> <code>pending-deprovision</code> - Deprovisioning is in progress.</p> </li> <li> <p> <code>pending-provision</code> - Provisioning is in progress.</p> </li> <li> <p> <code>provisioned</code> - The CIDR is provisioned.</p> </li> <li> <p> <code>provisioned-not-publicly-advertisable</code> - The CIDR is provisioned but not publicly advertisable.</p> </li> </ul>"""
    advertisement_type: NotRequired[
        "capo_ec2.types.ipam_byoip_advertisement_type.IpamByoipAdvertisementType"
    ]
    """<p>The advertisement type of the route. Possible values:</p> <ul> <li> <p> <code>regional</code> - The IP address is advertised from a single location (regional services such as Amazon EC2).</p> </li> <li> <p> <code>global</code> - The IP address is advertised from multiple global locations simultaneously (global services such as Amazon CloudFront).</p> </li> </ul>"""
    network_border_group: NotRequired["capo_ec2.types.string.String"]
    """<p>The network border group for the route.</p>"""
    pool_id: NotRequired["capo_ec2.types.string.String"]
    """<p>The ID of the BYOIP pool associated with the route.</p>"""
    ipam_pool_id: NotRequired["capo_ec2.types.string.String"]
    """<p>The ID of the IPAM pool associated with the route.</p>"""
    sample_time: NotRequired["capo_ec2.types.millisecond_date_time.MillisecondDateTime"]
    """<p>The time when the route was last sampled.</p>"""

advertisement_type instance-attribute

advertisement_type: NotRequired[IpamByoipAdvertisementType]

The advertisement type of the route. Possible values:

  • regional - The IP address is advertised from a single location (regional services such as Amazon EC2).

  • global - The IP address is advertised from multiple global locations simultaneously (global services such as Amazon CloudFront).

asn instance-attribute

asn: NotRequired[String]

The Autonomous System Number (ASN) that originates the route.

cidr instance-attribute

cidr: NotRequired[String]

The IP address prefix of the discovered route in CIDR notation.

ipam_pool_id instance-attribute

ipam_pool_id: NotRequired[String]

The ID of the IPAM pool associated with the route.

ipam_resource_discovery_id instance-attribute

ipam_resource_discovery_id: NotRequired[IpamResourceDiscoveryId]

The ID of the IPAM resource discovery that discovered the route.

network_border_group instance-attribute

network_border_group: NotRequired[String]

The network border group for the route.

pool_id instance-attribute

pool_id: NotRequired[String]

The ID of the BYOIP pool associated with the route.

resource_owner_id instance-attribute

resource_owner_id: NotRequired[String]

The ID of the resource owner.

resource_region instance-attribute

resource_region: NotRequired[String]

The Amazon Web Services Region where the route was discovered.

sample_time instance-attribute

sample_time: NotRequired[MillisecondDateTime]

The time when the route was last sampled.

state instance-attribute

state: NotRequired[IpamByoipCidrState]

The state of the BYOIP CIDR. Possible values:

  • advertised - The CIDR is being advertised.

  • deprovisioned - The CIDR has been deprovisioned.

  • failed-deprovision - Deprovisioning failed.

  • failed-provision - Provisioning failed.

  • pending-deprovision - Deprovisioning is in progress.

  • pending-provision - Provisioning is in progress.

  • provisioned - The CIDR is provisioned.

  • provisioned-not-publicly-advertisable - The CIDR is provisioned but not publicly advertisable.