ByoipCidr - Amazon Elastic Compute Cloud
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).


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



The BYOIP CIDR associations with ASNs.

Type: Array of AsnAssociation objects

Required: No


The address range, in CIDR notation.

Type: String

Required: No


The description of the address range.

Type: String

Required: No


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


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

Type: String

Required: No


The state of the address range.

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

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

Type: String

Valid Values: advertised | deprovisioned | failed-deprovision | failed-provision | pending-deprovision | pending-provision | provisioned | provisioned-not-publicly-advertisable

Required: No


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

Type: String

Required: No

See Also

For more information about using this API in one of the language-specific Amazon SDKs, see the following: