Skip to content

Delete Ipam

ec2_delete_ipam R Documentation

Delete an IPAM

Description

Delete an IPAM. Deleting an IPAM removes all monitored data associated with the IPAM including the historical data for CIDRs.

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

Usage

ec2_delete_ipam(DryRun, IpamId, 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.

IpamId

[required] The ID of the IPAM to delete.

Cascade

Enables you to quickly delete an IPAM, private scopes, pools in private scopes, and any allocations in the pools in private scopes. You cannot delete the IPAM with this option if there is a pool in your public scope. If you use this option, IPAM does the following:

  • Deallocates any CIDRs allocated to VPC resources (such as VPCs) in pools in private scopes.

    No VPC resources are deleted as a result of enabling this option. The CIDR associated with the resource will no longer be allocated from an IPAM pool, but the CIDR itself will remain unchanged.

  • Deprovisions all IPv4 CIDRs provisioned to IPAM pools in private scopes.

  • Deletes all IPAM pools in private scopes.

  • Deletes all non-default private scopes in the IPAM.

  • Deletes the default public and private scopes and the IPAM.

Value

A list with the following syntax: 

list(
  Ipam = list(
    OwnerId = "string",
    IpamId = "string",
    IpamArn = "string",
    IpamRegion = "string",
    PublicDefaultScopeId = "string",
    PrivateDefaultScopeId = "string",
    ScopeCount = 123,
    Description = "string",
    OperatingRegions = list(
      list(
        RegionName = "string"
      )
    ),
    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",
    Tags = list(
      list(
        Key = "string",
        Value = "string"
      )
    ),
    DefaultResourceDiscoveryId = "string",
    DefaultResourceDiscoveryAssociationId = "string",
    ResourceDiscoveryAssociationCount = 123,
    StateMessage = "string",
    Tier = "free"|"advanced",
    EnablePrivateGua = TRUE|FALSE
  )
)

Request syntax

svc$delete_ipam(
  DryRun = TRUE|FALSE,
  IpamId = "string",
  Cascade = TRUE|FALSE
)