DeleteDBInstance
The DeleteDBInstance action deletes a previously provisioned DB instance. When you delete
a DB instance, all automated backups for that instance are deleted and can't be recovered.
Manual DB snapshots of the DB instance to be deleted by DeleteDBInstance
are not
deleted.
If you request a final DB snapshot the status of the Amazon Neptune DB instance is
deleting
until the DB snapshot is created. The API action
DescribeDBInstance
is used to monitor the status of this operation. The action
can't 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
,
you can only delete it when the SkipFinalSnapshot
parameter is set to
true
.
You can't delete a DB instance if it is the only instance in the DB cluster, or if it has deletion protection enabled.
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
- 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.
Type: String
Required: Yes
-
- FinalDBSnapshotIdentifier
-
The DBSnapshotIdentifier of the new DBSnapshot created when SkipFinalSnapshot is set to
false
.Note
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.
Type: String
Required: No
-
- 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.Note
The FinalDBSnapshotIdentifier parameter must be specified if SkipFinalSnapshot is
false
.Default:
false
Type: Boolean
Required: No
Response Elements
The following element is returned by the service.
- DBInstance
-
Contains the details of an Amazon Neptune DB instance.
This data type is used as a response element in the DescribeDBInstances action.
Type: DBInstance object
Errors
For information about the errors that are common to all actions, see Common Errors.
- DBInstanceNotFound
-
DBInstanceIdentifier does not refer to an existing DB instance.
HTTP Status Code: 404
- DBSnapshotAlreadyExists
-
DBSnapshotIdentifier is already used by an existing snapshot.
HTTP Status Code: 400
- InvalidDBClusterStateFault
-
The DB cluster is not in a valid state.
HTTP Status Code: 400
- InvalidDBInstanceState
-
The specified DB instance is not in the available state.
HTTP Status Code: 400
- SnapshotQuotaExceeded
-
Request would result in user exceeding the allowed number of DB snapshots.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: