amazonka-ec2-2.0: Amazon Elastic Compute Cloud SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.EC2.DeleteIpam

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.

Synopsis

Creating a Request

data DeleteIpam Source #

See: newDeleteIpam smart constructor.

Constructors

DeleteIpam' 

Fields

  • cascade :: Maybe Bool

    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.
  • dryRun :: Maybe Bool

    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 :: Text

    The ID of the IPAM to delete.

Instances

Instances details
ToHeaders DeleteIpam Source # 
Instance details

Defined in Amazonka.EC2.DeleteIpam

Methods

toHeaders :: DeleteIpam -> [Header] #

ToPath DeleteIpam Source # 
Instance details

Defined in Amazonka.EC2.DeleteIpam

Methods

toPath :: DeleteIpam -> ByteString #

ToQuery DeleteIpam Source # 
Instance details

Defined in Amazonka.EC2.DeleteIpam

Methods

toQuery :: DeleteIpam -> QueryString #

AWSRequest DeleteIpam Source # 
Instance details

Defined in Amazonka.EC2.DeleteIpam

Associated Types

type AWSResponse DeleteIpam #

Methods

request :: (Service -> Service) -> DeleteIpam -> Request DeleteIpam #

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DeleteIpam -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DeleteIpam))) #

Generic DeleteIpam Source # 
Instance details

Defined in Amazonka.EC2.DeleteIpam

Associated Types

type Rep DeleteIpam :: Type -> Type #

Methods

from :: DeleteIpam -> Rep DeleteIpam x #

to :: Rep DeleteIpam x -> DeleteIpam #

Read DeleteIpam Source # 
Instance details

Defined in Amazonka.EC2.DeleteIpam

Methods

readsPrec :: Int -> ReadS DeleteIpam #

readList :: ReadS [DeleteIpam] #

readPrec :: ReadPrec DeleteIpam #

readListPrec :: ReadPrec [DeleteIpam] #

Show DeleteIpam Source # 
Instance details

Defined in Amazonka.EC2.DeleteIpam

Methods

showsPrec :: Int -> DeleteIpam -> ShowS #

show :: DeleteIpam -> String #

showList :: [DeleteIpam] -> ShowS #

NFData DeleteIpam Source # 
Instance details

Defined in Amazonka.EC2.DeleteIpam

Methods

rnf :: DeleteIpam -> () #

Eq DeleteIpam Source # 
Instance details

Defined in Amazonka.EC2.DeleteIpam

Methods

(==) :: DeleteIpam -> DeleteIpam -> Bool #

(/=) :: DeleteIpam -> DeleteIpam -> Bool #

Hashable DeleteIpam Source # 
Instance details

Defined in Amazonka.EC2.DeleteIpam

Methods

hashWithSalt :: Int -> DeleteIpam -> Int #

hash :: DeleteIpam -> Int #

type AWSResponse DeleteIpam Source # 
Instance details

Defined in Amazonka.EC2.DeleteIpam

type AWSResponse DeleteIpam = DeleteIpamResponse
type Rep DeleteIpam Source # 
Instance details

Defined in Amazonka.EC2.DeleteIpam

type Rep DeleteIpam = D1 ('MetaData "DeleteIpam" "Amazonka.EC2.DeleteIpam" "amazonka-ec2-2.0-48L9RAJvmvzAdBkRegqWCL" 'False) (C1 ('MetaCons "DeleteIpam'" 'PrefixI 'True) (S1 ('MetaSel ('Just "cascade") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: (S1 ('MetaSel ('Just "dryRun") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "ipamId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newDeleteIpam Source #

Arguments

:: Text

DeleteIpam

-> DeleteIpam 

Create a value of DeleteIpam with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:cascade:DeleteIpam', deleteIpam_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.

$sel:dryRun:DeleteIpam', deleteIpam_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.

DeleteIpam, deleteIpam_ipamId - The ID of the IPAM to delete.

Request Lenses

deleteIpam_cascade :: Lens' DeleteIpam (Maybe Bool) Source #

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.

deleteIpam_dryRun :: Lens' DeleteIpam (Maybe Bool) Source #

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.

deleteIpam_ipamId :: Lens' DeleteIpam Text Source #

The ID of the IPAM to delete.

Destructuring the Response

data DeleteIpamResponse Source #

See: newDeleteIpamResponse smart constructor.

Constructors

DeleteIpamResponse' 

Fields

Instances

Instances details
Generic DeleteIpamResponse Source # 
Instance details

Defined in Amazonka.EC2.DeleteIpam

Associated Types

type Rep DeleteIpamResponse :: Type -> Type #

Methods

from :: DeleteIpamResponse -> Rep DeleteIpamResponse x #

to :: Rep DeleteIpamResponse x -> DeleteIpamResponse #

Read DeleteIpamResponse Source # 
Instance details

Defined in Amazonka.EC2.DeleteIpam

Methods

readsPrec :: Int -> ReadS DeleteIpamResponse #

readList :: ReadS [DeleteIpamResponse] #

readPrec :: ReadPrec DeleteIpamResponse #

readListPrec :: ReadPrec [DeleteIpamResponse] #

Show DeleteIpamResponse Source # 
Instance details

Defined in Amazonka.EC2.DeleteIpam

Methods

showsPrec :: Int -> DeleteIpamResponse -> ShowS #

show :: DeleteIpamResponse -> String #

showList :: [DeleteIpamResponse] -> ShowS #

NFData DeleteIpamResponse Source # 
Instance details

Defined in Amazonka.EC2.DeleteIpam

Methods

rnf :: DeleteIpamResponse -> () #

Eq DeleteIpamResponse Source # 
Instance details

Defined in Amazonka.EC2.DeleteIpam

Methods

(==) :: DeleteIpamResponse -> DeleteIpamResponse -> Bool #

(/=) :: DeleteIpamResponse -> DeleteIpamResponse -> Bool #

type Rep DeleteIpamResponse Source # 
Instance details

Defined in Amazonka.EC2.DeleteIpam

type Rep DeleteIpamResponse = D1 ('MetaData "DeleteIpamResponse" "Amazonka.EC2.DeleteIpam" "amazonka-ec2-2.0-48L9RAJvmvzAdBkRegqWCL" 'False) (C1 ('MetaCons "DeleteIpamResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "ipam") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Ipam)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newDeleteIpamResponse Source #

Arguments

:: Int

$sel:httpStatus:DeleteIpamResponse'

-> DeleteIpamResponse 

Create a value of DeleteIpamResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:ipam:DeleteIpamResponse', deleteIpamResponse_ipam - Information about the results of the deletion.

$sel:httpStatus:DeleteIpamResponse', deleteIpamResponse_httpStatus - The response's http status code.

Response Lenses

deleteIpamResponse_ipam :: Lens' DeleteIpamResponse (Maybe Ipam) Source #

Information about the results of the deletion.

deleteIpamResponse_httpStatus :: Lens' DeleteIpamResponse Int Source #

The response's http status code.