/AWS1/IF_RSH=>CREATEHSMCONFIGURATION()

About CreateHsmConfiguration

Creates an HSM configuration that contains the information required by an Amazon Redshift cluster to store and use database encryption keys in a Hardware Security Module (HSM). After creating the HSM configuration, you can specify it as a parameter when creating a cluster. The cluster will then store its encryption keys in the HSM.

In addition to creating an HSM configuration, you must also create an HSM client certificate. For more information, go to Hardware Security Modules in the Amazon Redshift Cluster Management Guide.

Method Signature

METHODS /AWS1/IF_RSH~CREATEHSMCONFIGURATION
  IMPORTING
    !IV_HSMCONFIDENTIFIER TYPE /AWS1/RSHSTRING OPTIONAL
    !IV_DESCRIPTION TYPE /AWS1/RSHSTRING OPTIONAL
    !IV_HSMIPADDRESS TYPE /AWS1/RSHSTRING OPTIONAL
    !IV_HSMPARTITIONNAME TYPE /AWS1/RSHSTRING OPTIONAL
    !IV_HSMPARTITIONPASSWORD TYPE /AWS1/RSHSTRING OPTIONAL
    !IV_HSMSERVERPUBLICCERT TYPE /AWS1/RSHSTRING OPTIONAL
    !IT_TAGS TYPE /AWS1/CL_RSHTAG=>TT_TAGLIST OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_rshcreatehsmconfrslt
  RAISING
    /AWS1/CX_RSHHSMCONFALREXFAULT
    /AWS1/CX_RSHHSMCONFQUOTAEXCD00
    /AWS1/CX_RSHINVALIDTAGFAULT
    /AWS1/CX_RSHTAGLIMITEXCDFAULT
    /AWS1/CX_RSHCLIENTEXC
    /AWS1/CX_RSHSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_hsmconfidentifier TYPE /AWS1/RSHSTRING /AWS1/RSHSTRING

The identifier to be assigned to the new Amazon Redshift HSM configuration.

iv_description TYPE /AWS1/RSHSTRING /AWS1/RSHSTRING

A text description of the HSM configuration to be created.

iv_hsmipaddress TYPE /AWS1/RSHSTRING /AWS1/RSHSTRING

The IP address that the Amazon Redshift cluster must use to access the HSM.

iv_hsmpartitionname TYPE /AWS1/RSHSTRING /AWS1/RSHSTRING

The name of the partition in the HSM where the Amazon Redshift clusters will store their database encryption keys.

iv_hsmpartitionpassword TYPE /AWS1/RSHSTRING /AWS1/RSHSTRING

The password required to access the HSM partition.

iv_hsmserverpubliccert TYPE /AWS1/RSHSTRING /AWS1/RSHSTRING

The HSMs public certificate file. When using Cloud HSM, the file name is server.pem.

Optional arguments:

it_tags TYPE /AWS1/CL_RSHTAG=>TT_TAGLIST TT_TAGLIST

A list of tag instances.

RETURNING

oo_output TYPE REF TO /aws1/cl_rshcreatehsmconfrslt /AWS1/CL_RSHCREATEHSMCONFRSLT

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->createhsmconfiguration(
  it_tags = VALUE /aws1/cl_rshtag=>tt_taglist(
    (
      new /aws1/cl_rshtag(
        iv_key = |string|
        iv_value = |string|
      )
    )
  )
  iv_description = |string|
  iv_hsmconfidentifier = |string|
  iv_hsmipaddress = |string|
  iv_hsmpartitionname = |string|
  iv_hsmpartitionpassword = |string|
  iv_hsmserverpubliccert = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lo_hsmconfiguration = lo_result->get_hsmconfiguration( ).
  IF lo_hsmconfiguration IS NOT INITIAL.
    lv_string = lo_hsmconfiguration->get_hsmconfidentifier( ).
    lv_string = lo_hsmconfiguration->get_description( ).
    lv_string = lo_hsmconfiguration->get_hsmipaddress( ).
    lv_string = lo_hsmconfiguration->get_hsmpartitionname( ).
    LOOP AT lo_hsmconfiguration->get_tags( ) into lo_row.
      lo_row_1 = lo_row.
      IF lo_row_1 IS NOT INITIAL.
        lv_string = lo_row_1->get_key( ).
        lv_string = lo_row_1->get_value( ).
      ENDIF.
    ENDLOOP.
  ENDIF.
ENDIF.