byoip_cidrs

Creates, updates, deletes, gets or lists a byoip_cidrs resource.

Overview

Name	byoip_cidrs
Type	Resource
Id	aws.globalaccelerator.byoip_cidrs

Fields

The following fields are returned by SELECT queries:

list_byoip_cidrs

Name	Datatype	Description
cidr	string	The address range, in CIDR notation. For more information, see Bring your own IP addresses (BYOIP) in the Global Accelerator Developer Guide.
events	array	A history of status changes for an IP address range that you bring to Global Accelerator through bring your own IP address (BYOIP).
state	string	The state of the address pool. (PENDING_PROVISIONING, READY, PENDING_ADVERTISING, ADVERTISING, PENDING_WITHDRAWING, PENDING_DEPROVISIONING, DEPROVISIONED, FAILED_PROVISION, FAILED_ADVERTISING, FAILED_WITHDRAW, FAILED_DEPROVISION)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_byoip_cidrs	select	region		Lists the IP address ranges that were specified in calls to ProvisionByoipCidr, including the current state and a history of state changes.
provision_byoip_cidr	update	region, CidrAuthorizationContext		Provisions an IP address range to use with your Amazon Web Services resources through bring your own IP addresses (BYOIP) and creates a corresponding address pool. After the address range is provisioned, it is ready to be advertised using AdvertiseByoipCidr. For more information, see Bring your own IP addresses (BYOIP) in the Global Accelerator Developer Guide.
advertise_byoip_cidr	update	region		Advertises an IPv4 address range that is provisioned for use with your Amazon Web Services resources through bring your own IP addresses (BYOIP). It can take a few minutes before traffic to the specified addresses starts routing to Amazon Web Services because of propagation delays. To stop advertising the BYOIP address range, use WithdrawByoipCidr. For more information, see Bring your own IP addresses (BYOIP) in the Global Accelerator Developer Guide.
deprovision_byoip_cidr	exec	region		Releases the specified address range that you provisioned to use with your Amazon Web Services resources through bring your own IP addresses (BYOIP) and deletes the corresponding address pool. Before you can release an address range, you must stop advertising it by using WithdrawByoipCidr and you must not have any accelerators that are using static IP addresses allocated from its address range. For more information, see Bring your own IP addresses (BYOIP) in the Global Accelerator Developer Guide.
withdraw_byoip_cidr	exec	region		Stops advertising an address range that is provisioned as an address pool. You can perform this operation at most once every 10 seconds, even if you specify different address ranges each time. It can take a few minutes before traffic to the specified addresses stops routing to Amazon Web Services because of propagation delays. For more information, see Bring your own IP addresses (BYOIP) in the Global Accelerator Developer Guide.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

list_byoip_cidrs

Lists the IP address ranges that were specified in calls to ProvisionByoipCidr, including the current state and a history of state changes.

SELECT
cidr,
events,
state
FROM aws.globalaccelerator.byoip_cidrs
WHERE region = '{{ region }}' -- required
;

UPDATE examples

provision_byoip_cidr

Provisions an IP address range to use with your Amazon Web Services resources through bring your own IP addresses (BYOIP) and creates a corresponding address pool. After the address range is provisioned, it is ready to be advertised using AdvertiseByoipCidr. For more information, see Bring your own IP addresses (BYOIP) in the Global Accelerator Developer Guide.

UPDATE aws.globalaccelerator.byoip_cidrs
SET 
Cidr = '{{ Cidr }}',
CidrAuthorizationContext = '{{ CidrAuthorizationContext }}'
WHERE 
region = '{{ region }}' --required
AND CidrAuthorizationContext = '{{ CidrAuthorizationContext }}' --required
RETURNING
byoip_cidr;

advertise_byoip_cidr

Advertises an IPv4 address range that is provisioned for use with your Amazon Web Services resources through bring your own IP addresses (BYOIP). It can take a few minutes before traffic to the specified addresses starts routing to Amazon Web Services because of propagation delays. To stop advertising the BYOIP address range, use WithdrawByoipCidr. For more information, see Bring your own IP addresses (BYOIP) in the Global Accelerator Developer Guide.

UPDATE aws.globalaccelerator.byoip_cidrs
SET 
Cidr = '{{ Cidr }}'
WHERE 
region = '{{ region }}' --required
RETURNING
byoip_cidr;

Lifecycle Methods

deprovision_byoip_cidr

Releases the specified address range that you provisioned to use with your Amazon Web Services resources through bring your own IP addresses (BYOIP) and deletes the corresponding address pool. Before you can release an address range, you must stop advertising it by using WithdrawByoipCidr and you must not have any accelerators that are using static IP addresses allocated from its address range. For more information, see Bring your own IP addresses (BYOIP) in the Global Accelerator Developer Guide.

EXEC aws.globalaccelerator.byoip_cidrs.deprovision_byoip_cidr 
@region='{{ region }}' --required 
@@json=
'{
"Cidr": "{{ Cidr }}"
}'
;

withdraw_byoip_cidr

Stops advertising an address range that is provisioned as an address pool. You can perform this operation at most once every 10 seconds, even if you specify different address ranges each time. It can take a few minutes before traffic to the specified addresses stops routing to Amazon Web Services because of propagation delays. For more information, see Bring your own IP addresses (BYOIP) in the Global Accelerator Developer Guide.

EXEC aws.globalaccelerator.byoip_cidrs.withdraw_byoip_cidr 
@region='{{ region }}' --required 
@@json=
'{
"Cidr": "{{ Cidr }}"
}'
;