Menu
AWS CloudHSM V2
API Reference (API Version 2017-04-28)

CreateHsm

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

Request Syntax

{
   "AvailabilityZone": "string",
   "ClusterId": "string",
   "IpAddress": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

AvailabilityZone

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

Type: String

Pattern: [a-z]{2}(-(gov|isob|iso))?-(east|west|north|south|central){1,2}-\d[a-z]

Required: Yes

ClusterId

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

Type: String

Pattern: cluster-[2-7a-zA-Z]{11,16}

Required: Yes

IpAddress

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.

Type: String

Pattern: \d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}

Required: No

Response Syntax

{
   "Hsm": { 
      "AvailabilityZone": "string",
      "ClusterId": "string",
      "EniId": "string",
      "EniIp": "string",
      "HsmId": "string",
      "State": "string",
      "StateMessage": "string",
      "SubnetId": "string"
   }
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

Hsm

Information about the HSM that was created.

Type: Hsm object

Errors

For information about the errors that are common to all actions, see Common Errors.

CloudHsmAccessDeniedException

The request was rejected because the requester does not have permission to perform the requested operation.

HTTP Status Code: 400

CloudHsmInternalFailureException

The request was rejected because of an AWS CloudHSM internal failure. The request can be retried.

HTTP Status Code: 500

CloudHsmInvalidRequestException

The request was rejected because it is not a valid request.

HTTP Status Code: 400

CloudHsmResourceNotFoundException

The request was rejected because it refers to a resource that cannot be found.

HTTP Status Code: 400

CloudHsmServiceException

The request was rejected because an error occurred.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: