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 Summary

Modifier and Type	Method and Description
DeleteDbInstanceRequest.Builder	dbInstanceIdentifier(String dbInstanceIdentifier) The DB instance identifier for the DB instance to be deleted.
DeleteDbInstanceRequest.Builder	deleteAutomatedBackups(Boolean deleteAutomatedBackups) A value that indicates whether to remove automated backups immediately after the DB instance is deleted.
DeleteDbInstanceRequest.Builder	finalDBSnapshotIdentifier(String finalDBSnapshotIdentifier) The DBSnapshotIdentifier of the new DBSnapshot created when the SkipFinalSnapshot parameter is disabled.
DeleteDbInstanceRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
DeleteDbInstanceRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
DeleteDbInstanceRequest.Builder	skipFinalSnapshot(Boolean skipFinalSnapshot) A value that indicates whether to skip the creation of a final DB snapshot before the DB instance is deleted.

Methods inherited from interface software.amazon.awssdk.services.rds.model.RdsRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

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)

A value that indicates whether to skip the creation of a final DB snapshot before the DB instance is deleted. If skip is specified, no DB snapshot is created. If skip isn't specified, a DB snapshot is created before the DB instance is deleted. By default, skip isn't specified, and the DB snapshot is created.

When a DB instance is in a failure state and has a status of 'failed', 'incompatible-restore', or 'incompatible-network', it can only be deleted when skip is specified.

Specify skip when deleting a read replica.

The FinalDBSnapshotIdentifier parameter must be specified if skip isn't specified.

Parameters:

skipFinalSnapshot - A value that indicates whether to skip the creation of a final DB snapshot before the DB instance is deleted. If skip is specified, no DB snapshot is created. If skip isn't specified, a DB snapshot is created before the DB instance is deleted. By default, skip isn't specified, and the DB snapshot is created.

When a DB instance is in a failure state and has a status of 'failed', 'incompatible-restore', or 'incompatible-network', it can only be deleted when skip is specified.

Specify skip when deleting a read replica.

The FinalDBSnapshotIdentifier parameter must be specified if skip isn't specified.

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.

Specifying this parameter and also specifying to skip final DB snapshot creation in SkipFinalShapshot results in an error.

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.

Specifying this parameter and also specifying to skip final DB snapshot creation in SkipFinalShapshot results in an error.

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)

A value that indicates 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 - A value that indicates 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)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

DeleteDbInstanceRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Specified by:

overrideConfiguration in interface AwsRequest.Builder