community.aws.mq_broker module – MQ broker management
Note
This module is part of the community.aws collection (version 9.0.0).
You might already have this collection installed if you are using the ansible package.
It is not included in ansible-core.
To check whether it is installed, run ansible-galaxy collection list.
To install it, use: ansible-galaxy collection install community.aws.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: community.aws.mq_broker.
New in community.aws 6.0.0
Synopsis
Create/update/delete a broker.
Reboot a broker.
Requirements
The below requirements are needed on the host that executes this module.
python >= 3.6
boto3 >= 1.28.0
botocore >= 1.31.0
Parameters
Parameter |
Comments |
|---|---|
AWS access key ID. See the AWS documentation for more information about access tokens https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. The The aws_access_key and profile options are mutually exclusive. The aws_access_key_id alias was added in release 5.1.0 for consistency with the AWS botocore SDK. The ec2_access_key alias has been deprecated and will be removed in a release after 2024-12-01. Support for the |
|
Choose between locally and remotely managed users. Choices:
|
|
Allow/disallow automatic minor version upgrades. Choices:
|
|
The location of a CA Bundle to use when validating SSL certificates. The |
|
A dictionary to modify the botocore configuration. Parameters can be found in the AWS documentation https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config. |
|
The Name of the MQ broker to work on. |
|
Use a The Choices:
|
|
Set broker deployment type. Can be used only during creation. Defaults to Choices:
|
|
Enable/disable to push audit logs to AWS CloudWatch. Choices:
|
|
Enable/disable to push general logs to AWS CloudWatch. Choices:
|
|
URL to connect to instead of the default AWS endpoints. While this can be used to connection to other AWS-compatible services the amazon.aws and community.aws collections are only tested against AWS. The The ec2_url and s3_url aliases have been deprecated and will be removed in a release after 2024-12-01. Support for the |
|
Set broker engine type. Can be used only during creation. Defaults to Choices:
|
|
Set engine version of broker. The special value The special value |
|
Instance type of broker instances. |
|
Use referenced key to encrypt broker data at rest. Can be used only during creation. |
|
Set maintenance window for automatic minor upgrades. Can be used only during creation. Not providing any value means “no maintenance window”. |
|
A named AWS profile to use for authentication. See the AWS documentation for more information about named profiles https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html. The The profile option is mutually exclusive with the aws_access_key, aws_secret_key and security_token options. |
|
Allow/disallow public access. Can be used only during creation. Defaults to Choices:
|
|
The AWS region to use. For global services such as IAM, Route53 and CloudFront, region is ignored. The See the Amazon AWS documentation for more information http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region. The Support for the |
|
AWS secret access key. See the AWS documentation for more information about access tokens https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. The The secret_key and profile options are mutually exclusive. The aws_secret_access_key alias was added in release 5.1.0 for consistency with the AWS botocore SDK. The ec2_secret_key alias has been deprecated and will be removed in a release after 2024-12-01. Support for the |
|
Associate security groups with broker. At least one must be provided during creation. |
|
AWS STS session token for use with temporary credentials. See the AWS documentation for more information about access tokens https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. The The security_token and profile options are mutually exclusive. Aliases aws_session_token and session_token were added in release 3.2.0, with the parameter being renamed from security_token to session_token in release 6.0.0. The security_token, aws_security_token, and access_token aliases have been deprecated and will be removed in a release after 2024-12-01. Support for the |
|
Choices:
|
|
Set underlying storage type. Can be used only during creation. Defaults to Choices:
|
|
Defines where deploy broker instances to. Minimum required number depends on deployment type. Can be used only during creation. |
|
Tag newly created brokers. Can be used only during creation. |
|
Must be set to Can be used only during creation. Defaults to Choices:
|
|
This parameter allows to use a custom set of initial user(s). community.aws.mq_user is the preferred way to manage (local) users however a broker cannot be created without any user. If nothing is specified a default Can be used only during creation. Use community.aws.mq_user module for updates. |
|
When set to Setting validate_certs=false is strongly discouraged, as an alternative, consider setting aws_ca_bundle instead. Choices:
|
|
Specifies whether the module waits for the desired The time to wait can be controlled by setting wait_timeout. Choices:
|
|
How long to wait (in seconds) for the broker to reach the desired state if wait=true. Default: |
Notes
Note
Caution: For modules, environment variables and configuration files are read from the Ansible ‘host’ context and not the ‘controller’ context. As such, files may need to be explicitly copied to the ‘host’. For lookup and connection plugins, environment variables and configuration files are read from the Ansible ‘controller’ context and not the ‘host’ context.
The AWS SDK (boto3) that Ansible uses may also read defaults for credentials and other settings, such as the region, from its configuration files in the Ansible ‘host’ context (typically
~/.aws/credentials). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information.
Examples
- name: create broker (if missing) with minimal required parameters
community.aws.mq_broker:
broker_name: "{{ broker_name }}"
security_groups:
- sg_xxxxxxx
subnet_ids:
- subnet_xxx
- subnet_yyy
register: result
- set_fact:
broker_id: "{{ result.broker['BrokerId'] }}"
- name: use mq_broker_info to wait until broker is ready
community.aws.mq_broker_info:
broker_id: "{{ broker_id }}"
register: result
until: "result.broker['BrokerState'] == 'RUNNING'"
retries: 15
delay: 60
- name: create or update broker with almost all parameter set including credentials
community.aws.mq_broker:
broker_name: "my_broker_2"
state: present
deployment_mode: 'ACTIVE_STANDBY_MULTI_AZ'
use_aws_owned_key: false
kms_key_id: 'my-precreted-key-id'
engine_type: 'ACTIVEMQ'
maintenance_window_start_time:
DayOfWeek: 'MONDAY'
TimeOfDay: '03:15'
TimeZone: 'Europe/Berlin'
publicly_accessible: true
storage_type: 'EFS'
security_groups:
- sg_xxxxxxx
subnet_ids:
- subnet_xxx
- subnet_yyy
users:
- Username: 'initial-user'
Password': 'plain-text-password'
ConsoleAccess: true
tags:
env: Test
creator: ansible
authentication_strategy: 'SIMPLE'
auto_minor_version_upgrade: true
engine_version: "5.15.13"
host_instance_type: 'mq.t3.micro'
enable_audit_log: true
enable_general_log: true
- name: reboot a broker
community.aws.mq_broker:
broker_name: "my_broker_2"
state: restarted
- name: delete a broker
community.aws.mq_broker:
broker_name: "my_broker_2"
state: absent
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
All API responses are converted to snake yaml except ‘Tags’ ‘state=present’: API response of create_broker() or update_broker() call ‘state=absent’: result of describe_broker() call before delete_broker() is triggerd ‘state=restarted’: result of describe_broker() after reboot has been triggered Returned: success |