/AWS1/IF_IOT=>CREATEAUTHORIZER()

About CreateAuthorizer

Creates an authorizer.

Requires permission to access the CreateAuthorizer action.

Method Signature

METHODS /AWS1/IF_IOT~CREATEAUTHORIZER
  IMPORTING
    !IV_AUTHORIZERNAME TYPE /AWS1/IOTAUTHORIZERNAME OPTIONAL
    !IV_AUTHORIZERFUNCTIONARN TYPE /AWS1/IOTAUTHORIZERFUNCTIONARN OPTIONAL
    !IV_TOKENKEYNAME TYPE /AWS1/IOTTOKENKEYNAME OPTIONAL
    !IT_TOKENSIGNINGPUBLICKEYS TYPE /AWS1/CL_IOTPUBLICKEYMAP_W=>TT_PUBLICKEYMAP OPTIONAL
    !IV_STATUS TYPE /AWS1/IOTAUTHORIZERSTATUS OPTIONAL
    !IT_TAGS TYPE /AWS1/CL_IOTTAG=>TT_TAGLIST OPTIONAL
    !IV_SIGNINGDISABLED TYPE /AWS1/IOTBOOLEANKEY OPTIONAL
    !IV_ENABLECACHINGFORHTTP TYPE /AWS1/IOTENABLECACHINGFORHTTP OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_iotcreateauthrrsp
  RAISING
    /AWS1/CX_IOTINTERNALFAILUREEX
    /AWS1/CX_IOTINVALIDREQUESTEX
    /AWS1/CX_IOTLIMITEXCEEDEDEX
    /AWS1/CX_IOTRESRCALRDYEXISTSEX
    /AWS1/CX_IOTSERVICEUNAVAILEX
    /AWS1/CX_IOTTHROTTLINGEX
    /AWS1/CX_IOTUNAUTHORIZEDEX
    /AWS1/CX_IOTCLIENTEXC
    /AWS1/CX_IOTSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_authorizername TYPE /AWS1/IOTAUTHORIZERNAME /AWS1/IOTAUTHORIZERNAME

The authorizer name.

iv_authorizerfunctionarn TYPE /AWS1/IOTAUTHORIZERFUNCTIONARN /AWS1/IOTAUTHORIZERFUNCTIONARN

The ARN of the authorizer's Lambda function.

Optional arguments:

iv_tokenkeyname TYPE /AWS1/IOTTOKENKEYNAME /AWS1/IOTTOKENKEYNAME

The name of the token key used to extract the token from the HTTP headers.

it_tokensigningpublickeys TYPE /AWS1/CL_IOTPUBLICKEYMAP_W=>TT_PUBLICKEYMAP TT_PUBLICKEYMAP

The public keys used to verify the digital signature returned by your custom authentication service.

iv_status TYPE /AWS1/IOTAUTHORIZERSTATUS /AWS1/IOTAUTHORIZERSTATUS

The status of the create authorizer request.

it_tags TYPE /AWS1/CL_IOTTAG=>TT_TAGLIST TT_TAGLIST

Metadata which can be used to manage the custom authorizer.

For URI Request parameters use format: ...key1=value1&key2=value2...

For the CLI command-line parameter use format: &&tags "key1=value1&key2=value2..."

For the cli-input-json file use format: "tags": "key1=value1&key2=value2..."

iv_signingdisabled TYPE /AWS1/IOTBOOLEANKEY /AWS1/IOTBOOLEANKEY

Specifies whether IoT validates the token signature in an authorization request.

iv_enablecachingforhttp TYPE /AWS1/IOTENABLECACHINGFORHTTP /AWS1/IOTENABLECACHINGFORHTTP

When true, the result from the authorizer’s Lambda function is cached for clients that use persistent HTTP connections. The results are cached for the time specified by the Lambda function in refreshAfterInSeconds. This value does not affect authorization of clients that use MQTT connections.

The default value is false.

RETURNING

oo_output TYPE REF TO /aws1/cl_iotcreateauthrrsp /AWS1/CL_IOTCREATEAUTHRRSP

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->createauthorizer(
  it_tags = VALUE /aws1/cl_iottag=>tt_taglist(
    (
      new /aws1/cl_iottag(
        iv_key = |string|
        iv_value = |string|
      )
    )
  )
  it_tokensigningpublickeys = VALUE /aws1/cl_iotpublickeymap_w=>tt_publickeymap(
    (
      VALUE /aws1/cl_iotpublickeymap_w=>ts_publickeymap_maprow(
        key = |string|
        value = new /aws1/cl_iotpublickeymap_w( |string| )
      )
    )
  )
  iv_authorizerfunctionarn = |string|
  iv_authorizername = |string|
  iv_enablecachingforhttp = ABAP_TRUE
  iv_signingdisabled = ABAP_TRUE
  iv_status = |string|
  iv_tokenkeyname = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_authorizername = lo_result->get_authorizername( ).
  lv_authorizerarn = lo_result->get_authorizerarn( ).
ENDIF.