Skip to content

DeleteTenantDatabaseMessage

Source code in docs_src/capo_rds/types/delete_tenant_database_message.py
class DeleteTenantDatabaseMessage(TypedDict, closed=True):
    db_instance_identifier: NotRequired["capo_rds.types.string.String"]
    """<p>The user-supplied identifier for the DB instance that contains the tenant database that you want to delete.</p>"""
    tenant_db_name: NotRequired["capo_rds.types.string.String"]
    """<p>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.</p>"""
    skip_final_snapshot: NotRequired["capo_rds.types.boolean.Boolean"]
    """<p>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 <code>FinalDBSnapshotIdentifier</code> parameter.</p>"""
    final_db_snapshot_identifier: NotRequired["capo_rds.types.string.String"]
    """<p>The <code>DBSnapshotIdentifier</code> of the new <code>DBSnapshot</code> created when the <code>SkipFinalSnapshot</code> parameter is disabled.</p> <note> <p>If you enable this parameter and also enable <code>SkipFinalShapshot</code>, the command results in an error.</p> </note>"""

db_instance_identifier instance-attribute

db_instance_identifier: NotRequired[String]

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

final_db_snapshot_identifier instance-attribute

final_db_snapshot_identifier: NotRequired[String]

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.

skip_final_snapshot instance-attribute

skip_final_snapshot: NotRequired[Boolean]

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.

tenant_db_name instance-attribute

tenant_db_name: NotRequired[String]

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.