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

Class DeleteIpamPoolRequest

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.DeleteIpamPoolRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DeleteIpamPoolRequest.Builder,DeleteIpamPoolRequest>

@Generated("software.amazon.awssdk:codegen")
public final class DeleteIpamPoolRequest
extends Ec2Request
implements ToCopyableBuilder<DeleteIpamPoolRequest.Builder,DeleteIpamPoolRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DeleteIpamPoolRequest.Builder

Method Summary

Modifier and Type	Method	Description
static DeleteIpamPoolRequest.Builder	builder()
Boolean	cascade()	Enables you to quickly delete an IPAM pool and all resources within that pool, including provisioned CIDRs, allocations, and other pools.
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	ipamPoolId()	The ID of the pool to delete.
List<SdkField<?>>	sdkFields()
static Class<? extends DeleteIpamPoolRequest.Builder>	serializableBuilderClass()
DeleteIpamPoolRequest.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 is UnauthorizedOperation.

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 is UnauthorizedOperation.

ipamPoolId

public final String ipamPoolId()

The ID of the pool to delete.

Returns:

The ID of the pool to delete.

cascade

public final Boolean 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:

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.

toBuilder

public DeleteIpamPoolRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DeleteIpamPoolRequest.Builder,DeleteIpamPoolRequest>

Specified by:

toBuilder in class Ec2Request

builder

public static DeleteIpamPoolRequest.Builder builder()

serializableBuilderClass

public static Class<? extends DeleteIpamPoolRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

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.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo