Class DeleteDBInstanceRequest
- java.lang.Object
-
- com.amazonaws.AmazonWebServiceRequest
-
- com.amazonaws.services.rds.model.DeleteDBInstanceRequest
-
- All Implemented Interfaces:
ReadLimitInfo
,Serializable
,Cloneable
public class DeleteDBInstanceRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
- See Also:
- Serialized Form
-
-
Field Summary
-
Fields inherited from class com.amazonaws.AmazonWebServiceRequest
NOOP
-
-
Constructor Summary
Constructors Constructor Description DeleteDBInstanceRequest()
Default constructor for DeleteDBInstanceRequest object.DeleteDBInstanceRequest(String dBInstanceIdentifier)
Constructs a new DeleteDBInstanceRequest object.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method 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 tofalse
.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 tofalse
.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 tofalse
.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
copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
-
-
-
-
Constructor Detail
-
DeleteDBInstanceRequest
public DeleteDBInstanceRequest()
Default constructor for DeleteDBInstanceRequest object. Callers should use the setter or fluent setter (with...) methods to initialize the 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
-
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
-
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
-
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
- 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:
- Returns a reference to this object so that method calls can be chained together.
-
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. 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
-
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. 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:
- 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
-
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. 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.
-
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. 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:
- 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
-
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 tofalse
.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.
-
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.
-
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.
- 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 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:
- Returns a reference to this 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 classObject
- Returns:
- A string representation of this object.
- See Also:
Object.toString()
-
clone
public DeleteDBInstanceRequest clone()
Description copied from class:AmazonWebServiceRequest
Creates a shallow clone of this request. Explicitly does not clone the deep structure of the request object.- Overrides:
clone
in classAmazonWebServiceRequest
- See Also:
Object.clone()
-
-