Skip to content

/AWS1/CL_MQ_USER

A user associated with the broker. For Amazon MQ for RabbitMQ brokers, one and only one administrative user is accepted and created when a broker is first provisioned. All subsequent broker users are created by making RabbitMQ API calls directly to brokers or via the RabbitMQ web console.

CONSTRUCTOR

IMPORTING

Required arguments:

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 broker user. The following restrictions apply to broker usernames:

  • For Amazon MQ for ActiveMQ brokers, this value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long.

  • para>For Amazon MQ for RabbitMQ brokers, this value can contain only alphanumeric characters, dashes, periods, underscores (- . _). This value must not contain a tilde (~) character. Amazon MQ prohibts using guest as a valid usename. This value must be 2-100 characters long.

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.

Optional arguments:

iv_consoleaccess TYPE /AWS1/MQ___BOOLEAN /AWS1/MQ___BOOLEAN

Enables access to the ActiveMQ Web Console for the ActiveMQ user. Does not apply to RabbitMQ brokers.

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. Does not apply to RabbitMQ brokers.

iv_replicationuser TYPE /AWS1/MQ___BOOLEAN /AWS1/MQ___BOOLEAN

Defines if this user is intended for CRDR replication purposes.

Queryable Attributes

ConsoleAccess

Enables access to the ActiveMQ Web Console for the ActiveMQ user. Does not apply to RabbitMQ brokers.

Accessible with the following methods

Method Description
GET_CONSOLEACCESS() Getter for CONSOLEACCESS, with configurable default
ASK_CONSOLEACCESS() Getter for CONSOLEACCESS w/ exceptions if field has no value
HAS_CONSOLEACCESS() Determine if CONSOLEACCESS has a value

Groups

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. Does not apply to RabbitMQ brokers.

Accessible with the following methods

Method Description
GET_GROUPS() Getter for GROUPS, with configurable default
ASK_GROUPS() Getter for GROUPS w/ exceptions if field has no value
HAS_GROUPS() Determine if GROUPS has a value

Password

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 (,:=).

Accessible with the following methods

Method Description
GET_PASSWORD() Getter for PASSWORD, with configurable default
ASK_PASSWORD() Getter for PASSWORD w/ exceptions if field has no value
HAS_PASSWORD() Determine if PASSWORD has a value

Username

The username of the broker user. The following restrictions apply to broker usernames:

  • For Amazon MQ for ActiveMQ brokers, this value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long.

  • para>For Amazon MQ for RabbitMQ brokers, this value can contain only alphanumeric characters, dashes, periods, underscores (- . _). This value must not contain a tilde (~) character. Amazon MQ prohibts using guest as a valid usename. This value must be 2-100 characters long.

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.

Accessible with the following methods

Method Description
GET_USERNAME() Getter for USERNAME, with configurable default
ASK_USERNAME() Getter for USERNAME w/ exceptions if field has no value
HAS_USERNAME() Determine if USERNAME has a value

ReplicationUser

Defines if this user is intended for CRDR replication purposes.

Accessible with the following methods

Method Description
GET_REPLICATIONUSER() Getter for REPLICATIONUSER, with configurable default
ASK_REPLICATIONUSER() Getter for REPLICATIONUSER w/ exceptions if field has no val
HAS_REPLICATIONUSER() Determine if REPLICATIONUSER has a value

Public Local Types In This Class

Internal table types, representing arrays and maps of this class, are defined as local types:

TT___LISTOFUSER

TYPES TT___LISTOFUSER TYPE STANDARD TABLE OF REF TO /AWS1/CL_MQ_USER WITH DEFAULT KEY
.