CloudHSM / Client / create_hsm

create_hsm#

CloudHSM.Client.create_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.

Creates an uninitialized HSM instance.

There is an upfront fee charged for each HSM instance that you create with the CreateHsm operation. If you accidentally provision an HSM and want to request a refund, delete the instance using the DeleteHsm operation, go to the AWS Support Center, create a new case, and select Account and Billing Support.

Warning

It can take up to 20 minutes to create and provision an HSM. You can monitor the status of the HSM with the DescribeHsm operation. The HSM is ready to be initialized when the status changes to RUNNING.

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.create_hsm(
    SubnetId='string',
    SshKey='string',
    EniIp='string',
    IamRoleArn='string',
    ExternalId='string',
    SubscriptionType='PRODUCTION',
    ClientToken='string',
    SyslogIp='string'
)
Parameters:

  • SubnetId (string) –

    [REQUIRED]

    The identifier of the subnet in your VPC in which to place the HSM.

  • SshKey (string) –

    [REQUIRED]

    The SSH public key to install on the HSM.

  • EniIp (string) –

    The IP address to assign to the HSM’s ENI.

    If an IP address is not specified, an IP address will be randomly chosen from the CIDR range of the subnet.

  • IamRoleArn (string) –

    [REQUIRED]

    The ARN of an IAM role to enable the AWS CloudHSM service to allocate an ENI on your behalf.

  • ExternalId (string) – The external ID from IamRoleArn, if present.

  • SubscriptionType (string) –

    [REQUIRED]

    Specifies the type of subscription for the HSM.

    • PRODUCTION - The HSM is being used in a production environment.

    • TRIAL - The HSM is being used in a product trial.

  • ClientToken (string) – A user-defined token to ensure idempotence. Subsequent calls to this operation with the same token will be ignored.

  • SyslogIp (string) – The 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 CreateHsm operation.

    • HsmArn (string) –

      The ARN of the HSM.

Exceptions

  • CloudHSM.Client.exceptions.CloudHsmServiceException

  • CloudHSM.Client.exceptions.CloudHsmInternalException

  • CloudHSM.Client.exceptions.InvalidRequestException