Interface DeleteDbInstanceRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<DeleteDbInstanceRequest.Builder,
,DeleteDbInstanceRequest> NeptuneRequest.Builder
,SdkBuilder<DeleteDbInstanceRequest.Builder,
,DeleteDbInstanceRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
DeleteDbInstanceRequest
-
Method Summary
Modifier and TypeMethodDescriptiondbInstanceIdentifier
(String dbInstanceIdentifier) The DB instance identifier for the DB instance to be deleted.finalDBSnapshotIdentifier
(String finalDBSnapshotIdentifier) The DBSnapshotIdentifier of the new DBSnapshot created when SkipFinalSnapshot is set tofalse
.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.skipFinalSnapshot
(Boolean skipFinalSnapshot) Determines whether a final DB snapshot is created before the DB instance is deleted.Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.services.neptune.model.NeptuneRequest.Builder
build
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
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
Determines whether a final DB snapshot is created before the DB instance is deleted. If
true
is specified, no DBSnapshot is created. Iffalse
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. Iftrue
is specified, no DBSnapshot is created. Iffalse
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
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 tofalse
.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.
-
-
overrideConfiguration
DeleteDbInstanceRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.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 interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-