@Generated(value="software.amazon.awssdk:codegen") public final class DeleteDbInstanceRequest extends RdsRequest implements ToCopyableBuilder<DeleteDbInstanceRequest.Builder,DeleteDbInstanceRequest>
Modifier and Type | Class and Description |
---|---|
static interface |
DeleteDbInstanceRequest.Builder |
Modifier and Type | Method and Description |
---|---|
static DeleteDbInstanceRequest.Builder |
builder() |
String |
dbInstanceIdentifier()
The DB instance identifier for the DB instance to be deleted.
|
boolean |
equals(Object obj) |
String |
finalDBSnapshotIdentifier()
The DBSnapshotIdentifier of the new DBSnapshot created when SkipFinalSnapshot is set to
false . |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz)
Used to retrieve the value of a field from any class that extends
SdkRequest . |
int |
hashCode() |
static Class<? extends DeleteDbInstanceRequest.Builder> |
serializableBuilderClass() |
Boolean |
skipFinalSnapshot()
Determines whether a final DB snapshot is created before the DB instance is deleted.
|
DeleteDbInstanceRequest.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString() |
overrideConfiguration
copy
public 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.
Constraints:
Must match the name of an existing DB instance.
public 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
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
public 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.
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.
public DeleteDbInstanceRequest.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<DeleteDbInstanceRequest.Builder,DeleteDbInstanceRequest>
toBuilder
in class RdsRequest
public static DeleteDbInstanceRequest.Builder builder()
public static Class<? extends DeleteDbInstanceRequest.Builder> serializableBuilderClass()
public <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkRequest
SdkRequest
. The field name
specified should match the member name from the corresponding service-2.json model specified in the
codegen-resources folder for a given service. The class specifies what class to cast the returned value to.
If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class)
method will
again be available.getValueForField
in class SdkRequest
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.