Skip to content

/AWS1/IF_MQ=>CREATEUSER()

About CreateUser

Creates an ActiveMQ user.

Do not add personally identifiable information (PII) or other confidential or sensitive information in broker usernames. Broker usernames are accessible to other Amazon Web Services services, including CloudWatch Logs. Broker usernames are not intended to be used for private or sensitive data.

Method Signature

METHODS /AWS1/IF_MQ~CREATEUSER
  IMPORTING
    !IV_BROKERID TYPE /AWS1/MQ___STRING OPTIONAL
    !IV_CONSOLEACCESS TYPE /AWS1/MQ___BOOLEAN OPTIONAL
    !IT_GROUPS TYPE /AWS1/CL_MQ___LISTOF__STRING_W=>TT___LISTOF__STRING OPTIONAL
    !IV_PASSWORD TYPE /AWS1/MQ___STRING OPTIONAL
    !IV_USERNAME TYPE /AWS1/MQ___STRING OPTIONAL
    !IV_REPLICATIONUSER TYPE /AWS1/MQ___BOOLEAN OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_mq_createuserresponse
  RAISING
    /AWS1/CX_MQ_BADREQUESTEX
    /AWS1/CX_MQ_CONFLICTEXCEPTION
    /AWS1/CX_MQ_FORBIDDENEXCEPTION
    /AWS1/CX_MQ_INTERNALSERVERER00
    /AWS1/CX_MQ_NOTFOUNDEXCEPTION
    /AWS1/CX_MQ_CLIENTEXC
    /AWS1/CX_MQ_SERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_brokerid TYPE /AWS1/MQ___STRING /AWS1/MQ___STRING

The unique ID that Amazon MQ generates for the broker.

iv_password TYPE /AWS1/MQ___STRING /AWS1/MQ___STRING

Required. The password of the user. This value must be at least 12 characters long, must contain at least 4 unique characters, and must not contain commas, colons, or equal signs (,:=).

iv_username TYPE /AWS1/MQ___STRING /AWS1/MQ___STRING

The username of the ActiveMQ user. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long.

Optional arguments:

iv_consoleaccess TYPE /AWS1/MQ___BOOLEAN /AWS1/MQ___BOOLEAN

Enables access to the ActiveMQ Web Console for the ActiveMQ user.

it_groups TYPE /AWS1/CL_MQ___LISTOF__STRING_W=>TT___LISTOF__STRING TT___LISTOF__STRING

The list of groups (20 maximum) to which the ActiveMQ user belongs. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long.

iv_replicationuser TYPE /AWS1/MQ___BOOLEAN /AWS1/MQ___BOOLEAN

Defines if this user is intended for CRDR replication purposes.

RETURNING

oo_output TYPE REF TO /aws1/cl_mq_createuserresponse /AWS1/CL_MQ_CREATEUSERRESPONSE

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->createuser(
  it_groups = VALUE /aws1/cl_mq___listof__string_w=>tt___listof__string(
    ( new /aws1/cl_mq___listof__string_w( |string| ) )
  )
  iv_brokerid = |string|
  iv_consoleaccess = ABAP_TRUE
  iv_password = |string|
  iv_replicationuser = ABAP_TRUE
  iv_username = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
ENDIF.