[ aws . ec2 ]

allocate-ipam-pool-cidr

Description

Allocate a CIDR from an IPAM pool. In IPAM, an allocation is a CIDR assignment from an IPAM pool to another resource or IPAM pool. For more information, see Allocate CIDRs in the Amazon VPC IPAM User Guide .

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  allocate-ipam-pool-cidr
[--dry-run | --no-dry-run]
--ipam-pool-id <value>
[--cidr <value>]
[--netmask-length <value>]
[--client-token <value>]
[--description <value>]
[--preview-next-cidr | --no-preview-next-cidr]
[--disallowed-cidrs <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 from which you would like to allocate a CIDR.

--cidr (string)

The CIDR you would like to allocate from the IPAM pool. Note the following:

• If there is no DefaultNetmaskLength allocation rule set on the pool, you must specify either the NetmaskLength or the CIDR.

• If the DefaultNetmaskLength allocation rule is set on the pool, you can specify either the NetmaskLength or the CIDR and the DefaultNetmaskLength allocation rule will be ignored.

Possible values: Any available IPv4 or IPv6 CIDR.

--netmask-length (integer)

The netmask length of the CIDR you would like to allocate from the IPAM pool. Note the following:

• If there is no DefaultNetmaskLength allocation rule set on the pool, you must specify either the NetmaskLength or the CIDR.

• If the DefaultNetmaskLength allocation rule is set on the pool, you can specify either the NetmaskLength or the CIDR and the DefaultNetmaskLength allocation rule will be ignored.

Possible netmask lengths for IPv4 addresses are 0 - 32. Possible netmask lengths for IPv6 addresses are 0 - 128.

--client-token (string)

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency .

--description (string)

A description for the allocation.

--preview-next-cidr | --no-preview-next-cidr (boolean)

A preview of the next available CIDR in a pool.

--disallowed-cidrs (list)

Exclude a particular CIDR range from being returned by the pool.

(string)

Syntax:

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

See ‘aws help’ for descriptions of global parameters.

Examples

To allocate a CIDR from an IPAM pool

The following allocate-ipam-pool-cidr example allocates a CIDR from an IPAM pool.

(Linux):

aws ec2 allocate-ipam-pool-cidr \
    --ipam-pool-id ipam-pool-0533048da7d823723 \
    --netmask-length 24

(Windows):

aws ec2 allocate-ipam-pool-cidr ^
   --ipam-pool-id ipam-pool-0533048da7d823723 ^
   --netmask-length 24

Output:

{
    "IpamPoolAllocation": {
        "Cidr": "10.0.0.0/24",
        "IpamPoolAllocationId": "ipam-pool-alloc-018ecc28043b54ba38e2cd99943cebfbd",
        "ResourceType": "custom",
        "ResourceOwner": "123456789012"
    }
}

For more information, see Manually allocate a CIDR to a pool to reserve IP address space in the Amazon VPC IPAM User Guide.

Output

IpamPoolAllocation -> (structure)

Information about the allocation created.

Cidr -> (string)

The CIDR for the allocation. 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 .

IpamPoolAllocationId -> (string)

The ID of an allocation.

Description -> (string)

A description of the pool allocation.

ResourceId -> (string)

The ID of the resource.

ResourceType -> (string)

The type of the resource.

ResourceRegion -> (string)

The Amazon Web Services Region of the resource.

ResourceOwner -> (string)

The owner of the resource.