AWS::MemoryDB::MultiRegionCluster - Amazon CloudFormation
SyntaxPropertiesReturn values
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

This is the new Amazon CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the Amazon CloudFormation User Guide.

AWS::MemoryDB::MultiRegionCluster

Represents a multi-Region cluster.

Syntax

To declare this entity in your Amazon CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::MemoryDB::MultiRegionCluster",
  "Properties" : {
      "Description" : String,
      "Engine" : String,
      "EngineVersion" : String,
      "MultiRegionClusterNameSuffix" : String,
      "MultiRegionParameterGroupName" : String,
      "NodeType" : String,
      "NumShards" : Integer,
      "Tags" : [ Tag, ... ],
      "TLSEnabled" : Boolean,
      "UpdateStrategy" : String
    }
}

YAML

Type: AWS::MemoryDB::MultiRegionCluster
Properties:
  Description: String
  Engine: String
  EngineVersion: String
  MultiRegionClusterNameSuffix: String
  MultiRegionParameterGroupName: String
  NodeType: String
  NumShards: Integer
  Tags: 
    - Tag
  TLSEnabled: Boolean
  UpdateStrategy: String

Properties

Description

The description of the multi-Region cluster.

Required: No

Type: String

Update requires: No interruption

Engine

The name of the engine used by the multi-Region cluster.

Required: No

Type: String

Update requires: No interruption

EngineVersion

The version of the engine used by the multi-Region cluster.

Required: No

Type: String

Update requires: Replacement

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.

Required: No

Type: String

Pattern: [a-z][a-z0-9\-]*

Update requires: Replacement

MultiRegionParameterGroupName

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

Required: No

Type: String

Update requires: Replacement

NodeType

The node type used by the multi-Region cluster.

Required: Yes

Type: String

Update requires: No interruption

NumShards

The number of shards in the multi-Region cluster.

Required: No

Type: Integer

Update requires: No interruption

Tags

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

Required: No

Type: Array of Tag

Maximum: 50

Update requires: No interruption

TLSEnabled

Indiciates if the multi-Region cluster is TLS enabled.

Required: No

Type: Boolean

Update requires: Replacement

UpdateStrategy

The strategy to use for the update operation. Supported values are "coordinated" or "uncoordinated".

Required: No

Type: String

Allowed values: COORDINATED | UNCOORDINATED

Update requires: No interruption

Return values

Ref

Fn::GetAtt

ARN

The Amazon Resource Name (ARN) of the multi-Region cluster.

MultiRegionClusterName

The name of the multi-Region cluster.

Status

The current status of the multi-Region cluster.