:doc:`CloudHSM <../../cloudhsm>` / Client / modify_hsm

**********
modify_hsm
**********



.. py:method:: CloudHSM.Client.modify_hsm(**kwargs)

  

  This is documentation for **AWS CloudHSM Classic**. For more information, see `AWS CloudHSM Classic FAQs <http://aws.amazon.com/cloudhsm/faqs-classic/>`__, the `AWS CloudHSM Classic User Guide <https://docs.aws.amazon.com/cloudhsm/classic/userguide/>`__, and the `AWS CloudHSM Classic API Reference <https://docs.aws.amazon.com/cloudhsm/classic/APIReference/>`__.

   

  **For information about the current version of AWS CloudHSM**, see `AWS CloudHSM <http://aws.amazon.com/cloudhsm/>`__, the `AWS CloudHSM User Guide <https://docs.aws.amazon.com/cloudhsm/latest/userguide/>`__, and the `AWS CloudHSM API Reference <https://docs.aws.amazon.com/cloudhsm/latest/APIReference/>`__.

   

  Modifies an HSM.

   

  .. warning::

     

    This operation can result in the HSM being offline for up to 15 minutes while the AWS CloudHSM service is reconfigured. If you are modifying a production HSM, you should ensure that your AWS CloudHSM service is configured for high availability, and consider executing this operation during a maintenance window.

    

  

  .. danger::

        This operation is deprecated and may not function as expected. This operation should not be used going forward and is only kept for the purpose of backwards compatiblity.


  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/cloudhsm-2014-05-30/ModifyHsm>`_  


  **Request Syntax**
  ::

    response = client.modify_hsm(
        HsmArn='string',
        SubnetId='string',
        EniIp='string',
        IamRoleArn='string',
        ExternalId='string',
        SyslogIp='string'
    )
    
  :type HsmArn: string
  :param HsmArn: **[REQUIRED]** 

    The ARN of the HSM to modify.

    

  
  :type SubnetId: string
  :param SubnetId: 

    The new identifier of the subnet that the HSM is in. The new subnet must be in the same Availability Zone as the current subnet.

    

  
  :type EniIp: string
  :param EniIp: 

    The new IP address for the elastic network interface (ENI) attached to the HSM.

     

    If the HSM is moved to a different subnet, and an IP address is not specified, an IP address will be randomly chosen from the CIDR range of the new subnet.

    

  
  :type IamRoleArn: string
  :param IamRoleArn: 

    The new IAM role ARN.

    

  
  :type ExternalId: string
  :param ExternalId: 

    The new external ID.

    

  
  :type SyslogIp: string
  :param SyslogIp: 

    The new IP address for the syslog monitoring server. The AWS CloudHSM service only supports one syslog monitoring server.

    

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

    
    ::

      {
          'HsmArn': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 

      Contains the output of the  ModifyHsm operation.

      
      

      - **HsmArn** *(string) --* 

        The ARN of the HSM.

        
  
  **Exceptions**
  
  *   :py:class:`CloudHSM.Client.exceptions.CloudHsmServiceException`

  
  *   :py:class:`CloudHSM.Client.exceptions.CloudHsmInternalException`

  
  *   :py:class:`CloudHSM.Client.exceptions.InvalidRequestException`

  