Skip to content

EC2  >  Structures  >  IpamDiscoveredRoute

IpamDiscoveredRoute

Structure Class

IpamDiscoveredRoute dataclass

Bases: _SerdeShape

Contains information about a BGP route discovered by IPAM resource discovery.

Attributes

advertisement_type class-attribute instance-attribute
advertisement_type: str | None = ...

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 class-attribute instance-attribute
asn: str | None = ...

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

cidr class-attribute instance-attribute
cidr: str | None = ...

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

ipam_pool_id class-attribute instance-attribute
ipam_pool_id: str | None = ...

The ID of the IPAM pool associated with the route.

ipam_resource_discovery_id class-attribute instance-attribute
ipam_resource_discovery_id: str | None = ...

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

network_border_group class-attribute instance-attribute
network_border_group: str | None = ...

The network border group for the route.

pool_id class-attribute instance-attribute
pool_id: str | None = ...

The ID of the BYOIP pool associated with the route.

resource_owner_id class-attribute instance-attribute
resource_owner_id: str | None = ...

The ID of the resource owner.

resource_region class-attribute instance-attribute
resource_region: str | None = ...

The Amazon Web Services Region where the route was discovered.

sample_time class-attribute instance-attribute
sample_time: datetime | None = ...

The time when the route was last sampled.

state class-attribute instance-attribute
state: str | None = ...

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.