Skip to content

/AWS1/IF_HS2=>CREATECLUSTER()

About CreateCluster

Creates a new CloudHSM cluster.

Cross-account use: Yes. To perform this operation with an CloudHSM backup in a different AWS account, specify the full backup ARN in the value of the SourceBackupId parameter.

Method Signature

METHODS /AWS1/IF_HS2~CREATECLUSTER
  IMPORTING
    !IO_BACKUPRETENTIONPOLICY TYPE REF TO /AWS1/CL_HS2BACKUPRETPOLICY OPTIONAL
    !IV_HSMTYPE TYPE /AWS1/HS2HSMTYPE OPTIONAL
    !IV_SOURCEBACKUPID TYPE /AWS1/HS2BACKUPARN OPTIONAL
    !IT_SUBNETIDS TYPE /AWS1/CL_HS2SUBNETIDS_W=>TT_SUBNETIDS OPTIONAL
    !IV_NETWORKTYPE TYPE /AWS1/HS2NETWORKTYPE OPTIONAL
    !IT_TAGLIST TYPE /AWS1/CL_HS2TAG=>TT_TAGLIST OPTIONAL
    !IV_MODE TYPE /AWS1/HS2CLUSTERMODE OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_hs2createclusterrsp
  RAISING
    /AWS1/CX_HS2CLOUDHSMACCDENIE00
    /AWS1/CX_HS2CLOUDHSMINTERNAL00
    /AWS1/CX_HS2CLOUDHSMINVREQEX
    /AWS1/CX_HS2CLOUDHSMRESRCNOT00
    /AWS1/CX_HS2CLOUDHSMSERVICEEX
    /AWS1/CX_HS2CLOUDHSMTAGEX
    /AWS1/CX_HS2CLIENTEXC
    /AWS1/CX_HS2SERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_hsmtype TYPE /AWS1/HS2HSMTYPE /AWS1/HS2HSMTYPE

The type of HSM to use in the cluster. The allowed values are hsm1.medium and hsm2m.medium.

it_subnetids TYPE /AWS1/CL_HS2SUBNETIDS_W=>TT_SUBNETIDS TT_SUBNETIDS

The identifiers (IDs) of the subnets where you are creating the cluster. You must specify at least one subnet. If you specify multiple subnets, they must meet the following criteria:

  • All subnets must be in the same virtual private cloud (VPC).

  • You can specify only one subnet per Availability Zone.

Optional arguments:

io_backupretentionpolicy TYPE REF TO /AWS1/CL_HS2BACKUPRETPOLICY /AWS1/CL_HS2BACKUPRETPOLICY

A policy that defines how the service retains backups.

iv_sourcebackupid TYPE /AWS1/HS2BACKUPARN /AWS1/HS2BACKUPARN

The identifier (ID) or the Amazon Resource Name (ARN) of the cluster backup to restore. Use this value to restore the cluster from a backup instead of creating a new cluster. To find the backup ID or ARN, use DescribeBackups. If using a backup in another account, the full ARN must be supplied.

iv_networktype TYPE /AWS1/HS2NETWORKTYPE /AWS1/HS2NETWORKTYPE

The NetworkType to create a cluster with. The allowed values are IPV4 and DUALSTACK.

it_taglist TYPE /AWS1/CL_HS2TAG=>TT_TAGLIST TT_TAGLIST

Tags to apply to the CloudHSM cluster during creation.

iv_mode TYPE /AWS1/HS2CLUSTERMODE /AWS1/HS2CLUSTERMODE

The mode to use in the cluster. The allowed values are FIPS and NON_FIPS.

RETURNING

