Struct aws_sdk_rds::client::fluent_builders::FailoverGlobalCluster

pub struct FailoverGlobalCluster { /* private fields */ }

Fluent builder constructing a request to FailoverGlobalCluster.

Initiates the failover process for an Aurora global database (GlobalCluster).

A failover for an Aurora global database promotes one of secondary read-only DB clusters to be the primary DB cluster and demotes the primary DB cluster to being a secondary (read-only) DB cluster. In other words, the role of the current primary DB cluster and the selected (target) DB cluster are switched. The selected secondary DB cluster assumes full read/write capabilities for the Aurora global database.

For more information about failing over an Amazon Aurora global database, see Managed planned failover for Amazon Aurora global databases in the Amazon Aurora User Guide.

This action applies to GlobalCluster (Aurora global databases) only. Use this action only on healthy Aurora global databases with running Aurora DB clusters and no Region-wide outages, to test disaster recovery scenarios or to reconfigure your Aurora global database topology.

Implementations

impl FailoverGlobalCluster

pub async fn customize(
    self
) -> Result<CustomizableOperation<FailoverGlobalCluster, AwsResponseRetryClassifier>, SdkError<FailoverGlobalClusterError>>

Consume this builder, creating a customizable operation that can be modified before being sent. The operation’s inner http::Request can be modified as well.

pub async fn send(
    self
) -> Result<FailoverGlobalClusterOutput, SdkError<FailoverGlobalClusterError>>

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn global_cluster_identifier(self, input: impl Into<String>) -> Self

Identifier of the Aurora global database (GlobalCluster) that should be failed over. The identifier is the unique key assigned by the user when the Aurora global database was created. In other words, it's the name of the Aurora global database that you want to fail over.

Constraints:

• Must match the identifier of an existing GlobalCluster (Aurora global database).

pub fn set_global_cluster_identifier(self, input: Option<String>) -> Self

Identifier of the Aurora global database (GlobalCluster) that should be failed over. The identifier is the unique key assigned by the user when the Aurora global database was created. In other words, it's the name of the Aurora global database that you want to fail over.

Constraints:

• Must match the identifier of an existing GlobalCluster (Aurora global database).

pub fn target_db_cluster_identifier(self, input: impl Into<String>) -> Self

Identifier of the secondary Aurora DB cluster that you want to promote to primary for the Aurora global database (GlobalCluster.) Use the Amazon Resource Name (ARN) for the identifier so that Aurora can locate the cluster in its Amazon Web Services Region.

pub fn set_target_db_cluster_identifier(self, input: Option<String>) -> Self

Identifier of the secondary Aurora DB cluster that you want to promote to primary for the Aurora global database (GlobalCluster.) Use the Amazon Resource Name (ARN) for the identifier so that Aurora can locate the cluster in its Amazon Web Services Region.

Trait Implementations

impl Clone for FailoverGlobalCluster

fn clone(&self) -> FailoverGlobalCluster

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for FailoverGlobalCluster

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.