users

Creates, updates, deletes, gets or lists a users resource.

Overview

Name	users
Type	Resource
Id	aws.mq.users

Fields

The following fields are returned by SELECT queries:

describe_user

Name	Datatype	Description
broker_id	string	Required. The unique ID that Amazon MQ generates for the broker.
console_access	boolean	Enables access to the the ActiveMQ Web Console for the ActiveMQ user.
groups	array	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.
pending	object	The status of the changes pending for the ActiveMQ user.
replication_user	boolean	Describes whether the user is intended for data replication
username	string	Required. 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.

list_users

Name	Datatype	Description
broker_id	string	Required. The unique ID that Amazon MQ generates for the broker.
max_results	integer	Required. The maximum number of ActiveMQ users that can be returned per page (20 by default). This value must be an integer from 5 to 100.
next_token	string	The token that specifies the next page of results Amazon MQ should return. To request the first page, leave nextToken empty.
users	array	Required. The list of all ActiveMQ usernames for the specified broker. Does not apply to RabbitMQ brokers.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_user	select	broker-id, username, region		Returns information about an ActiveMQ user.
list_users	select	broker-id, region	maxResults, nextToken	Returns a list of all ActiveMQ users.
create_user	insert	broker-id, username, region, Password		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.
update_user	update	broker-id, username, region		Updates the information for an ActiveMQ user.
delete_user	delete	broker-id, username, region		Deletes an ActiveMQ user.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
broker-id	string	The unique ID that Amazon MQ generates for the broker.
region	string	AWS region (default: us-east-1)
username	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.
maxResults	integer	The maximum number of brokers that Amazon MQ can return per page (20 by default). This value must be an integer from 5 to 100.
nextToken	string	The token that specifies the next page of results Amazon MQ should return. To request the first page, leave nextToken empty.

SELECT examples

describe_user

Returns information about an ActiveMQ user.

SELECT
broker_id,
console_access,
groups,
pending,
replication_user,
username
FROM aws.mq.users
WHERE `broker-id` = '{{ broker-id }}' -- required
AND username = '{{ username }}' -- required
AND region = '{{ region }}' -- required
;

list_users

Returns a list of all ActiveMQ users.

SELECT
broker_id,
max_results,
next_token,
users
FROM aws.mq.users
WHERE `broker-id` = '{{ broker-id }}' -- required
AND region = '{{ region }}' -- required
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
;

INSERT examples

create_user

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.

INSERT INTO aws.mq.users (
ConsoleAccess,
Groups,
Password,
ReplicationUser,
`broker-id`,
username,
region
)
SELECT 
{{ ConsoleAccess }},
'{{ Groups }}',
'{{ Password }}' /* required */,
{{ ReplicationUser }},
'{{ broker-id }}',
'{{ username }}',
'{{ region }}'
;

Manifest

# Description fields are for documentation purposes
- name: users
props:
  - name: broker-id
    value: "{{ broker-id }}"
    description: Required parameter for the users resource.
  - name: username
    value: "{{ username }}"
    description: Required parameter for the users resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the users resource.
  - name: ConsoleAccess
    value: {{ ConsoleAccess }}
  - name: Groups
    value:
      - "{{ Groups }}"
  - name: Password
    value: "{{ Password }}"
  - name: ReplicationUser
    value: {{ ReplicationUser }}

UPDATE examples

update_user

Updates the information for an ActiveMQ user.

UPDATE aws.mq.users
SET 
ConsoleAccess = {{ ConsoleAccess }},
Groups = '{{ Groups }}',
Password = '{{ Password }}',
ReplicationUser = {{ ReplicationUser }}
WHERE 
`broker-id` = '{{ broker-id }}' --required
AND username = '{{ username }}' --required
AND region = '{{ region }}' --required;

DELETE examples

delete_user

Deletes an ActiveMQ user.

DELETE FROM aws.mq.users
WHERE `broker-id` = '{{ broker-id }}' --required
AND username = '{{ username }}' --required
AND region = '{{ region }}' --required
;