/AWS1/CL_EC2=>ALLOCATEIPAMPOOLCIDR()¶
About AllocateIpamPoolCidr¶
Allocate a CIDR from an IPAM pool. The Region you use should be the IPAM pool locale. The locale is the Amazon Web Services Region where this IPAM pool is available for allocations.
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.
Method Signature¶
IMPORTING¶
Required arguments:¶
IV_IPAMPOOLID TYPE /AWS1/EC2IPAMPOOLID /AWS1/EC2IPAMPOOLID¶
The ID of the IPAM pool from which you would like to allocate a CIDR.
Optional arguments:¶
IV_DRYRUN TYPE /AWS1/EC2BOOLEAN /AWS1/EC2BOOLEAN¶
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 isUnauthorizedOperation.
IV_CIDR TYPE /AWS1/EC2STRING /AWS1/EC2STRING¶
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.
IV_NETMASKLENGTH TYPE /AWS1/EC2INTEGER /AWS1/EC2INTEGER¶
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.
IV_CLIENTTOKEN TYPE /AWS1/EC2STRING /AWS1/EC2STRING¶
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.
IV_DESCRIPTION TYPE /AWS1/EC2STRING /AWS1/EC2STRING¶
A description for the allocation.
IV_PREVIEWNEXTCIDR TYPE /AWS1/EC2BOOLEAN /AWS1/EC2BOOLEAN¶
A preview of the next available CIDR in a pool.
IT_ALLOWEDCIDRS TYPE /AWS1/CL_EC2IPAMPOOLALLOCALW00=>TT_IPAMPOOLALLOCALLOWEDCIDRS TT_IPAMPOOLALLOCALLOWEDCIDRS¶
Include a particular CIDR range that can be returned by the pool. Allowed CIDRs are only allowed if using netmask length for allocation.
IT_DISALLOWEDCIDRS TYPE /AWS1/CL_EC2IPAMPOOLALLOCDIS00=>TT_IPAMPOOLALLOCDISALWEDCIDRS TT_IPAMPOOLALLOCDISALWEDCIDRS¶
Exclude a particular CIDR range from being returned by the pool. Disallowed CIDRs are only allowed if using netmask length for allocation.