The Wayback Machine - https://web.archive.org/web/20171226071147/http://docs.aws.amazon.com:80/amazon-mq/latest/developer-guide/amazon-mq-creating-configuring-broker.html
Menu
Sign In to the Console
Amazon MQ
Developer Guide

AWS Documentation » Amazon MQ » Developer Guide » Amazon MQ Tutorials » Tutorial: Creating and Configuring an Amazon MQ Broker

Tutorial: Creating and Configuring an Amazon MQ Broker

A broker is a message broker environment running on Amazon MQ. It is the basic building block of Amazon MQ. The combined description of the broker instance class (m4, t2) and size (large, micro) is a broker instance type (for example, mq.m4.large). For more information, see Broker.

The first and most common Amazon MQ task is creating a broker. The following example shows how you can use the AWS Management Console to create and configure a broker using the AWS Management Console.

Topics

Step 1: Configure basic broker settings

  1. Sign in to the Amazon MQ console.

  2. Do one of the following:

    • If this is your first time using Amazon MQ, in the Create a broker section, type MyBroker for Broker name and then choose Next step.

    • If you have created a broker before, on the Create a broker page, in the Broker details section, type MyBroker for Broker name.

  3. Choose a Broker instance type (for example, mq.m4.large). For more information, see Broker Instance Types.

  4. Choose a Deployment mode:

    • A Single-instance broker is comprised of one broker in one Availability Zone. The broker communicates with your application and with an AWS storage location. For more information, see Single-Instance Broker.

    • An Active/standby broker for high availability is comprised of two brokers in two different Availability Zones, configured in a redundant pair. These brokers communicate with your application, and with a shared storage location. For more information, see Active/Standby Broker for High Availability.

    Note

    Currently, Amazon MQ supports only the ActiveMQ broker engine, version 5.15.0.

  5. In the ActiveMQ Web Console access section, type a Username and Password.

Step 2: (Optional) Configure advanced broker settings

  1. Expand the Advanced settings section.

  2. In the Configuration section, choose Create a new configuration with default values or Select an existing configuration. For more information, see Configuration and Amazon MQ Broker Configuration Parameters.

  3. In the Network and security section, configure your broker's connectivity:

    1. Select the default Virtual Private Cloud (VPC) or create a new one on the Amazon VPC console. For more information, see What is Amazon VPC? in the Amazon VPC User Guide.

    2. Select the default Subnets or create new ones on the Amazon VPC console. For more information, see VPCs and Subnets in the Amazon VPC User Guide.

      Note

      A single-instance broker requires one subnet (for example, the default subnet). An active/standby broker for high availability requires two subnets.

    3. Select your Security group(s).

      Note

      Both single-instance brokers and active/standby brokers for high availability require at least one security group (for example, the default security group).

    4. Choose the Public accessibility of your broker.

      Note

      Disabling public accessibility makes the broker accessible only within your VPC.

  4. In the Maintenance section, configure your broker's maintenance schedule:

    1. To upgrade the broker to new versions as Apache releases them, choose Enable automatic minor version upgrades. Automatic upgrades occur during the maintenance window, defined by the day of the week, the time of day (in 24-hour format), and the time zone (UTC by default).

    2. Do one of the following:

      • To allow Amazon MQ to select the maintenance window automatically, choose No preference.

      • To set a custom maintenance window, choose Select maintenance window and then specify the Start day and Start time of the upgrades.

Step 3: Finish creating the broker

  1. Choose Create broker.

    While Amazon MQ creates your broker, it displays the Creation in progress status.

    Creating the broker takes about 10 minutes.

    When your broker is created successfully, Amazon MQ displays the Running status.

  2. Choose MyBroker.

    On the MyBroker page, in the Connect section, note your broker's ActiveMQ Web Console URL, for example: 

    https://b-1234a5b6-78cd-901e-2fgh-3i45j6k178l9-1.mq.us-east-1.amazonaws.com:8162

    Also, note your broker's wire-level protocol Endpoints. The following is an example of an OpenWire endpoint: 

    ssl://b-1234a5b6-78cd-901e-2fgh-3i45j6k178l9-1.mq.us-east-1.amazonaws.com:61617

Note

For an active/standby broker for high availability, Amazon MQ provides two ActiveMQ Web Console URLs, but only one URL is active at a time. Likewise, Amazon MQ provides two endpoints for each wire-level protocol, but only one endpoint is active in each pair at a time. The -1 and -2 suffixes denote a redundant pair. For more information, see Amazon MQ Broker Architecture).

For wire-level protocol endpoints, you can allow your application to connect to either endpoint by using the Failover Transport.