aws_sdk_rds/client/start_db_cluster.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 [`StartDBCluster`](crate::operation::start_db_cluster::builders::StartDBClusterFluentBuilder) operation.
4 ///
5 /// - The fluent builder is configurable:
6 /// - [`db_cluster_identifier(impl Into<String>)`](crate::operation::start_db_cluster::builders::StartDBClusterFluentBuilder::db_cluster_identifier) / [`set_db_cluster_identifier(Option<String>)`](crate::operation::start_db_cluster::builders::StartDBClusterFluentBuilder::set_db_cluster_identifier):<br>required: **true**<br><p>The DB cluster identifier of the Amazon Aurora DB cluster to be started. This parameter is stored as a lowercase string.</p><br>
7 /// - On success, responds with [`StartDbClusterOutput`](crate::operation::start_db_cluster::StartDbClusterOutput) with field(s):
8 /// - [`db_cluster(Option<DbCluster>)`](crate::operation::start_db_cluster::StartDbClusterOutput::db_cluster): <p>Contains the details of an Amazon Aurora DB cluster or Multi-AZ DB cluster.</p> <p>For an Amazon Aurora DB cluster, this data type is used as a response element in the operations <code>CreateDBCluster</code>, <code>DeleteDBCluster</code>, <code>DescribeDBClusters</code>, <code>FailoverDBCluster</code>, <code>ModifyDBCluster</code>, <code>PromoteReadReplicaDBCluster</code>, <code>RestoreDBClusterFromS3</code>, <code>RestoreDBClusterFromSnapshot</code>, <code>RestoreDBClusterToPointInTime</code>, <code>StartDBCluster</code>, and <code>StopDBCluster</code>.</p> <p>For a Multi-AZ DB cluster, this data type is used as a response element in the operations <code>CreateDBCluster</code>, <code>DeleteDBCluster</code>, <code>DescribeDBClusters</code>, <code>FailoverDBCluster</code>, <code>ModifyDBCluster</code>, <code>RebootDBCluster</code>, <code>RestoreDBClusterFromSnapshot</code>, and <code>RestoreDBClusterToPointInTime</code>.</p> <p>For more information on Amazon Aurora DB clusters, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html"> What is Amazon Aurora?</a> in the <i>Amazon Aurora User Guide.</i></p> <p>For more information on Multi-AZ DB clusters, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html"> Multi-AZ deployments with two readable standby DB instances</a> in the <i>Amazon RDS User Guide.</i></p>
9 /// - On failure, responds with [`SdkError<StartDBClusterError>`](crate::operation::start_db_cluster::StartDBClusterError)
10 pub fn start_db_cluster(&self) -> crate::operation::start_db_cluster::builders::StartDBClusterFluentBuilder {
11 crate::operation::start_db_cluster::builders::StartDBClusterFluentBuilder::new(self.handle.clone())
12 }
13}