Menu
Amazon DynamoDB
API Reference

DecreaseReplicationFactor

Removes one or more nodes from a DAX cluster.

Note

You cannot use DecreaseReplicationFactor to remove the last node in a DAX cluster. If you need to do this, use DeleteCluster instead.

Request Syntax

{ "AvailabilityZones": [ "string" ], "ClusterName": "string", "NewReplicationFactor": number, "NodeIdsToRemove": [ "string" ] }

Request Parameters

The request accepts the following data in JSON format.

Note

In the following list, the required parameters are described first.

ClusterName

The name of the DAX cluster from which you want to remove nodes.

Type: String

Required: Yes

NewReplicationFactor

The new number of nodes for the DAX cluster.

Type: Integer

Required: Yes

AvailabilityZones

The Availability Zone(s) from which to remove nodes.

Type: Array of strings

Required: No

NodeIdsToRemove

The unique identifiers of the nodes to be removed from the cluster.

Type: Array of strings

Required: No

Response Syntax

{ "Cluster": { "ActiveNodes": number, "ClusterArn": "string", "ClusterDiscoveryEndpoint": { "Address": "string", "Port": number }, "ClusterName": "string", "Description": "string", "IamRoleArn": "string", "NodeIdsToRemove": [ "string" ], "Nodes": [ { "AvailabilityZone": "string", "Endpoint": { "Address": "string", "Port": number }, "NodeCreateTime": number, "NodeId": "string", "NodeStatus": "string", "ParameterGroupStatus": "string" } ], "NodeType": "string", "NotificationConfiguration": { "TopicArn": "string", "TopicStatus": "string" }, "ParameterGroup": { "NodeIdsToReboot": [ "string" ], "ParameterApplyStatus": "string", "ParameterGroupName": "string" }, "PreferredMaintenanceWindow": "string", "SecurityGroups": [ { "SecurityGroupIdentifier": "string", "Status": "string" } ], "Status": "string", "SubnetGroup": "string", "TotalNodes": number } }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

Cluster

A description of the DAX cluster, after you have decreased its replication factor.

Type: Cluster object

Errors

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

ClusterNotFoundFault

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

HTTP Status Code: 400

InvalidClusterStateFault

The requested DAX cluster is not in the available state.

HTTP Status Code: 400

InvalidParameterCombinationException

Two or more incompatible parameters were specified.

HTTP Status Code: 400

InvalidParameterValueException

The value for a parameter is invalid.

HTTP Status Code: 400

NodeNotFoundFault

None of the nodes in the cluster have the given node ID.

HTTP Status Code: 400

See Also

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