Delete Ipam Pool

ec2_delete_ipam_pool

R Documentation

Delete an IPAM pool

Description

Delete an IPAM pool.

You cannot delete an IPAM pool if there are allocations in it or CIDRs provisioned to it. To release allocations, see release_ipam_pool_allocation. To deprovision pool CIDRs, see deprovision_ipam_pool_cidr.

For more information, see Delete a pool in the Amazon VPC IPAM User Guide.

Usage

ec2_delete_ipam_pool(DryRun, IpamPoolId, Cascade)

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 to delete.

Cascade

Enables you to quickly delete an IPAM pool and all resources within that pool, including provisioned CIDRs, allocations, and other pools.

You can only use this option to delete pools in the private scope or pools in the public scope with a source resource. A source resource is a resource used to provision CIDRs to a resource planning pool.

Value

A list with the following syntax:

list(
  IpamPool = list(
    OwnerId = "string",
    IpamPoolId = "string",
    SourceIpamPoolId = "string",
    IpamPoolArn = "string",
    IpamScopeArn = "string",
    IpamScopeType = "public"|"private",
    IpamArn = "string",
    IpamRegion = "string",
    Locale = "string",
    PoolDepth = 123,
    State = "create-in-progress"|"create-complete"|"create-failed"|"modify-in-progress"|"modify-complete"|"modify-failed"|"delete-in-progress"|"delete-complete"|"delete-failed"|"isolate-in-progress"|"isolate-complete"|"restore-in-progress",
    StateMessage = "string",
    Description = "string",
    AutoImport = TRUE|FALSE,
    PubliclyAdvertisable = TRUE|FALSE,
    AddressFamily = "ipv4"|"ipv6",
    AllocationMinNetmaskLength = 123,
    AllocationMaxNetmaskLength = 123,
    AllocationDefaultNetmaskLength = 123,
    AllocationResourceTags = list(
      list(
        Key = "string",
        Value = "string"
      )
    ),
    Tags = list(
      list(
        Key = "string",
        Value = "string"
      )
    ),
    AwsService = "ec2",
    PublicIpSource = "amazon"|"byoip",
    SourceResource = list(
      ResourceId = "string",
      ResourceType = "vpc",
      ResourceRegion = "string",
      ResourceOwner = "string"
    )
  )
)

Request syntax

svc$delete_ipam_pool(
  DryRun = TRUE|FALSE,
  IpamPoolId = "string",
  Cascade = TRUE|FALSE
)