:doc:`MemoryDB <../../memorydb>` / Client / update_multi_region_cluster

***************************
update_multi_region_cluster
***************************



.. py:method:: MemoryDB.Client.update_multi_region_cluster(**kwargs)

  

  Updates the configuration of an existing multi-Region cluster.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/memorydb-2021-01-01/UpdateMultiRegionCluster>`_  


  **Request Syntax**
  ::

    response = client.update_multi_region_cluster(
        MultiRegionClusterName='string',
        NodeType='string',
        Description='string',
        EngineVersion='string',
        ShardConfiguration={
            'ShardCount': 123
        },
        MultiRegionParameterGroupName='string',
        UpdateStrategy='coordinated'|'uncoordinated'
    )
    
  :type MultiRegionClusterName: string
  :param MultiRegionClusterName: **[REQUIRED]** 

    The name of the multi-Region cluster to be updated.

    

  
  :type NodeType: string
  :param NodeType: 

    The new node type to be used for the multi-Region cluster.

    

  
  :type Description: string
  :param Description: 

    A new description for the multi-Region cluster.

    

  
  :type EngineVersion: string
  :param EngineVersion: 

    The new engine version to be used for the multi-Region cluster.

    

  
  :type ShardConfiguration: dict
  :param ShardConfiguration: 

    A request to configure the sharding properties of a cluster

    

  
    - **ShardCount** *(integer) --* 

      The number of shards in the cluster

      

    
  
  :type MultiRegionParameterGroupName: string
  :param MultiRegionParameterGroupName: 

    The new multi-Region parameter group to be associated with the cluster.

    

  
  :type UpdateStrategy: string
  :param UpdateStrategy: 

    The strategy to use for the update operation. Supported values are "coordinated" or "uncoordinated".

    

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

    
    ::

      {
          'MultiRegionCluster': {
              'MultiRegionClusterName': 'string',
              'Description': 'string',
              'Status': 'string',
              'NodeType': 'string',
              'Engine': 'string',
              'EngineVersion': 'string',
              'NumberOfShards': 123,
              'Clusters': [
                  {
                      'ClusterName': 'string',
                      'Region': 'string',
                      'Status': 'string',
                      'ARN': 'string'
                  },
              ],
              'MultiRegionParameterGroupName': 'string',
              'TLSEnabled': True|False,
              'ARN': 'string'
          }
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **MultiRegionCluster** *(dict) --* 

        The status of updating the multi-Region cluster.

        
        

        - **MultiRegionClusterName** *(string) --* 

          The name of the multi-Region cluster.

          
        

        - **Description** *(string) --* 

          The description of the multi-Region cluster.

          
        

        - **Status** *(string) --* 

          The current status of the multi-Region cluster.

          
        

        - **NodeType** *(string) --* 

          The node type used by the multi-Region cluster.

          
        

        - **Engine** *(string) --* 

          The name of the engine used by the multi-Region cluster.

          
        

        - **EngineVersion** *(string) --* 

          The version of the engine used by the multi-Region cluster.

          
        

        - **NumberOfShards** *(integer) --* 

          The number of shards in the multi-Region cluster.

          
        

        - **Clusters** *(list) --* 

          The clusters in this multi-Region cluster.

          
          

          - *(dict) --* 

            Represents a Regional cluster

            
            

            - **ClusterName** *(string) --* 

              The name of the Regional cluster

              
            

            - **Region** *(string) --* 

              The Region the current Regional cluster is assigned to.

              
            

            - **Status** *(string) --* 

              The status of the Regional cluster.

              
            

            - **ARN** *(string) --* 

              The Amazon Resource Name (ARN) the Regional cluster

              
        
      
        

        - **MultiRegionParameterGroupName** *(string) --* 

          The name of the multi-Region parameter group associated with the cluster.

          
        

        - **TLSEnabled** *(boolean) --* 

          Indiciates if the multi-Region cluster is TLS enabled.

          
        

        - **ARN** *(string) --* 

          The Amazon Resource Name (ARN) of the multi-Region cluster.

          
    
  
  **Exceptions**
  
  *   :py:class:`MemoryDB.Client.exceptions.MultiRegionClusterNotFoundFault`

  
  *   :py:class:`MemoryDB.Client.exceptions.MultiRegionParameterGroupNotFoundFault`

  
  *   :py:class:`MemoryDB.Client.exceptions.InvalidMultiRegionClusterStateFault`

  
  *   :py:class:`MemoryDB.Client.exceptions.InvalidParameterCombinationException`

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

  