/AWS1/IF_LSA=>CREATEKEYPAIR()

About CreateKeyPair

Creates a custom SSH key pair that you can use with an Amazon Lightsail instance.

Use the DownloadDefaultKeyPair action to create a Lightsail default key pair in an Amazon Web Services Region where a default key pair does not currently exist.

The create key pair operation supports tag-based access control via request tags. For more information, see the Amazon Lightsail Developer Guide.

Method Signature

METHODS /AWS1/IF_LSA~CREATEKEYPAIR
  IMPORTING
    !IV_KEYPAIRNAME TYPE /AWS1/LSARESOURCENAME OPTIONAL
    !IT_TAGS TYPE /AWS1/CL_LSATAG=>TT_TAGLIST OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_lsacreatekeypairrslt
  RAISING
    /AWS1/CX_LSAACCESSDENIEDEX
    /AWS1/CX_LSAACCTSETUPINPRGSSEX
    /AWS1/CX_LSAINVALIDINPUTEX
    /AWS1/CX_LSANOTFOUNDEXCEPTION
    /AWS1/CX_LSAOPERATIONFAILUREEX
    /AWS1/CX_LSARGNSETUPINPRGSSEX
    /AWS1/CX_LSASERVICEEXCEPTION
    /AWS1/CX_LSAUNAUTHNTCTDEX
    /AWS1/CX_LSACLIENTEXC
    /AWS1/CX_LSASERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_keypairname TYPE /AWS1/LSARESOURCENAME /AWS1/LSARESOURCENAME

The name for your new key pair.

Optional arguments:

it_tags TYPE /AWS1/CL_LSATAG=>TT_TAGLIST TT_TAGLIST

The tag keys and optional values to add to the resource during create.

Use the TagResource action to tag a resource after it's created.

RETURNING

oo_output TYPE REF TO /aws1/cl_lsacreatekeypairrslt /AWS1/CL_LSACREATEKEYPAIRRSLT

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->createkeypair(
  it_tags = VALUE /aws1/cl_lsatag=>tt_taglist(
    (
      new /aws1/cl_lsatag(
        iv_key = |string|
        iv_value = |string|
      )
    )
  )
  iv_keypairname = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lo_keypair = lo_result->get_keypair( ).
  IF lo_keypair IS NOT INITIAL.
    lv_resourcename = lo_keypair->get_name( ).
    lv_nonemptystring = lo_keypair->get_arn( ).
    lv_string = lo_keypair->get_supportcode( ).
    lv_isodate = lo_keypair->get_createdat( ).
    lo_resourcelocation = lo_keypair->get_location( ).
    IF lo_resourcelocation IS NOT INITIAL.
      lv_string = lo_resourcelocation->get_availabilityzone( ).
      lv_regionname = lo_resourcelocation->get_regionname( ).
    ENDIF.
    lv_resourcetype = lo_keypair->get_resourcetype( ).
    LOOP AT lo_keypair->get_tags( ) into lo_row.
      lo_row_1 = lo_row.
      IF lo_row_1 IS NOT INITIAL.
        lv_tagkey = lo_row_1->get_key( ).
        lv_tagvalue = lo_row_1->get_value( ).
      ENDIF.
    ENDLOOP.
    lv_base64 = lo_keypair->get_fingerprint( ).
  ENDIF.
  lv_base64 = lo_result->get_publickeybase64( ).
  lv_base64 = lo_result->get_privatekeybase64( ).
  lo_operation = lo_result->get_operation( ).
  IF lo_operation IS NOT INITIAL.
    lv_nonemptystring = lo_operation->get_id( ).
    lv_resourcename = lo_operation->get_resourcename( ).
    lv_resourcetype = lo_operation->get_resourcetype( ).
    lv_isodate = lo_operation->get_createdat( ).
    lo_resourcelocation = lo_operation->get_location( ).
    IF lo_resourcelocation IS NOT INITIAL.
      lv_string = lo_resourcelocation->get_availabilityzone( ).
      lv_regionname = lo_resourcelocation->get_regionname( ).
    ENDIF.
    lv_boolean = lo_operation->get_isterminal( ).
    lv_string = lo_operation->get_operationdetails( ).
    lv_operationtype = lo_operation->get_operationtype( ).
    lv_operationstatus = lo_operation->get_status( ).
    lv_isodate = lo_operation->get_statuschangedat( ).
    lv_string = lo_operation->get_errorcode( ).
    lv_string = lo_operation->get_errordetails( ).
  ENDIF.
ENDIF.