byoip_cidrs

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

Overview

Name	byoip_cidrs
Type	Resource
Id	aws.ec2.byoip_cidrs

Fields

The following fields are returned by SELECT queries:

describe_byoip_cidrs

Name	Datatype	Description
advertisement_type	string	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	string	The BYOIP CIDR associations with ASNs.
cidr	string	The address range, in CIDR notation.
description	string	The description of the address range.
ipam_pool_id	string	The ID of the IPAM pool associated with the CIDR.
network_border_group	string	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 You cannot provision or advertise BYOIPv6 address ranges in Local Zones at this time.
pool_id	string	The ID of the address pool associated with the CIDR.
state	string	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	string	Upon success, contains the ID of the address pool. Otherwise, contains an error message.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_byoip_cidrs	select	MaxResults, region	DryRun, NextToken	Describes the IP address ranges that were provisioned for use with Amazon Web Services resources through through bring your own IP addresses (BYOIP).
advertise_byoip_cidr	update	region	Cidr, Asn, DryRun, NetworkBorderGroup	Advertises an IPv4 or IPv6 address range that is provisioned for use with your Amazon Web Services resources through bring your own IP addresses (BYOIP). You can perform this operation at most once every 10 seconds, even if you specify different address ranges each time. We recommend that you stop advertising the BYOIP CIDR from other locations when you advertise it from Amazon Web Services. To minimize down time, you can configure your Amazon Web Services resources to use an address from a BYOIP CIDR before it is advertised, and then simultaneously stop advertising it from the current location and start advertising it through Amazon Web Services. It can take a few minutes before traffic to the specified addresses starts routing to Amazon Web Services because of BGP propagation delays.
deprovision_byoip_cidr	exec	region	Cidr, DryRun	Releases the specified address range that you provisioned for 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 and you must not have any IP addresses allocated from its address range.
move_byoip_cidr_to_ipam	exec	IpamPoolId, IpamPoolOwner, region	DryRun, Cidr	Move a BYOIPv4 CIDR to IPAM from a public IPv4 pool. If you already have a BYOIPv4 CIDR with Amazon Web Services, you can move the CIDR to IPAM from a public IPv4 pool. You cannot move an IPv6 CIDR to IPAM. If you are bringing a new IP address to Amazon Web Services for the first time, complete the steps in Tutorial: BYOIP address CIDRs to IPAM.
provision_byoip_cidr	exec	region	Cidr, CidrAuthorizationContext, PubliclyAdvertisable, Description, DryRun, PoolTagSpecification, MultiRegion, NetworkBorderGroup	Provisions an IPv4 or IPv6 address range for 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. Amazon Web Services verifies that you own the address range and are authorized to advertise it. You must ensure that the address range is registered to you and that you created an RPKI ROA to authorize Amazon ASNs 16509 and 14618 to advertise the address range. For the Amazon Web Services GovCloud (US) Regions, authorize only ASN 8987. For the Amazon Web Services European Sovereign Cloud, authorize ASNs 16509 and 214101. For more information, see Bring your own IP addresses (BYOIP) in the Amazon EC2 User Guide. Provisioning an address range is an asynchronous operation, so the call returns immediately, but the address range is not ready to use until its status changes from pending-provision to provisioned. For more information, see Onboard your address range.
withdraw_byoip_cidr	exec	region	Cidr, DryRun	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 BGP propagation delays.

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
IpamPoolId	string	The IPAM pool ID.
IpamPoolOwner	string	The Amazon Web Services account ID of the owner of the IPAM pool.
MaxResults	integer	The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
region	string	AWS region (default: us-east-1)
Asn	string	The public 2-byte or 4-byte ASN that you want to advertise.
Cidr	string	The address range, in CIDR notation.
CidrAuthorizationContext	object	A signed document that proves that you are authorized to bring the specified IP address range to Amazon using BYOIP.
Description	string	A description for the address range and the address pool.
DryRun	boolean	Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
MultiRegion	boolean	Reserved.
NetworkBorderGroup	string	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 You cannot provision or advertise BYOIPv6 address ranges in Local Zones at this time.
NextToken	string	The token for the next page of results.
PoolTagSpecification	array	The tags to apply to the address pool.
PubliclyAdvertisable	boolean	(IPv6 only) Indicate whether the address range will be publicly advertised to the internet. Default: true

SELECT examples

describe_byoip_cidrs

