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.
See also: AWS API Documentation
Request Syntax
response = client.modify_hsm(
HsmArn='string',
SubnetId='string',
EniIp='string',
IamRoleArn='string',
ExternalId='string',
SyslogIp='string'
)
[REQUIRED]
The ARN of the HSM to modify.
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.
dict
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