- Navigation GuideYou are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.
CreateMultiRegionClusterCommand
Creates a new multi-Region cluster.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { MemoryDBClient, CreateMultiRegionClusterCommand } from "@aws-sdk/client-memorydb"; // ES Modules import
// const { MemoryDBClient, CreateMultiRegionClusterCommand } = require("@aws-sdk/client-memorydb"); // CommonJS import
const client = new MemoryDBClient(config);
const input = { // CreateMultiRegionClusterRequest
MultiRegionClusterNameSuffix: "STRING_VALUE", // required
Description: "STRING_VALUE",
Engine: "STRING_VALUE",
EngineVersion: "STRING_VALUE",
NodeType: "STRING_VALUE", // required
MultiRegionParameterGroupName: "STRING_VALUE",
NumShards: Number("int"),
TLSEnabled: true || false,
Tags: [ // TagList
{ // Tag
Key: "STRING_VALUE",
Value: "STRING_VALUE",
},
],
};
const command = new CreateMultiRegionClusterCommand(input);
const response = await client.send(command);
// { // CreateMultiRegionClusterResponse
// MultiRegionCluster: { // MultiRegionCluster
// MultiRegionClusterName: "STRING_VALUE",
// Description: "STRING_VALUE",
// Status: "STRING_VALUE",
// NodeType: "STRING_VALUE",
// Engine: "STRING_VALUE",
// EngineVersion: "STRING_VALUE",
// NumberOfShards: Number("int"),
// Clusters: [ // RegionalClusterList
// { // RegionalCluster
// ClusterName: "STRING_VALUE",
// Region: "STRING_VALUE",
// Status: "STRING_VALUE",
// ARN: "STRING_VALUE",
// },
// ],
// MultiRegionParameterGroupName: "STRING_VALUE",
// TLSEnabled: true || false,
// ARN: "STRING_VALUE",
// },
// };
CreateMultiRegionClusterCommand Input
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
MultiRegionClusterNameSuffix Required | string | undefined | A suffix to be added to the multi-Region cluster name. |
NodeType Required | string | undefined | The node type to be used for the multi-Region cluster. |
Description | string | undefined | A description for the multi-Region cluster. |
Engine | string | undefined | The name of the engine to be used for the multi-Region cluster. |
EngineVersion | string | undefined | The version of the engine to be used for the multi-Region cluster. |
MultiRegionParameterGroupName | string | undefined | The name of the multi-Region parameter group to be associated with the cluster. |
NumShards | number | undefined | The number of shards for the multi-Region cluster. |
TLSEnabled | boolean | undefined | Whether to enable TLS encryption for the multi-Region cluster. |
Tags | Tag[] | undefined | A list of tags to be applied to the multi-Region cluster. |
CreateMultiRegionClusterCommand Output
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
$metadata Required | ResponseMetadata | Metadata pertaining to this request. |
MultiRegionCluster | MultiRegionCluster | undefined | Details about the newly created multi-Region cluster. |
Throws
Name | Fault | Details |
---|
Name | Fault | Details |
---|---|---|
ClusterQuotaForCustomerExceededFault | client | |
InvalidParameterCombinationException | client | |
InvalidParameterValueException | client | |
MultiRegionClusterAlreadyExistsFault | client | A multi-Region cluster with the specified name already exists. |
MultiRegionParameterGroupNotFoundFault | client | The specified multi-Region parameter group does not exist. |
TagQuotaPerResourceExceeded | client | |
MemoryDBServiceException | Base exception class for all service exceptions from MemoryDB service. |