provision-ipam-pool-cidr¶

Description¶

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 .

Synopsis¶

  provision-ipam-pool-cidr
[--dry-run | --no-dry-run]
--ipam-pool-id <value>
[--cidr <value>]
[--cidr-authorization-context <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options¶

--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 is DryRunOperation . Otherwise, it is UnauthorizedOperation .

--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.

--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 applies to public pools only.

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"
}

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those 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. This may not be specified along with --cli-input-yaml.

--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. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

See ‘aws help’ for descriptions of global parameters.

Examples¶

Note

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.

Output¶

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 is 10.24.34.0/23 . An IPv6 CIDR example is 2001: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.

Table of Contents

Feedback

User Guide