pub struct DeleteReplicationGroup { /* private fields */ }
Expand description
Fluent builder constructing a request to DeleteReplicationGroup
.
Deletes an existing replication group. By default, this operation deletes the entire replication group, including the primary/primaries and all of the read replicas. If the replication group has only one primary, you can optionally delete only the read replicas, while retaining the primary by setting RetainPrimaryCluster=true
.
When you receive a successful response from this operation, Amazon ElastiCache immediately begins deleting the selected resources; you cannot cancel or revert this operation.
This operation is valid for Redis only.
Implementations
sourceimpl DeleteReplicationGroup
impl DeleteReplicationGroup
sourcepub async fn send(
self
) -> Result<DeleteReplicationGroupOutput, SdkError<DeleteReplicationGroupError>>
pub async fn send(
self
) -> Result<DeleteReplicationGroupOutput, SdkError<DeleteReplicationGroupError>>
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 replication_group_id(self, input: impl Into<String>) -> Self
pub fn replication_group_id(self, input: impl Into<String>) -> Self
The identifier for the cluster to be deleted. This parameter is not case sensitive.
sourcepub fn set_replication_group_id(self, input: Option<String>) -> Self
pub fn set_replication_group_id(self, input: Option<String>) -> Self
The identifier for the cluster to be deleted. This parameter is not case sensitive.
sourcepub fn retain_primary_cluster(self, input: bool) -> Self
pub fn retain_primary_cluster(self, input: bool) -> Self
If set to true
, all of the read replicas are deleted, but the primary node is retained.
sourcepub fn set_retain_primary_cluster(self, input: Option<bool>) -> Self
pub fn set_retain_primary_cluster(self, input: Option<bool>) -> Self
If set to true
, all of the read replicas are deleted, but the primary node is retained.
sourcepub fn final_snapshot_identifier(self, input: impl Into<String>) -> Self
pub fn final_snapshot_identifier(self, input: impl Into<String>) -> Self
The name of a final node group (shard) snapshot. ElastiCache creates the snapshot from the primary node in the cluster, rather than one of the replicas; this is to ensure that it captures the freshest data. After the final snapshot is taken, the replication group is immediately deleted.
sourcepub fn set_final_snapshot_identifier(self, input: Option<String>) -> Self
pub fn set_final_snapshot_identifier(self, input: Option<String>) -> Self
The name of a final node group (shard) snapshot. ElastiCache creates the snapshot from the primary node in the cluster, rather than one of the replicas; this is to ensure that it captures the freshest data. After the final snapshot is taken, the replication group is immediately deleted.
Trait Implementations
sourceimpl Clone for DeleteReplicationGroup
impl Clone for DeleteReplicationGroup
sourcefn clone(&self) -> DeleteReplicationGroup
fn clone(&self) -> DeleteReplicationGroup
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 DeleteReplicationGroup
impl Send for DeleteReplicationGroup
impl Sync for DeleteReplicationGroup
impl Unpin for DeleteReplicationGroup
impl !UnwindSafe for DeleteReplicationGroup
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
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> 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