aws_sdk_docdb/client/

failover_db_cluster.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`FailoverDBCluster`](crate::operation::failover_db_cluster::builders::FailoverDBClusterFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`db_cluster_identifier(impl Into<String>)`](crate::operation::failover_db_cluster::builders::FailoverDBClusterFluentBuilder::db_cluster_identifier) / [`set_db_cluster_identifier(Option<String>)`](crate::operation::failover_db_cluster::builders::FailoverDBClusterFluentBuilder::set_db_cluster_identifier):<br>required: **false**<br><p>A cluster identifier to force a failover for. This parameter is not case sensitive.</p> <p>Constraints:</p> <ul>  <li>   <p>Must match the identifier of an existing <code>DBCluster</code>.</p></li> </ul><br>
    ///   - [`target_db_instance_identifier(impl Into<String>)`](crate::operation::failover_db_cluster::builders::FailoverDBClusterFluentBuilder::target_db_instance_identifier) / [`set_target_db_instance_identifier(Option<String>)`](crate::operation::failover_db_cluster::builders::FailoverDBClusterFluentBuilder::set_target_db_instance_identifier):<br>required: **false**<br><p>The name of the instance to promote to the primary instance.</p> <p>You must specify the instance identifier for an Amazon DocumentDB replica in the cluster. For example, <code>mydbcluster-replica1</code>.</p><br>
    /// - On success, responds with [`FailoverDbClusterOutput`](crate::operation::failover_db_cluster::FailoverDbClusterOutput) with field(s):
    ///   - [`db_cluster(Option<DbCluster>)`](crate::operation::failover_db_cluster::FailoverDbClusterOutput::db_cluster): <p>Detailed information about a cluster.</p>
    /// - On failure, responds with [`SdkError<FailoverDBClusterError>`](crate::operation::failover_db_cluster::FailoverDBClusterError)
    pub fn failover_db_cluster(&self) -> crate::operation::failover_db_cluster::builders::FailoverDBClusterFluentBuilder {
        crate::operation::failover_db_cluster::builders::FailoverDBClusterFluentBuilder::new(self.handle.clone())
    }
}