Provisions an IP address range to use with your AWS 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 AWS Global Accelerator Developer Guide.
Request Syntax
{
"Cidr": "string",
"CidrAuthorizationContext": {
"Message": "string",
"Signature": "string"
}
}Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- Cidr
-
The public IPv4 address range, in CIDR notation. The most specific IP prefix that you can specify is /24. The address range cannot overlap with another address range that you've brought to this AWS Region or another Region.
For more information, see Bring your own IP addresses (BYOIP) in the AWS Global Accelerator Developer Guide.
Type: String
Length Constraints: Maximum length of 255.
Required: Yes
- CidrAuthorizationContext
-
A signed document that proves that you are authorized to bring the specified IP address range to Amazon using BYOIP.
Type: CidrAuthorizationContext object
Required: Yes
Response Syntax
{
"ByoipCidr": {
"Cidr": "string",
"Events": [
{
"Message": "string",
"Timestamp": number
}
],
"State": "string"
}
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
You don't have access permission.
HTTP Status Code: 400
- IncorrectCidrStateException
-
The CIDR that you specified is not valid for this action. For example, the state of the CIDR might be incorrect for this action.
HTTP Status Code: 400
- InternalServiceErrorException
-
There was an internal error for AWS Global Accelerator.
HTTP Status Code: 400
- InvalidArgumentException
-
An argument that you specified is invalid.
HTTP Status Code: 400
- LimitExceededException
-
Processing your request would cause you to exceed an AWS Global Accelerator limit.
HTTP Status Code: 400
Examples
Provisioning an address range for BYOIP
The following is an example of provisioning an address range for BYOIP and the response.
For more information about creating the values for text_message and signature,
see Bring your own
IP addresses (BYOIP) in the
AWS Global Accelerator Developer Guide.
aws globalaccelerator provision-byoip-cidr --cidr 203.0.113.25/24 --cidr-authorization-context Message="$text_message",Signature="$signed_message"
{
"ByoipCidr": {
"Cidr": "203.0.113.25/24",
"State": "PENDING_PROVISIONING"
}
}See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
