AWS Fundamentals Logo
AWS Fundamentals
L1 ConstructAWS::ElastiCache::GlobalReplicationGroup

CfnGlobalReplicationGroup

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.

Import

import { CfnGlobalReplicationGroup } from 'aws-cdk-lib/aws-elasticache';

Or use the module namespace:

import * as elasticache from 'aws-cdk-lib/aws-elasticache';
// elasticache.CfnGlobalReplicationGroup

Properties

Configuration passed to the constructor as CfnGlobalReplicationGroupProps.

membersRequired
IResolvable | IResolvable | GlobalReplicationGroupMemberProperty[]

The replication groups that comprise the Global datastore.

automaticFailoverEnabledOptional
boolean | IResolvable

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.

cacheNodeTypeOptional
string

The cache node type of the Global datastore.

cacheParameterGroupNameOptional
string

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.

engineOptional
string

The ElastiCache engine. For Valkey or Redis OSS only.

engineVersionOptional
string

The Elasticache Valkey or Redis OSS engine version.

globalNodeGroupCountOptional
number

The number of node groups that comprise the Global Datastore.

globalReplicationGroupDescriptionOptional
string

The optional description of the Global datastore.

globalReplicationGroupIdSuffixOptional
string

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

regionalConfigurationsOptional
IResolvable | IResolvable | RegionalConfigurationProperty[]

The Regions that comprise the Global Datastore.

CloudFormation Resource

This L1 construct maps directly to the following CloudFormation resource type.

AWS::ElastiCache::GlobalReplicationGroupView in CloudFormation Explorer

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

LevelL1 (CloudFormation)
Moduleaws-elasticache
CFN TypeAWS::ElastiCache::GlobalReplicationGroup
Properties10

Related Constructs

Explore This Service

External Links