ElastiCache / Client / modify_global_replication_group

modify_global_replication_group#

ElastiCache.Client.modify_global_replication_group(**kwargs)#

Modifies the settings for a Global datastore.

Request Syntax

response = client.modify_global_replication_group(
    GlobalReplicationGroupId='string',
    ApplyImmediately=True|False,
    CacheNodeType='string',
    Engine='string',
    EngineVersion='string',
    CacheParameterGroupName='string',
    GlobalReplicationGroupDescription='string',
    AutomaticFailoverEnabled=True|False
)

Parameters:

GlobalReplicationGroupId (string) –
[REQUIRED]

The name of the Global datastore
ApplyImmediately (boolean) –
[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 (string) – A valid cache node type that you want to scale this Global datastore to.
Engine (string) – Modifies the engine listed in a global replication group message. The options are redis, memcached or valkey.
EngineVersion (string) – The upgraded version of the cache engine to be run on the clusters in the Global datastore.
CacheParameterGroupName (string) – 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 (string) – A description of the Global datastore
AutomaticFailoverEnabled (boolean) – Determines whether a read replica is automatically promoted to read/write primary if the existing primary encounters a failure.

Return type:

dict

Returns:

Response Syntax

{
    'GlobalReplicationGroup': {
        'GlobalReplicationGroupId': 'string',
        'GlobalReplicationGroupDescription': 'string',
        'Status': 'string',
        'CacheNodeType': 'string',
        'Engine': 'string',
        'EngineVersion': 'string',
        'Members': [
            {
                'ReplicationGroupId': 'string',
                'ReplicationGroupRegion': 'string',
                'Role': 'string',
                'AutomaticFailover': 'enabled'|'disabled'|'enabling'|'disabling',
                'Status': 'string'
            },
        ],
        'ClusterEnabled': True|False,
        'GlobalNodeGroups': [
            {
                'GlobalNodeGroupId': 'string',
                'Slots': 'string'
            },
        ],
        'AuthTokenEnabled': True|False,
        'TransitEncryptionEnabled': True|False,
        'AtRestEncryptionEnabled': True|False,
        'ARN': 'string'
    }
}

Response Structure

(dict) –
- GlobalReplicationGroup (dict) –
  
  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 Valkey or Redis OSS only.
  - EngineVersion (string) –
    
    The ElastiCache engine version.
  - Members (list) –
    
    The replication groups that comprise the Global datastore.
    - (dict) –
      
      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.
    - (dict) –
      
      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 Valkey or Redis OSS commands.
    
    Default: false
  - TransitEncryptionEnabled (boolean) –
    
    A flag that enables in-transit encryption when set to true.
    
    Required: Only available when creating a replication group in an Amazon VPC using Redis OSS 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 OSS version 3.2.6, 4.x or later.
  - ARN (string) –
    
    The ARN (Amazon Resource Name) of the global replication group.

Exceptions

ElastiCache.Client.exceptions.GlobalReplicationGroupNotFoundFault
ElastiCache.Client.exceptions.InvalidGlobalReplicationGroupStateFault
ElastiCache.Client.exceptions.InvalidParameterValueException