Skip to content

EC2  >  Structures  >  ByoipCidr

ByoipCidr

Structure Class

ByoipCidr dataclass

Bases: _SerdeShape

Information about an address range that is provisioned for use with your Amazon Web Services resources through bring your own IP addresses (BYOIP).

Attributes

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

Specifies the advertisement method for the BYOIP CIDR. Valid values are:

  • unicast: IP is advertised from a single location (regional services like EC2)

  • anycast: IP is advertised from multiple global locations simultaneously (global services like CloudFront)

For more information, see Bring your own IP to CloudFront using IPAM in the Amazon VPC IPAM User Guide.

asn_associations class-attribute instance-attribute
asn_associations: list[AsnAssociation] | None = ...

The BYOIP CIDR associations with ASNs.

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

The address range, in CIDR notation.

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

The description of the address range.

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

The ID of the IPAM pool associated with the CIDR.

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

If you have Local Zones enabled, you can choose a network border group for Local Zones when you provision and advertise a BYOIPv4 CIDR. Choose the network border group carefully as the EIP and the Amazon Web Services resource it is associated with must reside in the same network border group.

You can provision BYOIP address ranges to and advertise them in the following Local Zone network border groups:

  • us-east-1-dfw-2

  • us-west-2-lax-1

  • us-west-2-phx-2

Note

You cannot provision or advertise BYOIPv6 address ranges in Local Zones at this time.

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

The ID of the address pool associated with the CIDR.

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

The state of the address range.

  • advertised: The address range is being advertised to the internet by Amazon Web Services.

  • deprovisioned: The address range is deprovisioned.

  • failed-deprovision: The request to deprovision the address range was unsuccessful. Ensure that all EIPs from the range have been deallocated and try again.

  • failed-provision: The request to provision the address range was unsuccessful.

  • pending-deprovision: You've submitted a request to deprovision an address range and it's pending.

  • pending-provision: You've submitted a request to provision an address range and it's pending.

  • provisioned: The address range is provisioned and can be advertised. The range is not currently advertised.

  • provisioned-not-publicly-advertisable: The address range is provisioned and cannot be advertised.

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

Upon success, contains the ID of the address pool. Otherwise, contains an error message.