Scaling down a single-node Redis cluster (Console)Scaling down single-node Redis cache clusters (AWS CLI)Scaling down single-node Redis cache clusters (ElastiCache API)

Scaling down single-node Redis clusters

The following sections walk you through how to scale a single-node Redis cluster down to a smaller node type. Ensuring that the new, smaller node type is large enough to accommodate all the data and Redis overhead is important to the long-term success of your new Redis cluster. For more information, see Ensuring that you have enough memory to create a Redis snapshot.

Note

For clusters running the r6gd node type, you can only scale to node sizes within the r6gd node family.

Topics

Scaling down a single-node Redis cluster (Console)
Scaling down single-node Redis cache clusters (AWS CLI)
Scaling down single-node Redis cache clusters (ElastiCache API)

Scaling down a single-node Redis cluster (Console)

The following procedure walks you through scaling your single-node Redis cluster down to a smaller node type using the ElastiCache console.

Important

If your parameter group uses reserved-memory to set aside memory for Redis overhead, before you begin scaling be sure that you have a custom parameter group that reserves the correct amount of memory for your new node type. Alternatively, you can modify a custom parameter group so that it uses reserved-memory-percent and use that parameter group for your new cluster.

If you're using reserved-memory-percent, doing this is not necessary.

For more information, see Managing Reserved Memory.

To scale down your single-node Redis cluster (console)

Ensure that the smaller node type is adequate for your data and overhead needs.
If your parameter group uses reserved-memory to set aside memory for Redis overhead, ensure that you have a custom parameter group to set aside the correct amount of memory for your new node type.

Alternatively, you can modify your custom parameter group to use reserved-memory-percent. For more information, see Managing Reserved Memory.
Sign in to the AWS Management Console and open the ElastiCache console at https://console.aws.amazon.com/elasticache/.
From the list of clusters, choose the cluster you want to scale down. This cluster must be running the Redis engine and not the Clustered Redis engine.
Choose Modify.
In the Modify Cluster wizard:
1. Choose the node type you want to scale down to from the Node type list.
2. If you're using reserved-memory to manage your memory, from the Parameter Group list, choose the custom parameter group that reserves the correct amount of memory for your new node type.
If you want to perform the scale-down process right away, choose the Apply immediately check box. If the Apply immediately check box is left not chosen, the scale-down process is performed during this cluster's next maintenance window.
Choose Modify.
When the cluster’s status changes from modifying to available, your cluster has scaled to the new node type. There is no need to update the endpoints in your application.

Scaling down single-node Redis cache clusters (AWS CLI)

The following procedure describes how to scale down a single-node Redis cache cluster using the AWS CLI.

To scale down a single-node Redis cache cluster (AWS CLI)

Determine the node types you can scale down to by running the AWS CLI list-allowed-node-type-modifications command with the following parameter.

--cache-cluster-id

For Linux, macOS, or Unix:


aws elasticache list-allowed-node-type-modifications \
	    --cache-cluster-id my-cache-cluster-id

For Windows:


aws elasticache list-allowed-node-type-modifications ^
	    --cache-cluster-id my-cache-cluster-id

Output from the above command looks something like this (JSON format).


{
	    "ScaleUpModifications": [
	        "cache.m3.2xlarge", 
	        "cache.m3.large", 
	        "cache.m3.xlarge", 
	        "cache.m4.10xlarge", 
	        "cache.m4.2xlarge", 
	        "cache.m4.4xlarge", 
	        "cache.m4.large", 
	        "cache.m4.xlarge", 
	        "cache.r3.2xlarge", 
	        "cache.r3.4xlarge", 
	        "cache.r3.8xlarge", 
	        "cache.r3.large", 
	        "cache.r3.xlarge"
	    ]
	       "ScaleDownModifications": [
	        "cache.t2.micro", 
	        "cache.t2.small ", 
	        "cache.t2.medium ",
            "cache.t1.small ",
	    ], 

	}

For more information, see list-allowed-node-type-modifications in the AWS CLI Reference.

Modify your existing cache cluster specifying the cache cluster to scale down and the new, smaller node type, using the AWS CLI modify-cache-cluster command and the following parameters.

--cache-cluster-id – The name of the cache cluster you are scaling down.
--cache-node-type – The new node type you want to scale the cache cluster. This value must be one of the node types returned by the list-allowed-node-type-modifications command in step 1.
--cache-parameter-group-name – [Optional] Use this parameter if you are using reserved-memory to manage your cluster's reserved memory. Specify a custom cache parameter group that reserves the correct amount of memory for your new node type. If you are using reserved-memory-percent you can omit this parameter.
--apply-immediately – Causes the scale-down process to be applied immediately. To postpone the scale-up process to the cluster's next maintenance window, use the --no-apply-immediately parameter.

For Linux, macOS, or Unix:


aws elasticache modify-cache-cluster \
	    --cache-cluster-id my-redis-cache-cluster \
	    --cache-node-type cache.m3.xlarge \
	    --cache-parameter-group-name redis32-m2-xl \
	    --apply-immediately

For Windows:


aws elasticache modify-cache-cluster ^
	    --cache-cluster-id my-redis-cache-cluster ^
	    --cache-node-type cache.m3.xlarge ^
	    --cache-parameter-group-name redis32-m2-xl ^
	    --apply-immediately

