Struct aws_sdk_docdb::operation::failover_db_cluster::builders::FailoverDBClusterFluentBuilder
source · pub struct FailoverDBClusterFluentBuilder { /* 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§
source§impl FailoverDBClusterFluentBuilder
impl FailoverDBClusterFluentBuilder
sourcepub fn as_input(&self) -> &FailoverDbClusterInputBuilder
pub fn as_input(&self) -> &FailoverDbClusterInputBuilder
Access the FailoverDBCluster as a reference.
sourcepub async fn send(
self
) -> Result<FailoverDbClusterOutput, SdkError<FailoverDBClusterError, HttpResponse>>
pub async fn send( self ) -> Result<FailoverDbClusterOutput, SdkError<FailoverDBClusterError, HttpResponse>>
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 customize(
self
) -> CustomizableOperation<FailoverDbClusterOutput, FailoverDBClusterError, Self>
pub fn customize( self ) -> CustomizableOperation<FailoverDbClusterOutput, FailoverDBClusterError, Self>
Consumes this builder, creating a customizable operation that can be modified before being sent.
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 get_db_cluster_identifier(&self) -> &Option<String>
pub fn get_db_cluster_identifier(&self) -> &Option<String>
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.
sourcepub fn get_target_db_instance_identifier(&self) -> &Option<String>
pub fn get_target_db_instance_identifier(&self) -> &Option<String>
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§
source§impl Clone for FailoverDBClusterFluentBuilder
impl Clone for FailoverDBClusterFluentBuilder
source§fn clone(&self) -> FailoverDBClusterFluentBuilder
fn clone(&self) -> FailoverDBClusterFluentBuilder
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreAuto Trait Implementations§
impl Freeze for FailoverDBClusterFluentBuilder
impl !RefUnwindSafe for FailoverDBClusterFluentBuilder
impl Send for FailoverDBClusterFluentBuilder
impl Sync for FailoverDBClusterFluentBuilder
impl Unpin for FailoverDBClusterFluentBuilder
impl !UnwindSafe for FailoverDBClusterFluentBuilder
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> Instrument for T
impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
source§impl<T> IntoEither for T
impl<T> IntoEither for T
source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moresource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read more