CloudHSM / Client / modify_hsm

modify_hsm#

CloudHSM.Client.modify_hsm(**kwargs)#

This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference.

For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference.

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

Request Syntax

response = client.modify_hsm(
    HsmArn='string',
    SubnetId='string',
    EniIp='string',
    IamRoleArn='string',
    ExternalId='string',
    SyslogIp='string'
)
Parameters:

  • HsmArn (string) –

    [REQUIRED]

    The ARN of the HSM to modify.

  • SubnetId (string) – 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.

  • EniIp (string) –

    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.

  • IamRoleArn (string) – The new IAM role ARN.

  • ExternalId (string) – The new external ID.

  • SyslogIp (string) – The new IP address for the syslog monitoring server. The AWS CloudHSM service only supports one syslog monitoring server.

Return type:

dict

Returns:

Response Syntax

{
    'HsmArn': 'string'
}

Response Structure

  • (dict) –

    Contains the output of the ModifyHsm operation.

    • HsmArn (string) –

      The ARN of the HSM.

Exceptions

  • CloudHSM.Client.exceptions.CloudHsmServiceException

  • CloudHSM.Client.exceptions.CloudHsmInternalException

  • CloudHSM.Client.exceptions.InvalidRequestException