Skip to content

/AWS1/IF_IOT=>UPDATEDOMAINCONFIGURATION()

About UpdateDomainConfiguration

Updates values stored in the domain configuration. Domain configurations for default endpoints can't be updated.

Requires permission to access the UpdateDomainConfiguration action.

Method Signature

METHODS /AWS1/IF_IOT~UPDATEDOMAINCONFIGURATION
  IMPORTING
    !IV_DOMAINCONFIGURATIONNAME TYPE /AWS1/IOTRSVDDOMAINCONFNAME OPTIONAL
    !IO_AUTHORIZERCONFIG TYPE REF TO /AWS1/CL_IOTAUTHORIZERCONFIG OPTIONAL
    !IV_DOMAINCONFIGURATIONSTATUS TYPE /AWS1/IOTDOMAINCONFSTATUS OPTIONAL
    !IV_REMOVEAUTHORIZERCONFIG TYPE /AWS1/IOTREMOVEAUTHRCONFIG OPTIONAL
    !IO_TLSCONFIG TYPE REF TO /AWS1/CL_IOTTLSCONFIG OPTIONAL
    !IO_SERVERCERTIFICATECONFIG TYPE REF TO /AWS1/CL_IOTSERVERCERTCONFIG OPTIONAL
    !IV_AUTHENTICATIONTYPE TYPE /AWS1/IOTAUTHENTICATIONTYPE OPTIONAL
    !IV_APPLICATIONPROTOCOL TYPE /AWS1/IOTAPPLICATIONPROTOCOL OPTIONAL
    !IO_CLIENTCERTIFICATECONFIG TYPE REF TO /AWS1/CL_IOTCLIENTCERTCONFIG OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_iotupdatedomconfrsp
  RAISING
    /AWS1/CX_IOTCERTVALIDATIONEX
    /AWS1/CX_IOTINTERNALFAILUREEX
    /AWS1/CX_IOTINVALIDREQUESTEX
    /AWS1/CX_IOTRESOURCENOTFOUNDEX
    /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_domainconfigurationname TYPE /AWS1/IOTRSVDDOMAINCONFNAME /AWS1/IOTRSVDDOMAINCONFNAME

The name of the domain configuration to be updated.

Optional arguments:

io_authorizerconfig TYPE REF TO /AWS1/CL_IOTAUTHORIZERCONFIG /AWS1/CL_IOTAUTHORIZERCONFIG

An object that specifies the authorization service for a domain.

iv_domainconfigurationstatus TYPE /AWS1/IOTDOMAINCONFSTATUS /AWS1/IOTDOMAINCONFSTATUS

The status to which the domain configuration should be updated.

iv_removeauthorizerconfig TYPE /AWS1/IOTREMOVEAUTHRCONFIG /AWS1/IOTREMOVEAUTHRCONFIG

Removes the authorization configuration from a domain.

io_tlsconfig TYPE REF TO /AWS1/CL_IOTTLSCONFIG /AWS1/CL_IOTTLSCONFIG

An object that specifies the TLS configuration for a domain.

io_servercertificateconfig TYPE REF TO /AWS1/CL_IOTSERVERCERTCONFIG /AWS1/CL_IOTSERVERCERTCONFIG

The server certificate configuration.

iv_authenticationtype TYPE /AWS1/IOTAUTHENTICATIONTYPE /AWS1/IOTAUTHENTICATIONTYPE

An enumerated string that specifies the authentication type.

  • CUSTOM_AUTH_X509 - Use custom authentication and authorization with additional details from the X.509 client certificate.

  • AWS_X509 - Use X.509 client certificates without custom authentication and authorization. For more information, see X.509 client certificates.

  • DEFAULT - Use a combination of port and Application Layer Protocol Negotiation (ALPN) to specify authentication type. For more information, see Device communication protocols.

iv_applicationprotocol TYPE /AWS1/IOTAPPLICATIONPROTOCOL /AWS1/IOTAPPLICATIONPROTOCOL

An enumerated string that specifies the application-layer protocol.

  • SECURE_MQTT - MQTT over TLS.

  • MQTT_WSS - MQTT over WebSocket.

  • HTTPS - HTTP over TLS.

  • DEFAULT - Use a combination of port and Application Layer Protocol Negotiation (ALPN) to specify application_layer protocol. For more information, see Device communication protocols.

io_clientcertificateconfig TYPE REF TO /AWS1/CL_IOTCLIENTCERTCONFIG /AWS1/CL_IOTCLIENTCERTCONFIG

An object that specifies the client certificate configuration for a domain.

RETURNING

oo_output TYPE REF TO /aws1/cl_iotupdatedomconfrsp /AWS1/CL_IOTUPDATEDOMCONFRSP

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->updatedomainconfiguration(
  io_authorizerconfig = new /aws1/cl_iotauthorizerconfig(
    iv_allowauthorizeroverride = ABAP_TRUE
    iv_defaultauthorizername = |string|
  )
  io_clientcertificateconfig = new /aws1/cl_iotclientcertconfig( |string| )
  io_servercertificateconfig = new /aws1/cl_iotservercertconfig(
    iv_enableocspcheck = ABAP_TRUE
    iv_ocspauthdresponderarn = |string|
    iv_ocsplambdaarn = |string|
  )
  io_tlsconfig = new /aws1/cl_iottlsconfig( |string| )
  iv_applicationprotocol = |string|
  iv_authenticationtype = |string|
  iv_domainconfigurationname = |string|
  iv_domainconfigurationstatus = |string|
  iv_removeauthorizerconfig = ABAP_TRUE
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_reserveddomainconfigura = lo_result->get_domainconfigurationname( ).
  lv_domainconfigurationarn = lo_result->get_domainconfigurationarn( ).
ENDIF.