AWS::MemoryDB::MultiRegionCluster

MemoryDB MultiRegionCluster

The AWS::MemoryDB::Multi Region Cluster resource creates an Amazon MemoryDB Multi Region Cluster.

Properties

10 configurable properties. 1 required. Click a row to see details.

Filter:

Property	Type	Flags
`NodeType`	`string`	Required
`Description`	`string`
`Engine`	`string`
`EngineVersion`	`string`	Create-only
`MultiRegionClusterNameSuffix`	`string`	Create-onlyWrite-only
`MultiRegionParameterGroupName`	`string`	Create-only
`NumShards`	`integer`
`Tags`	`Array<Tag>`
`TLSEnabled`	`boolean`	Create-only
`UpdateStrategy`	`string`	Write-only

Return Values

Values returned after the resource is created. Access these with Fn::GetAtt.

Attribute	Type	Description
`ARN`	`string`	The Amazon Resource Name (ARN) of the multi region cluster.
`MultiRegionClusterName`	`string`	The name of the Global Datastore, it is generated by MemoryDB adding a prefix to MultiRegionClusterNameSuffix.
`Status`	`string`	The status of the multi region cluster. For example, Available, Updating, Creating.

Sample CloudFormation Template

A minimal template with required properties and common optional ones.

template.yaml

AWSTemplateFormatVersion: "2010-09-09"
Description: Sample template for AWS::MemoryDB::MultiRegionCluster

Resources:
  MyResource:
    Type: AWS::MemoryDB::MultiRegionCluster
    Properties:
      NodeType: "value"
      Tags:
        - Key: Environment
          Value: Production
      Description: !Ref "AWS::StackName"

Required IAM Permissions

Permissions CloudFormation needs in your IAM role to manage this resource.

create

memorydb:CreateMultiRegionClustermemorydb:DescribeMultiRegionClustersmemorydb:TagResourcememorydb:ListTagsiam:CreateServiceLinkedRole

read

memorydb:DescribeMultiRegionClustersmemorydb:ListTags

update

memorydb:UpdateMultiRegionClustermemorydb:DescribeMultiRegionClustersmemorydb:ListTagsmemorydb:TagResourcememorydb:UntagResource

delete

memorydb:DeleteMultiRegionClustermemorydb:DescribeMultiRegionClusters

list

memorydb:DescribeMultiRegionClusters

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter

Quick Facts

ServiceMemoryDB

Properties13

Required1

TaggingSupported

Primary IDMultiRegionClusterName

Supported Operations

CreateReadUpdateDeleteList

Immutable After Creation

These properties cannot be changed after the resource is created. Updating them triggers a replacement.

MultiRegionClusterNameSuffixEngineVersionMultiRegionParameterGroupNameTLSEnabled

Related Resources

External Links

AWS Documentation