Output from the above command looks something like this (JSON format).


{
	    "CacheCluster": {
	        "Engine": "redis", 
	        "CacheParameterGroup": {
	            "CacheNodeIdsToReboot": [], 
	            "CacheParameterGroupName": "default.redis6,x", 
	            "ParameterApplyStatus": "in-sync"
	        }, 
	        "SnapshotRetentionLimit": 1, 
	        "CacheClusterId": "my-redis-cache-cluster", 
	        "CacheSecurityGroups": [], 
	        "NumCacheNodes": 1, 
	        "SnapshotWindow": "00:00-01:00", 
	        "CacheClusterCreateTime": "2017-02-21T22:34:09.645Z", 
	        "AutoMinorVersionUpgrade": true, 
	        "CacheClusterStatus": "modifying", 
	        "PreferredAvailabilityZone": "us-west-2a", 
	        "ClientDownloadLandingPage": "https://console.aws.amazon.com/elasticache/home#client-download:", 
	        "CacheSubnetGroupName": "default", 
	        "EngineVersion": "6.0", 
	        "PendingModifiedValues": {
	            "CacheNodeType": "cache.m3.2xlarge"
	        }, 
	        "PreferredMaintenanceWindow": "tue:11:30-tue:12:30", 
	        "CacheNodeType": "cache.m3.medium",
	         "DataTiering": "disabled"
	    }
	}

For more information, see modify-cache-cluster in the AWS CLI Reference.

If you used the --apply-immediately, check the status of the new cache cluster using the AWS CLI describe-cache-clusters command with the following parameter. When the status changes to available, you can begin using the new, larger cache cluster.
- --cache-cache cluster-id – The name of your single-node Redis cache cluster. Use this parameter to describe a particular cache cluster rather than all cache clusters.
```
aws elasticache describe-cache-clusters --cache-cluster-id my-redis-cache-cluster
```
For more information, see describe-cache-clusters in the AWS CLI Reference.

Scaling down single-node Redis cache clusters (ElastiCache API)

The following procedure describes how to scale updown a single-node Redis cache cluster using the ElastiCache API.

To scale down a single-node Redis cache cluster (ElastiCache API)

Determine the node types you can scale down to by running the ElastiCache API ListAllowedNodeTypeModifications action with the following parameter.
- CacheClusterId – The name of the single-node Redis cache cluster you want to scale down.
```
https://elasticache.us-west-2.amazonaws.com/
	   ?Action=ListAllowedNodeTypeModifications
	   &CacheClusterId=MyRedisCacheCluster
	   &Version=2015-02-02
	   &SignatureVersion=4
	   &SignatureMethod=HmacSHA256
	   &Timestamp=20150202T192317Z
	   &X-Amz-Credential=<credential>
```
For more information, see ListAllowedNodeTypeModifications in the Amazon ElastiCache API Reference.
Modify your existing cache cluster specifying the cache cluster to scale up and the new, larger node type, using the ModifyCacheCluster ElastiCache API action and the following parameters.
- CacheClusterId – The name of the cache cluster you are scaling down.
- CacheNodeType – The new, smaller node type you want to scale the cache cluster down to. This value must be one of the node types returned by the ListAllowedNodeTypeModifications action in step 1.
- CacheParameterGroupName – [Optional] Use this parameter if you are using reserved-memory to manage your cluster's reserved memory. Specify a custom cache parameter group that reserves the correct amount of memory for your new node type. If you are using reserved-memory-percent you can omit this parameter.
- ApplyImmediately – Set to true to cause the scale-down process to be performed immediately. To postpone the scale-up process to the cluster's next maintenance window, use ApplyImmediately=false.
```
https://elasticache.us-west-2.amazonaws.com/
	   ?Action=ModifyCacheCluster
	   &ApplyImmediately=true
	   &CacheClusterId=MyRedisCacheCluster
	   &CacheNodeType=cache.m3.xlarge
	   &CacheParameterGroupName redis32-m2-xl
	   &Version=2015-02-02
	   &SignatureVersion=4
	   &SignatureMethod=HmacSHA256
	   &Timestamp=20150202T192317Z
	   &X-Amz-Credential=<credential>
```
For more information, see ModifyCacheCluster in the Amazon ElastiCache API Reference.
If you used ApplyImmediately=true, check the status of the new cache cluster using the ElastiCache API DescribeCacheClusters action with the following parameter. When the status changes to available, you can begin using the new, smaller cache cluster.
- CacheClusterId – The name of your single-node Redis cache cluster. Use this parameter to describe a particular cache cluster rather than all cache clusters.
```
https://elasticache.us-west-2.amazonaws.com/
	   ?Action=DescribeCacheClusters
	   &CacheClusterId=MyRedisCacheCluster
	   &Version=2015-02-02
	   &SignatureVersion=4
	   &SignatureMethod=HmacSHA256
	   &Timestamp=20150202T192317Z
	   &X-Amz-Credential=<credential>
```
For more information, see DescribeCacheClusters in the Amazon ElastiCache API Reference.

Warning Javascript is disabled or is unavailable in your browser.

To use the Amazon Web Services Documentation, Javascript must be enabled. Please refer to your browser's Help pages for instructions.

Document Conventions

Scaling up single-node Redis clusters

Scaling Redis (Cluster Mode Disabled) clusters with replica nodes