Struct aws_sdk_docdb::client::fluent_builders::FailoverDBCluster

pub struct FailoverDBCluster { /* private fields */ }

Fluent builder constructing a request to FailoverDBCluster.

Forces a failover for a cluster.

A failover for a cluster promotes one of the Amazon DocumentDB replicas (read-only instances) in the cluster to be the primary instance (the cluster writer).

If the primary instance fails, Amazon DocumentDB automatically fails over to an Amazon DocumentDB replica, if one exists. You can force a failover when you want to simulate a failure of a primary instance for testing.

Implementations

impl FailoverDBCluster

pub async fn customize(
    self
) -> Result<CustomizableOperation<FailoverDBCluster, AwsResponseRetryClassifier>, SdkError<FailoverDBClusterError>>

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<FailoverDbClusterOutput, SdkError<FailoverDBClusterError>>

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 db_cluster_identifier(self, input: impl Into<String>) -> Self

A cluster identifier to force a failover for. This parameter is not case sensitive.

Constraints:

• Must match the identifier of an existing DBCluster.

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

A cluster identifier to force a failover for. This parameter is not case sensitive.

Constraints:

• Must match the identifier of an existing DBCluster.

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

The name of the instance to promote to the primary instance.

You must specify the instance identifier for an Amazon DocumentDB replica in the cluster. For example, mydbcluster-replica1.

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

The name of the instance to promote to the primary instance.

You must specify the instance identifier for an Amazon DocumentDB replica in the cluster. For example, mydbcluster-replica1.

Trait Implementations

impl Clone for FailoverDBCluster

fn clone(&self) -> FailoverDBCluster

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for FailoverDBCluster

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

Formats the value using the given formatter.