ListAllowedNodeTypeModifications - Amazon ElastiCache
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

ListAllowedNodeTypeModifications

Lists all available node types that you can scale your Redis cluster's or replication group's current node type.

When you use the ModifyCacheCluster or ModifyReplicationGroup operations to scale your cluster or replication group, the value of the CacheNodeType parameter must be one of the node types returned by this operation.

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

CacheClusterId

The name of the cluster you want to scale up to a larger node instanced type. ElastiCache uses the cluster id to identify the current node type of this cluster and from that to create a list of node types you can scale up to.

Important

You must provide a value for either the CacheClusterId or the ReplicationGroupId.

Type: String

Required: No

ReplicationGroupId

The name of the replication group want to scale up to a larger node type. ElastiCache uses the replication group id to identify the current node type being used by this replication group, and from that to create a list of node types you can scale up to.

Important

You must provide a value for either the CacheClusterId or the ReplicationGroupId.

Type: String

Required: No

Response Elements

The following elements are returned by the service.

ScaleDownModifications.member.N

A string list, each element of which specifies a cache node type which you can use to scale your cluster or replication group. When scaling down a Redis cluster or replication group using ModifyCacheCluster or ModifyReplicationGroup, use a value from this list for the CacheNodeType parameter.

Type: Array of strings

ScaleUpModifications.member.N

A string list, each element of which specifies a cache node type which you can use to scale your cluster or replication group.

When scaling up a Redis cluster or replication group using ModifyCacheCluster or ModifyReplicationGroup, use a value from this list for the CacheNodeType parameter.

Type: Array of strings

Errors

For information about the errors that are common to all actions, see Common Errors.

CacheClusterNotFound

The requested cluster ID does not refer to an existing cluster.

HTTP Status Code: 404

InvalidParameterCombination

Two or more incompatible parameters were specified.

HTTP Status Code: 400

InvalidParameterValue

The value for a parameter is invalid.

HTTP Status Code: 400

ReplicationGroupNotFoundFault

The specified replication group does not exist.

HTTP Status Code: 404

Examples

ListAllowedNodeTypeModifications for a Cluster

The following example request a list of node types you can use to scale myCluster up.

Sample Request

https://elasticache.us-east-1.amazonaws.com/ ?Action=ListAllowedNodeTypeModifications &CacheClusterId=mycachecluster &SignatureVersion=4 &SignatureMethod=HmacSHA256 &Version=2015-02-02 &Timestamp=20150202T192317Z &X-Amz-Credential=<credential>

ListAllowedNodeTypeModifications for a Replication Group

The following example requests a list of node types you can use to scale myReplGroup up.

Sample Request

https://elasticache.us-east-1.amazonaws.com/ ?Action=ListAllowedNodeTypeModifications &ReplicationGroupId=myreplgroup &SignatureVersion=4 &SignatureMethod=HmacSHA256 &Version=2015-02-02 &Timestamp=20150202T192317Z &X-Amz-Credential=<credential>

See Also

For more information about using this API in one of the language-specific Amazon SDKs, see the following: