AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

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.

Note:

For .NET Core this operation is only available in asynchronous form. Please refer to RebootCacheClusterAsync.

Namespace: Amazon.ElastiCache
Assembly: AWSSDK.ElastiCache.dll
Version: 3.x.y.z

Syntax

C#
public abstract RebootCacheClusterResponse RebootCacheCluster(
         RebootCacheClusterRequest request
)

Parameters

request
Type: Amazon.ElastiCache.Model.RebootCacheClusterRequest

Container for the necessary parameters to execute the RebootCacheCluster service method.

Return Value


The response from the RebootCacheCluster service method, as returned by ElastiCache.

Exceptions

ExceptionCondition
CacheClusterNotFoundException The requested cluster ID does not refer to an existing cluster.
InvalidCacheClusterStateException The requested cluster is not in the available state.

Examples

Reboots the specified nodes in the names cluster.

RebootCacheCluster


var client = new AmazonElastiCacheClient();
var response = client.RebootCacheCluster(new RebootCacheClusterRequest 
{
    CacheClusterId = "custom-mem1-4  ",
    CacheNodeIdsToReboot = new List<string> {
        "0001",
        "0002"
    }
});

CacheCluster cacheCluster = response.CacheCluster;

            

Version Information

.NET Framework:
Supported in: 4.5, 4.0, 3.5

See Also