GET /#Action=AllocateIpamPoolCidr

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

This action creates an allocation with strong consistency. The returned CIDR will not overlap with any other allocations from the same pool.

Servers

https://ec2.{region}.amazonaws.com
https://ec2.amazonaws.com
https://ec2.{region}.amazonaws.com.cn

Request headers

Name	Type	Required
`X-Amz-Content-Sha256`	String	No
`X-Amz-Credential`	String	No
`X-Amz-Date`	String	No
`X-Amz-Algorithm`	String	No
`X-Amz-SignedHeaders`	String	No
`X-Amz-Security-Token`	String	No
`X-Amz-Signature`	String	No

Query parameters

Name	Type	Required	Description
`IpamPoolId`	String	Yes	The ID of the IPAM pool from which you would like to allocate a CIDR.
`Version`	String	Yes	Possible values: `"2016-11-15"`
`ClientToken`	String	No	A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.
`Cidr`	String	No	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.
`DisallowedCidr[]`	Array	No	Exclude a particular CIDR range from being returned by the pool. Disallowed CIDRs are only allowed if using netmask length for allocation.
`PreviewNextCidr`	Boolean	No	A preview of the next available CIDR in a pool.
`DryRun`	Boolean	No	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`.
`Description`	String	No	A description for the allocation.
`NetmaskLength`	Integer	No	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.
`Action`	String	Yes	Possible values: `"AllocateIpamPoolCidr"`

How to start integrating

Add HTTP Task to your workflow definition.
Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
Click Test request to test run your request to the API and see the API's response.