AWS::MemoryDB::Cluster

MemoryDB Cluster

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

Properties

29 configurable properties. 3 required. Click a row to see details.

Filter:

Property	Type	Flags
`ACLName`	`string`	Required
`ClusterName`	`string`	RequiredCreate-only
`NodeType`	`string`	Required
`AutoMinorVersionUpgrade`	`boolean`
`ClusterEndpoint`	`Endpoint`
`DataTiering`	`string`	Create-only
`Description`	`string`
`Engine`	`string`
`EngineVersion`	`string`
`FinalSnapshotName`	`string`	Write-only
`IpDiscovery`	`string`
`KmsKeyId`	`string`	Create-only
`MaintenanceWindow`	`string`
`MultiRegionClusterName`	`string`	Create-onlyWrite-only
`NetworkType`	`string`	Create-only
`NumReplicasPerShard`	`integer`
`NumShards`	`integer`
`ParameterGroupName`	`string`
`Port`	`integer`	Create-only
`SecurityGroupIds`	`Array<string>`
`SnapshotArns`	`Array<string>`	Create-onlyWrite-only
`SnapshotName`	`string`	Create-onlyWrite-only
`SnapshotRetentionLimit`	`integer`
`SnapshotWindow`	`string`
`SnsTopicArn`	`string`
`SnsTopicStatus`	`string`
`SubnetGroupName`	`string`	Create-only
`Tags`	`Array<Tag>`
`TLSEnabled`	`boolean`	Create-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 cluster.
`ParameterGroupStatus`	`string`	The status of the parameter group used by the cluster.
`Status`	`string`	The status of the 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::Cluster

Resources:
  MyResource:
    Type: AWS::MemoryDB::Cluster
    Properties:
      ClusterName: "my-clustername"
      NodeType: "value"
      ACLName: "my-aclname"
      Tags:
        - Key: Environment
          Value: Production
      Description: !Ref "AWS::StackName"

Required IAM Permissions

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

create

kms:DescribeKeykms:CreateGrantmemorydb:CreateClustermemorydb:DescribeClustersmemorydb:TagResourcememorydb:ListTagsiam:CreateServiceLinkedRole

read

memorydb:DescribeClustersmemorydb:ListTags

update

memorydb:UpdateClustermemorydb:DescribeClustersmemorydb:ListTagsmemorydb:TagResourcememorydb:UntagResource

delete

memorydb:DeleteClustermemorydb:DescribeClusters

list

memorydb:DescribeClusters

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

Properties32

Required3

TaggingSupported

Primary IDClusterName

Supported Operations

CreateReadUpdateDeleteList

Immutable After Creation

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

ClusterNameTLSEnabledDataTieringKmsKeyIdPortSubnetGroupNameSnapshotArnsMultiRegionClusterNameSnapshotNameNetworkType

Related Resources

External Links

AWS Documentation