|
| 1 | +# TAGLINE |
| 2 | + |
| 3 | +Manage Amazon MQ message brokers. |
| 4 | + |
| 5 | +# TLDR |
| 6 | + |
| 7 | +**List all brokers** |
| 8 | + |
| 9 | +```aws mq list-brokers``` |
| 10 | + |
| 11 | +**Create an ActiveMQ broker** |
| 12 | + |
| 13 | +```aws mq create-broker --broker-name [my-broker] --engine-type ACTIVEMQ --engine-version [5.17.6] --host-instance-type [mq.m5.large] --deployment-mode SINGLE_INSTANCE --users Username=[admin],Password=[password]``` |
| 14 | + |
| 15 | +**Create a RabbitMQ broker** |
| 16 | + |
| 17 | +```aws mq create-broker --broker-name [my-broker] --engine-type RABBITMQ --engine-version [3.13] --host-instance-type [mq.m5.large] --deployment-mode SINGLE_INSTANCE --users Username=[admin],Password=[password]``` |
| 18 | + |
| 19 | +**Describe a broker** and get its details |
| 20 | + |
| 21 | +```aws mq describe-broker --broker-id [broker-id]``` |
| 22 | + |
| 23 | +**List all configurations** |
| 24 | + |
| 25 | +```aws mq list-configurations``` |
| 26 | + |
| 27 | +**Reboot a broker** |
| 28 | + |
| 29 | +```aws mq reboot-broker --broker-id [broker-id]``` |
| 30 | + |
| 31 | +**Delete a broker** |
| 32 | + |
| 33 | +```aws mq delete-broker --broker-id [broker-id]``` |
| 34 | + |
| 35 | +# SYNOPSIS |
| 36 | + |
| 37 | +**aws mq** _command_ [_options_] |
| 38 | + |
| 39 | +# DESCRIPTION |
| 40 | + |
| 41 | +**aws mq** is the AWS CLI interface for Amazon MQ, a managed message broker service that supports **Apache ActiveMQ** and **RabbitMQ** engines. Amazon MQ provisions, operates, and maintains message brokers, handling infrastructure tasks like hardware provisioning, broker setup, software upgrades, and failure detection. |
| 42 | + |
| 43 | +Amazon MQ provides compatibility with standard messaging APIs and protocols including JMS, NMS, AMQP, STOMP, MQTT, and WebSocket, allowing migration of existing messaging workloads to the cloud without rewriting application code. |
| 44 | + |
| 45 | +Brokers can be deployed in **single-instance** mode for development or **active/standby** mode for production high availability across multiple Availability Zones. |
| 46 | + |
| 47 | +# COMMANDS |
| 48 | + |
| 49 | +**create-broker** |
| 50 | +> Create a new message broker |
| 51 | +
|
| 52 | +**delete-broker** |
| 53 | +> Delete an existing broker |
| 54 | +
|
| 55 | +**describe-broker** |
| 56 | +> Get broker configuration, status, and endpoints |
| 57 | +
|
| 58 | +**list-brokers** |
| 59 | +> List all brokers in the account |
| 60 | +
|
| 61 | +**reboot-broker** |
| 62 | +> Restart a broker |
| 63 | +
|
| 64 | +**update-broker** |
| 65 | +> Modify broker configuration and maintenance settings |
| 66 | +
|
| 67 | +**create-configuration** |
| 68 | +> Create a broker configuration (ActiveMQ XML or RabbitMQ Cuttlefish) |
| 69 | +
|
| 70 | +**describe-configuration** |
| 71 | +> Get details of a configuration |
| 72 | +
|
| 73 | +**list-configurations** |
| 74 | +> List all configurations |
| 75 | +
|
| 76 | +**update-configuration** |
| 77 | +> Update a configuration with a new revision |
| 78 | +
|
| 79 | +**create-user** |
| 80 | +> Create a new ActiveMQ user on a broker |
| 81 | +
|
| 82 | +**delete-user** |
| 83 | +> Delete an ActiveMQ user |
| 84 | +
|
| 85 | +**list-users** |
| 86 | +> List all ActiveMQ users on a broker |
| 87 | +
|
| 88 | +**describe-user** |
| 89 | +> Get details of an ActiveMQ user |
| 90 | +
|
| 91 | +# CAVEATS |
| 92 | + |
| 93 | +Broker creation takes several minutes. Instance types and storage cannot be changed without downtime. ActiveMQ and RabbitMQ configurations differ significantly; user management commands only apply to ActiveMQ brokers, while RabbitMQ users are managed through the RabbitMQ web console. Maximum message size is limited by the engine (ActiveMQ defaults to 100MB, RabbitMQ to 128MB). |
| 94 | + |
| 95 | +# HISTORY |
| 96 | + |
| 97 | +Amazon MQ launched in **November 2017** with support for Apache ActiveMQ Classic. RabbitMQ engine support was added in **October 2020**. Support for ActiveMQ Artemis (the next-generation ActiveMQ) is not yet available through Amazon MQ. |
| 98 | + |
| 99 | +# SEE ALSO |
| 100 | + |
| 101 | +[aws](/man/aws)(1), [aws-sqs](/man/aws-sqs)(1), [aws-sns](/man/aws-sns)(1), [aws-kafka](/man/aws-kafka)(1) |
0 commit comments