aws_sdk_rds/client/
stop_db_instance.rs

1
2
3
4
5
6
7
8
9
10
11
12
13
14
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`StopDBInstance`](crate::operation::stop_db_instance::builders::StopDBInstanceFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`db_instance_identifier(impl Into<String>)`](crate::operation::stop_db_instance::builders::StopDBInstanceFluentBuilder::db_instance_identifier) / [`set_db_instance_identifier(Option<String>)`](crate::operation::stop_db_instance::builders::StopDBInstanceFluentBuilder::set_db_instance_identifier):<br>required: **true**<br><p>The user-supplied instance identifier.</p><br>
    ///   - [`db_snapshot_identifier(impl Into<String>)`](crate::operation::stop_db_instance::builders::StopDBInstanceFluentBuilder::db_snapshot_identifier) / [`set_db_snapshot_identifier(Option<String>)`](crate::operation::stop_db_instance::builders::StopDBInstanceFluentBuilder::set_db_snapshot_identifier):<br>required: **false**<br><p>The user-supplied instance identifier of the DB Snapshot created immediately before the DB instance is stopped.</p><br>
    /// - On success, responds with [`StopDbInstanceOutput`](crate::operation::stop_db_instance::StopDbInstanceOutput) with field(s):
    ///   - [`db_instance(Option<DbInstance>)`](crate::operation::stop_db_instance::StopDbInstanceOutput::db_instance): <p>Contains the details of an Amazon RDS DB instance.</p> <p>This data type is used as a response element in the operations <code>CreateDBInstance</code>, <code>CreateDBInstanceReadReplica</code>, <code>DeleteDBInstance</code>, <code>DescribeDBInstances</code>, <code>ModifyDBInstance</code>, <code>PromoteReadReplica</code>, <code>RebootDBInstance</code>, <code>RestoreDBInstanceFromDBSnapshot</code>, <code>RestoreDBInstanceFromS3</code>, <code>RestoreDBInstanceToPointInTime</code>, <code>StartDBInstance</code>, and <code>StopDBInstance</code>.</p>
    /// - On failure, responds with [`SdkError<StopDBInstanceError>`](crate::operation::stop_db_instance::StopDBInstanceError)
    pub fn stop_db_instance(&self) -> crate::operation::stop_db_instance::builders::StopDBInstanceFluentBuilder {
        crate::operation::stop_db_instance::builders::StopDBInstanceFluentBuilder::new(self.handle.clone())
    }
}