Package software.amazon.awssdk.services.rds.model

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, unless the Amazon Web Services Backup policy specifies a point-in-time restore rule.

      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, unless the Amazon Web Services Backup policy specifies a point-in-time restore rule.

    • toBuilder

      public DeleteDbClusterRequest.Builder toBuilder()
      Specified by:
      toBuilder in interface ToCopyableBuilder<DeleteDbClusterRequest.Builder,DeleteDbClusterRequest>
      Specified by:
      toBuilder in class RdsRequest

    • 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

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo