Using global datastores (CLI) - Amazon ElastiCache (Redis OSS)
Downloading and configuring the Amazon CLIUsing the Amazon CLI with global datastores
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).

Using global datastores (CLI)

You can use the Amazon Command Line Interface (Amazon CLI) to control multiple Amazon services from the command line and automate them through scripts. You can use the Amazon CLI for ad hoc (one-time) operations.

Downloading and configuring the Amazon CLI

The Amazon CLI runs on Windows, macOS, or Linux. Use the following procedure to download and configure it.

To download, install, and configure the CLI

  1. Download the Amazon CLI on the Amazon command line interface webpage.

  2. Follow the instructions for Installing the Amazon CLI and Configuring the Amazon CLI in the Amazon Command Line Interface User Guide.

Using the Amazon CLI with global datastores

Use the following CLI operations to work with global datastores:

  • create-global-replication-group

    aws elasticache create-global-replication-group \
   --global-replication-group-id-suffix my global datastore  \
   --primary-replication-group-id sample-repl-group  \
   --global-replication-group-description an optional description of the 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 (N. California) Region begins with "virxk" along with the suffix name that you provide. The suffix, combined with the autogenerated prefix, guarantees uniqueness of the global datastore name across multiple Regions.

    The following table lists each Amazon Region and its global datastore ID prefix.

    Region Name/Region Prefix

    US East (Ohio) Region

    us-east-2

    fpkhr

    US East (N. Virginia) Region

    us-east-1

    ldgnf

    US West (N. California) Region

    us-west-1

    virxk

    US West (Oregon) Region

    us-west-2

    sgaui

    Canada (Central) Region

    ca-central-1

    bxodz

    Asia Pacific (Mumbai) Region

    ap-south-1

    erpgt

    Asia Pacific (Tokyo) Region

    ap-northeast-1

    quwsw

    Asia Pacific (Seoul) Region

    ap-northeast-2

    lfqnh

    Asia Pacific (Osaka) Region

    ap-northeast-3

    nlapn

    Asia Pacific (Singapore) Region

    ap-southeast-1

    vlqxn

    Asia Pacific (Sydney) Region

    ap-southeast-2

    vbgxd

    Europe (Frankfurt) Region

    eu-central-1

    iudkw

    Europe (Ireland) Region

    eu-west-1

    gxeiz

    Europe (London) Region

    eu-west-2

    okuqm

    EU (Paris) Region

    eu-west-3

    fgjhi

    South America (São Paulo) Region

    sa-east-1

    juxlw

    China (Beijing) Region

    cn-north-1

    emvgo

    China (Ningxia) Region

    cn-northwest-1

    ckbem

    Asia Pacific (Hong Kong) Region

    ap-east-1

    knjmp

    Amazon GovCloud (US-West)

    us-gov-west-1

    		 sgwui

  • create-replication-group – Use this operation to create secondary clusters for a global datastore by supplying the name of the global datastore to the --global-replication-group-id parameter.

    aws elasticache create-replication-group \
  --replication-group-id secondary replication group name \
  --replication-group-description “Replication group description" \
  --global-replication-group-id global datastore name

    When calling this operation and passing in a --global-replication-group-id value, ElastiCache (Redis OSS) will infer the values from the primary replication group of the global replication group for the following paramaeters. Do not pass in values for these parameters:

    "PrimaryClusterId",

    "AutomaticFailoverEnabled",

    "NumNodeGroups",

    "CacheParameterGroupName",

    "CacheNodeType",

    "Engine",

    "EngineVersion",

    "CacheSecurityGroupNames",

    "EnableTransitEncryption",

    "AtRestEncryptionEnabled",

    "SnapshotArns",

    "SnapshotName"

  • describe-global-replication-groups

    aws elasticache describe-global-replication-groups \
   --global-replication-group-id my global datastore  \
   --show-member-info an optional parameter that returns a list of the primary and secondary clusters that make up the global datastore

  • modify-global-replication-group

    aws elasticache modify-global-replication-group \
   --global-replication-group-id my global datastore  \
   --automatic-failover-enabled \
   --cache-node-type node type \
   --cache-parameter-group-name parameter group name \ 
   --engine-version engine version \
   -—apply-immediately \
   --global-replication-group-description description

  • delete-global-replication-group

    aws elasticache delete-global-replication-group \
   --global-replication-group-id my global datastore  \
   --retain-primary-replication-group defaults to true

  • disassociate-global-replication-group

    aws elasticache disassociate-global-replication-group \
   --global-replication-group-id my global datastore  \
   --replication-group-id my secondary cluster  \
   --replication-group-region the Amazon Region in which the secondary cluster resides

  • failover-global-replication-group

    aws elasticache failover-replication-group \
   --global-replication-group-id my global datastore \
   --primary-region The Amazon Region of the primary cluster \  
   --primary-replication-group-id  The name of the global datastore, including the suffix.

  • increase-node-groups-in-global-replication-group

    aws elasticache increase-node-groups-in-global-replication-group \
   --apply-immediately yes \
   --global-replication-group-id global-replication-group-name \
   --node-group-count 3

  • decrease-node-groups-in-global-replication-group

    aws elasticache decrease-node-groups-in-global-replication-group \
   --apply-immediately yes \
   --global-replication-group-id global-replication-group-name \
   --node-group-count 3

  • rebalance-shards-in-global-replication-group

    aws elasticache rebalance-shards-in-global-replication-group \
   --apply-immediately yes \
   --global-replication-group-id global-replication-group-name

Use help to list all available commands ElastiCache (Redis OSS).

aws elasticache help

You can also use help to describe a specific command and learn more about its usage: 

aws elasticache create-global-replication-group help