Skip to content

/AWS1/IF_HSM=>CREATEHSM()

About CreateHsm

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.

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.

Method Signature

METHODS /AWS1/IF_HSM~CREATEHSM
  IMPORTING
    !IV_SUBNETID TYPE /AWS1/HSMSUBNETID OPTIONAL
    !IV_SSHKEY TYPE /AWS1/HSMSSHKEY OPTIONAL
    !IV_ENIIP TYPE /AWS1/HSMIPADDRESS OPTIONAL
    !IV_IAMROLEARN TYPE /AWS1/HSMIAMROLEARN OPTIONAL
    !IV_EXTERNALID TYPE /AWS1/HSMEXTERNALID OPTIONAL
    !IV_SUBSCRIPTIONTYPE TYPE /AWS1/HSMSUBSCRIPTIONTYPE OPTIONAL
    !IV_CLIENTTOKEN TYPE /AWS1/HSMCLIENTTOKEN OPTIONAL
    !IV_SYSLOGIP TYPE /AWS1/HSMIPADDRESS OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_hsmcreatehsmresponse
  RAISING
    /AWS1/CX_HSMCLOUDHSMINTERNALEX
    /AWS1/CX_HSMCLOUDHSMSERVICEEX
    /AWS1/CX_HSMINVALIDREQUESTEX
    /AWS1/CX_HSMCLIENTEXC
    /AWS1/CX_HSMSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_subnetid TYPE /AWS1/HSMSUBNETID /AWS1/HSMSUBNETID

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

iv_sshkey TYPE /AWS1/HSMSSHKEY /AWS1/HSMSSHKEY

The SSH public key to install on the HSM.

iv_iamrolearn TYPE /AWS1/HSMIAMROLEARN /AWS1/HSMIAMROLEARN

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

iv_subscriptiontype TYPE /AWS1/HSMSUBSCRIPTIONTYPE /AWS1/HSMSUBSCRIPTIONTYPE

SubscriptionType

Optional arguments:

iv_eniip TYPE /AWS1/HSMIPADDRESS /AWS1/HSMIPADDRESS

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.

iv_externalid TYPE /AWS1/HSMEXTERNALID /AWS1/HSMEXTERNALID

The external ID from IamRoleArn, if present.

iv_clienttoken TYPE /AWS1/HSMCLIENTTOKEN /AWS1/HSMCLIENTTOKEN

A user-defined token to ensure idempotence. Subsequent calls to this operation with the same token will be ignored.

iv_syslogip TYPE /AWS1/HSMIPADDRESS /AWS1/HSMIPADDRESS

The IP address for the syslog monitoring server. The AWS CloudHSM service only supports one syslog monitoring server.

RETURNING

oo_output TYPE REF TO /aws1/cl_hsmcreatehsmresponse /AWS1/CL_HSMCREATEHSMRESPONSE

Domain /AWS1/RT_ACCOUNT_ID
Primitive Type NUMC

Examples

Syntax Example

This is an example of the syntax for calling the method. It includes every possible argument and initializes every possible value. The data provided is not necessarily semantically accurate (for example the value "string" may be provided for something that is intended to be an instance ID, or in some cases two arguments may be mutually exclusive). The syntax shows the ABAP syntax for creating the various data structures.

DATA(lo_result) = lo_client->createhsm(
  iv_clienttoken = |string|
  iv_eniip = |string|
  iv_externalid = |string|
  iv_iamrolearn = |string|
  iv_sshkey = |string|
  iv_subnetid = |string|
  iv_subscriptiontype = |string|
  iv_syslogip = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_hsmarn = lo_result->get_hsmarn( ).
ENDIF.