:doc:`ElastiCache <../../elasticache>` / Paginator / DescribeGlobalReplicationGroups

*******************************
DescribeGlobalReplicationGroups
*******************************



.. py:class:: ElastiCache.Paginator.DescribeGlobalReplicationGroups

  ::

    
    paginator = client.get_paginator('describe_global_replication_groups')

  
  

  .. py:method:: paginate(**kwargs)

    Creates an iterator that will paginate through responses from :py:meth:`ElastiCache.Client.describe_global_replication_groups`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/elasticache-2015-02-02/DescribeGlobalReplicationGroups>`_    


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          GlobalReplicationGroupId='string',
          ShowMemberInfo=True|False,
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type GlobalReplicationGroupId: string
    :param GlobalReplicationGroupId: 

      The name of the Global datastore

      

    
    :type ShowMemberInfo: boolean
    :param ShowMemberInfo: 

      Returns the list of members that comprise the Global datastore.

      

    
    :type PaginationConfig: dict
    :param PaginationConfig: 

      A dictionary that provides parameters to control pagination.

      

    
      - **MaxItems** *(integer) --* 

        The total number of items to return. If the total number of items available is more than the value specified in max-items then a ``NextToken`` will be provided in the output that you can use to resume pagination.

        

      
      - **PageSize** *(integer) --* 

        The size of each page.

        

      
      - **StartingToken** *(string) --* 

        A token to specify where to start paginating. This is the ``NextToken`` from a previous response.

        

      
    
    
    :rtype: dict
    :returns: 
      
      **Response Syntax**

      
      ::

        {
            'GlobalReplicationGroups': [
                {
                    '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'
                },
            ],
            'NextToken': 'string'
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **GlobalReplicationGroups** *(list) --* 

          Indicates the slot configuration and global identifier for each slice group.

          
          

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

              
        
      
        

        - **NextToken** *(string) --* 

          A token to resume pagination.

          
    