Package software.amazon.awssdk.services.ec2.model

Interface DeleteIpamRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<DeleteIpamRequest.Builder,DeleteIpamRequest>, Ec2Request.Builder, SdkBuilder<DeleteIpamRequest.Builder,DeleteIpamRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
DeleteIpamRequest
public static interface DeleteIpamRequest.Builder extends Ec2Request.Builder, SdkPojo, CopyableBuilder<DeleteIpamRequest.Builder,DeleteIpamRequest>

  • Method Details

    • dryRun

      DeleteIpamRequest.Builder dryRun(Boolean 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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • ipamId

      DeleteIpamRequest.Builder ipamId(String ipamId)

      The ID of the IPAM to delete.

      Parameters:
      ipamId - The ID of the IPAM to delete.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • cascade

      DeleteIpamRequest.Builder cascade(Boolean 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.

      Parameters:
      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

      DeleteIpamRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      DeleteIpamRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.