aws_sdk_rds/client/
failover_db_cluster.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 [`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: **true**<br><p>The identifier of the DB cluster to force a failover for. This parameter isn't case-sensitive.</p> <p>Constraints:</p> <ul>  <li>   <p>Must match the identifier of an existing DB cluster.</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 DB instance to promote to the primary DB instance.</p> <p>Specify the DB instance identifier for an Aurora Replica or a Multi-AZ readable standby in the DB cluster, for example <code>mydbcluster-replica1</code>.</p> <p>This setting isn't supported for RDS for MySQL Multi-AZ DB clusters.</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>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>
    /// - 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())
    }
}