Skip to content

Modify Global Replication Group

elasticache_modify_global_replication_group R Documentation

Modifies the settings for a Global datastore

Description

Modifies the settings for a Global datastore.

Usage

elasticache_modify_global_replication_group(GlobalReplicationGroupId,
  ApplyImmediately, CacheNodeType, EngineVersion, CacheParameterGroupName,
  GlobalReplicationGroupDescription, AutomaticFailoverEnabled)

Arguments

GlobalReplicationGroupId

[required] The name of the Global datastore

ApplyImmediately

[required] This parameter causes the modifications in this request and any pending modifications to be applied, asynchronously and as soon as possible. Modifications to Global Replication Groups cannot be requested to be applied in PreferredMaintenceWindow.

CacheNodeType

A valid cache node type that you want to scale this Global datastore to.

EngineVersion

The upgraded version of the cache engine to be run on the clusters in the Global datastore.

CacheParameterGroupName

The name of the cache parameter group to use with the Global datastore. It must be compatible with the major engine version used by the Global datastore.

GlobalReplicationGroupDescription

A description of the Global datastore

AutomaticFailoverEnabled

Determines whether a read replica is automatically promoted to read/write primary if the existing primary encounters a failure.

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$modify_global_replication_group(
  GlobalReplicationGroupId = "string",
  ApplyImmediately = TRUE|FALSE,
  CacheNodeType = "string",
  EngineVersion = "string",
  CacheParameterGroupName = "string",
  GlobalReplicationGroupDescription = "string",
  AutomaticFailoverEnabled = TRUE|FALSE
)