AWS::ElastiCache::GlobalReplicationGroup - AWS CloudFormation
SyntaxPropertiesReturn values

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

AWS::ElastiCache::GlobalReplicationGroup

Consists of a primary cluster that accepts writes and an associated secondary cluster that resides in a different Amazon region. The secondary cluster accepts only reads. The primary cluster automatically replicates updates to the secondary cluster.

  • The GlobalReplicationGroupIdSuffix represents the name of the Global datastore, which is what you use to associate a secondary cluster.

Syntax

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

JSON

{
  "Type" : "AWS::ElastiCache::GlobalReplicationGroup",
  "Properties" : {
      "AutomaticFailoverEnabled" : Boolean,
      "CacheNodeType" : String,
      "CacheParameterGroupName" : String,
      "Engine" : String,
      "EngineVersion" : String,
      "GlobalNodeGroupCount" : Integer,
      "GlobalReplicationGroupDescription" : String,
      "GlobalReplicationGroupIdSuffix" : String,
      "Members" : [ GlobalReplicationGroupMember, ... ],
      "RegionalConfigurations" : [ RegionalConfiguration, ... ]
    }
}

Properties

AutomaticFailoverEnabled

Specifies whether a read-only replica is automatically promoted to read/write primary if the existing primary fails.

AutomaticFailoverEnabled must be enabled for Valkey or Redis OSS (cluster mode enabled) replication groups.

Required: No

Type: Boolean

Update requires: No interruption

CacheNodeType

The cache node type of the Global datastore

Required: No

Type: String

Update requires: No interruption

CacheParameterGroupName

The name of the cache parameter group to use with the Global datastore. It must be compatible with the major engine version used by the Global datastore.

Required: No

Type: String

Update requires: No interruption

Engine

The ElastiCache engine. For Valkey or Redis OSS only.

Required: No

Type: String

Update requires: No interruption

EngineVersion

The Elasticache Valkey or Redis OSS engine version.

Required: No

Type: String

Update requires: No interruption

GlobalNodeGroupCount

The number of node groups that comprise the Global Datastore.

Required: No

Type: Integer

Update requires: No interruption

GlobalReplicationGroupDescription

The optional description of the Global datastore

Required: No

Type: String

Update requires: No interruption

GlobalReplicationGroupIdSuffix

The suffix name of a Global Datastore. The suffix guarantees uniqueness of the Global Datastore name across multiple regions.

Required: No

Type: String

Update requires: No interruption

Members

The replication groups that comprise the Global datastore.

Required: Yes

Type: Array of GlobalReplicationGroupMember

Minimum: 1

Update requires: No interruption

RegionalConfigurations

The Regions that comprise the Global Datastore.

Required: No

Type: Array of RegionalConfiguration

Update requires: No interruption

Return values

Ref

Fn::GetAtt

GlobalReplicationGroupId

The ID used to associate a secondary cluster to the Global Replication Group.

Status

The status of the Global Datastore. Can be Creating, Modifying, Available, Deleting or Primary-Only. Primary-only status indicates the global datastore contains only a primary cluster. Either all secondary clusters are deleted or not successfully created.