DecreaseNodeGroupsInGlobalReplicationGroup - Amazon ElastiCache

DecreaseNodeGroupsInGlobalReplicationGroup

Decreases the number of node groups in a Global Datastore

Request Parameters

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

ApplyImmediately

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

Type: Boolean

Required: Yes

GlobalReplicationGroupId

The name of the Global Datastore

Type: String

Required: Yes

NodeGroupCount

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

Type: Integer

Required: Yes

GlobalNodeGroupsToRemove.GlobalNodeGroupId.N

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

Type: Array of strings

Required: No

GlobalNodeGroupsToRetain.GlobalNodeGroupId.N

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

Type: Array of strings

Required: No

Response Elements

The following element is returned by the service.

GlobalReplicationGroup

Consists of a primary cluster that accepts writes and an associated secondary cluster that resides in a different AWS region. The secondary cluster accepts only reads. The primary cluster automatically replicates updates to the secondary cluster.

  • The GlobalReplicationGroupIdSuffix represents the name of the Global Datastore, which is what you use to associate a secondary cluster.

Type: GlobalReplicationGroup object

Errors

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

GlobalReplicationGroupNotFoundFault

The Global Datastore does not exist

HTTP Status Code: 404

InvalidGlobalReplicationGroupState

The Global Datastore is not available or in primary-only state.

HTTP Status Code: 400

InvalidParameterCombination

Two or more incompatible parameters were specified.

HTTP Status Code: 400

InvalidParameterValue

The value for a parameter is invalid.

HTTP Status Code: 400

See Also

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