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.

Container for the parameters to the RebootCacheCluster operation. 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.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.ElastiCache.AmazonElastiCacheRequest
      Amazon.ElastiCache.Model.RebootCacheClusterRequest

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

Syntax

C#
public class RebootCacheClusterRequest : AmazonElastiCacheRequest
         IAmazonWebServiceRequest

The RebootCacheClusterRequest type exposes the following members

Constructors

NameDescription
Public Method RebootCacheClusterRequest()

Empty constructor used to set properties independently even when a simple constructor is available

Public Method RebootCacheClusterRequest(string, List<String>)

Instantiates RebootCacheClusterRequest with the parameterized properties

Properties

NameTypeDescription
Public Property CacheClusterId System.String

Gets and sets the property CacheClusterId.

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

Public Property CacheNodeIdsToReboot System.Collections.Generic.List<System.String>

Gets and sets the property CacheNodeIdsToReboot.

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.

Examples

Reboots the specified nodes in the names cluster.

RebootCacheCluster


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

CacheCluster cacheCluster = response.CacheCluster;

            

Version Information

.NET Standard:
Supported in: 1.3

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

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms