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 Jul 25, 2018
1 parent ffa721c commit 1288315
Show file tree
Hide file tree
Showing 36 changed files with 30 additions and 167 deletions.
6 changes: 0 additions & 6 deletions doc_source/activemq-authentication-authorization.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,11 @@
# Messaging Authentication and Authorization for ActiveMQ<a name="activemq-authentication-authorization"></a>

You can access your brokers using the following protocols with TLS enabled:

+ [AMQP](http://activemq.apache.org/amqp.html)

+ [MQTT](http://activemq.apache.org/mqtt.html)

+ MQTT over [WebSocket](http://activemq.apache.org/websockets.html)

+ [OpenWire](http://activemq.apache.org/openwire.html)

+ [STOMP](http://activemq.apache.org/stomp.html)

+ STOMP over WebSocket

Amazon MQ uses native ActiveMQ authentication to manage user permissions\. For information about restrictions related to ActiveMQ usernames and passwords, see [Users](amazon-mq-limits.md#activemq-user-limits)\.
Expand Down
8 changes: 1 addition & 7 deletions doc_source/amazon-mq-accessing-metrics.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ For information about creating a CloudWatch alarm for a metrics, see [Create or
There is no charge for the Amazon MQ metrics reported in CloudWatch\. These metrics are provided as part of the Amazon MQ service\.
CloudWatch monitors only the first 200 destinations\.


**Topics**
+ [AWS Management Console](#amazon-mq-accessing-metrics-console)
+ [AWS Command Line Interface](#amazon-mq-accessing-metrics-aws-cli)
+ [Amazon CloudWatch API](#amazon-mq-accessing-metrics-cw-api)
Expand All @@ -32,22 +32,16 @@ If you're already signed into the Amazon MQ console, on the broker **Details** p
![\[Image NOT FOUND\]](http://docs.aws.amazon.com/amazon-mq/latest/developer-guide/images/amazon-mq-cloudwatch-queue-metrics-namespace.png)

1. Select one of the following metric dimensions:

+ **Broker Metrics**

+ **Queue Metrics by Broker**

+ **Topic Metrics by Broker**

In this example, **Broker Metrics** is selected\.
![\[Image NOT FOUND\]](http://docs.aws.amazon.com/amazon-mq/latest/developer-guide/images/amazon-mq-cloudwatch-queue-metrics-dimension.png)

1. You can now examine your Amazon MQ metrics:

+ To sort the metrics, use the column heading\.

+ To graph the metric, select the check box next to the metric\.

+ To filter by metric, choose the metric name and then choose **Add to search**\.
![\[Image NOT FOUND\]](http://docs.aws.amazon.com/amazon-mq/latest/developer-guide/images/amazon-mq-cloudwatch-queue-metrics-examine.png)

Expand Down
2 changes: 1 addition & 1 deletion doc_source/amazon-mq-api-authentication-authorization.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Currently, Amazon MQ doesn't support IAM authentication using resource\-based pe

To authorize AWS users to work with brokers, configurations, and users, you must edit your IAM policy permissions\.


**Topics**
+ [IAM Permissions Required to Create an Amazon MQ Broker](#amazon-mq-permissions-required-to-create-broker)
+ [Amazon MQ REST API Permissions Reference](#amazon-mq-api-permissions-reference)

Expand Down
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 @@ -2,7 +2,7 @@

This section introduces key concepts essential to understanding Amazon MQ\.


**Topics**
+ [Broker](broker.md)
+ [Configuration](configuration.md)
+ [Engine](broker-engine.md)
Expand Down
2 changes: 1 addition & 1 deletion doc_source/amazon-mq-best-practices.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Use these best practices to make the most of Amazon MQ\.


**Topics**
+ [Using Amazon MQ Securely](using-amazon-mq-securely.md)
+ [Connecting to Amazon MQ](connecting-to-amazon-mq.md)
+ [Ensuring Effective Amazon MQ Performance](ensuring-effective-amazon-mq-performance.md)
2 changes: 1 addition & 1 deletion doc_source/amazon-mq-broker-architecture.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Amazon MQ brokers can be created as *single\-instance brokers* or *active/standb
**Note**
Amazon MQ uses [Apache KahaDB](http://activemq.apache.org/kahadb.html) as its data store\. Other data stores, such as JDBC and LevelDB, aren't supported\.


**Topics**
+ [Amazon MQ Single\-Instance Broker](single-broker-deployment.md)
+ [Amazon MQ Active/Standby Broker for High Availability](active-standby-broker-deployment.md)
+ [Amazon MQ Broker Configuration Lifecycle](amazon-mq-broker-configuration-lifecycle.md)
5 changes: 0 additions & 5 deletions doc_source/amazon-mq-broker-configuration-lifecycle.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,15 +10,10 @@ The next scheduled 2\-hour maintenance window triggers a reboot\. If the broker
![\[Image NOT FOUND\]](http://docs.aws.amazon.com/amazon-mq/latest/developer-guide/images/amazon-mq-configuration-lifecycle.png)

For information about creating, editing, and managing configurations, see the following:

+ [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)

+ [Amazon MQ Broker Configuration Parameters](amazon-mq-broker-configuration-parameters.md)

For information about creating, editing, and deleting ActiveMQ users, see the following:

+ [Tutorial: Creating and Managing Amazon MQ Broker Users](amazon-mq-listing-managing-users.md)

+ [Users](amazon-mq-limits.md#activemq-user-limits)
6 changes: 1 addition & 5 deletions doc_source/amazon-mq-broker-configuration-parameters.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,9 @@
# Amazon MQ Broker Configuration Parameters<a name="amazon-mq-broker-configuration-parameters"></a>

A *configuration* contains all of the settings for your ActiveMQ broker, in XML format \(similar to ActiveMQ's `activemq.xml` file\)\. You can create a configuration before creating any brokers\. You can then apply the configuration to one or more brokers\. For more information, see the following:

+ [Configuration](configuration.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)

+ [Configurations](amazon-mq-limits.md#configuration-limits)

## Working with Spring XML Configuration Files<a name="working-with-spring-xml-configuration-files"></a>
Expand All @@ -19,7 +15,7 @@ The full set of supported configuration options is specified in the [Amazon MQ X
**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\.


**Topics**
+ [Working with Spring XML Configuration Files](#working-with-spring-xml-configuration-files)
+ [Elements Permitted in Amazon MQ Configurations](permitted-elements.md)
+ [Elements and Their Attributes Permitted in Amazon MQ Configurations](permitted-attributes.md)
Expand Down
2 changes: 1 addition & 1 deletion doc_source/amazon-mq-connecting-application.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ You can connect to ActiveMQ brokers using [various ActiveMQ clients](http://acti
**Important**
To ensure that your broker is accessible within your VPC, you must enable the `enableDnsHostnames` and `enableDnsSupport` VPC attributes\. For more information, see [DNS Support in your VPC](http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/vpc-dns.html#vpc-dns-support) in the *Amazon VPC User Guide*\.


**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)
Expand Down
6 changes: 1 addition & 5 deletions doc_source/amazon-mq-creating-applying-configurations.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,18 +6,14 @@ A *configuration* contains all of the settings for your ActiveMQ broker, in XML
For an active/standby broker for high availability, 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\.

For more information, see the following:

+ [Configuration](configuration.md)

+ [Amazon MQ Broker Configuration Lifecycle](amazon-mq-broker-configuration-lifecycle.md)

+ [Amazon MQ Broker Configuration Parameters](amazon-mq-broker-configuration-parameters.md)

+ [Tutorial: Editing Amazon MQ Broker Configurations and Managing Configuration Revisions](amazon-mq-editing-managing-configurations.md)

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)
Expand Down
8 changes: 1 addition & 7 deletions doc_source/amazon-mq-creating-configuring-broker.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ 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)
+ [Step 2: \(Optional\) Configure advanced broker settings](#configure-advanced-broker-settings-console)
+ [Step 3: Finish creating the broker](#finish-creating-broker-console)
Expand All @@ -14,17 +14,13 @@ The first and most common Amazon MQ task is creating a broker\. The following ex
1. Sign in to the [Amazon MQ console](https://console.aws.amazon.com/amazon-mq/)\.

1. 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**\.

1. Choose a **Broker instance type** \(for example, **mq\.m5\.large**\)\. For more information, see [Instance Types](broker.md#broker-instance-types)\.

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)\.
**Note**
Currently, Amazon MQ supports only the `ActiveMQ` broker engine, version `5.15.0`\.
Expand Down Expand Up @@ -60,9 +56,7 @@ Currently, Amazon MQ supports only the `ActiveMQ` broker engine, version `5.15.0
For an active/standby broker for high availability, 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. 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<a name="finish-creating-broker-console"></a>
Expand Down
6 changes: 1 addition & 5 deletions doc_source/amazon-mq-editing-managing-configurations.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,18 +8,14 @@ For an active/standby broker for high availability, if one of the broker instanc
To keep track of the changes you make to your configuration, you can create *configuration revisions*\.

For more information, see the following:

+ [Configuration](configuration.md)

+ [Amazon MQ Broker Configuration Lifecycle](amazon-mq-broker-configuration-lifecycle.md)

+ [Amazon MQ Broker Configuration Parameters](amazon-mq-broker-configuration-parameters.md)

+ [Tutorial: Creating and Applying Amazon MQ Broker Configurations](amazon-mq-creating-applying-configurations.md)

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)
Expand Down
11 changes: 1 addition & 10 deletions doc_source/amazon-mq-getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

This section will help you become more familiar with Amazon MQ by showing you how to create a broker and how to connect your application to it\.


**Topics**
+ [Prerequisites](#create-broker-prerequisites)
+ [Create an ActiveMQ Broker](#create-activemq-broker)
+ [Connect a Java Application to Your Broker](#connect-java-application)
Expand All @@ -22,9 +22,7 @@ The first and most common Amazon MQ task is creating a broker\. The following ex
1. Sign in to the [Amazon MQ console](https://console.aws.amazon.com/amazon-mq/)\.

1. 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**\.

1. Choose a **Broker instance type** \(for example, **mq\.m5\.large**\)\. For more information, see [Instance Types](broker.md#broker-instance-types)\.
Expand Down Expand Up @@ -220,19 +218,12 @@ The following example shows how you can delete a broker using the AWS Management
## Next Steps<a name="next-steps-tutorials"></a>

Now that you have created a broker, connected an application to it, and sent and received a message, you might want to try the following:

+ [Tutorial: Creating and Configuring an Amazon MQ Broker](amazon-mq-creating-configuring-broker.md) \(Advanced Settings\)

+ [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: Listing Amazon MQ Brokers and Viewing Broker Details](amazon-mq-listing-brokers.md)

+ [Tutorial: Creating and Managing Amazon MQ Broker Users](amazon-mq-listing-managing-users.md)

+ [Tutorial: Rebooting an Amazon MQ Broker](amazon-mq-rebooting-broker.md)

+ [Tutorial: Accessing CloudWatch Metrics for Amazon MQ](amazon-mq-accessing-metrics.md)

You can also begin to dive deep into [Amazon MQ best practices](amazon-mq-best-practices.md) and [Amazon MQ REST APIs](http://docs.aws.amazon.com/amazon-mq/latest/api-reference/), and then [plan to migrate to Amazon MQ](amazon-mq-migrating.md)\.
2 changes: 1 addition & 1 deletion doc_source/amazon-mq-how-it-works.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ This section describes the basic elements of a message broker, lists available A

To learn about Amazon MQ REST APIs, see the *[Amazon MQ REST API Reference](http://docs.aws.amazon.com/amazon-mq/latest/api-reference/)*\.


**Topics**
+ [Amazon MQ Basic Elements](amazon-mq-basic-elements.md)
+ [Amazon MQ Broker Architecture](amazon-mq-broker-architecture.md)
+ [Amazon MQ Broker Configuration Parameters](amazon-mq-broker-configuration-parameters.md)
Expand Down
2 changes: 1 addition & 1 deletion doc_source/amazon-mq-limits.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

This topic lists limits within Amazon MQ\. Many of the following limits can be changed for specific AWS accounts\. To request an increase for a limit, see [AWS Service Limits](http://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html) in the *Amazon Web Services General Reference*\.


**Topics**
+ [Limits Related to Brokers](#broker-limits)
+ [Limits Related to Configurations](#configuration-limits)
+ [Limits Related to Users](#activemq-user-limits)
Expand Down
7 changes: 0 additions & 7 deletions doc_source/amazon-mq-listing-brokers.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,15 +12,10 @@ The following example shows how you can confirm your broker's existence by listi
![\[Image NOT FOUND\]](http://docs.aws.amazon.com/amazon-mq/latest/developer-guide/images/amazon-mq-tutorials-list-brokers.png)

The following information is displayed for each broker:

+ **Name**

+ **Creation** date

+ [**Status**](broker.md#broker-statuses)

+ [**Deployment mode**](amazon-mq-broker-architecture.md)

+ [**Instance type**](broker.md#broker-instance-types)

1. Choose your broker's name \(for example, **MyBroker**\)\.
Expand All @@ -29,7 +24,5 @@ The following example shows how you can confirm your broker's existence by listi
![\[Image NOT FOUND\]](http://docs.aws.amazon.com/amazon-mq/latest/developer-guide/images/amazon-mq-tutorials-show-broker-details.png)

Below the **Details** section, the following information is displayed:

+ In the **Connections** section, the [ActiveMQ Web Console](http://activemq.apache.org/web-console.html) URL and the [wire\-level protocol endpoints](http://activemq.apache.org/configuring-transports.html)

+ In the **Users** section, the [users](user.md) associated with the broker
2 changes: 1 addition & 1 deletion doc_source/amazon-mq-listing-managing-users.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ A user can belong to a *group*\. You can configure which users belong to which g

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 edit an existing user](#edit-existing-user-console)
+ [To delete a existing user](#delete-existing-user-console)
Expand Down
Loading

0 comments on commit 1288315

Please sign in to comment.