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

Interface DeleteDbInstanceRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<DeleteDbInstanceRequest.Builder,DeleteDbInstanceRequest>, RdsRequest.Builder, SdkBuilder<DeleteDbInstanceRequest.Builder,DeleteDbInstanceRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
DeleteDbInstanceRequest
public static interface DeleteDbInstanceRequest.Builder extends RdsRequest.Builder, SdkPojo, CopyableBuilder<DeleteDbInstanceRequest.Builder,DeleteDbInstanceRequest>

  • Method Details

    • dbInstanceIdentifier

      DeleteDbInstanceRequest.Builder dbInstanceIdentifier(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • skipFinalSnapshot

      DeleteDbInstanceRequest.Builder skipFinalSnapshot(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • finalDBSnapshotIdentifier

      DeleteDbInstanceRequest.Builder finalDBSnapshotIdentifier(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • deleteAutomatedBackups

      DeleteDbInstanceRequest.Builder deleteAutomatedBackups(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

      DeleteDbInstanceRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      DeleteDbInstanceRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.