public class DeleteDBInstanceRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
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.
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".
NOOP| Constructor and Description |
|---|
DeleteDBInstanceRequest()
Default constructor for a new DeleteDBInstanceRequest object.
|
DeleteDBInstanceRequest(String dBInstanceIdentifier)
Constructs a new DeleteDBInstanceRequest object.
|
| Modifier and Type | Method and Description |
|---|---|
DeleteDBInstanceRequest |
clone()
Creates a shallow clone of this request.
|
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.
|
getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeoutpublic DeleteDBInstanceRequest()
public DeleteDBInstanceRequest(String dBInstanceIdentifier)
dBInstanceIdentifier - The DB instance identifier for the DB
instance to be deleted. This parameter isn't case-sensitive.
Constraints:
public String getDBInstanceIdentifier()
Constraints:
Constraints:
public void setDBInstanceIdentifier(String dBInstanceIdentifier)
Constraints:
dBInstanceIdentifier - The DB instance identifier for the DB instance to be deleted. This
parameter isn't case-sensitive. Constraints:
public DeleteDBInstanceRequest withDBInstanceIdentifier(String dBInstanceIdentifier)
Constraints:
Returns a reference to this object so that method calls can be chained together.
dBInstanceIdentifier - The DB instance identifier for the DB instance to be deleted. This
parameter isn't case-sensitive. Constraints:
public Boolean isSkipFinalSnapshot()
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. 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. false.
Default:
false
public void setSkipFinalSnapshot(Boolean skipFinalSnapshot)
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. false.
Default:
false
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. false.
Default:
false
public DeleteDBInstanceRequest withSkipFinalSnapshot(Boolean skipFinalSnapshot)
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. false.
Default:
false
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. 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. false.
Default:
false
public Boolean getSkipFinalSnapshot()
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. 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. false.
Default:
false
public String getFinalDBSnapshotIdentifier()
false. Constraints:
false. Constraints:
public void setFinalDBSnapshotIdentifier(String finalDBSnapshotIdentifier)
false. Constraints:
finalDBSnapshotIdentifier - The DBSnapshotIdentifier of the new DBSnapshot created when
SkipFinalSnapshot is set to false. Constraints:
public DeleteDBInstanceRequest withFinalDBSnapshotIdentifier(String finalDBSnapshotIdentifier)
false. Constraints:
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. Constraints:
public String toString()
toString in class ObjectObject.toString()public DeleteDBInstanceRequest clone()
AmazonWebServiceRequestclone in class AmazonWebServiceRequestObject.clone()Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.