mq_user
Manage users in existing Amazon MQ broker
Collection: community.aws
Full Name: community.aws.mq_user
Synopsis
Manage users in existing Amazon MQ broker
Parameters
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
| access_key | str | |||
| allow_pw_update | bool | false | ||
| aws_ca_bundle | path | |||
| aws_config | dict | |||
| broker_id | str | yes | ||
| console_access | bool | |||
| debug_botocore_endpoint_logs | bool | false | ||
| endpoint_url | str | |||
| groups | list | |||
| password | str | |||
| profile | str | |||
| region | str | |||
| secret_key | str | |||
| session_token | str | |||
| state | str | present | ||
| username | str | yes | ||
| validate_certs | bool | true |
Example
yaml
- name: create/update user - set provided password if user doesn't exist, yet
community.aws.mq_user:
state: present
broker_id: "aws-mq-broker-id"
username: "sample_user1"
console_access: false
groups: ["g1", "g2"]
password: "plain-text-password"
- name: allow console access and update group list - relying on default state
community.aws.mq_user:
broker_id: "aws-mq-broker-id"
username: "sample_user1"
region: "{{ aws_region }}"
console_access: true
groups: ["g1", "g2", "g3"]
- name: remove user - setting all credentials explicitly
community.aws.mq_user:
state: absent
broker_id: "aws-mq-broker-id"
username: "other_user"