UpdateMultiRegionCluster
Updates the configuration of an existing multi-Region cluster.
Request Syntax
{
"Description": "string",
"EngineVersion": "string",
"MultiRegionClusterName": "string",
"MultiRegionParameterGroupName": "string",
"NodeType": "string",
"ShardConfiguration": {
"ShardCount": number
},
"UpdateStrategy": "string"
}Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- Description
-
A new description for the multi-Region cluster.
Type: String
Required: No
- EngineVersion
-
The new engine version to be used for the multi-Region cluster.
Type: String
Required: No
- MultiRegionClusterName
-
The name of the multi-Region cluster to be updated.
Type: String
Required: Yes
- MultiRegionParameterGroupName
-
The new multi-Region parameter group to be associated with the cluster.
Type: String
Required: No
- NodeType
-
The new node type to be used for the multi-Region cluster.
Type: String
Required: No
- ShardConfiguration
-
A request to configure the sharding properties of a cluster
Type: ShardConfigurationRequest object
Required: No
- UpdateStrategy
-
The strategy to use for the update operation. Supported values are "coordinated" or "uncoordinated".
Type: String
Valid Values:
coordinated | uncoordinatedRequired: No
Response Syntax
{
"MultiRegionCluster": {
"ARN": "string",
"Clusters": [
{
"ARN": "string",
"ClusterName": "string",
"Region": "string",
"Status": "string"
}
],
"Description": "string",
"Engine": "string",
"EngineVersion": "string",
"MultiRegionClusterName": "string",
"MultiRegionParameterGroupName": "string",
"NodeType": "string",
"NumberOfShards": number,
"Status": "string",
"TLSEnabled": boolean
}
}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.
- MultiRegionCluster
-
The status of updating the multi-Region cluster.
Type: MultiRegionCluster object
Errors
For information about the errors that are common to all actions, see Common Errors.
- InvalidMultiRegionClusterStateFault
-
The requested operation cannot be performed on the multi-Region cluster in its current state.
HTTP Status Code: 400
- InvalidParameterCombinationException
-
HTTP Status Code: 400
- InvalidParameterValueException
-
HTTP Status Code: 400
- MultiRegionClusterNotFoundFault
-
The specified multi-Region cluster does not exist.
HTTP Status Code: 400
- MultiRegionParameterGroupNotFoundFault
-
The specified multi-Region parameter group does not exist.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
