GET

/#Action=DecreaseNodeGroupsInGlobalReplicationGroup

http://elasticache.{region}.amazonaws.com/#Action=DecreaseNodeGroupsInGlobalReplicationGroup

Decreases the number of node groups in a Global datastore

Access Token Required: API Key

Query Params

GlobalReplicationGroupIdstringrequired

The name of the Global datastore

NodeGroupCountintegerrequired

The number of node groups (shards) that results from the modification of the shard configuration

GlobalNodeGroupsToRemovearray

If the value of NodeGroupCount is less than the current number of node groups (shards), then either NodeGroupsToRemove or NodeGroupsToRetain is required. GlobalNodeGroupsToRemove is a list of NodeGroupIds to remove from the cluster. ElastiCache for Redis will attempt to remove all node groups listed by GlobalNodeGroupsToRemove from the cluster.

GlobalNodeGroupsToRetainarray

If the value of NodeGroupCount is less than the current number of node groups (shards), then either NodeGroupsToRemove or NodeGroupsToRetain is required. GlobalNodeGroupsToRetain is a list of NodeGroupIds to retain from the cluster. ElastiCache for Redis will attempt to retain all node groups listed by GlobalNodeGroupsToRetain from the cluster.

ApplyImmediatelybooleanrequired

Indicates that the shard reconfiguration process begins immediately. At present, the only permitted value for this parameter is true.

Actionstringrequired

Allowed:

Versionstringrequired

Allowed:

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request GET \
2     --url 'http://elasticache.{region}.amazonaws.com/#Action=DecreaseNodeGroupsInGlobalReplicationGroup' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}