/AWS1/CL_RDS=>DELETETENANTDATABASE()
¶
About 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.
Method Signature¶
IMPORTING¶
Required arguments:¶
IV_DBINSTANCEIDENTIFIER
TYPE /AWS1/RDSSTRING
/AWS1/RDSSTRING
¶
The user-supplied identifier for the DB instance that contains the tenant database that you want to delete.
IV_TENANTDBNAME
TYPE /AWS1/RDSSTRING
/AWS1/RDSSTRING
¶
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.
Optional arguments:¶
IV_SKIPFINALSNAPSHOT
TYPE /AWS1/RDSBOOLEAN
/AWS1/RDSBOOLEAN
¶
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.
IV_FINALDBSNAPSHOTIDENTIFIER
TYPE /AWS1/RDSSTRING
/AWS1/RDSSTRING
¶
The
DBSnapshotIdentifier
of the newDBSnapshot
created when theSkipFinalSnapshot
parameter is disabled.If you enable this parameter and also enable
SkipFinalShapshot
, the command results in an error.