oo_output TYPE REF TO /aws1/cl_hs2createclusterrsp /AWS1/CL_HS2CREATECLUSTERRSP

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->createcluster(
  io_backupretentionpolicy = new /aws1/cl_hs2backupretpolicy(
    iv_type = |string|
    iv_value = |string|
  )
  it_subnetids = VALUE /aws1/cl_hs2subnetids_w=>tt_subnetids(
    ( new /aws1/cl_hs2subnetids_w( |string| ) )
  )
  it_taglist = VALUE /aws1/cl_hs2tag=>tt_taglist(
    (
      new /aws1/cl_hs2tag(
        iv_key = |string|
        iv_value = |string|
      )
    )
  )
  iv_hsmtype = |string|
  iv_mode = |string|
  iv_networktype = |string|
  iv_sourcebackupid = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lo_cluster = lo_result->get_cluster( ).
  IF lo_cluster IS NOT INITIAL.
    lv_backuppolicy = lo_cluster->get_backuppolicy( ).
    lo_backupretentionpolicy = lo_cluster->get_backupretentionpolicy( ).
    IF lo_backupretentionpolicy IS NOT INITIAL.
      lv_backupretentiontype = lo_backupretentionpolicy->get_type( ).
      lv_backupretentionvalue = lo_backupretentionpolicy->get_value( ).
    ENDIF.
    lv_clusterid = lo_cluster->get_clusterid( ).
    lv_timestamp = lo_cluster->get_createtimestamp( ).
    LOOP AT lo_cluster->get_hsms( ) into lo_row.
      lo_row_1 = lo_row.
      IF lo_row_1 IS NOT INITIAL.
        lv_externalaz = lo_row_1->get_availabilityzone( ).
        lv_clusterid = lo_row_1->get_clusterid( ).
        lv_subnetid = lo_row_1->get_subnetid( ).
        lv_eniid = lo_row_1->get_eniid( ).
        lv_ipaddress = lo_row_1->get_eniip( ).
        lv_ipv6address = lo_row_1->get_eniipv6( ).
        lv_hsmid = lo_row_1->get_hsmid( ).
        lv_hsmtype = lo_row_1->get_hsmtype( ).
        lv_hsmstate = lo_row_1->get_state( ).
        lv_string = lo_row_1->get_statemessage( ).
      ENDIF.
    ENDLOOP.
    lv_hsmtype = lo_cluster->get_hsmtype( ).
    lv_timestamp = lo_cluster->get_hsmtyperollbackexpir( ).
    lv_precopassword = lo_cluster->get_precopassword( ).
    lv_securitygroup = lo_cluster->get_securitygroup( ).
    lv_backupid = lo_cluster->get_sourcebackupid( ).
    lv_clusterstate = lo_cluster->get_state( ).
    lv_statemessage = lo_cluster->get_statemessage( ).
    LOOP AT lo_cluster->get_subnetmapping( ) into ls_row_2.
      lv_key = ls_row_2-key.
      lo_value = ls_row_2-value.
      IF lo_value IS NOT INITIAL.
        lv_subnetid = lo_value->get_value( ).
      ENDIF.
    ENDLOOP.
    lv_vpcid = lo_cluster->get_vpcid( ).
    lv_networktype = lo_cluster->get_networktype( ).
    lo_certificates = lo_cluster->get_certificates( ).
    IF lo_certificates IS NOT INITIAL.
      lv_cert = lo_certificates->get_clustercsr( ).
      lv_cert = lo_certificates->get_hsmcertificate( ).
      lv_cert = lo_certificates->get_awshardwarecertificate( ).
      lv_cert = lo_certificates->get_manufacturerhardwarecert( ).
      lv_cert = lo_certificates->get_clustercertificate( ).
    ENDIF.
    LOOP AT lo_cluster->get_taglist( ) into lo_row_3.
      lo_row_4 = lo_row_3.
      IF lo_row_4 IS NOT INITIAL.
        lv_tagkey = lo_row_4->get_key( ).
        lv_tagvalue = lo_row_4->get_value( ).
      ENDIF.
    ENDLOOP.
    lv_clustermode = lo_cluster->get_mode( ).
  ENDIF.
ENDIF.