[ aws . elasticache ]

failover-global-replication-group

Description

Used to failover the primary region to a selected secondary region. The selected secondary region will become primary, and all other clusters will become secondary.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  failover-global-replication-group
--global-replication-group-id <value>
--primary-region <value>
--primary-replication-group-id <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--global-replication-group-id (string)

The name of the Global Datastore

--primary-region (string)

The AWS region of the primary cluster of the Global Datastore

--primary-replication-group-id (string)

The name of the primary replication group

--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.

Output

GlobalReplicationGroup -> (structure)

Consists of a primary cluster that accepts writes and an associated secondary cluster that resides in a different AWS 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 AWS region and the role of the replication group.

ReplicationGroupId -> (string)

The replication group id of the Global Datastore member.

ReplicationGroupRegion -> (string)

The AWS 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 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.

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 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.

ARN -> (string)

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