Struct aws_sdk_elasticache::client::fluent_builders::RebootCacheCluster

pub struct RebootCacheCluster { /* private fields */ }

Fluent builder constructing a request to RebootCacheCluster.

Reboots some, or all, of the cache nodes within a provisioned cluster. This operation applies any modified cache parameter groups to the cluster. The reboot operation takes place as soon as possible, and results in a momentary outage to the cluster. During the reboot, the cluster status is set to REBOOTING.

The reboot causes the contents of the cache (for each cache node being rebooted) to be lost.

When the reboot is complete, a cluster event is created.

Rebooting a cluster is currently supported on Memcached and Redis (cluster mode disabled) clusters. Rebooting is not supported on Redis (cluster mode enabled) clusters.

If you make changes to parameters that require a Redis (cluster mode enabled) cluster reboot for the changes to be applied, see Rebooting a Cluster for an alternate process.

Implementations

impl RebootCacheCluster

pub async fn customize(
    self
) -> Result<CustomizableOperation<RebootCacheCluster, AwsResponseRetryClassifier>, SdkError<RebootCacheClusterError>>

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<RebootCacheClusterOutput, SdkError<RebootCacheClusterError>>

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

The cluster identifier. This parameter is stored as a lowercase string.

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

The cluster identifier. This parameter is stored as a lowercase string.

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

Appends an item to CacheNodeIdsToReboot.

To override the contents of this collection use set_cache_node_ids_to_reboot.

A list of cache node IDs to reboot. A node ID is a numeric identifier (0001, 0002, etc.). To reboot an entire cluster, specify all of the cache node IDs.

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

A list of cache node IDs to reboot. A node ID is a numeric identifier (0001, 0002, etc.). To reboot an entire cluster, specify all of the cache node IDs.

Trait Implementations

impl Clone for RebootCacheCluster

fn clone(&self) -> RebootCacheCluster

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RebootCacheCluster

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

Formats the value using the given formatter.