Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

CreateMultiRegionCluster

Creates a new multi-Region cluster.

Request Syntax


{
   "Description": "string",
   "Engine": "string",
   "EngineVersion": "string",
   "MultiRegionClusterNameSuffix": "string",
   "MultiRegionParameterGroupName": "string",
   "NodeType": "string",
   "NumShards": number,
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ],
   "TLSEnabled": boolean
}

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 description for the multi-Region cluster.

Type: String

Required: No

Engine

The name of the engine to be used for the multi-Region cluster.

Type: String

Required: No

EngineVersion

The version of the engine to be used for the multi-Region cluster.

Type: String

Required: No

MultiRegionClusterNameSuffix

A suffix to be added to the Multi-Region cluster name. Amazon MemoryDB automatically applies a prefix to the Multi-Region cluster Name when it is created. Each Amazon Region has its own prefix. For instance, a Multi-Region cluster Name created in the US-West-1 region will begin with "virxk", along with the suffix name you provide. The suffix guarantees uniqueness of the Multi-Region cluster name across multiple regions.

Type: String

Required: Yes

MultiRegionParameterGroupName

The name of the multi-Region parameter group to be associated with the cluster.

Type: String

Required: No

NodeType

The node type to be used for the multi-Region cluster.

Type: String

Required: Yes

NumShards

The number of shards for the multi-Region cluster.

Type: Integer

Required: No

Tags

A list of tags to be applied to the multi-Region cluster.

Type: Array of Tag objects

Array Members: Maximum number of 200 items.

Required: No

TLSEnabled

Whether to enable TLS encryption for the multi-Region cluster.

Type: Boolean

Required: 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

Details about the newly created multi-Region cluster.

Type: MultiRegionCluster object

Errors

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

ClusterQuotaForCustomerExceededFault

HTTP Status Code: 400

InvalidParameterCombinationException

HTTP Status Code: 400

InvalidParameterValueException

HTTP Status Code: 400

MultiRegionClusterAlreadyExistsFault

A multi-Region cluster with the specified name already exists.

HTTP Status Code: 400

MultiRegionParameterGroupNotFoundFault

The specified multi-Region parameter group does not exist.

HTTP Status Code: 400

TagQuotaPerResourceExceeded

HTTP Status Code: 400