Reboots a single node of a DAX cluster. The reboot action takes place as soon as possible. During the reboot, the node status is set to REBOOTING.
Note
RebootNode restarts the DAX engine process and does not remove the
contents of the cache.
Request Syntax
{
"ClusterName": "string",
"NodeId": "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 containing the node to be rebooted.
Type: String
Required: Yes
- NodeId
-
The system-assigned ID of the node to be rebooted.
Type: String
Required: Yes
Response Syntax
{
"Cluster": {
"ActiveNodes": number,
"ClusterArn": "string",
"ClusterDiscoveryEndpoint": {
"Address": "string",
"Port": number,
"URL": "string"
},
"ClusterEndpointEncryptionType": "string",
"ClusterName": "string",
"Description": "string",
"IamRoleArn": "string",
"NodeIdsToRemove": [ "string" ],
"Nodes": [
{
"AvailabilityZone": "string",
"Endpoint": {
"Address": "string",
"Port": number,
"URL": "string"
},
"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"
}
],
"SSEDescription": {
"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.
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
- ServiceLinkedRoleNotFoundFault
-
The specified service linked role (SLR) was not found.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
