Class DeleteIpamRequest
- java.lang.Object
-
- software.amazon.awssdk.core.SdkRequest
-
- software.amazon.awssdk.awscore.AwsRequest
-
- software.amazon.awssdk.services.ec2.model.Ec2Request
-
- software.amazon.awssdk.services.ec2.model.DeleteIpamRequest
-
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<DeleteIpamRequest.Builder,DeleteIpamRequest>
@Generated("software.amazon.awssdk:codegen") public final class DeleteIpamRequest extends Ec2Request implements ToCopyableBuilder<DeleteIpamRequest.Builder,DeleteIpamRequest>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
DeleteIpamRequest.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static DeleteIpamRequest.Builder
builder()
Boolean
cascade()
Enables you to quickly delete an IPAM, private scopes, pools in private scopes, and any allocations in the pools in private scopes.Boolean
dryRun()
A check for whether you have the required permissions for the action without actually making the request and provides an error response.boolean
equals(Object obj)
boolean
equalsBySdkFields(Object obj)
<T> Optional<T>
getValueForField(String fieldName, Class<T> clazz)
int
hashCode()
String
ipamId()
The ID of the IPAM to delete.List<SdkField<?>>
sdkFields()
static Class<? extends DeleteIpamRequest.Builder>
serializableBuilderClass()
DeleteIpamRequest.Builder
toBuilder()
String
toString()
Returns a string representation of this object.-
Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
dryRun
public final 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 isUnauthorizedOperation
.- Returns:
- 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
.
-
ipamId
public final String ipamId()
The ID of the IPAM to delete.
- Returns:
- The ID of the IPAM to delete.
-
cascade
public final 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.
- Returns:
- 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.
-
-
-
toBuilder
public DeleteIpamRequest.Builder toBuilder()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<DeleteIpamRequest.Builder,DeleteIpamRequest>
- Specified by:
toBuilder
in classEc2Request
-
builder
public static DeleteIpamRequest.Builder builder()
-
serializableBuilderClass
public static Class<? extends DeleteIpamRequest.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCode
in classAwsRequest
-
equals
public final boolean equals(Object obj)
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFields
in interfaceSdkPojo
-
toString
public final String toString()
Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
-
getValueForField
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
- Overrides:
getValueForField
in classSdkRequest
-
-