software.amazon.awssdk.services.rds.model

Interface DeleteDBInstanceRequest.Builder

All Superinterfaces:

AwsRequest.Builder, CopyableBuilder<DeleteDBInstanceRequest.Builder,DeleteDBInstanceRequest>, RDSRequest.Builder, SdkBuilder<DeleteDBInstanceRequest.Builder,DeleteDBInstanceRequest>, SdkRequest.Builder

Enclosing class:

DeleteDBInstanceRequest

public static interface DeleteDBInstanceRequest.Builder
extends RDSRequest.Builder, 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	finalDBSnapshotIdentifier(String finalDBSnapshotIdentifier) The DBSnapshotIdentifier of the new DBSnapshot created when SkipFinalSnapshot is set to false.
DeleteDBInstanceRequest.Builder	requestOverrideConfig(AwsRequestOverrideConfig awsRequestOverrideConfig) Add an optional request override configuration.
DeleteDBInstanceRequest.Builder	requestOverrideConfig(Consumer<AwsRequestOverrideConfig.Builder> builderConsumer) Add an optional request override configuration.
DeleteDBInstanceRequest.Builder	skipFinalSnapshot(Boolean skipFinalSnapshot) Determines 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

requestOverrideConfig

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

copy

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

apply, 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)

Determines whether a final DB snapshot is created before the DB instance is deleted. If true is specified, no DBSnapshot is created. If false is specified, a DB snapshot is created before the DB instance is deleted.

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

Note that 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 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 DBSnapshot 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

• Cannot end with a hyphen or contain two consecutive hyphens

• Cannot be specified when deleting a Read Replica.

Parameters:

finalDBSnapshotIdentifier - The DBSnapshotIdentifier of the new DBSnapshot 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

• Cannot end with a hyphen or contain two consecutive hyphens

• Cannot be specified when deleting a Read Replica.

Returns:

Returns a reference to this object so that method calls can be chained together.

requestOverrideConfig

DeleteDBInstanceRequest.Builder requestOverrideConfig(AwsRequestOverrideConfig awsRequestOverrideConfig)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

requestOverrideConfig in interface AwsRequest.Builder

Parameters:

awsRequestOverrideConfig - The override configuration.

Returns:

This object for method chaining.

requestOverrideConfig

DeleteDBInstanceRequest.Builder requestOverrideConfig(Consumer<AwsRequestOverrideConfig.Builder> builderConsumer)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

requestOverrideConfig in interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfig.Builder will be given.

Returns:

This object for method chaining.