From 128831507e9a70ab1c8bc9aa35a1d3c382074e00 Mon Sep 17 00:00:00 2001 From: Michael Khmelnitsky Date: Wed, 25 Jul 2018 21:02:25 +0000 Subject: [PATCH] Updated the documentation. --- .../activemq-authentication-authorization.md | 6 ------ doc_source/amazon-mq-accessing-metrics.md | 8 +------- ...azon-mq-api-authentication-authorization.md | 2 +- doc_source/amazon-mq-basic-elements.md | 2 +- doc_source/amazon-mq-best-practices.md | 2 +- doc_source/amazon-mq-broker-architecture.md | 2 +- ...amazon-mq-broker-configuration-lifecycle.md | 5 ----- ...mazon-mq-broker-configuration-parameters.md | 6 +----- doc_source/amazon-mq-connecting-application.md | 2 +- ...azon-mq-creating-applying-configurations.md | 6 +----- .../amazon-mq-creating-configuring-broker.md | 8 +------- ...mazon-mq-editing-managing-configurations.md | 6 +----- doc_source/amazon-mq-getting-started.md | 11 +---------- doc_source/amazon-mq-how-it-works.md | 2 +- doc_source/amazon-mq-limits.md | 2 +- doc_source/amazon-mq-listing-brokers.md | 7 ------- doc_source/amazon-mq-listing-managing-users.md | 2 +- doc_source/amazon-mq-logging-cloudtrail.md | 12 ------------ ...zon-mq-migrating-no-service-interruption.md | 2 -- ...amazon-mq-migrating-service-interruption.md | 2 -- doc_source/amazon-mq-migrating.md | 2 +- doc_source/amazon-mq-monitoring-logging.md | 2 +- doc_source/amazon-mq-release-notes.md | 1 + doc_source/amazon-mq-security.md | 2 +- doc_source/amazon-mq-setting-up.md | 2 +- doc_source/amazon-mq-tutorials.md | 2 +- doc_source/amazon-mq-working-java-example.md | 9 --------- doc_source/broker.md | 18 ------------------ doc_source/child-element-details.md | 2 +- doc_source/configuration.md | 11 ----------- doc_source/connecting-to-amazon-mq.md | 2 +- ...ensuring-effective-amazon-mq-performance.md | 11 ----------- doc_source/permitted-elements.md | 12 ++++++------ doc_source/user.md | 6 ------ doc_source/using-amazon-mq-securely.md | 8 +------- doc_source/welcome.md | 12 +----------- 36 files changed, 30 insertions(+), 167 deletions(-) diff --git a/doc_source/activemq-authentication-authorization.md b/doc_source/activemq-authentication-authorization.md index b9bb733..1b35c32 100644 --- a/doc_source/activemq-authentication-authorization.md +++ b/doc_source/activemq-authentication-authorization.md @@ -1,17 +1,11 @@ # Messaging Authentication and Authorization for ActiveMQ 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)\. diff --git a/doc_source/amazon-mq-accessing-metrics.md b/doc_source/amazon-mq-accessing-metrics.md index f1aadd5..bd81b53 100644 --- a/doc_source/amazon-mq-accessing-metrics.md +++ b/doc_source/amazon-mq-accessing-metrics.md @@ -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) @@ -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) diff --git a/doc_source/amazon-mq-api-authentication-authorization.md b/doc_source/amazon-mq-api-authentication-authorization.md index 622d954..cd3d27f 100644 --- a/doc_source/amazon-mq-api-authentication-authorization.md +++ b/doc_source/amazon-mq-api-authentication-authorization.md @@ -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) diff --git a/doc_source/amazon-mq-basic-elements.md b/doc_source/amazon-mq-basic-elements.md index 2c44ce3..a5ea011 100644 --- a/doc_source/amazon-mq-basic-elements.md +++ b/doc_source/amazon-mq-basic-elements.md @@ -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) diff --git a/doc_source/amazon-mq-best-practices.md b/doc_source/amazon-mq-best-practices.md index 80d4cd6..957c5e1 100644 --- a/doc_source/amazon-mq-best-practices.md +++ b/doc_source/amazon-mq-best-practices.md @@ -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) \ No newline at end of file diff --git a/doc_source/amazon-mq-broker-architecture.md b/doc_source/amazon-mq-broker-architecture.md index dd52a80..f73bf18 100644 --- a/doc_source/amazon-mq-broker-architecture.md +++ b/doc_source/amazon-mq-broker-architecture.md @@ -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) \ No newline at end of file diff --git a/doc_source/amazon-mq-broker-configuration-lifecycle.md b/doc_source/amazon-mq-broker-configuration-lifecycle.md index f8146ee..1b57f12 100644 --- a/doc_source/amazon-mq-broker-configuration-lifecycle.md +++ b/doc_source/amazon-mq-broker-configuration-lifecycle.md @@ -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) \ 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 09b9685..b87947c 100644 --- a/doc_source/amazon-mq-broker-configuration-parameters.md +++ b/doc_source/amazon-mq-broker-configuration-parameters.md @@ -1,13 +1,9 @@ # Amazon MQ Broker Configuration Parameters 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 @@ -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) diff --git a/doc_source/amazon-mq-connecting-application.md b/doc_source/amazon-mq-connecting-application.md index 96f0f48..43e1202 100644 --- a/doc_source/amazon-mq-connecting-application.md +++ b/doc_source/amazon-mq-connecting-application.md @@ -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) diff --git a/doc_source/amazon-mq-creating-applying-configurations.md b/doc_source/amazon-mq-creating-applying-configurations.md index e08e30f..45f3e11 100644 --- a/doc_source/amazon-mq-creating-applying-configurations.md +++ b/doc_source/amazon-mq-creating-applying-configurations.md @@ -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) diff --git a/doc_source/amazon-mq-creating-configuring-broker.md b/doc_source/amazon-mq-creating-configuring-broker.md index a595f1d..b9cb4ed 100644 --- a/doc_source/amazon-mq-creating-configuring-broker.md +++ b/doc_source/amazon-mq-creating-configuring-broker.md @@ -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) @@ -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`\. @@ -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 diff --git a/doc_source/amazon-mq-editing-managing-configurations.md b/doc_source/amazon-mq-editing-managing-configurations.md index f086044..cfe364f 100644 --- a/doc_source/amazon-mq-editing-managing-configurations.md +++ b/doc_source/amazon-mq-editing-managing-configurations.md @@ -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) diff --git a/doc_source/amazon-mq-getting-started.md b/doc_source/amazon-mq-getting-started.md index 6f19967..a0333b9 100644 --- a/doc_source/amazon-mq-getting-started.md +++ b/doc_source/amazon-mq-getting-started.md @@ -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) @@ -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)\. @@ -220,19 +218,12 @@ The following example shows how you can delete a broker using the AWS Management ## Next Steps 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)\. \ No newline at end of file diff --git a/doc_source/amazon-mq-how-it-works.md b/doc_source/amazon-mq-how-it-works.md index 50f9ac4..9a3660f 100644 --- a/doc_source/amazon-mq-how-it-works.md +++ b/doc_source/amazon-mq-how-it-works.md @@ -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) diff --git a/doc_source/amazon-mq-limits.md b/doc_source/amazon-mq-limits.md index 3f0f0c9..3ee73fc 100644 --- a/doc_source/amazon-mq-limits.md +++ b/doc_source/amazon-mq-limits.md @@ -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) diff --git a/doc_source/amazon-mq-listing-brokers.md b/doc_source/amazon-mq-listing-brokers.md index d5175f3..c1ced4a 100644 --- a/doc_source/amazon-mq-listing-brokers.md +++ b/doc_source/amazon-mq-listing-brokers.md @@ -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**\)\. @@ -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 \ No newline at end of file diff --git a/doc_source/amazon-mq-listing-managing-users.md b/doc_source/amazon-mq-listing-managing-users.md index 5b87c0c..c0146a5 100644 --- a/doc_source/amazon-mq-listing-managing-users.md +++ b/doc_source/amazon-mq-listing-managing-users.md @@ -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) diff --git a/doc_source/amazon-mq-logging-cloudtrail.md b/doc_source/amazon-mq-logging-cloudtrail.md index 0a68688..0461743 100644 --- a/doc_source/amazon-mq-logging-cloudtrail.md +++ b/doc_source/amazon-mq-logging-cloudtrail.md @@ -12,25 +12,16 @@ Using the information that CloudTrail collects, you can identify a specific requ When you create your AWS account, CloudTrail is enabled\. When a supported Amazon MQ event activity occurs, it is recorded in a CloudTrail event with other AWS service events in the event history\. You can view, search, and download recent events for your AWS account\. For more information, see [Viewing Events with CloudTrail Event History](http://docs.aws.amazon.com/awscloudtrail/latest/userguide/view-cloudtrail-events.html) in the *AWS CloudTrail User Guide*\. A trail allows CloudTrail to deliver log files to an Amazon S3 bucket\. You can create a trail to keep an ongoing record of events in your AWS account\. By default, when you create a trail using the AWS Management Console, the trail applies to all AWS Regions\. The trail logs events from all AWS Regions and delivers log files to the specified Amazon S3 bucket\. You can also configure other AWS services to further analyze and act on the event data collected in CloudTrail logs\. For more information, see the following topics in the *AWS CloudTrail User Guide*: - + [CloudTrail Supported Services and Integrations](http://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-aws-service-specific-topics.html#cloudtrail-aws-service-specific-topics-integrations) - + [Configuring Amazon SNS Notifications for CloudTrail](http://docs.aws.amazon.com/awscloudtrail/latest/userguide/getting_notifications_top_level.html) - + [Receiving CloudTrail Log Files from Multiple Regions](http://docs.aws.amazon.com/awscloudtrail/latest/userguide/receive-cloudtrail-log-files-from-multiple-regions.html) - + [Receiving CloudTrail Log Files from Multiple Accounts](http://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-receive-logs-from-multiple-accounts.html) Amazon MQ supports logging both the request parameters and the responses for the following APIs as events in CloudTrail log files: - + [http://docs.aws.amazon.com/amazon-mq/latest/api-reference/rest-api-configurations.html#rest-api-configurations-methods-post](http://docs.aws.amazon.com/amazon-mq/latest/api-reference/rest-api-configurations.html#rest-api-configurations-methods-post) - + [http://docs.aws.amazon.com/amazon-mq/latest/api-reference/rest-api-broker.html#rest-api-broker-methods-delete](http://docs.aws.amazon.com/amazon-mq/latest/api-reference/rest-api-broker.html#rest-api-broker-methods-delete) - + [http://docs.aws.amazon.com/amazon-mq/latest/api-reference/rest-api-user.html#rest-api-user-methods-delete](http://docs.aws.amazon.com/amazon-mq/latest/api-reference/rest-api-user.html#rest-api-user-methods-delete) - + [http://docs.aws.amazon.com/amazon-mq/latest/api-reference/rest-api-broker-reboot.html#rest-api-broker-reboot-methods-post](http://docs.aws.amazon.com/amazon-mq/latest/api-reference/rest-api-broker-reboot.html#rest-api-broker-reboot-methods-post) - + [http://docs.aws.amazon.com/amazon-mq/latest/api-reference/rest-api-broker.html#rest-api-broker-methods-put](http://docs.aws.amazon.com/amazon-mq/latest/api-reference/rest-api-broker.html#rest-api-broker-methods-put) **Important** @@ -50,11 +41,8 @@ For the following APIs, the `data` and `password` request parameters are hidden [http://docs.aws.amazon.com/amazon-mq/latest/api-reference/rest-api-user.html#rest-api-user-methods-put](http://docs.aws.amazon.com/amazon-mq/latest/api-reference/rest-api-user.html#rest-api-user-methods-put) \(`PUT`\) Every event or log entry contains information about the requester\. This information helps you determine the following: - + Was the request made with root or IAM user credentials? - + Was the request made with temporary security credentials for a role or a federated user? - + Was the request made by another AWS service? For more information, see [CloudTrail userIdentity Element](http://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-event-reference-user-identity.html) in the *AWS CloudTrail User Guide*\. diff --git a/doc_source/amazon-mq-migrating-no-service-interruption.md b/doc_source/amazon-mq-migrating-no-service-interruption.md index 20985cb..f3e3c83 100644 --- a/doc_source/amazon-mq-migrating-no-service-interruption.md +++ b/doc_source/amazon-mq-migrating-no-service-interruption.md @@ -25,9 +25,7 @@ failover:(ssl://on-premises-broker.example.com:61617,ssl://b-1234a5b6-78cd-901e- ``` Do one of the following: - + One by one, point each existing consumer to your Amazon MQ broker's endpoint\. - + Create new consumers and point them to your Amazon MQ broker's endpoint\. **Note** If you scale up your consumer fleet during the migration process, it is a best practice to scale it down afterward\. diff --git a/doc_source/amazon-mq-migrating-service-interruption.md b/doc_source/amazon-mq-migrating-service-interruption.md index fff2487..c9a84ed 100644 --- a/doc_source/amazon-mq-migrating-service-interruption.md +++ b/doc_source/amazon-mq-migrating-service-interruption.md @@ -26,9 +26,7 @@ This step requires an interruption of your application's functionality because n ![\[Image NOT FOUND\]](http://docs.aws.amazon.com/amazon-mq/latest/developer-guide/images/number-3-red.png) Wait for your consumers to drain the destinations on your on\-premises broker\. ![\[Image NOT FOUND\]](http://docs.aws.amazon.com/amazon-mq/latest/developer-guide/images/number-4-red.png) Do one of the following: - + One by one, point each existing consumer to your Amazon MQ broker's endpoint\. - + Create new consumers and point them to your Amazon MQ broker's endpoint\. **Note** If you scale up your consumer fleet during the migration process, it is a best practice to scale it down afterward\. diff --git a/doc_source/amazon-mq-migrating.md b/doc_source/amazon-mq-migrating.md index ca02fbd..e2fde4a 100644 --- a/doc_source/amazon-mq-migrating.md +++ b/doc_source/amazon-mq-migrating.md @@ -2,7 +2,7 @@ Use the following topics to get started with migrating your on\-premises message broker to Amazon MQ\. - +**Topics** + [Migrating to Amazon MQ without Service Interruption](amazon-mq-migrating-no-service-interruption.md) + [Migrating to Amazon MQ with Service Interruption](amazon-mq-migrating-service-interruption.md) diff --git a/doc_source/amazon-mq-monitoring-logging.md b/doc_source/amazon-mq-monitoring-logging.md index 9396561..c2f399a 100644 --- a/doc_source/amazon-mq-monitoring-logging.md +++ b/doc_source/amazon-mq-monitoring-logging.md @@ -2,6 +2,6 @@ This section provides information about monitoring and logging Amazon MQ broker activity\. - +**Topics** + [Monitoring Amazon MQ Using CloudWatch](amazon-mq-monitoring-cloudwatch.md) + [Logging Amazon MQ API Calls Using CloudTrail](amazon-mq-logging-cloudtrail.md) \ No newline at end of file diff --git a/doc_source/amazon-mq-release-notes.md b/doc_source/amazon-mq-release-notes.md index b745252..a8e9507 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 | | --- | --- | +| July 25, 2018 | Amazon MQ is available in the Asia Pacific \(Tokyo\) and Asia Pacific \(Seoul\) Regions 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 19, 2018 | You can use AWS CloudTrail to log Amazon MQ API calls\. For more information, see [Logging Amazon MQ API Calls Using AWS CloudTrail](amazon-mq-logging-cloudtrail.md)\. | | June 29, 2018 | In addition to mq\.t2\.micro and mq\.m4\.large, the following broker instance types are available for regular development, testing, and production workloads that require high throughput: [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/amazon-mq/latest/developer-guide/amazon-mq-release-notes.html)For more information, see [Instance Types](broker.md#broker-instance-types)\. | | June 27, 2018 | Amazon MQ is available in the US West \(N\. California\) 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) | diff --git a/doc_source/amazon-mq-security.md b/doc_source/amazon-mq-security.md index e428278..a1366cf 100644 --- a/doc_source/amazon-mq-security.md +++ b/doc_source/amazon-mq-security.md @@ -2,6 +2,6 @@ This section provides information about Amazon MQ and ActiveMQ authentication and authorization\. For information about security best practices, see [Using Amazon MQ Securely](using-amazon-mq-securely.md)\. - +**Topics** + [API Authentication and Authorization for Amazon MQ](amazon-mq-api-authentication-authorization.md) + [Messaging Authentication and Authorization for ActiveMQ](activemq-authentication-authorization.md) \ No newline at end of file diff --git a/doc_source/amazon-mq-setting-up.md b/doc_source/amazon-mq-setting-up.md index ecd52bc..eb8e7c3 100644 --- a/doc_source/amazon-mq-setting-up.md +++ b/doc_source/amazon-mq-setting-up.md @@ -2,7 +2,7 @@ Before you can use Amazon MQ, you must complete the following steps\. - +**Topics** + [Create an AWS Account and an IAM Administrator User](#create-aws-account) + [Create an IAM User and Get Your AWS Credentials](#create-iam-user) + [Get Ready to Use the Example Code](#get-ready-to-use-example-code) diff --git a/doc_source/amazon-mq-tutorials.md b/doc_source/amazon-mq-tutorials.md index 1303aca..36fe2da 100644 --- a/doc_source/amazon-mq-tutorials.md +++ b/doc_source/amazon-mq-tutorials.md @@ -2,7 +2,7 @@ The following tutorials show how you can work with Amazon MQ and ActiveMQ using the AWS Management Console and Java\. To use the example code, you must install the [Java Standard Edition Development Kit](http://www.oracle.com/technetwork/java/javase/downloads/) and make some changes to the code\. - +**Topics** + [Creating and Configuring a Broker](amazon-mq-creating-configuring-broker.md) + [Creating and Applying Broker Configurations](amazon-mq-creating-applying-configurations.md) + [Editing and Managing Broker Configurations](amazon-mq-editing-managing-configurations.md) diff --git a/doc_source/amazon-mq-working-java-example.md b/doc_source/amazon-mq-working-java-example.md index 3defda1..513063a 100644 --- a/doc_source/amazon-mq-working-java-example.md +++ b/doc_source/amazon-mq-working-java-example.md @@ -1,11 +1,8 @@ # Working Examples of Using Java Message Service \(JMS\) with ActiveMQ The following examples show how you can work with ActiveMQ programmatically: - + The OpenWire example Java code connects to a broker, creates a queue, and sends and receives a message\. For a detailed breakdown and explanation, see [Tutorial: Connecting a Java Application to Your Amazon MQ Broker](amazon-mq-connecting-application.md)\. - + The MQTT example Java code connects to a broker, creates a topic, and publishes and receives a message\. - + The STOMP\+WSS example Java code connects to a broker, creates a queue, and publishes and receives a message\. ## Prerequisites @@ -85,17 +82,11 @@ For more information about `org.eclipse.paho.client.mqttv3.jar`, see [Eclipse Pa #### [ STOMP\+WSS ] Add the following packages to your Java class path: - + `spring-messaging.jar` - + `spring-websocket.jar` - + `javax.websocket-api.jar` - + `jetty-all.jar` - + `slf4j-simple.jar` - + `jackson-databind.jar` The following example shows these dependencies in a Maven project `pom.xml` file\. diff --git a/doc_source/broker.md b/doc_source/broker.md index f297f37..dcfbe1c 100644 --- a/doc_source/broker.md +++ b/doc_source/broker.md @@ -1,9 +1,7 @@ # 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* \(`m5`, `t2`\) and *size* \(`large`, `micro`\) is a *broker instance type* \(for example, `mq.m5.large`\)\. For more information, see [Instance Types](#broker-instance-types)\. - + 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\. - + 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 Broker Architecture](amazon-mq-broker-architecture.md)\. @@ -11,41 +9,28 @@ For more information, see [Amazon MQ Broker Architecture](amazon-mq-broker-archi You can enable *automatic minor version upgrades* to new minor versions of the broker engine, as Apache releases new versions\. Automatic upgrades occur during the 2\-hour *maintenance window* defined by the day of the week, the time of day \(in 24\-hour format\), and the time zone \(UTC by default\)\. For information about creating and managing brokers, see the following: - + [Tutorial: Creating and Configuring an Amazon MQ Broker](amazon-mq-creating-configuring-broker.md) - + [Brokers](amazon-mq-limits.md#broker-limits) - + [Statuses](#broker-statuses) ## Attributes A broker has several attributes, for example: - + A name \(`MyBroker`\) - + An ID \(`b-1234a5b6-78cd-901e-2fgh-3i45j6k178l9`\) - + An Amazon Resource Name \(ARN\) \(`arn:aws:mq:us-east-2:123456789012:broker:MyBroker:b-1234a5b6-78cd-901e-2fgh-3i45j6k178l9`\) - + An ActiveMQ Web Console URL \(`https://b-1234a5b6-78cd-901e-2fgh-3i45j6k178l9-1.mq.us-east-2.amazonaws.com:8162`\) For more information, see [Web Console](http://activemq.apache.org/web-console.html) in the Apache ActiveMQ documentation\. **Important** If you specify an authorization map which doesn't include the `activemq-webconsole` group, you can't use the ActiveMQ Web Console because the group isn't authorized to send messages to, or receive messages from, the Amazon MQ broker\. - + Wire\-level protocol endpoints: - + `amqp+ssl://b-1234a5b6-78cd-901e-2fgh-3i45j6k178l9-1.mq.us-east-2.amazonaws.com:5671` - + `mqtt+ssl://b-1234a5b6-78cd-901e-2fgh-3i45j6k178l9-1.mq.us-east-2.amazonaws.com:8883` - + `ssl://b-1234a5b6-78cd-901e-2fgh-3i45j6k178l9-1.mq.us-east-2.amazonaws.com:61617` **Note** This is an OpenWire endpoint\. - + `stomp+ssl://b-1234a5b6-78cd-901e-2fgh-3i45j6k178l9-1.mq.us-east-2.amazonaws.com:61614` - + `wss://b-1234a5b6-78cd-901e-2fgh-3i45j6k178l9-1.mq.us-east-2.amazonaws.com:61619` For more information, see [Configuring Transports](http://activemq.apache.org/configuring-transports.html) in the Apache ActiveMQ documentation\. @@ -54,11 +39,8 @@ This is an OpenWire endpoint\. 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 a full list of broker attributes, see the following in the *Amazon MQ REST API Reference*: - + [REST Operation ID: Broker](http://docs.aws.amazon.com/amazon-mq/latest/api-reference/rest-api-broker.html) - + [REST Operation ID: Brokers](http://docs.aws.amazon.com/amazon-mq/latest/api-reference/rest-api-brokers.html) - + [REST Operation ID: Broker Reboot](http://docs.aws.amazon.com/amazon-mq/latest/api-reference/rest-api-broker-reboot.html) ## Instance Types diff --git a/doc_source/child-element-details.md b/doc_source/child-element-details.md index 11fb346..c945484 100644 --- a/doc_source/child-element-details.md +++ b/doc_source/child-element-details.md @@ -6,7 +6,7 @@ The following is a detailed explanation of child element attributes\. For more i `authorizationEntry` is a child of the `authorizationEntries` child collection element\. -### admin|read|write +### admin\|read\|write **Amazon MQ Default:** Not configured\. diff --git a/doc_source/configuration.md b/doc_source/configuration.md index 13a7051..9f97dd4 100644 --- a/doc_source/configuration.md +++ b/doc_source/configuration.md @@ -7,13 +7,9 @@ Making changes to a configuration does *not* apply the changes to the broker imm Currently, it isn't possible to delete a configuration\. 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) - + [Configurations](amazon-mq-limits.md#configuration-limits) - + [Amazon MQ Broker Configuration Parameters](amazon-mq-broker-configuration-parameters.md) To keep track of the changes you make to your configuration, you can create *configuration revisions*\. For more information, see [Tutorial: Creating and Applying Amazon MQ Broker Configurations](amazon-mq-creating-applying-configurations.md) and [Tutorial: Editing Amazon MQ Broker Configurations and Managing Configuration Revisions](amazon-mq-editing-managing-configurations.md)\. @@ -21,21 +17,14 @@ To keep track of the changes you make to your configuration, you can create *con ## Attributes A broker configuration has several attributes, for example: - + A name \(`MyConfiguration`\) - + An ID \(`c-1234a5b6-78cd-901e-2fgh-3i45j6k178l9`\) - + An Amazon Resource Name \(ARN\) \(`arn:aws:mq:us-east-2:123456789012:configuration:MyConfiguration:c-1234a5b6-78cd-901e-2fgh-3i45j6k178l9`\) For a full list of configuration attributes, see the following in the *Amazon MQ REST API Reference*: - + [REST Operation ID: Configuration](http://docs.aws.amazon.com/amazon-mq/latest/api-reference/rest-api-configuration.html) - + [REST Operation ID: Configurations](http://docs.aws.amazon.com/amazon-mq/latest/api-reference/rest-api-configurations.html) For a full list of configuration revision attributes, see the following: - + [REST Operation ID: Configuration Revision](http://docs.aws.amazon.com/amazon-mq/latest/api-reference/rest-api-configuration-revision.html) - + [REST Operation ID: Configuration Revisions](http://docs.aws.amazon.com/amazon-mq/latest/api-reference/rest-api-configuration-revisions.html) \ No newline at end of file diff --git a/doc_source/connecting-to-amazon-mq.md b/doc_source/connecting-to-amazon-mq.md index 81e160a..931aec6 100644 --- a/doc_source/connecting-to-amazon-mq.md +++ b/doc_source/connecting-to-amazon-mq.md @@ -2,7 +2,7 @@ The following design patterns can improve the effectiveness of your application's connection to your Amazon MQ broker\. - +**Topics** + [Never Modify or Delete the Amazon MQ Elastic Network Interface](#never-modify-delete-elastic-network-interface) + [Always Use Connection Pooling](#always-use-connection-pooling) + [Always Use the Failover Transport to Connect to Multiple Broker Endpoints](#always-use-failover-transport-connect-to-multiple-broker-endpoints) diff --git a/doc_source/ensuring-effective-amazon-mq-performance.md b/doc_source/ensuring-effective-amazon-mq-performance.md index 50af17d..076ba81 100644 --- a/doc_source/ensuring-effective-amazon-mq-performance.md +++ b/doc_source/ensuring-effective-amazon-mq-performance.md @@ -5,9 +5,7 @@ The following design patterns can improve the effectiveness and performance of y ## Disable Concurrent Store and Dispatch for Queues with Slow Consumers By default, Amazon MQ optimizes for queues with fast consumers: - + Consumers are considered *fast* if they are able to keep up with the rate of messages generated by producers\. - + Consumers are considered *slow* if a queue builds up a backlog of unacknowledged messages, potentially causing a decrease in producer throughput\. To instruct Amazon MQ to optimize for queues with slow consumers, set the `concurrentStoreAndDispatchQueues` attribute to `false`\. For an example configuration, see [`concurrentStoreAndDispatchQueues`](child-element-details.md#concurrentStoreAndDispatchQueues)\. @@ -15,21 +13,15 @@ To instruct Amazon MQ to optimize for queues with slow consumers, set the `concu ## Choose the Correct Broker Instance Type for the Best Throughput The message throughput of a [broker instance type](broker.md#broker-instance-types) depends on your application's use case and the following factors: - + Use of ActiveMQ in persistent mode - + Message size - + The number of producers and consumers - + The number of destinations ### Understanding the Relationship Between Message Size, Latency, and Throughput Depending on your use case, a larger broker instance type might not necessarily improve system throughput\. When ActiveMQ writes messages to durable storage, the size of your messages determines your system's limiting factor: - + If your messages are smaller than 100 KB, persistent storage latency is the limiting factor\. - + If your messages are larger than 100 KB, persistent storage throughput is the limiting factor\. When you use ActiveMQ in persistent mode, writing to storage normally occurs when there are either few consumers or when the consumers are slow\. In non\-persistent mode, writing to storage also occurs with slow consumers if the heap memory of the broker instance is full\. Because Amazon MQ has highly\-durable storage \(all persistent messages are replicated across three Availability Zones\), the throughput to persistent storage is smaller than the throughput to local, single\-AZ storage\. @@ -42,9 +34,6 @@ You can't change an existing broker to a different broker instance type\. Using ### Use Cases for Larger Broker Instance Types There are three common use cases when larger broker instance types improve throughput: - + **Non\-persistent mode** – When your application is less sensitive to losing messages during [broker instance failover](active-standby-broker-deployment.md) \(for example, when broadcasting sports scores\), you can often use ActiveMQ's non\-persistent mode\. In this mode, ActiveMQ writes messages to persistent storage only if the heap memory of the broker instance is full\. Systems that use non\-persistent mode can benefit from the higher amount of memory, faster CPU, and faster network available on larger broker instance types\. - + **Fast consumers** – When active consumers are available and the [`concurrentStoreAndDispatchQueues`](child-element-details.md#concurrentStoreAndDispatchQueues) flag is enabled, ActiveMQ allows messages to flow directly from producer to consumer without sending messages to storage \(even in persistent mode\)\. If your application can consume messages quickly \(or if you can design your consumers to do this\), your application can benefit from a larger broker instance type\. To let your application consume messages more quickly, add consumer threads to your application instances or scale up your application instances vertically or horizontally\. - + **Batched transactions** – When you use persistent mode and send multiple messages per transaction, you can achieve an overall higher message throughput by using larger broker instance types\. For more information, see [Should I Use Transactions?](http://activemq.apache.org/should-i-use-transactions.html) in the ActiveMQ documentation\. \ No newline at end of file diff --git a/doc_source/permitted-elements.md b/doc_source/permitted-elements.md index 47d66b5..707c4ac 100644 --- a/doc_source/permitted-elements.md +++ b/doc_source/permitted-elements.md @@ -10,10 +10,10 @@ The following is a detailed listing of the elements permitted in Amazon MQ confi | authorizationEntry [\(attributes\)](permitted-attributes.md#authorizationEntry.attributes) | | authorizationMap [\(child collection elements\)](permitted-collections.md#authorizationMap.collections) | | authorizationPlugin [\(child collection elements\)](permitted-collections.md#authorizationPlugin.collections) | -| broker [\(attributes](permitted-attributes.md#broker.attributes) | [child collection elements\)](permitted-collections.md#broker.collections) | +| broker [\(attributes](permitted-attributes.md#broker.attributes) \| [child collection elements\)](permitted-collections.md#broker.collections) | | cachedMessageGroupMapFactory [\(attributes\)](permitted-attributes.md#cachedMessageGroupMapFactory.attributes) | -| compositeQueue [\(attributes](permitted-attributes.md#compositeQueue.attributes) | [child collection elements\)](permitted-collections.md#compositeQueue.collections) | -| compositeTopic [\(attributes](permitted-attributes.md#compositeTopic.attributes) | [child collection elements\)](permitted-collections.md#compositeTopic.collections) | +| compositeQueue [\(attributes](permitted-attributes.md#compositeQueue.attributes) \| [child collection elements\)](permitted-collections.md#compositeQueue.collections) | +| compositeTopic [\(attributes](permitted-attributes.md#compositeTopic.attributes) \| [child collection elements\)](permitted-collections.md#compositeTopic.collections) | | constantPendingMessageLimitStrategy [\(attributes\)](permitted-attributes.md#constantPendingMessageLimitStrategy.attributes) | | discarding [\(attributes\)](permitted-attributes.md#discarding.attributes) | | discardingDLQBrokerPlugin [\(attributes\)](permitted-attributes.md#discardingDLQBrokerPlugin.attributes) | @@ -31,19 +31,19 @@ The following is a detailed listing of the elements permitted in Amazon MQ confi | noSubscriptionRecoveryPolicy | | oldestMessageEvictionStrategy [\(attributes\)](permitted-attributes.md#oldestMessageEvictionStrategy.attributes) | | oldestMessageWithLowestPriorityEvictionStrategy [\(attributes\)](permitted-attributes.md#oldestMessageWithLowestPriorityEvictionStrategy.attributes) | -| policyEntry [\(attributes](permitted-attributes.md#policyEntry.attributes) | [child collection elements\)](permitted-collections.md#policyEntry.collections) | +| policyEntry [\(attributes](permitted-attributes.md#policyEntry.attributes) \| [child collection elements\)](permitted-collections.md#policyEntry.collections) | | policyMap [\(child collection elements\)](permitted-collections.md#policyMap.collections) | | prefetchRatePendingMessageLimitStrategy [\(attributes\)](permitted-attributes.md#prefetchRatePendingMessageLimitStrategy.attributes) | | priorityDispatchPolicy | | priorityNetworkDispatchPolicy | | queryBasedSubscriptionRecoveryPolicy [\(attributes\)](permitted-attributes.md#queryBasedSubscriptionRecoveryPolicy.attributes) | | queue [\(attributes\)](permitted-attributes.md#queue.attributes) | -| redeliveryPlugin [\(attributes](permitted-attributes.md#redeliveryPlugin.attributes) | [child collection elements\)](permitted-collections.md#redeliveryPlugin.collections) | +| redeliveryPlugin [\(attributes](permitted-attributes.md#redeliveryPlugin.attributes) \| [child collection elements\)](permitted-collections.md#redeliveryPlugin.collections) | | redeliveryPolicy [\(attributes\)](permitted-attributes.md#redeliveryPolicy.attributes) | | redeliveryPolicyMap [\(child collection elements\)](permitted-collections.md#redeliveryPolicyMap.collections) | | retainedMessageSubscriptionRecoveryPolicy [\(child collection elements\)](permitted-collections.md#retainedMessageSubscriptionRecoveryPolicy.collections) | | roundRobinDispatchPolicy | -| sharedDeadLetterStrategy [\(attributes](permitted-attributes.md#sharedDeadLetterStrategy.attributes) | [child collection elements\)](permitted-collections.md#sharedDeadLetterStrategy.collections) | +| sharedDeadLetterStrategy [\(attributes](permitted-attributes.md#sharedDeadLetterStrategy.attributes) \| [child collection elements\)](permitted-collections.md#sharedDeadLetterStrategy.collections) | | simpleDispatchPolicy | | simpleMessageGroupMapFactory | | statisticsBrokerPlugin | diff --git a/doc_source/user.md b/doc_source/user.md index b27ddc2..8985586 100644 --- a/doc_source/user.md +++ b/doc_source/user.md @@ -8,21 +8,15 @@ A user can belong to a *group*\. You can configure which users belong to which g Making changes to a user does *not* apply the changes to the user immediately\. To apply your changes, you must [wait for the next 2\-hour 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)\. For information about users and groups, see the following in the Apache ActiveMQ documentation: - + [Authorization](http://activemq.apache.org/security.html#Security-Authorization) - + [Authorization Example](http://activemq.apache.org/security.html#Security-AuthorizationExample) 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) ## Attributes For a full list of user attributes, see the following in the *Amazon MQ REST API Reference*: - + [REST Operation ID: User](http://docs.aws.amazon.com/amazon-mq/latest/api-reference/rest-api-user.html) - + [REST Operation ID: Users](http://docs.aws.amazon.com/amazon-mq/latest/api-reference/rest-api-users.html) \ No newline at end of file diff --git a/doc_source/using-amazon-mq-securely.md b/doc_source/using-amazon-mq-securely.md index 32fe2f7..25ad036 100644 --- a/doc_source/using-amazon-mq-securely.md +++ b/doc_source/using-amazon-mq-securely.md @@ -2,7 +2,7 @@ The following design patterns can improve the security of your Amazon MQ broker\. - +**Topics** + [Prefer Brokers without Public Accessibility](#prefer-brokers-without-public-accessibility) + [Always Use Client\-Side Encryption as a Complement to TLS](#always-use-client-side-encryption-complement-tls) + [Always Configure an Authorization Map](#always-configure-authorization-map) @@ -15,17 +15,11 @@ Brokers created without public accessibility can't be accessed from outside of y ## Always Use Client\-Side Encryption as a Complement to TLS 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 encrypts messages at rest and in transit using encryption keys that it manages and stores securely\. For additional security, we highly recommend designing your application to use client\-side encryption\. For more information, see the *[AWS Encryption SDK Developer Guide](http://docs.aws.amazon.com/encryption-sdk/latest/developer-guide/)*\. diff --git a/doc_source/welcome.md b/doc_source/welcome.md index c536d1a..e418b15 100644 --- a/doc_source/welcome.md +++ b/doc_source/welcome.md @@ -6,22 +6,17 @@ Amazon MQ is a managed message broker service for [Apache ActiveMQ](http://activ Amazon MQ works with your existing applications and services without the need to manage, operate, or maintain your own messaging system\. - +**Topics** + [What Are the Main Benefits of Amazon MQ?](#main-benefits) + [How is Amazon MQ Different from Amazon SQS or Amazon SNS?](#difference-from-sqs-sns) + [How Can I Get Started with Amazon MQ?](#get-started) + [We Want to Hear from You](#amazon-mq-we-want-to-hear-from-you) ## What Are the Main Benefits of Amazon MQ? - + **Security** – You control [who can create and modify brokers](amazon-mq-api-authentication-authorization.md) and [who can send messages to and receive messages from](activemq-authentication-authorization.md) an ActiveMQ broker\. Amazon MQ encrypts messages at rest and in transit using encryption keys that it manages and stores securely\. - + **Durability** – To ensure the safety of your messages, Amazon MQ stores them on [redundant shared storage](amazon-mq-broker-architecture.md)\. - + **Availability** – You can create a [single\-instance broker](single-broker-deployment.md) \(comprised of one broker in one Availability Zone\), or an [active/standby broker for high availability](active-standby-broker-deployment.md) \(comprised of two brokers in two different Availability Zones\)\. For either broker type, Amazon MQ automatically provisions infrastructure for high durability\. - + **Enterprise readiness** – Amazon MQ supports industry\-standard APIs and protocols so you can [migrate from your existing message broker](amazon-mq-migrating.md) without rewriting [application code](amazon-mq-working-java-example.md)\. - + **Operation offloading** – You can [configure many aspects of your ActiveMQ broker](amazon-mq-broker-configuration-parameters.md), such as predefined destinations, destination policies, authorization policies, and plugins\. Amazon MQ controls some of these configuration elements, such as network transports and storage, simplifying the maintenance and administration of your messaging system in the cloud\. ## How Is Amazon MQ Different from Amazon SQS or Amazon SNS? @@ -31,15 +26,10 @@ Amazon MQ is a managed message broker service that provides compatibility with m [Amazon SQS](https://aws.amazon.com/sqs/) and [Amazon SNS](https://aws.amazon.com/sns/) are queue and topic services that are highly scalable, simple to use, and don't require you to set up message brokers\. We recommend these services for new applications that can benefit from nearly unlimited scalability and simple APIs\. ## How Can I Get Started with Amazon MQ? - + To create your first broker with Amazon MQ, see [Getting Started with Amazon MQ](amazon-mq-getting-started.md)\. - + To discover the functionality and architecture of Amazon MQ, see [How Amazon MQ Works](amazon-mq-how-it-works.md)\. - + To find out the guidelines and caveats that will help you make the most of Amazon MQ, see [Best Practices for Amazon MQ](amazon-mq-best-practices.md)\. - + To learn about Amazon MQ REST APIs, see the *[Amazon MQ REST API Reference](http://docs.aws.amazon.com/amazon-mq/latest/api-reference/)*\. - + To learn about Amazon MQ AWS CLI commands, see [Amazon MQ in the *AWS CLI Command Reference*](http://docs.aws.amazon.com/cli/latest/reference/mq/index.html)\. ## We Want to Hear from You