aws_sdk_rds/client/
delete_tenant_database.rs

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`DeleteTenantDatabase`](crate::operation::delete_tenant_database::builders::DeleteTenantDatabaseFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`db_instance_identifier(impl Into<String>)`](crate::operation::delete_tenant_database::builders::DeleteTenantDatabaseFluentBuilder::db_instance_identifier) / [`set_db_instance_identifier(Option<String>)`](crate::operation::delete_tenant_database::builders::DeleteTenantDatabaseFluentBuilder::set_db_instance_identifier):<br>required: **true**<br><p>The user-supplied identifier for the DB instance that contains the tenant database that you want to delete.</p><br>
    ///   - [`tenant_db_name(impl Into<String>)`](crate::operation::delete_tenant_database::builders::DeleteTenantDatabaseFluentBuilder::tenant_db_name) / [`set_tenant_db_name(Option<String>)`](crate::operation::delete_tenant_database::builders::DeleteTenantDatabaseFluentBuilder::set_tenant_db_name):<br>required: **true**<br><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><br>
    ///   - [`skip_final_snapshot(bool)`](crate::operation::delete_tenant_database::builders::DeleteTenantDatabaseFluentBuilder::skip_final_snapshot) / [`set_skip_final_snapshot(Option<bool>)`](crate::operation::delete_tenant_database::builders::DeleteTenantDatabaseFluentBuilder::set_skip_final_snapshot):<br>required: **false**<br><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><br>
    ///   - [`final_db_snapshot_identifier(impl Into<String>)`](crate::operation::delete_tenant_database::builders::DeleteTenantDatabaseFluentBuilder::final_db_snapshot_identifier) / [`set_final_db_snapshot_identifier(Option<String>)`](crate::operation::delete_tenant_database::builders::DeleteTenantDatabaseFluentBuilder::set_final_db_snapshot_identifier):<br>required: **false**<br><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><br>
    /// - On success, responds with [`DeleteTenantDatabaseOutput`](crate::operation::delete_tenant_database::DeleteTenantDatabaseOutput) with field(s):
    ///   - [`tenant_database(Option<TenantDatabase>)`](crate::operation::delete_tenant_database::DeleteTenantDatabaseOutput::tenant_database): <p>A tenant database in the DB instance. This data type is an element in the response to the <code>DescribeTenantDatabases</code> action.</p>
    /// - On failure, responds with [`SdkError<DeleteTenantDatabaseError>`](crate::operation::delete_tenant_database::DeleteTenantDatabaseError)
    pub fn delete_tenant_database(&self) -> crate::operation::delete_tenant_database::builders::DeleteTenantDatabaseFluentBuilder {
        crate::operation::delete_tenant_database::builders::DeleteTenantDatabaseFluentBuilder::new(self.handle.clone())
    }
}