delete_tenant_database¶
Operation¶
delete_tenant_database
async
¶
delete_tenant_database(request: DeleteTenantDatabaseInput | DeleteTenantDatabaseInputDict, /, *, plugins: list[Plugin] | None = None) -> DeleteTenantDatabaseOutput
delete_tenant_database(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[DeleteTenantDatabaseInputDict]) -> DeleteTenantDatabaseOutput
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.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
Returns:
| Type | Description |
|---|---|
DeleteTenantDatabaseOutput
|
An instance of |
Input¶
Pass the input fields as keyword arguments, or pass a model or dictionary as the first positional argument. Pass plugins separately as a keyword argument.
Model¶
DeleteTenantDatabaseInput
dataclass
¶
Bases: _SerdeShape
Dataclass for DeleteTenantDatabaseInput structure.
Attributes¶
db_instance_identifier
class-attribute
instance-attribute
¶
db_instance_identifier: str | None = ...
The user-supplied identifier for the DB instance that contains the tenant database that you want to delete.
final_db_snapshot_identifier
class-attribute
instance-attribute
¶
final_db_snapshot_identifier: str | None = ...
The DBSnapshotIdentifier of the new DBSnapshot created when the
SkipFinalSnapshot parameter is disabled.
Note
If you enable this parameter and also enable SkipFinalShapshot, the
command results in an error.
skip_final_snapshot
class-attribute
instance-attribute
¶
skip_final_snapshot: bool | None = ...
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.
Dictionaries¶
DeleteTenantDatabaseInputDict
¶
Bases: TypedDict
Dictionary form of DeleteTenantDatabaseInput.
Attributes¶
db_instance_identifier
instance-attribute
¶
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: str | None
The DBSnapshotIdentifier of the new DBSnapshot created when the
SkipFinalSnapshot parameter is disabled.
Note
If you enable this parameter and also enable SkipFinalShapshot, the
command results in an error.
skip_final_snapshot
instance-attribute
¶
skip_final_snapshot: bool | None
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.
Output¶
DeleteTenantDatabaseOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for DeleteTenantDatabaseOutput structure.
Attributes¶
response_metadata
class-attribute
instance-attribute
¶
Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.
tenant_database
class-attribute
instance-attribute
¶
tenant_database: TenantDatabase | None = ...
A tenant database in the DB instance. This data type is an element in
the response to the DescribeTenantDatabases action.