Failover Global Replication Group

elasticache_failover_global_replication_group

R Documentation

Used to failover the primary region to a secondary region

Description

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

Usage

elasticache_failover_global_replication_group(GlobalReplicationGroupId,
  PrimaryRegion, PrimaryReplicationGroupId)

Arguments

GlobalReplicationGroupId

[required] The name of the Global datastore

PrimaryRegion

[required] The Amazon region of the primary cluster of the Global datastore

PrimaryReplicationGroupId

[required] The name of the primary replication group

Value

A list with the following syntax:

list(
  GlobalReplicationGroup = list(
    GlobalReplicationGroupId = "string",
    GlobalReplicationGroupDescription = "string",
    Status = "string",
    CacheNodeType = "string",
    Engine = "string",
    EngineVersion = "string",
    Members = list(
      list(
        ReplicationGroupId = "string",
        ReplicationGroupRegion = "string",
        Role = "string",
        AutomaticFailover = "enabled"|"disabled"|"enabling"|"disabling",
        Status = "string"
      )
    ),
    ClusterEnabled = TRUE|FALSE,
    GlobalNodeGroups = list(
      list(
        GlobalNodeGroupId = "string",
        Slots = "string"
      )
    ),
    AuthTokenEnabled = TRUE|FALSE,
    TransitEncryptionEnabled = TRUE|FALSE,
    AtRestEncryptionEnabled = TRUE|FALSE,
    ARN = "string"
  )
)

Request syntax

svc$failover_global_replication_group(
  GlobalReplicationGroupId = "string",
  PrimaryRegion = "string",
  PrimaryReplicationGroupId = "string"
)