mq_broker

Create, configure and manage Amazon MQ brokers

Collection: community.aws

Full Name: community.aws.mq_broker

Synopsis

Create, configure and manage Amazon MQ brokers

Parameters

Name	Type	Required	Default
access_key	str
authentication_strategy	str
auto_minor_version_upgrade	bool		`true`
aws_ca_bundle	path
aws_config	dict
broker_name	str	yes
debug_botocore_endpoint_logs	bool		`false`
deployment_mode	str
enable_audit_log	bool		`false`
enable_general_log	bool		`false`
endpoint_url	str
engine_type	str
engine_version	str
host_instance_type	str
kms_key_id	str
maintenance_window_start_time	dict
profile	str
publicly_accessible	bool
region	str
secret_key	str
security_groups	list
session_token	str
state	str		`present`
storage_type	str
subnet_ids	list
tags	dict
use_aws_owned_key	bool
users	list
validate_certs	bool		`true`
wait	bool		`false`
wait_timeout	int		`900`

Example

yaml

- 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

- 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