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 DB snapshot created when SkipFinalSnapshot is set to false.
DeleteDbInstanceRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.
DeleteDbInstanceRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.
DeleteDbInstanceRequest.Builder	skipFinalSnapshot(Boolean skipFinalSnapshot) A value that indicates whether a final DB snapshot is created 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

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 a final DB snapshot is created before the DB instance is deleted. If true is specified, no DB snapshot is created. If false is specified, a DB snapshot is created before the DB instance is deleted.

When a DB instance is in a failure state and has a status of failed, incompatible-restore, or incompatible-network, you can only delete it when the SkipFinalSnapshot parameter is set to true.

Specify true when deleting a Read Replica.

The FinalDBSnapshotIdentifier parameter must be specified if SkipFinalSnapshot is false.

Default: false

Parameters:

skipFinalSnapshot - A value that indicates whether a final DB snapshot is created before the DB instance is deleted. If true is specified, no DB snapshot is created. If false is specified, a DB snapshot is created before the DB instance is deleted.

When a DB instance is in a failure state and has a status of failed, incompatible-restore, or incompatible-network, you can only delete it when the SkipFinalSnapshot parameter is set to true.

Specify true when deleting a Read Replica.

The FinalDBSnapshotIdentifier parameter must be specified if SkipFinalSnapshot is false.

Default: false

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 DB snapshot created when SkipFinalSnapshot is set to false.

Specifying this parameter and also setting the SkipFinalShapshot parameter to true 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 DB snapshot created when SkipFinalSnapshot is set to false.

Specifying this parameter and also setting the SkipFinalShapshot parameter to true 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. This parameter defaults to true.

Parameters:

deleteAutomatedBackups - A value that indicates whether to remove automated backups immediately after the DB instance is deleted. This parameter isn't case-sensitive. This parameter defaults to true.

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.