Describes the IP address ranges that were provisioned for use with Amazon Web Services resources through through bring your own IP addresses (BYOIP).

SELECT
advertisement_type,
asn_associations,
cidr,
description,
ipam_pool_id,
network_border_group,
pool_id,
state,
status_message
FROM aws.ec2.byoip_cidrs
WHERE MaxResults = '{{ MaxResults }}' -- required
AND region = '{{ region }}' -- required
AND DryRun = '{{ DryRun }}'
AND NextToken = '{{ NextToken }}'
;

UPDATE examples

advertise_byoip_cidr

Advertises an IPv4 or IPv6 address range that is provisioned for use with your Amazon Web Services resources through bring your own IP addresses (BYOIP). You can perform this operation at most once every 10 seconds, even if you specify different address ranges each time. We recommend that you stop advertising the BYOIP CIDR from other locations when you advertise it from Amazon Web Services. To minimize down time, you can configure your Amazon Web Services resources to use an address from a BYOIP CIDR before it is advertised, and then simultaneously stop advertising it from the current location and start advertising it through Amazon Web Services. It can take a few minutes before traffic to the specified addresses starts routing to Amazon Web Services because of BGP propagation delays.

UPDATE aws.ec2.byoip_cidrs
SET 
-- No updatable properties
WHERE 
region = '{{ region }}' --required
AND Cidr = '{{ Cidr}}'
AND Asn = '{{ Asn}}'
AND DryRun = {{ DryRun}}
AND NetworkBorderGroup = '{{ NetworkBorderGroup}}'
RETURNING
advertisement_type,
asn_associations,
cidr,
description,
ipam_pool_id,
network_border_group,
pool_id,
state,
status_message;

Lifecycle Methods

deprovision_byoip_cidr

Releases the specified address range that you provisioned for 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 and you must not have any IP addresses allocated from its address range.

EXEC aws.ec2.byoip_cidrs.deprovision_byoip_cidr 
@region='{{ region }}' --required, 
@Cidr='{{ Cidr }}', 
@DryRun={{ DryRun }}
;

move_byoip_cidr_to_ipam

Move a BYOIPv4 CIDR to IPAM from a public IPv4 pool. If you already have a BYOIPv4 CIDR with Amazon Web Services, you can move the CIDR to IPAM from a public IPv4 pool. You cannot move an IPv6 CIDR to IPAM. If you are bringing a new IP address to Amazon Web Services for the first time, complete the steps in Tutorial: BYOIP address CIDRs to IPAM.

EXEC aws.ec2.byoip_cidrs.move_byoip_cidr_to_ipam 
@IpamPoolId='{{ IpamPoolId }}' --required, 
@IpamPoolOwner='{{ IpamPoolOwner }}' --required, 
@region='{{ region }}' --required, 
@DryRun={{ DryRun }}, 
@Cidr='{{ Cidr }}'
;

provision_byoip_cidr

Provisions an IPv4 or IPv6 address range for 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. Amazon Web Services verifies that you own the address range and are authorized to advertise it. You must ensure that the address range is registered to you and that you created an RPKI ROA to authorize Amazon ASNs 16509 and 14618 to advertise the address range. For the Amazon Web Services GovCloud (US) Regions, authorize only ASN 8987. For the Amazon Web Services European Sovereign Cloud, authorize ASNs 16509 and 214101. For more information, see Bring your own IP addresses (BYOIP) in the Amazon EC2 User Guide. Provisioning an address range is an asynchronous operation, so the call returns immediately, but the address range is not ready to use until its status changes from pending-provision to provisioned. For more information, see Onboard your address range.

EXEC aws.ec2.byoip_cidrs.provision_byoip_cidr 
@region='{{ region }}' --required, 
@Cidr='{{ Cidr }}', 
@CidrAuthorizationContext='{{ CidrAuthorizationContext }}', 
@PubliclyAdvertisable={{ PubliclyAdvertisable }}, 
@Description='{{ Description }}', 
@DryRun={{ DryRun }}, 
@PoolTagSpecification='{{ PoolTagSpecification }}', 
@MultiRegion={{ MultiRegion }}, 
@NetworkBorderGroup='{{ NetworkBorderGroup }}'
;

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 BGP propagation delays.

EXEC aws.ec2.byoip_cidrs.withdraw_byoip_cidr 
@region='{{ region }}' --required, 
@Cidr='{{ Cidr }}', 
@DryRun={{ DryRun }}
;