software.amazon.awssdk.services.rds.model

Class DeleteDBInstanceRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.rds.model.RDSRequest

software.amazon.awssdk.services.rds.model.DeleteDBInstanceRequest

All Implemented Interfaces:

ToCopyableBuilder<DeleteDBInstanceRequest.Builder,DeleteDBInstanceRequest>

@Generated(value="software.amazon.awssdk:codegen")
public class DeleteDBInstanceRequest
extends RDSRequest
implements ToCopyableBuilder<DeleteDBInstanceRequest.Builder,DeleteDBInstanceRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DeleteDBInstanceRequest.Builder

Method Summary

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()

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

requestOverrideConfig

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

dbInstanceIdentifier

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.

Returns:

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.

skipFinalSnapshot

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

Returns:

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

finalDBSnapshotIdentifier

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.

Returns:

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.

toBuilder

public DeleteDBInstanceRequest.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<DeleteDBInstanceRequest.Builder,DeleteDBInstanceRequest>

Specified by:

toBuilder in class RDSRequest

Returns:

a builder for type T

builder

public static DeleteDBInstanceRequest.Builder builder()

serializableBuilderClass

public static Class<? extends DeleteDBInstanceRequest.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Description copied from class: SdkRequest

Used to retrieve the value of a field from any class that extends 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.

Overrides:

getValueForField in class SdkRequest

Parameters:

fieldName - The name of the member to be retrieved.

clazz - The class to cast the returned object to.

Returns:

Optional containing the casted return value