Deprovision Ipam Pool Cidr

ec2_deprovision_ipam_pool_cidr

R Documentation

Deprovision a CIDR provisioned from an IPAM pool¶

Description¶

Deprovision a CIDR provisioned from an IPAM pool. If you deprovision a CIDR from a pool that has a source pool, the CIDR is recycled back into the source pool. For more information, see Deprovision pool CIDRs in the Amazon VPC IPAM User Guide.

Usage¶

ec2_deprovision_ipam_pool_cidr(DryRun, IpamPoolId, Cidr)

Arguments¶

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.
IpamPoolId: [required] The ID of the pool that has the CIDR you want to deprovision.
Cidr: The CIDR which you want to deprovision from the pool.

Value¶

A list with the following syntax:

list(
  IpamPoolCidr = list(
    Cidr = "string",
    State = "pending-provision"|"provisioned"|"failed-provision"|"pending-deprovision"|"deprovisioned"|"failed-deprovision"|"pending-import"|"failed-import",
    FailureReason = list(
      Code = "cidr-not-available"|"limit-exceeded",
      Message = "string"
    ),
    IpamPoolCidrId = "string",
    NetmaskLength = 123
  )
)

Request syntax¶

svc$deprovision_ipam_pool_cidr(
  DryRun = TRUE|FALSE,
  IpamPoolId = "string",
  Cidr = "string"
)