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
Amazon.Runtime.AmazonWebServiceRequest
Amazon.ElastiCache.AmazonElastiCacheRequest
Amazon.ElastiCache.Model.RebootCacheClusterRequest
Namespace: Amazon.ElastiCache.Model
Assembly: AWSSDK.ElastiCache.dll
Version: 3.x.y.z
Syntax
public class RebootCacheClusterRequest : AmazonElastiCacheRequest IAmazonWebServiceRequest
The RebootCacheClusterRequest type exposes the following members
Constructors
| Name | Description | |
|---|---|---|
|
RebootCacheClusterRequest() |
Empty constructor used to set properties independently even when a simple constructor is available |
|
|
RebootCacheClusterRequest(string, List<String>) |
Instantiates RebootCacheClusterRequest with the parameterized properties |
Properties
| Name | Type | Description | |
|---|---|---|---|
|
|
CacheClusterId | System.String |
Gets and sets the property CacheClusterId. The cluster identifier. This parameter is stored as a lowercase string. |
|
|
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 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 Core App:
Supported in: 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5, 4.0, 3.5