AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.
[ aws . globalaccelerator ]
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 .
See also: AWS API Documentation
deprovision-byoip-cidr
--cidr <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
--cidr
(string)
The address range, in CIDR notation. The prefix must be the same prefix that you specified when you provisioned the address range.
For more information, see Bring your own IP addresses (BYOIP) in the Global Accelerator Developer Guide.
--cli-input-json
(string)
Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton
. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.
--generate-cli-skeleton
(string)
Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input
, prints a sample input JSON that can be used as an argument for --cli-input-json
. If provided with the value output
, it validates the command inputs and returns a sample output JSON for that command.
--debug
(boolean)
Turn on debug logging.
--endpoint-url
(string)
Override command's default URL with the given URL.
--no-verify-ssl
(boolean)
By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.
--no-paginate
(boolean)
Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.
--output
(string)
The formatting style for command output.
--query
(string)
A JMESPath query to use in filtering the response data.
--profile
(string)
Use a specific profile from your credential file.
--region
(string)
The region to use. Overrides config/env settings.
--version
(string)
Display the version of this tool.
--color
(string)
Turn on/off color output.
--no-sign-request
(boolean)
Do not sign requests. Credentials will not be loaded if this argument is provided.
--ca-bundle
(string)
The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.
--cli-read-timeout
(int)
The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.
--cli-connect-timeout
(int)
The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.
To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.
Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal's quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .
To deprovision an address range
The following deprovision-byoip-cidr
example releases the specified address range that you provisioned to use with your AWS resources.
aws globalaccelerator deprovision-byoip-cidr \
--cidr "198.51.100.0/24"
Output:
{
"ByoipCidr": {
"Cidr": "198.51.100.0/24",
"State": "PENDING_DEPROVISIONING"
}
}
For more information, see Bring your own IP address in AWS Global Accelerator in the AWS Global Accelerator Developer Guide.
ByoipCidr -> (structure)
Information about the address range.
Cidr -> (string)
The address range, in CIDR notation.
For more information, see Bring your own IP addresses (BYOIP) in the Global Accelerator Developer Guide.
State -> (string)
The state of the address pool.Events -> (list)
A history of status changes for an IP address range that you bring to Global Accelerator through bring your own IP address (BYOIP).
(structure)
A complex type that contains a
Message
and aTimestamp
value for changes that you make in the status of an IP address range that you bring to Global Accelerator through bring your own IP address (BYOIP).Message -> (string)
A string that contains anEvent
message describing changes that you make in the status of an IP address range that you bring to Global Accelerator through bring your own IP address (BYOIP).Timestamp -> (timestamp)
A timestamp for when you make a status change for an IP address range that you bring to Global Accelerator through bring your own IP address (BYOIP).