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.
Provision a CIDR to an IPAM pool. You can use this action to provision new CIDRs to a top-level pool or to transfer a CIDR from a top-level pool to a pool within it.
For more information, see Provision CIDRs to pools in the Amazon VPC IPAM User Guide .
See also: AWS API Documentation
provision-ipam-pool-cidr
[--dry-run | --no-dry-run]
--ipam-pool-id <value>
[--cidr <value>]
[--cidr-authorization-context <value>]
[--netmask-length <value>]
[--client-token <value>]
[--verification-method <value>]
[--ipam-external-resource-verification-token-id <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>]
--dry-run
| --no-dry-run
(boolean)
A check for 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 isDryRunOperation
. Otherwise, it isUnauthorizedOperation
.
--ipam-pool-id
(string)
The ID of the IPAM pool to which you want to assign a CIDR.
--cidr
(string)
The CIDR you want to assign to the IPAM pool. Either "NetmaskLength" or "Cidr" is required. This value will be null if you specify "NetmaskLength" and will be filled in during the provisioning process.
--cidr-authorization-context
(structure)
A signed document that proves that you are authorized to bring a specified IP address range to Amazon using BYOIP. This option only applies to IPv4 and IPv6 pools in the public scope.
Message -> (string)
The plain-text authorization message for the prefix and account.Signature -> (string)
The signed authorization message for the prefix and account.
Shorthand Syntax:
Message=string,Signature=string
JSON Syntax:
{
"Message": "string",
"Signature": "string"
}
--netmask-length
(integer)
The netmask length of the CIDR you'd like to provision to a pool. Can be used for provisioning Amazon-provided IPv6 CIDRs to top-level pools and for provisioning CIDRs to pools with source pools. Cannot be used to provision BYOIP CIDRs to top-level pools. Either "NetmaskLength" or "Cidr" is required.
--client-token
(string)
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring idempotency .
--verification-method
(string)
The method for verifying control of a public IP address range. Defaults to
remarks-x509
if not specified. This option only applies to IPv4 and IPv6 pools in the public scope.Possible values:
remarks-x509
dns-token
--ipam-external-resource-verification-token-id
(string)
Verification token ID. This option only applies to IPv4 and IPv6 pools in the public scope.
--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 provision a CIDR to an IPAM pool
The following provision-ipam-pool-cidr
example provisions a CIDR to an IPAM pool.
(Linux):
aws ec2 provision-ipam-pool-cidr \
--ipam-pool-id ipam-pool-0533048da7d823723 \
--cidr 10.0.0.0/24
(Windows):
aws ec2 provision-ipam-pool-cidr ^
--ipam-pool-id ipam-pool-0533048da7d823723 ^
--cidr 10.0.0.0/24
Output:
{
"IpamPoolCidr": {
"Cidr": "10.0.0.0/24",
"State": "pending-provision"
}
}
For more information, see Provision CIDRs to a pool in the Amazon VPC IPAM User Guide.
IpamPoolCidr -> (structure)
Information about the provisioned CIDR.
Cidr -> (string)
The CIDR provisioned to the IPAM pool. A CIDR is a representation of an IP address and its associated network mask (or netmask) and refers to a range of IP addresses. An IPv4 CIDR example is10.24.34.0/23
. An IPv6 CIDR example is2001:DB8::/32
.State -> (string)
The state of the CIDR.FailureReason -> (structure)
Details related to why an IPAM pool CIDR failed to be provisioned.
Code -> (string)
An error code related to why an IPAM pool CIDR failed to be provisioned.Message -> (string)
A message related to why an IPAM pool CIDR failed to be provisioned.IpamPoolCidrId -> (string)
The IPAM pool CIDR ID.NetmaskLength -> (integer)
The netmask length of the CIDR you'd like to provision to a pool. Can be used for provisioning Amazon-provided IPv6 CIDRs to top-level pools and for provisioning CIDRs to pools with source pools. Cannot be used to provision BYOIP CIDRs to top-level pools. "NetmaskLength" or "Cidr" is required.