Struct aws_sdk_docdb::client::fluent_builders::FailoverDBCluster
source · [−]pub struct FailoverDBCluster { /* private fields */ }Expand description
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
sourceimpl FailoverDBCluster
impl FailoverDBCluster
sourcepub async fn send(
self
) -> Result<FailoverDbClusterOutput, SdkError<FailoverDBClusterError>>
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.
sourcepub fn db_cluster_identifier(self, input: impl Into<String>) -> Self
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.
sourcepub fn set_db_cluster_identifier(self, input: Option<String>) -> Self
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.
sourcepub fn target_db_instance_identifier(self, input: impl Into<String>) -> Self
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.
sourcepub fn set_target_db_instance_identifier(self, input: Option<String>) -> Self
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
sourceimpl Clone for FailoverDBCluster
impl Clone for FailoverDBCluster
sourcefn clone(&self) -> FailoverDBCluster
fn clone(&self) -> FailoverDBCluster
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read more
Auto Trait Implementations
impl !RefUnwindSafe for FailoverDBCluster
impl Send for FailoverDBCluster
impl Sync for FailoverDBCluster
impl Unpin for FailoverDBCluster
impl !UnwindSafe for FailoverDBCluster
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcepub fn borrow_mut(&mut self) -> &mut T
pub fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcepub fn to_owned(&self) -> T
pub fn to_owned(&self) -> T
Creates owned data from borrowed data, usually by cloning. Read more
sourcepub fn clone_into(&self, target: &mut T)
pub fn clone_into(&self, target: &mut T)
toowned_clone_into)Uses borrowed data to replace owned data, usually by cloning. Read more
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
Attaches the provided Subscriber to this type, returning a
WithDispatch wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber to this type, returning a
WithDispatch wrapper. Read more