:doc:`ElastiCache <../../elasticache>` / Client / increase_node_groups_in_global_replication_group

************************************************
increase_node_groups_in_global_replication_group
************************************************



.. py:method:: ElastiCache.Client.increase_node_groups_in_global_replication_group(**kwargs)

  

  Increase the number of node groups in the Global datastore

  

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


  **Request Syntax**
  ::

    response = client.increase_node_groups_in_global_replication_group(
        GlobalReplicationGroupId='string',
        NodeGroupCount=123,
        RegionalConfigurations=[
            {
                'ReplicationGroupId': 'string',
                'ReplicationGroupRegion': 'string',
                'ReshardingConfiguration': [
                    {
                        'NodeGroupId': 'string',
                        'PreferredAvailabilityZones': [
                            'string',
                        ]
                    },
                ]
            },
        ],
        ApplyImmediately=True|False
    )
    
  :type GlobalReplicationGroupId: string
  :param GlobalReplicationGroupId: **[REQUIRED]** 

    The name of the Global datastore

    

  
  :type NodeGroupCount: integer
  :param NodeGroupCount: **[REQUIRED]** 

    Total number of node groups you want

    

  
  :type RegionalConfigurations: list
  :param RegionalConfigurations: 

    Describes the replication group IDs, the Amazon regions where they are stored and the shard configuration for each that comprise the Global datastore

    

  
    - *(dict) --* 

      A list of the replication groups

      

    
      - **ReplicationGroupId** *(string) --* **[REQUIRED]** 

        The name of the secondary cluster

        

      
      - **ReplicationGroupRegion** *(string) --* **[REQUIRED]** 

        The Amazon region where the cluster is stored

        

      
      - **ReshardingConfiguration** *(list) --* **[REQUIRED]** 

        A list of ``PreferredAvailabilityZones`` objects that specifies the configuration of a node group in the resharded cluster.

        

      
        - *(dict) --* 

          A list of ``PreferredAvailabilityZones`` objects that specifies the configuration of a node group in the resharded cluster.

          

        
          - **NodeGroupId** *(string) --* 

            Either the ElastiCache supplied 4-digit id or a user supplied id for the node group these configuration values apply to.

            

          
          - **PreferredAvailabilityZones** *(list) --* 

            A list of preferred availability zones for the nodes in this cluster.

            

          
            - *(string) --* 

            
        
        
    
    

  :type ApplyImmediately: boolean
  :param ApplyImmediately: **[REQUIRED]** 

    Indicates that the process begins immediately. At present, the only permitted value for this parameter is true.

    

  
  
  :rtype: 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**
  
  *   :py:class:`ElastiCache.Client.exceptions.GlobalReplicationGroupNotFoundFault`

  
  *   :py:class:`ElastiCache.Client.exceptions.InvalidGlobalReplicationGroupStateFault`

  
  *   :py:class:`ElastiCache.Client.exceptions.InvalidParameterValueException`

  