DeleteDBInstanceRequest (AWS SDK for Java

java.lang.Object
- com.amazonaws.AmazonWebServiceRequest
- - com.amazonaws.services.rds.model.DeleteDBInstanceRequest

All Implemented Interfaces:

Serializable
```
public class DeleteDBInstanceRequest
extends AmazonWebServiceRequest
implements Serializable
```
Container for the parameters to the DeleteDBInstance operation.
The DeleteDBInstance action deletes a previously provisioned DB instance. A successful response from the web service indicates the request was received correctly. When you delete a DB instance, all automated backups for that instance are deleted and cannot be recovered. Manual DB snapshots of the DB instance to be deleted are not deleted.

If a final DB snapshot is requested the status of the RDS instance will be "deleting" until the DB snapshot is created. The API action DescribeDBInstance is used to monitor the status of this operation. The action cannot be canceled or reverted once submitted.

See Also:
AmazonRDS.deleteDBInstance(DeleteDBInstanceRequest), Serialized Form

Constructor Summary

Constructors
Constructor and Description
`DeleteDBInstanceRequest()` Default constructor for a new DeleteDBInstanceRequest object.
`DeleteDBInstanceRequest(String dBInstanceIdentifier)` Constructs a new DeleteDBInstanceRequest object.

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)`
`String`	`getDBInstanceIdentifier()` The DB instance identifier for the DB instance to be deleted.
`String`	`getFinalDBSnapshotIdentifier()` The DBSnapshotIdentifier of the new DBSnapshot created when SkipFinalSnapshot is set to `false`.
`Boolean`	`getSkipFinalSnapshot()` Determines whether a final DB snapshot is created before the DB instance is deleted.
`int`	`hashCode()`
`Boolean`	`isSkipFinalSnapshot()` Determines whether a final DB snapshot is created before the DB instance is deleted.
`void`	`setDBInstanceIdentifier(String dBInstanceIdentifier)` The DB instance identifier for the DB instance to be deleted.
`void`	`setFinalDBSnapshotIdentifier(String finalDBSnapshotIdentifier)` The DBSnapshotIdentifier of the new DBSnapshot created when SkipFinalSnapshot is set to `false`.
`void`	`setSkipFinalSnapshot(Boolean skipFinalSnapshot)` Determines whether a final DB snapshot is created before the DB instance is deleted.
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`DeleteDBInstanceRequest`	`withDBInstanceIdentifier(String dBInstanceIdentifier)` The DB instance identifier for the DB instance to be deleted.
`DeleteDBInstanceRequest`	`withFinalDBSnapshotIdentifier(String finalDBSnapshotIdentifier)` The DBSnapshotIdentifier of the new DBSnapshot created when SkipFinalSnapshot is set to `false`.
`DeleteDBInstanceRequest`	`withSkipFinalSnapshot(Boolean skipFinalSnapshot)` Determines whether a final DB snapshot is created before the DB instance is deleted.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest
copyPrivateRequestParameters, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setRequestCredentials, setRequestMetricCollector, withRequestMetricCollector

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - DeleteDBInstanceRequest
```
public DeleteDBInstanceRequest()
```
    Default constructor for a new DeleteDBInstanceRequest object. Callers should use the setter or fluent setter (with...) methods to initialize this object after creating it.
  - DeleteDBInstanceRequest
```
public DeleteDBInstanceRequest(String dBInstanceIdentifier)
```
    Constructs a new DeleteDBInstanceRequest object. Callers should use the setter or fluent setter (with...) methods to initialize any additional object members.
    Parameters:
    dBInstanceIdentifier - The DB instance identifier for the DB instance to be deleted. This parameter isn't case sensitive.
    Constraints:
    
    Must contain from 1 to 63 alphanumeric characters or hyphens
    
    First character must be a letter
    
    Cannot end with a hyphen or contain two consecutive hyphens
- Method Detail
  - getDBInstanceIdentifier
```
public String getDBInstanceIdentifier()
```
    The DB instance identifier for the DB instance to be deleted. This parameter isn't case sensitive.
    Constraints:
    - Must contain from 1 to 63 alphanumeric characters or hyphens
    - First character must be a letter
    - Cannot end with a hyphen or contain two consecutive hyphens
    Returns:
    The DB instance identifier for the DB instance to be deleted. This parameter isn't case sensitive.
    Constraints:
    
    Must contain from 1 to 63 alphanumeric characters or hyphens
    
    First character must be a letter
    
    Cannot end with a hyphen or contain two consecutive hyphens
  - setDBInstanceIdentifier
```
public void setDBInstanceIdentifier(String dBInstanceIdentifier)
```
    The DB instance identifier for the DB instance to be deleted. This parameter isn't case sensitive.
    Constraints:
    - Must contain from 1 to 63 alphanumeric characters or hyphens
    - First character must be a letter
    - Cannot end with a hyphen or contain two consecutive hyphens
    Parameters:
    dBInstanceIdentifier - The DB instance identifier for the DB instance to be deleted. This parameter isn't case sensitive.
    Constraints:
    
    Must contain from 1 to 63 alphanumeric characters or hyphens
    
    First character must be a letter
    
    Cannot end with a hyphen or contain two consecutive hyphens
  - withDBInstanceIdentifier
```
public DeleteDBInstanceRequest withDBInstanceIdentifier(String dBInstanceIdentifier)
```
    The DB instance identifier for the DB instance to be deleted. This parameter isn't case sensitive.
    Constraints:
    - Must contain from 1 to 63 alphanumeric characters or hyphens
    - First character must be a letter
    - Cannot end with a hyphen or contain two consecutive hyphens
    Returns a reference to this object so that method calls can be chained together.
    Parameters:
    dBInstanceIdentifier - The DB instance identifier for the DB instance to be deleted. This parameter isn't case sensitive.
    Constraints:
    
    Must contain from 1 to 63 alphanumeric characters or hyphens
    
    First character must be a letter
    
    Cannot end with a hyphen or contain two consecutive hyphens
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - isSkipFinalSnapshot
```
public Boolean isSkipFinalSnapshot()
```
    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.
    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.
    Specify true when deleting a read replica. The FinalDBSnapshotIdentifier parameter must be specified if SkipFinalSnapshot is false.
    Default: false
  - setSkipFinalSnapshot
```
public void setSkipFinalSnapshot(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.
    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.
    Specify true when deleting a read replica. The FinalDBSnapshotIdentifier parameter must be specified if SkipFinalSnapshot is false.
    Default: false
  - withSkipFinalSnapshot
```
public DeleteDBInstanceRequest withSkipFinalSnapshot(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.
    Specify true when deleting a read replica. The FinalDBSnapshotIdentifier parameter must be specified if SkipFinalSnapshot is false.
    Default: false
    Returns a reference to this object so that method calls can be chained together.
    
    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.
    Specify true when deleting a read replica. The FinalDBSnapshotIdentifier parameter must be specified if SkipFinalSnapshot is false.
    Default: false
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getSkipFinalSnapshot
```
public Boolean getSkipFinalSnapshot()
```
    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.
    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.
    Specify true when deleting a read replica. The FinalDBSnapshotIdentifier parameter must be specified if SkipFinalSnapshot is false.
    Default: false
  - getFinalDBSnapshotIdentifier
```
public String getFinalDBSnapshotIdentifier()
```
    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 alphanumeric characters
    - 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 alphanumeric characters
    
    First character must be a letter
    
    Cannot end with a hyphen or contain two consecutive hyphens
    
    Cannot be specified when deleting a read replica.
  - setFinalDBSnapshotIdentifier
```
public void setFinalDBSnapshotIdentifier(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 alphanumeric characters
    - 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 alphanumeric characters
    
    First character must be a letter
    
    Cannot end with a hyphen or contain two consecutive hyphens
    
    Cannot be specified when deleting a read replica.
  - withFinalDBSnapshotIdentifier
```
public DeleteDBInstanceRequest withFinalDBSnapshotIdentifier(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 alphanumeric characters
    - 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 a reference to this object so that method calls can be chained together.
    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 alphanumeric characters
    
    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:
    A reference to this updated object so that method calls can be chained together.
  - toString
```
public String toString()
```
    Returns a string representation of this object; useful for testing and debugging.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    A string representation of this object.
    See Also:
    Object.toString()
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object

Did this page help you?

Class DeleteDBInstanceRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

DeleteDBInstanceRequest

DeleteDBInstanceRequest

Method Detail

getDBInstanceIdentifier

setDBInstanceIdentifier

withDBInstanceIdentifier

isSkipFinalSnapshot

setSkipFinalSnapshot

withSkipFinalSnapshot

getSkipFinalSnapshot

getFinalDBSnapshotIdentifier

setFinalDBSnapshotIdentifier

withFinalDBSnapshotIdentifier

toString

hashCode

equals