Interface DeleteIpamPoolRequest.Builder
- All Superinterfaces:
AwsRequest.Builder,Buildable,CopyableBuilder<DeleteIpamPoolRequest.Builder,,DeleteIpamPoolRequest> Ec2Request.Builder,SdkBuilder<DeleteIpamPoolRequest.Builder,,DeleteIpamPoolRequest> SdkPojo,SdkRequest.Builder
- Enclosing class:
DeleteIpamPoolRequest
-
Method Summary
Modifier and TypeMethodDescriptionEnables you to quickly delete an IPAM pool and all resources within that pool, including provisioned CIDRs, allocations, and other pools.A check for whether you have the required permissions for the action without actually making the request and provides an error response.ipamPoolId(String ipamPoolId) The ID of the pool to delete.overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfigurationMethods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copyMethods inherited from interface software.amazon.awssdk.services.ec2.model.Ec2Request.Builder
buildMethods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, buildMethods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
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 isUnauthorizedOperation.- 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 isDryRunOperation. Otherwise, it isUnauthorizedOperation.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
ipamPoolId
The ID of the pool to delete.
- Parameters:
ipamPoolId- The ID of the pool to delete.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
cascade
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.
- Parameters:
cascade- 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.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
overrideConfiguration
DeleteIpamPoolRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.BuilderAdd an optional request override configuration.- Specified by:
overrideConfigurationin interfaceAwsRequest.Builder- Parameters:
overrideConfiguration- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
DeleteIpamPoolRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.BuilderAdd an optional request override configuration.- Specified by:
overrideConfigurationin interfaceAwsRequest.Builder- Parameters:
builderConsumer- AConsumerto which an emptyAwsRequestOverrideConfiguration.Builderwill be given.- Returns:
- This object for method chaining.
-