Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
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
- data DeleteIpam = DeleteIpam' {}
- newDeleteIpam :: Text -> DeleteIpam
- deleteIpam_cascade :: Lens' DeleteIpam (Maybe Bool)
- deleteIpam_dryRun :: Lens' DeleteIpam (Maybe Bool)
- deleteIpam_ipamId :: Lens' DeleteIpam Text
- data DeleteIpamResponse = DeleteIpamResponse' {
- ipam :: Maybe Ipam
- httpStatus :: Int
- newDeleteIpamResponse :: Int -> DeleteIpamResponse
- deleteIpamResponse_ipam :: Lens' DeleteIpamResponse (Maybe Ipam)
- deleteIpamResponse_httpStatus :: Lens' DeleteIpamResponse Int
Creating a Request
data DeleteIpam Source #
See: newDeleteIpam
smart constructor.
DeleteIpam' | |
|
Instances
:: Text | |
-> 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.
DeleteIpamResponse' | |
|
Instances
newDeleteIpamResponse Source #
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.