:doc:`AuroraDSQL <../../dsql>` / Client / get_cluster

***********
get_cluster
***********



.. py:method:: AuroraDSQL.Client.get_cluster(**kwargs)

  

  Retrieves information about a cluster.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/dsql-2018-05-10/GetCluster>`_  


  **Request Syntax**
  ::

    response = client.get_cluster(
        identifier='string'
    )
    
  :type identifier: string
  :param identifier: **[REQUIRED]** 

    The ID of the cluster to retrieve.

    

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

    
    ::

      {
          'identifier': 'string',
          'arn': 'string',
          'status': 'CREATING'|'ACTIVE'|'IDLE'|'INACTIVE'|'UPDATING'|'DELETING'|'DELETED'|'FAILED'|'PENDING_SETUP'|'PENDING_DELETE',
          'creationTime': datetime(2015, 1, 1),
          'deletionProtectionEnabled': True|False,
          'multiRegionProperties': {
              'witnessRegion': 'string',
              'clusters': [
                  'string',
              ]
          },
          'tags': {
              'string': 'string'
          },
          'encryptionDetails': {
              'encryptionType': 'AWS_OWNED_KMS_KEY'|'CUSTOMER_MANAGED_KMS_KEY',
              'kmsKeyArn': 'string',
              'encryptionStatus': 'ENABLED'|'UPDATING'|'KMS_KEY_INACCESSIBLE'|'ENABLING'
          },
          'endpoint': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 

      The output of a cluster.

      
      

      - **identifier** *(string) --* 

        The ID of the retrieved cluster.

        
      

      - **arn** *(string) --* 

        The ARN of the retrieved cluster.

        
      

      - **status** *(string) --* 

        The status of the retrieved cluster.

        
      

      - **creationTime** *(datetime) --* 

        The time of when the cluster was created.

        
      

      - **deletionProtectionEnabled** *(boolean) --* 

        Whether deletion protection is enabled in this cluster.

        
      

      - **multiRegionProperties** *(dict) --* 

        Returns the current multi-Region cluster configuration, including witness region and linked cluster information.

        
        

        - **witnessRegion** *(string) --* 

          The Region that serves as the witness region for a multi-Region cluster. The witness Region helps maintain cluster consistency and quorum.

          
        

        - **clusters** *(list) --* 

          The set of peered clusters that form the multi-Region cluster configuration. Each peered cluster represents a database instance in a different Region.

          
          

          - *(string) --* 

            The Amazon Resource Name of the cluster.

            
      
    
      

      - **tags** *(dict) --* 

        Map of tags.

        
        

        - *(string) --* 

          Unique tag key, maximum 128 Unicode characters in UTF-8.

          
          

          - *(string) --* 

            Tag value, maximum 256 Unicode characters in UTF-8.

            
    
  
      

      - **encryptionDetails** *(dict) --* 

        The current encryption configuration details for the cluster.

        
        

        - **encryptionType** *(string) --* 

          The type of encryption that protects the data on your cluster.

          
        

        - **kmsKeyArn** *(string) --* 

          The ARN of the KMS key that encrypts data in the cluster.

          
        

        - **encryptionStatus** *(string) --* 

          The status of encryption for the cluster.

          
    
      

      - **endpoint** *(string) --* 

        The connection endpoint for the cluster.

        
  
  **Exceptions**
  
  *   :py:class:`AuroraDSQL.Client.exceptions.ThrottlingException`

  
  *   :py:class:`AuroraDSQL.Client.exceptions.AccessDeniedException`

  
  *   :py:class:`AuroraDSQL.Client.exceptions.ValidationException`

  
  *   :py:class:`AuroraDSQL.Client.exceptions.InternalServerException`

  
  *   :py:class:`AuroraDSQL.Client.exceptions.ResourceNotFoundException`

  