Class DeleteDbClusterRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.rds.model.RdsRequest
software.amazon.awssdk.services.rds.model.DeleteDbClusterRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<DeleteDbClusterRequest.Builder,DeleteDbClusterRequest>
@Generated("software.amazon.awssdk:codegen") public final class DeleteDbClusterRequest extends RdsRequest implements ToCopyableBuilder<DeleteDbClusterRequest.Builder,DeleteDbClusterRequest>

  • Method Details

    • dbClusterIdentifier

      public final String dbClusterIdentifier()

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

      Constraints:

      • Must match an existing DBClusterIdentifier.

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

      Constraints:

      • Must match an existing DBClusterIdentifier.

    • skipFinalSnapshot

      public final Boolean skipFinalSnapshot()

      Specifies whether to skip the creation of a final DB cluster snapshot before RDS deletes the DB cluster. If you set this value to true, RDS doesn't create a final DB cluster snapshot. If you set this value to false or don't specify it, RDS creates a DB cluster snapshot before it deletes the DB cluster. By default, this parameter is disabled, so RDS creates a final DB cluster snapshot.

      If SkipFinalSnapshot is disabled, you must specify a value for the FinalDBSnapshotIdentifier parameter.

      Returns:
      Specifies whether to skip the creation of a final DB cluster snapshot before RDS deletes the DB cluster. If you set this value to true, RDS doesn't create a final DB cluster snapshot. If you set this value to false or don't specify it, RDS creates a DB cluster snapshot before it deletes the DB cluster. By default, this parameter is disabled, so RDS creates a final DB cluster snapshot.

      If SkipFinalSnapshot is disabled, you must specify a value for the FinalDBSnapshotIdentifier parameter.

    • finalDBSnapshotIdentifier

      public final String finalDBSnapshotIdentifier()

      The DB cluster snapshot identifier of the new DB cluster snapshot created when SkipFinalSnapshot is disabled.

      If you specify this parameter and also skip the creation of a final DB cluster snapshot with the SkipFinalShapshot parameter, the request results in an error.

      Constraints:

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

      • First character must be a letter

      • Can't end with a hyphen or contain two consecutive hyphens

      Returns:
      The DB cluster snapshot identifier of the new DB cluster snapshot created when SkipFinalSnapshot is disabled.

      If you specify this parameter and also skip the creation of a final DB cluster snapshot with the SkipFinalShapshot parameter, the request results in an error.

      Constraints:

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

      • First character must be a letter

      • Can't end with a hyphen or contain two consecutive hyphens

    • deleteAutomatedBackups

      public final Boolean deleteAutomatedBackups()

      Specifies whether to remove automated backups immediately after the DB cluster is deleted. This parameter isn't case-sensitive. The default is to remove automated backups immediately after the DB cluster is deleted.

      Returns:
      Specifies whether to remove automated backups immediately after the DB cluster is deleted. This parameter isn't case-sensitive. The default is to remove automated backups immediately after the DB cluster is deleted.

    • 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 RdsRequest
      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.