Skip to content

List Allowed Node Type Modifications

elasticache_list_allowed_node_type_modifications R Documentation

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

Description

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

When you use the modify_cache_cluster or modify_replication_group 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.

Usage

elasticache_list_allowed_node_type_modifications(CacheClusterId,
  ReplicationGroupId)

Arguments

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.

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

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.

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

Value

A list with the following syntax:

list(
  ScaleUpModifications = list(
    "string"
  ),
  ScaleDownModifications = list(
    "string"
  )
)

Request syntax

svc$list_allowed_node_type_modifications(
  CacheClusterId = "string",
  ReplicationGroupId = "string"
)

Examples

## Not run: 
# Lists all available node types that you can scale your Redis cluster's
# or replication group's current node type up to.
svc$list_allowed_node_type_modifications(
  ReplicationGroupId = "myreplgroup"
)

# Lists all available node types that you can scale your Redis cluster's
# or replication group's current node type up to.
svc$list_allowed_node_type_modifications(
  CacheClusterId = "mycluster"
)

## End(Not run)