API for Amazon CloudHSM

ABAP Package	/AWS1/API_HSM
ABAP SDK "TLA"	HSM
ABAP Interface	/AWS1/IF_HSM

The "TLA" is a Three Letter Abbreviation that appears in ABAP class names, data dictionary objects and other ABAP objects throughout the AWS SDK for SAP ABAP. The TLA for Amazon CloudHSM is HSM. This TLA helps squeeze ABAP objects into the 30-character length limit of the ABAP data dictionary.

Installation

To install the AWS SDK for SAP ABAP, import the Core transport, along with the transport for the CloudHSM module and other API modules you are interested in. A few modules are included in the Core transport itself. For more information, see the Developer Guide guide.

About The Service

AWS CloudHSM Service

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.

Using the SDK

In your code, create a client using the SDK module for Amazon CloudHSM, which is created with factory method /AWS1/CL_HSM_FACTORY=>create(). In this example we will assume you have configured an SDK profile in transaction /AWS1/IMG called ZFINANCE.

DATA(go_session)   = /aws1/cl_rt_session_aws=>create( 'ZFINANCE' ).
DATA(go_hsm)       = /aws1/cl_hsm_factory=>create( go_session ).

Your variable go_hsm is an instance of /AWS1/IF_HSM, and all of the operations in the Amazon CloudHSM service are accessed by calling methods in /AWS1/IF_HSM.

API Operations

For an overview of ABAP method calls corresponding to API operations in Amazon CloudHSM, see the Operation List.

Factory Method

/AWS1/CL_HSM_FACTORY=>create( )

Creates an object of type /AWS1/IF_HSM.

IMPORTING

Optional arguments:

iv_protocol TYPE /aws1/rt_protocol /AWS1/RT_PROTOCOL

Domain	/AWS1/RT_ACCOUNT_ID
Primitive Type	NUMC

io_session TYPE REF TO /aws1/cl_rt_session_base /AWS1/CL_RT_SESSION_BASE

Domain	/AWS1/RT_ACCOUNT_ID
Primitive Type	NUMC

iv_region TYPE /aws1/rt_region_id /AWS1/RT_REGION_ID

Domain	/AWS1/RT_ACCOUNT_ID
Primitive Type	NUMC

iv_custom_endpoint TYPE /aws1/rt_endpoint /AWS1/RT_ENDPOINT

Domain	/AWS1/RT_ACCOUNT_ID
Primitive Type	NUMC

RETURNING

oo_client TYPE REF TO /aws1/if_hsm /AWS1/IF_HSM

/AWS1/IF_HSM represents the ABAP client for the CloudHSM service, representing each operation as a method call. For more information see the API Page page.

Configuring Programmatically

DATA(lo_config) = DATA(go_hsm)->get_config( ).

lo_config is a variable of type /AWS1/CL_HSM_CONFIG. See the documentation for /AWS1/CL_HSM_CONFIG for details on the settings that can be configured.