Skip to content

/AWS1/IF_HSM=>MODIFYHSM()

About ModifyHsm

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.

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.

Method Signature

METHODS /AWS1/IF_HSM~MODIFYHSM
  IMPORTING
    !IV_HSMARN TYPE /AWS1/HSMHSMARN OPTIONAL
    !IV_SUBNETID TYPE /AWS1/HSMSUBNETID OPTIONAL
    !IV_ENIIP TYPE /AWS1/HSMIPADDRESS OPTIONAL
    !IV_IAMROLEARN TYPE /AWS1/HSMIAMROLEARN OPTIONAL
    !IV_EXTERNALID TYPE /AWS1/HSMEXTERNALID OPTIONAL
    !IV_SYSLOGIP TYPE /AWS1/HSMIPADDRESS OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_hsmmodifyhsmresponse
  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_hsmarn TYPE /AWS1/HSMHSMARN /AWS1/HSMHSMARN

The ARN of the HSM to modify.

Optional arguments:

iv_subnetid TYPE /AWS1/HSMSUBNETID /AWS1/HSMSUBNETID

The new identifier of the subnet that the HSM is in. The new subnet must be in the same Availability Zone as the current subnet.

iv_eniip TYPE /AWS1/HSMIPADDRESS /AWS1/HSMIPADDRESS

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.

iv_iamrolearn TYPE /AWS1/HSMIAMROLEARN /AWS1/HSMIAMROLEARN

The new IAM role ARN.

iv_externalid TYPE /AWS1/HSMEXTERNALID /AWS1/HSMEXTERNALID

The new external ID.

iv_syslogip TYPE /AWS1/HSMIPADDRESS /AWS1/HSMIPADDRESS

The new 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_hsmmodifyhsmresponse /AWS1/CL_HSMMODIFYHSMRESPONSE

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->modifyhsm(
  iv_eniip = |string|
  iv_externalid = |string|
  iv_hsmarn = |string|
  iv_iamrolearn = |string|
  iv_subnetid = |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.