Class: Aws::EC2::Types::DeleteIpamRequest

Inherits:

Struct

• Object
• Struct
• Aws::EC2::Types::DeleteIpamRequest

Includes:

Structure

Defined in:

lib/aws-sdk-ec2/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #cascade ⇒ Boolean

  Enables you to quickly delete an IPAM, private scopes, pools in private scopes, and any allocations in the pools in private scopes.

• #dry_run ⇒ Boolean

  A check for whether you have the required permissions for the action without actually making the request and provides an error response.

• #ipam_id ⇒ String

  The ID of the IPAM to delete.

Instance Attribute Details

#cascade ⇒ Boolean

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.

  <note markdown=“1”> 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.

  </note>
  

• 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.

Returns:

• (Boolean)

# File 'lib/aws-sdk-ec2/types.rb', line 13996

class DeleteIpamRequest < Struct.new(
  :dry_run,
  :ipam_id,
  :cascade)
  SENSITIVE = []
  include Aws::Structure
end

#dry_run ⇒ Boolean

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`.

Returns:

• (Boolean)

# File 'lib/aws-sdk-ec2/types.rb', line 13996

class DeleteIpamRequest < Struct.new(
  :dry_run,
  :ipam_id,
  :cascade)
  SENSITIVE = []
  include Aws::Structure
end

#ipam_id ⇒ String

The ID of the IPAM to delete.

Returns:

• (String)

# File 'lib/aws-sdk-ec2/types.rb', line 13996

class DeleteIpamRequest < Struct.new(
  :dry_run,
  :ipam_id,
  :cascade)
  SENSITIVE = []
  include Aws::Structure
end