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.

  • Method Details

    • 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()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<DeleteDbClusterRequest.Builder,DeleteDbClusterRequest>
      Specified by:
      toBuilder in class DocDbRequest
      Returns:
      a builder for type T

    • 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.