GlobalReplicationGroup - Amazon ElastiCache
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.

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.

Contents

Note

In the following list, the required parameters are described first.

ARN

The ARN (Amazon Resource Name) of the global replication group.

Type: String

Required: No

AtRestEncryptionEnabled

A flag that enables encryption at rest when set to true.

You cannot modify the value of AtRestEncryptionEnabled after the replication group is created. To enable encryption at rest on a replication group you must set AtRestEncryptionEnabled to true when you create the replication group.

Required: Only available when creating a replication group in an Amazon VPC using redis version 3.2.6, 4.x or later.

Type: Boolean

Required: No

AuthTokenEnabled

A flag that enables using an AuthToken (password) when issuing Redis commands.

Default: false

Type: Boolean

Required: No

CacheNodeType

The cache node type of the Global datastore

Type: String

Required: No

ClusterEnabled

A flag that indicates whether the Global datastore is cluster enabled.

Type: Boolean

Required: No

Engine

The Elasticache engine. For Redis only.

Type: String

Required: No

EngineVersion

The Elasticache Redis engine version.

Type: String

Required: No

GlobalNodeGroups.GlobalNodeGroup.N

Indicates the slot configuration and global identifier for each slice group.

Type: Array of GlobalNodeGroup objects

Required: No

GlobalReplicationGroupDescription

The optional description of the Global datastore

Type: String

Required: No

GlobalReplicationGroupId

The name of the Global datastore

Type: String

Required: No

Members.GlobalReplicationGroupMember.N

The replication groups that comprise the Global datastore.

Type: Array of GlobalReplicationGroupMember objects

Required: No

Status

The status of the Global datastore

Type: String

Required: No

TransitEncryptionEnabled

A flag that enables in-transit encryption when set to true. You cannot modify the value of TransitEncryptionEnabled after the cluster is created. To enable in-transit encryption on a cluster you must set TransitEncryptionEnabled to true when you create a cluster.

Required: Only available when creating a replication group in an Amazon VPC using redis version 3.2.6, 4.x or later.

Type: Boolean

Required: No

See Also

For more information about using this API in one of the language-specific Amazon SDKs, see the following: