aws_sdk_lightsail/client/

delete_relational_database.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`DeleteRelationalDatabase`](crate::operation::delete_relational_database::builders::DeleteRelationalDatabaseFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`relational_database_name(impl Into<String>)`](crate::operation::delete_relational_database::builders::DeleteRelationalDatabaseFluentBuilder::relational_database_name) / [`set_relational_database_name(Option<String>)`](crate::operation::delete_relational_database::builders::DeleteRelationalDatabaseFluentBuilder::set_relational_database_name):<br>required: **true**<br><p>The name of the database that you are deleting.</p><br>
    ///   - [`skip_final_snapshot(bool)`](crate::operation::delete_relational_database::builders::DeleteRelationalDatabaseFluentBuilder::skip_final_snapshot) / [`set_skip_final_snapshot(Option<bool>)`](crate::operation::delete_relational_database::builders::DeleteRelationalDatabaseFluentBuilder::set_skip_final_snapshot):<br>required: **false**<br><p>Determines whether a final database snapshot is created before your database is deleted. If <code>true</code> is specified, no database snapshot is created. If <code>false</code> is specified, a database snapshot is created before your database is deleted.</p> <p>You must specify the <code>final relational database snapshot name</code> parameter if the <code>skip final snapshot</code> parameter is <code>false</code>.</p> <p>Default: <code>false</code></p><br>
    ///   - [`final_relational_database_snapshot_name(impl Into<String>)`](crate::operation::delete_relational_database::builders::DeleteRelationalDatabaseFluentBuilder::final_relational_database_snapshot_name) / [`set_final_relational_database_snapshot_name(Option<String>)`](crate::operation::delete_relational_database::builders::DeleteRelationalDatabaseFluentBuilder::set_final_relational_database_snapshot_name):<br>required: **false**<br><p>The name of the database snapshot created if <code>skip final snapshot</code> is <code>false</code>, which is the default value for that parameter.</p><note>  <p>Specifying this parameter and also specifying the <code>skip final snapshot</code> parameter to <code>true</code> results in an error.</p> </note> <p>Constraints:</p> <ul>  <li>   <p>Must contain from 2 to 255 alphanumeric characters, or hyphens.</p></li>  <li>   <p>The first and last character must be a letter or number.</p></li> </ul><br>
    /// - On success, responds with [`DeleteRelationalDatabaseOutput`](crate::operation::delete_relational_database::DeleteRelationalDatabaseOutput) with field(s):
    ///   - [`operations(Option<Vec::<Operation>>)`](crate::operation::delete_relational_database::DeleteRelationalDatabaseOutput::operations): <p>An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.</p>
    /// - On failure, responds with [`SdkError<DeleteRelationalDatabaseError>`](crate::operation::delete_relational_database::DeleteRelationalDatabaseError)
    pub fn delete_relational_database(&self) -> crate::operation::delete_relational_database::builders::DeleteRelationalDatabaseFluentBuilder {
        crate::operation::delete_relational_database::builders::DeleteRelationalDatabaseFluentBuilder::new(self.handle.clone())
    }
}