allowed_node_type_modifications
Creates, updates, deletes, gets or lists an allowed_node_type_modifications resource.
Overview
| Name | allowed_node_type_modifications |
| Type | Resource |
| Id | aws.elasticache.allowed_node_type_modifications |
Fields
The following fields are returned by SELECT queries:
- list_allowed_node_type_modifications
| Name | Datatype | Description |
|---|---|---|
scale_down_modifications | array | 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 Valkey or Redis OSS cluster or replication group using ModifyCacheCluster or ModifyReplicationGroup, use a value from this list for the CacheNodeType parameter. |
scale_up_modifications | array | 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 Valkey or Redis OSS cluster or replication group using ModifyCacheCluster or ModifyReplicationGroup, use a value from this list for the CacheNodeType parameter. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
list_allowed_node_type_modifications | select | region | CacheClusterId, ReplicationGroupId | Lists all available node types that you can scale with your cluster's 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. |
Parameters
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
region | string | AWS region (default: us-east-1) |
CacheClusterId | string | 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. You must provide a value for either the CacheClusterId or the ReplicationGroupId. |
ReplicationGroupId | string | 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. You must provide a value for either the CacheClusterId or the ReplicationGroupId. |
SELECT examples
- list_allowed_node_type_modifications
Lists all available node types that you can scale with your cluster's 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.
SELECT
scale_down_modifications,
scale_up_modifications
FROM aws.elasticache.allowed_node_type_modifications
WHERE region = '{{ region }}' -- required
AND CacheClusterId = '{{ CacheClusterId }}'
AND ReplicationGroupId = '{{ ReplicationGroupId }}'
;