CloudHSMV2 / Client / create_hsm

create_hsm#

CloudHSMV2.Client.create_hsm(**kwargs)#

Creates a new hardware security module (HSM) in the specified CloudHSM cluster.

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

See also: AWS API Documentation

Request Syntax

response = client.create_hsm(
    ClusterId='string',
    AvailabilityZone='string',
    IpAddress='string'
)
Parameters:

  • ClusterId (string) –

    [REQUIRED]

    The identifier (ID) of the HSM’s cluster. To find the cluster ID, use DescribeClusters.

  • AvailabilityZone (string) –

    [REQUIRED]

    The Availability Zone where you are creating the HSM. To find the cluster’s Availability Zones, use DescribeClusters.

  • IpAddress (string) – The HSM’s IP address. If you specify an IP address, use an available address from the subnet that maps to the Availability Zone where you are creating the HSM. If you don’t specify an IP address, one is chosen for you from that subnet.

Return type:

dict

Returns:

Response Syntax

{
    'Hsm': {
        'AvailabilityZone': 'string',
        'ClusterId': 'string',
        'SubnetId': 'string',
        'EniId': 'string',
        'EniIp': 'string',
        'EniIpV6': 'string',
        'HsmId': 'string',
        'State': 'CREATE_IN_PROGRESS'|'ACTIVE'|'DEGRADED'|'DELETE_IN_PROGRESS'|'DELETED',
        'StateMessage': 'string'
    }
}

Response Structure

  • (dict) –

    • Hsm (dict) –

      Information about the HSM that was created.

      • AvailabilityZone (string) –

        The Availability Zone that contains the HSM.

      • ClusterId (string) –

        The identifier (ID) of the cluster that contains the HSM.

      • SubnetId (string) –

        The subnet that contains the HSM’s elastic network interface (ENI).

      • EniId (string) –

        The identifier (ID) of the HSM’s elastic network interface (ENI).

      • EniIp (string) –

        The IP address of the HSM’s elastic network interface (ENI).

      • EniIpV6 (string) –

        The IPv6 address (if any) of the HSM’s elastic network interface (ENI).

      • HsmId (string) –

        The HSM’s identifier (ID).

      • State (string) –

        The HSM’s state.

      • StateMessage (string) –

        A description of the HSM’s state.

Exceptions

  • CloudHSMV2.Client.exceptions.CloudHsmInternalFailureException

  • CloudHSMV2.Client.exceptions.CloudHsmServiceException

  • CloudHSMV2.Client.exceptions.CloudHsmInvalidRequestException

  • CloudHSMV2.Client.exceptions.CloudHsmResourceNotFoundException

  • CloudHSMV2.Client.exceptions.CloudHsmAccessDeniedException