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

Class DeleteDbInstanceRequest

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.DeleteDbInstanceRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<DeleteDbInstanceRequest.Builder,DeleteDbInstanceRequest>
@Generated("software.amazon.awssdk:codegen") public final class DeleteDbInstanceRequest extends RdsRequest implements ToCopyableBuilder<DeleteDbInstanceRequest.Builder,DeleteDbInstanceRequest>

  • Method Details

    • dbInstanceIdentifier

      public final String dbInstanceIdentifier()

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

      Constraints:

      • Must match the name of an existing DB instance.

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

      Constraints:

      • Must match the name of an existing DB instance.

    • skipFinalSnapshot

      public final Boolean skipFinalSnapshot()

      Specifies whether to skip the creation of a final DB snapshot before deleting the instance. If you enable this parameter, RDS doesn't create a DB snapshot. If you don't enable this parameter, RDS creates a DB snapshot before the DB instance is deleted. By default, skip isn't enabled, and the DB snapshot is created.

      If you don't enable this parameter, you must specify the FinalDBSnapshotIdentifier parameter.

      When a DB instance is in a failure state and has a status of failed, incompatible-restore, or incompatible-network, RDS can delete the instance only if you enable this parameter.

      If you delete a read replica or an RDS Custom instance, you must enable this setting.

      This setting is required for RDS Custom.

      Returns:
      Specifies whether to skip the creation of a final DB snapshot before deleting the instance. If you enable this parameter, RDS doesn't create a DB snapshot. If you don't enable this parameter, RDS creates a DB snapshot before the DB instance is deleted. By default, skip isn't enabled, and the DB snapshot is created.

      If you don't enable this parameter, you must specify the FinalDBSnapshotIdentifier parameter.

      When a DB instance is in a failure state and has a status of failed, incompatible-restore, or incompatible-network, RDS can delete the instance only if you enable this parameter.

      If you delete a read replica or an RDS Custom instance, you must enable this setting.

      This setting is required for RDS Custom.

    • finalDBSnapshotIdentifier

      public final String finalDBSnapshotIdentifier()

      The DBSnapshotIdentifier of the new DBSnapshot created when the SkipFinalSnapshot parameter is disabled.

      If you enable this parameter and also enable SkipFinalShapshot, the command results in an error.

      This setting doesn't apply to RDS Custom.

      Constraints:

      • Must be 1 to 255 letters or numbers.

      • First character must be a letter.

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

      • Can't be specified when deleting a read replica.

      Returns:
      The DBSnapshotIdentifier of the new DBSnapshot created when the SkipFinalSnapshot parameter is disabled.

      If you enable this parameter and also enable SkipFinalShapshot, the command results in an error.

      This setting doesn't apply to RDS Custom.

      Constraints:

      • Must be 1 to 255 letters or numbers.

      • First character must be a letter.

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

      • Can't be specified when deleting a read replica.

    • deleteAutomatedBackups

      public final Boolean deleteAutomatedBackups()

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

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

    • toBuilder

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

    • builder

      public static DeleteDbInstanceRequest.Builder builder()

    • serializableBuilderClass

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