AllocateIpamPoolCidr - Amazon Elastic Compute Cloud

AllocateIpamPoolCidr

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.

Request Parameters

The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see Common Query Parameters.

Cidr

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.

Type: String

Required: No

ClientToken

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

Type: String

Required: No

Description

A description for the allocation.

Type: String

Required: No

DisallowedCidr.N

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

Type: Array of strings

Required: No

DryRun

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.

Type: Boolean

Required: No

IpamPoolId

The ID of the IPAM pool from which you would like to allocate a CIDR.

Type: String

Required: Yes

NetmaskLength

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.

Type: Integer

Required: No

PreviewNextCidr

A preview of the next available CIDR in a pool.

Type: Boolean

Required: No

Response Elements

The following elements are returned by the service.

ipamPoolAllocation

Information about the allocation created.

Type: IpamPoolAllocation object

requestId

The ID of the request.

Type: String

Errors

For information about the errors that are common to all actions, see Common client error codes.

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: