aws_sdk_lightsail/client/
stop_relational_database.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3    /// Constructs a fluent builder for the [`StopRelationalDatabase`](crate::operation::stop_relational_database::builders::StopRelationalDatabaseFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`relational_database_name(impl Into<String>)`](crate::operation::stop_relational_database::builders::StopRelationalDatabaseFluentBuilder::relational_database_name) / [`set_relational_database_name(Option<String>)`](crate::operation::stop_relational_database::builders::StopRelationalDatabaseFluentBuilder::set_relational_database_name):<br>required: **true**<br><p>The name of your database to stop.</p><br>
7    ///   - [`relational_database_snapshot_name(impl Into<String>)`](crate::operation::stop_relational_database::builders::StopRelationalDatabaseFluentBuilder::relational_database_snapshot_name) / [`set_relational_database_snapshot_name(Option<String>)`](crate::operation::stop_relational_database::builders::StopRelationalDatabaseFluentBuilder::set_relational_database_snapshot_name):<br>required: **false**<br><p>The name of your new database snapshot to be created before stopping your database.</p><br>
8    /// - On success, responds with [`StopRelationalDatabaseOutput`](crate::operation::stop_relational_database::StopRelationalDatabaseOutput) with field(s):
9    ///   - [`operations(Option<Vec::<Operation>>)`](crate::operation::stop_relational_database::StopRelationalDatabaseOutput::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>
10    /// - On failure, responds with [`SdkError<StopRelationalDatabaseError>`](crate::operation::stop_relational_database::StopRelationalDatabaseError)
11    pub fn stop_relational_database(&self) -> crate::operation::stop_relational_database::builders::StopRelationalDatabaseFluentBuilder {
12        crate::operation::stop_relational_database::builders::StopRelationalDatabaseFluentBuilder::new(self.handle.clone())
13    }
14}