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

***************************
delete_multi_region_cluster
***************************



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

  

  Deletes an existing multi-Region cluster.

  

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


  **Request Syntax**
  ::

    response = client.delete_multi_region_cluster(
        MultiRegionClusterName='string'
    )
    
  :type MultiRegionClusterName: string
  :param MultiRegionClusterName: **[REQUIRED]** 

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

    

  
  
  :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) --* 

        Details about the deleted 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.InvalidMultiRegionClusterStateFault`

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

  