[ aws . elasticache ]
Global Datastore for Redis offers fully managed, fast, reliable and secure cross-region replication. Using Global Datastore for Redis, you can create cross-region read replica clusters for ElastiCache for Redis to enable low-latency reads and disaster recovery across regions. For more information, see Replication Across Regions Using Global Datastore .
The GlobalReplicationGroupIdSuffix is the name of the Global datastore.
The PrimaryReplicationGroupId represents the name of the primary cluster that accepts writes and will replicate updates to the secondary cluster.
See also: AWS API Documentation
See ‘aws help’ for descriptions of global parameters.
create-global-replication-group
--global-replication-group-id-suffix <value>
[--global-replication-group-description <value>]
--primary-replication-group-id <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
--global-replication-group-id-suffix
(string)
The suffix name of a Global datastore. Amazon ElastiCache automatically applies a prefix to the Global datastore ID when it is created. Each Amazon Region has its own prefix. For instance, a Global datastore ID created in the US-West-1 region will begin with “dsdfu” along with the suffix name you provide. The suffix, combined with the auto-generated prefix, guarantees uniqueness of the Global datastore name across multiple regions.
For a full list of Amazon Regions and their respective Global datastore iD prefixes, see Using the Amazon CLI with Global datastores .
--global-replication-group-description
(string)
Provides details of the Global datastore
--primary-replication-group-id
(string)
The name of the primary cluster that accepts writes and will replicate updates to the secondary cluster.
--cli-input-json
| --cli-input-yaml
(string)
Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton
. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml
.
--generate-cli-skeleton
(string)
Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input
, prints a sample input JSON that can be used as an argument for --cli-input-json
. Similarly, if provided yaml-input
it will print a sample input YAML that can be used with --cli-input-yaml
. If provided with the value output
, it validates the command inputs and returns a sample output JSON for that command.
See ‘aws help’ for descriptions of global parameters.
To create a global replication group
The following create-global-replication-group
example creates a new global replication group.
aws elasticache create-global-replication-group \
--global-replication-group-id-suffix my-global-replication-group \
--primary-replication-group-id my-primary-cluster
Output:
{
"GlobalReplicationGroup": {
"GlobalReplicationGroupId": "sgaui-my-global-replication-group",
"GlobalReplicationGroupDescription": " ",
"Status": "creating",
"CacheNodeType": "cache.r5.large",
"Engine": "redis",
"EngineVersion": "5.0.6",
"Members": [
{
"ReplicationGroupId": "my-primary-cluster",
"ReplicationGroupRegion": "us-west-2",
"Role": "PRIMARY",
"AutomaticFailover": "enabled",
"Status": "associating"
}
],
"ClusterEnabled": true,
"GlobalNodeGroups": [
{
"GlobalNodeGroupId": "sgaui-my-global-replication-group-0001",
"Slots": "0-16383"
}
],
"AuthTokenEnabled": false,
"TransitEncryptionEnabled": false,
"AtRestEncryptionEnabled": false
}
}
For more information, see Replication Across AWS Regions Using Global Datastore in the Elasticache User Guide.
GlobalReplicationGroup -> (structure)
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.
GlobalReplicationGroupId -> (string)
The name of the Global datastore
GlobalReplicationGroupDescription -> (string)
The optional description of the Global datastore
Status -> (string)
The status of the Global datastore
CacheNodeType -> (string)
The cache node type of the Global datastore
Engine -> (string)
The Elasticache engine. For Redis only.
EngineVersion -> (string)
The Elasticache Redis engine version.
Members -> (list)
The replication groups that comprise the Global datastore.
(structure)
A member of a Global datastore. It contains the Replication Group Id, the Amazon region and the role of the replication group.
ReplicationGroupId -> (string)
The replication group id of the Global datastore member.
ReplicationGroupRegion -> (string)
The Amazon region of the Global datastore member.
Role -> (string)
Indicates the role of the replication group, primary or secondary.
AutomaticFailover -> (string)
Indicates whether automatic failover is enabled for the replication group.
Status -> (string)
The status of the membership of the replication group.
ClusterEnabled -> (boolean)
A flag that indicates whether the Global datastore is cluster enabled.
GlobalNodeGroups -> (list)
Indicates the slot configuration and global identifier for each slice group.
(structure)
Indicates the slot configuration and global identifier for a slice group.
GlobalNodeGroupId -> (string)
The name of the global node group
Slots -> (string)
The keyspace for this node group
AuthTokenEnabled -> (boolean)
A flag that enables using an
AuthToken
(password) when issuing Redis commands.Default:
false
TransitEncryptionEnabled -> (boolean)
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 setTransitEncryptionEnabled
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.AtRestEncryptionEnabled -> (boolean)
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 setAtRestEncryptionEnabled
totrue
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.ARN -> (string)
The ARN (Amazon Resource Name) of the global replication group.