From c2b60af74abbd3ffbbbb3bfe924abd867ed0b210 Mon Sep 17 00:00:00 2001 From: Michael Khmelnitsky Date: Mon, 1 Oct 2018 23:17:19 +0000 Subject: [PATCH] Updated the documentation. --- doc_source/amazon-mq-basic-elements.md | 2 +- ...azon-mq-broker-configuration-parameters.md | 2 +- .../amazon-mq-connecting-application.md | 12 +++---- ...zon-mq-creating-applying-configurations.md | 21 ++++++----- .../amazon-mq-creating-configuring-broker.md | 19 +++++----- doc_source/amazon-mq-deleting-broker.md | 2 +- doc_source/amazon-mq-documentation-history.md | 1 + .../amazon-mq-editing-broker-preferences.md | 35 +++++++++++++++++++ ...azon-mq-editing-managing-configurations.md | 31 ++++++++-------- doc_source/amazon-mq-getting-started.md | 8 +++-- doc_source/amazon-mq-listing-brokers.md | 2 +- .../amazon-mq-listing-managing-users.md | 8 ++--- doc_source/amazon-mq-logging-cloudtrail.md | 2 +- doc_source/amazon-mq-rebooting-broker.md | 2 +- doc_source/amazon-mq-release-notes.md | 1 + doc_source/amazon-mq-tutorials.md | 1 + doc_source/amazon-mq-working-java-example.md | 4 +-- doc_source/broker-engine.md | 5 +-- doc_source/index.md | 1 + 19 files changed, 99 insertions(+), 60 deletions(-) create mode 100644 doc_source/amazon-mq-editing-broker-preferences.md diff --git a/doc_source/amazon-mq-basic-elements.md b/doc_source/amazon-mq-basic-elements.md index a5ea011..445dcfe 100644 --- a/doc_source/amazon-mq-basic-elements.md +++ b/doc_source/amazon-mq-basic-elements.md @@ -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) \ No newline at end of file diff --git a/doc_source/amazon-mq-broker-configuration-parameters.md b/doc_source/amazon-mq-broker-configuration-parameters.md index b87947c..af397e4 100644 --- a/doc_source/amazon-mq-broker-configuration-parameters.md +++ b/doc_source/amazon-mq-broker-configuration-parameters.md @@ -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\. diff --git a/doc_source/amazon-mq-connecting-application.md b/doc_source/amazon-mq-connecting-application.md index ee425d5..4404fbe 100644 --- a/doc_source/amazon-mq-connecting-application.md +++ b/doc_source/amazon-mq-connecting-application.md @@ -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 @@ -54,12 +54,12 @@ Add the `activemq-client.jar` and `activemq-pool.jar` packages to your Java clas org.apache.activemq activemq-client - 5.15.0 + 5.15.6 org.apache.activemq activemq-pool - 5.15.0 + 5.15.6 ``` @@ -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 +## To Create a Message Producer and Send a Message 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** @@ -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 +## To Create a Message Consumer and Receive the Message 1. Create a JMS connection factory for the message producer using your broker's endpoint and then call the `createConnection` method against the factory\. diff --git a/doc_source/amazon-mq-creating-applying-configurations.md b/doc_source/amazon-mq-creating-applying-configurations.md index 8514378..e31136c 100644 --- a/doc_source/amazon-mq-creating-applying-configurations.md +++ b/doc_source/amazon-mq-creating-applying-configurations.md @@ -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 +## Step 1: Create a Configuration from Scratch 1. Sign in to the [Amazon MQ console](https://console.aws.amazon.com/amazon-mq/)\. @@ -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 +## Step 2: Create a New Configuration Revision 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** @@ -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 +## Step 3: Apply a Configuration Revision to Your Broker 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** diff --git a/doc_source/amazon-mq-creating-configuring-broker.md b/doc_source/amazon-mq-creating-configuring-broker.md index 7f679f9..5f6b1ae 100644 --- a/doc_source/amazon-mq-creating-configuring-broker.md +++ b/doc_source/amazon-mq-creating-configuring-broker.md @@ -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 +## Step 1: Configure Basic Broker Settings 1. Sign in to the [Amazon MQ console](https://console.aws.amazon.com/amazon-mq/)\. @@ -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 +## Step 2: \(Optional\) Configure Advanced Broker Settings **Important** **Subnet\(s\)** – A single\-instance broker requires one subnet \(for example, the default subnet\)\. An active/standby broker requires two subnets\. @@ -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: @@ -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 +## Step 3: Finish Creating the Broker 1. Choose **Create broker**\. diff --git a/doc_source/amazon-mq-deleting-broker.md b/doc_source/amazon-mq-deleting-broker.md index 9aecaf2..bcf0d8c 100644 --- a/doc_source/amazon-mq-deleting-broker.md +++ b/doc_source/amazon-mq-deleting-broker.md @@ -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 +## To Delete an Amazon MQ Broker 1. Sign in to the [Amazon MQ console](https://console.aws.amazon.com/amazon-mq/)\. diff --git a/doc_source/amazon-mq-documentation-history.md b/doc_source/amazon-mq-documentation-history.md index 5f431d0..9be8bb8 100644 --- a/doc_source/amazon-mq-documentation-history.md +++ b/doc_source/amazon-mq-documentation-history.md @@ -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) | diff --git a/doc_source/amazon-mq-editing-broker-preferences.md b/doc_source/amazon-mq-editing-broker-preferences.md new file mode 100644 index 0000000..8b067ef --- /dev/null +++ b/doc_source/amazon-mq-editing-broker-preferences.md @@ -0,0 +1,35 @@ +# Tutorial: Editing Broker Engine Version, CloudWatch Logs, and Maintenance Preferences + +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 + +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\. \ No newline at end of file diff --git a/doc_source/amazon-mq-editing-managing-configurations.md b/doc_source/amazon-mq-editing-managing-configurations.md index ca53e7c..d824245 100644 --- a/doc_source/amazon-mq-editing-managing-configurations.md +++ b/doc_source/amazon-mq-editing-managing-configurations.md @@ -16,23 +16,22 @@ For more information, see the following: The following examples show how you can edit Amazon MQ broker configurations and manage broker configuration revisions using the AWS Management Console\. **Topics** -+ [To view a previous configuration revision](#view-previous-configuration-console) -+ [To edit the current configuration revision](#edit-current-configuration-console) -+ [To apply a configuration revision to your broker](#apply-configuration-revision-editing-console) -+ [To roll back your broker to the last configuration revision](#roll-back-last-configuration-console) ++ [To View a Previous Configuration Revision](#view-previous-configuration-console) ++ [To Edit the Current Configuration Revision](#edit-current-configuration-console) ++ [To Apply a Configuration Revision to Your Broker](#apply-configuration-revision-editing-console) ++ [To Roll Back Your Broker to the Last Configuration Revision](#roll-back-last-configuration-console) -## To view a previous configuration revision +## To View a Previous Configuration Revision 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 **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 **View** ![\[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-view.png) +1. On the **Edit *MyBroker*** page, in the **Configuration** section, select a **Configuration** and a **Revision** and then choose **Edit**\. **Note** Unless you select a configuration when you create a broker, the first configuration revision is always created for you when Amazon MQ creates the broker\. - On the ***MyBroker*** page, the broker engine type and version that the configuration uses \(for example, **Apache ActiveMQ 5\.15\.0**\) are displayed\. + On the ***MyBroker*** page, the broker engine type and version that the configuration uses \(for example, **Apache ActiveMQ 5\.15\.6**\) are displayed\. 1. Choose **Revision history**\. @@ -42,7 +41,7 @@ Unless you select a configuration when you create a broker, the first configurat The broker configuration in XML format is displayed\. -## To edit the current configuration revision +## To Edit the Current Configuration Revision 1. Sign in to the [Amazon MQ console](https://console.aws.amazon.com/amazon-mq/)\. @@ -50,12 +49,11 @@ Unless you select a configuration when you create a broker, the first configurat 1. On the ***MyBroker*** page, 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 **View** ![\[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-view.png) +1. On the **Edit *MyBroker*** page, in the **Configuration** section, select a **Configuration** and a **Revision** and then choose **Edit**\. **Note** Unless you select a configuration when you create a broker, the first configuration revision is always created for you when Amazon MQ creates the broker\. - On the ***MyBroker*** page, the broker engine type and version that the configuration uses \(for example, **Apache ActiveMQ 5\.15\.0**\) are displayed\. + On the ***MyBroker*** page, the broker engine type and version that the configuration 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** @@ -78,14 +76,13 @@ 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](#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\. -## To apply a configuration revision to your broker +## To Apply a Configuration Revision to Your Broker 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 **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** @@ -95,7 +92,7 @@ Your broker will be offline while it is being rebooted\. Your configuration revision is applied to your broker at the specified time\. -## To roll back your broker to the last configuration revision +## To Roll Back Your Broker to the Last Configuration Revision 1. Sign in to the [Amazon MQ console](https://console.aws.amazon.com/amazon-mq/)\. @@ -104,7 +101,7 @@ Your broker will be offline while it is being rebooted\. 1. On the ***MyBroker*** page, choose **Actions**, **Roll back to last configuration**\. ![\[Image NOT FOUND\]](http://docs.aws.amazon.com/amazon-mq/latest/developer-guide/images/amazon-mq-tutorials-configuration-roll-back.png) -1. \(Optional\) To review the **Current configuration** or the **Last configuration**, on the **Roll back to the last configuration** page, in the **Summary** section, choose **View** for either configuration\. +1. \(Optional\) To review the **Current configuration** or the **Last configuration**, on the **Roll back to the last configuration** page, in the **Summary** section, choose **Edit** for either configuration\. 1. In the **Schedule broker modifications** section, choose whether to apply modifications **During the next scheduled maintenance window** or **Immediately**\. **Important** diff --git a/doc_source/amazon-mq-getting-started.md b/doc_source/amazon-mq-getting-started.md index 78b73e2..947e121 100644 --- a/doc_source/amazon-mq-getting-started.md +++ b/doc_source/amazon-mq-getting-started.md @@ -34,8 +34,10 @@ The first and most common Amazon MQ task is creating a broker\. The following ex 1. Choose a **Deployment mode**\. In this example, **Single\-instance broker** is selected\. + 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**\. @@ -113,12 +115,12 @@ Add the `activemq-client.jar` and `activemq-pool.jar` packages to your Java clas org.apache.activemq activemq-client - 5.15.0 + 5.15.6 org.apache.activemq activemq-pool - 5.15.0 + 5.15.6 ``` diff --git a/doc_source/amazon-mq-listing-brokers.md b/doc_source/amazon-mq-listing-brokers.md index c1ced4a..3148c31 100644 --- a/doc_source/amazon-mq-listing-brokers.md +++ b/doc_source/amazon-mq-listing-brokers.md @@ -4,7 +4,7 @@ When you request that Amazon MQ create a broker, the creation process can take a The following example shows how you can confirm your broker's existence by listing your brokers in the current region using the AWS Management Console\. -## To list brokers and view broker details +## To List Brokers and View Broker Details 1. Sign in to the [Amazon MQ console](https://console.aws.amazon.com/amazon-mq/)\. diff --git a/doc_source/amazon-mq-listing-managing-users.md b/doc_source/amazon-mq-listing-managing-users.md index fefb4f2..7a79957 100644 --- a/doc_source/amazon-mq-listing-managing-users.md +++ b/doc_source/amazon-mq-listing-managing-users.md @@ -10,11 +10,11 @@ You can't configure groups independently of users\. A group label is created whe The following examples show how you can create, edit, and delete Amazon MQ broker users using the AWS Management Console\. **Topics** -+ [To create a new user](#create-new-user-console) ++ [To Create a New User](#create-new-user-console) + [To edit an existing user](#edit-existing-user-console) -+ [To delete a existing user](#delete-existing-user-console) ++ [To Delete an Existing User](#delete-existing-user-console) -## To create a new user +## To Create a New User 1. Sign in to the [Amazon MQ console](https://console.aws.amazon.com/amazon-mq/)\. @@ -58,7 +58,7 @@ Making changes to a user does *not* apply the changes to the user immediately\. **Important** Making changes to a user does *not* apply the changes to the user 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)\. -## To delete a existing user +## To Delete an Existing User 1. Sign in to the [Amazon MQ console](https://console.aws.amazon.com/amazon-mq/)\. diff --git a/doc_source/amazon-mq-logging-cloudtrail.md b/doc_source/amazon-mq-logging-cloudtrail.md index f552bd3..6985056 100644 --- a/doc_source/amazon-mq-logging-cloudtrail.md +++ b/doc_source/amazon-mq-logging-cloudtrail.md @@ -76,7 +76,7 @@ Because CloudTrail log files aren't an ordered stack trace of public APIs, they "sourceIPAddress": "203.0.113.0", "userAgent": "PostmanRuntime/7.1.5", "requestParameters": { - "engineVersion": "5.15.0", + "engineVersion": "5.15.6", "deploymentMode": "ACTIVE_STANDBY_MULTI_AZ", "maintenanceWindowStartTime": { "dayOfWeek": "THURSDAY", diff --git a/doc_source/amazon-mq-rebooting-broker.md b/doc_source/amazon-mq-rebooting-broker.md index 50c1aaf..b824af6 100644 --- a/doc_source/amazon-mq-rebooting-broker.md +++ b/doc_source/amazon-mq-rebooting-broker.md @@ -4,7 +4,7 @@ To apply a new configuration to a broker, you can reboot the broker\. In additio The following example shows how you can reboot an Amazon MQ broker using the AWS Management Console\. -## To reboot an Amazon MQ broker +## To Reboot an Amazon MQ Broker 1. Sign in to the [Amazon MQ console](https://console.aws.amazon.com/amazon-mq/)\. diff --git a/doc_source/amazon-mq-release-notes.md b/doc_source/amazon-mq-release-notes.md index 9d0b0ab..787b01e 100644 --- a/doc_source/amazon-mq-release-notes.md +++ b/doc_source/amazon-mq-release-notes.md @@ -5,6 +5,7 @@ The following table lists Amazon MQ feature releases and improvements\. For chan | Date | Feature Release | | --- | --- | +| September 27, 2018 | Amazon MQ supports ActiveMQ 5\.15\.6, in addition to 5\.15\.0\. For more information, see the following:[\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/amazon-mq/latest/developer-guide/amazon-mq-release-notes.html) | | August 31, 2018 | [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/amazon-mq/latest/developer-guide/amazon-mq-release-notes.html) | | August 30, 2018 | Amazon MQ is available in the Asia Pacific \(Singapore\) Region in addition to the following regions:[\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/amazon-mq/latest/developer-guide/amazon-mq-release-notes.html) | | July 30, 2018 | You can configure Amazon MQ to publish general 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)\. | diff --git a/doc_source/amazon-mq-tutorials.md b/doc_source/amazon-mq-tutorials.md index 36fe2da..853fb30 100644 --- a/doc_source/amazon-mq-tutorials.md +++ b/doc_source/amazon-mq-tutorials.md @@ -4,6 +4,7 @@ The following tutorials show how you can work with Amazon MQ and ActiveMQ using **Topics** + [Creating and Configuring a Broker](amazon-mq-creating-configuring-broker.md) ++ [Editing Broker Engine Version, CloudWatch Logs, and Maintenance Preferences](amazon-mq-editing-broker-preferences.md) + [Creating and Applying Broker Configurations](amazon-mq-creating-applying-configurations.md) + [Editing and Managing Broker Configurations](amazon-mq-editing-managing-configurations.md) + [Connecting a Java Application to Your Broker](amazon-mq-connecting-application.md) diff --git a/doc_source/amazon-mq-working-java-example.md b/doc_source/amazon-mq-working-java-example.md index e963b91..9f1c929 100644 --- a/doc_source/amazon-mq-working-java-example.md +++ b/doc_source/amazon-mq-working-java-example.md @@ -49,12 +49,12 @@ Add the `activemq-client.jar` and `activemq-pool.jar` packages to your Java clas org.apache.activemq activemq-client - 5.15.0 + 5.15.6 org.apache.activemq activemq-pool - 5.15.0 + 5.15.6 ``` diff --git a/doc_source/broker-engine.md b/doc_source/broker-engine.md index b4768b4..3ec040e 100644 --- a/doc_source/broker-engine.md +++ b/doc_source/broker-engine.md @@ -2,5 +2,6 @@ A *broker engine* is a type of message broker that runs on Amazon MQ\. -**Note** -Currently, Amazon MQ supports only the `ActiveMQ` broker engine, version `5.15.0`\. \ No newline at end of file +Amazon MQ supports the following versions of ActiveMQ: ++ ActiveMQ 5\.15\.0 ++ ActiveMQ 5\.15\.6 \ No newline at end of file diff --git a/doc_source/index.md b/doc_source/index.md index f1dad2a..0b32faa 100644 --- a/doc_source/index.md +++ b/doc_source/index.md @@ -21,6 +21,7 @@ Amazon's trademarks and trade dress may not be used in + [Amazon MQ Tutorials](amazon-mq-tutorials.md) + [Tutorial: Creating and Configuring an Amazon MQ Broker](amazon-mq-creating-configuring-broker.md) + [Accessing the ActiveMQ Web Console of a Broker without Public Accessibility](accessing-web-console-of-broker-without-private-accessibility.md) + + [Tutorial: Editing Broker Engine Version, CloudWatch Logs, and Maintenance Preferences](amazon-mq-editing-broker-preferences.md) + [Tutorial: Creating and Applying Amazon MQ Broker Configurations](amazon-mq-creating-applying-configurations.md) + [Tutorial: Editing Amazon MQ Broker Configurations and Managing Configuration Revisions](amazon-mq-editing-managing-configurations.md) + [Tutorial: Connecting a Java Application to Your Amazon MQ Broker](amazon-mq-connecting-application.md)