:doc:`CloudHSMV2 <../../cloudhsmv2>` / Client / initialize_cluster

******************
initialize_cluster
******************



.. py:method:: CloudHSMV2.Client.initialize_cluster(**kwargs)

  

  Claims an CloudHSM cluster by submitting the cluster certificate issued by your issuing certificate authority (CA) and the CA's root certificate. Before you can claim a cluster, you must sign the cluster's certificate signing request (CSR) with your issuing CA. To get the cluster's CSR, use  DescribeClusters.

   

  **Cross-account use:** No. You cannot perform this operation on an CloudHSM cluster in a different Amazon Web Services account.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/cloudhsmv2-2017-04-28/InitializeCluster>`_  


  **Request Syntax**
  ::

    response = client.initialize_cluster(
        ClusterId='string',
        SignedCert='string',
        TrustAnchor='string'
    )
    
  :type ClusterId: string
  :param ClusterId: **[REQUIRED]** 

    The identifier (ID) of the cluster that you are claiming. To find the cluster ID, use  DescribeClusters.

    

  
  :type SignedCert: string
  :param SignedCert: **[REQUIRED]** 

    The cluster certificate issued (signed) by your issuing certificate authority (CA). The certificate must be in PEM format and can contain a maximum of 5000 characters.

    

  
  :type TrustAnchor: string
  :param TrustAnchor: **[REQUIRED]** 

    The issuing certificate of the issuing certificate authority (CA) that issued (signed) the cluster certificate. You must use a self-signed certificate. The certificate used to sign the HSM CSR must be directly available, and thus must be the root certificate. The certificate must be in PEM format and can contain a maximum of 5000 characters.

    

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

    
    ::

      {
          'State': 'CREATE_IN_PROGRESS'|'UNINITIALIZED'|'INITIALIZE_IN_PROGRESS'|'INITIALIZED'|'ACTIVE'|'UPDATE_IN_PROGRESS'|'MODIFY_IN_PROGRESS'|'ROLLBACK_IN_PROGRESS'|'DELETE_IN_PROGRESS'|'DELETED'|'DEGRADED',
          'StateMessage': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **State** *(string) --* 

        The cluster's state.

        
      

      - **StateMessage** *(string) --* 

        A description of the cluster's state.

        
  
  **Exceptions**
  
  *   :py:class:`CloudHSMV2.Client.exceptions.CloudHsmAccessDeniedException`

  
  *   :py:class:`CloudHSMV2.Client.exceptions.CloudHsmInternalFailureException`

  
  *   :py:class:`CloudHSMV2.Client.exceptions.CloudHsmInvalidRequestException`

  
  *   :py:class:`CloudHSMV2.Client.exceptions.CloudHsmResourceNotFoundException`

  
  *   :py:class:`CloudHSMV2.Client.exceptions.CloudHsmServiceException`

  