aws-sdk-odb 1.42.0

AWS SDK for odb
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`StopDbNode`](crate::operation::stop_db_node::builders::StopDbNodeFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`cloud_vm_cluster_id(impl Into<String>)`](crate::operation::stop_db_node::builders::StopDbNodeFluentBuilder::cloud_vm_cluster_id) / [`set_cloud_vm_cluster_id(Option<String>)`](crate::operation::stop_db_node::builders::StopDbNodeFluentBuilder::set_cloud_vm_cluster_id):<br>required: **false**<br><p>The unique identifier of the VM cluster that contains the DB node to stop. You must specify either this parameter or <code>exadbVmClusterId</code>.</p><br>
    ///   - [`exadb_vm_cluster_id(impl Into<String>)`](crate::operation::stop_db_node::builders::StopDbNodeFluentBuilder::exadb_vm_cluster_id) / [`set_exadb_vm_cluster_id(Option<String>)`](crate::operation::stop_db_node::builders::StopDbNodeFluentBuilder::set_exadb_vm_cluster_id):<br>required: **false**<br><p>The unique identifier of the Exascale VM cluster that contains the DB node to stop. You must specify either this parameter or <code>cloudVmClusterId</code>.</p><br>
    ///   - [`db_node_id(impl Into<String>)`](crate::operation::stop_db_node::builders::StopDbNodeFluentBuilder::db_node_id) / [`set_db_node_id(Option<String>)`](crate::operation::stop_db_node::builders::StopDbNodeFluentBuilder::set_db_node_id):<br>required: **true**<br><p>The unique identifier of the DB node to stop.</p><br>
    /// - On success, responds with [`StopDbNodeOutput`](crate::operation::stop_db_node::StopDbNodeOutput) with field(s):
    ///   - [`db_node_id(String)`](crate::operation::stop_db_node::StopDbNodeOutput::db_node_id): <p>The unique identifier of the DB node that was stopped.</p>
    ///   - [`status(Option<DbNodeResourceStatus>)`](crate::operation::stop_db_node::StopDbNodeOutput::status): <p>The current status of the DB node after the stop operation.</p>
    ///   - [`status_reason(Option<String>)`](crate::operation::stop_db_node::StopDbNodeOutput::status_reason): <p>Additional information about the status of the DB node after the stop operation.</p>
    /// - On failure, responds with [`SdkError<StopDbNodeError>`](crate::operation::stop_db_node::StopDbNodeError)
    pub fn stop_db_node(&self) -> crate::operation::stop_db_node::builders::StopDbNodeFluentBuilder {
        crate::operation::stop_db_node::builders::StopDbNodeFluentBuilder::new(self.handle.clone())
    }
}