Package software.amazon.awssdk.services.docdb.model

Class DeleteDbClusterRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.docdb.model.DocDbRequest

software.amazon.awssdk.services.docdb.model.DeleteDbClusterRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DeleteDbClusterRequest.Builder,DeleteDbClusterRequest>

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

Represents the input to DeleteDBCluster.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DeleteDbClusterRequest.Builder

Method Summary

Modifier and Type	Method	Description
static DeleteDbClusterRequest.Builder	builder()
String	dbClusterIdentifier()	The cluster identifier for the cluster to be deleted.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	finalDBSnapshotIdentifier()	The cluster snapshot identifier of the new cluster snapshot created when SkipFinalSnapshot is set to false.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends DeleteDbClusterRequest.Builder>	serializableBuilderClass()
Boolean	skipFinalSnapshot()	Determines whether a final cluster snapshot is created before the cluster is deleted.
DeleteDbClusterRequest.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

dbClusterIdentifier

public final String dbClusterIdentifier()

The cluster identifier for the cluster to be deleted. This parameter isn't case sensitive.

Constraints:

• Must match an existing DBClusterIdentifier.

Returns:

The cluster identifier for the cluster to be deleted. This parameter isn't case sensitive.

Constraints:

• Must match an existing DBClusterIdentifier.

skipFinalSnapshot

public final Boolean skipFinalSnapshot()

Determines whether a final cluster snapshot is created before the cluster is deleted. If true is specified, no cluster snapshot is created. If false is specified, a cluster snapshot is created before the DB cluster is deleted.

If SkipFinalSnapshot is false, you must specify a FinalDBSnapshotIdentifier parameter.

Default: false

Returns:

Determines whether a final cluster snapshot is created before the cluster is deleted. If true is specified, no cluster snapshot is created. If false is specified, a cluster snapshot is created before the DB cluster is deleted.

If SkipFinalSnapshot is false, you must specify a FinalDBSnapshotIdentifier parameter.

Default: false

finalDBSnapshotIdentifier

public final String finalDBSnapshotIdentifier()

The cluster snapshot identifier of the new cluster snapshot created when SkipFinalSnapshot is set to false.

Specifying this parameter and also setting the SkipFinalShapshot parameter to true results in an error.

Constraints:

• Must be from 1 to 255 letters, numbers, or hyphens.

• The first character must be a letter.

• Cannot end with a hyphen or contain two consecutive hyphens.

Returns:

The cluster snapshot identifier of the new cluster snapshot created when SkipFinalSnapshot is set to false.

Specifying this parameter and also setting the SkipFinalShapshot parameter to true results in an error.

Constraints:

• Must be from 1 to 255 letters, numbers, or hyphens.

• The first character must be a letter.

• Cannot end with a hyphen or contain two consecutive hyphens.

toBuilder

public DeleteDbClusterRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DeleteDbClusterRequest.Builder,DeleteDbClusterRequest>

Specified by:

toBuilder in class DocDbRequest

builder

public static DeleteDbClusterRequest.Builder builder()

serializableBuilderClass

public static Class<? extends DeleteDbClusterRequest.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