Skip to content
This repository has been archived by the owner on Jun 15, 2023. It is now read-only.

Commit

Permalink
Updated the documentation.
Browse files Browse the repository at this point in the history
  • Loading branch information
Michael Khmelnitsky committed Oct 1, 2018
1 parent d3a3a74 commit c2b60af
Show file tree
Hide file tree
Showing 19 changed files with 99 additions and 60 deletions.
2 changes: 1 addition & 1 deletion doc_source/amazon-mq-basic-elements.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,5 +5,5 @@ This section introduces key concepts essential to understanding Amazon MQ\.
**Topics**
+ [Broker](broker.md)
+ [Configuration](configuration.md)
+ [Engine](broker-engine.md)
+ [Broker Engine](broker-engine.md)
+ [User](user.md)
2 changes: 1 addition & 1 deletion doc_source/amazon-mq-broker-configuration-parameters.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ A *configuration* contains all of the settings for your ActiveMQ broker, in XML

ActiveMQ brokers are configured using [Spring XML](https://docs.spring.io/spring/docs/current/spring-framework-reference/) files\. You can configure many aspects of your ActiveMQ broker, such as predefined destinations, destination policies, authorization policies, and plugins\. Amazon MQ controls some of these configuration elements, such as network transports and storage\. Other configuration options, such as creating networks of brokers, aren't currently supported\.

The full set of supported configuration options is specified in the [Amazon MQ XML schema](https://s3-us-west-2.amazonaws.com/amazon-mq-docs/XML/amazon-mq-active-mq-5.15.0.xsd)\. You can use this schema to validate and sanitize your configuration files\. Amazon MQ also lets you provide configurations by uploading XML files\. When you upload an XML file, Amazon MQ automatically sanitizes and removes invalid and prohibited configuration parameters according to the schema\.
The full set of supported configuration options is specified in the [Amazon MQ XML schema](https://s3-us-west-2.amazonaws.com/amazon-mq-docs/XML/amazon-mq-active-mq-5.15.6.xsd)\. You can use this schema to validate and sanitize your configuration files\. Amazon MQ also lets you provide configurations by uploading XML files\. When you upload an XML file, Amazon MQ automatically sanitizes and removes invalid and prohibited configuration parameters according to the schema\.

**Note**
You can use only static values for attributes\. Amazon MQ sanitizes elements and attributes that contain Spring expressions, variables, and element references from your configuration\.
Expand Down
12 changes: 6 additions & 6 deletions doc_source/amazon-mq-connecting-application.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@ You can connect to ActiveMQ brokers using [various ActiveMQ clients](http://acti

**Topics**
+ [Prerequisites](#connect-application-prerequisites-tutorial)
+ [To create a message producer and send a message](#create-producer-send-message-tutorial)
+ [To create a message consumer and receive the message](#create-consumer-receive-message-tutorial)
+ [To Create a Message Producer and Send a Message](#create-producer-send-message-tutorial)
+ [To Create a Message Consumer and Receive the Message](#create-consumer-receive-message-tutorial)

## Prerequisites<a name="connect-application-prerequisites-tutorial"></a>

Expand Down Expand Up @@ -54,12 +54,12 @@ Add the `activemq-client.jar` and `activemq-pool.jar` packages to your Java clas
<dependency>
<groupId>org.apache.activemq</groupId>
<artifactId>activemq-client</artifactId>
<version>5.15.0</version>
<version>5.15.6</version>
</dependency>
<dependency>
<groupId>org.apache.activemq</groupId>
<artifactId>activemq-pool</artifactId>
<version>5.15.0</version>
<version>5.15.6</version>
</dependency>
</dependencies>
```
Expand All @@ -69,7 +69,7 @@ For more information about `activemq-client.jar`, see [Initial Configuration](ht
**Important**
In the following example code, producers and consumers run in a single thread\. For production systems \(or to test broker instance failover\), make sure that your producers and consumers run on separate hosts or threads\.

## To create a message producer and send a message<a name="create-producer-send-message-tutorial"></a>
## To Create a Message Producer and Send a Message<a name="create-producer-send-message-tutorial"></a>

1. Create a JMS pooled connection factory for the message producer using your broker's endpoint and then call the `createConnection` method against the factory\.
**Note**
Expand Down Expand Up @@ -130,7 +130,7 @@ Message producers should always use the `PooledConnectionFactory` class\. For mo
producerConnection.close();
```

## To create a message consumer and receive the message<a name="create-consumer-receive-message-tutorial"></a>
## To Create a Message Consumer and Receive the Message<a name="create-consumer-receive-message-tutorial"></a>

1. Create a JMS connection factory for the message producer using your broker's endpoint and then call the `createConnection` method against the factory\.

Expand Down
21 changes: 10 additions & 11 deletions doc_source/amazon-mq-creating-applying-configurations.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,11 +14,11 @@ For more information, see the following:
The following example shows how you can create and apply an Amazon MQ broker configuration using the AWS Management Console\.

**Topics**
+ [Step 1: Create a configuration from scratch](#creating-configuration-from-scratch-console)
+ [Step 2: Create a new configuration revision](#creating-new-configuration-revision-console)
+ [Step 3: Apply a configuration revision to your broker](#apply-configuration-revision-creating-console)
+ [Step 1: Create a Configuration from Scratch](#creating-configuration-from-scratch-console)
+ [Step 2: Create a New Configuration Revision](#creating-new-configuration-revision-console)
+ [Step 3: Apply a Configuration Revision to Your Broker](#apply-configuration-revision-creating-console)

## Step 1: Create a configuration from scratch<a name="creating-configuration-from-scratch-console"></a>
## Step 1: Create a Configuration from Scratch<a name="creating-configuration-from-scratch-console"></a>

1. Sign in to the [Amazon MQ console](https://console.aws.amazon.com/amazon-mq/)\.

Expand All @@ -27,19 +27,19 @@ The following example shows how you can create and apply an Amazon MQ broker con

1. On the **Configurations** page, choose **Create configuration**\.

1. On the **Create configuration** page, in the **Details** section, type the **Configuration name** \(for example, `MyConfiguration`\)\.
1. On the **Create configuration** page, in the **Details** section, type the **Configuration name** \(for example, `MyConfiguration`\) and select a **Broker engine** version\.
**Note**
Currently, Amazon MQ supports only the `ActiveMQ` broker engine, version `5.15.0`\.
Currently, Amazon MQ supports only `ActiveMQ` broker engine versions `5.15.6` and `5.15.0`\.

1. Choose **Create configuration**\.

## Step 2: Create a new configuration revision<a name="creating-new-configuration-revision-console"></a>
## Step 2: Create a New Configuration Revision<a name="creating-new-configuration-revision-console"></a>

1. From the configuration list, choose ***MyConfiguration***\.
**Note**
The first configuration revision is always created for you when Amazon MQ creates the configuration\.

On the ***MyConfiguration*** page, the broker engine type and version that your new configuration revision uses \(for example, **Apache ActiveMQ 5\.15\.0**\) are displayed\.
On the ***MyConfiguration*** page, the broker engine type and version that your new configuration revision uses \(for example, **Apache ActiveMQ 5\.15\.6**\) are displayed\.

1. On the **Configuration details** tab, the configuration revision number, description, and broker configuration in XML format are displayed\.
**Note**
Expand All @@ -62,15 +62,14 @@ The Amazon MQ console automatically sanitizes invalid and prohibited configurati
Making changes to a configuration does *not* apply the changes to the broker immediately\. To apply your changes, you must [wait for the next maintenance window](amazon-mq-editing-managing-configurations.md#apply-configuration-revision-editing-console) or [reboot the broker](amazon-mq-rebooting-broker.md)\. For more information, see [Amazon MQ Broker Configuration Lifecycle](amazon-mq-broker-configuration-lifecycle.md)\.
Currently, it isn't possible to delete a configuration\.

## Step 3: Apply a configuration revision to your broker<a name="apply-configuration-revision-creating-console"></a>
## Step 3: Apply a Configuration Revision to Your Broker<a name="apply-configuration-revision-creating-console"></a>

1. On the left, expand the navigation panel and choose **Brokers**\.
![\[Image NOT FOUND\]](http://docs.aws.amazon.com/amazon-mq/latest/developer-guide/images/amazon-mq-tutorials-apply-configuration.png)

1. From the broker list, select your broker \(for example, **MyBroker**\) and then choose **Edit**\.

1. On the **Edit *MyBroker*** page, in the **Configuration** section, select a **Configuration** ![\[Image NOT FOUND\]](http://docs.aws.amazon.com/amazon-mq/latest/developer-guide/images/number-1-red.png) and a **Revision** ![\[Image NOT FOUND\]](http://docs.aws.amazon.com/amazon-mq/latest/developer-guide/images/number-2-red.png) and then choose **Schedule Modifications** ![\[Image NOT FOUND\]](http://docs.aws.amazon.com/amazon-mq/latest/developer-guide/images/number-3-red.png)\.
![\[Image NOT FOUND\]](http://docs.aws.amazon.com/amazon-mq/latest/developer-guide/images/amazon-mq-tutorials-configuration-schedule-modifications.png)
1. On the **Edit *MyBroker*** page, in the **Configuration** section, select a **Configuration** and a **Revision** and then choose **Schedule Modifications**\.

1. In the **Schedule broker modifications** section, choose whether to apply modifications **During the next scheduled maintenance window** or **Immediately**\.
**Important**
Expand Down
19 changes: 10 additions & 9 deletions doc_source/amazon-mq-creating-configuring-broker.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,12 @@ A *broker* is a message broker environment running on Amazon MQ\. It is the basi
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](#configure-basic-broker-settings-console)
+ [Configure advanced broker settings](#configure-advanced-broker-settings-console)
+ [Step 3: Finish creating the broker](#finish-creating-broker-console)
+ [Configure Basic Broker Settings](#configure-basic-broker-settings-console)
+ [Configure Advanced Broker Settings](#configure-advanced-broker-settings-console)
+ [Step 3: Finish Creating the Broker](#finish-creating-broker-console)
+ [Accessing the ActiveMQ Web Console of a Broker without Public Accessibility](accessing-web-console-of-broker-without-private-accessibility.md)

## Step 1: Configure basic broker settings<a name="configure-basic-broker-settings-console"></a>
## Step 1: Configure Basic Broker Settings<a name="configure-basic-broker-settings-console"></a>

1. Sign in to the [Amazon MQ console](https://console.aws.amazon.com/amazon-mq/)\.

Expand All @@ -23,12 +23,14 @@ The first and most common Amazon MQ task is creating a broker\. The following ex
1. 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 [Amazon MQ Single\-Instance Broker](single-broker-deployment.md)\.
+ 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 synchronously with your application, and with a shared storage location\. For more information, see [Amazon MQ Active/Standby Broker for High Availability](active-standby-broker-deployment.md)\.

1. Choose a **Broker engine** version\.
**Note**
Currently, Amazon MQ supports only the `ActiveMQ` broker engine, version `5.15.0`\.
Currently, Amazon MQ supports only `ActiveMQ` broker engine versions `5.15.6` and `5.15.0`\.

1. In the **ActiveMQ Web Console access** section, type a **Username** and **Password**\.

## Step 2: \(Optional\) Configure advanced broker settings<a name="configure-advanced-broker-settings-console"></a>
## Step 2: \(Optional\) Configure Advanced Broker Settings<a name="configure-advanced-broker-settings-console"></a>

**Important**
**Subnet\(s\)** – A single\-instance broker requires one subnet \(for example, the default subnet\)\. An active/standby broker requires two subnets\.
Expand All @@ -43,8 +45,7 @@ Currently, Amazon MQ supports only the `ActiveMQ` broker engine, version `5.15.0
1. In the **Logs** section, choose whether to publish **General** logs and **Audit** logs to Amazon CloudWatch Logs\. For more information, see [Configuring Amazon MQ to Publish General and Audit Logs to Amazon CloudWatch Logs](amazon-mq-configuring-cloudwatch-logs.md)\.
**Important**
If you don't [add the `CreateLogGroup` permission to your Amazon MQ user](amazon-mq-configuring-cloudwatch-logs.md#add-createloggroup-permission-to-user) before the user creates or reboots the broker, Amazon MQ doesn't create the log group\.
If you don't [configure a resource\-based policy for Amazon MQ](amazon-mq-configuring-cloudwatch-logs.md#configure-resource-based-policy), the broker can't publish the logs to CloudWatch Logs\.
![\[Image NOT FOUND\]](http://docs.aws.amazon.com/amazon-mq/latest/developer-guide/images/amazon-mq-tutorials-enable-cloudwatch-logs.png)
If you don't [configure a resource\-based policy for Amazon MQ](amazon-mq-configuring-cloudwatch-logs.md#configure-resource-based-policy), the broker can't publish the logs to CloudWatch Logs\.

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

Expand All @@ -70,7 +71,7 @@ For an active/standby broker, if one of the broker instances undergoes maintenan
+ 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<a name="finish-creating-broker-console"></a>
## Step 3: Finish Creating the Broker<a name="finish-creating-broker-console"></a>

1. Choose **Create broker**\.

Expand Down
2 changes: 1 addition & 1 deletion doc_source/amazon-mq-deleting-broker.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ If you don't use an Amazon MQ broker \(and don't foresee using it in the near fu

The following example shows how you can delete a broker using the AWS Management Console\.

## To delete an Amazon MQ broker<a name="deleting-broker-console"></a>
## To Delete an Amazon MQ Broker<a name="deleting-broker-console"></a>

1. Sign in to the [Amazon MQ console](https://console.aws.amazon.com/amazon-mq/)\.

Expand Down
1 change: 1 addition & 0 deletions doc_source/amazon-mq-documentation-history.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ The following table lists changes to the *Amazon MQ Developer Guide*\. For Amazo

| Date | Documentation Update |
| --- | --- |
| September 27, 2018 | [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/amazon-mq/latest/developer-guide/amazon-mq-documentation-history.html) |
| September 18, 2018 | Added the following note to the [Tutorial: Creating and Managing Amazon MQ Broker Users](amazon-mq-listing-managing-users.md) section: You can't configure groups independently of users\. A group label is created when you add at least one user to it and deleted when you remove all users from it\. |
| September 10, 2018 | Updated the [Frequently Viewed Amazon MQ Topics](amazon-mq-newly-added-most-frequently-viewed-topics.md) section\. |
| August 31, 2018 | [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/amazon-mq/latest/developer-guide/amazon-mq-documentation-history.html) |
Expand Down
35 changes: 35 additions & 0 deletions doc_source/amazon-mq-editing-broker-preferences.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
# Tutorial: Editing Broker Engine Version, CloudWatch Logs, and Maintenance Preferences<a name="amazon-mq-editing-broker-preferences"></a>

In addition to [editing broker configurations and managing configuration revisions](amazon-mq-editing-managing-configurations.md), you can configure preferences specific to the broker\.

**Note**
All preferences except for those for automatic minor version upgrades require you to schedule modifications\. For more information, see [Amazon MQ Broker Configuration Lifecycle](amazon-mq-broker-configuration-lifecycle.md)\.

The following example shows how you can edit Amazon MQ broker preferences using the AWS Management Console\.

## To Edit Broker Engine Version, CloudWatch Logs, and Maintenance Preferences<a name="edit-current-configuration-console"></a>

1. Sign in to the [Amazon MQ console](https://console.aws.amazon.com/amazon-mq/)\.

1. From the broker list, select your broker \(for example, **MyBroker**\) and then choose **Edit**\.

1. On the **Edit *MyBroker*** page, in the **Specifications** section, select a **Broker engine version**\.

1. In the **Configuration** section, select the configuration and revision for your broker\. For more information, see [Tutorial: Editing Amazon MQ Broker Configurations and Managing Configuration Revisions](amazon-mq-editing-managing-configurations.md)\.

1. In the **CloudWatch Logs** section, choose whether to publish **General** logs and **Audit** logs to Amazon CloudWatch Logs\. For more information, see [Configuring Amazon MQ to Publish General and Audit Logs to Amazon CloudWatch Logs](amazon-mq-configuring-cloudwatch-logs.md)\.
**Important**
If you don't [add the `CreateLogGroup` permission to your Amazon MQ user](amazon-mq-configuring-cloudwatch-logs.md#add-createloggroup-permission-to-user) before the user creates or reboots the broker, Amazon MQ doesn't create the log group\.
If you don't [configure a resource\-based policy for Amazon MQ](amazon-mq-configuring-cloudwatch-logs.md#configure-resource-based-policy), the broker can't publish the logs to CloudWatch Logs\.

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

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\)\.
**Note**
For an active/standby broker, if one of the broker instances undergoes maintenance, it takes Amazon MQ a short while to take the inactive instance out of service, allowing the healthy standby instance to become active and to begin accepting incoming communications\.

1. Choose **Schedule modifications**\.
**Note**
If you choose only **Enable automatic minor version upgrades**, the button changes to **Save** because no broker reboot is necessary\.

Your preferences are applied to your broker at the specified time\.
Loading

0 comments on commit c2b60af

Please sign in to comment.