Class ProvisionIpamPoolCidrCommandProtected

Provision a CIDR to an IPAM pool. You can use this action to provision new CIDRs to a top-level pool or to transfer a CIDR from a top-level pool to a pool within it.

For more information, see Provision CIDRs to pools in the Amazon VPC IPAM User Guide.

Example

Use a bare-bones client and the command you need to make an API call.

import { EC2Client, ProvisionIpamPoolCidrCommand } from "@aws-sdk/client-ec2"; // ES Modules import
// const { EC2Client, ProvisionIpamPoolCidrCommand } = require("@aws-sdk/client-ec2"); // CommonJS import
const client = new EC2Client(config);
const input = { // ProvisionIpamPoolCidrRequest
  DryRun: true || false,
  IpamPoolId: "STRING_VALUE", // required
  Cidr: "STRING_VALUE",
  CidrAuthorizationContext: { // IpamCidrAuthorizationContext
    Message: "STRING_VALUE",
    Signature: "STRING_VALUE",
  },
  NetmaskLength: Number("int"),
  ClientToken: "STRING_VALUE",
};
const command = new ProvisionIpamPoolCidrCommand(input);
const response = await client.send(command);
// { // ProvisionIpamPoolCidrResult
//   IpamPoolCidr: { // IpamPoolCidr
//     Cidr: "STRING_VALUE",
//     State: "pending-provision" || "provisioned" || "failed-provision" || "pending-deprovision" || "deprovisioned" || "failed-deprovision" || "pending-import" || "failed-import",
//     FailureReason: { // IpamPoolCidrFailureReason
//       Code: "cidr-not-available" || "limit-exceeded",
//       Message: "STRING_VALUE",
//     },
//     IpamPoolCidrId: "STRING_VALUE",
//     NetmaskLength: Number("int"),
//   },
// };

Param

ProvisionIpamPoolCidrCommandInput

Returns

ProvisionIpamPoolCidrCommandOutput

See

• ProvisionIpamPoolCidrCommandInput for command's input shape.
• ProvisionIpamPoolCidrCommandOutput for command's response shape.
• config for EC2Client's config shape.

Throws

EC2ServiceException

Base exception class for all service exceptions from EC2 service.