Provision a CIDR to a public IPv4 pool.
For more information about IPAM, see What is IPAM? 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.
- 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 isUnauthorizedOperation.Type: Boolean
Required: No
- IpamPoolId
-
The ID of the IPAM pool you would like to use to allocate this CIDR.
Type: String
Required: Yes
- NetmaskLength
-
The netmask length of the CIDR you would like to allocate to the public IPv4 pool. The least specific netmask length you can define is 24.
Type: Integer
Required: Yes
- NetworkBorderGroup
-
The Availability Zone (AZ) or Local Zone (LZ) network border group that the resource that the IP address is assigned to is in. Defaults to an AZ network border group. For more information on available Local Zones, see Local Zone availability in the Amazon EC2 User Guide.
Type: String
Required: No
- PoolId
-
The ID of the public IPv4 pool you would like to use for this CIDR.
Type: String
Required: Yes
Response Elements
The following elements are returned by the service.
- poolAddressRange
-
Information about the address range of the public IPv4 pool.
Type: PublicIpv4PoolRange object
- poolId
-
The ID of the pool that you want to provision the CIDR to.
Type: String
- 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:
