DeleteTenantDatabase
Deletes a tenant database from your DB instance. This command only applies to RDS for Oracle container database (CDB) instances.
You can't delete a tenant database when it is the only tenant in the DB instance.
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
- DBInstanceIdentifier
-
The user-supplied identifier for the DB instance that contains the tenant database that you want to delete.
Type: String
Required: Yes
- TenantDBName
-
The user-supplied name of the tenant database that you want to remove from your DB instance. Amazon RDS deletes the tenant database with this name. This parameter isn’t case-sensitive.
Type: String
Required: Yes
- FinalDBSnapshotIdentifier
-
The
DBSnapshotIdentifier
of the newDBSnapshot
created when theSkipFinalSnapshot
parameter is disabled.Note
If you enable this parameter and also enable
SkipFinalShapshot
, the command results in an error.Type: String
Required: No
- SkipFinalSnapshot
-
Specifies whether to skip the creation of a final DB snapshot before removing the tenant database from your DB instance. If you enable this parameter, RDS doesn't create a DB snapshot. If you don't enable this parameter, RDS creates a DB snapshot before it deletes the tenant database. By default, RDS doesn't skip the final snapshot. If you don't enable this parameter, you must specify the
FinalDBSnapshotIdentifier
parameter.Type: Boolean
Required: No
Response Elements
The following element is returned by the service.
- TenantDatabase
-
A tenant database in the DB instance. This data type is an element in the response to the
DescribeTenantDatabases
action.Type: TenantDatabase object
Errors
For information about the errors that are common to all actions, see Common Errors.
- DBInstanceNotFound
-
DBInstanceIdentifier
doesn't refer to an existing DB instance.HTTP Status Code: 404
- InvalidDBInstanceState
-
The DB instance isn't in a valid state.
HTTP Status Code: 400
- TenantDatabaseNotFound
-
The specified tenant database wasn't found in the DB instance.
HTTP Status Code: 404
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: