AWS::MemoryDB::Cluster - 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::Cluster

Specifies a cluster. All nodes in the cluster run the same protocol-compliant engine software.

Syntax

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

JSON

{
  "Type" : "AWS::MemoryDB::Cluster",
  "Properties" : {
      "ACLName" : String,
      "AutoMinorVersionUpgrade" : Boolean,
      "ClusterEndpoint" : Endpoint,
      "ClusterName" : String,
      "DataTiering" : String,
      "Description" : String,
      "Engine" : String,
      "EngineVersion" : String,
      "FinalSnapshotName" : String,
      "IpDiscovery" : String,
      "KmsKeyId" : String,
      "MaintenanceWindow" : String,
      "MultiRegionClusterName" : String,
      "NetworkType" : String,
      "NodeType" : String,
      "NumReplicasPerShard" : Integer,
      "NumShards" : Integer,
      "ParameterGroupName" : String,
      "Port" : Integer,
      "SecurityGroupIds" : [ String, ... ],
      "SnapshotArns" : [ String, ... ],
      "SnapshotName" : String,
      "SnapshotRetentionLimit" : Integer,
      "SnapshotWindow" : String,
      "SnsTopicArn" : String,
      "SnsTopicStatus" : String,
      "SubnetGroupName" : String,
      "Tags" : [ Tag, ... ],
      "TLSEnabled" : Boolean
    }
}

YAML

Type: AWS::MemoryDB::Cluster
Properties:
  ACLName: String
  AutoMinorVersionUpgrade: Boolean
  ClusterEndpoint: 
    Endpoint
  ClusterName: String
  DataTiering: String
  Description: String
  Engine: String
  EngineVersion: String
  FinalSnapshotName: String
  IpDiscovery: String
  KmsKeyId: String
  MaintenanceWindow: String
  MultiRegionClusterName: String
  NetworkType: String
  NodeType: String
  NumReplicasPerShard: Integer
  NumShards: Integer
  ParameterGroupName: String
  Port: Integer
  SecurityGroupIds: 
    - String
  SnapshotArns: 
    - String
  SnapshotName: String
  SnapshotRetentionLimit: Integer
  SnapshotWindow: String
  SnsTopicArn: String
  SnsTopicStatus: String
  SubnetGroupName: String
  Tags: 
    - Tag
  TLSEnabled: Boolean

Properties

ACLName

The name of the Access Control List to associate with the cluster.

Required: Yes

Type: String

Pattern: [a-zA-Z][a-zA-Z0-9\-]*

Update requires: No interruption

AutoMinorVersionUpgrade

When set to true, the cluster will automatically receive minor engine version upgrades after launch.

Required: No

Type: Boolean

Update requires: No interruption

ClusterEndpoint

The cluster's configuration endpoint.

Required: No

Type: Endpoint

Update requires: No interruption

ClusterName

The name of the cluster.

Required: Yes

Type: String

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

Update requires: Replacement

DataTiering

Enables data tiering. Data tiering is only supported for clusters using the r6gd node type. This parameter must be set when using r6gd nodes. For more information, see Data tiering.

Required: No

Type: String

Allowed values: true | false

Update requires: Replacement

Description

A description of the cluster.

Required: No

Type: String

Update requires: No interruption

Engine

The name of the engine used by the cluster.

Required: No

Type: String

Update requires: No interruption

EngineVersion

The Redis engine version used by the cluster.

Required: No

Type: String

Update requires: No interruption

FinalSnapshotName

The user-supplied name of a final cluster snapshot. This is the unique name that identifies the snapshot. MemoryDB creates the snapshot, and then deletes the cluster immediately afterward.

Required: No

Type: String

Update requires: No interruption

IpDiscovery

The mechanism that the cluster uses to discover IP addresses. Returns 'ipv4' when DNS endpoints resolve to IPv4 addresses, or 'ipv6' when DNS endpoints resolve to IPv6 addresses.

Required: No

Type: String

Allowed values: ipv4 | ipv6

Update requires: No interruption

KmsKeyId

The ID of the KMS key used to encrypt the cluster.

Required: No

Type: String

Update requires: Replacement

MaintenanceWindow

Specifies the weekly time range during which maintenance on the cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period.

Pattern: ddd:hh24:mi-ddd:hh24:mi

Required: No

Type: String

Update requires: No interruption

MultiRegionClusterName

The name of the multi-Region cluster that this cluster belongs to.

Required: No

Type: String

Update requires: Replacement

NetworkType

The IP address type for the cluster. Returns 'ipv4' for IPv4 only, 'ipv6' for IPv6 only, or 'dual-stack' if the cluster supports both IPv4 and IPv6 addressing.

Required: No

Type: String

Allowed values: ipv4 | ipv6 | dual_stack

Update requires: Replacement

NodeType

The cluster's node type.

Required: Yes

Type: String

Update requires: No interruption

NumReplicasPerShard

The number of replicas to apply to each shard.

Default value: 1

Maximum value: 5

Required: No

Type: Integer

Update requires: No interruption

NumShards

The number of shards in the cluster.

Required: No

Type: Integer

Update requires: No interruption

ParameterGroupName

The name of the parameter group used by the cluster.

Required: No

Type: String

Update requires: No interruption

Port

The port used by the cluster.

Required: No

Type: Integer

Update requires: Replacement

SecurityGroupIds

A list of security group names to associate with this cluster.

Required: No

Type: Array of String

Update requires: No interruption

SnapshotArns

A list of Amazon Resource Names (ARN) that uniquely identify the RDB snapshot files stored in Amazon S3. The snapshot files are used to populate the new cluster. The Amazon S3 object name in the ARN cannot contain any commas.

Required: No

Type: Array of String

Update requires: Replacement

SnapshotName

The name of a snapshot from which to restore data into the new cluster. The snapshot status changes to restoring while the new cluster is being created.

Required: No

Type: String

Update requires: Replacement

SnapshotRetentionLimit

The number of days for which MemoryDB retains automatic snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, a snapshot that was taken today is retained for 5 days before being deleted.

Required: No

Type: Integer

Update requires: No interruption

SnapshotWindow

The daily time range (in UTC) during which MemoryDB begins taking a daily snapshot of your shard. Example: 05:00-09:00 If you do not specify this parameter, MemoryDB automatically chooses an appropriate time range.

Required: No

Type: String

Update requires: No interruption

SnsTopicArn

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the ARN of the SNS topic, such as arn:aws:memorydb:us-east-1:123456789012:mySNSTopic

Required: No

Type: String

Update requires: No interruption

SnsTopicStatus

The SNS topic must be in Active status to receive notifications.

Required: No

Type: String

Update requires: No interruption

SubnetGroupName

The name of the subnet group used by the cluster.

Required: No

Type: String

Update requires: Replacement

Tags

An array of key-value pairs to apply to this resource.

For more information, see Tag.

Required: No

Type: Array of Tag

Maximum: 50

Update requires: No interruption

TLSEnabled

A flag to indicate if In-transit encryption is enabled.

Required: No

Type: Boolean

Update requires: Replacement

Return values

Fn::GetAtt

ARN

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the ARN of the cluster, such as arn:aws:memorydb:us-east-1:123456789012:cluster/my-cluster

ClusterEndpoint.Address

The address of the cluster's configuration endpoint.

ClusterEndpoint.Port

The port used by the cluster configuration endpoint.

ParameterGroupStatus

The status of the parameter group used by the cluster, for example active or applying.

Status

The status of the cluster. For example, 'available', 'updating' or 'creating'.