delete_global_replication_group¶

delete_global_replication_group(**kwargs)¶

Deleting a Global datastore is a two-step process:

First, you must DisassociateGlobalReplicationGroup to remove the secondary clusters in the Global datastore.
Once the Global datastore contains only the primary cluster, you can use the DeleteGlobalReplicationGroup API to delete the Global datastore while retainining the primary cluster using RetainPrimaryReplicationGroup=true .

Since the Global Datastore has only a primary cluster, you can delete the Global Datastore while retaining the primary by setting RetainPrimaryReplicationGroup=true . The primary cluster is never deleted when deleting a Global Datastore. It can only be deleted when it no longer is associated with any Global Datastore.

When you receive a successful response from this operation, Amazon ElastiCache immediately begins deleting the selected resources; you cannot cancel or revert this operation.

See also: AWS API Documentation

Request Syntax

response = client.delete_global_replication_group(
    GlobalReplicationGroupId='string',
    RetainPrimaryReplicationGroup=True|False
)

Parameters

GlobalReplicationGroupId (string) --
[REQUIRED]

The name of the Global datastore
RetainPrimaryReplicationGroup (boolean) --
[REQUIRED]

The primary replication group is retained as a standalone replication group.

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 Redis only.
  - EngineVersion (string) --
    
    The Elasticache Redis 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 Redis 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 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.

Exceptions

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

Table Of Contents

delete_global_replication_group¶