Skip to content

DeleteIpamPoolRequest

Source code in docs_src/capo_ec2/types/delete_ipam_pool_request.py 
14
15
16
17
18
19
20
class DeleteIpamPoolRequest(TypedDict, closed=True):
    dry_run: NotRequired["capo_ec2.types.boolean.Boolean"]
    """<p>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 <code>DryRunOperation</code>. Otherwise, it is <code>UnauthorizedOperation</code>.</p>"""
    ipam_pool_id: NotRequired["capo_ec2.types.ipam_pool_id.IpamPoolId"]
    """<p>The ID of the pool to delete.</p>"""
    cascade: NotRequired["capo_ec2.types.boolean.Boolean"]
    """<p>Enables you to quickly delete an IPAM pool and all resources within that pool, including provisioned CIDRs, allocations, and other pools.</p> <important> <p>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.</p> </important>"""

cascade instance-attribute 

cascade: NotRequired[Boolean]

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.

dry_run instance-attribute 

dry_run: NotRequired[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.

ipam_pool_id instance-attribute 

ipam_pool_id: NotRequired[IpamPoolId]

The ID of the pool to delete.