aws-sdk-rds 1.131.0

AWS SDK for Amazon Relational Database Service
Documentation
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
#[allow(missing_docs)] // documentation missing in model
#[non_exhaustive]
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::fmt::Debug)]
pub struct DeleteTenantDatabaseInput {
    /// <p>The user-supplied identifier for the DB instance that contains the tenant database that you want to delete.</p>
    pub db_instance_identifier: ::std::option::Option<::std::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>
    pub tenant_db_name: ::std::option::Option<::std::string::String>,
    /// <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>
    pub skip_final_snapshot: ::std::option::Option<bool>,
    /// <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>
    pub final_db_snapshot_identifier: ::std::option::Option<::std::string::String>,
}
impl DeleteTenantDatabaseInput {
    /// <p>The user-supplied identifier for the DB instance that contains the tenant database that you want to delete.</p>
    pub fn db_instance_identifier(&self) -> ::std::option::Option<&str> {
        self.db_instance_identifier.as_deref()
    }
    /// <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>
    pub fn tenant_db_name(&self) -> ::std::option::Option<&str> {
        self.tenant_db_name.as_deref()
    }
    /// <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>
    pub fn skip_final_snapshot(&self) -> ::std::option::Option<bool> {
        self.skip_final_snapshot
    }
    /// <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>
    pub fn final_db_snapshot_identifier(&self) -> ::std::option::Option<&str> {
        self.final_db_snapshot_identifier.as_deref()
    }
}
impl DeleteTenantDatabaseInput {
    /// Creates a new builder-style object to manufacture [`DeleteTenantDatabaseInput`](crate::operation::delete_tenant_database::DeleteTenantDatabaseInput).
    pub fn builder() -> crate::operation::delete_tenant_database::builders::DeleteTenantDatabaseInputBuilder {
        crate::operation::delete_tenant_database::builders::DeleteTenantDatabaseInputBuilder::default()
    }
}

/// A builder for [`DeleteTenantDatabaseInput`](crate::operation::delete_tenant_database::DeleteTenantDatabaseInput).
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
#[non_exhaustive]
pub struct DeleteTenantDatabaseInputBuilder {
    pub(crate) db_instance_identifier: ::std::option::Option<::std::string::String>,
    pub(crate) tenant_db_name: ::std::option::Option<::std::string::String>,
    pub(crate) skip_final_snapshot: ::std::option::Option<bool>,
    pub(crate) final_db_snapshot_identifier: ::std::option::Option<::std::string::String>,
}
impl DeleteTenantDatabaseInputBuilder {
    /// <p>The user-supplied identifier for the DB instance that contains the tenant database that you want to delete.</p>
    /// This field is required.
    pub fn db_instance_identifier(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.db_instance_identifier = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The user-supplied identifier for the DB instance that contains the tenant database that you want to delete.</p>
    pub fn set_db_instance_identifier(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.db_instance_identifier = input;
        self
    }
    /// <p>The user-supplied identifier for the DB instance that contains the tenant database that you want to delete.</p>
    pub fn get_db_instance_identifier(&self) -> &::std::option::Option<::std::string::String> {
        &self.db_instance_identifier
    }
    /// <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>
    /// This field is required.
    pub fn tenant_db_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.tenant_db_name = ::std::option::Option::Some(input.into());
        self
    }
    /// <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>
    pub fn set_tenant_db_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.tenant_db_name = input;
        self
    }
    /// <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>
    pub fn get_tenant_db_name(&self) -> &::std::option::Option<::std::string::String> {
        &self.tenant_db_name
    }
    /// <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>
    pub fn skip_final_snapshot(mut self, input: bool) -> Self {
        self.skip_final_snapshot = ::std::option::Option::Some(input);
        self
    }
    /// <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>
    pub fn set_skip_final_snapshot(mut self, input: ::std::option::Option<bool>) -> Self {
        self.skip_final_snapshot = input;
        self
    }
    /// <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>
    pub fn get_skip_final_snapshot(&self) -> &::std::option::Option<bool> {
        &self.skip_final_snapshot
    }
    /// <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>
    pub fn final_db_snapshot_identifier(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.final_db_snapshot_identifier = ::std::option::Option::Some(input.into());
        self
    }
    /// <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>
    pub fn set_final_db_snapshot_identifier(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.final_db_snapshot_identifier = input;
        self
    }
    /// <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>
    pub fn get_final_db_snapshot_identifier(&self) -> &::std::option::Option<::std::string::String> {
        &self.final_db_snapshot_identifier
    }
    /// Consumes the builder and constructs a [`DeleteTenantDatabaseInput`](crate::operation::delete_tenant_database::DeleteTenantDatabaseInput).
    pub fn build(
        self,
    ) -> ::std::result::Result<crate::operation::delete_tenant_database::DeleteTenantDatabaseInput, ::aws_smithy_types::error::operation::BuildError>
    {
        ::std::result::Result::Ok(crate::operation::delete_tenant_database::DeleteTenantDatabaseInput {
            db_instance_identifier: self.db_instance_identifier,
            tenant_db_name: self.tenant_db_name,
            skip_final_snapshot: self.skip_final_snapshot,
            final_db_snapshot_identifier: self.final_db_snapshot_identifier,
        })
    }
}