Deletes a tenant database from your DB instance¶

Description¶

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.

Usage¶

rds_delete_tenant_database(DBInstanceIdentifier, TenantDBName,
  SkipFinalSnapshot, FinalDBSnapshotIdentifier)

Arguments¶

• DBInstanceIdentifier

  [required] The user-supplied identifier for the DB instance that contains the tenant database that you want to delete.

• TenantDBName

  [required] 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.

• 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.

• FinalDBSnapshotIdentifier

  The DBSnapshotIdentifier of the new DBSnapshot created when the SkipFinalSnapshot parameter is disabled.

  If you enable this parameter and also enable SkipFinalShapshot, the command results in an error.

Value¶

A list with the following syntax:

list(
  TenantDatabase = list(
    TenantDatabaseCreateTime = as.POSIXct(
      "2015-01-01"
    ),
    DBInstanceIdentifier = "string",
    TenantDBName = "string",
    Status = "string",
    MasterUsername = "string",
    DbiResourceId = "string",
    TenantDatabaseResourceId = "string",
    TenantDatabaseARN = "string",
    CharacterSetName = "string",
    NcharCharacterSetName = "string",
    DeletionProtection = TRUE|FALSE,
    PendingModifiedValues = list(
      MasterUserPassword = "string",
      TenantDBName = "string"
    ),
    MasterUserSecret = list(
      SecretArn = "string",
      SecretStatus = "string",
      KmsKeyId = "string"
    ),
    TagList = list(
      list(
        Key = "string",
        Value = "string"
      )
    )
  )
)

Request syntax¶

svc$delete_tenant_database(
  DBInstanceIdentifier = "string",
  TenantDBName = "string",
  SkipFinalSnapshot = TRUE|FALSE,
  FinalDBSnapshotIdentifier = "string"
)