CREATEAPIKEYCREDPROVIDER()`¶

About CreateApiKeyCredentialProvider¶

Creates a new API key credential provider.

Method Signature¶

METHODS /AWS1/IF_BDO~CREATEAPIKEYCREDPROVIDER
  IMPORTING
    !IV_NAME TYPE /AWS1/BDOCREDPROVIDERNAME OPTIONAL
    !IV_APIKEY TYPE /AWS1/BDODEFAULTAPIKEYTYPE OPTIONAL
    !IO_APIKEYSECRETCONFIG TYPE REF TO /AWS1/CL_BDOSECRETREFERENCE OPTIONAL
    !IV_APIKEYSECRETSOURCE TYPE /AWS1/BDOSECRETSOURCETYPE OPTIONAL
    !IT_TAGS TYPE /AWS1/CL_BDOTAGSMAP_W=>TT_TAGSMAP OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_bdocreapikeycredpvd01
  RAISING
    /AWS1/CX_BDOACCESSDENIEDEX
    /AWS1/CX_BDOCONFLICTEXCEPTION
    /AWS1/CX_BDODECRYPTIONFAILURE
    /AWS1/CX_BDOENCRYPTIONFAILURE
    /AWS1/CX_BDOINTERNALSERVEREX
    /AWS1/CX_BDORESLIMITEXCDEX
    /AWS1/CX_BDORESOURCENOTFOUNDEX
    /AWS1/CX_BDOSERVICEQUOTAEXCDEX
    /AWS1/CX_BDOTHROTTLINGEX
    /AWS1/CX_BDOUNAUTHORIZEDEX
    /AWS1/CX_BDOVALIDATIONEX
    /AWS1/CX_BDOCLIENTEXC
    /AWS1/CX_BDOSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_name` `TYPE /AWS1/BDOCREDPROVIDERNAME` `/AWS1/BDOCREDPROVIDERNAME`¶

The name of the API key credential provider. The name must be unique within your account.

Optional arguments:¶

`iv_apikey` `TYPE /AWS1/BDODEFAULTAPIKEYTYPE` `/AWS1/BDODEFAULTAPIKEYTYPE`¶

The API key to use for authentication. This value is encrypted and stored securely.

`io_apikeysecretconfig` `TYPE REF TO /AWS1/CL_BDOSECRETREFERENCE` `/AWS1/CL_BDOSECRETREFERENCE`¶

A reference to the AWS Secrets Manager secret that stores the API key. This includes the secret ID and the JSON key used to extract the API key value from the secret. Required when apiKeySecretSource is set to EXTERNAL.

`iv_apikeysecretsource` `TYPE /AWS1/BDOSECRETSOURCETYPE` `/AWS1/BDOSECRETSOURCETYPE`¶

The source type of the API key secret. Use MANAGED if the secret is managed by the service, or EXTERNAL if you manage the secret yourself in AWS Secrets Manager.

`it_tags` `TYPE /AWS1/CL_BDOTAGSMAP_W=>TT_TAGSMAP` `TT_TAGSMAP`¶

A map of tag keys and values to assign to the API key credential provider. Tags enable you to categorize your resources in different ways, for example, by purpose, owner, or environment.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_bdocreapikeycredpvd01` `/AWS1/CL_BDOCREAPIKEYCREDPVD01`¶

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->createapikeycredprovider(
  io_apikeysecretconfig = new /aws1/cl_bdosecretreference(
    iv_jsonkey = |string|
    iv_secretid = |string|
  )
  it_tags = VALUE /aws1/cl_bdotagsmap_w=>tt_tagsmap(
    (
      VALUE /aws1/cl_bdotagsmap_w=>ts_tagsmap_maprow(
        key = |string|
        value = new /aws1/cl_bdotagsmap_w( |string| )
      )
    )
  )
  iv_apikey = |string|
  iv_apikeysecretsource = |string|
  iv_name = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lo_secret = lo_result->get_apikeysecretarn( ).
  IF lo_secret IS NOT INITIAL.
    lv_secretarn = lo_secret->get_secretarn( ).
  ENDIF.
  lv_secretjsonkeytype = lo_result->get_apikeysecretjsonkey( ).
  lv_secretsourcetype = lo_result->get_apikeysecretsource( ).
  lv_credentialprovidername = lo_result->get_name( ).
  lv_apikeycredentialprovide = lo_result->get_credentialproviderarn( ).
ENDIF.

/AWS1/IF_BDO=>CREATEAPIKEYCREDPROVIDER()¶