Split (1)

train · 107k rows

id stringlengths 8 78	source stringclasses 743 values	chunk_id int64 1 5.05k	text stringlengths 593 49.7k
amazon-mq-dg-014	amazon-mq-dg.pdf	14	to organize your AWS bill to reﬂect your own cost structure. To do this, sign up to get your AWS account bill to include the tag keys and values. For more information, see Setting Up a Monthly Cost Allocation Report in the AWS Billing User Guide. For instance, you could add tags that represent the cost center and purpose of your Amazon MQ resources: Resource Key Cost Center Value 34567 Broker1 Broker2 Tagging Stack Production Cost Center 34567 Stack Production 35 Amazon MQ Resource Broker3 Developer Guide Key Cost Center Value 12345 Stack Development This tagging scheme allows you to group two brokers performing related tasks in the same cost center, while tagging an unrelated broker with a diﬀerent cost allocation tag. Adding tags in the Amazon MQ Console You can quickly add tags to the resources you are creating in the Amazon MQ console by following these steps: 1. From the Create a broker page, select Additional settings. 2. Under Tags, select Add tag. 3. 4. 5. Enter a Key and Value pair. (Optional) Select Add tag to add multiple tags to your broker. Select Create broker. To add tags as you create a conﬁguration: 1. From the Create conﬁguration page, select Advanced. 2. Under Tags on the Create conﬁguration page, select Add tag. 3. 4. 5. Enter a Key and Value pair. (Optional) Select Add tag to add multiple tags to your conﬁguration. Select Create conﬁguration. After adding tags, you can view, edit, and remove the tags for your resources in the Amazon MQ console. You can also view the tags of your resources using the REST API. For more information, see the Amazon MQ REST API Reference. Adding tags in the Amazon MQ Console 36 Amazon MQ Developer Guide Using Amazon MQ for ActiveMQ Amazon MQ makes it easy to create a message broker with the computing and storage resources that ﬁt your needs. You can create, manage, and delete brokers using the AWS Management Console, Amazon MQ REST API, or the AWS Command Line Interface. Amazon MQ for ActiveMQ brokers can be deployment as single-instance brokers or active/standby brokers. For both deployment modes, Amazon MQ provides high durability by storing its data redundantly. Note Amazon MQ uses Apache KahaDB as its data store. Other data stores, such as JDBC and LevelDB, aren't supported. You can access your brokers by using any programming language that ActiveMQ supports and by enabling TLS explicitly for the following protocols: • AMQP • MQTT • MQTT over WebSocket • OpenWire • STOMP • STOMP over WebSocket To learn about Amazon MQ REST APIs, see the Amazon MQ REST API Reference. Amazon MQ for ActiveMQ brokers What is an Amazon MQ for ActiveMQ 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, t3) and size (large, micro) is called the broker instance type (for example, mq.m5.large). For more information, see Broker instance types. Amazon MQ for ActiveMQ brokers 37 Amazon MQ Developer Guide • A single-instance broker is comprised of one broker in one Availability Zone. The broker communicates with your application and with an Amazon EBS or Amazon EFS storage volume. • An active/standby broker is comprised of two brokers in two diﬀerent Availability Zones, conﬁgured in a redundant pair. These brokers communicate synchronously with your application, and with Amazon EFS. For more information, see Deployment options for Amazon MQ for ActiveMQ brokers. 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 maintenance window deﬁned 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: • Getting started: Creating and connecting to an ActiveMQ broker • Brokers • Broker statuses Supported wire-level protocols You can access your brokers by using any programming language that ActiveMQ supports and by enabling TLS explicitly for the following protocols: • AMQP • MQTT • MQTT over WebSocket • OpenWire • STOMP • STOMP over WebSocket Attributes An ActiveMQ broker has several attributes, for example: • A name (MyBroker) • An ID (b-1234a5b6-78cd-901e-2fgh-3i45j6k178l9) Broker 38 Amazon MQ Developer Guide • 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 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
amazon-mq-dg-015	amazon-mq-dg.pdf	15	broker has several attributes, for example: • A name (MyBroker) • An ID (b-1234a5b6-78cd-901e-2fgh-3i45j6k178l9) Broker 38 Amazon MQ Developer Guide • 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 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 Conﬁguring Transports in the Apache ActiveMQ documentation. Note For an active/standby broker, 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 Broker 39 Amazon MQ Developer Guide wire-level protocol, but only one endpoint is active in each pair at a time. The -1 and -2 suﬃxes 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 • REST Operation ID: Brokers • REST Operation ID: Broker Reboot Broker users An ActiveMQ user is a person or an application that can access the queues and topics of an ActiveMQ broker. You can conﬁgure users to have speciﬁc permissions. For example, you can allow some users to access the ActiveMQ Web Console. A group is a semantic label. You can assign a group to a user and conﬁgure permissions for groups to send to, receive from, and administer speciﬁc queues and topics. 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 or reboot the broker. For information about users and groups, see the following in the Apache ActiveMQ documentation: • Authorization • Authorization Example For information about creating, editing, and deleting ActiveMQ users, see the following: • Creating an ActiveMQ broker user • Users User 40 Amazon MQ User attributes Developer Guide For a full list of user attributes, see the following in the Amazon MQ REST API Reference: • REST Operation ID: User • REST Operation ID: Users Deployment options for Amazon MQ for ActiveMQ brokers Amazon MQ oﬀers single instance and cluster deployment options for brokers. Option 1: Amazon MQ single-instance brokers A single-instance broker is comprised of one broker in one Availability Zone. The broker communicates with your application and with an Amazon EBS or Amazon EFS storage volume. Amazon EFS storage volumes are designed to provide the highest level of durability and availability by storing data redundantly across multiple Availability Zones (AZs). Amazon EBS provides block level storage optimized for low-latency and high throughput. For more information about storage options, see Storage. The following diagram illustrates a single-instance broker with Amazon EFS storage replicated across multiple AZs. The following diagram illustrates a single-instance broker with Amazon EBS storage replicated across multiple servers within a single AZ. Deploying a broker 41 Amazon MQ Developer Guide Option 2: Amazon MQ active/standby brokers for high availability An active/standby broker is comprised of two brokers in two diﬀerent Availability Zones, conﬁgured in a redundant pair. These brokers communicate synchronously with your application, and with Amazon EFS. Amazon EFS storage volumes are designed to provide the highest level of durability, and availability by storing data redundantly across multiple Availability Zones (AZs). For more information, see Storage. Usually, only one of the broker instances is active at any time, while the other broker instance is on standby. If one of the broker instances malfunctions or undergoes maintenance, it takes Amazon MQ a short while to take the inactive instance out of service. This allows the healthy standby instance to become active and to begin accepting incoming communications. When you reboot a broker, the failover takes only a few seconds. For an active/standby broker, 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 suﬃxes denote a redundant pair. For wire-level protocol endpoints, you can allow your application to connect to either endpoint by using the Failover Transport. The following diagram illustrates an active/standby broker with Amazon EFS storage replicated across multiple AZs. Active/standby broker 42 Amazon MQ Developer Guide Amazon MQ network of brokers Amazon MQ supports ActiveMQ's network of brokers feature. A network of brokers is comprised of multiple simultaneously active single-instance brokers or active/standby brokers. Creating a network of brokers can increase availability, fault tolerance, and
amazon-mq-dg-016	amazon-mq-dg.pdf	16	only one endpoint is active in each pair at a time. The -1 and -2 suﬃxes denote a redundant pair. For wire-level protocol endpoints, you can allow your application to connect to either endpoint by using the Failover Transport. The following diagram illustrates an active/standby broker with Amazon EFS storage replicated across multiple AZs. Active/standby broker 42 Amazon MQ Developer Guide Amazon MQ network of brokers Amazon MQ supports ActiveMQ's network of brokers feature. A network of brokers is comprised of multiple simultaneously active single-instance brokers or active/standby brokers. Creating a network of brokers can increase availability, fault tolerance, and load balancing with multiple broker instances. How does a Network of Brokers work? A network of brokers is established by connecting one broker to another using network connectors. A network connector provides on-demand message from one broker to another. Network connectors are conﬁgured in the broker conﬁguration as either non-duplex or duplex connections. For non-duplex connections, messages are forwarded only from one broker to the other. For duplex connections, messages are forwarded both ways between both brokers. If the network connector is conﬁgured as duplex, messages are also forwarded from Broker2 to Broker1. For example, here is a duplex networkConnector entry in a broker conﬁguration: Network of brokers 43 Amazon MQ Developer Guide You can use both non-duplex and duplex connections in a network of brokers. You may want to introduce a duplex connection to another broker to improve traﬃc, or to avoid a limit increase. Duplex connections are also useful for partial migration from on-premises to Amazon MQ managed brokers. How Does a Network of Brokers Handle Credentials? For broker A to connect to broker B in a network, broker A must use valid credentials, like any other producer or consumer. Instead of providing a password in broker A's <networkConnector> conﬁguration, you must ﬁrst create a user on broker A with the same values as another user on broker B (these are separate, unique users that share the same username and password values). When you specify the userName attribute in the <networkConnector> conﬁguration, Amazon MQ will add the password automatically at runtime. Important Don't specify the password attribute for the <networkConnector>. We don't recommend storing plaintext passwords in broker conﬁguration ﬁles, because this makes the passwords visible in the Amazon MQ console. For more information, see Conﬁgure Network Connectors for Your Broker. Cross region To conﬁgure a network of brokers that spans AWS regions, deploy brokers in those regions, and conﬁgure network connectors to the endpoints of those brokers. How Does a Network of Brokers Handle Credentials? 44 Amazon MQ Developer Guide To conﬁgure a network of brokers like this example, you could add networkConnectors entries to the conﬁgurations of Broker1 and Broker4 that reference the wire-level endpoints of those brokers. Network connectors for Broker1: <networkConnectors> <networkConnector name="1_to_2" userName="myCommonUser" duplex="true" uri="static:(ssl://b-9876l5k4-32ji-109h-8gfe-7d65c4b132a1-2.mq.us- west-2.amazonaws.com:61617)"/> <networkConnector name="1_to_3" userName="myCommonUser" duplex="true" uri="static:(ssl://b-743c885d-2244-4c95-af67-a85017ff234e-3.mq.us- east-2.amazonaws.com:61617)"/> <networkConnector name="1_to_4" userName="myCommonUser" duplex="true" uri="static:(ssl://b-62a7fb31-d51c-466a-a873-905cd660b553-4.mq.us- east-2.amazonaws.com:61617)"/> Cross region 45 Amazon MQ </networkConnectors> Network connector for Broker2: <networkConnectors> Developer Guide <networkConnector name="2_to_3" userName="myCommonUser" duplex="true" uri="static:(ssl://b-743c885d-2244-4c95-af67-a85017ff234e-3.mq.us- east-2.amazonaws.com:61617)"/> </networkConnectors> Network connectors for Broker4: <networkConnectors> <networkConnector name="4_to_3" userName="myCommonUser" duplex="true" uri="static:(ssl://b-743c885d-2244-4c95-af67-a85017ff234e-3.mq.us- east-2.amazonaws.com:61617)"/> <networkConnector name="4_to_2" userName="myCommonUser" duplex="true" uri="static:(ssl://b-9876l5k4-32ji-109h-8gfe-7d65c4b132a1-2.mq.us- west-2.amazonaws.com:61617)"/> </networkConnectors> Dynamic Failover With Transport Connectors In addition to conﬁguring networkConnector elements, you can conﬁgure your broker transportConnector options to enable dynamic failover, and to rebalance connections when brokers are added or removed from the network. <transportConnectors> <transportConnector name="openwire" updateClusterClients="true" rebalanceClusterClients="true" updateClusterClientsOnRemove="true"/> </transportConnectors> In this example both updateClusterClients and rebalanceClusterClients are set to true. In this case clients will be provided a list of brokers in the network, and will request them to rebalance if a new broker joins. Available options: • updateClusterClients: Passes information to clients about changes in the network of broker topology. Dynamic Failover With Transport Connectors 46 Amazon MQ Developer Guide • rebalanceClusterClients: Causes clients to re-balance across brokers when a new broker is added to a network of brokers. • updateClusterClientsOnRemove: Updates clients with topology information when a broker leaves a network of brokers. When updateClusterClients is set to true, clients can be conﬁgured to connect to a single broker in a network of brokers. failover:(ssl://b-1234a5b6-78cd-901e-2fgh-3i45j6k178l9-1.mq.us- east-2.amazonaws.com:61617) When a new broker connects, it will receive a list of URIs of all brokers in the network. If the connection to the broker fails, it can dynamically switch to one of the brokers provided when it connected. For more information on failover, see Broker-side Options for Failover in the Active MQ documentation. Amazon MQ for ActiveMQ broker instance types The combined description of the broker instance class (m5, t3) and size (large, micro) is called the broker instance type (for example, mq.m5.large). The following table lists the available Amazon MQ broker instance types for ActiveMQ brokers. Amazon MQ provides at least a 90 day notice before an instance type reaches end of support. We recommend
amazon-mq-dg-017	amazon-mq-dg.pdf	17	the network. If the connection to the broker fails, it can dynamically switch to one of the brokers provided when it connected. For more information on failover, see Broker-side Options for Failover in the Active MQ documentation. Amazon MQ for ActiveMQ broker instance types The combined description of the broker instance class (m5, t3) and size (large, micro) is called the broker instance type (for example, mq.m5.large). The following table lists the available Amazon MQ broker instance types for ActiveMQ brokers. Amazon MQ provides at least a 90 day notice before an instance type reaches end of support. We recommend upgrading your broker to a new instance type before the end-of-support date to prevent any disruptions. Important You cannot create brokers on t2.micro or mq.m4.large after March 17, 2025. Instance types 47 Amazon MQ Instance Type vCPU Memory (GiB) Recommend ed Use Storage Developer Guide End of support on Amazon MQ mq.t2.mic ro mq.t3.mic ro mq.m4.lar ge mq.m5.lar ge mq.m5.xla rge mq.m5.2xl arge 1 2 2 2 4 8 mq.m5.4xl 16 arge 1 1 8 8 16 32 64 Evaluation EFS May 12, 2025 Evaluation EFS Production EFS May 12, 2025 Production EFS or EBS Production EFS or EBS Production EFS or EBS Production EFS or EBS For more information about throughput considerations, see Choose the Correct Broker Instance Type for the Best Throughput. Amazon MQ for ActiveMQ broker conﬁgurations A conﬁguration contains all of the settings for your ActiveMQ broker in XML format (similar to ActiveMQ's activemq.xml ﬁle). You can create a conﬁguration before creating any brokers. You can then apply the conﬁguration to one or more brokers. Broker conﬁgurations 48 Amazon MQ Important Developer Guide Making changes to a conﬁguration does not apply the changes to the broker immediately. To apply your changes, you must wait for the next maintenance window or reboot the broker. You can only delete a conﬁguration using the DeleteConfiguration API. For more information, see Conﬁgurations in the Amazon MQ API Reference. Attributes A broker conﬁguration 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:c-1234a5b6-78cd-901e-2fgh-3i45j6k178l9) For a full list of conﬁguration attributes, see the following in the Amazon MQ REST API Reference: • REST Operation ID: Conﬁguration • REST Operation ID: Conﬁgurations For a full list of conﬁguration revision attributes, see the following: • REST Operation ID: Conﬁguration Revision • REST Operation ID: Conﬁguration Revisions Using Spring XML conﬁguration ﬁles ActiveMQ brokers are conﬁgured using Spring XML ﬁles. You can conﬁgure many aspects of your ActiveMQ broker, such as predeﬁned destinations, destination policies, authorization policies, and plugins. Amazon MQ controls some of these conﬁguration elements, such as network transports and storage. Other conﬁguration options, such as creating networks of brokers, aren't currently supported. Attributes 49 Amazon MQ Developer Guide The full set of supported conﬁguration options is speciﬁed in the Amazon MQ XML schemas. Download zip ﬁles of the supported schemas using the following links. • amazon-mq-active-mq-5.18.4.xsd.zip • amazon-mq-active-mq-5.17.6.xsd.zip • amazon-mq-active-mq-5.16.7.xsd.zip • amazon-mq-active-mq-5.15.16.xsd.zip You can use these schemas to validate and sanitize your conﬁguration ﬁles. Amazon MQ also lets you provide conﬁgurations by uploading XML ﬁles. When you upload an XML ﬁle, Amazon MQ automatically sanitizes and removes invalid and prohibited conﬁguration 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 conﬁguration. Creating an Amazon MQ for ActiveMQ broker conﬁguration A conﬁguration contains all of the settings for your ActiveMQ broker, in XML format (similar to ActiveMQ's activemq.xml ﬁle). You can create a conﬁguration before creating any brokers. You can then apply the conﬁguration to one or more brokers. You can apply a conﬁguration immediately or during a maintenance window. The following example shows how you can create and apply an Amazon MQ broker conﬁguration using the AWS Management Console. Important You can only delete a conﬁguration using the DeleteConfiguration API. For more information, see Conﬁgurations in the Amazon MQ API Reference. Create a New Conﬁguration To create a new broker conﬁguration, ﬁrst create the new conﬁguration. Creating a conﬁguration 50 Amazon MQ Developer Guide 1. Sign in to the Amazon MQ console. 2. On the left, expand the navigation panel and choose Conﬁgurations. 3. On the Conﬁgurations page, choose Create conﬁguration. 4. On the Create conﬁguration page, in the Details section, type the Conﬁguration name (for example, MyConfiguration) and select a Broker engine version. Note To learn more about ActiveMQ engine versions supported by Amazon MQ for ActiveMQ, see the section called “Version management”. 5. Choose Create conﬁguration. Create a New Conﬁguration Revision After you create a broker conﬁguration, you will need to edit the conﬁguration using a conﬁguration revision. 1. From the conﬁguration list, choose MyConfiguration. Note The ﬁrst
amazon-mq-dg-018	amazon-mq-dg.pdf	18	MQ console. 2. On the left, expand the navigation panel and choose Conﬁgurations. 3. On the Conﬁgurations page, choose Create conﬁguration. 4. On the Create conﬁguration page, in the Details section, type the Conﬁguration name (for example, MyConfiguration) and select a Broker engine version. Note To learn more about ActiveMQ engine versions supported by Amazon MQ for ActiveMQ, see the section called “Version management”. 5. Choose Create conﬁguration. Create a New Conﬁguration Revision After you create a broker conﬁguration, you will need to edit the conﬁguration using a conﬁguration revision. 1. From the conﬁguration list, choose MyConfiguration. Note The ﬁrst conﬁguration revision is always created for you when Amazon MQ creates the conﬁguration. On the MyConfiguration page, the broker engine type and version that your new conﬁguration revision uses (for example, Apache ActiveMQ 5.15.16) are displayed. 2. On the Conﬁguration details tab, the conﬁguration revision number, description, and broker conﬁguration in XML format are displayed. Creating a conﬁguration 51 Amazon MQ Note Developer Guide Editing the current conﬁguration creates a new conﬁguration revision. 3. Choose Edit conﬁguration and make changes to the XML conﬁguration. 4. Choose Save. The Save revision dialog box is displayed. 5. (Optional) Type A description of the changes in this revision. 6. Choose Save. The new revision of the conﬁguration is saved. Important The Amazon MQ console automatically sanitizes invalid and prohibited conﬁguration parameters according to a schema. For more information and a full list of permitted XML parameters, see Amazon MQ Broker Conﬁguration Parameters. Apply a Conﬁguration Revision to Your Broker After revising the conﬁguration, you can apply the conﬁguration revision to your broker. 1. On the left, expand the navigation panel and choose Brokers. Creating a conﬁguration 52 Amazon MQ Developer Guide 2. From the broker list, select your broker (for example, MyBroker) and then choose Edit. 3. On the Edit MyBroker page, in the Conﬁguration section, select a Conﬁguration and a Revision and then choose Schedule Modiﬁcations. 4. In the Schedule broker modiﬁcations section, choose whether to apply modiﬁcations During the next scheduled maintenance window or Immediately. Important Single instance brokers are oﬄine while being rebooted. For cluster brokers, only one node is down at a time while the broker reboots. 5. Choose Apply. Your conﬁguration revision is applied to your broker at the speciﬁed time. Edit an Amazon MQ for ActiveMQ conﬁguration revision You may want to edit a conﬁguration revision after applying it to your broker. Use the following instructions to edit a conﬁguration revision. 1. 2. Sign in to the Amazon MQ console. From the broker list, select your broker (for example, MyBroker) and then choose Edit. 3. On the MyBroker page, choose Edit. 4. On the Edit MyBroker page, in the Conﬁguration section, select a Conﬁguration and a Revision and then choose Edit. Note Unless you select a conﬁguration when you create a broker, the ﬁrst conﬁguration revision is always created for you when Amazon MQ creates the broker. Edit a conﬁguration revision 53 Amazon MQ Developer Guide On the MyBroker page, the broker engine type and version that the conﬁguration uses (for example, Apache ActiveMQ 5.15.8) are displayed. 5. On the Conﬁguration details tab, the conﬁguration revision number, description, and broker conﬁguration in XML format are displayed. Note Editing the current conﬁguration creates a new conﬁguration revision. 6. Choose Edit conﬁguration and make changes to the XML conﬁguration. 7. Choose Save. The Save revision dialog box is displayed. 8. (Optional) Type A description of the changes in this revision. 9. Choose Save. The new revision of the conﬁguration is saved. Important The Amazon MQ console automatically sanitizes invalid and prohibited conﬁguration parameters according to a schema. For more information and a full list of permitted XML parameters, see Amazon MQ Broker Conﬁguration Parameters. Edit a conﬁguration revision 54 Amazon MQ Developer Guide Elements permitted in Amazon MQ conﬁgurations The following is a detailed listing of the elements permitted in Amazon MQ conﬁgurations. For more information, see XML Conﬁguration in the Apache ActiveMQ documentation. Element abortSlowAckConsumerStrategy (attributes) abortSlowConsumerStrategy (attributes) authorizationEntry (attributes) authorizationMap (child collection elements) authorizationPlugin (child collection elements) broker (attributes \| child collection elements) cachedMessageGroupMapFactory (attributes) compositeQueue (attributes \| child collection elements) compositeTopic (attributes \| child collection elements) constantPendingMessageLimitStrategy (attributes) discarding (attributes) discardingDLQBrokerPlugin (attributes) fileCursor fileDurableSubscriberCursor fileQueueCursor filteredDestination (attributes) fixedCountSubscriptionRecoveryPolicy (attributes) Permitted elements 55 Amazon MQ Element Developer Guide fixedSizedSubscriptionRecoveryPolicy (attributes) forcePersistencyModeBrokerPlugin (attributes) individualDeadLetterStrategy (attributes) lastImageSubscriptionRecoveryPolicy messageGroupHashBucketFactory (attributes) mirroredQueue (attributes) noSubscriptionRecoveryPolicy oldestMessageEvictionStrategy (attributes) oldestMessageWithLowestPriorityEvictionStrategy (attributes) policyEntry (attributes \| child collection elements) policyMap (child collection elements) prefetchRatePendingMessageLimitStrategy (attributes) priorityDispatchPolicy priorityNetworkDispatchPolicy queryBasedSubscriptionRecoveryPolicy (attributes) queue (attributes) redeliveryPlugin (attributes \| child collection elements) redeliveryPolicy (attributes) redeliveryPolicyMap (child collection elements) retainedMessageSubscriptionRecoveryPolicy (child collection elements) Permitted elements 56 Amazon MQ Element roundRobinDispatchPolicy sharedDeadLetterStrategy (attributes \| child collection elements) Developer Guide simpleDispatchPolicy simpleMessageGroupMapFactory statisticsBrokerPlugin storeCursor storeDurableSubscriberCursor (attributes) strictOrderDispatchPolicy tempDestinationAuthorizationEntry (attributes) tempQueue (attributes) tempTopic (attributes) timedSubscriptionRecoveryPolicy
amazon-mq-dg-019	amazon-mq-dg.pdf	19	constantPendingMessageLimitStrategy (attributes) discarding (attributes) discardingDLQBrokerPlugin (attributes) fileCursor fileDurableSubscriberCursor fileQueueCursor filteredDestination (attributes) fixedCountSubscriptionRecoveryPolicy (attributes) Permitted elements 55 Amazon MQ Element Developer Guide fixedSizedSubscriptionRecoveryPolicy (attributes) forcePersistencyModeBrokerPlugin (attributes) individualDeadLetterStrategy (attributes) lastImageSubscriptionRecoveryPolicy messageGroupHashBucketFactory (attributes) mirroredQueue (attributes) noSubscriptionRecoveryPolicy oldestMessageEvictionStrategy (attributes) oldestMessageWithLowestPriorityEvictionStrategy (attributes) policyEntry (attributes \| child collection elements) policyMap (child collection elements) prefetchRatePendingMessageLimitStrategy (attributes) priorityDispatchPolicy priorityNetworkDispatchPolicy queryBasedSubscriptionRecoveryPolicy (attributes) queue (attributes) redeliveryPlugin (attributes \| child collection elements) redeliveryPolicy (attributes) redeliveryPolicyMap (child collection elements) retainedMessageSubscriptionRecoveryPolicy (child collection elements) Permitted elements 56 Amazon MQ Element roundRobinDispatchPolicy sharedDeadLetterStrategy (attributes \| child collection elements) Developer Guide simpleDispatchPolicy simpleMessageGroupMapFactory statisticsBrokerPlugin storeCursor storeDurableSubscriberCursor (attributes) strictOrderDispatchPolicy tempDestinationAuthorizationEntry (attributes) tempQueue (attributes) tempTopic (attributes) timedSubscriptionRecoveryPolicy (attributes) timeStampingBrokerPlugin (attributes) topic (attributes) transportConnector (attributes) uniquePropertyMessageEvictionStrategy (attributes) virtualDestinationInterceptor (child collection elements) virtualTopic (attributes) vmCursor vmDurableCursor Permitted elements 57 Amazon MQ Element vmQueueCursor Developer Guide Elements and Their Attributes Permitted in Amazon MQ Conﬁgurations The following is a detailed listing of the elements and their attributes permitted in Amazon MQ conﬁgurations. For more information, see XML Conﬁguration in the Apache ActiveMQ documentation. Element Attribute abortSlowAckConsumerStrategy abortConnection checkPeriod ignoreIdleConsumers ignoreNetworkConsumers maxSlowCount maxSlowDuration maxTimeSinceLastAck name abortSlowConsumerStrategy abortConnection checkPeriod ignoreNetworkConsumers maxSlowCount maxSlowDuration name Permitted Attributes 58 Amazon MQ Element authorizationEntry Developer Guide Attribute admin queue read tempQueue tempTopic topic write broker advisorySupport allowTempAutoCreationOnSend cacheTempDestinations consumerSystemUsagePortion dedicatedTaskRunner deleteAllMessagesOnStartup keepDurableSubsActive enableMessageExpirationOnAc tiveDurableSubs maxPurgedDestinationsPerSweep maxSchedulerRepeatAllowed monitorConnectionSplits networkConnectorStartAsync Permitted Attributes 59 Amazon MQ Element Developer Guide Attribute offlineDurableSubscriberTas kSchedule offlineDurableSubscriberTimeout persistenceThreadPriority persistent populateJMSXUserID producerSystemUsagePortion rejectDurableConsumers rollbackOnlyOnAsyncException schedulePeriodForDestinatio nPurge schedulerSupport splitSystemUsageForProducer sConsumers taskRunnerPriority timeBeforePurgeTempDestinations useAuthenticatedPrincipalFo rJMSXUserID useMirroredQueues useTempMirroredQueues useVirtualDestSubs useVirtualDestSubsOnCreation Permitted Attributes 60 Amazon MQ Element Developer Guide Attribute useVirtualTopics cachedMessageGroupMapFactory cacheSize compositeQueue concurrentSend copyMessage forwardOnly name sendWhenNotMatched compositeTopic concurrentSend copyMessage forwardOnly name sendWhenNotMatched conditionalNetworkBridgeFilterFactory rateDuration rateLimit replayDelay replayWhenNoConsumers selectorAware Supported in Apache ActiveMQ 5.16.x Permitted Attributes 61 Amazon MQ Element Attribute Developer Guide constantPendingMessageLimit limit Strategy discarding deadLetterQueue enableAudit expiration maxAuditDepth maxProducersToAudit processExpired processNonPersistent discardingDLQBrokerPlugin dropAll filteredDestination dropOnly dropTemporaryQueues dropTemporaryTopics reportInterval queue selector topic fixedCountSubscriptionRecov maximumSize eryPolicy fixedSizedSubscriptionRecov maximumSize eryPolicy useSharedBuffer Permitted Attributes 62 Amazon MQ Element Attribute Developer Guide forcePersistencyModeBrokerPlugin persistenceFlag individualDeadLetterStrategy destinationPerDurableSubscriber enableAudit expiration maxAuditDepth maxProducersToAudit processExpired processNonPersistent queuePrefix queueSuffix topicPrefix topicSuffix useQueueForQueueMessages useQueueForTopicMessages messageGroupHashBucketFactory bucketCount mirroredQueue cacheSize copyMessage postfix prefix oldestMessageEvictionStrategy evictExpiredMessagesHighWat ermark Permitted Attributes 63 Amazon MQ Element Attribute Developer Guide oldestMessageWithLowestPrio evictExpiredMessagesHighWat rityEvictionStrategy ermark policyEntry advisoryForConsumed advisoryForDelivery advisoryForDiscardingMessages advisoryForFastProducers advisoryForSlowConsumers advisoryWhenFull allConsumersExclusiveByDefault alwaysRetroactive blockedProducerWarningInterval consumersBeforeDispatchStarts cursorMemoryHighWaterMark doOptimzeMessageStorage durableTopicPrefetch enableAudit expireMessagesPeriod gcInactiveDestinations gcWithNetworkConsumers inactiveTimeoutBeforeGC inactiveTimoutBeforeGC Permitted Attributes 64 Amazon MQ Element Developer Guide Attribute includeBodyForAdvisory lazyDispatch maxAuditDepth maxBrowsePageSize maxDestinations maxExpirePageSize maxPageSize maxProducersToAudit maxQueueAuditDepth memoryLimit messageGroupMapFactoryType minimumMessageSize optimizedDispatch optimizeMessageStoreInFligh tLimit persistJMSRedelivered prioritizedMessages producerFlowControl queue queueBrowserPrefetch queuePrefetch Permitted Attributes 65 Amazon MQ Element Developer Guide Attribute reduceMemoryFootprint sendAdvisoryIfNoConsumers sendFailIfNoSpace sendFailIfNoSpaceAfterTimeout Supported in Apache ActiveMQ 5.16.4 and above sendDuplicateFromStoreToDLQ storeUsageHighWaterMark strictOrderDispatch tempQueue tempTopic timeBeforeDispatchStarts topic topicPrefetch useCache useConsumerPriority usePrefetchExtension prefetchRatePendingMessageL multiplier imitStrategy Permitted Attributes 66 Amazon MQ Element Attribute Developer Guide queryBasedSubscriptionRecov query eryPolicy queue DLQ physicalName redeliveryPlugin fallbackToDeadLetter sendToDlqIfMaxRetriesExceeded redeliveryPolicy backOffMultiplier collisionAvoidancePercent initialRedeliveryDelay maximumRedeliveries maximumRedeliveryDelay preDispatchCheck queue redeliveryDelay tempQueue tempTopic topic useCollisionAvoidance useExponentialBackOff sharedDeadLetterStrategy enableAudit expiration Permitted Attributes 67 Amazon MQ Element Developer Guide Attribute maxAuditDepth maxProducersToAudit processExpired processNonPersistent storeDurableSubscriberCursor immediatePriorityDispatch tempDestinationAuthorizatio nEntry tempQueue tempTopic useCache admin queue read tempQueue tempTopic topic write DLQ physicalName DLQ physicalName timedSubscriptionRecoveryPolicy zeroExpirationOverride timeStampingBrokerPlugin recoverDuration futureOnly Permitted Attributes 68 Amazon MQ Element topic transportConnector Developer Guide Attribute processNetworkMessages ttlCeiling DLQ physicalName • name updateClusterClients rebalanceClusterClients updateClusterClientsOnRemove uniquePropertyMessageEvicti evictExpiredMessagesHighWat onStrategy ermark virtualTopic propertyName concurrentSend local dropOnResourceLimit name postfix prefix selectorAware setOriginalDestination Permitted Attributes 69 Amazon MQ Element Developer Guide Attribute transactedSend Amazon MQ Parent Element Attributes The following is a detailed explanation of parent element attributes. For more information, see XML Conﬁguration in the Apache ActiveMQ documentation. Topics • broker broker broker is a parent collection element. Attributes networkConnectionStartAsync To mitigate network latency and to allow other networks to start in a timely manner, use the <networkConnectionStartAsync> tag. The tag instructs the broker to use an executor to start network connections in parallel, asynchronous to a broker start. Default: false Example Conﬁguration <broker networkConnectorStartAsync="false"/> Elements, Child Collection Elements, and Their Child Elements Permitted in Amazon MQ Conﬁgurations The following is a detailed listing of the elements, child collection elements, and their child elements permitted in Amazon MQ conﬁgurations. For more information, see XML Conﬁguration in the Apache ActiveMQ documentation. Permitted Collections 70 Amazon MQ Developer Guide Element Child Collection Element Child Element authorizationMap authorizationEntries authorizationEntry tempDestinationAut horizationEntry defaultEntry authorizationEntry tempDestinationAut horizationEntry tempDestinationAut tempDestinationAut horizationEntry horizationEntry authorizationPlugin map authorizationMap broker destinationInterce mirroredQueue ptors virtualDestination Interceptor destinationPolicy policyMap destinations queue tempQueue tempTopic topic networkConnectors networkConnector persistenceAdapter kahaDB plugins authorizationPlugin discardingDLQBroke rPlugin Permitted Collections 71 Amazon MQ Element Child Collection Element Child Element Developer Guide forcePersistencyMo deBrokerPlugin redeliveryPlugin statisticsBrokerPl ugin timeStampingBroker Plugin systemUsage systemUsage transportConnector name updateClusterClients rebalanceClusterCl ients updateClusterClien tsOnRemove compositeQueue forwardTo queue tempQueue tempTopic topic filteredDestination compositeTopic forwardTo queue tempQueue tempTopic Permitted Collections 72 Amazon MQ Element Child Collection Element Child Element Developer Guide policyEntry deadLetterStrategy discarding topic filteredDestination destination
amazon-mq-dg-020	amazon-mq-dg.pdf	20	Element Child Element authorizationMap authorizationEntries authorizationEntry tempDestinationAut horizationEntry defaultEntry authorizationEntry tempDestinationAut horizationEntry tempDestinationAut tempDestinationAut horizationEntry horizationEntry authorizationPlugin map authorizationMap broker destinationInterce mirroredQueue ptors virtualDestination Interceptor destinationPolicy policyMap destinations queue tempQueue tempTopic topic networkConnectors networkConnector persistenceAdapter kahaDB plugins authorizationPlugin discardingDLQBroke rPlugin Permitted Collections 71 Amazon MQ Element Child Collection Element Child Element Developer Guide forcePersistencyMo deBrokerPlugin redeliveryPlugin statisticsBrokerPl ugin timeStampingBroker Plugin systemUsage systemUsage transportConnector name updateClusterClients rebalanceClusterCl ients updateClusterClien tsOnRemove compositeQueue forwardTo queue tempQueue tempTopic topic filteredDestination compositeTopic forwardTo queue tempQueue tempTopic Permitted Collections 72 Amazon MQ Element Child Collection Element Child Element Developer Guide policyEntry deadLetterStrategy discarding topic filteredDestination destination individualDeadLett erStrategy sharedDeadLetterSt rategy queue tempQueue tempTopic topic dispatchPolicy priorityDispatchPo licy priorityNetworkDis patchPolicy roundRobinDispatch Policy simpleDispatchPolicy strictOrderDispatc hPolicy clientIdFilterDisp atchPolicy Permitted Collections 73 Amazon MQ Element Developer Guide Child Collection Element Child Element messageEvictionStr oldestMessageEvict ategy ionStrategy oldestMessageWithL owestPriorityEvict ionStrategy uniquePropertyMess ageEvictionStrategy messageGroupMapFac cachedMessageGroup tory MapFactory messageGroupHashBu cketFactory simpleMessageGroup MapFactory pendingDurableSubs fileDurableSubscri criberPolicy berCursor storeDurableSubscr iberCursor vmDurableCursor pendingMessageLimi constantPendingMes tStrategy sageLimitStrategy prefetchRatePendin gMessageLimitStrat egy pendingQueuePolicy fileQueueCursor storeCursor Permitted Collections 74 Amazon MQ Element Developer Guide Child Collection Element Child Element vmQueueCursor pendingSubscriberP fileCursor olicy vmCursor slowConsumerStrategy abortSlowAckConsum erStrategy abortSlowConsumerS trategy subscriptionRecove fixedCountSubscrip ryPolicy tionRecoveryPolicy fixedSizedSubscrip tionRecoveryPolicy lastImageSubscript ionRecoveryPolicy noSubscriptionReco veryPolicy queryBasedSubscrip tionRecoveryPolicy retainedMessageSub scriptionRecoveryP olicy timedSubscriptionR ecoveryPolicy policyMap defaultEntry policyEntry policyEntries policyEntry Permitted Collections 75 Amazon MQ Element Child Collection Element Child Element Developer Guide redeliveryPlugin redeliveryPolicyMap redeliveryPolicyMap redeliveryPolicyMap defaultEntry redeliveryPolicy redeliveryPolicyEn redeliveryPolicy tries retainedMessageSub wrapped scriptionRecoveryP olicy fixedCountSubscrip tionRecoveryPolicy fixedSizedSubscrip tionRecoveryPolicy lastImageSubscript ionRecoveryPolicy noSubscriptionReco veryPolicy queryBasedSubscrip tionRecoveryPolicy retainedMessageSub scriptionRecoveryP olicy timedSubscriptionR ecoveryPolicy sharedDeadLetterSt deadLetterQueue queue rategy tempQueue tempTopic topic Permitted Collections 76 Amazon MQ Element Child Collection Element Child Element Developer Guide virtualDestination virtualDestinations compositeQueue Interceptor compositeTopic virtualTopic Amazon MQ Child Element Attributes The following is a detailed explanation of child element attributes. For more information, see XML Conﬁguration in the Apache ActiveMQ documentation. Topics • authorizationEntry • networkConnector • kahaDB • systemUsage authorizationEntry authorizationEntry is a child of the authorizationEntries child collection element. Attributes admin\|read\|write The permissions granted to a group of users. For more information, see Always conﬁgure an authorization map. 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. Default: null Example Conﬁguration <authorizationPlugin> Child Element Attributes 77 Amazon MQ Developer Guide <map> <authorizationMap> <authorizationEntries> <authorizationEntry admin="admins,activemq- webconsole" read="admins,users,activemq-webconsole" write="admins,activemq-webconsole" queue=">"/> <authorizationEntry admin="admins,activemq- webconsole" read="admins,users,activemq-webconsole" write="admins,activemq-webconsole" topic=">"/> </authorizationEntries> </authorizationMap> </map> </authorizationPlugin> Note The activemq-webconsole group in ActiveMQ on Amazon MQ has admin permissions on all queues and topics. All users in this group will have admin access. networkConnector networkConnector is a child of the networkConnectors child collection element. Topics • Attributes • Example Conﬁgurations Attributes conduitSubscriptions Speciﬁes whether a network connection in a network of brokers treats multiple consumers subscribed to the same destination as one consumer. For example, if conduitSubscriptions is set to true and two consumers connect to broker B and consume from a destination, broker B combines the subscriptions into a single logical subscription over the network connection to broker A, so that only a single copy of a message is forwarded from broker A to broker B. Child Element Attributes 78 Amazon MQ Note Developer Guide Setting conduitSubscriptions to true can reduce redundant network traﬃc. However, using this attribute can have implications for the load-balancing of messages across consumers and might cause incorrect behavior in certain scenarios (for example, with JMS message selectors or with durable topics). Default: true duplex Speciﬁes whether the connection in the network of brokers is used to produce and consume messages. For example, if broker A creates a connection to broker B in non-duplex mode, messages can be forwarded only from broker A to broker B. However, if broker A creates a duplex connection to broker B, then broker B can forward messages to broker A without having to conﬁgure a <networkConnector>. Default: false name The name of the bridge in the network of brokers. Default: bridge uri The wire-level protocol endpoint for one of two brokers (or for multiple brokers) in a network of brokers. Default: null username The username common to the brokers in a network of brokers. Default: null Example Conﬁgurations Child Element Attributes 79 Amazon MQ Note Developer Guide When using a networkConnector to deﬁne a network of brokers, don't include the password for the user common to your brokers. A Network of Brokers with Two Brokers In this conﬁguration, two brokers are connected in a network of brokers. The name of the network connector is connector_1_to_2, the username common to the brokers is myCommonUser, the connection is duplex, and the OpenWire endpoint URI is preﬁxed by static:, indicating a one- to-one connection between the brokers. <networkConnectors> <networkConnector name="connector_1_to_2" userName="myCommonUser" duplex="true" uri="static:(ssl:// b-1234a5b6-78cd-901e-2fgh-3i45j6k178l9-1.mq.us-east-2.amazonaws.com:61617)"/> </networkConnectors> For more
amazon-mq-dg-021	amazon-mq-dg.pdf	21	Default: null Example Conﬁgurations Child Element Attributes 79 Amazon MQ Note Developer Guide When using a networkConnector to deﬁne a network of brokers, don't include the password for the user common to your brokers. A Network of Brokers with Two Brokers In this conﬁguration, two brokers are connected in a network of brokers. The name of the network connector is connector_1_to_2, the username common to the brokers is myCommonUser, the connection is duplex, and the OpenWire endpoint URI is preﬁxed by static:, indicating a one- to-one connection between the brokers. <networkConnectors> <networkConnector name="connector_1_to_2" userName="myCommonUser" duplex="true" uri="static:(ssl:// b-1234a5b6-78cd-901e-2fgh-3i45j6k178l9-1.mq.us-east-2.amazonaws.com:61617)"/> </networkConnectors> For more information, see Conﬁgure Network Connectors for Your Broker. A Network of Brokers with Multiple Brokers In this conﬁguration, multiple brokers are connected in a network of brokers. The name of the network connector is connector_1_to_2, the username common to the brokers is myCommonUser, the connection is duplex, and the comma-separated list of OpenWire endpoint URIs is preﬁxed by masterslave:, indicating a failover connection between the brokers. The failover from broker to broker isn't randomized and reconnection attempts continue indeﬁnitely. <networkConnectors> <networkConnector name="connector_1_to_2" userName="myCommonUser" duplex="true" uri="masterslave:(ssl:// b-1234a5b6-78cd-901e-2fgh-3i45j6k178l9-1.mq.us-east-2.amazonaws.com:61617, ssl:// b-9876l5k4-32ji-109h-8gfe-7d65c4b132a1-2.mq.us-west-2.amazonaws.com:61617)"/> </networkConnectors> Child Element Attributes 80 Amazon MQ Note Developer Guide We recommend using the masterslave: preﬁx for networks of brokers. The preﬁx is identical to the more explicit static:failover:()? randomize=false&maxReconnectAttempts=0 syntax. Note This XML conﬁguration does not allow spaces. kahaDB kahaDB is a child of the persistenceAdapter child collection element. Attributes concurrentStoreAndDispatchQueues Speciﬁes whether to use concurrent store and dispatch for queues. For more information, see Disable Concurrent Store and Dispatch for Queues with Slow Consumers. Default: true cleanupOnStop Supported in Apache ActiveMQ 15.16.x and above If deactivated, garbage collection and cleanup does not take place when the broker is stopped, which speeds up the shutdown process. The increased speed is useful in cases with large databases or scheduler databases. Default: true Child Element Attributes 81 Amazon MQ journalDiskSyncInterval Developer Guide Interval (ms) for when to perform a disk sync if journalDiskSyncStrategy=periodic. For more information, see the Apache ActiveMQ kahaDB documentation. Default: 1000 journalDiskSyncStrategy Supported in Apache ActiveMQ 15.14.x and above Conﬁgures the disk sync policy. For more information, see the Apache ActiveMQ kahaDB documentation. Default: always Note The ActiveMQ documentation states that the data loss is limited to the duration of journalDiskSyncInterval, which has a default of 1s. The data loss can be longer than the interval, but it is diﬃcult to be precise. Use caution. preallocationStrategy Conﬁgures how the broker will try to preallocate the journal ﬁles when a new journal ﬁle is needed. For more information, see the Apache ActiveMQ kahaDB documentation. Default: sparse_file Example Conﬁguration Example <broker xmlns="http://activemq.apache.org/schema/core"> <persistenceAdapter> Child Element Attributes 82 Amazon MQ Developer Guide <kahaDB preallocationStrategy="zeros" concurrentStoreAndDispatchQueues="false" journalDiskSyncInterval="10000" journalDiskSyncStrategy="periodic"/> </persistenceAdapter> </broker> systemUsage systemUsage is a child of the systemUsage child collection element. It controls the maximum amount of space the broker will use before slowing down producers. For more information, see Producer Flow Control in the Apache ActiveMQ documentation. Child Element memoryUsage memoryUsage is a child of the systemUsage child element. It manages memory usage. Use memoryUsage to keep track of how much of something is being used so that you can control working set usage productively. For more information, see the schema in the Apache ActiveMQ documentation. Child Element memoryUsage is a child of the memoryUsage child element. Attribute percentOfJvmHeap Integer between 0 (inclusive) and 70 (inclusive). Default: 70 Attributes sendFailIfNoSpace Sets whether a send() method should fail if there is no space free. The default value is false, which blocks the send() method until space becomes available. For more information, see the schema in the Apache Active MQ documentation. Child Element Attributes 83 Amazon MQ Default: false sendFailIfNoSpaceAfterTimeout Default: null Example Conﬁguration Example Developer Guide <broker xmlns="http://activemq.apache.org/schema/core"> <systemUsage> <systemUsage sendFailIfNoSpace="true" sendFailIfNoSpaceAfterTimeout="2000"> <memoryUsage> <memoryUsage percentOfJvmHeap="60" /> </memoryUsage>> </systemUsage> </systemUsage> </broker> </persistenceAdapter> Cross-Region data replication for Amazon MQ for ActiveMQ Amazon MQ for ActiveMQ oﬀers a Cross-Region data replication (CRDR) feature that allows for asynchronous message replication from the primary broker in a primary AWS Region to the replica broker in a replica Region. By issuing a failover request to the Amazon MQ API, the current replica broker is promoted to the primary broker role, and the current primary broker is demoted to the replica role. Primary and replica brokers for cross-Region data replication You can create primary and replica brokers for asynchronous data replication from the primary broker in a primary AWS Region to the replica broker in a replica Region. The primary Region consists of a redundant pair of active/standby brokers referred to as the primary broker. The secondary Region consists of a redundant pair of active/standby brokers referred to as the replica broker. The following diagram illustrates a replica broker in a secondary Region receiving asynchronous replicated data from the primary broker
amazon-mq-dg-022	amazon-mq-dg.pdf	22	and the current primary broker is demoted to the replica role. Primary and replica brokers for cross-Region data replication You can create primary and replica brokers for asynchronous data replication from the primary broker in a primary AWS Region to the replica broker in a replica Region. The primary Region consists of a redundant pair of active/standby brokers referred to as the primary broker. The secondary Region consists of a redundant pair of active/standby brokers referred to as the replica broker. The following diagram illustrates a replica broker in a secondary Region receiving asynchronous replicated data from the primary broker in the primary Region. Cross-Region data replication 84 Amazon MQ Developer Guide Primary and replica brokers act as a cross-Region data recovery solution. If the primary broker in the primary Region fails, you can promote the replica broker in the secondary Region to primary by initiating a switchover or failover. The former primary broker then becomes the replica broker, and the former replica broker is promoted to primary broker. For instructions on creating a primary and replica broker, see Creating an Amazon MQ cross-Region data replication broker. Note Only available for active/standby brokers. Not available for mirrored queues. Creating an Amazon MQ cross-Region data replication broker With Cross-Region data replication (CRDR), you can switch between Amazon MQ for ActiveMQ message brokers in two AWS Regions as needed. You can designate an existing broker as a primary broker and create a replica for this broker, or create a new primary and replica broker together. You can then promote the replica broker to the primary broker role using the Amazon MQ Promote API operation. For more information about primary and replica brokers, see Primary and replica brokers for cross-Region data replication. Creating a CRDR broker 85 Amazon MQ Developer Guide The following instructions describe how you can create and conﬁgure a replica broker using the Amazon MQ Management Console. Topics • Prerequisites • Step 1 (Optional): Create a new primary broker • Step 2: Create a replica of an existing broker Prerequisites To use the cross-Region data replication feature, you must review and comply with the following prerequisites: • Version: The cross-Region data replication feature is only available for Amazon MQ for ActiveMQ brokers on versions 5.17.6 and above. • Region: Cross-Region data replication is supported in the following regions: US East (Ohio), US East (N. Virginia), US West (Oregon), and US West (N. California). • Instance type: Cross-Region data replication is only available for broker instance sizes mq.m5.large and above. • Deployment type: Cross-Region data replication is only available for active/standby brokers with multi-availability zone deployment. • Broker status: You can only create a replica broker for a primary broker with the broker status Running. Step 1 (Optional): Create a new primary broker Create a new primary broker 1. Sign in to the Amazon MQ console. 2. On the Brokers page of the Amazon MQ console, choose Create brokers. 3. On the Select broker engine page, choose Apache ActiveMQ. 4. On the Select deployment and storage page, in the Deployment mode and storage type section, do the following: • For the Deployment mode, choose Active/standby broker. An Active/standby broker is comprised of two brokers in two diﬀerent Availability Zones conﬁgured in a redundant Creating a CRDR broker 86 Amazon MQ Developer Guide pair. These brokers communicate synchronously with your application and with Amazon EFS. For more information, see Deployment options for Amazon MQ for ActiveMQ brokers. 5. Choose Next. 6. On the Conﬁgure settings page, in the Details section, do the following: a. Enter the Broker name. Important Do not add personally identiﬁable information (PII) or other conﬁdential or sensitive information in broker names. Broker names are accessible to other AWS services, including CloudWatch Logs. Broker names are not intended to be used for private or sensitive data. b. Choose the Broker instance type (for example, mq.m5.large). For more information, see Broker instance types. 7. In the ActiveMQ Web Console access section, provide a Username and Password. The following restrictions apply to broker usernames and passwords: • Your username can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). • Your password must be at least 12 characters long, contain at least 4 unique characters and must not contain commas, colons, or equal signs (,:=). Important Do not add personally identiﬁable information (PII) or other conﬁdential or sensitive information in broker usernames. Broker usernames are accessible to other AWS services, including CloudWatch Logs. Broker usernames are not intended to be used for private or sensitive data. The green ﬂash bar at the top of the page conﬁrms that Amazon MQ is creating the replica broker in the recovery Region. You can also see the CRDR role and RPO status for your brokers. To turn oﬀ the CRDR
amazon-mq-dg-023	amazon-mq-dg.pdf	23	characters long, contain at least 4 unique characters and must not contain commas, colons, or equal signs (,:=). Important Do not add personally identiﬁable information (PII) or other conﬁdential or sensitive information in broker usernames. Broker usernames are accessible to other AWS services, including CloudWatch Logs. Broker usernames are not intended to be used for private or sensitive data. The green ﬂash bar at the top of the page conﬁrms that Amazon MQ is creating the replica broker in the recovery Region. You can also see the CRDR role and RPO status for your brokers. To turn oﬀ the CRDR Role and RPO Status columns, choose the gear icon in the top right corner of the Brokers table. Then, on the Preferences page, turn oﬀ CRDR Role or RPO Status. Creating a CRDR broker 87 Amazon MQ Developer Guide Step 2: Create a replica of an existing broker 1. On the Brokers page of the Amazon MQ console, choose Create replica broker. 2. On the Choose primary broker page, select an existing broker to use as a CRDR primary broker. Then, choose Next. 3. On the Conﬁgure replica broker page, use the drop down menu to choose the replica Region. 4. In the ActiveMQ console user for replica broker section, provide a Username and Password for the replica broker console user. The following restrictions apply to broker usernames and passwords: • Your username can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). • Your password must be at least 12 characters long, contain at least 4 unique characters and must not contain commas, colons, or equal signs (,:=). Important Do not add personally identiﬁable information (PII) or other conﬁdential or sensitive information in broker usernames. Broker usernames are accessible to other AWS services, including CloudWatch Logs. Broker usernames are not intended to be used for private or sensitive data. 5. In the Data replication user to bridge access between brokers section, provide a Username and Password for the user that will access both the primary and replica broker. The following restrictions apply to broker usernames and passwords: • Your username can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). • Your password must be at least 12 characters long, contain at least 4 unique characters and must not contain commas, colons, or equal signs (,:=). Important Do not add personally identiﬁable information (PII) or other conﬁdential or sensitive information in broker usernames. Broker usernames are accessible to other AWS Creating a CRDR broker 88 Amazon MQ Developer Guide services, including CloudWatch Logs. Broker usernames are not intended to be used for private or sensitive data. Conﬁgure any additional settings. Then, choose Next. 6. On the Review and create page, review the replica broker details. Then, choose Create replica broker. 7. Next, reboot the primary broker. This will also reboot the replica broker. For instructions on rebooting your broker, see Rebooting a Broker. For more information on conﬁguring additional settings for your ActiveMQ broker, see Getting started: Creating and connecting to an ActiveMQ broker Deleting an Amazon MQ cross-Region data replication broker To delete a primary or replica cross-Region data replication (CRDR) broker, you must ﬁrst unpair then reboot the brokers. The following instructions show how you can unpair and reboot the brokers using the AWS Management Console. 1. On the Brokers page, select the CRDR broker you want to unpair, then choose Edit. 2. On the broker Edit page in the Data replication section, choose Unpair brokers. 3. Enter "conﬁrm" in the pop-up window to conﬁrm your choice. Then choose Unpair brokers. 4. Next, reboot the unpaired primary broker. This will also reboot the replica broker. For instructions on rebooting your broker, see Rebooting a Broker. After the primary broker is rebooted, both brokers are unpaired and can be individually deleted. To delete your broker, see Deleting a broker. Initiating switchover or failover to promote an Amazon MQ replica broker to primary broker role You can initiate a switchover or failover when you want to promote the replica broker to the primary broker role. When you promote the replica broker, the primary broker is demoted to the replica broker role. A switchover prioritizes consistency over availability. Brokers are guaranteed to have identical state when this failover operation completes. With a switchover, there may be a period where neither Deleting a CRDR broker 89 Amazon MQ Developer Guide broker is available for client connections while inter-broker consistency is established. Both brokers will have the same state at the instant when the replica is promoted. Switchover success depends on the health of both regions and the inter-region network to succeed. A failover prioritizes availability over consistency. Brokers are not guaranteed to have identical states when this operation completes. With a failover, the
amazon-mq-dg-024	amazon-mq-dg.pdf	24	A switchover prioritizes consistency over availability. Brokers are guaranteed to have identical state when this failover operation completes. With a switchover, there may be a period where neither Deleting a CRDR broker 89 Amazon MQ Developer Guide broker is available for client connections while inter-broker consistency is established. Both brokers will have the same state at the instant when the replica is promoted. Switchover success depends on the health of both regions and the inter-region network to succeed. A failover prioritizes availability over consistency. Brokers are not guaranteed to have identical states when this operation completes. With a failover, the replica broker is guaranteed to become immediately available to serve client traﬃc, without waiting for any replication data to be synchronized, or for the primary to receive the shutdown signal. Failover depends on neither the health of the original primary region nor the inter-region network to succeed. The following diagram illustrates a switchover in which neither broker accepts client connections while the replication queue is being drained and broker states are synchronized. In this process, the client in the primary broker’s VPC is unable to produce further state changes while the operation is in progress, and the primary broker is being demoted to a replica. When the replication queue is drained and the two brokers achieve identical state, the client in the replica broker’s VPC is unable to connect to the replica broker until the failover operation completes, and the replica broker is promoted to primary. The following diagram illustrates the broker status after the switchover process is complete. The original replica broker has now been promoted to the primary broker role and is accepting client connections. The client can produce and consume data from the broker. Promoting a CRDR broker 90 Amazon MQ Developer Guide Promote the replica broker using the console To promote the replica broker using switchover or failover, follow these steps in the Amazon MQ console. Note You cannot initiate switchover or failover on a primary broker. 1. Switch to the region for your replica broker. From your Brokers table, select the existing replica broker you will promote to primary. 2. On the Broker details page, do the following: 1. 2. 3. Select Promote replica. In the pop up window, chose Switchover or Failover. Type “conﬁrm” in the text box to conﬁrm your choice. 4. Choose Conﬁrm. Promoting a CRDR broker 91 Amazon MQ Developer Guide After initiating failover, the broker status changes to Failover in progress. The blue progress bar at the top of the Brokers page becomes green when failover is complete. Note The conﬁguration is only replicated at the time the replicat broker is created. Any update afterwards is not replicated. Cross-Region data replication metrics in Amazon CloudWatch The Amazon MQ for ActiveMQ cross-Region data replication feature oﬀers metrics for maintaining the reliability, availability, and performance of your primary and replica brokers. During the replication process, a replica broker in a secondary Region receives asynchronously replicated data from the primary broker in the primary Region. If the primary broker in the primary Region fails, you can promote the replica broker in the secondary Region to primary by initiating a switchover or failover. For instructions on viewing metrics in Amazon CloudWatch, see Accessing CloudWatch metrics for Amazon MQ. CRDR timestamps The following timestamps describe how the metrics found in Amazon CloudWatch are calculated. There are ﬁve timestamps in the data replication process: • Time of current observation (TCO): The current instant in time. • Time of creation (TC): The instant in time an event was created on the replication queue by the primary broker. Available on both primary and replica brokers. • Time of delivery (TD): The instant in time an event was successfully delivered to the replica broker. Only available on replica brokers. • Time of processing (TP): The instant in time an event was successfully processed by the replica broker. Only available on replica brokers. • Time of acknowledgement (TA): The instant in time an event was successfully acknowledged by the primary broker. Only available on primary brokers. Metrics 92 Amazon MQ Developer Guide Estimate switchover/failover performance with CRDR CloudWatch metrics Amazon MQ enables metrics for your broker by default. You can view your broker metrics by accessing the Amazon CloudWatch console, or by using the CloudWatch API. The following metrics are useful for understanding the replication and switchover/failover performance of your CRDR brokers: Amazon MQ CloudWatch metric TotalReplicationLag ReplicationLag PrimaryWaitTime ReplicaWaitTime QueueSize Reason for CRDR use The estimated time between TA and TC of the last unacknowledged event on the primary broker. The estimated time between TP and TC of the last unacknowledged event on the replica broker. The estimated time between TCO and TC of the last processed event on the primary broker. The estimated time between TCO and TP
amazon-mq-dg-025	amazon-mq-dg.pdf	25	view your broker metrics by accessing the Amazon CloudWatch console, or by using the CloudWatch API. The following metrics are useful for understanding the replication and switchover/failover performance of your CRDR brokers: Amazon MQ CloudWatch metric TotalReplicationLag ReplicationLag PrimaryWaitTime ReplicaWaitTime QueueSize Reason for CRDR use The estimated time between TA and TC of the last unacknowledged event on the primary broker. The estimated time between TP and TC of the last unacknowledged event on the replica broker. The estimated time between TCO and TC of the last processed event on the primary broker. The estimated time between TCO and TP of the last processed event on the replica broker. The total number of unacknowledged events in the replication queue on the primary broker. Metrics 93 Amazon MQ Developer Guide TotalReplicationLag and ReplicationLag describe the delayed replication between the primary and replica brokers. The two metrics can also be used to estimate the time until the ongoing switchover or failover operation complete. PrimaryWaitTime and ReplicaWaitTime can be used to identify any ongoing issues with the replication process. If the value of the metric is constantly growing, this can indicate the replication process is degraded or paused. Slow replication may happen due issues like to network partitioning, broker starts, and long recovery. ActiveMQ tutorials The following tutorials show how you can create and connect to your ActiveMQ brokers. To use the ActiveMQ Java example code, you must install the Java Standard Edition Development Kit and make some changes to the code Topics • Creating and conﬁguring an Amazon MQ network of brokers • Connecting a Java application to your Amazon MQ broker • Integrating ActiveMQ brokers with LDAP • Step 3: (Optional) Connect to an AWS Lambda function • Creating an ActiveMQ broker user • Edit an ActiveMQ broker user • Delete an ActiveMQ broker user • Working examples of using Java Message Service (JMS) with ActiveMQ Creating and conﬁguring an Amazon MQ network of brokers A network of brokers is comprised of multiple simultaneously active single-instance brokers or active/standby brokers. In this tutorial, you learn how to create a two-broker network of brokers with a source and sink topology. For a conceptual overview and detailed conﬁguration information, see the following: • Amazon MQ network of brokers • Conﬁgure Your Network of Brokers Correctly ActiveMQ tutorials 94 Amazon MQ • networkConnector • networkConnectionStartAsync • Networks of Brokers in the ActiveMQ documentation Developer Guide You can use the Amazon MQ console to create an Amazon MQ network of brokers. Because you can start the creation of the two brokers in parallel, this process takes approximately 15 minutes. Topics • Prerequisites • Step 1: Allow Traﬃc between Brokers • Step 2: Conﬁgure Network Connectors for Your Broker • Next Steps Prerequisites To create a network of brokers, you must have the following: • Two or more simultaneously active brokers (named MyBroker1 and MyBroker2 in this tutorial). For more information about creating brokers, see Getting started: Creating and connecting to an ActiveMQ broker. • The two brokers must be in the same VPC or in peered VPCs. For more information about VPCs, see What is Amazon VPC? in the Amazon VPC User Guide and What is VPC Peering? in the Amazon VPC Peering Guide. Important If you don't have a default VPC, subnet(s), or security group, you must create them ﬁrst. For more information, see the following in the Amazon VPC User Guide: • Creating a Default VPC • Creating a Default Subnet • Creating a Security Group • Two users with identical sign-in credentials for both brokers. For more information about creating users, see Creating an ActiveMQ broker user. Creating and conﬁguring a network of brokers 95 Amazon MQ Note Developer Guide When integrating LDAP authentication with a network of brokers, make sure that the user exists both as an ActiveMQ brokers, as well as an LDAP user. The following example uses two single-instance brokers. However, you can create networks of brokers using active/standby brokers or a combination of broker deployment modes. Step 1: Allow Traﬃc between Brokers After you create your brokers, you must allow traﬃc between them. 1. On the Amazon MQ console, on the MyBroker2 page, in the Details section, under Security and network, choose the name of your security group or . The Security Groups page of the EC2 Dashboard is displayed. 2. From the security group list, choose your security group. 3. At the bottom of the page, choose Inbound, and then choose Edit. 4. In the Edit inbound rules dialog box, add a rule for the OpenWire endpoint. a. b. c. Choose Add Rule. For Type, select Custom TCP. For Port Range, type the OpenWire port (61617). d. Do one of the following: • If you want to restrict access to a particular IP address, for Source, leave
amazon-mq-dg-026	amazon-mq-dg.pdf	26	Security and network, choose the name of your security group or . The Security Groups page of the EC2 Dashboard is displayed. 2. From the security group list, choose your security group. 3. At the bottom of the page, choose Inbound, and then choose Edit. 4. In the Edit inbound rules dialog box, add a rule for the OpenWire endpoint. a. b. c. Choose Add Rule. For Type, select Custom TCP. For Port Range, type the OpenWire port (61617). d. Do one of the following: • If you want to restrict access to a particular IP address, for Source, leave Custom selected, and then enter the IP address of MyBroker1, followed by /32. (This converts the IP address to a valid CIDR record). For more information see Elastic Network Interfaces. Tip To retrieve the IP address of MyBroker1, on the Amazon MQ console, choose the name of the broker and navigate to the Details section. Creating and conﬁguring a network of brokers 96 Amazon MQ Developer Guide • If all the brokers are private and belong to the same VPC, for Source, leave Custom selected and then type the ID of the security group you are editing. Note For public brokers, you must restrict access using IP addresses. e. Choose Save. Your broker can now accept inbound connections. Step 2: Conﬁgure Network Connectors for Your Broker After you allow traﬃc between your brokers, you must conﬁgure network connectors for one of them. 1. Edit the conﬁguration revision for broker MyBroker1. a. On the MyBroker1 page, choose Edit. b. On the Edit MyBroker1 page, in the Conﬁguration section, choose View. The broker engine type and version that the conﬁguration uses (for example, Apache ActiveMQ 5.15.0) are displayed. c. On the Conﬁguration details tab, the conﬁguration revision number, description, and broker conﬁguration in XML format are displayed. d. Choose Edit conﬁguration. e. At the bottom of the conﬁguration ﬁle, uncomment the <networkConnectors> section and include the following information: • The name for the network connector. • The ActiveMQ Web Console username that is common to both brokers. • Enable duplex connections. • Do one of the following: • If you are connecting the broker to a single-instance broker, use the static: preﬁx and the OpenWire endpoint uri for MyBroker2. For example: Creating and conﬁguring a network of brokers <networkConnectors> 97 Amazon MQ Developer Guide <networkConnector name="connector_1_to_2" userName="myCommonUser" duplex="true" uri="static:(ssl://b-1234a5b6-78cd-901e-2fgh-3i45j6k178l9-1.mq.us- east-2.amazonaws.com:61617)"/> </networkConnectors> • If you are connecting the broker to an active/standby broker, use the static +failover transport and the OpenWire endpoint uri for both brokers with the following query parameters ?randomize=false&maxReconnectAttempts=0. For example: <networkConnectors> <networkConnector name="connector_1_to_2" userName="myCommonUser" duplex="true" uri="static:(failover:(ssl:// b-1234a5b6-78cd-901e-2fgh-3i45j6k178l9-1.mq.us-east-2.amazonaws.com:61617, ssl://b-9876l5k4-32ji-109h-8gfe-7d65c4b132a1-2.mq.us- west-2.amazonaws.com:61617)?randomize=false&maxReconnectAttempts=0)"/> </networkConnectors> Note Don't include the sign-in credentials for the ActiveMQ user. f. g. Choose Save. In the Save revision dialog box, type Add network of brokers connector for MyBroker2. h. Choose Save to save the new revision of the conﬁguration. 2. Edit MyBroker1 to set the latest conﬁguration revision to apply immediately. a. On the MyBroker1 page, choose Edit. b. On the Edit MyBroker1 page, in the Conﬁguration section, choose Schedule Modiﬁcations. c. In the Schedule broker modiﬁcations section, choose to apply modiﬁcations Immediately. d. Choose Apply. MyBroker1 is rebooted and your conﬁguration revision is applied. Creating and conﬁguring a network of brokers 98 Amazon MQ Developer Guide The network of brokers is created. Next Steps After you conﬁgure your network of brokers, you can test it by producing and consuming messages. Important Make sure that you enable inbound connections from your local machine for broker MyBroker1 on port 8162 (for the ActiveMQ Web Console) and port 61617 (for the OpenWire endpoint). You might also need to adjust your security group(s) settings to allow the producer and consumer to connect to the network of brokers. 1. On the Amazon MQ console, navigate to the Connections section and note the ActiveMQ Web Console endpoint for broker MyBroker1. 2. Navigate to the ActiveMQ Web Console for broker MyBroker1. 3. To verify that the network bridge is connected, choose Network. In the Network Bridges section, the name and the address of MyBroker2 are listed in the Remote Broker and Remote Address columns. 4. From any machine that has access to broker MyBroker2, create a consumer. For example: activemq consumer --brokerUrl "ssl:// b-1234a5b6-78cd-901e-2fgh-3i45j6k178l9-1.mq.us-east-2.amazonaws.com:61617" \ --user commonUser \ --password myPassword456 \ --destination queue://MyQueue The consumer connects to the OpenWire endpoint of MyBroker2 and begins to consume messages from queue MyQueue. 5. From any machine that has access to broker MyBroker1, create a producer and send some messages. For example: Creating and conﬁguring a network of brokers 99 Amazon MQ Developer Guide activemq producer --brokerUrl "ssl:// b-9876l5k4-32ji-109h-8gfe-7d65c4b132a1-1.mq.us-east-2.amazonaws.com:61617" \ --user commonUser \ --password myPassword456 \ --destination queue://MyQueue \ --persistent true \ --messageSize 1000 \ --messageCount 10000 The producer connects to the OpenWire endpoint of MyBroker1 and begins
amazon-mq-dg-027	amazon-mq-dg.pdf	27	a consumer. For example: activemq consumer --brokerUrl "ssl:// b-1234a5b6-78cd-901e-2fgh-3i45j6k178l9-1.mq.us-east-2.amazonaws.com:61617" \ --user commonUser \ --password myPassword456 \ --destination queue://MyQueue The consumer connects to the OpenWire endpoint of MyBroker2 and begins to consume messages from queue MyQueue. 5. From any machine that has access to broker MyBroker1, create a producer and send some messages. For example: Creating and conﬁguring a network of brokers 99 Amazon MQ Developer Guide activemq producer --brokerUrl "ssl:// b-9876l5k4-32ji-109h-8gfe-7d65c4b132a1-1.mq.us-east-2.amazonaws.com:61617" \ --user commonUser \ --password myPassword456 \ --destination queue://MyQueue \ --persistent true \ --messageSize 1000 \ --messageCount 10000 The producer connects to the OpenWire endpoint of MyBroker1 and begins to produce persistent messages to queue MyQueue. Connecting a Java application to your Amazon MQ broker After you create an Amazon MQ ActiveMQ broker, you can connect your application to it. The following examples show how you can use the Java Message Service (JMS) to create a connection to the broker, create a queue, and send a message. For a complete, working Java example, see Working Java Example. You can connect to ActiveMQ brokers using various ActiveMQ clients. We recommend using the ActiveMQ Client. Topics • Prerequisites • To Create a Message Producer and Send a Message • To Create a Message Consumer and Receive the Message Prerequisites Enable VPC Attributes 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 in the Amazon VPC User Guide. Enable Inbound Connections Next, enable inbound connections for your application. Connecting a Java application to your broker 100 Amazon MQ Developer Guide 1. 2. Sign in to the Amazon MQ console. From the broker list, choose the name of your broker (for example, MyBroker). 3. On the MyBroker page, in the Connections section, note the addresses and ports of the broker's web console URL and wire-level protocols. 4. In the Details section, under Security and network, choose the name of your security group or . The Security Groups page of the EC2 Dashboard is displayed. 5. From the security group list, choose your security group. 6. At the bottom of the page, choose Inbound, and then choose Edit. 7. In the Edit inbound rules dialog box, add a rule for every URL or endpoint that you want to be publicly accessible (the following example shows how to do this for a broker web console). a. b. c. d. Choose Add Rule. For Type, select Custom TCP. For Port Range, type the web console port (8162). For Source, leave Custom selected and then type the IP address of the system that you want to be able to access the web console (for example, 192.0.2.1). e. Choose Save. Your broker can now accept inbound connections. Add Java Dependencies Add the activemq-client.jar and activemq-pool.jar packages to your Java class path. The following example shows these dependencies in a Maven project pom.xml ﬁle. <dependencies> <dependency> <groupId>org.apache.activemq</groupId> <artifactId>activemq-client</artifactId> <version>5.15.16</version> </dependency> <dependency> <groupId>org.apache.activemq</groupId> <artifactId>activemq-pool</artifactId> <version>5.15.16</version> Connecting a Java application to your broker 101 Amazon MQ </dependency> </dependencies> Developer Guide For more information about activemq-client.jar, see Initial Conﬁguration in the Apache ActiveMQ documentation. 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 Use the following instruction to create a message producer and recieve 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 For an active/standby broker, 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 suﬃxes denote a redundant pair. For more information, see Deployment options for Amazon MQ for ActiveMQ brokers). For wire-level protocol endpoints, you can allow your application to connect to either endpoint by using the Failover Transport. // Create a connection factory. final ActiveMQConnectionFactory connectionFactory = new ActiveMQConnectionFactory(wireLevelEndpoint); // Pass the sign-in credentials. connectionFactory.setUserName(activeMqUsername); connectionFactory.setPassword(activeMqPassword); Connecting a Java application to your broker 102 Amazon MQ Developer Guide // Create a pooled connection factory. final PooledConnectionFactory pooledConnectionFactory = new PooledConnectionFactory(); pooledConnectionFactory.setConnectionFactory(connectionFactory); pooledConnectionFactory.setMaxConnections(10); // Establish a connection for the producer. final Connection producerConnection = pooledConnectionFactory.createConnection(); producerConnection.start(); // Close all connections in the pool. pooledConnectionFactory.clear(); Note Message producers should always use the PooledConnectionFactory class. For more information, see Always Use Connection Pooling. 2. Create a session, a queue named MyQueue, and a message producer. // Create a session. final Session producerSession = producerConnection.createSession(false, Session.AUTO_ACKNOWLEDGE); // Create a queue named "MyQueue". final Destination producerDestination
amazon-mq-dg-028	amazon-mq-dg.pdf	28	the sign-in credentials. connectionFactory.setUserName(activeMqUsername); connectionFactory.setPassword(activeMqPassword); Connecting a Java application to your broker 102 Amazon MQ Developer Guide // Create a pooled connection factory. final PooledConnectionFactory pooledConnectionFactory = new PooledConnectionFactory(); pooledConnectionFactory.setConnectionFactory(connectionFactory); pooledConnectionFactory.setMaxConnections(10); // Establish a connection for the producer. final Connection producerConnection = pooledConnectionFactory.createConnection(); producerConnection.start(); // Close all connections in the pool. pooledConnectionFactory.clear(); Note Message producers should always use the PooledConnectionFactory class. For more information, see Always Use Connection Pooling. 2. Create a session, a queue named MyQueue, and a message producer. // Create a session. final Session producerSession = producerConnection.createSession(false, Session.AUTO_ACKNOWLEDGE); // Create a queue named "MyQueue". final Destination producerDestination = producerSession.createQueue("MyQueue"); // Create a producer from the session to the queue. final MessageProducer producer = producerSession.createProducer(producerDestination); producer.setDeliveryMode(DeliveryMode.NON_PERSISTENT); 3. Create the message string "Hello from Amazon MQ!" and then send the message. // Create a message. final String text = "Hello from Amazon MQ!"; TextMessage producerMessage = producerSession.createTextMessage(text); // Send the message. producer.send(producerMessage); System.out.println("Message sent."); Connecting a Java application to your broker 103 Amazon MQ 4. Clean up the producer. producer.close(); producerSession.close(); producerConnection.close(); Developer Guide To Create a Message Consumer and Receive the Message Use the following instruction to create a message producer and recieve a 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. // Create a connection factory. final ActiveMQConnectionFactory connectionFactory = new ActiveMQConnectionFactory(wireLevelEndpoint); // Pass the sign-in credentials. connectionFactory.setUserName(activeMqUsername); connectionFactory.setPassword(activeMqPassword); // Establish a connection for the consumer. final Connection consumerConnection = connectionFactory.createConnection(); consumerConnection.start(); Note Message consumers should never use the PooledConnectionFactory class. For more information, see Always Use Connection Pooling. 2. Create a session, a queue named MyQueue, and a message consumer. // Create a session. final Session consumerSession = consumerConnection.createSession(false, Session.AUTO_ACKNOWLEDGE); // Create a queue named "MyQueue". final Destination consumerDestination = consumerSession.createQueue("MyQueue"); // Create a message consumer from the session to the queue. Connecting a Java application to your broker 104 Amazon MQ Developer Guide final MessageConsumer consumer = consumerSession.createConsumer(consumerDestination); 3. Begin to wait for messages and receive the message when it arrives. // Begin to wait for messages. final Message consumerMessage = consumer.receive(1000); // Receive the message when it arrives. final TextMessage consumerTextMessage = (TextMessage) consumerMessage; System.out.println("Message received: " + consumerTextMessage.getText()); Note Unlike AWS messaging services (such as Amazon SQS), the consumer is constantly connected to the broker. 4. Close the consumer, session, and connection. consumer.close(); consumerSession.close(); consumerConnection.close(); Integrating ActiveMQ brokers with LDAP Important LDAP integration is not supported for RabbitMQ brokers. Amazon MQ does not support server certiﬁcate issued by a private CA. You can access your ActiveMQ brokers using the following protocols with TLS enabled: • AMQP • MQTT • MQTT over WebSocket • OpenWire • STOMP Integrating ActiveMQ brokers with LDAP 105 Amazon MQ • STOMP over WebSocket Developer Guide Amazon MQ oﬀers a choice between native ActiveMQ authentication and LDAP authentication and authorization to manage user permissions. For information about restrictions related to ActiveMQ usernames and passwords, see Users. To authorize ActiveMQ users and groups to works with queues and topics, you must edit your broker's conﬁguration. Amazon MQ uses ActiveMQ's Simple Authentication Plugin to restrict reading and writing to destinations. For more information and examples, see Always conﬁgure an authorization map and authorizationEntry. Note Currently, Amazon MQ doesn't support Client Certiﬁcate Authentication. Topics • Integrate LDAP with ActiveMQ • Prerequisites • Getting Started with LDAP • How LDAP integration works Integrate LDAP with ActiveMQ You can authenticate Amazon MQ users through the credentials stored in your lightweight directory access protocol (LDAP) server. You can also add, delete, and modify Amazon MQ users and assign permissions to topics and queues through it. Management operations like creating, updating and deleting brokers still require IAM credentials and are not integrated with LDAP. Customers who want to simplify and centralize their Amazon MQ broker authentication and authorization using an LDAP server can use this feature. Keeping all user credentials in the LDAP server saves time and eﬀort by providing a central location for storing and managing these credentials. Amazon MQ provides LDAP support using the Apache ActiveMQ JAAS plugin. Any LDAP server, such as Microsoft Active Directory or OpenLDAP that is supported by the plugin is also supported Integrating ActiveMQ brokers with LDAP 106 Amazon MQ Developer Guide by Amazon MQ. For more information about the plugin, see the Security section of the Active MQ documentation. In addition to users, you can specify access to topics and queues for a speciﬁc group or a user through your LDAP server. You do this by creating entries that represent topics and queues in your LDAP server and then assigning permissions to a speciﬁc LDAP user or a group. You can then conﬁgure broker to retrieve authorization data from the LDAP server. Important When using LDAP, authentication is not case-sensitive, but authorization
amazon-mq-dg-029	amazon-mq-dg.pdf	29	ActiveMQ brokers with LDAP 106 Amazon MQ Developer Guide by Amazon MQ. For more information about the plugin, see the Security section of the Active MQ documentation. In addition to users, you can specify access to topics and queues for a speciﬁc group or a user through your LDAP server. You do this by creating entries that represent topics and queues in your LDAP server and then assigning permissions to a speciﬁc LDAP user or a group. You can then conﬁgure broker to retrieve authorization data from the LDAP server. Important When using LDAP, authentication is not case-sensitive, but authorization is case-sensitive for your username. Prerequisites Before you add LDAP support to a new or existing Amazon MQ broker, you must set up a service account. This service account is required to initiate a connection to an LDAP server and must have the correct permissions to make this connection. This service account will set up LDAP authentication for your broker. Any successive client connections will be authenticated through the same connection. The service account is an account in your LDAP server, which has access to initiate a connection. It is a standard LDAP requirement and you have to provide the service account credentials only once. After the connection is setup, all the future client connections are authenticated through your LDAP server. Your service account credentials are stored securely in an encrypted form, which is accessible only to Amazon MQ. To integrate with ActiveMQ, a speciﬁc Directory Information Tree (DIT) is required on the LDAP server. For an example ldif ﬁle that clearly shows this structure, see Import the following LDIF ﬁle into the LDAP server in the Security section of the ActiveMQ documentation. Getting Started with LDAP To get started, navigate to the Amazon MQ console and choose LDAP authentication and authorization when you create a new Amazon MQ or edit an existing broker instance. Provide the following information about the service account: Integrating ActiveMQ brokers with LDAP 107 Amazon MQ Developer Guide • Fully qualiﬁed domain name The location of the LDAP server to which authentication and authorization requests are to be issued. Note The fully qualiﬁed domain name of the LDAP server you supply must not include the protocol or port number. Amazon MQ will prepend the fully qualiﬁed domain name with the protocol ldaps, and will append the port number 636. For example, if you provide the following fully qualiﬁed domain: example.com, Amazon MQ will access your LDAP server using the following URL: ldaps://example.com:636. For the broker host to be able to successfully communicate with the LDAP server, the fully qualiﬁed domain name must be publicly resolvable. To keep the LDAP server private and secure, restrict inbound traﬃc in the server's inbound rules to only allow traﬃc originated from within the broker's VPC. • Service account username The distinguished name of the user that will be used to perform the initial bind to the LDAP server. • Service account password The password of the user performing the initial bind. The following image highlights where to supply these details. Integrating ActiveMQ brokers with LDAP 108 Amazon MQ Developer Guide In the LDAP login conﬁguration section, provide the following required information: • User Base The distinguished name of the node in the directory information tree (DIT) that will be searched for users. • User Search Matching The LDAP search ﬁlter that will be used to ﬁnd users within the userBase. The client's username will be substituted into the {0} placeholder in the search ﬁlter. For more information, see Authentication and Authorization. Integrating ActiveMQ brokers with LDAP 109 Amazon MQ Developer Guide • Role Base The distinguished name of the node in the DIT that will be searched for roles. Roles can be conﬁgured as explicit LDAP group entries in your directory. A typical role entry may consist of one attribute for the name of the role, such as common name (CN), and another attribute, such as member, with values representing the distinguished names or usernames of the users belonging to the role group. For example, given the organizational unit, group, you can provide the following distinguished name: ou=group,dc=example,dc=com. • Role Search Matching The LDAP search ﬁlter that will be used to ﬁnd roles within the roleBase. The distinguished name of the user matched by userSearchMatching will be substituted into the {0} placeholder in the search ﬁlter. The client's username will be substituted in place of the {1} placeholder. For example, if role entries in your directory include an attribute named member, containing the usernames for all users in that role, you can provide the following search ﬁlter: (member:=uid={1}). The following image highlights where to specify these details. Integrating ActiveMQ brokers with LDAP 110 Amazon MQ Developer Guide In the Optional settings section, you can provide the following optional information:
amazon-mq-dg-030	amazon-mq-dg.pdf	30	used to ﬁnd roles within the roleBase. The distinguished name of the user matched by userSearchMatching will be substituted into the {0} placeholder in the search ﬁlter. The client's username will be substituted in place of the {1} placeholder. For example, if role entries in your directory include an attribute named member, containing the usernames for all users in that role, you can provide the following search ﬁlter: (member:=uid={1}). The following image highlights where to specify these details. Integrating ActiveMQ brokers with LDAP 110 Amazon MQ Developer Guide In the Optional settings section, you can provide the following optional information: • User Role Name The name of the LDAP attribute in the user's directory entry for the user's group membership. In some cases, user roles may be identiﬁed by the value of an attribute in the user's directory entry. The userRoleName option allows you to provide the name of this attribute. For example, let's consider the following user entry: Integrating ActiveMQ brokers with LDAP 111 Amazon MQ Developer Guide dn: uid=jdoe,ou=user,dc=example,dc=com objectClass: user uid: jdoe sn: jane cn: Jane Doe mail: j.doe@somecompany.com memberOf: role1 userPassword: password To provide the correct userRoleName for the example above, you would specify the memberOf attribute. If authentication is successful, the user is assigned the role role1. • Role Name The group name attribute in a role entry whose value is the name of that role. For example, you can specify cn for a group entry's common name. If authentication succeeds, the user is assigned the the value of the cn attribute for each role entry that they are a member of. • User Search Subtree Deﬁnes the scope for the LDAP user search query. If true, the scope is set to search the entire subtree under the node deﬁned by userBase. • Role Search Subtree Deﬁnes the scope for the LDAP role search query. If true, the scope is set to search the entire subtree under the node deﬁned by roleBase. The following image highlights where to specify these optional settings. Integrating ActiveMQ brokers with LDAP 112 Amazon MQ Developer Guide How LDAP integration works You can think of integration in two main categories: the structure for authentication, and the structure for authorization. Authentication For authentication, client credentials must be valid. These credentials are validated against users in the user base in the LDAP server. The user base supplied to the ActiveMQ broker must point to the node in the DIT where users are stored in the LDAP server. For example, if you are using AWS Managed Microsoft AD, and you have the domain components corp, example, and com, and within those you have organizational units corp and Users, you would use the following as your user base: OU=Users,OU=corp,DC=corp,DC=example,DC=com The ActiveMQ broker would search at this location in the DIT for users in order to authenticate client connection requests to the broker. Integrating ActiveMQ brokers with LDAP 113 Amazon MQ Developer Guide Because the ActiveMQ source code hardcodes the attribute name for users to uid, you must make sure that each user has this attribute set. For simplicity, you can use the user’s connection username. For more information, see the activemq source code and Conﬁguring ID mappings in Active Directory Users and Computers for Windows Server 2016 (and subsequent) versions. To enable ActiveMQ console access for speciﬁc users, make sure they belong to the amazonmq- console-admins group. Authorization For authorization, permissions search bases are speciﬁed in the broker conﬁguration. Authorization is done on a per-destination basis (or wildcard, destination set) via the cachedLdapAuthorizationMap element, found in the broker’s activemq.xml conﬁguration ﬁle. For more information, see Cached LDAP Authorization Module. Note To be able to use the cachedLDAPAuthorizationMap element in your broker's activemq.xml conﬁguration ﬁle, you must choose the LDAP Authentication and Integrating ActiveMQ brokers with LDAP 114 Amazon MQ Developer Guide Authorization option when creating a conﬁguration via the AWS Management Console, or set the authenticationStrategy property to LDAP when creating a new conﬁguration using the Amazon MQ API. You must provide the following three attributes as part of the cachedLDAPAuthorizationMap element: • queueSearchBase • topicSearchBase • tempSearchBase Important To prevent sensitive information from being directly placed in the broker's conﬁguration ﬁle, Amazon MQ blocks the following attributes from being used in cachedLdapAuthorizationMap: • connectionURL • connectionUsername • connectionPassword When you create a broker, Amazon MQ substitutes the values you provide via the AWS Management Console, or in the ldapServerMetadata property of your API request, for the above attributes. The following demonstrates a working example of the cachedLdapAuthorizationMap. <authorizationPlugin> <map> <cachedLDAPAuthorizationMap queueSearchBase="ou=Queue,ou=Destination,ou=corp,dc=corp,dc=example,dc=com" topicSearchBase="ou=Topic,ou=Destination,ou=corp,dc=corp,dc=example,dc=com" tempSearchBase="ou=Temp,ou=Destination,ou=corp,dc=corp,dc=example,dc=com" refreshInterval="300000" legacyGroupMapping="false" Integrating ActiveMQ brokers with LDAP 115 Amazon MQ /> </map> </authorizationPlugin> Developer Guide These values identify the locations within the DIT where permissions for each type of destination are speciﬁed. So for the above example with AWS Managed
amazon-mq-dg-031	amazon-mq-dg.pdf	31	blocks the following attributes from being used in cachedLdapAuthorizationMap: • connectionURL • connectionUsername • connectionPassword When you create a broker, Amazon MQ substitutes the values you provide via the AWS Management Console, or in the ldapServerMetadata property of your API request, for the above attributes. The following demonstrates a working example of the cachedLdapAuthorizationMap. <authorizationPlugin> <map> <cachedLDAPAuthorizationMap queueSearchBase="ou=Queue,ou=Destination,ou=corp,dc=corp,dc=example,dc=com" topicSearchBase="ou=Topic,ou=Destination,ou=corp,dc=corp,dc=example,dc=com" tempSearchBase="ou=Temp,ou=Destination,ou=corp,dc=corp,dc=example,dc=com" refreshInterval="300000" legacyGroupMapping="false" Integrating ActiveMQ brokers with LDAP 115 Amazon MQ /> </map> </authorizationPlugin> Developer Guide These values identify the locations within the DIT where permissions for each type of destination are speciﬁed. So for the above example with AWS Managed Microsoft AD, using the same domain components of corp, example, and com, you would specify an organizational unit named destination to contain all your destination types. Within that OU, you would create one for queues, one for topics, and one for temp destinations. This would mean that your queue search base, which provides authorization information for destinations of type queue, would have the following location in your DIT: OU=Queue,OU=Destination,OU=corp,DC=corp,DC=example,DC=com Integrating ActiveMQ brokers with LDAP 116 Amazon MQ Developer Guide Similarly, permissions rules for topics and temp destinations would be located at the same level in the DIT: OU=Topic,OU=Destination,OU=corp,DC=corp,DC=example,DC=com OU=Temp,OU=Destination,OU=corp,DC=corp,DC=example,DC=com Within the OU for each type of destination (queue, topic, temp), either a wildcard or speciﬁc destination name can be provided. For example, to provide an authorization rule for all queues that start with the preﬁx DEMO.EVENTS.$., you could create the following OU: OU=DEMO.EVENTS.$,OU=Queue,OU=Destination,OU=corp,DC=corp,DC=example,DC=com Integrating ActiveMQ brokers with LDAP 117 Amazon MQ Note The DEMO.EVENTS.$ OU is within the Queue OU. Developer Guide For more info on wildcards in ActiveMQ, see Wildcards To provide authorization rules for speciﬁc queues, such as DEMO.MYQUEUE, specify something like the following: OU=DEMO.MYQUEUE,OU=Queue,OU=Destination,OU=corp,DC=corp,DC=example,DC=com Integrating ActiveMQ brokers with LDAP 118 Amazon MQ Security Groups Developer Guide Within each OU that represents a destination or a wildcard, you must create three security groups. As with all permissions in ActiveMQ, these are read/write/admin permissions. For more information on what each of these permissions allows a user to do, see Security in the ActiveMQ documentation. You must name these security groups read, write, and admin. Within each of these security groups, you can add users or groups, who will then have permission to perform the associated actions. You’ll need these security groups for each wildcard destination set or individual destination. Integrating ActiveMQ brokers with LDAP 119 Amazon MQ Note Developer Guide When you create the admin group, a conﬂict will arise with the group name. This conﬂict happens because the legacy pre-Windows 2000 rules do not allow groups to share the same name, even if the groups are in diﬀerent locations of the DIT. The value in the pre- Windows 2000 text box has no impact on the setup, but it must be globally unique. To avoid this conﬂict, you can append a uuid suﬃx to each admin group. Adding a user to the admin security group for a particular destination will enable the user to create and delete that topic. Adding them to the read security group will enable them to read from the destination, and adding them to the write group will enable them to write to the destination. In addition to adding individual users to security group permissions, you can also add entire groups. However, because ActiveMQ again hardcodes attribute names for groups, you must ensure the group you want to add has the object class groupOfNames, as shown in the activemq source code. Integrating ActiveMQ brokers with LDAP 120 Amazon MQ Developer Guide To do this, follow the same process as with the uid for users. See Conﬁguring ID mappings in Active Directory Users and Computers for Windows Server 2016 (and subsequent) versions. Step 3: (Optional) Connect to an AWS Lambda function AWS Lambda can connect to and consume messages from your Amazon MQ broker. When you connect a broker to Lambda, you create an event source mapping that reads messages from a queue and invokes the function synchronously. The event source mapping you create reads messages from your broker in batches and converts them into a Lambda payload in the form of a JSON object. To connect your broker to a Lambda function 1. Add the following IAM role permissions to your Lambda function execution role. • mq:DescribeBroker • ec2:CreateNetworkInterface • ec2:DeleteNetworkInterface • ec2:DescribeNetworkInterfaces • ec2:DescribeSecurityGroups • ec2:DescribeSubnets • ec2:DescribeVpcs • logs:CreateLogGroup • logs:CreateLogStream • logs:PutLogEvents • secretsmanager:GetSecretValue Note Without the necessary IAM permissions, your function will not be able to successfully read records from Amazon MQ resources. 2. (Optional) If you have created a broker without public accessibility, you must do one of the following to allow Lambda to connect to your broker: Step 3: (Optional) Connect to an AWS Lambda function 121 Amazon MQ Developer Guide • Conﬁgure one NAT gateway per public
amazon-mq-dg-032	amazon-mq-dg.pdf	32	the following IAM role permissions to your Lambda function execution role. • mq:DescribeBroker • ec2:CreateNetworkInterface • ec2:DeleteNetworkInterface • ec2:DescribeNetworkInterfaces • ec2:DescribeSecurityGroups • ec2:DescribeSubnets • ec2:DescribeVpcs • logs:CreateLogGroup • logs:CreateLogStream • logs:PutLogEvents • secretsmanager:GetSecretValue Note Without the necessary IAM permissions, your function will not be able to successfully read records from Amazon MQ resources. 2. (Optional) If you have created a broker without public accessibility, you must do one of the following to allow Lambda to connect to your broker: Step 3: (Optional) Connect to an AWS Lambda function 121 Amazon MQ Developer Guide • Conﬁgure one NAT gateway per public subnet. For more information, see Internet and service access for VPC-connected functions in the AWS Lambda Developer Guide. • Create a connection between your Amazon Virtual Private Cloud (Amazon VPC) and Lambda using a VPC endpoint. Your Amazon VPC must also connect to AWS Security Token Service (AWS STS) and Secrets Manager endpoints. For more information, see Conﬁguring interface VPC endpoints for Lambda in the AWS Lambda Developer Guide. 3. Conﬁgure your broker as an event source for a Lambda function using the AWS Management Console. You can also use the create-event-source-mapping AWS Command Line Interface command. 4. Write some code for your Lambda function to process the messages consumed from your broker. The Lambda payload that retrieved by your event source mapping depends on the engine type of the broker. The following is an example of a Lambda payload for an Amazon MQ for ActiveMQ queue. Note In the example, testQueue is the name of the queue. { "eventSource": "aws:amq", "eventSourceArn": "arn:aws:mq:us- west-2:112556298976:broker:test:b-9bcfa592-423a-4942-879d-eb284b418fc8", "messages": { [ { "messageID": "ID:b-9bcfa592-423a-4942-879d-eb284b418fc8-1.mq.us- west-2.amazonaws.com-37557-1234520418293-4:1:1:1:1", "messageType": "jms/text-message", "data": "QUJDOkFBQUE=", "connectionId": "myJMSCoID", "redelivered": false, "destination": { "physicalname": "testQueue" }, "timestamp": 1598827811958, "brokerInTime": 1598827811958, "brokerOutTime": 1598827811959 Step 3: (Optional) Connect to an AWS Lambda function 122 Amazon MQ }, Developer Guide { "messageID": "ID:b-9bcfa592-423a-4942-879d-eb284b418fc8-1.mq.us- west-2.amazonaws.com-37557-1234520418293-4:1:1:1:1", "messageType":"jms/bytes-message", "data": "3DTOOW7crj51prgVLQaGQ82S48k=", "connectionId": "myJMSCoID1", "persistent": false, "destination": { "physicalname": "testQueue" }, "timestamp": 1598827811958, "brokerInTime": 1598827811958, "brokerOutTime": 1598827811959 } ] } } For more information about connecting Amazon MQ to Lambda, the options Lambda supports for an Amazon MQ event source, and event source mapping errors, see Using Lambda with Amazon MQ in the AWS Lambda Developer Guide. Creating an ActiveMQ broker user An ActiveMQ user is a person or an application that can access the queues and topics of an ActiveMQ broker. You can conﬁgure users to have speciﬁc permissions. For example, you can allow some users to access the ActiveMQ Web Console. A group is a semantic label. You can assign a group to a user and conﬁgure permissions for groups to send to, receive from, and administer speciﬁc queues and topics. Note You can't conﬁgure 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. Creating an ActiveMQ broker user 123 Amazon MQ Note Developer Guide The activemq-webconsole group in ActiveMQ on Amazon MQ has admin permissions on all queues and topics. All users in this group will have admin access. The following examples show how you can create, edit, and delete Amazon MQ broker users using the AWS Management Console. Create a new ActiveMQ broker user 1. 2. Sign in to the Amazon MQ console. From the broker list, choose the name of your broker (for example, MyBroker) and then choose View details. On the MyBroker page, in the Users section, all the users for this broker are listed. 3. Choose Create user. 4. 5. 6. In the Create user dialog box, type a Username and Password. (Optional) Type the names of groups to which the user belongs, separated by commas (for example: Devs, Admins). (Optional) To enable the user to access the ActiveMQ Web Console, choose ActiveMQ Web Console. 7. Choose Create user. 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 or reboot the broker. Creating an ActiveMQ broker user 124 Amazon MQ Developer Guide Edit an ActiveMQ broker user To edit an existing user, do the following: 1. 2. Sign in to the Amazon MQ console. From the broker list, choose the name of your broker (for example, MyBroker) and then choose View details. On the MyBroker page, in the Users section, all the users for this broker are listed. 3. Select your sign-in credentials and choose Edit. 4. 5. 6. The Edit user dialog box is displayed. (Optional) Type a new Password. (Optional) Add or remove the names of groups to which the user belongs, separated by commas (for example: Managers, Admins). (Optional) To enable the user to access the ActiveMQ Web Console, choose ActiveMQ Web Console. 7. To save the changes to the user, choose Done. Important
amazon-mq-dg-033	amazon-mq-dg.pdf	33	list, choose the name of your broker (for example, MyBroker) and then choose View details. On the MyBroker page, in the Users section, all the users for this broker are listed. 3. Select your sign-in credentials and choose Edit. 4. 5. 6. The Edit user dialog box is displayed. (Optional) Type a new Password. (Optional) Add or remove the names of groups to which the user belongs, separated by commas (for example: Managers, Admins). (Optional) To enable the user to access the ActiveMQ Web Console, choose ActiveMQ Web Console. 7. To save the changes to the user, choose Done. 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 or reboot the broker. Delete an ActiveMQ broker user When you no longer need a user, you can delete the user. 1. Sign in to the Amazon MQ console. Edit an ActiveMQ broker user 125 Amazon MQ Developer Guide 2. From the broker list, choose the name of your broker (for example, MyBroker) and then choose View details. On the MyBroker page, in the Users section, all the users for this broker are listed. 3. 4. Select a your sign-in credentials (for example, MyUser) and then choose Delete. To conﬁrm deleting the user, in the Delete MyUser? dialog box, choose Delete. 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 or reboot the broker. 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 Connecting a Java application to your broker. • 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. Working Java examples 126 Amazon MQ Prerequisites Enable VPC Attributes Developer Guide 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 in the Amazon VPC User Guide. Enable inbound Connections To work with Amazon MQ programmatically, you must use inbound connections. 1. 2. Sign in to the Amazon MQ console. From the broker list, choose the name of your broker (for example, MyBroker). 3. On the MyBroker page, in the Connections section, note the addresses and ports of the broker's web console URL and wire-level protocols. 4. In the Details section, under Security and network, choose the name of your security group or . The Security Groups page of the EC2 Dashboard is displayed. 5. From the security group list, choose your security group. 6. At the bottom of the page, choose Inbound, and then choose Edit. 7. In the Edit inbound rules dialog box, add a rule for every URL or endpoint that you want to be publicly accessible (the following example shows how to do this for a broker web console). a. b. c. d. Choose Add Rule. For Type, select Custom TCP. For Port Range, type the web console port (8162). For Source, leave Custom selected and then type the IP address of the system that you want to be able to access the web console (for example, 192.0.2.1). e. Choose Save. Your broker can now accept inbound connections. Working Java examples 127 Amazon MQ Add Java dependencies OpenWire Developer Guide Add the activemq-client.jar and activemq-pool.jar packages to your Java class path. The following example shows these dependencies in a Maven project pom.xml ﬁle. <dependencies> <dependency> <groupId>org.apache.activemq</groupId> <artifactId>activemq-client</artifactId> <version>5.15.16</version> </dependency> <dependency> <groupId>org.apache.activemq</groupId> <artifactId>activemq-pool</artifactId> <version>5.15.16</version> </dependency> </dependencies> For more information about activemq-client.jar, see Initial Conﬁguration in the Apache ActiveMQ documentation. MQTT Add the org.eclipse.paho.client.mqttv3.jar package to your Java class path. The following example shows this dependency in a Maven project pom.xml ﬁle. <dependencies> <dependency> <groupId>org.eclipse.paho</groupId> <artifactId>org.eclipse.paho.client.mqttv3</artifactId> <version>1.2.0</version> </dependency> </dependencies> For more information about org.eclipse.paho.client.mqttv3.jar, see Eclipse Paho Java Client. STOMP+WSS Add the following packages to your Java class path: Working Java examples 128 Amazon MQ Developer Guide • 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 ﬁle. <dependencies> <dependency> <groupId>org.springframework</groupId> <artifactId>spring-messaging</artifactId> <version>5.0.5.RELEASE</version> </dependency> <dependency> <groupId>org.springframework</groupId> <artifactId>spring-websocket</artifactId> <version>5.0.5.RELEASE</version> </dependency> <dependency> <groupId>javax.websocket</groupId> <artifactId>javax.websocket-api</artifactId> <version>1.1</version> </dependency> <dependency> <groupId>org.eclipse.jetty.aggregate</groupId> <artifactId>jetty-all</artifactId> <type>pom</type> <version>9.3.3.v20150827</version> </dependency> <dependency> <groupId>org.slf4j</groupId> <artifactId>slf4j-simple</artifactId> <version>1.6.6</version> </dependency> <dependency> <groupId>com.fasterxml.jackson.core</groupId> <artifactId>jackson-databind</artifactId> <version>2.5.0</version> Working Java examples 129 Amazon MQ Developer Guide </dependency> </dependencies> For more information, see STOMP Support in the Spring Framework documentation. AmazonMQExample.java Important In the following example
amazon-mq-dg-034	amazon-mq-dg.pdf	34	STOMP+WSS Add the following packages to your Java class path: Working Java examples 128 Amazon MQ Developer Guide • 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 ﬁle. <dependencies> <dependency> <groupId>org.springframework</groupId> <artifactId>spring-messaging</artifactId> <version>5.0.5.RELEASE</version> </dependency> <dependency> <groupId>org.springframework</groupId> <artifactId>spring-websocket</artifactId> <version>5.0.5.RELEASE</version> </dependency> <dependency> <groupId>javax.websocket</groupId> <artifactId>javax.websocket-api</artifactId> <version>1.1</version> </dependency> <dependency> <groupId>org.eclipse.jetty.aggregate</groupId> <artifactId>jetty-all</artifactId> <type>pom</type> <version>9.3.3.v20150827</version> </dependency> <dependency> <groupId>org.slf4j</groupId> <artifactId>slf4j-simple</artifactId> <version>1.6.6</version> </dependency> <dependency> <groupId>com.fasterxml.jackson.core</groupId> <artifactId>jackson-databind</artifactId> <version>2.5.0</version> Working Java examples 129 Amazon MQ Developer Guide </dependency> </dependencies> For more information, see STOMP Support in the Spring Framework documentation. AmazonMQExample.java 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. OpenWire /* * Copyright 2010-2019 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). * You may not use this file except in compliance with the License. * A copy of the License is located at * * https://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either * express or implied. See the License for the specific language governing * permissions and limitations under the License. * / import org.apache.activemq.ActiveMQConnectionFactory; import org.apache.activemq.jms.pool.PooledConnectionFactory; import javax.jms.; public class AmazonMQExample { // Specify the connection parameters. private final static String WIRE_LEVEL_ENDPOINT Working Java examples 130 Amazon MQ Developer Guide = "ssl://b-1234a5b6-78cd-901e-2fgh-3i45j6k178l9-1.mq.us- east-2.amazonaws.com:61617"; private final static String ACTIVE_MQ_USERNAME = "MyUsername123"; private final static String ACTIVE_MQ_PASSWORD = "MyPassword456"; public static void main(String[] args) throws JMSException { final ActiveMQConnectionFactory connectionFactory = createActiveMQConnectionFactory(); final PooledConnectionFactory pooledConnectionFactory = createPooledConnectionFactory(connectionFactory); sendMessage(pooledConnectionFactory); receiveMessage(connectionFactory); pooledConnectionFactory.stop(); } private static void sendMessage(PooledConnectionFactory pooledConnectionFactory) throws JMSException { // Establish a connection for the producer. final Connection producerConnection = pooledConnectionFactory .createConnection(); producerConnection.start(); // Create a session. final Session producerSession = producerConnection .createSession(false, Session.AUTO_ACKNOWLEDGE); // Create a queue named "MyQueue". final Destination producerDestination = producerSession .createQueue("MyQueue"); // Create a producer from the session to the queue. final MessageProducer producer = producerSession .createProducer(producerDestination); producer.setDeliveryMode(DeliveryMode.NON_PERSISTENT); // Create a message. final String text = "Hello from Amazon MQ!"; final TextMessage producerMessage = producerSession Working Java examples 131 Amazon MQ Developer Guide .createTextMessage(text); // Send the message. producer.send(producerMessage); System.out.println("Message sent."); // Clean up the producer. producer.close(); producerSession.close(); producerConnection.close(); } private static void receiveMessage(ActiveMQConnectionFactory connectionFactory) throws JMSException { // Establish a connection for the consumer. // Note: Consumers should not use PooledConnectionFactory. final Connection consumerConnection = connectionFactory.createConnection(); consumerConnection.start(); // Create a session. final Session consumerSession = consumerConnection .createSession(false, Session.AUTO_ACKNOWLEDGE); // Create a queue named "MyQueue". final Destination consumerDestination = consumerSession .createQueue("MyQueue"); // Create a message consumer from the session to the queue. final MessageConsumer consumer = consumerSession .createConsumer(consumerDestination); // Begin to wait for messages. final Message consumerMessage = consumer.receive(1000); // Receive the message when it arrives. final TextMessage consumerTextMessage = (TextMessage) consumerMessage; System.out.println("Message received: " + consumerTextMessage.getText()); // Clean up the consumer. consumer.close(); Working Java examples 132 Amazon MQ Developer Guide consumerSession.close(); consumerConnection.close(); } private static PooledConnectionFactory createPooledConnectionFactory(ActiveMQConnectionFactory connectionFactory) { // Create a pooled connection factory. final PooledConnectionFactory pooledConnectionFactory = new PooledConnectionFactory(); pooledConnectionFactory.setConnectionFactory(connectionFactory); pooledConnectionFactory.setMaxConnections(10); return pooledConnectionFactory; } private static ActiveMQConnectionFactory createActiveMQConnectionFactory() { // Create a connection factory. final ActiveMQConnectionFactory connectionFactory = new ActiveMQConnectionFactory(WIRE_LEVEL_ENDPOINT); // Pass the sign-in credentials. connectionFactory.setUserName(ACTIVE_MQ_USERNAME); connectionFactory.setPassword(ACTIVE_MQ_PASSWORD); return connectionFactory; } } MQTT /* * Copyright 2010-2019 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). * You may not use this file except in compliance with the License. * A copy of the License is located at * * https://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either * express or implied. See the License for the specific language governing Working Java examples 133 Amazon MQ Developer Guide * permissions and limitations under the License. * / import org.eclipse.paho.client.mqttv3.; public class AmazonMQExampleMqtt implements MqttCallback { // Specify the connection parameters. private final static String WIRE_LEVEL_ENDPOINT = "ssl://b-1234a5b6-78cd-901e-2fgh-3i45j6k178l9-1.mq.us- east-2.amazonaws.com:8883"; private final static String ACTIVE_MQ_USERNAME = "MyUsername123"; private final static String ACTIVE_MQ_PASSWORD = "MyPassword456"; public static void main(String[] args) throws Exception { new AmazonMQExampleMqtt().run(); } private void run() throws MqttException, InterruptedException { // Specify the topic name and the message text. final String topic = "myTopic"; final String text = "Hello from Amazon MQ!"; // Create the MQTT client and specify the connection options. final String clientId = "abc123"; final MqttClient client = new MqttClient(WIRE_LEVEL_ENDPOINT, clientId); final MqttConnectOptions connOpts = new MqttConnectOptions(); // Pass the sign-in credentials. connOpts.setUserName(ACTIVE_MQ_USERNAME); connOpts.setPassword(ACTIVE_MQ_PASSWORD.toCharArray()); // Create a session and subscribe to a topic filter. client.connect(connOpts); client.setCallback(this); client.subscribe("+"); Working Java examples 134 Amazon MQ Developer
amazon-mq-dg-035	amazon-mq-dg.pdf	35	static String ACTIVE_MQ_PASSWORD = "MyPassword456"; public static void main(String[] args) throws Exception { new AmazonMQExampleMqtt().run(); } private void run() throws MqttException, InterruptedException { // Specify the topic name and the message text. final String topic = "myTopic"; final String text = "Hello from Amazon MQ!"; // Create the MQTT client and specify the connection options. final String clientId = "abc123"; final MqttClient client = new MqttClient(WIRE_LEVEL_ENDPOINT, clientId); final MqttConnectOptions connOpts = new MqttConnectOptions(); // Pass the sign-in credentials. connOpts.setUserName(ACTIVE_MQ_USERNAME); connOpts.setPassword(ACTIVE_MQ_PASSWORD.toCharArray()); // Create a session and subscribe to a topic filter. client.connect(connOpts); client.setCallback(this); client.subscribe("+"); Working Java examples 134 Amazon MQ Developer Guide // Create a message. final MqttMessage message = new MqttMessage(text.getBytes()); // Publish the message to a topic. client.publish(topic, message); System.out.println("Published message."); // Wait for the message to be received. Thread.sleep(3000L); // Clean up the connection. client.disconnect(); } @Override public void connectionLost(Throwable cause) { System.out.println("Lost connection."); } @Override public void messageArrived(String topic, MqttMessage message) throws MqttException { System.out.println("Received message from topic " + topic + ": " + message); } @Override public void deliveryComplete(IMqttDeliveryToken token) { System.out.println("Delivered message."); } } STOMP+WSS /* * Copyright 2010-2019 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). * You may not use this file except in compliance with the License. * A copy of the License is located at * * https://aws.amazon.com/apache2.0 Working Java examples 135 Amazon MQ * Developer Guide * or in the "license" file accompanying this file. This file is distributed * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either * express or implied. See the License for the specific language governing * permissions and limitations under the License. * / import org.springframework.messaging.converter.StringMessageConverter; import org.springframework.messaging.simp.stomp.; import org.springframework.web.socket.WebSocketHttpHeaders; import org.springframework.web.socket.client.WebSocketClient; import org.springframework.web.socket.client.standard.StandardWebSocketClient; import org.springframework.web.socket.messaging.WebSocketStompClient; import java.lang.reflect.Type; public class AmazonMQExampleStompWss { // Specify the connection parameters. private final static String DESTINATION = "/queue"; private final static String WIRE_LEVEL_ENDPOINT = "wss://b-1234a5b6-78cd-901e-2fgh-3i45j6k178l9-1.mq.us- east-2.amazonaws.com:61619"; private final static String ACTIVE_MQ_USERNAME = "MyUsername123"; private final static String ACTIVE_MQ_PASSWORD = "MyPassword456"; public static void main(String[] args) throws Exception { final AmazonMQExampleStompWss example = new AmazonMQExampleStompWss(); final StompSession stompSession = example.connect(); System.out.println("Subscribed to a destination using session."); example.subscribeToDestination(stompSession); System.out.println("Sent message to session."); example.sendMessage(stompSession); Thread.sleep(60000); Working Java examples 136 Amazon MQ } Developer Guide private StompSession connect() throws Exception { // Create a client. final WebSocketClient client = new StandardWebSocketClient(); final WebSocketStompClient stompClient = new WebSocketStompClient(client); stompClient.setMessageConverter(new StringMessageConverter()); final WebSocketHttpHeaders headers = new WebSocketHttpHeaders(); // Create headers with authentication parameters. final StompHeaders head = new StompHeaders(); head.add(StompHeaders.LOGIN, ACTIVE_MQ_USERNAME); head.add(StompHeaders.PASSCODE, ACTIVE_MQ_PASSWORD); final StompSessionHandler sessionHandler = new MySessionHandler(); // Create a connection. return stompClient.connect(WIRE_LEVEL_ENDPOINT, headers, head, sessionHandler).get(); } private void subscribeToDestination(final StompSession stompSession) { stompSession.subscribe(DESTINATION, new MyFrameHandler()); } private void sendMessage(final StompSession stompSession) { stompSession.send(DESTINATION, "Hello from Amazon MQ!".getBytes()); } private static class MySessionHandler extends StompSessionHandlerAdapter { public void afterConnected(final StompSession stompSession, final StompHeaders stompHeaders) { System.out.println("Connected to broker."); } Working Java examples 137 Amazon MQ } Developer Guide private static class MyFrameHandler implements StompFrameHandler { public Type getPayloadType(final StompHeaders headers) { return String.class; } public void handleFrame(final StompHeaders stompHeaders, final Object message) { System.out.print("Received message from topic: " + message); } } } Managing Amazon MQ for ActiveMQ engine versions Apache ActiveMQ organizes version numbers according to semantic versioning speciﬁcation as X.Y.Z. In Amazon MQ for ActiveMQ implementations, X denotes the major version, Y represents the minor version, and Z denotes the patch version number. Amazon MQ considers a version change to be major if the major version numbers change. For example, upgrading from version 5.17 to 6.0 is considered a major version upgrade. A version change is considered minor if only the minor or patch version number changes. For example, upgrading from version 5.17 to 5.18 is considered a minor version upgrade. When autoMinorVersionUpgrade is turned on, Amazon MQ upgrades your broker to the newest available patch version. Amazon MQ for ActiveMQ recommends all brokers use the latest supported minor version. For instructions on how to upgrade your broker engine version, see Upgrading an Amazon MQ broker engine version. Supported engine versions on Amazon MQ for ActiveMQ The Amazon MQ version support calendar indicates when a broker engine version will reach end of support. When a version reaches end of support, Amazon MQ upgrades all brokers on this version to the next supported version automatically. This upgrade takes place during your broker's scheduled maintenance windows, within the 45 days following the end-of-support date. Amazon MQ provides at least a 90 day notice before a version reaches end of support. We recommend upgrading your broker before the end-of-support date to prevent any disruptions. Version management 138 Amazon MQ Developer Guide Additionally, you cannot create new brokers on versions scheduled for end of support within 30 days of the end of support date. Apache ActiveMQ version End
amazon-mq-dg-036	amazon-mq-dg.pdf	36	a version reaches end of support, Amazon MQ upgrades all brokers on this version to the next supported version automatically. This upgrade takes place during your broker's scheduled maintenance windows, within the 45 days following the end-of-support date. Amazon MQ provides at least a 90 day notice before a version reaches end of support. We recommend upgrading your broker before the end-of-support date to prevent any disruptions. Version management 138 Amazon MQ Developer Guide Additionally, you cannot create new brokers on versions scheduled for end of support within 30 days of the end of support date. Apache ActiveMQ version End of support on Amazon MQ ActiveMQ 5.18 (recommended) ActiveMQ 5.17 ActiveMQ 5.16 ActiveMQ 5.15 June 16, 2025 November 15, 2024 September 16, 2024 When you create a new Amazon MQ for ActiveMQ broker, you can specify any supported ActiveMQ engine version. If you do not specify the engine version number when creating a broker, Amazon MQ automatically defaults to the latest engine version number. Engine version upgrades You can manually upgrade your broker at any time to the next supported major or minor version. When you turn on automatic minor version upgrades, Amazon MQ will upgrade your broker to the latest supported patch version during the maintenance window. For more information about manually upgrading your broker, see the section called “Upgrading the engine version”. Listing supported engine versions You can list all supported minor and major engine versions by using the describe-broker- instance-options AWS CLI command. aws mq describe-broker-instance-options To ﬁlter the results by engine and instance type use the --engine-type and --host-instance- type options as shown in the following. aws mq describe-broker-instance-options --engine-type engine-type --host-instance- type instance-type Engine version upgrades 139 Amazon MQ Developer Guide For example, to ﬁlter the results for ActiveMQ, and mq.m5.large instance type, replace engine- type with ACTIVEMQ and instance-type with mq.m5.large. Amazon MQ for ActiveMQ best practices Use this as a reference to quickly ﬁnd recommendations for maximizing performance and minimizing throughput costs when working with ActiveMQ brokers on Amazon MQ. Never Modify or Delete the Amazon MQ Elastic Network Interface When you ﬁrst create an Amazon MQ broker, Amazon MQ provisions an elastic network interface in the Virtual Private Cloud (VPC) under your account and, thus, requires a number of EC2 permissions. The network interface allows your client (producer or consumer) to communicate with the Amazon MQ broker. The network interface is considered to be within the service scope of Amazon MQ, despite being part of your account's VPC. Warning You must not modify or delete this network interface. Modifying or deleting the network interface can cause a permanent loss of connection between your VPC and your broker. Amazon MQ for ActiveMQ best practices 140 Amazon MQ Developer Guide Always Use Connection Pooling In a scenario with a single producer and single consumer (such as the Getting started: Creating and connecting to an ActiveMQ broker tutorial), you can use a single ActiveMQConnectionFactory class for every producer and consumer. For example: // Create a connection factory. final ActiveMQConnectionFactory connectionFactory = new ActiveMQConnectionFactory(wireLevelEndpoint); // Pass the sign-in credentials. connectionFactory.setUserName(activeMqUsername); connectionFactory.setPassword(activeMqPassword); // Establish a connection for the consumer. final Connection consumerConnection = connectionFactory.createConnection(); consumerConnection.start(); However, in more realistic scenarios with multiple producers and consumers, it can be costly and ineﬃcient to create a large number of connections for multiple producers. In these scenarios, you should group multiple producer requests using the PooledConnectionFactory class. For example: Note Message consumers should never use the PooledConnectionFactory class. // Create a connection factory. final ActiveMQConnectionFactory connectionFactory = new ActiveMQConnectionFactory(wireLevelEndpoint); // Pass the sign-in credentials. connectionFactory.setUserName(activeMqUsername); connectionFactory.setPassword(activeMqPassword); // Create a pooled connection factory. final PooledConnectionFactory pooledConnectionFactory = new PooledConnectionFactory(); pooledConnectionFactory.setConnectionFactory(connectionFactory); pooledConnectionFactory.setMaxConnections(10); Always Use Connection Pooling 141 Amazon MQ Developer Guide // Establish a connection for the producer. final Connection producerConnection = pooledConnectionFactory.createConnection(); producerConnection.start(); Always Use the Failover Transport to Connect to Multiple Broker Endpoints If you need your application to connect to multiple broker endpoints—for example, when you use an active/standby deployment mode or when you migrate from an on-premises message broker to Amazon MQ—use the Failover Transport to allow your consumers to randomly connect to either one. For example: failover:(ssl://b-1234a5b6-78cd-901e-2fgh-3i45j6k178l9-1.mq.us- east-2.amazonaws.com:61617,ssl://b-9876l5k4-32ji-109h-8gfe-7d65c4b132a1-2.mq.us- west-2.amazonaws.com:61617)?randomize=true Avoid Using Message Selectors It is possible to use JMS selectors to attach ﬁlters to topic subscriptions (to route messages to consumers based on their content). However, the use of JMS selectors ﬁlls up the Amazon MQ broker's ﬁlter buﬀer, preventing it from ﬁltering messages. In general, avoid letting consumers route messages because, for optimal decoupling of consumers and producers, both the consumer and the producer should be ephemeral. Prefer Virtual Destinations to Durable Subscriptions A durable subscription can help ensure that the consumer receives all messages published to a topic, for example, after a lost connection is restored. However, the use of durable subscriptions also precludes the
amazon-mq-dg-037	amazon-mq-dg.pdf	37	use JMS selectors to attach ﬁlters to topic subscriptions (to route messages to consumers based on their content). However, the use of JMS selectors ﬁlls up the Amazon MQ broker's ﬁlter buﬀer, preventing it from ﬁltering messages. In general, avoid letting consumers route messages because, for optimal decoupling of consumers and producers, both the consumer and the producer should be ephemeral. Prefer Virtual Destinations to Durable Subscriptions A durable subscription can help ensure that the consumer receives all messages published to a topic, for example, after a lost connection is restored. However, the use of durable subscriptions also precludes the use of competing consumers and might have performance issues at scale. Consider using virtual destinations instead. If using Amazon VPC peering, avoid client IPs in CIDR range 10.0.0.0/16 If you are setting up Amazon VPC peering between on-premise infrastructure and your Amazon MQ broker, you must not conﬁgure client connections with IPs in CIDR range 10.0.0.0/16. Always Use the Failover Transport to Connect to Multiple Broker Endpoints 142 Amazon MQ Developer Guide 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 conﬁguration, see concurrentStoreAndDispatchQueues. Choose the Correct Broker Instance Type for the Best Throughput The message throughput of a broker instance type 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. Disable Concurrent Store and Dispatch for Queues with Slow Consumers 143 Amazon MQ Developer Guide To determine the best broker instance type for your application, we recommend testing diﬀerent broker instance types. For more information, see Broker instance types and also Measuring the Throughput for Amazon MQ using the JMS Benchmark. 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 (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 beneﬁt 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 ﬂag is enabled, ActiveMQ allows messages to ﬂow 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 beneﬁt 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? in the ActiveMQ documentation. Choose the correct broker storage type for the best throughput To take advantage of high durability and replication across multiple Availability Zones, use Amazon EFS. To take advantage of low latency and high throughput, use Amazon EBS. For more information, see Storage. Conﬁgure Your Network of Brokers Correctly When you create a network of brokers, conﬁgure it correctly for your application: • Enable persistent mode – Because (relative to its peers) each broker instance acts like a producer or a consumer, networks of brokers don't provide distributed replication of messages. The ﬁrst Choose the correct broker storage type for the best throughput 144
amazon-mq-dg-038	amazon-mq-dg.pdf	38	broker storage type for the best throughput To take advantage of high durability and replication across multiple Availability Zones, use Amazon EFS. To take advantage of low latency and high throughput, use Amazon EBS. For more information, see Storage. Conﬁgure Your Network of Brokers Correctly When you create a network of brokers, conﬁgure it correctly for your application: • Enable persistent mode – Because (relative to its peers) each broker instance acts like a producer or a consumer, networks of brokers don't provide distributed replication of messages. The ﬁrst Choose the correct broker storage type for the best throughput 144 Amazon MQ Developer Guide broker that acts as a consumer receives a message and persists it to storage. This broker sends an acknowledgement to the producer and forwards the message to the next broker. When the second broker acknowledges the persistence of the message, the ﬁrst broker deletes the message. If persistent mode is disabled, the ﬁrst broker acknowledges the producer without persisting the message to storage. For more information, see Replicated Message Store and What is the diﬀerence between persistent and non-persistent delivery? in the Apache ActiveMQ documentation. • Don't disable advisory messages for broker instances – For more information, see Advisory Message in the Apache ActiveMQ documentation. • Don't use multicast broker discovery – Amazon MQ doesn't support broker discovery using multicast. For more information, see What is the diﬀerence between discovery, multicast, and zeroconf? in the Apache ActiveMQ documentation. Avoid slow restarts by recovering prepared XA transactions ActiveMQ supports distributed (XA) transactions. Knowing how ActiveMQ processes XA transactions can help avoid slow recovery times for broker restarts and failovers in Amazon MQ Unresolved prepared XA transactions are replayed on every restart. If these remain unresolved, their number will grow over time, signiﬁcantly increasing the time needed to start up the broker. This aﬀects restart and failover time. You must resolve these transactions with a commit() or a rollback() so that performance doesn't degrade over time. To monitor your unresolved prepared XA transactions, you can use the JournalFilesForFastRecovery metric in Amazon CloudWatch Logs. If this number is increasing, or is consistently higher than 1, you should recover your unresolved transactions with code similar to the following example. For more information, see Quotas in Amazon MQ. The following example code walks through prepared XA transactions and closes them with a rollback(). import org.apache.activemq.ActiveMQXAConnectionFactory; import javax.jms.XAConnection; import javax.jms.XASession; import javax.transaction.xa.XAResource; Avoid slow restarts by recovering prepared XA transactions 145 Amazon MQ Developer Guide import javax.transaction.xa.Xid; public class RecoverXaTransactions { private static final ActiveMQXAConnectionFactory ACTIVE_MQ_CONNECTION_FACTORY; final static String WIRE_LEVEL_ENDPOINT = "tcp://localhost:61616";; static { final String activeMqUsername = "MyUsername123"; final String activeMqPassword = "MyPassword456"; ACTIVE_MQ_CONNECTION_FACTORY = new ActiveMQXAConnectionFactory(activeMqUsername, activeMqPassword, WIRE_LEVEL_ENDPOINT); ACTIVE_MQ_CONNECTION_FACTORY.setUserName(activeMqUsername); ACTIVE_MQ_CONNECTION_FACTORY.setPassword(activeMqPassword); } public static void main(String[] args) { try { final XAConnection connection = ACTIVE_MQ_CONNECTION_FACTORY.createXAConnection(); XASession xaSession = connection.createXASession(); XAResource xaRes = xaSession.getXAResource(); for (Xid id : xaRes.recover(XAResource.TMENDRSCAN)) { xaRes.rollback(id); } connection.close(); } catch (Exception e) { } } } In a real-world scenario, you could check your prepared XA transactions against your XA Transaction Manager. Then you can decide whether to handle each prepared transaction with a rollback() or a commit(). Avoid slow restarts by recovering prepared XA transactions 146 Amazon MQ Developer Guide Using Amazon MQ for RabbitMQ Amazon MQ makes it easy to create a message broker with the computing and storage resources that ﬁt your needs. You can create, manage, and delete brokers using the AWS Management Console, Amazon MQ REST API, or the AWS Command Line Interface. This section describes the basic elements of a message broker for ActiveMQ and RabbitMQ engine types, lists available Amazon MQ broker instance types and their statuses, and provides an overview of broker architecture and conﬁguration options. To learn about Amazon MQ REST APIs, see the Amazon MQ REST API Reference. Amazon MQ for RabbitMQ brokers What is an Amazon MQ for RabbitMQ 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, t3) and size (large, micro) is called the broker instance type (for example, mq.m5.large). • A single-instance broker is comprised of one broker in one Availability Zone behind a Network Load Balancer (NLB) The broker communicates with your application and with an Amazon EBS storage volume. • A cluster deployment is a logical grouping of three RabbitMQ broker nodes behind a Network Load Balancer, each sharing users, queues, and a distributed state across multiple Availability Zones (AZ). For more information, see Deployment options for Amazon MQ for RabbitMQ brokers. You can enable automatic minor version upgrades to new minor versions of the broker engine, as new versions of the RabbitMQ engine are released. Automatic upgrades occur during the maintenance window deﬁned by the day of the week,
amazon-mq-dg-039	amazon-mq-dg.pdf	39	behind a Network Load Balancer (NLB) The broker communicates with your application and with an Amazon EBS storage volume. • A cluster deployment is a logical grouping of three RabbitMQ broker nodes behind a Network Load Balancer, each sharing users, queues, and a distributed state across multiple Availability Zones (AZ). For more information, see Deployment options for Amazon MQ for RabbitMQ brokers. You can enable automatic minor version upgrades to new minor versions of the broker engine, as new versions of the RabbitMQ engine are released. Automatic upgrades occur during the maintenance window deﬁned by the day of the week, the time of day (in 24-hour format), and the time zone (UTC by default). Supported protocols You can access your RabbitMQ brokers by using any programming language that RabbitMQ supports and by enabling TLS for the following protocols: Amazon MQ for RabbitMQ brokers 147 Amazon MQ • AMQP (0-9-1) Listener ports Developer Guide Amazon MQ managed RabbitMQ brokers support the following listener ports for application-level connectivity via amqps, as well as client connections using the RabbitMQ web console and the management API. • Listener port 5671 - Used for connections made via the secure AMQP URL. For example, given a broker with broker ID b-c8352341-ec91-4a78-ad9c-a43f23d325bb, deployed in the us- west-2 region, the following is the broker's full amqp URL: b-c8352341-ec91-4a78-ad9c- a43f23d325bb.mq.us-west-2.amazonaws.com:5671. • Listener ports 443 and 15671 - Both listener ports can be used interchangably to access a broker via the RabbitMQ web console or the mangement API. Attributes A RabbitMQ broker has several attributes: • A name. For example, MyBroker. • An ID. For example, b-1234a5b6-78cd-901e-2fgh-3i45j6k178l9. • An Amazon Resource Name (ARN). For example, arn:aws:mq:us- east-2:123456789012:broker:MyBroker:b-1234a5b6-78cd-901e-2fgh-3i45j6k178l9. • A RabbitMQ web console URL. For example, https:// b-1234a5b6-78cd-901e-2fgh-3i45j6k178l9-1.mq.us-east-2.amazonaws.com. For more information, see RabbitMQ web console in the RabbitMQ documentation. • A secure AMQP endpoint. For example, amqps:// b-1234a5b6-78cd-901e-2fgh-3i45j6k178l9-1.mq.us-east-2.amazonaws.com. For a full list of broker attributes, see the following in the Amazon MQ REST API Reference: • REST Operation ID: Broker • REST Operation ID: Brokers • REST Operation ID: Broker Reboot Broker 148 Amazon MQ Developer Guide Amazon MQ for RabbitMQ broker users Every AMQP 0-9-1 client connection has an associated user which must be authenticated. Each client connection also targets a virtual host (vhost) for which the user must have a set of permissions. A user may have permission to conﬁgure, write to, and read from queues and exchanges in a vhost. User credentials, and the target vhost are speciﬁed at the time the connection is established. When you ﬁrst create an Amazon MQ for RabbitMQ broker, Amazon MQ uses the sign-in credentials you provide to create a RabbitMQ user with the administrator tag. You can then add and manage users via the RabbitMQ management API or the RabbitMQ web console. You can also use the RabbitMQ web console or the management API to set or modify user permissions and tags. Note RabbitMQ users will not be stored or displayed via the Amazon MQ Users API. Important Amazon MQ for RabbitMQ does not support the username "guest", and will delete the default guest account when you create a new broker. Amazon MQ will also periodically delete any customer created account called "guest". To create a new user with the RabbitMQ management API, use the following API endpoint and request body. Replace username and password with your new sign-in credentials. PUT /api/users/username HTTP/1.1 {"password":"password","tags":"administrator"} Important • Do not add personally identiﬁable information (PII) or other conﬁdential or sensitive information in broker usernames. Broker usernames are accessible to other AWS services, including CloudWatch Logs. Broker usernames are not intended to be used for private or sensitive data. Broker users 149 Amazon MQ Developer Guide • If you've forgotten the admin password you set while creating the broker, you cannot reset your credentials. If you've created multiple administrators, you can log in using another admin user and reset or recreate your credentials. If you have only one admin user, you must delete the broker and create a new one with new credentials. We recommend consuming or backing up messages before deleting the broker. The tags key is mandatory, and is a comma-separated list of tags for the user. Amazon MQ supports administrator, management, monitoring, and policymaker user tags. You can set permissions for an individual user by using the following API endpoint and request body. Replace vhost and username with your information. For the default vhost /, use %2F. PUT /api/permissions/vhost/username HTTP/1.1 {"configure":".","write":".","read":"."} Note The configure, read, and write keys are all mandatory. By using the wildcard . value, this operation will grant read, write, and conﬁgure permissions for all queues in the speciﬁed vhost to the user. For more information about managing users via the RabbitMQ management API, see RabbitMQ Management HTTP API. Amazon MQ for RabbitMQ broker defaults When you create
amazon-mq-dg-040	amazon-mq-dg.pdf	40	monitoring, and policymaker user tags. You can set permissions for an individual user by using the following API endpoint and request body. Replace vhost and username with your information. For the default vhost /, use %2F. PUT /api/permissions/vhost/username HTTP/1.1 {"configure":".","write":".","read":"."} Note The configure, read, and write keys are all mandatory. By using the wildcard . value, this operation will grant read, write, and conﬁgure permissions for all queues in the speciﬁed vhost to the user. For more information about managing users via the RabbitMQ management API, see RabbitMQ Management HTTP API. Amazon MQ for RabbitMQ broker defaults When you create an Amazon MQ for RabbitMQ broker, Amazon MQ applies a default set of broker policies and vhost limits to optimize your broker's performance. Amazon MQ applies vhost limits only to the default (/) vhost. Amazon MQ will not apply default policies to newly created vhosts. We recommend keeping these defaults for all new and existing brokers. However, you can modify, override, or delete these defaults at any time. Amazon MQ creates policies and limits based on the instance type and broker deployment mode that you choose when you create your broker. The default policies are named according to the deployment mode, as follows: • Single-instance – AWS-DEFAULT-POLICY-SINGLE-INSTANCE Broker defaults 150 Amazon MQ Developer Guide • Cluster deployment – AWS-DEFAULT-POLICY-CLUSTER-MULTI-AZ For single-instance brokers, Amazon MQ sets the policy priority value to 0. To override the default priority value, you can create your own custom policies with higher priority values. For cluster deployments, Amazon MQ sets the priority value to 1 for broker defaults. To create your own custom policy for clusters, assign a priority value greater than 1. Note In cluster deployments, ha-mode and ha-sync-mode broker policies are required for classic mirroring and high availability (HA). If you delete the default AWS-DEFAULT-POLICY-CLUSTER-MULTI-AZ policy, Amazon MQ uses the ha-all-AWS-OWNED-DO-NOT-DELETE policy with a priority value of 0. This ensures that the required ha-mode and ha-sync-mode policies are still in eﬀect. If you create your own custom policy, Amazon MQ automatically appends ha-mode and ha- sync-mode to your policy deﬁnitions. Topics • Policy and limit descriptions • Recommended default values Policy and limit descriptions The following list describes the default policies and limits that Amazon MQ applies to a newly created broker. The values for max-length, max-queues, and max-connections vary based on your broker's instance type and deployment mode. These values are listed in the Recommended default values section. • queue-mode: lazy (policy) – Enables lazy queues. By default, queues keep an in-memory cache of messages, enabling the broker to deliver messages to consumers as fast as possible. This can lead to the broker running out of memory and raising a high-memory alarm. Lazy queues attempt to move messages to disk as early as is practical. This means that fewer messages are kept in memory under normal operating conditions. Using lazy queues, Amazon MQ for RabbitMQ can support much larger messaging loads and longer queues. Note that for certain use cases, brokers with lazy queues might perform marginally slower. This is because Broker defaults 151 Amazon MQ Developer Guide messages are moved from disk to broker, as opposed to delivering messages from an in-memory cache. Deployment modes Single-instance, cluster • max-length: number-of-messages (policy) – Sets a limit for the number of messages in a queue. In cluster deployments, the limit prevents paused queue synchronization in cases such as broker reboots, or following a maintenance window. Deployment modes Cluster • overflow: reject-publish (policy) – Enforces queues with a max-length policy to reject new messages after the number of messages in the queue reaches the max-length value. To ensure that messages aren't lost if a queue is in an overﬂow state, client applications that publish messages to the broker must implement publisher conﬁrms. For information about implementing publisher conﬁrms, see Publisher Conﬁrms on the RabbitMQ website. Deployment modes Cluster • max-queues: number-of-queues-per-vhost (vhost limit) – Sets the limit for the number of queues in a broker. Similar to the max-length policy deﬁnition, limiting the number of queues in cluster deployments prevents paused queue synchronization following broker reboots or maintenance windows. Limiting queues also prevents excessive amounts of CPU usage for maintaining queues. Deployment modes Single-instance, cluster • max-connections: number-of-connections-per-vhost (vhost limit) – Sets the limit for the number of client connections to the broker. Limiting the number of connections according Broker defaults 152 Amazon MQ Developer Guide to the recommended values prevents excessive broker memory usage, which could result in the broker raising a high memory alarm and pausing operations. Deployment modes Single-instance, cluster Recommended default values Note The max-length and max-queue default limits are tested and evaluated based on an average message size of 5 kB. If your messages are signiﬁcantly larger than 5 kB, you will need to adjust and reduce the max-length and
amazon-mq-dg-041	amazon-mq-dg.pdf	41	• max-connections: number-of-connections-per-vhost (vhost limit) – Sets the limit for the number of client connections to the broker. Limiting the number of connections according Broker defaults 152 Amazon MQ Developer Guide to the recommended values prevents excessive broker memory usage, which could result in the broker raising a high memory alarm and pausing operations. Deployment modes Single-instance, cluster Recommended default values Note The max-length and max-queue default limits are tested and evaluated based on an average message size of 5 kB. If your messages are signiﬁcantly larger than 5 kB, you will need to adjust and reduce the max-length and max-queue limits. The following table lists the default limit values for a newly created broker. Amazon MQ applies these values according to the broker's instance type and deployment mode. Instance type Deployment mode max-length max-queues max-conne t3.micro Single-instance N/A m5.large Single-instance N/A 500 20,000 Cluster 8,000,000 4,000 m5.xlarge Single-instance N/A 30,000 Cluster 9,000,000 5,000 m5.2xlarge Single-instance N/A 60,000 Cluster 10,000,000 6,000 m5.4xlarge Single-instance N/A 150,000 ctions 500 4,000 15,000 8,000 20,000 15,000 40,000 30,000 Broker defaults 153 Amazon MQ Instance type Deployment mode max-length max-queues max-conne Developer Guide Cluster 12,000,000 10,000 ctions 100,000 Amazon MQ for RabbitMQ sizing guidelines You can choose the broker instance type that best supports your application. When choosing an instance type, it is important to consider factors that will aﬀect broker performance: • the number of clients and queues • the volume of messages sent • messages kept in memory • redundant messages Smaller broker instance types (t3.micro) are recommended only for testing application performance. We recommend larger broker instance types (m5.large and above) for production levels of clients and queues, high throughput, messages in memory, and redundant messages. It is important to test your brokers to determine the appropriate instance type and size for your workload messaging requirements. Use the following sizing guidelines to determine the best appropriate instance type for your application. Sizing guidelines for single instance deployment The following table shows the maximum limit values for each instance type for single instance brokers. Instance Type Connections Channels Queues t3.micro 500 1,500 2,500 m5.large 5,000 15,000 30,000 m5.xlarge 10,000 30,000 60,000 Consumers per channel Shovels 1,000 1,000 1,000 150 250 500 Sizing guidelines 154 Amazon MQ Instance Type Connections Channels Queues Consumers per channel Shovels Developer Guide m5.2xlarge 20,000 60,000 120,000 1,000 m5.4xlarge 40,000 120,000 240,000 1,000 1,000 2,000 Sizing guidelines for cluster deployment The following table shows the maximum limit values for each instance type for cluster brokers. Instance Type Queues Consumers per channel Shovels m5.large m5.xlarge m5.2xlarge m5.4xlarge 10,000 15,000 20,000 30,000 1,000 1,000 1,000 1,000 150 300 600 1200 The following connection and channel limits are applied per node: Instance Type Connections Channels m5.large m5.xlarge m5.2xlarge m5.4xlarge 5000 10,000 20,000 40,000 15,000 30,000 60,000 120,000 The exact limit values for a cluster broker may be lower than the indicated value depending on the number of available nodes and how RabbitMQ distributes resources among the available nodes. If Sizing guidelines 155 Amazon MQ Developer Guide you exceed the limit values, you can create a new connection to a diﬀerent node and try again, or you can upgrade the instance size to increase the maximum limits Error messages The following error messages are returned when limits are exceeded. All values are based on the m5.large single instance limits. Note The error codes for the following messages may change based on the client library you are using. Connection ConnectionClosedByBroker 500 "NOT_ALLOWED - connection refused: node connection limit (500) is reached" Channel ConnectionClosedByBroker 1500 "NOT_ALLOWED - number of channels opened on node 'rabbit@ip-10-0-23-173.us-west-2.compute.internal' has reached the maximum allowed limit of (15,000)" Consumer ConnectionClosedByBroker: (530, 'NOT_ALLOWED - reached maximum (1,000) of consumers per channel') Note The following error messages use the HTTP Management API format. Queue {"error":"bad_request","reason":"cannot declare queue 'my_queue': queue limit in cluster (30,000) is reached"}] Shovel Sizing guidelines 156 Amazon MQ Developer Guide {"error":"bad_request","reason":"Validation failed\n\ncomponent shovel is limited to 250 per node\n"} Vhost {"error":"bad_request","reason":"cannot create vhost 'my_vhost': vhost limit of 4,000 is reached"} Plugins for Amazon MQ for RabbitMQ Amazon MQ for RabbitMQ supports the RabbitMQ management plugin which powers the management API and the RabbitMQ web console. You can use the web console and the management API to create and manage broker users and policies. In addition to the management plugin, Amazon MQ for RabbitMQ also supports the following plugins. Topics • Shovel plugin • Federation plugin • Consistent Hash exchange plugin Shovel plugin Amazon MQ managed brokers support RabbitMQ shovel, allowing you to move messages from queues and exchanges on one broker instance to another. You can use shovel to connect loosely coupled brokers and distribute messages away from nodes with heavier message loads. Amazon MQ managed RabbitMQ brokers support dynamic shovels. Dynamic shovels are conﬁgured using runtime parameters, and can
amazon-mq-dg-042	amazon-mq-dg.pdf	42	console and the management API to create and manage broker users and policies. In addition to the management plugin, Amazon MQ for RabbitMQ also supports the following plugins. Topics • Shovel plugin • Federation plugin • Consistent Hash exchange plugin Shovel plugin Amazon MQ managed brokers support RabbitMQ shovel, allowing you to move messages from queues and exchanges on one broker instance to another. You can use shovel to connect loosely coupled brokers and distribute messages away from nodes with heavier message loads. Amazon MQ managed RabbitMQ brokers support dynamic shovels. Dynamic shovels are conﬁgured using runtime parameters, and can be started and stopped at any time programatically by a client connection. For example, using the RabbitMQ management API, you can create a PUT request to the following API endpoint to conﬁgure a dynamic shovel. In the example, {vhost} can be replaced by the name of the broker's vhost, and {name} replaced by the name of the new dynamic shovel. /api/parameters/shovel/{vhost}/{name} In the request body, you must specify either a queue or an exchange but not both. This example below conﬁgures a dynamic shovel between a local queue speciﬁed in src-queue and a remote Plugins 157 Amazon MQ Developer Guide queue deﬁned in dest-queue. Similairly, you can use src-exchange and dest-exchange parameters to conﬁgure a shovel between two exchanges. { "value": { "src-protocol": "amqp091", "src-uri": "amqp://localhost", "src-queue": "source-queue-name", "dest-protocol": "amqp091", "dest-uri": "amqps://b-c8352341-ec91-4a78-ad9c-a43f23d325bb.mq.us- west-2.amazonaws.com:5671", "dest-queue": "destination-queue-name" } } Important You cannot conﬁgure shovel between queues or exchanges if the shovel destination is a private broker. For more information about using dynamic shovels, see RabbitMQ dynamic shovel plugin. Note Amazon MQ does not support using static shovels. Federation plugin Amazon MQ supports federated exchanges and queues. With federation, you can replicate the ﬂow of messages between queues, exchanges and consumers on separate brokers. Federated queues and exchanges use point-to-point links to connect to peers in other brokers. While federated exchanges, by default, route messages once, federated queues can move messages any number of times as needed by consumers. You can use federation to allow a downstream broker to consume a message from an exchange or a queue on an upstream. You can enable federation on downstream brokers by using the RabbitMQ web console or the management API. Plugins 158 Amazon MQ Important Developer Guide You cannot conﬁgure federation if the upstream queue or exchange is in a private broker. You can only conﬁgure federation between queues or exchanges in public brokers, or between an upstream queue or exchange in a public broker, and a downstream queue or exchange in a private broker. For example, using the management API, you can conﬁgure federation by doing the following. • Conﬁgure one or more upstreams that deﬁne federation connections to other nodes. You can deﬁne federation connections by using the RabbitMQ web console or the management API. Using the management API, you can create a POST request to /api/parameters/ federation-upstream/%2f/my-upstream with the following request body. {"value":{"uri":"amqp://server-name","expires":3600000}} • Conﬁgure a policy to enable your queues or exchanges to become federated. You can conﬁgure policies by using the RabbitMQ web console, or the management API. Using the management API, you can create a POST request to /api/policies/%2f/federate-me with the following request body. {"pattern":"^amq\.", "definition":{"federation-upstream-set":"all"}, "apply- to":"exchanges"} Note The request body assumes exchanges on the server are named beginning with amq. Using regular expression ^amq\. will ensure that federation is enabled for all exchanges whose names begin with "amq." The exchanges on your RabbitMQ server can be named diﬀerently. For more information about conﬁguring the federation plugin, see RabbitMQ federation plugin. Plugins 159 Amazon MQ Developer Guide Consistent Hash exchange plugin By default, Amazon MQ for RabbitMQ supports the Consistent Hash exchange type plugin. Consistent Hash exchanges route messages to queues based on a hash value calculated from the routing key of a message. Given a reasonably even routing key, Consistent Hash exchanges can distribute messages between queues reasonably evenly. For queues bound to a Consistent Hash exchange, the binding key is a number-as-a-string that determines the binding weight of each queue. Queues with a higher binding weight will receive a proportionally higher distribution of messages from the Consistent Hash exchange to which they are bound. In a Consistent Hash exchange topology, publishers can simply publish messages to the exchange, but consumers must be explicitly conﬁgured to consume messages from speciﬁc queues. For more information about Consistent Hash exchanges, see RabbitMQ Consistent Hash Exchange Type on the GitHub website. Applying policies to Amazon MQ for RabbitMQ You can apply custom policies and limits with Amazon MQ recommended default values. If you have deleted the recommended default policies and limits, and want to re-create them, or you have created additional vhosts and want to apply the default policies and limits to your new vhosts, you can use the following
amazon-mq-dg-043	amazon-mq-dg.pdf	43	Consistent Hash exchange topology, publishers can simply publish messages to the exchange, but consumers must be explicitly conﬁgured to consume messages from speciﬁc queues. For more information about Consistent Hash exchanges, see RabbitMQ Consistent Hash Exchange Type on the GitHub website. Applying policies to Amazon MQ for RabbitMQ You can apply custom policies and limits with Amazon MQ recommended default values. If you have deleted the recommended default policies and limits, and want to re-create them, or you have created additional vhosts and want to apply the default policies and limits to your new vhosts, you can use the following steps. Important On Amazon MQ for RabbitMQ engine versions 3.12 and below, the current default operator policy is: vhost name pattern apply-to definition priority/ default_operator_policy_AWS_managed .* all {"queue-version":2} 0 On versions 3.13 and above, the default operator policy has changed to: vhost name pattern apply-to definition priority/ default_operator_policy_AWS_managed .* classic_queues {"ha-mode":"all","ha- sync-mode":"automatic","queue-version":2} 0 This update has no functional change on RabbitMQ application behaviors. You cannot create a policy that applies to both classic mirrored queues and quorum queues. If you want your policy to only apply to quorum queues, you must set --apply-to Policies 160 Amazon MQ Developer Guide to quorum_queues. If you are using classic mirrored queues and quorum queues, you must create a separate policy with --apply-to:classic_queues as well as a quorum queues policy. Important To perform the following steps, you must have an Amazon MQ for RabbitMQ broker user with administrator permissions. You can use the administrator user created when you ﬁrst created the broker, or another user that you might have created afterwards. The following table provides the necessary administrator user tag and permissions as regular expression (regexp) patterns. Tags Read regexp Conﬁgure regexp Write regexp administrator .* .* .* For more information about creating RabbitMQ users and managing user tags and permissions, see Amazon MQ for RabbitMQ broker users. To apply default policies and virtual host limits using the RabbitMQ web console 1. 2. 3. Sign in to the Amazon MQ console. In the left navigation pane, choose Brokers. From the list of brokers, choose the name of the broker to which you want to apply the new policy. 4. On the broker details page, in the Connections section, choose the RabbitMQ web console URL. The RabbitMQ web console opens in a new browser tab or window. 5. 6. Log in to the RabbitMQ web console with your broker administrator user name and password. In the RabbitMQ web console, at the top of the page, choose Admin. 7. On the Admin page, in the right navigation pane, choose Policies. 8. On the Policies page, you can see a list of the broker's current User policies. Below User policies, expand Add / update a policy. 9. To create a new broker policy, under Add / update a policy, do the following: Policies 161 Amazon MQ Developer Guide a. For Virtual host, choose the name of the vhost to which you want to attach the policies from the dropdown list. To choose the default vhost, choose /. Note If you have not created additional vhosts, the Virtual host option is not shown in the RabbitMQ console, and the policies are applied only to the default vhost. b. c. d. e. For Name, enter a name for your policy, for example, policy-defaults. For Pattern, enter the regexp pattern .* so that the policy matches all queues on the broker. For Apply to, choose Exchanges and queues from the dropdown list. For Priority, enter an integer greater than all other policies applied to the vhost. You can apply exactly one set of policy deﬁnitions to RabbitMQ queues and exchanges at any given time. RabbitMQ chooses the matching policy with the highest priority value. For more information about policy priorities and how to combine policies, see Policies in the RabbitMQ Server Documentation. f. For Deﬁnition, add the following key-value pairs: • queue-mode=lazy. Choose String from the dropdown list. • overflow=reject-publish. Choose String from the dropdown list. Note Does not apply to single-instance brokers. • max-length=number-of-messages. Replace number-of-messages with the Amazon MQ recommended value according to the broker's instance size and deployment mode, for example, 8000000 for an mq.m5.large cluster. Choose Number from the dropdown list. Note Does not apply to single-instance brokers. g. Choose Add / update policy. Policies 162 Amazon MQ Developer Guide 10. Conﬁrm that the new policy appears in the list of User policies. Note For cluster brokers, Amazon MQ automatically applies the ha-mode: all and ha- sync-mode: automatic policy deﬁnitions. 11. From the right navigation pane, choose Limits. 12. On the Limits page, you can see a list of the broker's current Virtual host limits. Below Virtual host limits, expand Set / update a virtual host limit. 13. To create a new vhost limit, under Set
amazon-mq-dg-044	amazon-mq-dg.pdf	44	Number from the dropdown list. Note Does not apply to single-instance brokers. g. Choose Add / update policy. Policies 162 Amazon MQ Developer Guide 10. Conﬁrm that the new policy appears in the list of User policies. Note For cluster brokers, Amazon MQ automatically applies the ha-mode: all and ha- sync-mode: automatic policy deﬁnitions. 11. From the right navigation pane, choose Limits. 12. On the Limits page, you can see a list of the broker's current Virtual host limits. Below Virtual host limits, expand Set / update a virtual host limit. 13. To create a new vhost limit, under Set / update a virtual host limit, do the following: a. b. c. For Virtual host, choose the name of the vhost to which you want to attach the policies from the dropdown list. To choose the default vhost, choose /. For Limit, choose max-connections from the dropdown options. For Value, enter the Amazon MQ recommended value according to the broker's instance size and deployment mode, for example, 15000 for an mq.m5.large cluster. d. Choose Set / update limit. e. Repeat the steps above, and for Limit, choose max-queues from the dropdown options. 14. Conﬁrm that the new limits appear in the list of Virtual host limits. To apply default policies and virtual host limits using the RabbitMQ management API 1. 2. 3. Sign in to the Amazon MQ console. In the left navigation pane, choose Brokers. From the list of brokers, choose the name of the broker to which you want to apply the new policy. 4. On the broker's page, in the Connections section, note the RabbitMQ web console URL. This is the broker endpoint that you use in an HTTP request. 5. Open a new terminal or command line window of your choice. 6. To create a new broker policy, enter the following curl command. This command assumes a queue on the default / vhost, which is encoded as %2F. To apply the policy to another vhost, replace %2F with the vhost's name. Policies 163 Amazon MQ Note Developer Guide Replace username and password with your administrator sign-in credentials. Replace number-of-messages with the Amazon MQ recommended value according to the broker's instance size and deployment mode. Replace policy-name with a name for your policy. Replace broker-endpoint with the URL that you noted previously. curl -i -u username:password -H "content-type:application/json" -XPUT \ -d '{"pattern":".*", "priority":1, "definition":{"queue-mode":lazy, "overflow":"reject-publish", "max-length":"number-of-messages"}}' \ broker-endpoint/api/policies/%2F/policy-name 7. To conﬁrm that the new policy is added to your broker's user policies, enter the following curl command to list all broker policies. curl -i -u username:password broker-endpoint/api/policies 8. To create a new max-connections virtual host limits, enter the following curl command. This command assumes a queue on the default / vhost, which is encoded as %2F. To apply the policy to another vhost, replace %2F with the vhost's name. Note Replace username and password with your administrator sign-in credentials. Replace max-connections with the Amazon MQ recommended value according to the broker's instance size and deployment mode. Replace the broker endpoint with the URL that you noted previously. curl -i -u username:password -H "content-type:application/json" -XPUT \ -d '{"value":"number-of-connections"}' \ broker-endpoint/api/vhost-limits/%2F/max-connections 9. To create a new max-queues virtual host limit, repeat the previous step, but modify the curl command as shown in the following. Policies 164 Amazon MQ Developer Guide curl -i -u username:password -H "content-type:application/json" -XPUT \ -d '{"value":"number-of-queues"}' \ broker-endpoint/api/vhost-limits/%2F/max-queues 10. To conﬁrm that the new limits are added to your broker's virtual host limits, enter the following curl command to list all broker virtual host limits. curl -i -u username:password broker-endpoint/api/vhost-limits Deployment options for Amazon MQ for RabbitMQ brokers RabbitMQ brokers can be created as single-instance brokers or in a cluster deployment. For both deployment modes, Amazon MQ provides high durability by storing its data redundantly. You can access your RabbitMQ brokers by using any programming language that RabbitMQ supports and by enabling TLS for the following protocols: • AMQP (0-9-1) Topics • Option 1: Amazon MQ for RabbitMQ single-instance broker • Option 2: Amazon MQ for RabbitMQ cluster deployment Option 1: Amazon MQ for RabbitMQ single-instance broker A single-instance broker is comprised of one broker in one Availability Zone behind a Network Load Balancer (NLB). The broker communicates with your application and with an Amazon EBS storage volume. Amazon EBS provides block level storage optimized for low-latency and high throughput. Using an Network Load Balancer ensures that your Amazon MQ for RabbitMQ broker endpoint remains unchanged if the broker instance is replaced during a maintenance window or because of underlying Amazon EC2 hardware failures. An Network Load Balancer allows your applications and users to continue to use the same endpoint to connect to the broker. The following diagram illustrates an Amazon MQ for RabbitMQ single-instance broker. Deploying a RabbitMQ broker 165 Amazon MQ Developer Guide
amazon-mq-dg-045	amazon-mq-dg.pdf	45	The broker communicates with your application and with an Amazon EBS storage volume. Amazon EBS provides block level storage optimized for low-latency and high throughput. Using an Network Load Balancer ensures that your Amazon MQ for RabbitMQ broker endpoint remains unchanged if the broker instance is replaced during a maintenance window or because of underlying Amazon EC2 hardware failures. An Network Load Balancer allows your applications and users to continue to use the same endpoint to connect to the broker. The following diagram illustrates an Amazon MQ for RabbitMQ single-instance broker. Deploying a RabbitMQ broker 165 Amazon MQ Developer Guide Option 2: Amazon MQ for RabbitMQ cluster deployment A cluster deployment is a logical grouping of three RabbitMQ broker nodes behind a Network Load Balancer, each sharing users, queues, and a distributed state across multiple Availability Zones (AZ). In a cluster deployment, Amazon MQ automatically manages broker policies to enable classic mirroring across all nodes, ensuring high availability (HA). Each mirrored queue consists of one main node and one or more mirrors. Each queue has its own main node. All operations for a given queue are ﬁrst applied on the queue's main node and then propagated to mirrors. Amazon MQ creates a default system policy that sets the ha-mode to all and ha-sync-mode to automatic. This ensures that data is replicated to all nodes in the cluster across diﬀerent Availability Zones for better durability. Note During a maintenance window, all maintenance to a cluster is performed one node at a time, keeping at least two running nodes at all times. Each time a node is brought down, client connections to that node are severed and need to be re-established. You must ensure that your client code is designed to automatically reconnect to your cluster. For more information about connection recovery, see the section called “Automatically recover from network failures”. Because Amazon MQ sets ha-sync-mode: automatic, during a maintenance window, queues will synchronize when each node re-joins the cluster. Queue synchronization blocks all other queue operations. You can mitigate the impact of queue synchronization during maintenance windows by keeping queues short. Cluster deployment 166 Amazon MQ Developer Guide The default policy should not be deleted. If you do delete this policy, Amazon MQ will automatically recreate it. Amazon MQ will also ensure that HA properties are applied to all other policies that you create on a clustered broker. If you add a policy without the HA properties, Amazon MQ will add them for you. If you add a policy with diﬀerent high availability properties, Amazon MQ will replace them. For more information about classic mirroring, see Classic mirrored queues. The following diagram illustrates a RabbitMQ cluster broker deployment with three nodes in three Availability Zones (AZ), each with its own Amazon EBS volume and a shared state. Amazon EBS provides block level storage optimized for low-latency and high throughput. Cluster deployment 167 Amazon MQ Developer Guide Amazon MQ for RabbitMQ broker instance types The combined description of the broker instance class (m5, t3) and size (large, micro) is called the broker instance type (for example, mq.m5.large). The following table lists the available Amazon MQ broker instance types for RabbitMQ brokers. Amazon MQ provides at least a 90 day notice before an instance type reaches end of support. We recommend upgrading your broker to a new instance type before the end-of-support date to prevent any disruptions. Important You cannot downgrade a broker from an mq.m5. instance type to a mq.t3.micro instance type. Instance Type vCPU Memory (GiB) Recommend ed use Storage End of support mq.t3.mic 2 1 Evaluation EBS ro Important The mq.t3.mic ro instance type does not support cluster deploymen t. mq.m5.lar 2 8 Production EBS ge Instance types 168 Amazon MQ Instance Type vCPU Memory (GiB) Recommend ed use Storage End of support Developer Guide mq.m5.xla rge mq.m5.2xl arge 4 8 mq.m5.4xl 16 arge 16 32 64 Production EBS Production EBS Production EBS Amazon MQ for RabbitMQ broker conﬁgurations A conﬁguration contains all of the settings for your RabbitMQ broker in Cuttleﬁsh format. You can create a conﬁguration before creating any brokers. You can then apply the conﬁguration to one or more brokers. Attributes A broker conﬁguration 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:c-1234a5b6-78cd-901e-2fgh-3i45j6k178l9) For a full list of conﬁguration attributes, see the following in the Amazon MQ REST API Reference: • REST Operation ID: Conﬁguration • REST Operation ID: Conﬁgurations For a full list of conﬁguration revision attributes, see the following: • REST Operation ID: Conﬁguration Revision • REST Operation ID: Conﬁguration Revisions Broker conﬁgurations 169 Amazon MQ Topics • Creating and applying RabbitMQ broker conﬁgurations • Edit a Amazon MQ for RabbitMQ Conﬁguration Revision • Conﬁgurable values for RabbitMQ on Amazon MQ Developer Guide
amazon-mq-dg-046	amazon-mq-dg.pdf	46	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:c-1234a5b6-78cd-901e-2fgh-3i45j6k178l9) For a full list of conﬁguration attributes, see the following in the Amazon MQ REST API Reference: • REST Operation ID: Conﬁguration • REST Operation ID: Conﬁgurations For a full list of conﬁguration revision attributes, see the following: • REST Operation ID: Conﬁguration Revision • REST Operation ID: Conﬁguration Revisions Broker conﬁgurations 169 Amazon MQ Topics • Creating and applying RabbitMQ broker conﬁgurations • Edit a Amazon MQ for RabbitMQ Conﬁguration Revision • Conﬁgurable values for RabbitMQ on Amazon MQ Developer Guide Creating and applying RabbitMQ broker conﬁgurations A conﬁguration contains all of the settings for your RabbitMQ broker in Cuttleﬁsh format. You can create a conﬁguration before creating any brokers. You can then apply the conﬁguration to one or more brokers The following examples show how you can create and apply a RabbitMQ broker conﬁguration using the AWS Management Console. Important You can only delete a conﬁguration using the DeleteConfiguration API. For more information, see Conﬁgurations in the Amazon MQ API Reference. Create a New Conﬁguration To apply a conﬁguration to your broker, you must ﬁrst create the conﬁguration. 1. Sign in to the Amazon MQ console. 2. On the left, expand the navigation panel and choose Conﬁgurations. 3. On the Conﬁgurations page, choose Create conﬁguration. 4. On the Create conﬁguration page, in the Details section, type the Conﬁguration name (for example, MyConfiguration) and select a Broker engine version. To learn more about RabbitMQ engine versions supported by Amazon MQ for RabbitMQ, see the section called “Version management”. Creating a conﬁguration 170 Amazon MQ Developer Guide 5. Choose Create conﬁguration. Create a New Conﬁguration Revision After you create a conﬁguration, you must edit the conﬁguration using a conﬁguration revision. 1. From the conﬁguration list, choose MyConfiguration. Note The ﬁrst conﬁguration revision is always created for you when Amazon MQ creates the conﬁguration. On the MyConfiguration page, the broker engine type and version that your new conﬁguration revision uses (for example, RabbitMQ 3.xx.xx) are displayed. 2. On the Conﬁguration details tab, the conﬁguration revision number, description, and broker conﬁguration in Cuttleﬁsh format are displayed. Note Editing the current conﬁguration creates a new conﬁguration revision. 3. Choose Edit conﬁguration and make changes to the Cuttleﬁsh conﬁguration. 4. Choose Save. The Save revision dialog box is displayed. 5. (Optional) Type A description of the changes in this revision. 6. Choose Save. The new revision of the conﬁguration is saved. Important Making changes to a conﬁguration does not apply the changes to the broker immediately. To apply your changes, you must wait for the next maintenance window or reboot the broker. Creating a conﬁguration 171 Amazon MQ Developer Guide Currently, you can't delete a conﬁguration. Apply a Conﬁguration Revision to Your Broker After creating the conﬁguration revision, you can apply the conﬁguration revision to your broker. 1. On the left, expand the navigation panel and choose Brokers. 2. From the broker list, select your broker (for example, MyBroker) and then choose Edit. 3. On the Edit MyBroker page, in the Conﬁguration section, select a Conﬁguration and a Revision and then choose Schedule Modiﬁcations. 4. In the Schedule broker modiﬁcations section, choose whether to apply modiﬁcations During the next scheduled maintenance window or Immediately. Important Single instance brokers are oﬄine while being rebooted. For cluster brokers, only one node is down at a time while the broker reboots. 5. Choose Apply. Your conﬁguration revision is applied to your broker at the speciﬁed time. Edit a Amazon MQ for RabbitMQ Conﬁguration Revision The following instructions describe how to edit a conﬁguration revision for your broker. 1. 2. Sign in to the Amazon MQ console. From the broker list, select your broker (for example, MyBroker) and then choose Edit. 3. On the MyBroker page, choose Edit. Editing a conﬁguration revision 172 Amazon MQ Developer Guide 4. On the Edit MyBroker page, in the Conﬁguration section, select a Conﬁguration and a Revision and then choose Edit. Note Unless you select a conﬁguration when you create a broker, the ﬁrst conﬁguration revision is always created for you when Amazon MQ creates the broker. On the MyBroker page, the broker engine type and version that the conﬁguration uses (for example, RabbitMQ 3.xx.xx) are displayed. 5. On the Conﬁguration details tab, the conﬁguration revision number, description, and broker conﬁguration in Cuttleﬁsh format are displayed. Note Editing the current conﬁguration creates a new conﬁguration revision. 6. Choose Edit conﬁguration and make changes to the Cuttleﬁsh conﬁguration. 7. Choose Save. The Save revision dialog box is displayed. 8. (Optional) Type A description of the changes in this revision. 9. Choose Save. The new revision of the conﬁguration is saved. Important Making changes to a conﬁguration does not apply the changes to the broker immediately.
amazon-mq-dg-047	amazon-mq-dg.pdf	47	type and version that the conﬁguration uses (for example, RabbitMQ 3.xx.xx) are displayed. 5. On the Conﬁguration details tab, the conﬁguration revision number, description, and broker conﬁguration in Cuttleﬁsh format are displayed. Note Editing the current conﬁguration creates a new conﬁguration revision. 6. Choose Edit conﬁguration and make changes to the Cuttleﬁsh conﬁguration. 7. Choose Save. The Save revision dialog box is displayed. 8. (Optional) Type A description of the changes in this revision. 9. Choose Save. The new revision of the conﬁguration is saved. Important Making changes to a conﬁguration does not apply the changes to the broker immediately. To apply your changes, you must wait for the next maintenance window or reboot the broker. Currently, you can't delete a conﬁguration. Editing a conﬁguration revision 173 Amazon MQ Developer Guide Conﬁgurable values for RabbitMQ on Amazon MQ You can set the value of the following broker conﬁguration options by modifying the broker conﬁguration ﬁle in the AWS Management Console. Conﬁgura tion Default Value Recommend ed Value Values consumer_ timeout 1800000 ms (30 minutes) 1800000 ms (30 minutes) 0 to 2,147,483 Applicable Versions All versions ,647 milisecon ds. Amazon MQ supports the value 0, which means "inﬁnite". 60 to 3600 seconds All versions heartbeat 60 seconds 60 seconds true true true, false 3.11 and above managemen t.restric tions.ope rator _policy_c hanges.di sabled Description A timeout on consumer delivery acknowled gement to detect when consumers do not ack deliveries. Deﬁnes the time before a connection is considere d unavailable by RabbitMQ. Turns oﬀ making changes to the operator policies. If you make this change, you are highly encourage d to include the HA Conﬁguration values 174 Amazon MQ Developer Guide Conﬁgura tion Default Value Recommend ed Value Values Applicable Versions Description properties in your own operator policies. When set to TRUE, your applicati on avoids a channel exception when redeclaring a quorum queue. Turns on unmodiﬁa ble HTTP security headers. true true true, false 3.13 and above quorum_qu eue.prope rty_equiv alence.re laxed _checks_o n_redecla ration secure.ma nagement. http.head true for brokers on 3.10 created ers.enabled on or after true true or false 3.10 and above July 9, 2024. false for brokers created before July 9, 2024 Conﬁguring consumer delivery acknowledgement You can conﬁgure consumer_timeout to detect when consumers do not ack deliveries. If the consumer does not send an acknowledgment within the timeout value, the channel will be closed. For example, if you are using the default value 1800000 milliseconds, if the consumer does not send a delivery acknowledgement within 1800000 milliseconds, the channel will be closed. Conﬁguration values 175 Amazon MQ Conﬁguring heartbeat Developer Guide You can conﬁgure a heartbeat timeout to ﬁnd out when connections are disrupted or have failed. The heartbeat value deﬁnes the time limit before a connection is considered down. Conﬁguring operator policies The default operator policy on each virtual host has the following recommended HA properties: { "name": "default_operator_policy_AWS_managed", "pattern": ".*", "apply-to": "all", "priority": 0, "definition": { "ha-mode": "all", "ha-sync-mode": "automatic" } } Changes to the operator policies via the AWS Management Console or Management API are not available by default. You can enable changes by adding the following line to the broker conﬁguration: management.restrictions.operator_policy_changes.disabled=false If you make this change, you are highly encouraged to include the HA properties in your own operator policies. Conﬁguring relaxed checks on queue declaration If you have migrated your classic queues to quorum queues but not updated your client code, you can avoid a channel exception when redeclaring a quorum queue by conﬁguring quorum_queue.property_equivalence.relaxed_checks_on_redeclaration set to true. Conﬁguring HTTP security headers The secure.management.http.headers.enabled conﬁguration enables the following HTTP security headers: Conﬁguration values 176 Amazon MQ Developer Guide • X-Content-Type-Options: nosniﬀ: prevents browsers from performing content sniﬃng, algorithms that are used to deduce the ﬁle format of websites. • X-Frame-Options: DENY: prevents others from embedding the management plugin into a frame on their own website to deceive others • Strict-Transport-Security: max-age=47304000; includeSubDomains: enforces browsers to use HTTPS when making subsequent connections to the website and its subdomains for a long period of time (1.5 years). Amazon MQ for RabbitMQ brokers created on versions 3.10 and above will have secure.management.http.headers.enabled set to true by default. You can turn on these HTTP security headers by setting secure.management.http.headers.enabled to true. If you wish to opt out of these HTTP security headers, set secure.management.http.headers.enabled to false. Quorum queues for RabbitMQ on Amazon MQ Important Quorum queues are only available for brokers on Amazon MQ for RabbitMQ version 3.13 and above. Quorum queues are a replicated queue type made up of a leader (primary replica) and followers (other replicas). If the leader becomes unavailable, quorum queues uses the Raft consensus algorithm to elect a new leader node by majority of votes, and the previous leader is demoted to a follower node in the same cluster.
amazon-mq-dg-048	amazon-mq-dg.pdf	48	security headers by setting secure.management.http.headers.enabled to true. If you wish to opt out of these HTTP security headers, set secure.management.http.headers.enabled to false. Quorum queues for RabbitMQ on Amazon MQ Important Quorum queues are only available for brokers on Amazon MQ for RabbitMQ version 3.13 and above. Quorum queues are a replicated queue type made up of a leader (primary replica) and followers (other replicas). If the leader becomes unavailable, quorum queues uses the Raft consensus algorithm to elect a new leader node by majority of votes, and the previous leader is demoted to a follower node in the same cluster. The remaining followers continue replicating as before. Because each node is in a diﬀerent availability zone, if one node is temporarily unavailable, message delivery continues with the newly elected leader replica in another availability zone. Quorum queues are useful for handling poison messages, which occur when a message fails and is requeued multiple times. You should not use quorum queues if you: • use transient queues • have long queue backlogs • prioritize low latency Quorum queues 177 Amazon MQ Developer Guide To declare a quorum queue, set the header x-queue-type to quorum. Topics • Migrating from classic queues to quorum queues on Amazon MQ for RabbitMQ • Policy conﬁgurations for quorum queues for Amazon MQ for RabbitMQ • Best practices for quorum queues for Amazon MQ for RabbitMQ Migrating from classic queues to quorum queues on Amazon MQ for RabbitMQ You can migrate your classic mirrored queues to quorum queues on Amazon MQ brokers on version 3.13 or above by creating a new virtual host on the same cluster, or by migrating in place. Option 1: Migrating from classic mirrored queues to quorum queues with a new virtual host You can migrate your classic mirrored queues to quorum queues on Amazon MQ brokers on version 3.13 or above by creating a new virtual host on the same cluster. 1. In your existing cluster, create a new virtual host (vhost) with the default queue type as quorum. 2. Create the Federation plugin from the new vhost with the URI pointing to the old vhost using classic mirrored queues. 3. Using rabbitmqadmin, export the deﬁnitions from the old vhost to a new ﬁle. You must make changes to the schema ﬁle so it is compatible with quorum queues. For the full list of changes you need to make to the ﬁle, see Moving deﬁnitions in the RabbitMQ quorum queues documentation. After applying the necessary changes to the ﬁle, reimport the deﬁnitions to the new vhost. 4. Create a new policy in the new vhost. For recommendations on Amazon MQ policy conﬁgurations for quorum queues, see Policy conﬁgurations for quorum queues for Amazon MQ for RabbitMQ . Then, start the Federation you created earlier from the old vhost to the new vhost. 5. Point consumers and producers to the new vhost. 6. Conﬁgure the Shovel plug in to move any remaining messages. Once a queue is empty, delete the Shovel. Migrating to quorum queues 178 Amazon MQ Developer Guide Migrating from classic mirrored queues to quorum queues in place You can migrate your classic mirrored queues to quorum queues on Amazon MQ brokers on version 3.13 or above by migrating in place. 1. Stop the consumers and producers. 2. Create a new temporary quorum queue. 3. Conﬁgure the Shovel plug in to move any messages from the old classic mirrored queue to the new temporary quorum queue. After all messages are moved to the temporary quorum queue, delete the Shovel. 4. Delete the source classic mirrored queue. Then, recreate a quorum queue with the same name and bindings as the source classic mirrored queue. 5. Create a new Shovel to move the messages from the temporary quorum queue to the new quorum queue. Policy conﬁgurations for quorum queues for Amazon MQ for RabbitMQ You can add speciﬁc policy conﬁgurations to quorum queues for your RabbitMQ broker on Amazon MQ. When you create a policy for quorum queues, you must do the following: • Remove all policy attributes that start with ha, such as ha-mode, ha-params, ha-sync-mode, ha-sync-batch-size, ha-promote-on-shutdown, and ha-promote-on-failure. • Remove queue-mode. • Change overﬂow when it is set to reject-publish-dlx Important Amazon MQ for RabbitMQ applies all or none of the attributes within a policy. You cannot create a policy that applies to both classic mirrored queues and quorum queues. If you want your policy to only apply to quorum queues, you must set --apply-to to quorum_queues. If you are using classic mirrored queues and quorum queues, you must create a separate policy with --apply-to:classic_queues as well as a quorum queues policy. Policy conﬁguration 179 Amazon MQ Developer Guide You do not need to modify AWS-DEFAULT policies because they automatically adopt the new queue type in the “applies to” parameter.
amazon-mq-dg-049	amazon-mq-dg.pdf	49	Important Amazon MQ for RabbitMQ applies all or none of the attributes within a policy. You cannot create a policy that applies to both classic mirrored queues and quorum queues. If you want your policy to only apply to quorum queues, you must set --apply-to to quorum_queues. If you are using classic mirrored queues and quorum queues, you must create a separate policy with --apply-to:classic_queues as well as a quorum queues policy. Policy conﬁguration 179 Amazon MQ Developer Guide You do not need to modify AWS-DEFAULT policies because they automatically adopt the new queue type in the “applies to” parameter. For more information on default policies for Amazon MQ for RabbitMQ, see RabbitMQ conﬁguration policies. Best practices for quorum queues for Amazon MQ for RabbitMQ We recommend using the following best practices to improve performance when working with quorum queues. Handling poison messages by setting a delivery limit Poison messages occur when a message fails and is redelivered multiple times. You can set a message delivery limit using the delivery-limit policy argument to drop messages that are redelivered multiple times. If a message is redelivered more times than the delivery limit allows, the message is then dropped and deleted by RabbitMQ. When you set a delivery limit, the message is requeued near the head of the queue. Message priority for quorum queues Quorum queues do not have message priority. If you need message priority, you must create multiple quorum queues. For more information on prioritizing messages with multiple quorum queues, see Message priority in the RabbitMQ documentation. Using the default replication factor Amazon MQ for RabbitMQ defaults to a replication factor of three (3) nodes for cluster brokers using quorum queues. If you make changes to x-quorum-initial-group-size, Amazon MQ will default again to the replication factor of 3. Troubleshooting RABBITMQ_QUORUM_QUEUES_NOT_SUPPORTED_ON_CURRENT_VERSION Amazon MQ for RabbitMQ will raise the critical required action code RABBITMQ_QUORUM_QUEUES_NOT_SUPPORTED_ON_CURRENT_VERSION when you attempt to create quorum queues on a single instance or cluster broker using version 3.12 and below. For more information on troubleshooting RABBITMQ_QUORUM_QUEUES_NOT_SUPPORTED_ON_CURRENT_VERSION, see RabbitMQ on Amazon MQ quorum queues alarm. Best practices 180 Amazon MQ RabbitMQ tutorials Developer Guide The following tutorials show how you can conﬁgure and use RabbitMQ on Amazon MQ. To learn more about working with supported client libraries in a variety of programming languages such as Node.js, Python, .NET, and more, see RabbitMQ Tutorials in the RabbitMQ Getting Started Guide. Topics • Editing broker preferences • Using Python Pika with Amazon MQ for RabbitMQ • Resolving RabbitMQ paused queue synchronization • Step 2: Connect a JVM-based application to your broker • Step 3: (Optional) Connect to an AWS Lambda function Editing broker preferences You can edit your broker preferences, such as enabling or disabling CloudWatch logs using the AWS Management Console. Edit RabbitMQ broker options 1. 2. Sign in to the Amazon MQ console. From the broker list, select your broker (for example, MyBroker) and then choose Edit. 3. On the Edit MyBroker page, in the Speciﬁcations section, select a Broker engine version or a Broker Instance type. 4. In the CloudWatch Logs section, click the toggle button to enable or disable general logs. No other steps are required. Note • For RabbitMQ brokers, Amazon MQ automatically uses a Service-Linked Role (SLR) to publish general logs to CloudWatch. For more information, see the section called “Using service-linked roles” • Amazon MQ does not support audit logging for RabbitMQ brokers. RabbitMQ tutorials 181 Amazon MQ Developer Guide 5. In the Maintenance section, conﬁgure your broker's maintenance schedule: To upgrade the broker to new versions as AWS releases them, choose Enable automatic minor version upgrades. Automatic upgrades occur during the maintenance window deﬁned by the day of the week, the time of day (in 24-hour format), and the time zone (UTC by default). 6. Choose Schedule modiﬁcations. 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 speciﬁed time. Using Python Pika with Amazon MQ for RabbitMQ The following tutorial shows how you can set up a Python Pika client with TLS conﬁgured to connect to an Amazon MQ for RabbitMQ broker. Pika is a Python implementation of the AMQP 0-9-1 protocol for RabbitMQ. This tutorial guides you through installing Pika, declaring a queue, setting up a publisher to send messages to the broker's default exchange, and setting up a consumer to recieve messages from the queue. Topics • Prerequisites • Permissions • Step one: Create a basic Python Pika client • Step two: Create a publisher and send a message • Step three: Create a consumer and recieve a message • Step four: (Optional) Set up an event loop and consume messages • What's next? Prerequisites To complete the steps in this
amazon-mq-dg-050	amazon-mq-dg.pdf	50	is a Python implementation of the AMQP 0-9-1 protocol for RabbitMQ. This tutorial guides you through installing Pika, declaring a queue, setting up a publisher to send messages to the broker's default exchange, and setting up a consumer to recieve messages from the queue. Topics • Prerequisites • Permissions • Step one: Create a basic Python Pika client • Step two: Create a publisher and send a message • Step three: Create a consumer and recieve a message • Step four: (Optional) Set up an event loop and consume messages • What's next? Prerequisites To complete the steps in this tutorial, you need the following prerequisites: Using Python Pika with Amazon MQ for RabbitMQ 182 Amazon MQ Developer Guide • An Amazon MQ for RabbitMQ broker. For more information, see Creating an Amazon MQ for RabbitMQ broker. • Python 3 installed for your operating system. • Pika installed using Python pip. To install Pika, open a new terminal window and run the following. $ python3 -m pip install pika Permissions For this tutorial, you need at least one Amazon MQ for RabbitMQ broker user with permission to write to, and read from, a vhost. The following table describes the neccessary minimum permissions as regular expression (regexp) patterns. Tags none Conﬁgure regexp Write regexp Read regexp .* .* The user permissions listed provide only read and write permissions to the user, without granting access to the management plugin to perform administrative operations on the broker. You can further restrict permissions by providing regexp patterns that limit the user's access to speciﬁed queues. For example, if you change the read regexp pattern to ^[hello world].*, the user will only have permission to read from queues that start with hello world. For more information about creating RabbitMQ users and managing user tags and permissions, see Amazon MQ for RabbitMQ broker users. Step one: Create a basic Python Pika client To create a Python Pika client base class that deﬁnes a constructor and provides the SSL context necessary for TLS conﬁguration when interacting with an Amazon MQ for RabbitMQ broker, do the following. 1. Open a new terminal window, create a new directory for your project, and navigate to the directory. $ mkdir pika-tutorial Using Python Pika with Amazon MQ for RabbitMQ 183 Amazon MQ $ cd pika-tutorial Developer Guide 2. Create a new ﬁle, basicClient.py, that contains the following Python code. import ssl import pika class BasicPikaClient: def __init__(self, rabbitmq_broker_id, rabbitmq_user, rabbitmq_password, region): # SSL Context for TLS configuration of Amazon MQ for RabbitMQ ssl_context = ssl.SSLContext(ssl.PROTOCOL_TLSv1_2) ssl_context.set_ciphers('ECDHE+AESGCM:!ECDSA') url = f"amqps://{rabbitmq_user}: {rabbitmq_password}@{rabbitmq_broker_id}.mq.{region}.amazonaws.com:5671" parameters = pika.URLParameters(url) parameters.ssl_options = pika.SSLOptions(context=ssl_context) self.connection = pika.BlockingConnection(parameters) self.channel = self.connection.channel() You can now deﬁne additional classes for your publisher and consumer that inherit from BasicPikaClient. Step two: Create a publisher and send a message To create a publisher that declares a queue, and sends a single message, do the following. 1. Copy the contents of the following code sample, and save locally as publisher.py in the same directory you created in the previous step. from basicClient import BasicPikaClient class BasicMessageSender(BasicPikaClient): def declare_queue(self, queue_name): print(f"Trying to declare queue({queue_name})...") self.channel.queue_declare(queue=queue_name) Using Python Pika with Amazon MQ for RabbitMQ 184 Amazon MQ Developer Guide def send_message(self, exchange, routing_key, body): channel = self.connection.channel() channel.basic_publish(exchange=exchange, routing_key=routing_key, body=body) print(f"Sent message. Exchange: {exchange}, Routing Key: {routing_key}, Body: {body}") def close(self): self.channel.close() self.connection.close() if __name__ == "__main__": # Initialize Basic Message Sender which creates a connection # and channel for sending messages. basic_message_sender = BasicMessageSender( "<broker-id>", "<username>", "<password>", "<region>" ) # Declare a queue basic_message_sender.declare_queue("hello world queue") # Send a message to the queue. basic_message_sender.send_message(exchange="", routing_key="hello world queue", body=b'Hello World!') # Close connections. basic_message_sender.close() The BasicMessageSender class inherits from BasicPikaClient and implements additional methods for delaring a queue, sending a message to the queue, and closing connections. The code sample routes a message to the default exchange, with a routing key equal to the name of the queue. 2. Under if __name__ == "__main__":, replace the parameters passed to the BasicMessageSender constructor statement with the following information. • <broker-id> – The unique ID that Amazon MQ generates for the broker. You can parse the ID from your broker ARN. For example, given the following ARN, arn:aws:mq:us- Using Python Pika with Amazon MQ for RabbitMQ 185 Amazon MQ Developer Guide east-2:123456789012:broker:MyBroker:b-1234a5b6-78cd-901e-2fgh-3i45j6k178l9, the broker ID would be b-1234a5b6-78cd-901e-2fgh-3i45j6k178l9. • <username> – The username for a broker user with suﬃcient permissions to write messages to the broker. • <password> – The password for a broker user with suﬃcient permissions to write messages to the broker. • <region> – The AWS region in which you created your Amazon MQ for RabbitMQ broker. For example, us-west-2. 3. Run the following command in the same directory you created publisher.py. $ python3 publisher.py If the code runs successfully, you will see the following output
amazon-mq-dg-051	amazon-mq-dg.pdf	51	Python Pika with Amazon MQ for RabbitMQ 185 Amazon MQ Developer Guide east-2:123456789012:broker:MyBroker:b-1234a5b6-78cd-901e-2fgh-3i45j6k178l9, the broker ID would be b-1234a5b6-78cd-901e-2fgh-3i45j6k178l9. • <username> – The username for a broker user with suﬃcient permissions to write messages to the broker. • <password> – The password for a broker user with suﬃcient permissions to write messages to the broker. • <region> – The AWS region in which you created your Amazon MQ for RabbitMQ broker. For example, us-west-2. 3. Run the following command in the same directory you created publisher.py. $ python3 publisher.py If the code runs successfully, you will see the following output in your terminal window. Trying to declare queue(hello world queue)... Sent message. Exchange: , Routing Key: hello world queue, Body: b'Hello World!' Step three: Create a consumer and recieve a message To create a consumer that recieves a single message from the queue, do the following. 1. Copy the contents of the following code sample, and save locally as consumer.py in the same directory. from basicClient import BasicPikaClient class BasicMessageReceiver(BasicPikaClient): def get_message(self, queue): method_frame, header_frame, body = self.channel.basic_get(queue) if method_frame: print(method_frame, header_frame, body) self.channel.basic_ack(method_frame.delivery_tag) return method_frame, header_frame, body else: print('No message returned') def close(self): Using Python Pika with Amazon MQ for RabbitMQ 186 Amazon MQ Developer Guide self.channel.close() self.connection.close() if __name__ == "__main__": # Create Basic Message Receiver which creates a connection # and channel for consuming messages. basic_message_receiver = BasicMessageReceiver( "<broker-id>", "<username>", "<password>", "<region>" ) # Consume the message that was sent. basic_message_receiver.get_message("hello world queue") # Close connections. basic_message_receiver.close() Similar to the the publisher you created in the previous step, BasicMessageReciever inherits from BasicPikaClient and implements additional methods for recieving a single message, and closing connections. 2. Under the if __name__ == "__main__": statement, replace the parameters passed to the BasicMessageReciever constructor with your information. 3. Run the following command in your project directory. $ python3 consumer.py If the code runs successfully, you will see the message body, and headers including the routing key, displayed in your terminal window. <Basic.GetOk(['delivery_tag=1', 'exchange=', 'message_count=0', 'redelivered=False', 'routing_key=hello world queue'])> <BasicProperties> b'Hello World!' Using Python Pika with Amazon MQ for RabbitMQ 187 Amazon MQ Developer Guide Step four: (Optional) Set up an event loop and consume messages To consume multiple messages from a queue, use Pika's basic_consume method and a callback function as shown in the following 1. In consumer.py, add the following method deﬁnition to the BasicMessageReceiver class. def consume_messages(self, queue): def callback(ch, method, properties, body): print(" [x] Received %r" % body) self.channel.basic_consume(queue=queue, on_message_callback=callback, auto_ack=True) print(' [] Waiting for messages. To exit press CTRL+C') self.channel.start_consuming() 2. In consumer.py, under if __name__ == "__main__":, invoke the consume_messages method you deﬁned in the previous step. if __name__ == "__main__": # Create Basic Message Receiver which creates a connection and channel for consuming messages. basic_message_receiver = BasicMessageReceiver( "<broker-id>", "<username>", "<password>", "<region>" ) # Consume the message that was sent. # basic_message_receiver.get_message("hello world queue") # Consume multiple messages in an event loop. basic_message_receiver.consume_messages("hello world queue") # Close connections. basic_message_receiver.close() 3. Run consumer.py again, and if successful, the queued messages will be displayed in your terminal window. Using Python Pika with Amazon MQ for RabbitMQ 188 Amazon MQ Developer Guide [] Waiting for messages. To exit press CTRL+C [x] Received b'Hello World!' [x] Received b'Hello World!' ... What's next? • For more information about other supported RabbitMQ client libraries, see RabbitMQ Client Documentation on the RabbitMQ website. Resolving RabbitMQ paused queue synchronization In an Amazon MQ for RabbitMQ cluster deployment, messages published to each queue are replicated across three broker nodes. This replication, referred to as mirroring, provides high availability (HA) for RabbitMQ brokers. Queues in a cluster deployment consist of a main replica on one node and one or more mirrors. Every operation applied to a mirrored queue, including enqueuing messages, is ﬁrst applied to the main queue and then replicated across its mirrors. For example, consider a mirrored queue replicated across three nodes: the main node (main) and two mirrors (mirror-1 and mirror-2). If all messages in this mirrored queue are successfully propagated to all mirrors, then the queue is synchronized. If a node (mirror-1) becomes unavailable for an interval of time, the queue is still operational and can continue to enqueue messages. However, for the queue to synchronize, messages published to main while mirror-1 is unavailable must be replicated to mirror-1. For more information about mirroring, see Classic Mirrored Queues on the RabbitMQ website. Maintenance and queue synchronization During maintenance windows, Amazon MQ performs all maintenance work one node at a time to ensure that the broker remains operational. As a result, queues might need to synchronize as each node resumes operation. During synchronization, messages that need to be replicated to mirrors are loaded into memory from the corresponding Amazon Elastic Block Store (Amazon EBS) volume to be processed in batches. Processing messages in
amazon-mq-dg-052	amazon-mq-dg.pdf	52	the queue to synchronize, messages published to main while mirror-1 is unavailable must be replicated to mirror-1. For more information about mirroring, see Classic Mirrored Queues on the RabbitMQ website. Maintenance and queue synchronization During maintenance windows, Amazon MQ performs all maintenance work one node at a time to ensure that the broker remains operational. As a result, queues might need to synchronize as each node resumes operation. During synchronization, messages that need to be replicated to mirrors are loaded into memory from the corresponding Amazon Elastic Block Store (Amazon EBS) volume to be processed in batches. Processing messages in batches lets queues synchronize faster. If queues are kept short and messages are small, the queues successfully synchronize and resume operation as expected. However, if the amount of data in a batch approaches the node's memory Resolving paused queue sync 189 Amazon MQ Developer Guide limit, the node raises a high memory alarm, pausing the queue sync. You can conﬁrm memory usage by comparing the RabbitMemUsed and RabbitMqMemLimit broker node metrics in CloudWatch. Synchronization can't complete until messages are consumed or deleted, or the number of messages in the batch is reduced. Note Reducing the queue synchronization batch size can result in a higher number of replication transactions. To resolve a paused queue synchronization, follow the steps in this tutorial, which demonstrates applying an ha-sync-batch-size policy and restarting the queue sync. Topics • Prerequisites • Step 1: Apply an ha-sync-batch-size policy • Step 2: Restart the queue sync • Next steps • Related resources Prerequisites For this tutorial, you must have an Amazon MQ for RabbitMQ broker user with administrator permissions. You can use the administrator user created when you ﬁrst created the broker, or another user that you might have created afterwards. The following table provides the necessary administrator user tag and permissions as regular expression (regexp) patterns. Tags Read regexp Conﬁgure regexp Write regexp administrator .* .* .* For more information about creating RabbitMQ users and managing user tags and permissions, see Amazon MQ for RabbitMQ broker users. Resolving paused queue sync 190 Amazon MQ Developer Guide Step 1: Apply an ha-sync-batch-size policy The following procedures demonstrate adding a policy that applies to all queues created on the broker. You can use the RabbitMQ web console or the RabbitMQ management API. For more information, see Management Plugin on the RabbitMQ website. To apply an ha-sync-batch-size policy using the RabbitMQ web console 1. 2. 3. Sign in to the Amazon MQ console. In the left navigation pane, choose Brokers. From the list of brokers, choose the name of the broker to which you want to apply the new policy. 4. On the broker's page, in the Connections section, choose the RabbitMQ web console URL. The RabbitMQ web console opens in a new browser tab or window. 5. 6. Log in to the RabbitMQ web console with your broker administrator sign-in credentials. In the RabbitMQ web console, at the top of the page, choose Admin. 7. On the Admin page, in the right navigation pane, choose Policies. 8. On the Policies page, you can see a list of the broker's current User policies. Below User policies, expand Add / update a policy. Note By default, Amazon MQ for RabbitMQ clusters are created with an initial broker policy named ha-all-AWS-OWNED-DO-NOT-DELETE. Amazon MQ manages this policy to ensure that every queue on the broker is replicated to all three nodes and that queues are synchronized automatically. 9. To create a new broker policy, under Add / update a policy, do the following: a. b. c. d. For Name, enter a name for your policy, for example, batch-size-policy. For Pattern, enter the regexp pattern .* so that the policy matches all queues on the broker. For Apply to, choose Exchanges and queues from the dropdown list. For Priority, enter an integer greater than all other policies in applied to the vhost. You can apply exactly one set of policy deﬁnitions to RabbitMQ queues and exchanges at any given time. RabbitMQ chooses the matching policy with the highest priority value. For Resolving paused queue sync 191 Amazon MQ Developer Guide more information about policy priorities and how to combine policies, see Policies in the RabbitMQ Server Documentation. e. For Deﬁnition, add the following key-value pairs: • ha-sync-batch-size=100. Choose Number from the dropdown list. Note You might need to adjust and calibrate the value of ha-sync-batch-size based on the number and size of unsynchronized messages in your queues. • ha-mode=all. Choose String from the dropdown list. Important The ha-mode deﬁnition is required for all HA-related policies. Omitting it results in a validation failure. • ha-sync-mode=automatic. Choose String from the dropdown list. Note The ha-sync-mode deﬁnition is required for all custom policies. If it is omitted, Amazon MQ automatically appends the deﬁnition. f. Choose Add /
amazon-mq-dg-053	amazon-mq-dg.pdf	53	RabbitMQ Server Documentation. e. For Deﬁnition, add the following key-value pairs: • ha-sync-batch-size=100. Choose Number from the dropdown list. Note You might need to adjust and calibrate the value of ha-sync-batch-size based on the number and size of unsynchronized messages in your queues. • ha-mode=all. Choose String from the dropdown list. Important The ha-mode deﬁnition is required for all HA-related policies. Omitting it results in a validation failure. • ha-sync-mode=automatic. Choose String from the dropdown list. Note The ha-sync-mode deﬁnition is required for all custom policies. If it is omitted, Amazon MQ automatically appends the deﬁnition. f. Choose Add / update policy. 10. Conﬁrm that the new policy appears in the list of User policies. To apply an ha-sync-batch-size policy using the RabbitMQ management API 1. 2. 3. Sign in to the Amazon MQ console. In the left navigation pane, choose Brokers. From the list of brokers, choose the name of the broker to which you want to apply the new policy. 4. On the broker's page, in the Connections section, note the RabbitMQ web console URL. This is the broker endpoint that you use in an HTTP request. 5. Open a new terminal or command line window of your choice. Resolving paused queue sync 192 Amazon MQ Developer Guide 6. To create a new broker policy, enter the following curl command. This command assumes a queue on the default / vhost, which is encoded as %2F. Note Replace username and password with your broker administrator sign-in credentials. You might need to adjust and calibrate the value of ha-sync-batch-size (100) based on the number and size of unsynchronized messages in your queues. Replace the broker endpoint with the URL that you noted previously. curl -i -u username:password -H "content-type:application/json" -XPUT \ -d '{"pattern":".*", "priority":1, "definition":{"ha-sync-batch-size":100, "ha- mode":"all", "ha-sync-mode":"automatic"}}' \ https://b-589c045f-f8ln-4ab0-a89c-co62e1c32ef8.mq.us-west-2.amazonaws.com/api/ policies/%2F/batch-size-policy 7. To conﬁrm that the new policy is added to your broker's user policies, enter the following curl command to list all broker policies. curl -i -u username:password https://b-589c045f-f8ln-4ab0-a89c-co62e1c32ef8.mq.us- west-2.amazonaws.com/api/policies Step 2: Restart the queue sync After applying a new ha-sync-batch-size policy to your broker, restart the queue sync. To restart the queue sync using the RabbitMQ web console Note To open the RabbitMQ web console, see the previous instructions in Step 1 of this tutorial. 1. In the RabbitMQ web console, at the top of the page, choose Queues. Resolving paused queue sync 193 Amazon MQ Developer Guide 2. On the Queues page, under All queues, locate your paused queue. In the Policy row, your queue should list the name of the new policy that you created (for example, batch-size- policy). 3. To restart the synchronization process with a reduced batch size, ﬁrst cancel queue sync. Then restart the queue sync. Note If synchronization pauses and doesn't ﬁnish successfully, try reducing the ha-sync- batch-size value and restarting the queue sync again. Next steps • Once your queue synchronizes successfully, you can monitor the amount of memory that your RabbitMQ nodes use by viewing the Amazon CloudWatch metric RabbitMQMemUsed. You can also view the RabbitMQMemLimit metric to monitor a node's memory limit. For more information, see Accessing CloudWatch metrics for Amazon MQ and Available CloudWatch metrics for Amazon MQ for RabbitMQ brokers. • To prevent paused queue synchronization, we recommend keeping queues short and processing messages. For workloads with larger message sizes, we also recommend upgrading your broker instance type to a larger instance size with more memory. For more information about broker instance types and editing broker preferences, see Editing broker preferences. • When you create a new Amazon MQ for RabbitMQ broker, Amazon MQ applies a set of default policies and virtual host limits to optimize broker performance. If your broker does not have the recommended default policies and limits, we recommend creating them yourself. For more information about creating default policies and vhost limits, see the section called “Broker defaults”. Related resources • UpdateBrokerInput – Use this broker property to update a broker instance type using the Amazon MQ API. • Parameters and Policies (RabbitMQ Server Documentation) – Learn more about RabbitMQ parameters and policies on the RabbitMQ website. Resolving paused queue sync 194 Amazon MQ Developer Guide • RabbitMQ Management HTTP API – Learn more about the RabbitMQ management API. Step 2: Connect a JVM-based application to your broker After you create a RabbitMQ broker, you can connect your application to it. The following examples show how you can use the RabbitMQ Java client library to create a connection to your broker, create a queue, and send a message. You can connect to RabbitMQ brokers using supported RabbitMQ client libraries for a variety of languages. For more information about supported RabbitMQ client libraries, see RabbitMQ client libraries and developer tools. Prerequisites Note The following prerequisite steps are only applicable to RabbitMQ brokers created without public
amazon-mq-dg-054	amazon-mq-dg.pdf	54	about the RabbitMQ management API. Step 2: Connect a JVM-based application to your broker After you create a RabbitMQ broker, you can connect your application to it. The following examples show how you can use the RabbitMQ Java client library to create a connection to your broker, create a queue, and send a message. You can connect to RabbitMQ brokers using supported RabbitMQ client libraries for a variety of languages. For more information about supported RabbitMQ client libraries, see RabbitMQ client libraries and developer tools. Prerequisites Note The following prerequisite steps are only applicable to RabbitMQ brokers created without public accessibility. If you are creating a broker with public accessibility you can skip them. Enable VPC attributes 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 in the Amazon VPC User Guide. Enable inbound connections 1. 2. Sign in to the Amazon MQ console. From the broker list, choose the name of your broker (for example, MyBroker). 3. On the MyBroker page, in the Connections section, note the addresses and ports of the broker's web console URL and wire-level protocols. 4. In the Details section, under Security and network, choose the name of your security group or The Security Groups page of the EC2 Dashboard is displayed. 5. From the security group list, choose your security group. 6. At the bottom of the page, choose Inbound, and then choose Edit. Step 2: Connect a JVM-based application to your broker . 195 Amazon MQ Developer Guide 7. In the Edit inbound rules dialog box, add a rule for every URL or endpoint that you want to be publicly accessible (the following example shows how to do this for a broker web console). a. b. c. Choose Add Rule. For Type, select Custom TCP. For Source, leave Custom selected and then type the IP address of the system that you want to be able to access the web console (for example, 192.0.2.1). d. Choose Save. Your broker can now accept inbound connections. Add Java dependencies If you are using Apache Maven for automating builds, add the following dependency to your pom.xml ﬁle. For more information about Project Object Model ﬁles in Apache Maven, see Introduction to the POM. <dependency> <groupId>com.rabbitmq</groupId> <artifactId>amqp-client</artifactId> <version>5.9.0</version> </dependency> If you are using Gradle for automating builds, declare the following dependency. dependencies { compile 'com.rabbitmq:amqp-client:5.9.0' } Import Connection and Channel classes RabbitMQ Java client uses com.rabbitmq.client as its top-level package, with Connection and Channel API classes representing an AMQP 0-9-1 connection and channel, respectively. Import the Connection and Channel classes before using them, as shown in the following example. import com.rabbitmq.client.Connection; import com.rabbitmq.client.Channel; Step 2: Connect a JVM-based application to your broker 196 Amazon MQ Developer Guide Create a ConnectionFactory and connect to your broker Use the following example to create an instance of the ConnectionFactory class with the given parameters. Use the setHost method to conﬁgure the broker endpoint you noted earlier. For AMQPS wire-level connections, use port 5671. ConnectionFactory factory = new ConnectionFactory(); factory.setUsername(username); factory.setPassword(password); //Replace the URL with your information factory.setHost("b-c8352341-ec91-4a78-ad9c-a43f23d325bb.mq.us-west-2.amazonaws.com"); factory.setPort(5671); // Allows client to establish a connection over TLS factory.useSslProtocol(); // Create a connection Connection conn = factory.newConnection(); // Create a channel Channel channel = conn.createChannel(); Publish a message to an exchange You can use Channel.basicPublish to publish messages to an exchange. The following example uses the AMQP Builder class to build a message properties object with content-type plain/text. byte[] messageBodyBytes = "Hello, world!".getBytes(); channel.basicPublish(exchangeName, routingKey, new AMQP.BasicProperties.Builder() .contentType("text/plain") .userId("userId") .build(), messageBodyBytes); Note Note that BasicProperties is an inner class of the autogenerated holder class, AMQP. Step 2: Connect a JVM-based application to your broker 197 Amazon MQ Developer Guide Subscribe to a queue and receive a message You can receive a message by subscribing to a queue using the Consumer interface. Once subscribed, messages will then be delivered automatically as they arrive. The easiest way to implement a Consumer is to use the subclass DefaultConsumer. A DefaultConsumer object can be passed as part of a basicConsume call to set up the subscription as shown in the following example. boolean autoAck = false; channel.basicConsume(queueName, autoAck, "myConsumerTag", new DefaultConsumer(channel) { @Override public void handleDelivery(String consumerTag, Envelope envelope, AMQP.BasicProperties properties, byte[] body) throws IOException { String routingKey = envelope.getRoutingKey(); String contentType = properties.getContentType(); long deliveryTag = envelope.getDeliveryTag(); // (process the message components here ...) channel.basicAck(deliveryTag, false); } }); Note Because we speciﬁed autoAck = false, it is necessary to acknowledge messages delivered to the Consumer, most conveniently done in the handleDelivery method, as shown in the example. Close your connection and disconnect from the broker In order to disconnect from your RabbitMQ broker, close both the channel and connection as shown in the following. channel.close(); conn.close();
amazon-mq-dg-055	amazon-mq-dg.pdf	55	autoAck, "myConsumerTag", new DefaultConsumer(channel) { @Override public void handleDelivery(String consumerTag, Envelope envelope, AMQP.BasicProperties properties, byte[] body) throws IOException { String routingKey = envelope.getRoutingKey(); String contentType = properties.getContentType(); long deliveryTag = envelope.getDeliveryTag(); // (process the message components here ...) channel.basicAck(deliveryTag, false); } }); Note Because we speciﬁed autoAck = false, it is necessary to acknowledge messages delivered to the Consumer, most conveniently done in the handleDelivery method, as shown in the example. Close your connection and disconnect from the broker In order to disconnect from your RabbitMQ broker, close both the channel and connection as shown in the following. channel.close(); conn.close(); Step 2: Connect a JVM-based application to your broker 198 Amazon MQ Note Developer Guide For more information about working with the RabbitMQ Java client library, see the RabbitMQ Java Client API Guide. Step 3: (Optional) Connect to an AWS Lambda function AWS Lambda can connect to and consume messages from your Amazon MQ broker. When you connect a broker to Lambda, you create an event source mapping that reads messages from a queue and invokes the function synchronously. The event source mapping you create reads messages from your broker in batches and converts them into a Lambda payload in the form of a JSON object. To connect your broker to a Lambda function 1. Add the following IAM role permissions to your Lambda function execution role. • mq:DescribeBroker • ec2:CreateNetworkInterface • ec2:DeleteNetworkInterface • ec2:DescribeNetworkInterfaces • ec2:DescribeSecurityGroups • ec2:DescribeSubnets • ec2:DescribeVpcs • logs:CreateLogGroup • logs:CreateLogStream • logs:PutLogEvents • secretsmanager:GetSecretValue Note Without the necessary IAM permissions, your function will not be able to successfully read records from Amazon MQ resources. Step 3: (Optional) Connect to an AWS Lambda function 199 Amazon MQ Developer Guide 2. (Optional) If you have created a broker without public accessibility, you must do one of the following to allow Lambda to connect to your broker: • Conﬁgure one NAT gateway per public subnet. For more information, see Internet and service access for VPC-connected functions in the AWS Lambda Developer Guide. • Create a connection between your Amazon Virtual Private Cloud (Amazon VPC) and Lambda using a VPC endpoint. Your Amazon VPC must also connect to AWS Security Token Service (AWS STS) and Secrets Manager endpoints. For more information, see Conﬁguring interface VPC endpoints for Lambda in the AWS Lambda Developer Guide. 3. Conﬁgure your broker as an event source for a Lambda function using the AWS Management Console. You can also use the create-event-source-mapping AWS Command Line Interface command. 4. Write some code for your Lambda function to process the messages from your consumed from your broker. The Lambda payload that retrieved by your event source mapping depends on the engine type of the broker. The following is an example of a Lambda payload for an Amazon MQ for RabbitMQ queue. Note In the example, test is the name of the queue, and / is the name of the default virtual host. When receiving messages, the event source lists messages under test::/. { "eventSource": "aws:rmq", "eventSourceArn": "arn:aws:mq:us- west-2:112556298976:broker:test:b-9bcfa592-423a-4942-879d-eb284b418fc8", "rmqMessagesByQueue": { "test::/": [ { "basicProperties": { "contentType": "text/plain", "contentEncoding": null, "headers": { "header1": { "bytes": [ 118, 97, 108, Step 3: (Optional) Connect to an AWS Lambda function 200 Amazon MQ Developer Guide 117, 101, 49 ] }, "header2": { "bytes": [ 118, 97, 108, 117, 101, 50 ] }, "numberInHeader": 10 } "deliveryMode": 1, "priority": 34, "correlationId": null, "replyTo": null, "expiration": "60000", "messageId": null, "timestamp": "Jan 1, 1970, 12:33:41 AM", "type": null, "userId": "AIDACKCEVSQ6C2EXAMPLE", "appId": null, "clusterId": null, "bodySize": 80 }, "redelivered": false, "data": "eyJ0aW1lb3V0IjowLCJkYXRhIjoiQ1pybWYwR3c4T3Y0YnFMUXhENEUifQ==" } ] } } For more information about connecting Amazon MQ to Lambda, the options Lambda supports for an Amazon MQ event source, and event source mapping errors, see Using Lambda with Amazon MQ in the AWS Lambda Developer Guide. Step 3: (Optional) Connect to an AWS Lambda function 201 Amazon MQ Developer Guide Managing Amazon MQ for RabbitMQ engine versions RabbitMQ organizes version numbers according to semantic versioning speciﬁcation as X.Y.Z. In Amazon MQ for RabbitMQ implementations, X denotes the major version, Y represents the minor version, and Z denotes the patch version number. Amazon MQ considers a version change to be major if the major version numbers change. For example, upgrading from version 3.13 to 4.0 is considered a major version upgrade. A version change is considered minor if only the minor or patch version number changes. For example, upgrading from version 3.11.28 to 3.12.13 is considered a minor version upgrade. Amazon MQ for RabbitMQ recommends all brokers use the latest supported minor version. For instructions on how to upgrade your broker engine version, see Upgrading an Amazon MQ broker engine version. Important Amazon MQ does not support streams. Creating a stream will result in data loss. Amazon MQ does not support using structured logging in JSON, introduced in
amazon-mq-dg-056	amazon-mq-dg.pdf	56	example, upgrading from version 3.13 to 4.0 is considered a major version upgrade. A version change is considered minor if only the minor or patch version number changes. For example, upgrading from version 3.11.28 to 3.12.13 is considered a minor version upgrade. Amazon MQ for RabbitMQ recommends all brokers use the latest supported minor version. For instructions on how to upgrade your broker engine version, see Upgrading an Amazon MQ broker engine version. Important Amazon MQ does not support streams. Creating a stream will result in data loss. Amazon MQ does not support using structured logging in JSON, introduced in RabbitMQ 3.9 Supported engine versions on Amazon MQ for RabbitMQ The Amazon MQ version support calendar indicates when a broker engine version will reach end of support. When a version reaches end of support, Amazon MQ upgrades all brokers on this version to the next supported version automatically. This upgrade takes place during your broker's scheduled maintenance windows, within the 45 days following the end-of-support date. Amazon MQ provides at least a 90 day notice before a version reaches end of support. We recommend upgrading your broker before the end-of-support date to prevent any disruptions. Additionally, you cannot create new brokers on versions scheduled for end of support within 30 days of the end of support date. RabbitMQ version End of support on Amazon MQ 3.13 (recommended) 3.12 March 17, 2025 Version management 202 Amazon MQ Developer Guide RabbitMQ version End of support on Amazon MQ 3.11 3.10 3.9 February 17, 2025 October 15, 2024 September 16, 2024 When you create a new Amazon MQ for RabbitMQ broker, you can specify any supported RabbitMQ engine version. If you do not specify the engine version number when creating a broker, Amazon MQ automatically defaults to the latest engine version number. Engine version upgrades You can manually upgrade your broker at any time to the next supported major or minor version. When you turn on automatic minor version upgrades, Amazon MQ will upgrade your broker to the latest supported patch version during the maintenance window. For more information about manually upgrading your broker, see the section called “Upgrading the engine version”. For all brokers using engine version 3.13 and above, Amazon MQ manages upgrades to the latest supported patch version during the maintenance window. Important RabbitMQ only allows incremental version updates (ex: 3.9.x to 3.10.x). You cannot skip minor versions when updating (ex: 3.8.x to 3.11.x). Single instance brokers will be oﬄine while being rebooted. For cluster brokers, the mirrored queues must be synced during reboot. With longer queues, the queue-sync process can take longer. During the queue-sync process, the queue is unavailable to consumers and producer. When the queue-sync process is complete, the broker becomes available again. To minimize the impact, we recommend upgrading during a low traﬃc time. For more information on best practices for version upgrades, see Amazon MQ for RabbitMQ best practices. Engine version upgrades 203 Amazon MQ Developer Guide Listing supported engine versions You can list all supported minor and major engine versions by using the describe-broker- instance-options AWS CLI command. aws mq describe-broker-instance-options To ﬁlter the results by engine and instance type use the --engine-type and --host-instance- type options as shown in the following. aws mq describe-broker-instance-options --engine-type engine-type --host-instance- type instance-type For example, to ﬁlter the results for RabbitMQ, and mq.m5.large instance type, replace engine- type with RABBITMQ and instance-type with mq.m5.large. Amazon MQ for RabbitMQ best practices Use this as a reference to quickly ﬁnd recommendations for maximizing performance and minimizing throughput costs when working with RabbitMQ brokers on Amazon MQ. Important Currently, Amazon MQ does not support streams, or using structured logging in JSON, introduced in RabbitMQ 3.9.x. Important Amazon MQ for RabbitMQ does not support the username "guest", and will delete the default guest account when you create a new broker. Amazon MQ will also periodically delete any customer created account called "guest". Topics • Choose the correct broker instance type for the best throughput Listing supported engine versions 204 Amazon MQ • Use multiple channels • Use persistent messages and durable queues • Keep queues short • Conﬁgure publisher conﬁrmation and consumer delivery acknowledgement • Conﬁgure pre-fetching • Use Celery 5.5.0 or later with quorum queues • Automatically recover from network failures Developer Guide Choose the correct broker instance type for the best throughput The message throughput of a broker instance type depends on your application use case. Smaller broker instance types like t3.micro should only be used for testing application performance. Using these micro instances before using larger instances in production can improve application performance and help you keep development costs down. On instance types m5.large and above, you can use cluster deployments for high availability and message durability. Larger broker instance types can handle production levels of clients and
amazon-mq-dg-057	amazon-mq-dg.pdf	57	or later with quorum queues • Automatically recover from network failures Developer Guide Choose the correct broker instance type for the best throughput The message throughput of a broker instance type depends on your application use case. Smaller broker instance types like t3.micro should only be used for testing application performance. Using these micro instances before using larger instances in production can improve application performance and help you keep development costs down. On instance types m5.large and above, you can use cluster deployments for high availability and message durability. Larger broker instance types can handle production levels of clients and queues, high throughput, messages in memory, and redundant messages. For more info on choosing the correct instance type, see the section called “Sizing guidelines”. Use multiple channels To avoid connection churn, use multiple channels over a single connection. Applications should avoid a 1:1 connection to channel ratio. We recommend using one connection per process, and then one channel per thread. Avoid excessive channel usage to prevent channel leaks. Use persistent messages and durable queues Persistent messages can help prevent data loss in situations where a broker crashes or restarts. Persistent messages are written to disk as soon as they arrive. Unlike lazy queues, however, persistent messages are cached both in memory and in disk unless more memory is needed by the broker. In cases where more memory is needed, messages are removed from memory by the RabbitMQ broker mechanism that manages storing messages to disk, commonly referred to as the persistence layer. To enable message persistence, you can declare your queues as durable and set message delivery mode to persistent. The following example demonstrates using the RabbitMQ Java client library Choose the correct broker instance type for the best throughput 205 Amazon MQ Developer Guide to declare a durable queue. When working with AMQP 0-9-1, you can mark messages as persistent by setting delivery mode "2". boolean durable = true; channel.queueDeclare("my_queue", durable, false, false, null); Once you have conﬁgured your queue as durable, you can send a persistent message to your queue by setting MessageProperties to PERSISTENT_TEXT_PLAIN as shown in the following example. import com.rabbitmq.client.MessageProperties; channel.basicPublish("", "my_queue", MessageProperties.PERSISTENT_TEXT_PLAIN, message.getBytes()); Keep queues short In cluster deployments, queues with a large number of messages can lead to resource overutilization. When a broker is overutilized, rebooting an Amazon MQ for RabbitMQ broker can cause further degradation of performance. If rebooted, overutilized brokers might become unresponsive in the REBOOT_IN_PROGRESS state. During maintenance windows, Amazon MQ performs all maintenance work one node at a time to ensure that the broker remains operational. As a result, queues might need to synchronize as each node resumes operation. During synchronization, messages that need to be replicated to mirrors are loaded into memory from the corresponding Amazon Elastic Block Store (Amazon EBS) volume to be processed in batches. Processing messages in batches lets queues synchronize faster. If queues are kept short and messages are small, the queues successfully synchronize and resume operation as expected. However, if the amount of data in a batch approaches the node's memory limit, the node raises a high memory alarm, pausing the queue sync. You can conﬁrm memory usage by comparing the RabbitMemUsed and RabbitMqMemLimit broker node metrics in CloudWatch. Synchronization can't complete until messages are consumed or deleted, or the number of messages in the batch is reduced. If queue synchronization is paused for a cluster deployment, we recommend consuming or deleting messages to lower the number of messages in queues. Once queue depth is reduced and queue Keep queues short 206 Amazon MQ Developer Guide sync completes, the broker status will change to RUNNING. To resolve a paused queue sync, you can also apply a policy to reduce the queue synchronization batch-size. You can also deﬁne auto-delete and TTL policies to proactively reduce resource usage, as well as keep NACKs from consumers to a minimum. Requeueing messages on the broker is CPU-intensive so a high number of NACKs can aﬀect broker performance. Conﬁgure publisher conﬁrmation and consumer delivery acknowledgement The process of conﬁrming a message has been sent to the broker is known as publisher conﬁrmation. Publisher conﬁrms let your application know when messages have been reliably stored. Publisher conﬁrms can also help control the rate of messages stored to the broker. Without publisher conﬁrms, there is no conﬁrmation that a messgae is processed successfully, and your broker may drop messages it cannot process. Similarly, when a client application sends conﬁrmation of delivery and consumption of messages back to the broker, it is known as consumer delivery acknowledgment. Both conﬁrmation and acknowledgement are essential to ensuring data safety when working with RabbitMQ brokers. Consumer delivery acknowledgement is typically conﬁgured on the client application. When working with AMQP 0-9-1, acknowledgement can be enabled by conﬁguring the basic.consume method. AMQP 0-9-1 clients can also
amazon-mq-dg-058	amazon-mq-dg.pdf	58	help control the rate of messages stored to the broker. Without publisher conﬁrms, there is no conﬁrmation that a messgae is processed successfully, and your broker may drop messages it cannot process. Similarly, when a client application sends conﬁrmation of delivery and consumption of messages back to the broker, it is known as consumer delivery acknowledgment. Both conﬁrmation and acknowledgement are essential to ensuring data safety when working with RabbitMQ brokers. Consumer delivery acknowledgement is typically conﬁgured on the client application. When working with AMQP 0-9-1, acknowledgement can be enabled by conﬁguring the basic.consume method. AMQP 0-9-1 clients can also conﬁgure publisher conﬁrms by sending the confirm.select method. Typically, delivery acknowledgement is enabled in a channel. For example, when working with the RabbitMQ Java client library, you can use the Channel#basicAck to set up a simple basic.ack positive acknowledgement as shown in the following example. // this example assumes an existing channel instance boolean autoAck = false; channel.basicConsume(queueName, autoAck, "a-consumer-tag", new DefaultConsumer(channel) { @Override public void handleDelivery(String consumerTag, Envelope envelope, AMQP.BasicProperties properties, byte[] body) throws IOException Conﬁgure publisher conﬁrmation and consumer delivery acknowledgement 207 Amazon MQ { Developer Guide long deliveryTag = envelope.getDeliveryTag(); // positively acknowledge a single delivery, the message will // be discarded channel.basicAck(deliveryTag, false); } }); Note Unacknowledged messages must be cached in memory. You can limit the number of messages that a consumer pre-fetches by conﬁguring pre-fetch settings for a client application. You can conﬁgure consumer_timeout to detect when consumers do not acknowledge deliveries. If the consumer does not send an acknowledgment within the timeout value, the channel will be closed, and you will recieve a PRECONDITION_FAILED. To diagnose the error, use the UpdateConﬁguration API to increase the consumer_timeout value. Conﬁgure pre-fetching You can use the RabbitMQ pre-fetch value to optimize how your consumers consume messages. RabbitMQ implements the channel pre-fetch mechanism provided by AMQP 0-9-1 by applying the pre-fetch count to consumers as opposed to channels. The pre-fetch value is used to specify how many messages are being sent to the consumer at any given time. By default, RabbitMQ sets an unlimited buﬀer size for client applications. There are a variety of factors to consider when setting a pre-fetch count for your RabbitMQ consumers. First, consider your consumers' environment and conﬁguration. Because consumers need to keep all messages in memory as they are being processed, a high pre-fetch value can have a negative impact on your consumers' performance, and in some cases, can result in a consumer potentially crashing all together. Similarly, the RabbitMQ broker itself keeps all messages that it sends cached in memory until it recieves consumer acknowledgement. A high pre-fetch value can cause your RabbitMQ server to run out of memory quickly if automatic acknowledgement is not conﬁgured for consumers, and if consumers take a relatively long time to process messages. With the above considerations in mind, we recommend always setting a pre-fetch value in order to prevent situations where a RabbitMQ broker or its consumers run out of memory due to a large Conﬁgure pre-fetching 208 Amazon MQ Developer Guide number number of unprocessed, or unacknowledged messages. If you need to optimize your brokers to process large volumes of messages, you can test your brokers and consumers using a range of pre-fetch counts to determine the value at which point network overhead becomes largely insigniﬁcant compared to the time it takes a consumer to process messages. Note • If your client applications have conﬁgured to automatically acknowledge delivery of messages to consumers, setting a pre-fetch value will have no eﬀect. • All pre-fetched messages are removed from the queue. The following example desmonstrate setting a pre-fetch value of 10 for a single consumer using the RabbitMQ Java client library. ConnectionFactory factory = new ConnectionFactory(); Connection connection = factory.newConnection(); Channel channel = connection.createChannel(); channel.basicQos(10, false); QueueingConsumer consumer = new QueueingConsumer(channel); channel.basicConsume("my_queue", false, consumer); Note In the RabbitMQ Java client library, the default value for the global ﬂag is set to false, so the above example can be written simply as channel.basicQos(10). Use Celery 5.5.0 or later with quorum queues Python Celery, a distributed task queue system, can generate many non-critical messages when experiencing high task load. This additional broker activity can trigger RabbitMQ memory alarm and lead to broker unavailability. To reduce the chance of triggering memory alarm, do the following: Use Celery 5.5.0 or later with quorum queues 209 Amazon MQ Developer Guide 1. Upgrade to Celery version 5.5.0, the minimum version that supports quorum queues, or a later version. To check what version of Celery you are using, use celery --version. For more information on quorum queues, see the section called “Quorum queues”. 2. After upgrading to Celery 5.5.0 or later, conﬁgure task_default_queue_type to "quorum". Then, you must also turn on Publish Conﬁrms in Broker Transport Options: broker_transport_options = {"confirm_publish":
amazon-mq-dg-059	amazon-mq-dg.pdf	59	RabbitMQ memory alarm and lead to broker unavailability. To reduce the chance of triggering memory alarm, do the following: Use Celery 5.5.0 or later with quorum queues 209 Amazon MQ Developer Guide 1. Upgrade to Celery version 5.5.0, the minimum version that supports quorum queues, or a later version. To check what version of Celery you are using, use celery --version. For more information on quorum queues, see the section called “Quorum queues”. 2. After upgrading to Celery 5.5.0 or later, conﬁgure task_default_queue_type to "quorum". Then, you must also turn on Publish Conﬁrms in Broker Transport Options: broker_transport_options = {"confirm_publish": True} 3. To further reduce non-critical message activity, turn oﬀ Celery worker-send-task-events by not including -E or --task-events ﬂag when starting your Celery application. 4. Then, turn oﬀ worker_enable_remote_control to stop dynamic creation of celery@...pidbox queues. This will reduce queue churn on the broker. worker_enable_remote_control = false 5. Start your Celery application using the following parameters: celery -A app_name worker --without-heartbeat --without-gossip --without-mingle Automatically recover from network failures We recommend always enabling automatic network recovery to prevent signiﬁcant downtime in cases where client connections to RabbitMQ nodes fail. The RabbitMQ Java client library supports automatic network recovery by default, beginning with version 4.0.0. Automatic connection recovery is triggered if an unhandled exception is thrown in the connection's I/O loop, if a socket read operation timeout is detected, or if the server misses a heartbeat. In cases where the initial connection between a client and a RabbitMQ node fails, automatic recovery will not be triggered. We recommend writing your application code to account for initial connection failures by retrying the connection. The following example demonstrates retrying initial network failures using the RabbitMQ Java client library. ConnectionFactory factory = new ConnectionFactory(); // enable automatic recovery if using RabbitMQ Java client library prior to version 4.0.0. factory.setAutomaticRecoveryEnabled(true); // configure various connection settings Automatically recover from network failures 210 Amazon MQ Developer Guide try { Connection conn = factory.newConnection(); } catch (java.net.ConnectException e) { Thread.sleep(5000); // apply retry logic } Note If an application closes a connection by using the Connection.Close method, automatic network recovery will not be enabled or triggered. Automatically recover from network failures 211 Amazon MQ Developer Guide Security in Amazon MQ Cloud security at AWS is the highest priority. As an AWS customer, you beneﬁt from data centers and network architectures that are built to meet the requirements of the most security-sensitive organizations. Security is a shared responsibility between AWS and you. The shared responsibility model describes this as security of the cloud and security in the cloud: • Security of the cloud – AWS is responsible for protecting the infrastructure that runs AWS services in the AWS Cloud. AWS also provides you with services that you can use securely. Third- party auditors regularly test and verify the eﬀectiveness of our security as part of the AWS Compliance Programs. To learn about the compliance programs that apply to Amazon MQ, see AWS Services in Scope by Compliance Program. • Security in the cloud – Your responsibility is determined by the AWS service that you use. You are also responsible for other factors including the sensitivity of your data, your company’s requirements, and applicable laws and regulations. This documentation helps you understand how to apply the shared responsibility model when using Amazon MQ. The following topics show you how to conﬁgure Amazon MQ to meet your security and compliance objectives. You also learn how to use other AWS services that help you to monitor and secure your Amazon MQ resources. Topics • Data protection in Amazon MQ • Identity and access Management for Amazon MQ • Compliance validation for Amazon MQ • Resilience in Amazon MQ • Infrastructure security in Amazon MQ • Security best practices for Amazon MQ Data protection in Amazon MQ The AWS shared responsibility model applies to data protection in Amazon MQ. As described in this model, AWS is responsible for protecting the global infrastructure that runs all of the AWS Cloud. Data protection 212 Amazon MQ Developer Guide You are responsible for maintaining control over your content that is hosted on this infrastructure. You are also responsible for the security conﬁguration and management tasks for the AWS services that you use. For more information about data privacy, see the Data Privacy FAQ. For information about data protection in Europe, see the AWS Shared Responsibility Model and GDPR blog post on the AWS Security Blog. For data protection purposes, we recommend that you protect AWS account credentials and set up individual users with AWS IAM Identity Center or AWS Identity and Access Management (IAM). That way, each user is given only the permissions necessary to fulﬁll their job duties. We also recommend that you secure your data in the following ways: • Use multi-factor authentication (MFA) with
amazon-mq-dg-060	amazon-mq-dg.pdf	60	AWS services that you use. For more information about data privacy, see the Data Privacy FAQ. For information about data protection in Europe, see the AWS Shared Responsibility Model and GDPR blog post on the AWS Security Blog. For data protection purposes, we recommend that you protect AWS account credentials and set up individual users with AWS IAM Identity Center or AWS Identity and Access Management (IAM). That way, each user is given only the permissions necessary to fulﬁll their job duties. We also recommend that you secure your data in the following ways: • Use multi-factor authentication (MFA) with each account. • Use SSL/TLS to communicate with AWS resources. We require TLS 1.2 and recommend TLS 1.3. • Set up API and user activity logging with AWS CloudTrail. For information about using CloudTrail trails to capture AWS activities, see Working with CloudTrail trails in the AWS CloudTrail User Guide. • Use AWS encryption solutions, along with all default security controls within AWS services. • Use advanced managed security services such as Amazon Macie, which assists in discovering and securing sensitive data that is stored in Amazon S3. • If you require FIPS 140-3 validated cryptographic modules when accessing AWS through a command line interface or an API, use a FIPS endpoint. For more information about the available FIPS endpoints, see Federal Information Processing Standard (FIPS) 140-3. We strongly recommend that you never put conﬁdential or sensitive information, such as your customers' email addresses, into tags or free-form text ﬁelds such as a Name ﬁeld. This includes when you work with Amazon MQ or other AWS services using the console, API, AWS CLI, or AWS SDKs. Any data that you enter into tags or free-form text ﬁelds used for names may be used for billing or diagnostic logs. If you provide a URL to an external server, we strongly recommend that you do not include credentials information in the URL to validate your request to that server. For both Amazon MQ for ActiveMQ and Amazon MQ for RabbitMQ brokers, do not use any personally identiﬁable information (PII) or other conﬁdential or sensitive information for broker names or usernames when creating resources via the broker web console, or the Amazon MQ API. Broker names and usernames are accessible to other AWS services, including CloudWatch Logs. Broker usernames are not intended to be used for private or sensitive data. Data protection 213 Amazon MQ Encryption Developer Guide User data stored in Amazon MQ is encrypted at rest. Amazon MQ encryption at rest provides enhanced security by encrypting your data using encryption keys stored in the AWS Key Management Service (KMS). This service helps reduce the operational burden and complexity involved in protecting sensitive data. With encryption at rest, you can build security-sensitive applications that meet encryption compliance and regulatory requirements. All connections between Amazon MQ brokers use Transport layer Security (TLS) to provide encryption in transit. Amazon MQ encrypts messages at rest and in transit using encryption keys that it manages and stores securely. For more information, see the AWS Encryption SDK Developer Guide. Encryption at rest Amazon MQ integrates with AWS Key Management Service (KMS) to oﬀer transparent server-side encryption. Amazon MQ always encrypts your data at rest. When you create an Amazon MQ for ActiveMQ broker or an Amazon MQ for RabbitMQ broker, you can specify the AWS KMS key that you want Amazon MQ to use to encrypt your data at rest. If you do not specify a KMS key, Amazon MQ creates an AWS owned KMS key for you and uses it on your behalf. Amazon MQ currently supports symmetric KMS keys. For more information about KMS keys, see AWS KMS keys. When creating a broker, you can conﬁgure what Amazon MQ uses for your encryption key by selecting one of the following. • Amazon MQ owned KMS key (default) — The key is owned and managed by Amazon MQ and is not in your account. • AWS managed KMS key — The AWS managed KMS key (aws/mq) is a KMS key in your account that is created, managed, and used on your behalf by Amazon MQ. • Select existing customer managed KMS key — Customer managed KMS keys are created and managed by you in AWS Key Management Service (KMS). Encryption 214 Amazon MQ Important Developer Guide • Revoking a grant cannot be undone. Instead, we suggest deleting the broker if you need to revoke access rights. • For Amazon MQ for ActiveMQ brokers that use Amazon Elastic File System (EFS) to store message data, if you revoke the grant that gives Amazon EFS permission to use the KMS keys in your account, it will not take place immediately. • For Amazon MQ for RabbitMQ and Amazon MQ for ActiveMQ brokers that use EBS to store message
amazon-mq-dg-061	amazon-mq-dg.pdf	61	keys are created and managed by you in AWS Key Management Service (KMS). Encryption 214 Amazon MQ Important Developer Guide • Revoking a grant cannot be undone. Instead, we suggest deleting the broker if you need to revoke access rights. • For Amazon MQ for ActiveMQ brokers that use Amazon Elastic File System (EFS) to store message data, if you revoke the grant that gives Amazon EFS permission to use the KMS keys in your account, it will not take place immediately. • For Amazon MQ for RabbitMQ and Amazon MQ for ActiveMQ brokers that use EBS to store message data, if you disable, schedule for deletion, or revoke the grant that gives Amazon EBS permission to use the KMS keys in your account, Amazon MQ cannot maintain your broker, and it may change to a degraded state. • If you have deactivated the key or scheduled the key to be deleted, you can reactivate the key or cancel key deletion and keep your broker maintained. • Deactivating a key or revoking a grant will not take place immediately. When creating a single instance broker with a KMS key for RabbitMQ, you will see two CreateGrant events logged in AWS CloudTrail. The ﬁrst event is Amazon MQ creating a grant for the KMS key. The second event is EBS creating a grant for EBS to use. CreateGrant AWS CloudTrail log entry: single instance broker mq_grant { "eventVersion": "1.08", "userIdentity": { "type": "AssumedRole", "principalId": "AKIAIOSFODNN7EXAMPLE", "arn": "arn:aws:iam::111122223333:user/AmazonMqConsole", "accountId": "111122223333", "accessKeyId": "AKIAI44QH8DHBEXAMPLE", "sessionContext": { "sessionIssuer": { "type": "Role", "principalId": "AKIAIOSFODNN7EXAMPLE", "arn": "arn:aws:iam::111122223333:user/AmazonMqConsole", "accountId": "111122223333", Encryption at rest 215 Amazon MQ Developer Guide "userName": "AmazonMqConsole" }, "webIdFederationData": {}, "attributes": { "creationDate": "2023-02-23T18:59:10Z", "mfaAuthenticated": "false" } }, "invokedBy": "mq.amazonaws.com" }, "eventTime": "2018-06-28T22:23:46Z", "eventSource": "amazonmq.amazonaws.com", "eventName": "CreateGrant", "awsRegion": "us-west-2", "sourceIPAddress": "203.0.113.0", "userAgent": "PostmanRuntime/7.1.5", "requestParameters": { "granteePrincipal": "mq.amazonaws.com", "keyId": "arn:aws:kms:us-east-1:316438333700:key/bdbe42ae-f825-4e78- a8a1-828d411c4be2", "retiringPrincipal": "mq.amazonaws.com", "operations": [ "CreateGrant", "Decrypt", "GenerateDataKeyWithoutPlaintext", "ReEncryptFrom", "ReEncryptTo", "DescribeKey" ] }, "responseElements": { "grantId": "0ab0ac0d0b000f00ea00cc0a0e00fc00bce000c000f0000000c0bc0a0000aaafSAMPLE", "keyId": "arn:aws:kms:us- west-2:111122223333:key/1234abcd-12ab-34cd-56ef-123456SAMPLE", "requestID": "ff000af-00eb-00ce-0e00-ea000fb0fba0SAMPLE", "eventID": "ff000af-00eb-00ce-0e00-ea000fb0fba0SAMPLE", "readOnly": false, "resources": [ { "accountId": "111122223333", "type": "AWS::KMS::Key", Encryption at rest 216 Amazon MQ Developer Guide "ARN": "arn:aws:kms:us- west-2:111122223333:key/1234abcd-12ab-34cd-56ef-123456SAMPLE" } ], "eventType": "AwsApiCall", "managementEvent": true, "recipientAccountId": "111122223333", "eventCategory": "Management", "sessionCredentialFromConsole": "true" } EBS grant creation You will see one event for EBS grant creation. { "eventVersion": "1.08", "userIdentity": { "type": "AWSService", "invokedBy": "mq.amazonaws.com" }, "eventTime": "2023-02-23T19:09:40Z", "eventSource": "kms.amazonaws.com", "eventName": "CreateGrant", "awsRegion": "us-east-1", "sourceIPAddress": "mq.amazonaws.com", "userAgent": "ExampleDesktop/1.0 (V1; OS)", "requestParameters": { "granteePrincipal": "mq.amazonaws.com", "keyId": "arn:aws:kms:us- west-2:111122223333:key/1234abcd-12ab-34cd-56ef-123456SAMPLE", "constraints": { "encryptionContextSubset": { "aws:ebs:id": "vol-0b670f00f7d5417c0" } }, "operations": [ "Decrypt" ], "retiringPrincipal": "ec2.us-east-1.amazonaws.com" }, "responseElements": { Encryption at rest 217 Amazon MQ "grantId": Developer Guide "0ab0ac0d0b000f00ea00cc0a0e00fc00bce000c000f0000000c0bc0a0000aaafSAMPLE", "keyId": "arn:aws:kms:us- west-2:111122223333:key/1234abcd-12ab-34cd-56ef-123456SAMPLE", }, "requestID": "ff000af-00eb-00ce-0e00-ea000fb0fba0SAMPLE", "eventID": "ff000af-00eb-00ce-0e00-ea000fb0fba0SAMPLE", "readOnly": false, "resources": [ { "accountId": "111122223333", "type": "AWS::KMS::Key", "ARN": "arn:aws:kms:us- west-2:111122223333:key/1234abcd-12ab-34cd-56ef-123456SAMPLE" } ], "eventType": "AwsApiCall", "managementEvent": true, "recipientAccountId": "111122223333", "sharedEventID": "ff000af-00eb-00ce-0e00-ea000fb0fba0SAMPLE", "eventCategory": "Management" } When creating a cluster deployment with a KMS key for RabbitMQ, you will see ﬁve CreateGrant events logged in AWS CloudTrail. The ﬁrst two events are grant creations for Amazon MQ. The next three events are grants created by EBS for EBS to use. CreateGrant AWS CloudTrail log entry: cluster deployment mq_grant { "eventVersion": "1.08", "userIdentity": { "type": "AssumedRole", "principalId": "AKIAIOSFODNN7EXAMPLE", "arn": "arn:aws:iam::111122223333:user/AmazonMqConsole", "accountId": "111122223333", "accessKeyId": "AKIAI44QH8DHBEXAMPLE", "sessionContext": { Encryption at rest 218 Amazon MQ Developer Guide "sessionIssuer": { "type": "Role", "principalId": "AKIAIOSFODNN7EXAMPLE", "arn": "arn:aws:iam::111122223333:user/AmazonMqConsole", "accountId": "111122223333", "userName": "AmazonMqConsole" }, "webIdFederationData": {}, "attributes": { "creationDate": "2023-02-23T18:59:10Z", "mfaAuthenticated": "false" } }, "invokedBy": "mq.amazonaws.com" }, "eventTime": "2018-06-28T22:23:46Z", "eventSource": "amazonmq.amazonaws.com", "eventName": "CreateGrant", "awsRegion": "us-west-2", "sourceIPAddress": "203.0.113.0", "userAgent": "PostmanRuntime/7.1.5", "requestParameters": { "granteePrincipal": "mq.amazonaws.com", "keyId": "arn:aws:kms:us-east-1:316438333700:key/bdbe42ae-f825-4e78- a8a1-828d411c4be2", "retiringPrincipal": "mq.amazonaws.com", "operations": [ "CreateGrant", "Encrypt", "Decrypt", "ReEncryptFrom", "ReEncryptTo", "GenerateDataKey", "GenerateDataKeyWithoutPlaintext", "DescribeKey" ] }, "responseElements": { "grantId": "0ab0ac0d0b000f00ea00cc0a0e00fc00bce000c000f0000000c0bc0a0000aaafSAMPLE", "keyId": "arn:aws:kms:us- west-2:111122223333:key/1234abcd-12ab-34cd-56ef-123456SAMPLE", "requestID": "ff000af-00eb-00ce-0e00-ea000fb0fba0SAMPLE", Encryption at rest 219 Amazon MQ Developer Guide "eventID": "ff000af-00eb-00ce-0e00-ea000fb0fba0SAMPLE", "readOnly": false, "resources": [ { "accountId": "111122223333", "type": "AWS::KMS::Key", "ARN": "arn:aws:kms:us- west-2:111122223333:key/1234abcd-12ab-34cd-56ef-123456SAMPLE" } ], "eventType": "AwsApiCall", "managementEvent": true, "recipientAccountId": "111122223333", "eventCategory": "Management", "sessionCredentialFromConsole": "true" } mq_rabbit_grant { "eventVersion": "1.08", "userIdentity": { "type": "AssumedRole", "principalId": "AKIAIOSFODNN7EXAMPLE", "arn": "arn:aws:iam::111122223333:user/AmazonMqConsole", "accountId": "111122223333", "accessKeyId": "AKIAI44QH8DHBEXAMPLE", "sessionContext": { "sessionIssuer": { "type": "Role", "principalId": "AKIAIOSFODNN7EXAMPLE", "arn": "arn:aws:iam::111122223333:user/AmazonMqConsole", "accountId": "111122223333", "userName": "AmazonMqConsole" }, "webIdFederationData": {}, "attributes": { "creationDate": "2023-02-23T18:59:10Z", "mfaAuthenticated": "false" } }, Encryption at rest 220 Amazon MQ Developer Guide "invokedBy": "mq.amazonaws.com" }, "eventTime": "2018-06-28T22:23:46Z", "eventSource": "amazonmq.amazonaws.com", "eventName": "CreateGrant", "awsRegion": "us-west-2", "sourceIPAddress": "203.0.113.0", "userAgent": "PostmanRuntime/7.1.5", "requestParameters": { "granteePrincipal": "mq.amazonaws.com", "retiringPrincipal": "mq.amazonaws.com", "operations": [ "DescribeKey" ], "keyId": "arn:aws:kms:us- west-2:111122223333:key/1234abcd-12ab-34cd-56ef-123456SAMPLE", }, "responseElements": { "grantId": "0ab0ac0d0b000f00ea00cc0a0e00fc00bce000c000f0000000c0bc0a0000aaafSAMPLE", "keyId": "arn:aws:kms:us- west-2:111122223333:key/1234abcd-12ab-34cd-56ef-123456SAMPLE", "requestID": "ff000af-00eb-00ce-0e00-ea000fb0fba0SAMPLE", "eventID": "ff000af-00eb-00ce-0e00-ea000fb0fba0SAMPLE", "readOnly": false, "resources": [ { "accountId": "111122223333", "type": "AWS::KMS::Key", "ARN": "arn:aws:kms:us- west-2:111122223333:key/1234abcd-12ab-34cd-56ef-123456SAMPLE" } ], "eventType": "AwsApiCall", "managementEvent": true, "recipientAccountId": "111122223333", "eventCategory": "Management", "sessionCredentialFromConsole": "true" } Encryption at rest 221 Amazon MQ EBS grant creation You will see three events for EBS grant creation. Developer Guide { "eventVersion": "1.08", "userIdentity": { "type": "AWSService", "invokedBy": "mq.amazonaws.com" }, "eventTime": "2023-02-23T19:09:40Z", "eventSource": "kms.amazonaws.com", "eventName": "CreateGrant", "awsRegion": "us-east-1", "sourceIPAddress": "mq.amazonaws.com", "userAgent": "ExampleDesktop/1.0
amazon-mq-dg-062	amazon-mq-dg.pdf	62	"eventName": "CreateGrant", "awsRegion": "us-west-2", "sourceIPAddress": "203.0.113.0", "userAgent": "PostmanRuntime/7.1.5", "requestParameters": { "granteePrincipal": "mq.amazonaws.com", "retiringPrincipal": "mq.amazonaws.com", "operations": [ "DescribeKey" ], "keyId": "arn:aws:kms:us- west-2:111122223333:key/1234abcd-12ab-34cd-56ef-123456SAMPLE", }, "responseElements": { "grantId": "0ab0ac0d0b000f00ea00cc0a0e00fc00bce000c000f0000000c0bc0a0000aaafSAMPLE", "keyId": "arn:aws:kms:us- west-2:111122223333:key/1234abcd-12ab-34cd-56ef-123456SAMPLE", "requestID": "ff000af-00eb-00ce-0e00-ea000fb0fba0SAMPLE", "eventID": "ff000af-00eb-00ce-0e00-ea000fb0fba0SAMPLE", "readOnly": false, "resources": [ { "accountId": "111122223333", "type": "AWS::KMS::Key", "ARN": "arn:aws:kms:us- west-2:111122223333:key/1234abcd-12ab-34cd-56ef-123456SAMPLE" } ], "eventType": "AwsApiCall", "managementEvent": true, "recipientAccountId": "111122223333", "eventCategory": "Management", "sessionCredentialFromConsole": "true" } Encryption at rest 221 Amazon MQ EBS grant creation You will see three events for EBS grant creation. Developer Guide { "eventVersion": "1.08", "userIdentity": { "type": "AWSService", "invokedBy": "mq.amazonaws.com" }, "eventTime": "2023-02-23T19:09:40Z", "eventSource": "kms.amazonaws.com", "eventName": "CreateGrant", "awsRegion": "us-east-1", "sourceIPAddress": "mq.amazonaws.com", "userAgent": "ExampleDesktop/1.0 (V1; OS)", "requestParameters": { "granteePrincipal": "mq.amazonaws.com", "keyId": "arn:aws:kms:us- west-2:111122223333:key/1234abcd-12ab-34cd-56ef-123456SAMPLE", "constraints": { "encryptionContextSubset": { "aws:ebs:id": "vol-0b670f00f7d5417c0" } }, "operations": [ "Decrypt" ], "retiringPrincipal": "ec2.us-east-1.amazonaws.com" }, "responseElements": { "grantId": "0ab0ac0d0b000f00ea00cc0a0e00fc00bce000c000f0000000c0bc0a0000aaafSAMPLE", "keyId": "arn:aws:kms:us- west-2:111122223333:key/1234abcd-12ab-34cd-56ef-123456SAMPLE", }, "requestID": "ff000af-00eb-00ce-0e00-ea000fb0fba0SAMPLE", "eventID": "ff000af-00eb-00ce-0e00-ea000fb0fba0SAMPLE", "readOnly": false, "resources": [ { "accountId": "111122223333", "type": "AWS::KMS::Key", Encryption at rest 222 Amazon MQ Developer Guide "ARN": "arn:aws:kms:us- west-2:111122223333:key/1234abcd-12ab-34cd-56ef-123456SAMPLE" } ], "eventType": "AwsApiCall", "managementEvent": true, "recipientAccountId": "111122223333", "sharedEventID": "ff000af-00eb-00ce-0e00-ea000fb0fba0SAMPLE", "eventCategory": "Management" } For more information about KMS keys, see AWS KMS keys in the AWS Key Management Service Developer Guide. Encryption in transit Amazon MQ for ActiveMQ: Amazon MQ for ActiveMQ requires strong Transport Layer Security (TLS) and encrypts data in transit between the brokers of your Amazon MQ deployment. All data that passes between Amazon MQ brokers is encrypted using strong Transport Layer Security (TLS). This is true for all available protocols. Amazon MQ for RabbitMQ: Amazon MQ for RabbitMQ requires strong Transport Layer Security (TLS) encryption for all client connections. RabbitMQ cluster replication traﬃc only transits your broker’s VPC and all network traﬃc between AWS data centers is transparently encrypted at the physical layer. Amazon MQ for RabbitMQ clustered brokers currently do not support Inter-node encryption for cluster replication. To learn more about data-in-transit, see Encrypting Data-at-Rest and -in-Transit. Amazon MQ for ActiveMQ protocols You can access your ActiveMQ brokers using the following protocols with TLS enabled: • AMQP • MQTT • MQTT over WebSocket • OpenWire • STOMP Encryption in transit 223 Amazon MQ • STOMP over WebSocket Developer Guide Supported TLS Cipher Suites for ActiveMQ ActiveMQ on Amazon MQ supports the following cipher suites: • TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384 • TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384 • TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA • TLS_DHE_RSA_WITH_AES_256_GCM_SHA384 • TLS_DHE_RSA_WITH_AES_256_CBC_SHA256 • TLS_DHE_RSA_WITH_AES_256_CBC_SHA • TLS_RSA_WITH_AES_256_GCM_SHA384 • TLS_RSA_WITH_AES_256_CBC_SHA256 • TLS_RSA_WITH_AES_256_CBC_SHA • TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256 • TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256 • TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA • TLS_DHE_RSA_WITH_AES_128_GCM_SHA256 • TLS_DHE_RSA_WITH_AES_128_CBC_SHA256 • TLS_DHE_RSA_WITH_AES_128_CBC_SHA • TLS_RSA_WITH_AES_128_GCM_SHA256 • TLS_RSA_WITH_AES_128_CBC_SHA256 • TLS_RSA_WITH_AES_128_CBC_SHA Amazon MQ for RabbitMQ protocols You can access your RabbitMQ brokers using the following protocols with TLS enabled: • AMQP (0-9-1) Supported TLS Cipher Suites for RabbitMQ RabbitMQ on Amazon MQ supports the following cipher suites: Encryption in transit 224 Amazon MQ Developer Guide • TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384 • TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256 Identity and access Management for Amazon MQ AWS Identity and Access Management (IAM) is an AWS service that helps an administrator securely control access to AWS resources. IAM administrators control who can be authenticated (signed in) and authorized (have permissions) to use Amazon MQ resources. IAM is an AWS service that you can use with no additional charge. Topics • Audience • Authenticating with identities • Managing access using policies • How Amazon MQ works with IAM • Amazon MQ Identity-based policy examples • API authentication and authorization for Amazon MQ • AWS managed policies for Amazon MQ • Using service-linked roles for Amazon MQ • Troubleshooting Amazon MQ identity and access Audience How you use AWS Identity and Access Management (IAM) diﬀers, depending on the work that you do in Amazon MQ. Service user – If you use the Amazon MQ service to do your job, then your administrator provides you with the credentials and permissions that you need. As you use more Amazon MQ features to do your work, you might need additional permissions. Understanding how access is managed can help you request the right permissions from your administrator. If you cannot access a feature in Amazon MQ, see Troubleshooting Amazon MQ identity and access. Service administrator – If you're in charge of Amazon MQ resources at your company, you probably have full access to Amazon MQ. It's your job to determine which Amazon MQ features and resources your service users should access. You must then submit requests to your IAM Identity and access management 225 Amazon MQ Developer Guide administrator to change the permissions of your service users. Review the information on this page to understand the basic concepts of IAM. To learn more about how your company can use IAM with Amazon MQ, see How Amazon MQ works with IAM. IAM administrator – If you're an IAM administrator, you might want to learn details about how you can write policies to manage access to Amazon MQ. To view example Amazon MQ identity-based policies that you can use in IAM, see Amazon MQ Identity-based policy examples. Authenticating with
amazon-mq-dg-063	amazon-mq-dg.pdf	63	your IAM Identity and access management 225 Amazon MQ Developer Guide administrator to change the permissions of your service users. Review the information on this page to understand the basic concepts of IAM. To learn more about how your company can use IAM with Amazon MQ, see How Amazon MQ works with IAM. IAM administrator – If you're an IAM administrator, you might want to learn details about how you can write policies to manage access to Amazon MQ. To view example Amazon MQ identity-based policies that you can use in IAM, see Amazon MQ Identity-based policy examples. Authenticating with identities Authentication is how you sign in to AWS using your identity credentials. You must be authenticated (signed in to AWS) as the AWS account root user, as an IAM user, or by assuming an IAM role. You can sign in to AWS as a federated identity by using credentials provided through an identity source. AWS IAM Identity Center (IAM Identity Center) users, your company's single sign-on authentication, and your Google or Facebook credentials are examples of federated identities. When you sign in as a federated identity, your administrator previously set up identity federation using IAM roles. When you access AWS by using federation, you are indirectly assuming a role. Depending on the type of user you are, you can sign in to the AWS Management Console or the AWS access portal. For more information about signing in to AWS, see How to sign in to your AWS account in the AWS Sign-In User Guide. If you access AWS programmatically, AWS provides a software development kit (SDK) and a command line interface (CLI) to cryptographically sign your requests by using your credentials. If you don't use AWS tools, you must sign requests yourself. For more information about using the recommended method to sign requests yourself, see AWS Signature Version 4 for API requests in the IAM User Guide. Regardless of the authentication method that you use, you might be required to provide additional security information. For example, AWS recommends that you use multi-factor authentication (MFA) to increase the security of your account. To learn more, see Multi-factor authentication in the AWS IAM Identity Center User Guide and AWS Multi-factor authentication in IAM in the IAM User Guide. AWS account root user When you create an AWS account, you begin with one sign-in identity that has complete access to all AWS services and resources in the account. This identity is called the AWS account root user and Authenticating with identities 226 Amazon MQ Developer Guide is accessed by signing in with the email address and password that you used to create the account. We strongly recommend that you don't use the root user for your everyday tasks. Safeguard your root user credentials and use them to perform the tasks that only the root user can perform. For the complete list of tasks that require you to sign in as the root user, see Tasks that require root user credentials in the IAM User Guide. Users and groups An IAM user is an identity within your AWS account that has speciﬁc permissions for a single person or application. Where possible, we recommend relying on temporary credentials instead of creating IAM users who have long-term credentials such as passwords and access keys. However, if you have speciﬁc use cases that require long-term credentials with IAM users, we recommend that you rotate access keys. For more information, see Rotate access keys regularly for use cases that require long- term credentials in the IAM User Guide. An IAM group is an identity that speciﬁes a collection of IAM users. You can't sign in as a group. You can use groups to specify permissions for multiple users at a time. Groups make permissions easier to manage for large sets of users. For example, you could have a group named IAMAdmins and give that group permissions to administer IAM resources. Users are diﬀerent from roles. A user is uniquely associated with one person or application, but a role is intended to be assumable by anyone who needs it. Users have permanent long-term credentials, but roles provide temporary credentials. To learn more, see Use cases for IAM users in the IAM User Guide. IAM roles An IAM role is an identity within your AWS account that has speciﬁc permissions. It is similar to an IAM user, but is not associated with a speciﬁc person. To temporarily assume an IAM role in the AWS Management Console, you can switch from a user to an IAM role (console). You can assume a role by calling an AWS CLI or AWS API operation or by using a custom URL. For more information about methods for using roles, see Methods to assume a role in the IAM User Guide. IAM roles with
amazon-mq-dg-064	amazon-mq-dg.pdf	64	in the IAM User Guide. IAM roles An IAM role is an identity within your AWS account that has speciﬁc permissions. It is similar to an IAM user, but is not associated with a speciﬁc person. To temporarily assume an IAM role in the AWS Management Console, you can switch from a user to an IAM role (console). You can assume a role by calling an AWS CLI or AWS API operation or by using a custom URL. For more information about methods for using roles, see Methods to assume a role in the IAM User Guide. IAM roles with temporary credentials are useful in the following situations: • Federated user access – To assign permissions to a federated identity, you create a role and deﬁne permissions for the role. When a federated identity authenticates, the identity is associated with the role and is granted the permissions that are deﬁned by the role. For information about roles for federation, see Create a role for a third-party identity provider Authenticating with identities 227 Amazon MQ Developer Guide (federation) in the IAM User Guide. If you use IAM Identity Center, you conﬁgure a permission set. To control what your identities can access after they authenticate, IAM Identity Center correlates the permission set to a role in IAM. For information about permissions sets, see Permission sets in the AWS IAM Identity Center User Guide. • Temporary IAM user permissions – An IAM user or role can assume an IAM role to temporarily take on diﬀerent permissions for a speciﬁc task. • Cross-account access – You can use an IAM role to allow someone (a trusted principal) in a diﬀerent account to access resources in your account. Roles are the primary way to grant cross- account access. However, with some AWS services, you can attach a policy directly to a resource (instead of using a role as a proxy). To learn the diﬀerence between roles and resource-based policies for cross-account access, see Cross account resource access in IAM in the IAM User Guide. • Cross-service access – Some AWS services use features in other AWS services. For example, when you make a call in a service, it's common for that service to run applications in Amazon EC2 or store objects in Amazon S3. A service might do this using the calling principal's permissions, using a service role, or using a service-linked role. • Forward access sessions (FAS) – When you use an IAM user or role to perform actions in AWS, you are considered a principal. When you use some services, you might perform an action that then initiates another action in a diﬀerent service. FAS uses the permissions of the principal calling an AWS service, combined with the requesting AWS service to make requests to downstream services. FAS requests are only made when a service receives a request that requires interactions with other AWS services or resources to complete. In this case, you must have permissions to perform both actions. For policy details when making FAS requests, see Forward access sessions. • Service role – A service role is an IAM role that a service assumes to perform actions on your behalf. An IAM administrator can create, modify, and delete a service role from within IAM. For more information, see Create a role to delegate permissions to an AWS service in the IAM User Guide. • Service-linked role – A service-linked role is a type of service role that is linked to an AWS service. The service can assume the role to perform an action on your behalf. Service-linked roles appear in your AWS account and are owned by the service. An IAM administrator can view, but not edit the permissions for service-linked roles. • Applications running on Amazon EC2 – You can use an IAM role to manage temporary credentials for applications that are running on an EC2 instance and making AWS CLI or AWS API requests. This is preferable to storing access keys within the EC2 instance. To assign an AWS role to an EC2 instance and make it available to all of its applications, you create an instance proﬁle Authenticating with identities 228 Amazon MQ Developer Guide that is attached to the instance. An instance proﬁle contains the role and enables programs that are running on the EC2 instance to get temporary credentials. For more information, see Use an IAM role to grant permissions to applications running on Amazon EC2 instances in the IAM User Guide. Managing access using policies You control access in AWS by creating policies and attaching them to AWS identities or resources. A policy is an object in AWS that, when associated with an identity or resource, deﬁnes their permissions. AWS evaluates these policies when a principal (user, root user, or role session) makes a request.
amazon-mq-dg-065	amazon-mq-dg.pdf	65	to the instance. An instance proﬁle contains the role and enables programs that are running on the EC2 instance to get temporary credentials. For more information, see Use an IAM role to grant permissions to applications running on Amazon EC2 instances in the IAM User Guide. Managing access using policies You control access in AWS by creating policies and attaching them to AWS identities or resources. A policy is an object in AWS that, when associated with an identity or resource, deﬁnes their permissions. AWS evaluates these policies when a principal (user, root user, or role session) makes a request. Permissions in the policies determine whether the request is allowed or denied. Most policies are stored in AWS as JSON documents. For more information about the structure and contents of JSON policy documents, see Overview of JSON policies in the IAM User Guide. Administrators can use AWS JSON policies to specify who has access to what. That is, which principal can perform actions on what resources, and under what conditions. By default, users and roles have no permissions. To grant users permission to perform actions on the resources that they need, an IAM administrator can create IAM policies. The administrator can then add the IAM policies to roles, and users can assume the roles. IAM policies deﬁne permissions for an action regardless of the method that you use to perform the operation. For example, suppose that you have a policy that allows the iam:GetRole action. A user with that policy can get role information from the AWS Management Console, the AWS CLI, or the AWS API. Identity-based policies Identity-based policies are JSON permissions policy documents that you can attach to an identity, such as an IAM user, group of users, or role. These policies control what actions users and roles can perform, on which resources, and under what conditions. To learn how to create an identity-based policy, see Deﬁne custom IAM permissions with customer managed policies in the IAM User Guide. Identity-based policies can be further categorized as inline policies or managed policies. Inline policies are embedded directly into a single user, group, or role. Managed policies are standalone policies that you can attach to multiple users, groups, and roles in your AWS account. Managed policies include AWS managed policies and customer managed policies. To learn how to choose between a managed policy or an inline policy, see Choose between managed policies and inline policies in the IAM User Guide. Managing access using policies 229 Amazon MQ Resource-based policies Developer Guide Resource-based policies are JSON policy documents that you attach to a resource. Examples of resource-based policies are IAM role trust policies and Amazon S3 bucket policies. In services that support resource-based policies, service administrators can use them to control access to a speciﬁc resource. For the resource where the policy is attached, the policy deﬁnes what actions a speciﬁed principal can perform on that resource and under what conditions. You must specify a principal in a resource-based policy. Principals can include accounts, users, roles, federated users, or AWS services. Resource-based policies are inline policies that are located in that service. You can't use AWS managed policies from IAM in a resource-based policy. Access Control Lists (ACLs) Access control lists (ACLs) control which principals (account members, users, or roles) have permissions to access a resource. ACLs are similar to resource-based policies, although they do not use the JSON policy document format. Amazon S3, AWS WAF, and Amazon VPC are examples of services that support ACLs. To learn more about ACLs, see Access control list (ACL) overview in the Amazon Simple Storage Service Developer Guide. Other policy types AWS supports additional, less-common policy types. These policy types can set the maximum permissions granted to you by the more common policy types. • Permissions boundaries – A permissions boundary is an advanced feature in which you set the maximum permissions that an identity-based policy can grant to an IAM entity (IAM user or role). You can set a permissions boundary for an entity. The resulting permissions are the intersection of an entity's identity-based policies and its permissions boundaries. Resource-based policies that specify the user or role in the Principal ﬁeld are not limited by the permissions boundary. An explicit deny in any of these policies overrides the allow. For more information about permissions boundaries, see Permissions boundaries for IAM entities in the IAM User Guide. • Service control policies (SCPs) – SCPs are JSON policies that specify the maximum permissions for an organization or organizational unit (OU) in AWS Organizations. AWS Organizations is a service for grouping and centrally managing multiple AWS accounts that your business owns. If Managing access using policies 230 Amazon MQ Developer Guide you enable all features in an organization, then you can apply service control policies (SCPs)
amazon-mq-dg-066	amazon-mq-dg.pdf	66	limited by the permissions boundary. An explicit deny in any of these policies overrides the allow. For more information about permissions boundaries, see Permissions boundaries for IAM entities in the IAM User Guide. • Service control policies (SCPs) – SCPs are JSON policies that specify the maximum permissions for an organization or organizational unit (OU) in AWS Organizations. AWS Organizations is a service for grouping and centrally managing multiple AWS accounts that your business owns. If Managing access using policies 230 Amazon MQ Developer Guide you enable all features in an organization, then you can apply service control policies (SCPs) to any or all of your accounts. The SCP limits permissions for entities in member accounts, including each AWS account root user. For more information about Organizations and SCPs, see Service control policies in the AWS Organizations User Guide. • Resource control policies (RCPs) – RCPs are JSON policies that you can use to set the maximum available permissions for resources in your accounts without updating the IAM policies attached to each resource that you own. The RCP limits permissions for resources in member accounts and can impact the eﬀective permissions for identities, including the AWS account root user, regardless of whether they belong to your organization. For more information about Organizations and RCPs, including a list of AWS services that support RCPs, see Resource control policies (RCPs) in the AWS Organizations User Guide. • Session policies – Session policies are advanced policies that you pass as a parameter when you programmatically create a temporary session for a role or federated user. The resulting session's permissions are the intersection of the user or role's identity-based policies and the session policies. Permissions can also come from a resource-based policy. An explicit deny in any of these policies overrides the allow. For more information, see Session policies in the IAM User Guide. Multiple policy types When multiple types of policies apply to a request, the resulting permissions are more complicated to understand. To learn how AWS determines whether to allow a request when multiple policy types are involved, see Policy evaluation logic in the IAM User Guide. How Amazon MQ works with IAM Before you use IAM to manage access to Amazon MQ, you should understand what IAM features are available to use with Amazon MQ. To get a high-level view of how Amazon MQ and other AWS services work with IAM, see AWS Services That Work with IAM in the IAM User Guide. Amazon MQ uses IAM for creating, updating, and deleting operations, but native ActiveMQ authentication for brokers. For more information, see Integrating ActiveMQ brokers with LDAP. Topics • Amazon MQ identity-based policies • Amazon MQ Resource-based policies • Authorization based on Amazon MQ tags How Amazon MQ works with IAM 231 Amazon MQ • Amazon MQ IAM roles Amazon MQ identity-based policies Developer Guide With IAM identity-based policies, you can specify allowed or denied actions and resources as well as the conditions under which actions are allowed or denied. Amazon MQ supports speciﬁc actions, resources, and condition keys. To learn about all of the elements that you use in a JSON policy, see IAM JSON Policy Elements Reference in the IAM User Guide. Actions Administrators can use AWS JSON policies to specify who has access to what. That is, which principal can perform actions on what resources, and under what conditions. The Action element of a JSON policy describes the actions that you can use to allow or deny access in a policy. Policy actions usually have the same name as the associated AWS API operation. There are some exceptions, such as permission-only actions that don't have a matching API operation. There are also some operations that require multiple actions in a policy. These additional actions are called dependent actions. Include actions in a policy to grant permissions to perform the associated operation. Policy actions in Amazon MQ use the following preﬁx before the action: mq:. For example, to grant someone permission to run an Amazon MQ instance with the Amazon MQ CreateBroker API operation, you include the mq:CreateBroker action in their policy. Policy statements must include either an Action or NotAction element. Amazon MQ deﬁnes its own set of actions that describe tasks that you can perform with this service. To specify multiple actions in a single statement, separate them with commas as follows: "Action": [ "mq:action1", "mq:action2" You can specify multiple actions using wildcards (). For example, to specify all actions that begin with the word Describe, include the following action: "Action": "mq:Describe" How Amazon MQ works with IAM 232 Amazon MQ Developer Guide To see a list of Amazon MQ actions, see Actions Deﬁned by Amazon MQ in the IAM User Guide. Resources Administrators can use AWS JSON policies to specify who has access to what.
amazon-mq-dg-067	amazon-mq-dg.pdf	67	of actions that describe tasks that you can perform with this service. To specify multiple actions in a single statement, separate them with commas as follows: "Action": [ "mq:action1", "mq:action2" You can specify multiple actions using wildcards (). For example, to specify all actions that begin with the word Describe, include the following action: "Action": "mq:Describe" How Amazon MQ works with IAM 232 Amazon MQ Developer Guide To see a list of Amazon MQ actions, see Actions Deﬁned by Amazon MQ in the IAM User Guide. Resources Administrators can use AWS JSON policies to specify who has access to what. That is, which principal can perform actions on what resources, and under what conditions. The Resource JSON policy element speciﬁes the object or objects to which the action applies. Statements must include either a Resource or a NotResource element. As a best practice, specify a resource using its Amazon Resource Name (ARN). You can do this for actions that support a speciﬁc resource type, known as resource-level permissions. For actions that don't support resource-level permissions, such as listing operations, use a wildcard () to indicate that the statement applies to all resources. "Resource": "" In the Amazon MQ, the primary AWS resources are an Amazon MQ message broker and its conﬁguration. Amazon MQ brokers and conﬁgurations each have unique Amazon Resource Names (ARNs) associated with them, as shown in the following table. Resource Types ARN Condition Keys brokers arn:aws:mq:us-east-1:123456789012:br oker:${brokerName}:${brokerId} aws:ResourceTag/${ TagKey} conﬁgura tions arn:${Partition}:mq:${Region}:${Acco unt}:configuration:${configuration-i aws:ResourceTag/${ TagKey} d} For more information about the format of ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces. For example, to specify the broker named MyBroker with brokerId b-1234a5b6-78cd-901e-2fgh-3i45j6k178l9 in your statement, use the following ARN: How Amazon MQ works with IAM 233 Amazon MQ Developer Guide "Resource": "arn:aws:mq:us- east-1:123456789012:broker:MyBroker:b-1234a5b6-78cd-901e-2fgh-3i45j6k178l9" To specify all brokers and conﬁgurations that belong to a speciﬁc account, use the wildcard (): "Resource": "arn:aws:mq:us-east-1:123456789012:" Some Amazon MQ actions, such as those for creating resources, cannot be performed on a speciﬁc resource. In those cases, you must use the wildcard (). "Resource": "" The API action CreateTags requires both a broker and a conﬁguration. To specify multiple resources in a single statement, separate the ARNs with commas. "Resource": [ "resource1", "resource2" To see a list of Amazon MQ resource types and their ARNs, see Resources Deﬁned by Amazon MQ in the IAM User Guide. To learn with which actions you can specify the ARN of each resource, see Actions Deﬁned by Amazon MQ. Condition keys Administrators can use AWS JSON policies to specify who has access to what. That is, which principal can perform actions on what resources, and under what conditions. The Condition element (or Condition block) lets you specify conditions in which a statement is in eﬀect. The Condition element is optional. You can create conditional expressions that use condition operators, such as equals or less than, to match the condition in the policy with values in the request. If you specify multiple Condition elements in a statement, or multiple keys in a single Condition element, AWS evaluates them using a logical AND operation. If you specify multiple values for a single condition key, AWS evaluates the condition using a logical OR operation. All of the conditions must be met before the statement's permissions are granted. How Amazon MQ works with IAM 234 Amazon MQ Developer Guide You can also use placeholder variables when you specify conditions. For example, you can grant an IAM user permission to access a resource only if it is tagged with their IAM user name. For more information, see IAM policy elements: variables and tags in the IAM User Guide. AWS supports global condition keys and service-speciﬁc condition keys. To see all AWS global condition keys, see AWS global condition context keys in the IAM User Guide. Amazon MQ does not deﬁne any service-speciﬁc condition keys, but supports using some global condition keys. To see a list of Amazon MQ condition keys, see the table below or Condition Keys for Amazon MQ in the IAM User Guide. To learn with which actions and resources you can use a condition key, see Actions Deﬁned by Amazon MQ. Condition Keys Description aws:Reque stTag/${TagKey} Filters actions based on the tags that are passed in the request. Filters actions based on the tags associated with the resource. Type String String Filters actions based on the tag keys that are passed in the request. String aws:Resou rceTag/${ TagKey} aws:TagKeys Examples To view examples of Amazon MQ identity-based policies, see Amazon MQ Identity-based policy examples. Amazon MQ Resource-based policies Currently, Amazon MQ doesn't support IAM authentication using resource-based permissions or resource-based policies. Authorization based on Amazon MQ tags You can attach tags to Amazon MQ resources or pass tags in a request to Amazon MQ. To control access
amazon-mq-dg-068	amazon-mq-dg.pdf	68	actions based on the tags that are passed in the request. Filters actions based on the tags associated with the resource. Type String String Filters actions based on the tag keys that are passed in the request. String aws:Resou rceTag/${ TagKey} aws:TagKeys Examples To view examples of Amazon MQ identity-based policies, see Amazon MQ Identity-based policy examples. Amazon MQ Resource-based policies Currently, Amazon MQ doesn't support IAM authentication using resource-based permissions or resource-based policies. Authorization based on Amazon MQ tags You can attach tags to Amazon MQ resources or pass tags in a request to Amazon MQ. To control access based on tags, you provide tag information in the condition element of a policy using the mq:ResourceTag/key-name, aws:RequestTag/key-name, or aws:TagKeys condition keys. How Amazon MQ works with IAM 235 Amazon MQ Developer Guide Amazon MQ supports policies based on tags. For instance, you could deny access to Amazon MQ resources that include a tag with the key environment and the value production: { "Version": "2012-10-17", "Statement": [ { "Effect": "Deny", "Action": [ "mq:DeleteBroker", "mq:RebootBroker", "mq:DeleteTags" ], "Resource": "*", "Condition": { "StringEquals": { "aws:ResourceTag/environment": "production" } } } ] } This policy will Deny the ability to delete or reboot an Amazon MQ broker that includes the tag environment/production. For more information on tagging, see: • Adding tags to Amazon MQ resources • Controlling Access Using IAM Tags Amazon MQ IAM roles An IAM role is an entity within your AWS account that has speciﬁc permissions. Using Temporary Credentials with Amazon MQ You can use temporary credentials to sign in with federation, assume an IAM role, or to assume a cross-account role. You obtain temporary security credentials by calling AWS STS API operations such as AssumeRole or GetFederationToken. Amazon MQ supports using temporary credentials. How Amazon MQ works with IAM 236 Amazon MQ Service roles Developer Guide This feature allows a service to assume a service role on your behalf. This role allows the service to access resources in other services to complete an action on your behalf. Service roles appear in your IAM account and are owned by the account. This means that an IAM administrator can change the permissions for this role. However, doing so might break the functionality of the service. Amazon MQ supports service roles. Amazon MQ Identity-based policy examples By default, users and roles don't have permission to create or modify Amazon MQ resources. They also can't perform tasks using the AWS Management Console, AWS CLI, or AWS API. An IAM administrator must create IAM policies that grant users and roles permission to perform speciﬁc API operations on the speciﬁed resources they need. The administrator must then attach those policies to the IAM users or groups that require those permissions. To learn how to create an IAM identity-based policy using these example JSON policy documents, see Creating Policies on the JSON Tab in the IAM User Guide. Topics • Policy best practices • Using the Amazon MQ console • Allow users to view their own permissions Policy best practices Identity-based policies determine whether someone can create, access, or delete Amazon MQ resources in your account. These actions can incur costs for your AWS account. When you create or edit identity-based policies, follow these guidelines and recommendations: • Get started with AWS managed policies and move toward least-privilege permissions – To get started granting permissions to your users and workloads, use the AWS managed policies that grant permissions for many common use cases. They are available in your AWS account. We recommend that you reduce permissions further by deﬁning AWS customer managed policies that are speciﬁc to your use cases. For more information, see AWS managed policies or AWS managed policies for job functions in the IAM User Guide. Identity-based policy examples 237 Amazon MQ Developer Guide • Apply least-privilege permissions – When you set permissions with IAM policies, grant only the permissions required to perform a task. You do this by deﬁning the actions that can be taken on speciﬁc resources under speciﬁc conditions, also known as least-privilege permissions. For more information about using IAM to apply permissions, see Policies and permissions in IAM in the IAM User Guide. • Use conditions in IAM policies to further restrict access – You can add a condition to your policies to limit access to actions and resources. For example, you can write a policy condition to specify that all requests must be sent using SSL. You can also use conditions to grant access to service actions if they are used through a speciﬁc AWS service, such as AWS CloudFormation. For more information, see IAM JSON policy elements: Condition in the IAM User Guide. • Use IAM Access Analyzer to validate your IAM policies to ensure secure and functional permissions – IAM Access Analyzer validates new and existing policies
amazon-mq-dg-069	amazon-mq-dg.pdf	69	further restrict access – You can add a condition to your policies to limit access to actions and resources. For example, you can write a policy condition to specify that all requests must be sent using SSL. You can also use conditions to grant access to service actions if they are used through a speciﬁc AWS service, such as AWS CloudFormation. For more information, see IAM JSON policy elements: Condition in the IAM User Guide. • Use IAM Access Analyzer to validate your IAM policies to ensure secure and functional permissions – IAM Access Analyzer validates new and existing policies so that the policies adhere to the IAM policy language (JSON) and IAM best practices. IAM Access Analyzer provides more than 100 policy checks and actionable recommendations to help you author secure and functional policies. For more information, see Validate policies with IAM Access Analyzer in the IAM User Guide. • Require multi-factor authentication (MFA) – If you have a scenario that requires IAM users or a root user in your AWS account, turn on MFA for additional security. To require MFA when API operations are called, add MFA conditions to your policies. For more information, see Secure API access with MFA in the IAM User Guide. For more information about best practices in IAM, see Security best practices in IAM in the IAM User Guide. Using the Amazon MQ console To access the Amazon MQ console, you must have a minimum set of permissions. These permissions must allow you to list and view details about the Amazon MQ resources in your AWS account. If you create an identity-based policy that is more restrictive than the minimum required permissions, the console won't function as intended for entities (IAM users or roles) with that policy. To ensure that those entities can still use the Amazon MQ console, also attach the following AWS managed policy to the entities. For more information, see Adding Permissions to a User in the IAM User Guide: AmazonMQReadOnlyAccess Identity-based policy examples 238 Amazon MQ Developer Guide You don't need to allow minimum console permissions for users that are making calls only to the AWS CLI or the AWS API. Instead, allow access to only the actions that match the API operation that you're trying to perform. Allow users to view their own permissions This example shows how you might create a policy that allows IAM users to view the inline and managed policies that are attached to their user identity. This policy includes permissions to complete this action on the console or programmatically using the AWS CLI or AWS API. { "Version": "2012-10-17", "Statement": [ { "Sid": "ViewOwnUserInfo", "Effect": "Allow", "Action": [ "iam:GetUserPolicy", "iam:ListGroupsForUser", "iam:ListAttachedUserPolicies", "iam:ListUserPolicies", "iam:GetUser" ], "Resource": ["arn:aws:iam:::user/${aws:username}"] }, { "Sid": "NavigateInConsole", "Effect": "Allow", "Action": [ "iam:GetGroupPolicy", "iam:GetPolicyVersion", "iam:GetPolicy", "iam:ListAttachedGroupPolicies", "iam:ListGroupPolicies", "iam:ListPolicyVersions", "iam:ListPolicies", "iam:ListUsers" ], "Resource": "" } ] } Identity-based policy examples 239 Amazon MQ Developer Guide API authentication and authorization for Amazon MQ Amazon MQ uses standard AWS request signing for API authentication. For more information, see Signing AWS API Requests in the AWS General Reference. Note Currently, Amazon MQ doesn't support IAM authentication using resource-based permissions or resource-based policies. To authorize AWS users to work with brokers, conﬁgurations, and users, you must edit your IAM policy permissions. Topics • IAM Permissions Required to Create an Amazon MQ Broker • Amazon MQ REST API permissions reference • Resource-level permissions for Amazon MQ API actions IAM Permissions Required to Create an Amazon MQ Broker To create a broker, you must either use the AmazonMQFullAccess IAM policy or include the following EC2 permissions in your IAM policy. The following custom policy is comprised of two statements (one conditional) which grant permissions to manipulate the resources which Amazon MQ requires to create an ActiveMQ broker. Important • The ec2:CreateNetworkInterface action is required to allow Amazon MQ to create an elastic network interface (ENI) in your account on your behalf. • The ec2:CreateNetworkInterfacePermission action authorizes Amazon MQ to attach the ENI to an ActiveMQ broker. • The ec2:AuthorizedService condition key ensures that ENI permissions can be granted only to Amazon MQ service accounts. API authentication and authorization 240 Amazon MQ Developer Guide { "Version": "2012-10-17", "Statement": [{ "Action": [ "mq:", "ec2:CreateNetworkInterface", "ec2:DeleteNetworkInterface", "ec2:DetachNetworkInterface", "ec2:DescribeInternetGateways", "ec2:DescribeNetworkInterfaces", "ec2:DescribeRouteTables", "ec2:DescribeSecurityGroups", "ec2:DescribeSubnets", "ec2:DescribeVpcs" ], "Effect": "Allow", "Resource": "" },{ "Action": [ "ec2:CreateNetworkInterfacePermission", "ec2:DeleteNetworkInterfacePermission", "ec2:DescribeNetworkInterfacePermissions" ], "Effect": "Allow", "Resource": "*", "Condition": { "StringEquals": { "ec2:AuthorizedService": "mq.amazonaws.com" } } }] } For more information, see Step 2: create a user and get your AWS credentials and Never Modify or Delete the Amazon MQ Elastic Network Interface. Amazon MQ REST API permissions reference The following table lists Amazon MQ REST APIs and the corresponding IAM permissions. API authentication and authorization 241 Amazon MQ Developer Guide Amazon MQ REST APIs and Required Permissions Amazon MQ
amazon-mq-dg-070	amazon-mq-dg.pdf	70	"Action": [ "mq:", "ec2:CreateNetworkInterface", "ec2:DeleteNetworkInterface", "ec2:DetachNetworkInterface", "ec2:DescribeInternetGateways", "ec2:DescribeNetworkInterfaces", "ec2:DescribeRouteTables", "ec2:DescribeSecurityGroups", "ec2:DescribeSubnets", "ec2:DescribeVpcs" ], "Effect": "Allow", "Resource": "" },{ "Action": [ "ec2:CreateNetworkInterfacePermission", "ec2:DeleteNetworkInterfacePermission", "ec2:DescribeNetworkInterfacePermissions" ], "Effect": "Allow", "Resource": "", "Condition": { "StringEquals": { "ec2:AuthorizedService": "mq.amazonaws.com" } } }] } For more information, see Step 2: create a user and get your AWS credentials and Never Modify or Delete the Amazon MQ Elastic Network Interface. Amazon MQ REST API permissions reference The following table lists Amazon MQ REST APIs and the corresponding IAM permissions. API authentication and authorization 241 Amazon MQ Developer Guide Amazon MQ REST APIs and Required Permissions Amazon MQ REST APIs Required Permissions CreateBroker mq:CreateBroker CreateConfiguration mq:CreateConfiguration CreateTags CreateUser DeleteBroker DeleteUser mq:CreateTags mq:CreateUser mq:DeleteBroker mq:DeleteUser DescribeBroker mq:DescribeBroker DescribeConfiguration mq:DescribeConfiguration DescribeConfigurationRevision mq:DescribeConfigurationRevision DescribeUser ListBrokers mq:DescribeUser mq:ListBrokers ListConfigurationRevisions mq:ListConfigurationRevisions ListConfigurations mq:ListConfigurations ListTags ListUsers RebootBroker UpdateBroker mq:ListTags mq:ListUsers mq:RebootBroker mq:UpdateBroker UpdateConfiguration mq:UpdateConfiguration UpdateUser mq:UpdateUser API authentication and authorization 242 Amazon MQ Developer Guide Resource-level permissions for Amazon MQ API actions The term resource-level permissions refers to the ability to specify the resources on which users are allowed to perform actions. Amazon MQ has partial support for resource-level permissions. For certain Amazon MQ actions, you can control when users are allowed to use those actions based on conditions that have to be fulﬁlled, or speciﬁc resources that users are allowed to use. The following table describes the Amazon MQ API actions that currently support resource-level permissions, as well as the supported resources, resource ARNs, and condition keys for each action. Important If an Amazon MQ API action is not listed in this table, then it does not support resource- level permissions. If an Amazon MQ API action does not support resource-level permissions, you can grant users permission to use the action, but you have to specify a wildcard for the resource element of your policy statement. API Action Resource Types (required) CreateConfiguration conﬁgurations CreateTags CreateUser DeleteBroker DeleteUser DescribeBroker brokers, conﬁgurations brokers* brokers* brokers* brokers* DescribeConfiguration conﬁgurations* DescribeConfigurat conﬁgurations* ionRevision DescribeUser brokers* API authentication and authorization 243 Amazon MQ API Action Resource Types (required) Developer Guide ListConfigurationR conﬁgurations evisions ListConfigurationR conﬁgurations* evisions ListTags ListUsers RebootBroker UpdateBroker brokers, conﬁgurations brokers* brokers* brokers* UpdateConfiguration conﬁgurations* UpdateUser brokers* AWS managed policies for Amazon MQ An AWS managed policy is a standalone policy that is created and administered by AWS. AWS managed policies are designed to provide permissions for many common use cases so that you can start assigning permissions to users, groups, and roles. Keep in mind that AWS managed policies might not grant least-privilege permissions for your speciﬁc use cases because they're available for all AWS customers to use. We recommend that you reduce permissions further by deﬁning customer managed policies that are speciﬁc to your use cases. You cannot change the permissions deﬁned in AWS managed policies. If AWS updates the permissions deﬁned in an AWS managed policy, the update aﬀects all principal identities (users, groups, and roles) that the policy is attached to. AWS is most likely to update an AWS managed policy when a new AWS service is launched or new API operations become available for existing services. For more information, see AWS managed policies in the IAM User Guide. Amazon MQ supports the following AWS managed policies: AWS managed policies 244 Amazon MQ Developer Guide • AmazonMQApiFullAccess • AmazonMQApiReadOnlyAccess • AmazonMQFullAccess • AmazonMQReadOnlyAccess • AmazonMQServiceRolePolicy AWS managed policy: AmazonMQServiceRolePolicy You can't attach AmazonMQServiceRolePolicy to your IAM entities. This policy is attached to a service-linked role that allows Amazon MQ to perform actions on your behalf. For more information about this permission policy and the actions it allows Amazon MQ to perform, see the section called “Service-linked role permissions for Amazon MQ”. Amazon MQ updates to AWS managed policies View details about updates to AWS managed policies for Amazon MQ since this service began tracking these changes. For automatic alerts about changes to this page, subscribe to the RSS feed on the Amazon MQ Document history page. Change Description Date Amazon MQ started tracking changes Amazon MQ started tracking changes for its AWS managed policies. May 5, 2021 Using service-linked roles for Amazon MQ Amazon MQ uses AWS Identity and Access Management (IAM) service-linked roles. A service-linked role is a unique type of IAM role that is linked directly to Amazon MQ. Service-linked roles are predeﬁned by Amazon MQ and include all the permissions that the service requires to call other AWS services on your behalf. Using service-linked roles 245 Amazon MQ Developer Guide A service-linked role makes setting up Amazon MQ easier because you don’t have to manually add the necessary permissions. Amazon MQ deﬁnes the permissions of its service-linked roles, and unless deﬁned otherwise, only Amazon MQ can assume its roles. The deﬁned permissions include the trust policy and the permissions policy, and that permissions policy cannot be attached to
amazon-mq-dg-071	amazon-mq-dg.pdf	71	of IAM role that is linked directly to Amazon MQ. Service-linked roles are predeﬁned by Amazon MQ and include all the permissions that the service requires to call other AWS services on your behalf. Using service-linked roles 245 Amazon MQ Developer Guide A service-linked role makes setting up Amazon MQ easier because you don’t have to manually add the necessary permissions. Amazon MQ deﬁnes the permissions of its service-linked roles, and unless deﬁned otherwise, only Amazon MQ can assume its roles. The deﬁned permissions include the trust policy and the permissions policy, and that permissions policy cannot be attached to any other IAM entity. You can delete a service-linked role only after ﬁrst deleting their related resources. This protects your Amazon MQ resources because you can't inadvertently remove permission to access the resources. For information about other services that support service-linked roles, see AWS services that work with IAM and look for the services that have Yes in the Service-Linked Role column. Choose a Yes with a link to view the service-linked role documentation for that service. Service-linked role permissions for Amazon MQ Amazon MQ uses the service-linked role named AWSServiceRoleForAmazonMQ – Amazon MQ uses this service-linked role to call AWS services on your behalf. The AWSServiceRoleForAmazonMQ service-linked role trusts the following services to assume the role: • mq.amazonaws.com Amazon MQ uses the permission policy AmazonMQServiceRolePolicy, which is attached to the AWSServiceRoleForAmazonMQ service-linked role, to complete the following actions on the speciﬁed resources: • Action: ec2:CreateVpcEndpoint on the vpc resource. • Action: ec2:CreateVpcEndpoint on the subnet resource. • Action: ec2:CreateVpcEndpoint on the security-group resource. • Action: ec2:CreateVpcEndpoint on the vpc-endpoint resource. • Action: ec2:DescribeVpcEndpoints on the vpc resource. • Action: ec2:DescribeVpcEndpoints on the subnet resource. Using service-linked roles 246 Amazon MQ Developer Guide • Action: ec2:CreateTags on the vpc-endpoint resource. • Action: logs:PutLogEvents on the log-group resource. • Action: logs:DescribeLogStreams on the log-group resource. • Action: logs:DescribeLogGroups on the log-group resource. • Action: CreateLogStream on the log-group resource. • Action: CreateLogGroup on the log-group resource. When you create an Amazon MQ for RabbitMQ broker, the AmazonMQServiceRolePolicy permission policy allows Amazon MQ to perform the following tasks on your behalf. • Create a Amazon VPC endpoint for the broker using the Amazon VPC, subnet, and security-group you provide. You can use the endpoint created for your broker to connect to the broker via the RabbitMQ management console, the management API, or programatically. • Create log groups, and publish broker logs to Amazon CloudWatch Logs. { "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Action": [ "ec2:DescribeVpcEndpoints" ], "Resource": "" }, { "Effect": "Allow", "Action": [ "ec2:CreateVpcEndpoint" ], "Resource": [ "arn:aws:ec2:::vpc/", "arn:aws:ec2:::subnet/", "arn:aws:ec2:::security-group/" Using service-linked roles 247 Developer Guide Amazon MQ ] }, { "Effect": "Allow", "Action": [ "ec2:CreateVpcEndpoint" ], "Resource": [ "arn:aws:ec2:::vpc-endpoint/" ], "Condition": { "StringEquals": { "aws:RequestTag/AMQManaged": "true" } } }, { "Effect": "Allow", "Action": [ "ec2:CreateTags" ], "Resource": "arn:aws:ec2:::vpc-endpoint/", "Condition": { "StringEquals": { "ec2:CreateAction": "CreateVpcEndpoint" } } }, { "Effect": "Allow", "Action": [ "ec2:DeleteVpcEndpoints" ], "Resource": "arn:aws:ec2:::vpc-endpoint/", "Condition": { "StringEquals": { "ec2:ResourceTag/AMQManaged": "true" } } }, { "Effect": "Allow", "Action": [ "logs:PutLogEvents", Using service-linked roles 248 Amazon MQ Developer Guide "logs:DescribeLogStreams", "logs:DescribeLogGroups", "logs:CreateLogStream", "logs:CreateLogGroup" ], "Resource": [ "arn:aws:logs:::log-group:/aws/amazonmq/" ] } ] } You must conﬁgure permissions to allow an IAM entity (such as a user, group, or role) to create, edit, or delete a service-linked role. For more information, see Service-Linked Role Permissions in the IAM User Guide. Creating a service-linked role for Amazon MQ You don't need to manually create a service-linked role. When you ﬁrst create a broker, Amazon MQ creates a service-linked role to call AWS services on your behalf. All subsequent brokers that you create will use the same role and no new role is created. Important This service-linked role can appear in your account if you completed an action in another service that uses the features supported by this role. To learn more, see A New Role Appeared in My IAM Account. If you delete this service-linked role, and then need to create it again, you can use the same process to recreate the role in your account. You can also use the IAM console to create a service-linked role with the Amazon MQ use case. In the AWS CLI or the AWS API, create a service-linked role with the mq.amazonaws.com service name. For more information, see Creating a service-linked role in the IAM User Guide. If you delete this service-linked role, you can use this same process to create the role again. Important Service Linked Roles are only created for Amazon MQ for RabbitMQ. Using service-linked roles 249 Amazon MQ Developer Guide Editing a service-linked role for Amazon MQ Amazon MQ does not allow you to edit the AWSServiceRoleForAmazonMQ service-linked role. However, you can edit the description of the role using IAM. For more
amazon-mq-dg-072	amazon-mq-dg.pdf	72	case. In the AWS CLI or the AWS API, create a service-linked role with the mq.amazonaws.com service name. For more information, see Creating a service-linked role in the IAM User Guide. If you delete this service-linked role, you can use this same process to create the role again. Important Service Linked Roles are only created for Amazon MQ for RabbitMQ. Using service-linked roles 249 Amazon MQ Developer Guide Editing a service-linked role for Amazon MQ Amazon MQ does not allow you to edit the AWSServiceRoleForAmazonMQ service-linked role. However, you can edit the description of the role using IAM. For more information, see Editing a service-linked role in the IAM User Guide. Deleting a service-linked role for Amazon MQ If you no longer need to use a feature or service that requires a service-linked role, we recommend that you delete that role. That way you don’t have an unused entity that is not actively monitored or maintained. However, you must clean up the resources for your service-linked role before you can manually delete it. Note If the Amazon MQ service is using the role when you try to delete the resources, then the deletion might fail. If that happens, wait for a few minutes and try the operation again. To delete Amazon MQ resources used by the AWSServiceRoleForAmazonMQ • Delete your Amazon MQ brokers using the AWS Management Console, Amazon MQ CLI, or Amazon MQ API. For more information about deleting brokers, see ???. To manually delete the service-linked role using IAM Use the IAM console, the AWS CLI, or the AWS API to delete the AWSServiceRoleForAmazonMQ service-linked role. For more information, see Deleting a Service-Linked Role in the IAM User Guide. Supported regions for Amazon MQ service-linked roles Amazon MQ supports using service-linked roles in all of the regions where the service is available. For more information, see AWS Regions and Endpoints. Region name Region identity Support in Amazon MQ US East (N. Virginia) US East (Ohio) us-east-1 us-east-2 Yes Yes Using service-linked roles 250 Amazon MQ Region name Region identity Support in Amazon MQ Developer Guide US West (N. California) US West (Oregon) Asia Paciﬁc (Mumbai) Asia Paciﬁc (Osaka) Asia Paciﬁc (Seoul) Asia Paciﬁc (Singapore) Asia Paciﬁc (Sydney) Asia Paciﬁc (Tokyo) Canada (Central) Europe (Frankfurt) Europe (Ireland) Europe (London) Europe (Paris) South America (São Paulo) us-west-1 us-west-2 ap-south-1 ap-northeast-3 ap-northeast-2 ap-southeast-1 ap-southeast-2 ap-northeast-1 ca-central-1 eu-central-1 eu-west-1 eu-west-2 eu-west-3 sa-east-1 AWS GovCloud (US) us-gov-west-1 Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes No Troubleshooting Amazon MQ identity and access Use the following information to help you diagnose and ﬁx common issues that you might encounter when working with Amazon MQ and IAM. Topics • I Am Not Authorized to Perform an Action in Amazon MQ • I am not authorized to perform iam:PassRole Troubleshooting 251 Amazon MQ Developer Guide • I want to allow people outside of my AWS account to access my Amazon MQ resources I Am Not Authorized to Perform an Action in Amazon MQ If the AWS Management Console tells you that you're not authorized to perform an action, then you must contact your administrator for assistance. Your administrator is the person that provided you with your sign-in credentials. The following example error occurs when the mateojackson user tries to use the console to view details about a widget but does not have mq:GetWidget permissions. User: arn:aws:iam::123456789012:user/mateojackson is not authorized to perform: mq:GetWidget on resource: my-example-widget In this case, Mateo asks his administrator to update his policies to allow him to access the my- example-widget resource using the mq:GetWidget action. I am not authorized to perform iam:PassRole If you receive an error that you're not authorized to perform the iam:PassRole action, your policies must be updated to allow you to pass a role to Amazon MQ. Some AWS services allow you to pass an existing role to that service instead of creating a new service role or service-linked role. To do this, you must have permissions to pass the role to the service. The following example error occurs when an IAM user named marymajor tries to use the console to perform an action in Amazon MQ. However, the action requires the service to have permissions that are granted by a service role. Mary does not have permissions to pass the role to the service. User: arn:aws:iam::123456789012:user/marymajor is not authorized to perform: iam:PassRole In this case, Mary's policies must be updated to allow her to perform the iam:PassRole action. If you need help, contact your AWS administrator. Your administrator is the person who provided you with your sign-in credentials. Troubleshooting 252 Amazon MQ Developer Guide I want to allow people outside of my AWS account to access my Amazon MQ resources You can create a role that users in other accounts or
amazon-mq-dg-073	amazon-mq-dg.pdf	73	service to have permissions that are granted by a service role. Mary does not have permissions to pass the role to the service. User: arn:aws:iam::123456789012:user/marymajor is not authorized to perform: iam:PassRole In this case, Mary's policies must be updated to allow her to perform the iam:PassRole action. If you need help, contact your AWS administrator. Your administrator is the person who provided you with your sign-in credentials. Troubleshooting 252 Amazon MQ Developer Guide I want to allow people outside of my AWS account to access my Amazon MQ resources You can create a role that users in other accounts or people outside of your organization can use to access your resources. You can specify who is trusted to assume the role. For services that support resource-based policies or access control lists (ACLs), you can use those policies to grant people access to your resources. To learn more, consult the following: • To learn whether Amazon MQ supports these features, see How Amazon MQ works with IAM. • To learn how to provide access to your resources across AWS accounts that you own, see Providing access to an IAM user in another AWS account that you own in the IAM User Guide. • To learn how to provide access to your resources to third-party AWS accounts, see Providing access to AWS accounts owned by third parties in the IAM User Guide. • To learn how to provide access through identity federation, see Providing access to externally authenticated users (identity federation) in the IAM User Guide. • To learn the diﬀerence between using roles and resource-based policies for cross-account access, see Cross account resource access in IAM in the IAM User Guide. Compliance validation for Amazon MQ Third-party auditors assess the security and compliance of Amazon MQ as part of multiple AWS compliance programs. These include SOC, PCI, HIPAA, and others. To learn whether an AWS service is within the scope of speciﬁc compliance programs, see AWS services in Scope by Compliance Program and choose the compliance program that you are interested in. For general information, see AWS Compliance Programs. You can download third-party audit reports using AWS Artifact. For more information, see Downloading Reports in AWS Artifact. Your compliance responsibility when using AWS services is determined by the sensitivity of your data, your company's compliance objectives, and applicable laws and regulations. AWS provides the following resources to help with compliance: • Security Compliance & Governance – These solution implementation guides discuss architectural considerations and provide steps for deploying security and compliance features. Compliance validation 253 Amazon MQ Developer Guide • HIPAA Eligible Services Reference – Lists HIPAA eligible services. Not all AWS services are HIPAA eligible. • AWS Compliance Resources – This collection of workbooks and guides might apply to your industry and location. • AWS Customer Compliance Guides – Understand the shared responsibility model through the lens of compliance. The guides summarize the best practices for securing AWS services and map the guidance to security controls across multiple frameworks (including National Institute of Standards and Technology (NIST), Payment Card Industry Security Standards Council (PCI), and International Organization for Standardization (ISO)). • Evaluating Resources with Rules in the AWS Conﬁg Developer Guide – The AWS Conﬁg service assesses how well your resource conﬁgurations comply with internal practices, industry guidelines, and regulations. • AWS Security Hub – This AWS service provides a comprehensive view of your security state within AWS. Security Hub uses security controls to evaluate your AWS resources and to check your compliance against security industry standards and best practices. For a list of supported services and controls, see Security Hub controls reference. • Amazon GuardDuty – This AWS service detects potential threats to your AWS accounts, workloads, containers, and data by monitoring your environment for suspicious and malicious activities. GuardDuty can help you address various compliance requirements, like PCI DSS, by meeting intrusion detection requirements mandated by certain compliance frameworks. • AWS Audit Manager – This AWS service helps you continuously audit your AWS usage to simplify how you manage risk and compliance with regulations and industry standards. Resilience in Amazon MQ The AWS global infrastructure is built around AWS Regions and Availability Zones. AWS Regions provide multiple physically separated and isolated Availability Zones, which are connected with low-latency, high-throughput, and highly redundant networking. With Availability Zones, you can design and operate applications and databases that automatically fail over between zones without interruption. Availability Zones are more highly available, fault tolerant, and scalable than traditional single or multiple data center infrastructures. For more information about AWS Regions and Availability Zones, see AWS Global Infrastructure. Resilience 254 Amazon MQ Developer Guide Infrastructure security in Amazon MQ As a managed service, is protected by AWS global network security. For information about AWS security services and how AWS protects infrastructure, see AWS
amazon-mq-dg-074	amazon-mq-dg.pdf	74	separated and isolated Availability Zones, which are connected with low-latency, high-throughput, and highly redundant networking. With Availability Zones, you can design and operate applications and databases that automatically fail over between zones without interruption. Availability Zones are more highly available, fault tolerant, and scalable than traditional single or multiple data center infrastructures. For more information about AWS Regions and Availability Zones, see AWS Global Infrastructure. Resilience 254 Amazon MQ Developer Guide Infrastructure security in Amazon MQ As a managed service, is protected by AWS global network security. For information about AWS security services and how AWS protects infrastructure, see AWS Cloud Security. To design your AWS environment using the best practices for infrastructure security, see Infrastructure Protection in Security Pillar AWS Well‐Architected Framework. You use AWS published API calls to access through the network. Clients must support the following: • Transport Layer Security (TLS). We require TLS 1.2 and recommend TLS 1.3. • Cipher suites with perfect forward secrecy (PFS) such as DHE (Ephemeral Diﬃe-Hellman) or ECDHE (Elliptic Curve Ephemeral Diﬃe-Hellman). Most modern systems such as Java 7 and later support these modes. Additionally, requests must be signed by using an access key ID and a secret access key that is associated with an IAM principal. Or you can use the AWS Security Token Service (AWS STS) to generate temporary security credentials to sign requests. Security best practices for Amazon MQ The following design patterns can improve the security of your Amazon MQ broker. Topics • Prefer brokers without public accessibility • Always conﬁgure an authorization map • Block unnecessary protocols with VPC security groups For more information about how Amazon MQ encrypts your data, as well as a list of supported protocols, see Data Protection. Prefer brokers without public accessibility Brokers created without public accessibility can't be accessed from outside of your VPC. This greatly reduces your broker's susceptibility to Distributed Denial of Service (DDoS) attacks from the public internet. For more information, see How to Help Prepare for DDoS Attacks by Reducing Your Attack Surface on the AWS Security Blog. Infrastructure security 255 Amazon MQ Developer Guide Always conﬁgure an authorization map Because ActiveMQ has no authorization map conﬁgured by default, any authenticated user can perform any action on the broker. Thus, it is a best practice to restrict permissions by group. For more information, see authorizationEntry. 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. Block unnecessary protocols with VPC security groups To improve security for private brokers, you should restrict the connections of unnecessary protocols and ports by properly conﬁguring your Amazon VPC Security Group. For instance, to restrict access to most protocols while allowing access to OpenWire and the web console, you could allow access to only 61617 and 8162. This limits your exposure by blocking protocols you are not using, while allowing OpenWire and the web console to function normally. Allow only the protocol ports that you are using. • AMQP: 5671 • MQTT: 8883 • OpenWire: 61617 • STOMP: 61614 • WebSocket: 61619 For more information see: • Security Groups for your VPC • Default Security Group for Your VPC • Working with Security Groups Always conﬁgure an authorization map 256 Amazon MQ Developer Guide Logging and monitoring Amazon MQ brokers Monitoring is an important part of maintaining the reliability, availability, and performance of your AWS solutions. You should collect monitoring data from all of the parts of your AWS solution so that you can more easily debug a multi-point failure if one occurs. AWS provides several tools for monitoring your Amazon MQ resources and responding to potential incidents: You can use CloudWatch to view and analyze metrics for your Amazon MQ broker. You can view and analyze your broker metrics from the CloudWatch console, the AWS CLI, or the CloudWatch AWS CLI. CloudWatch metrics for Amazon MQ are automatically polled from the broker and then pushed to CloudWatch every minute. For ActiveMQ brokers, CloudWatch monitors only the ﬁrst 1000 destinations.. For RabbitMQ brokers, CloudWatch monitors only the ﬁrst 500 destinations, ordered by number of consumers.. For a full list of Amazon MQ metrics, see Available CloudWatch metrics Amazon MQ for ActiveMQ brokers. For information about creating a CloudWatch alarm for a metrics, see Create or Edit a CloudWatch Alarm in the Amazon CloudWatch User Guide. Accessing CloudWatch metrics for Amazon MQ You can access CloudWatch metrics using the AWS Management Console, AWS CLI, and API. You may want to access CloudWatch metrics without using the AWS Management Console. To access Amazon MQ metrics using the AWS CLI, use the get-metric-statistics command. For more information, see Get Statistics for a Metric in the Amazon CloudWatch
amazon-mq-dg-075	amazon-mq-dg.pdf	75	consumers.. For a full list of Amazon MQ metrics, see Available CloudWatch metrics Amazon MQ for ActiveMQ brokers. For information about creating a CloudWatch alarm for a metrics, see Create or Edit a CloudWatch Alarm in the Amazon CloudWatch User Guide. Accessing CloudWatch metrics for Amazon MQ You can access CloudWatch metrics using the AWS Management Console, AWS CLI, and API. You may want to access CloudWatch metrics without using the AWS Management Console. To access Amazon MQ metrics using the AWS CLI, use the get-metric-statistics command. For more information, see Get Statistics for a Metric in the Amazon CloudWatch User Guide. To access Amazon MQ metrics using the CloudWatch API, use the GetMetricStatistics action. For more information, see Get Statistics for a Metric in the Amazon CloudWatch User Guide. Accesing CloudWatch metrics using the AWS Management Console The following example shows you how to access CloudWatch metrics for Amazon MQ using the AWS Management Console.If you're already signed into the Amazon MQ console, on the broker Details page, choose Actions, View CloudWatch metrics. Accessing CloudWatch metrics 257 Amazon MQ Developer Guide 1. Sign in to the CloudWatch console. 2. On the navigation panel, choose Metrics. 3. 4. Select the AmazonMQ metric namespace. Select one of the following metric dimensions: • Broker Metrics • Queue Metrics by Broker • Topic Metrics by Broker In this example, Broker Metrics is selected. 5. 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 ﬁlter by metric, choose the metric name and then choose Add to search. Available CloudWatch metrics Amazon MQ for ActiveMQ brokers Amazon MQ for ActiveMQ metrics Metric Unit Description AmqpMaximumConnect Count ions BurstBalance Percent The maximum number of clients you can connect to your broker using AMQP. For more information on connection quotas, see Quotas in Amazon MQ. The percentage of burst credits remaining on the Amazon EBS volume used Metrics for ActiveMQ 258 Amazon MQ Metric Unit Description Developer Guide to persist message data for throughput-optimiz ed brokers. If this balance reaches zero, the IOPS provided by the Amazon EBS volume will decrease until the Burst Balance reﬁlls. For more information on how Burst Balances work in Amazon EBS, see: I/O Credits and Burst Performance. Amazon MQ for ActiveMQ metrics 259 Amazon MQ Metric Unit Description Developer Guide CpuCreditBalance Credits (vCPU-minutes) Important This metric is available only for the mq.t2.micro broker instance type. CPU credit metrics are available only at ﬁve- minute intervals. The number of earned CPU credits that an instance has accrued since it was launched or started (including the number of launch credits). The credit balance is available for the broker instance to spend on bursts beyond the baseline CPU utilization. Credits are accrued in the credit balance after they're earned and removed from the credit balance after they're spent. The credit balance has a maximum limit. Once the limit is reached, any newly earned credits are discarded. The percentage of allocated Amazon EC2 compute units that the broker currently uses. CpuUtilization Percent Amazon MQ for ActiveMQ metrics 260 Amazon MQ Metric Unit Description Developer Guide CurrentConnections Count Count EstablishedConnect Count ionsCount HeapUsage Percent InactiveDurableTop Count icSubscribersCount JobSchedulerStoreP Percent ercentUsage JournalFilesForFas Count tRecovery JournalFilesForFul Count lRecovery MqttMaximumConnect Count ions The current number of active connections on the current broker. The total number of connections, active and inactive, that have been established on the broker. The percentage of the ActiveMQ JVM memory limit that the broker currently uses. The number of inactive durable topic subscribers, up to a maximum of 2000. The percentage of disk space used by the job scheduler store. The number of journal ﬁles that will be replayed after a clean shutdown. The number of journal ﬁles that will be replayed after an unclean shutdown. The maximum number of clients you can connect to your broker using MQTT. For more information on connection quotas, see Quotas in Amazon MQ. Amazon MQ for ActiveMQ metrics 261 Amazon MQ Metric Unit Description Developer Guide NetworkConnectorCo Count nnectionCount NetworkIn NetworkOut Bytes Bytes OpenTransactionCount Count OpenwireMaximumCon Count nections StompMaximumConnec Count tions StorePercentUsage Percent TempPercentUsage Percent The number of nodes connected to the broker in a network of brokers using NetworkConnector. The volume of incoming traﬃc for the broker. The volume of outgoing traﬃc for the broker. The total number of transacti ons in progress. The maximum number of clients you can connect to your broker using OpenWire. For more information on connection quotas, see Quotas in Amazon MQ. The maximum number of clients you can connect to your broker using STOMP. For more information on connection quotas, see Quotas in Amazon MQ. The percent used by the storage limit. If this reaches 100, the broker
amazon-mq-dg-076	amazon-mq-dg.pdf	76	The number of nodes connected to the broker in a network of brokers using NetworkConnector. The volume of incoming traﬃc for the broker. The volume of outgoing traﬃc for the broker. The total number of transacti ons in progress. The maximum number of clients you can connect to your broker using OpenWire. For more information on connection quotas, see Quotas in Amazon MQ. The maximum number of clients you can connect to your broker using STOMP. For more information on connection quotas, see Quotas in Amazon MQ. The percent used by the storage limit. If this reaches 100, the broker will refuse messages. The percentage of available temporary storage used by non-persistent messages. Amazon MQ for ActiveMQ metrics 262 Amazon MQ Metric Unit Description Developer Guide TotalConsumerCount Count TotalMessageCount Count TotalProducerCount Count VolumeReadOps Count VolumeWriteOps Count WsMaximumConnections Count The number of message consumers subscribed to destinations on the current broker. The number of messages stored on the broker. The number of message producers active on destinati ons on the current broker. The number of read operation s performed on the Amazon EBS volume. The number of write operations performed on the Amazon EBS volume. The maximum number of clients you can connect to your broker using WebSocket . For more information on connection quotas, see Quotas in Amazon MQ. Dimensions for ActiveMQ broker metrics Dimension Broker Description The name of the broker Amazon MQ for ActiveMQ metrics 263 Amazon MQ Dimension Developer Guide Description Note A single-instance broker has the suﬃx -1. An active/standby broker for high availability has the suﬃxes -1 and -2 for its redundant pair. ActiveMQ destination (queue and topic) metrics Important The following metrics include per-minute counts for the CloudWatch polling period. • EnqueueCount • ExpiredCount • DequeueCount • DispatchCount • InFlightCount For example, in a ﬁve-minute CloudWatch period, EnqueueCount has ﬁve count values, each for a one-minute portion of the period. The Minimum and Maximum statistics provide the lowest and highest per-minute value during the speciﬁed period. Metric ConsumerCount EnqueueCount Unit Count Count Description The number of consumers subscribed to the destination. The number of messages sent to the destination, per minute. ActiveMQ destination (queue and topic) metrics 264 Amazon MQ Metric Unit Description Developer Guide EnqueueTime Time (milliseconds) ExpiredCount Count DispatchCount Count The end-to-end latency from when a message arrives at a broker until it is delivered to a consumer. Note EnqueueTime does not measure the end-to-end latency from when a message is sent by a producer until it reaches the broker, nor the latency from when a message is received by a broker until it is acknowled ged by the broker. Rather, EnqueueTi me is the number of milliseconds from the moment a message is received by the broker until it is successfu lly delivered to a consumer. The number of messages that couldn't be delivered because they expired, per minute. The number of messages sent to consumers, per minute. ActiveMQ destination (queue and topic) metrics 265 Amazon MQ Metric DequeueCount Unit Count InFlightCount Count ReceiveCount Count MemoryUsage Percent ProducerCount Count QueueSize Count TotalEnqueueCount Count TotalDequeueCount Count Developer Guide Description The number of messages acknowledged by consumers, per minute. The number of messages sent to consumers that have not been acknowledged. The number of messages that have been received from the remote broker for a duplex network connector. The percentage of the memory limit that the destination currently uses. The number of producers for the destination. The number of messages in the queue. Important This metric applies only to queues. The total number of messages that have been sent to the broker. The total number of messages that have been consumed by clients. ActiveMQ destination (queue and topic) metrics 266 Amazon MQ Note Developer Guide TotalEnqueueCount and TotalDequeueCount metrics include messages for advisory topics. For more information about advisory topic messages, see the ActiveMQ documentation. Dimensions for ActiveMQ destination (queue and topic) metrics Dimension Broker Description The name of the broker. Note A single-instance broker has the suﬃx -1. An active/standby broker for high availability has the suﬃxes -1 and -2 for its redundant pair. Topic or Queue The name of the topic or queue. NetworkConnector The name of the network connector. Available CloudWatch metrics for Amazon MQ for RabbitMQ brokers RabbitMQ broker metrics Metric ExchangeCount Unit Count Description The total number of exchanges conﬁgured on the broker. Metrics for RabbitMQ 267 Amazon MQ Metric QueueCount Unit Count ConnectionCount Count ChannelCount Count ConsumerCount Count MessageCount Count MessageReadyCount Count MessageUnacknowled Count gedCount Developer Guide Description The total number of queues conﬁgured on the broker. The total number of connections established on the broker. The total number of channels established on the broker. The total number of consumers connected to the broker. The total number of messages in the queues. Note The number produced is
amazon-mq-dg-077	amazon-mq-dg.pdf	77	CloudWatch metrics for Amazon MQ for RabbitMQ brokers RabbitMQ broker metrics Metric ExchangeCount Unit Count Description The total number of exchanges conﬁgured on the broker. Metrics for RabbitMQ 267 Amazon MQ Metric QueueCount Unit Count ConnectionCount Count ChannelCount Count ConsumerCount Count MessageCount Count MessageReadyCount Count MessageUnacknowled Count gedCount Developer Guide Description The total number of queues conﬁgured on the broker. The total number of connections established on the broker. The total number of channels established on the broker. The total number of consumers connected to the broker. The total number of messages in the queues. Note The number produced is the total sum of ready and unacknowl edged messages on the broker. The total number of ready messages in the queues. The total number of unacknowledged messages in the queues. RabbitMQ broker metrics 268 Amazon MQ Metric PublishRate Unit Count ConfirmRate Count AckRate Count Developer Guide Description The rate at which messages are published to the broker. The number produced represents the number of messages per second at the time of sampling. The rate at which the RabbitMQ server is conﬁrmin g published messages. You can compare this metric with PublishRate to better understand how your broker is performing. The number produced represents the number of messages per second at the time of sampling. The rate at which messages are being acknowledged by consumers. The number produced represents the number of messages per second at the time of sampling. RabbitMQ broker metrics 269 Amazon MQ Metric Unit Description Developer Guide SystemCpuUtilization Percent RabbitMQMemLimit Bytes RabbitMQMemUsed Bytes RabbitMQDiskFreeLi Bytes mit The percentage of allocated Amazon EC2 compute units that the broker currently uses. For cluster deploymen ts, this value represents the aggregate of all three RabbitMQ nodes' correspon ding metric values. The RAM limit for a RabbitMQ broker. For cluster deploymen ts, this value represents the aggregate of all three RabbitMQ nodes' correspon ding metric values. The volume of RAM used by a RabbitMQ broker. For cluster deployments, this value represents the aggregate of all three RabbitMQ nodes' corresponding metric values. The disk limit for a RabbitMQ broker. For cluster deploymen ts, this value represents the aggregate of all three RabbitMQ nodes' correspon ding metric values. This metric is diﬀerent per instance size. RabbitMQ broker metrics 270 Amazon MQ Metric RabbitMQDiskFree Unit Bytes RabbitMQFdUsed Count RabbitMQIOReadAver Count ageTime RabbitMQIOWriteAve Count rageTime Developer Guide Description The total volume of free disk space available in a RabbitMQ broker. When disk usage goes above its limit, the cluster will block all producer connectio ns. For cluster deploymen ts, this value represents the aggregate of all three RabbitMQ nodes' correspon ding metric values. Number of ﬁle descriptors used. For cluster deploymen ts, this value represents the aggregate of all three RabbitMQ nodes' correspon ding metric values. The average time (in milliseco nds) for RabbitMQ to perform one read operation. The value is proportional to the message size. The average time (in milliseco nds) for RabbitMQ to perform one write operation. The value is proportional to the message size. RabbitMQ broker metrics 271 Amazon MQ Developer Guide Dimensions for RabbitMQ broker metrics Dimension Broker Description The name of the broker. RabbitMQ node metrics Metric Unit Description SystemCpuUtilization Percent RabbitMQMemLimit Bytes RabbitMQMemUsed Bytes RabbitMQDiskFreeLi Bytes mit RabbitMQDiskFree Bytes RabbitMQFdUsed Count The percentage of allocated Amazon EC2 compute units that the broker currently uses. The RAM limit for a RabbitMQ node. The volume of RAM used by a RabbitMQ node. When memory use goes above the limit, the cluster will block all producer connections. The disk limit for a RabbitMQ node. This metric is diﬀerent per instance size. The total volume of free disk space available in a RabbitMQ node. When disk usage goes above its limit, the cluster will block all producer connectio ns. Number of ﬁle descriptors used. Dimensions for RabbitMQ broker metrics 272 Amazon MQ Developer Guide Dimensions for RabbitMQ node metrics Dimension Node Description The name of the node. Note A node name consists of two parts: a preﬁx (usuallly rabbit) and a hostname. For example, rabbit@ip-10-0-0-230.us- west-2.compute.intern al is a node name with the preﬁx rabbit and the hostname ip-10-0-0-230.us-west-2.com pute.internal . Broker The name of the broker. RabbitMQ queue metrics Metric ConsumerCount Unit Count MessageReadyCount Count MessageUnacknowled Count gedCount Description The number of consumers subscribed to the queue. The number of messages that are currently available to be delivered. The number of messages for which the server is awaiting acknowledgement. Dimensions for RabbitMQ node metrics 273 Amazon MQ Metric MessageCount Unit Count Developer Guide Description The total number of MessageReadyCount and MessageUnacknowled gedCount (also known as queue depth). Dimensions for RabbitMQ queue metrics Note Amazon MQ for RabbitMQ will not publish metrics for virtual hosts and queues with names containing blank spaces, tabs or other non-ASCII characters. For more information about dimension
amazon-mq-dg-078	amazon-mq-dg.pdf	78	Unit Count MessageReadyCount Count MessageUnacknowled Count gedCount Description The number of consumers subscribed to the queue. The number of messages that are currently available to be delivered. The number of messages for which the server is awaiting acknowledgement. Dimensions for RabbitMQ node metrics 273 Amazon MQ Metric MessageCount Unit Count Developer Guide Description The total number of MessageReadyCount and MessageUnacknowled gedCount (also known as queue depth). Dimensions for RabbitMQ queue metrics Note Amazon MQ for RabbitMQ will not publish metrics for virtual hosts and queues with names containing blank spaces, tabs or other non-ASCII characters. For more information about dimension names, see Dimension in the Amazon CloudWatch API Reference. Dimension Queue VirtualHost Broker Description The name of the queue. The name of the virtual host. The name of the broker. Conﬁguring Amazon MQ for RabbitMQ logs When you enable CloudWatch logging for your RabbitMQ brokers, Amazon MQ uses a service- linked role to publish general logs to CloudWatch. If no Amazon MQ service-linked role exists when you ﬁrst create a broker, Amazon MQ will automatically create one. All subsequent RabbitMQ brokers will use the same service-linked role to publish logs to CloudWatch. For more information about service-linked roles, see Using service-linked roles in the AWS Identity and Access Management User Guide. For more information about how Amazon MQ uses service- linked roles, see the section called “Using service-linked roles”. Dimensions for RabbitMQ queue metrics 274 Amazon MQ Developer Guide Logging Amazon MQ API calls using AWS CloudTrail Amazon MQ is integrated with AWS CloudTrail, a service that provides a record of the Amazon MQ calls that a user, role, or AWS service makes. CloudTrail captures API calls related to Amazon MQ brokers and conﬁgurations as events, including calls from the Amazon MQ console and code calls from Amazon MQ APIs. For more information about CloudTrail, see the AWS CloudTrail User Guide. Note CloudTrail doesn't log API calls related to ActiveMQ operations (for example, sending and receiving messages) or to the ActiveMQ Web Console. To log information related to ActiveMQ operations, you can conﬁgure Amazon MQ to publish general and audit logs to Amazon CloudWatch Logs. Using the information that CloudTrail collects, you can identify a speciﬁc request to an Amazon MQ API, the IP address of the requester, the requester's identity, the date and time of the request, and so on. If you conﬁgure a trail, you can enable continuous delivery of CloudTrail events to an Amazon S3 bucket. If you don't conﬁgure a trail, you can view the most recent events in the event history in the CloudTrail console. For more information, see Overview for Creating a Trail in the AWS CloudTrail User Guide. Amazon MQ Information in CloudTrail 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 in the AWS CloudTrail User Guide. A trail allows CloudTrail to deliver log ﬁles 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 ﬁles to the speciﬁed Amazon S3 bucket. You can also conﬁgure 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 • Conﬁguring Amazon SNS Notiﬁcations for CloudTrail Logging API calls using CloudTrail 275 Amazon MQ Developer Guide • Receiving CloudTrail Log Files from Multiple Regions • Receiving CloudTrail Log Files from Multiple Accounts Amazon MQ supports logging both the request parameters and the responses for the following APIs as events in CloudTrail log ﬁles: • CreateConfiguration • DeleteBroker • DeleteUser • RebootBroker • UpdateBroker Note RebootBroker log ﬁles are logged when you reboot the broker. During the maintenance window, the service automatically reboots, and RebootBroker log ﬁles are not logged. Important For the GET methods of the following APIs, the request parameters are logged, but the responses are redacted: • DescribeBroker • DescribeConfiguration • DescribeConfigurationRevision • DescribeUser • ListBrokers • ListConfigurationRevisions • ListConfigurations • ListUsers For the following APIs, the data and password request parameters are hidden by asterisks (***): Amazon MQ Information in CloudTrail 276 Amazon MQ Developer Guide • CreateBroker (POST) • CreateUser (POST) • UpdateConfiguration (PUT) • UpdateUser (PUT) Every event or log entry contains information about the requester. This information helps you determine the following: • Was the request made
amazon-mq-dg-079	amazon-mq-dg.pdf	79	RebootBroker log ﬁles are not logged. Important For the GET methods of the following APIs, the request parameters are logged, but the responses are redacted: • DescribeBroker • DescribeConfiguration • DescribeConfigurationRevision • DescribeUser • ListBrokers • ListConfigurationRevisions • ListConfigurations • ListUsers For the following APIs, the data and password request parameters are hidden by asterisks (*): Amazon MQ Information in CloudTrail 276 Amazon MQ Developer Guide • CreateBroker (POST) • CreateUser (POST) • UpdateConfiguration (PUT) • UpdateUser (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 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 in the AWS CloudTrail User Guide. Example Amazon MQ Log File Entry A trail is a conﬁguration that allows the delivery of events as log ﬁles to the speciﬁed Amazon S3 bucket. CloudTrail log ﬁles contain one or more log entries. An event represents a single request from any source and includes information about the request to an Amazon MQ API, the IP address of the requester, the requester's identity, the date and time of the request, and so on. The following example shows a CloudTrail log entry for a CreateBroker API call. Note Because CloudTrail log ﬁles aren't an ordered stack trace of public APIs, they don't list information in any speciﬁc order. { "eventVersion": "1.06", "userIdentity": { "type": "IAMUser", "principalId": "AKIAIOSFODNN7EXAMPLE", Example Amazon MQ Log File Entry 277 Amazon MQ Developer Guide "arn": "arn:aws:iam::111122223333:user/AmazonMqConsole", "accountId": "111122223333", "accessKeyId": "AKIAI44QH8DHBEXAMPLE", "userName": "AmazonMqConsole" }, "eventTime": "2018-06-28T22:23:46Z", "eventSource": "amazonmq.amazonaws.com", "eventName": "CreateBroker", "awsRegion": "us-west-2", "sourceIPAddress": "203.0.113.0", "userAgent": "PostmanRuntime/7.1.5", "requestParameters": { "engineVersion": "5.15.9", "deploymentMode": "ACTIVE_STANDBY_MULTI_AZ", "maintenanceWindowStartTime": { "dayOfWeek": "THURSDAY", "timeOfDay": "22:45", "timeZone": "America/Los_Angeles" }, "engineType": "ActiveMQ", "hostInstanceType": "mq.m5.large", "users": [ { "username": "MyUsername123", "password": "", "consoleAccess": true, "groups": [ "admins", "support" ] }, { "username": "MyUsername456", "password": "*", "groups": [ "admins" ] } ], "creatorRequestId": "1", "publiclyAccessible": true, "securityGroups": [ "sg-a1b234cd" ], Example Amazon MQ Log File Entry 278 Amazon MQ Developer Guide "brokerName": "MyBroker", "autoMinorVersionUpgrade": false, "subnetIds": [ "subnet-12a3b45c", "subnet-67d8e90f" ] }, "responseElements": { "brokerId": "b-1234a5b6-78cd-901e-2fgh-3i45j6k178l9", "brokerArn": "arn:aws:mq:us- east-2:123456789012:broker:MyBroker:b-1234a5b6-78cd-901e-2fgh-3i45j6k178l9" }, "requestID": "a1b2c345-6d78-90e1-f2g3-4hi56jk7l890", "eventID": "a12bcd3e-fg45-67h8-ij90-12k34d5l16mn", "readOnly": false, "eventType": "AwsApiCall", "recipientAccountId": "111122223333" } Conﬁguring Amazon MQ for ActiveMQ logs To allow Amazon MQ to publish logs to CloudWatch Logs, you must add a permission to your Amazon MQ user and also conﬁgure a resource-based policy for Amazon MQ before you create or restart the broker. Note When you turn on logs and publish messages from the ActiveMQ web console, the content of the message is sent to CloudWatch and displayed in the logs. The following describes the steps to conﬁgure CloudWatch logs for your ActiveMQ brokers. Topics • Understanding the structure of logging in CloudWatch Logs • Add the CreateLogGroup permission to your Amazon MQ user • Conﬁgure a resource-based policy for Amazon MQ • Cross-service confused deputy prevention Conﬁguring Amazon MQ for ActiveMQ logs 279 Amazon MQ Developer Guide Understanding the structure of logging in CloudWatch Logs You can enable general and audit logging when you conﬁgure advanced broker settings when you create a broker, or when you edit a broker. General logging enables the default INFO logging level (DEBUG logging isn't supported) and publishes activemq.log to a log group in your CloudWatch account. The log group has a format similar to the following: /aws/amazonmq/broker/b-1234a5b6-78cd-901e-2fgh-3i45j6k178l9/general Audit logging enables logging of management actions taken using JMX or using the ActiveMQ Web Console and publishes audit.log to a log group in your CloudWatch account. The log group has a format similar to the following: /aws/amazonmq/broker/b-1234a5b6-78cd-901e-2fgh-3i45j6k178l9/audit Depending on whether you have a single-instance broker or an active/standby broker, Amazon MQ creates either one or two log streams within each log group. The log streams have a format similar to the following. activemq-b-1234a5b6-78cd-901e-2fgh-3i45j6k178l9-1.log activemq-b-1234a5b6-78cd-901e-2fgh-3i45j6k178l9-2.log The -1 and -2 suﬃxes denote individual broker instances. For more information, see Working with Log Groups and Log Streams in the Amazon CloudWatch Logs User Guide. Add the CreateLogGroup permission to your Amazon MQ user To allow Amazon MQ to create a CloudWatch Logs log group, you must ensure that the user who creates or reboots the broker has the logs:CreateLogGroup permission. Important If you don't add the CreateLogGroup permission to your Amazon MQ user before the user creates or reboots the broker, Amazon MQ doesn't create the log group. Understanding the structure of logging in CloudWatch Logs 280 Amazon MQ Developer Guide The following example IAM-based policy grants permission for logs:CreateLogGroup for users to whom this policy is attached. { "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Action": "logs:CreateLogGroup", "Resource": "arn:aws:logs:::log-group:/aws/amazonmq/" } ] } Note Here, the term user refers to Users and not Amazon
amazon-mq-dg-080	amazon-mq-dg.pdf	80	you must ensure that the user who creates or reboots the broker has the logs:CreateLogGroup permission. Important If you don't add the CreateLogGroup permission to your Amazon MQ user before the user creates or reboots the broker, Amazon MQ doesn't create the log group. Understanding the structure of logging in CloudWatch Logs 280 Amazon MQ Developer Guide The following example IAM-based policy grants permission for logs:CreateLogGroup for users to whom this policy is attached. { "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Action": "logs:CreateLogGroup", "Resource": "arn:aws:logs:::log-group:/aws/amazonmq/" } ] } Note Here, the term user refers to Users and not Amazon MQ users, which are created when a new broker is conﬁgured. For more information regarding setting up users and conﬁguring IAM policies, please refer to the Identity Management Overview section of the IAM User Guide. For more information, see CreateLogGroup in the Amazon CloudWatch Logs API Reference. Conﬁgure a resource-based policy for Amazon MQ Important If you don't conﬁgure a resource-based policy for Amazon MQ, the broker can't publish the logs to CloudWatch Logs. To allow Amazon MQ to publish logs to your CloudWatch Logs log group, conﬁgure a resource- based policy to give Amazon MQ access to the following CloudWatch Logs API actions: • CreateLogStream – Creates a CloudWatch Logs log stream for the speciﬁed log group. • PutLogEvents – Delivers events to the speciﬁed CloudWatch Logs log stream. Conﬁgure a resource-based policy for Amazon MQ 281 Amazon MQ Developer Guide The following resource-based policy grants permission for logs:CreateLogStream and logs:PutLogEvents to AWS. { "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Principal": { "Service": "mq.amazonaws.com" }, "Action": [ "logs:CreateLogStream", "logs:PutLogEvents" ], "Resource": "arn:aws:logs:::log-group:/aws/ amazonmq/" } ] } This resource-based policy must be conﬁgured by using the AWS CLI as shown by the following command. In the example, replace us-east-1 with your own information. aws --region us-east-1 logs put-resource-policy --policy-name AmazonMQ-logs \ --policy-document "{\"Version\": \"2012-10-17\", \"Statement\": [{ \"Effect\": \"Allow\", \"Principal\": { \"Service\": \"mq.amazonaws.com\" }, \"Action\": [\"logs:CreateLogStream\", \"logs:PutLogEvents\"], \"Resource\": \"arn:aws:logs:::log-group:\/aws\/amazonmq\/\" }]}" Note Because this example uses the /aws/amazonmq/ preﬁx, you need to conﬁgure the resource-based policy only once per AWS account, per region. Cross-service confused deputy prevention The confused deputy problem is a security issue where an entity that doesn't have permission to perform an action can coerce a more-privileged entity to perform the action. In AWS, cross-service impersonation can result in the confused deputy problem. Cross-service impersonation can occur when one service (the calling service) calls another service (the called service). The calling service can be manipulated to use its permissions to act on another customer's resources in a way it should Cross-service confused deputy prevention 282 Amazon MQ Developer Guide not otherwise have permission to access. To prevent this, AWS provides tools that help you protect your data for all services with service principals that have been given access to resources in your account. We recommend using the aws:SourceArn and aws:SourceAccount global condition context keys in your Amazon MQ resource-based policy to limit CloudWatch Logs access to one or more speciﬁed brokers. Note If you use both global condition context keys, the aws:SourceAccount value and the account in the aws:SourceArn value must use the same account ID when used in the same policy statement. The following example demonstrates a resource-based policy that limits CloudWatch Logs access to a single Amazon MQ broker. { "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Principal": { "Service": "mq.amazonaws.com" }, "Action": [ "logs:CreateLogStream", "logs:PutLogEvents" ], "Resource": "arn:aws:logs:::log-group:/aws/amazonmq/", "Condition": { "StringEquals": { "aws:SourceAccount": "123456789012", "aws:SourceArn": "arn:aws:mq:us- east-2:123456789012:broker:MyBroker:b-1234a5b6-78cd-901e-2fgh-3i45j6k178l9" } } } ] } Cross-service confused deputy prevention 283 Amazon MQ Developer Guide You can also conﬁgure your resource-based policy to limit CloudWatch Logs access to all brokers in an account, as shown in the following. { "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Principal": { "Service": [ "mq.amazonaws.com" ] }, "Action": [ "logs:CreateLogStream", "logs:PutLogEvents" ], "Resource": "arn:aws:logs:::log-group:/aws/amazonmq/ ", "Condition": { "ArnLike": { "aws:SourceArn": "arn:aws:mq::123456789012:broker:*" }, "StringEquals": { "aws:SourceAccount": "123456789012" } } } ] } For more information about the confused deputy security issue, see The confused deputy problem in the User Guide. Troubleshooting CloudWatch Logs Conﬁguration with Amazon MQ In some cases, CloudWatch Logs might not always behave as expected. This section gives an overview of common issues and shows how to resolve them. Troubleshooting 284 Amazon MQ Developer Guide Log Groups Don't Appear in CloudWatch Add the CreateLogGroup permission to your Amazon MQ user and reboot the broker. This allows Amazon MQ to create the log group. Log Streams Don't Appear in CloudWatch Log Groups Conﬁgure a resource-based policy for Amazon MQ. This allows your broker to publish its logs. Log Groups Don't Appear in CloudWatch 285 Amazon MQ Developer Guide Quotas in Amazon MQ This topic lists limits within Amazon MQ. Many of the following limits can be changed for speciﬁc AWS accounts. To
amazon-mq-dg-081	amazon-mq-dg.pdf	81	common issues and shows how to resolve them. Troubleshooting 284 Amazon MQ Developer Guide Log Groups Don't Appear in CloudWatch Add the CreateLogGroup permission to your Amazon MQ user and reboot the broker. This allows Amazon MQ to create the log group. Log Streams Don't Appear in CloudWatch Log Groups Conﬁgure a resource-based policy for Amazon MQ. This allows your broker to publish its logs. Log Groups Don't Appear in CloudWatch 285 Amazon MQ Developer Guide Quotas in Amazon MQ This topic lists limits within Amazon MQ. Many of the following limits can be changed for speciﬁc AWS accounts. To request an increase for a limit, see AWS Service Quotas in the Amazon Web Services General Reference. Updated limits will not be visible even after the limit increase has been applied. For more information on viewing current connection limits in Amazon CloudWatch, see Monitoring Amazon MQ brokers using Amazon CloudWatch. Topics • Brokers • Conﬁgurations • Users • Data Storage • API Throttling Brokers The following table lists quotas related to Amazon MQ brokers. Limit Broker name Description • • • • Must be unique in your AWS account. Must be 1-50 characters long. Must contain only characters speciﬁed in the ASCII Printable Character Set. Can contain only alphanumeric character s, dashes, periods, underscores, and tildes (- . _ ~). Number of brokers, per region 50 Brokers 286 Amazon MQ Limit Wire-level connections per protocol for smaller broker Developer Guide Description Important Does not apply to RabbitMQ brokers. 300 for mq..micro instance type brokers. Wire-level connections per protocol for larger broker Important Does not apply to RabbitMQ brokers. 2,000 for mq..large instance type brokers. Security groups per broker 5 ActiveMQ destinations (queues, and topics) monitored in CloudWatch CloudWatch monitors only the ﬁrst 1000 destinations. RabbitMQ destinations (queues) monitored in CloudWatch CloudWatch monitors only the ﬁrst 500 destinations, ordered by number of consumers Tags per broker Conﬁgurations . 50 The following table lists quotas related to Amazon MQ conﬁgurations. Limit Description Conﬁguration name Must be 1-150 characters long. • • Conﬁgurations 287 Amazon MQ Limit Developer Guide Description Must contain only characters speciﬁed in the ASCII Printable Character Set. • Can contain only alphanumeric character s, dashes, periods, underscores, and tildes (- . _ ~). Revisions per conﬁguration 300 Users The following table lists quotas related to Amazon MQ ActiveMQ broker users. Limit Username Password Description Must be 1-100 characters long. Must contain only characters speciﬁed in the ASCII Printable Character Set. Can contain only alphanumeric character s, dashes, periods, underscores, and tildes (- . _ ~). Must not contain commas (,). Must be 12-250 characters long. Must contain only characters speciﬁed in the ASCII Printable Character Set. Must contain at least 4 unique characters. • • • • • • • • Users 288 Amazon MQ Limit Developer Guide Description Must not contain commas (,). Users per broker (simple auth) Groups per user (simple auth) 250 20 Data Storage The following table lists quotas related to Amazon MQ data storage. Limit Description Storage capacity per smaller broker Storage capacity per larger broker Job scheduler usage limit per broker backed by Amazon EBS Temporary storage capacity per smaller broker. 20 GB for mq..micro instance type brokers. For more information regarding A mazon MQ instance types, see Broker instance types. 200 GB for mq.m5.* instance type brokers. For more information regarding Amazon MQ instance types, see Broker instance types. Important Does not apply to RabbitMQ brokers. 50 GB. For more information about job scheduler usage, see JobSchedulerUsage in the Apache ActiveMQ API Documentation. Important Does not apply to RabbitMQ brokers. Data Storage 289 Amazon MQ Limit Temporary storage capacity per larger broker. Developer Guide Description 5 GB for mq..micro instance type brokers. Important Does not apply to RabbitMQ brokers. 50 GB for mq.m5. instance type brokers. API Throttling The following throttling quotas are aggregated per AWS account, across all Amazon MQ APIs to maintain service bandwidth. For more information about Amazon MQ APIs, see the Amazon MQ REST API Reference. Important These quotas don't apply to Amazon MQ for ActiveMQ or Amazon MQ for RabbitMQ broker messaging APIs. For example, Amazon MQ doesn't throttle the sending or receiving of messages. API burst limit 100 API rate limit 15 API Throttling 290 Amazon MQ Developer Guide Troubleshooting Amazon MQ This section describes common issues you might encounter when using Amazon MQ brokers, and the steps you can take to resolve them. For general troubleshooting, see the section called “Troubleshooting: General Amazon MQ”. For troubleshooting your speciﬁc engine version, see the following sections. Troubleshooting ActiveMQ on Amazon MQ Troubleshooting topic Description General troubleshooting Use the information in this section to help you diagnose and resolve common issues you might encounter when working with ActiveMQ on Amazon MQ brokers. BROKER_ENI_DELETED ActiveMQ on Amazon MQ will
amazon-mq-dg-082	amazon-mq-dg.pdf	82	limit 100 API rate limit 15 API Throttling 290 Amazon MQ Developer Guide Troubleshooting Amazon MQ This section describes common issues you might encounter when using Amazon MQ brokers, and the steps you can take to resolve them. For general troubleshooting, see the section called “Troubleshooting: General Amazon MQ”. For troubleshooting your speciﬁc engine version, see the following sections. Troubleshooting ActiveMQ on Amazon MQ Troubleshooting topic Description General troubleshooting Use the information in this section to help you diagnose and resolve common issues you might encounter when working with ActiveMQ on Amazon MQ brokers. BROKER_ENI_DELETED ActiveMQ on Amazon MQ will raise a BROKER_OOM BROKER_ENI_DELETED delete a broker’s Elastic Network Interface alarm when you (ENI). ActiveMQ on Amazon MQ will raise a BROKER_OOM alarm when the broker undergoes a restart loop due to the insuﬃci ent memory capacity Troubleshooting RabbitMQ on Amazon MQ Troubleshooting topic General troubleshooting Description Diagnose common issues you might encounter when working with RabbitMQ brokers. Troubleshooting ActiveMQ on Amazon MQ 291 Amazon MQ Developer Guide Troubleshooting topic Description RABBITMQ_MEMORY_ALARM RABBITMQ_INVALID_KMS_KEY RABBITMQ_DISK_ALARM RabbitMQ will raise a high memory alarm when the broker's memory usage, identiﬁed by CloudWatch metric RabbitMQMemUsed , exceeds the memory limit, identiﬁed by RabbitMQM emLimit . RabbitMQ on Amazon MQ will raise an INVALID_KMS_KEY critical action required code when a broker created with a customer managed AWS KMS key(CMK) detects that the AWS Key Management Service (KMS) key is disabled. Disk limit alarm is an indicatio n that the volume of disk used by a RabbitMQ node has decreased due to a high number of messages not consumed while new messages were added. RABBITMQ_QUORUM_QUEUES_NOT _SUPPORTED_ON_CURR ENT_VERSION RabbitMQ on Amazon MQ will raise the RABBITMQ_ QUORUM_QUEUES_NOT_ SUPPORTED_ON_CURRE NT_VERSION when you attempt to create alarm quorum queues on a single instance or cluster broker using version 3.12 and below. Troubleshooting RabbitMQ on Amazon MQ 292 Amazon MQ Developer Guide Troubleshooting: General Amazon MQ Use the information in this section to help you diagnose common issues you might encounter when working with Amazon MQ brokers, such as issues connecting to your broker, and broker reboots. Contents • I can't connect to my broker web console or endpoints. • My broker is running, and I can verify connectivity using telnet, but my clients are unable to connect and are returning SSL exceptions. • I created a broker but broker creation failed. • My broker restarted and I'm not sure why. I can't connect to my broker web console or endpoints. If you're experiencing issues connecting to your broker using the web console or wire-level endpoints, we recommend the following steps. 1. Check whether you're attempting to connect to your broker from behind a ﬁrewall. You might need to conﬁgure the ﬁrewall to allow access to your broker. 2. Check whether you're trying to connect to your broker using a FIPS endpoint. Amazon MQ only supports FIPS endpoints when using API operations, and not for wire-level connections to the broker instance itself. 3. Check if the Public Accessibility option for your broker is set to Yes. If this is set to No, check your subnet's network Access Control List (ACL) rules. If you've created custom network ACLs, you might need to change the network ACL rules to provide access to your broker. For more information about Amazon VPC networking, see Enabling internet access in the Amazon VPC User Guide 4. Check your broker's Security Group rules. Make sure that you are allowing connections to the following ports: Note The following ports are grouped according to engine types because ActiveMQ on Amazon MQ and RabbitMQ on Amazon MQ use diﬀerent ports for connections. Troubleshooting: General Amazon MQ 293 Amazon MQ Developer Guide ActiveMQ on Amazon MQ • Web console – Port 8162 • OpenWire – Port 61617 • AMQP – Port 5671 • STOMP – Port 61614 • MQTT – Port 8883 • WSS – Port 61619 RabbitMQ on Amazon MQ • Web console and management API – Port 443 and 15671 • AMQP – Port 5671 5. Run the following network connectivity tests for your broker engine type. Note For brokers without public accessibility, run the tests from an Amazon EC2 instance within the same Amazon VPC as your Amazon MQ broker and evaluate the responses. ActiveMQ on Amazon MQ To test your ActiveMQ on Amazon MQ broker's network connectivity 1. Open a new terminal or command line window. 2. Run the following nslookup command to query your broker DNS record. For active/ standby deployments, test both the active and standby endpoints. The active/standby endpoints are identiﬁed with a suﬃx, -1 or -2 added to the unique broker ID. Replace the endpoint with your information. $ nslookup b-1234a5b6-78cd-901e-2fgh-3i45j6k178l9-1.mq.us-west-2.amazonaws.com If the query succeeds, you will see an output similar to the following. Non-authoritative answer: I can't connect to my broker web
amazon-mq-dg-083	amazon-mq-dg.pdf	83	MQ broker and evaluate the responses. ActiveMQ on Amazon MQ To test your ActiveMQ on Amazon MQ broker's network connectivity 1. Open a new terminal or command line window. 2. Run the following nslookup command to query your broker DNS record. For active/ standby deployments, test both the active and standby endpoints. The active/standby endpoints are identiﬁed with a suﬃx, -1 or -2 added to the unique broker ID. Replace the endpoint with your information. $ nslookup b-1234a5b6-78cd-901e-2fgh-3i45j6k178l9-1.mq.us-west-2.amazonaws.com If the query succeeds, you will see an output similar to the following. Non-authoritative answer: I can't connect to my broker web console or endpoints. 294 Amazon MQ Developer Guide Server: dns-resolver-corp-sfo-1.sfo.corp.amazon.com Address: 172.10.123.456 Name: ec2-12-345-123-45.us-west-2.compute.amazonaws.com Address: 12.345.123.45 Aliases: b-1234a5b6-78cd-901e-2fgh-3i45j6k178l9-1.mq.us-west-2.amazonaws.com The resolved IP address should match the IP addresses provided in the Amazon MQ console. This indicates that the domain name is resolving correctly on the DNS server, and you can move on to the next step. 3. Run the following telnet command to test the network path for your broker. Replace the endpoint with your information. Replace port with port number 8162 for the web console, or other wire-level ports to test additional protocols as needed. Note For active/standby deployments, you will receive a Connect failed error message if you run telnet with the standby endpoint. This is expected, as the standby instance itself is running, but the ActiveMQ process is not running and does not have access to the broker's Amazon EFS storage volume. Run the command for both -1 and -2 endpoints to ensure you test both the active and the standby instances. $ telnet b-1234a5b6-78cd-901e-2fgh-3i45j6k178l9-1.mq.us- west-2.amazonaws.com port For the active instance, you will see an output similar to the following. Connected to b-1234a5b6-78cd-901e-2fgh-3i45j6k178l9-1.mq.us- west-2.amazonaws.com. Escape character is '^]'. 4. Do one of the following. • If the telnet command succeeds, check the EstablishedConnectionsCount metric and conﬁrm that the broker has not reached the maximum Wire-level connection limit. You can also conﬁrm if the limit has been reached by reviewing the broker General logs. If this metric is greater than zero, then there is at least I can't connect to my broker web console or endpoints. 295 Amazon MQ Developer Guide one client currently connected to the broker. If the metric shows zero connections, then perform the telnet path test again and wait at least one minute before disconnecting, as broker metrics are published every minute. • If the telnet command fails, check the status of your broker's elastic network interface, and conﬁrm that the status is in-use. Create an Amazon VPC ﬂow log for each instance's network interface, and review the generated ﬂow logs. Look for the broker's IP addresses when you ran the telnet command, and conﬁrm the connection packets are ACCEPTED, including a return packet. For more information, and to see a ﬂow log example, see Flow log record examples in the Amazon VPC Developer Guide. 5. Run the following curl command to check connectivity to the ActiveMQ admin web console. $ curl https://b-1234a5b6-78cd-901e-2fgh-3i45j6k178l9-1.mq.us- west-2.amazonaws.com:8162/index.html If the command succeeds, the output should be an HTML document similar to the following. <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http:// www.w3.org/TR/html4/loose.dtd"> <html> <head> <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" /> <title>Apache ActiveMQ</title> ... RabbitMQ on Amazon MQ To test your RabbitMQ on Amazon MQ broker's network connectivity 1. Open a new terminal or command line window. 2. Run the following nslookup command to query your broker DNS record. Replace the endpoint with your information. $ nslookup b-1234a5b6-78cd-901e-2fgh-3i45j6k178l9-1.mq.us-west-2.amazonaws.com I can't connect to my broker web console or endpoints. 296 Amazon MQ Developer Guide If the query succeeds, you will see an output similar to the following. Non-authoritative answer: Server: dns-resolver-corp-sfo-1.sfo.corp.amazon.com Address: 172.10.123.456 Name: rabbit-broker-1c23e456ca78-b9000123b4ebbab5.elb.us- west-2.amazonaws.com Addresses: 52.12.345.678 52.23.234.56 41.234.567.890 54.123.45.678 Aliases: b-1234a5b6-78cd-901e-2fgh-3i45j6k178l9-1.mq.us-west-2.amazonaws.com 3. Run the following telnet command to test the network path for your broker. Replace the endpoint with your information. You can replace port with port 443 for the web console, and 5671 to test the wire-level AMQP connection. $ telnet b-1234a5b6-78cd-901e-2fgh-3i45j6k178l9-1.mq.us- west-2.amazonaws.com port If the command succeeds, you'll see an output similar to the following. Connected to b-1234a5b6-78cd-901e-2fgh-3i45j6k178l9-1.mq.us- west-2.amazonaws.com. Escape character is '^]'. Note The telnet connection will close automatically after a few seconds. 4. Do one of the following. • If the telnet command succeeds, check the ConnectionCount metric and conﬁrm that the broker has not reached the value set in the max-connections default policy. You can also conﬁrm if the limit has been reached by reviewing the broker Connection.log log group. If this metric is greater than zero, there is at least one client currently connected to the broker. If the metric shows zero connections, then perform the telnet path test again. You may need to repeat this process if I can't connect to my broker web console or endpoints. 297 Amazon MQ Developer Guide the
amazon-mq-dg-084	amazon-mq-dg.pdf	84	the following. • If the telnet command succeeds, check the ConnectionCount metric and conﬁrm that the broker has not reached the value set in the max-connections default policy. You can also conﬁrm if the limit has been reached by reviewing the broker Connection.log log group. If this metric is greater than zero, there is at least one client currently connected to the broker. If the metric shows zero connections, then perform the telnet path test again. You may need to repeat this process if I can't connect to my broker web console or endpoints. 297 Amazon MQ Developer Guide the connection closes before your broker has published new connection metrics to CloudWatch. Metrics are published every minute. • For brokers without public accessibility, if the telnet command fails, check the status of your broker's elastic network interfaces, and conﬁrm that the status is in-use. Create an Amazon VPC ﬂow log for each network interface, and review the generated ﬂow logs. Look for the broker's private IP addresses when you the telnet command was invoked, and conﬁrm the connection packets are ACCEPTED, including a return packet. For more information, and to see a ﬂow log example, see Flow log record examples in the Amazon VPC Developer Guide. Note This step does not apply to RabbitMQ on Amazon MQ brokers with public accessibility. 5. Run the following curl command to check connectivity to the RabbitMQ admin web console. $ curl https://b-1234a5b6-78cd-901e-2fgh-3i45j6k178l9-1.mq.us- west-2.amazonaws.com:443/index.html If the command succeeds, the output should be an HTML document similar to the following. <!DOCTYPE html> <html> <head> <meta http-equiv="X-UA-Compatible" content="IE=edge" /> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <title>RabbitMQ Management</title> ... I can't connect to my broker web console or endpoints. 298 Amazon MQ Developer Guide My broker is running, and I can verify connectivity using telnet, but my clients are unable to connect and are returning SSL exceptions. Your broker endpoint certiﬁcate may have been updated during the broker maintenance window. Amazon MQ broker certiﬁcates are rotated periodically to ensure continued availability and security of brokers. We recommend using the Amazon root certiﬁcate authority (CA) in Amazon Trust Services to authenticate against in your clients' trust store. All Amazon MQ broker certiﬁcates are signed with this root CA. By using an Amazon root CA, you will no longer need to download the new Amazon MQ broker certiﬁcate every time there is a certiﬁcate update on the broker. I created a broker but broker creation failed. If your broker is in a CREATION_FAILED status, do the following. • Check your IAM permissions. To create a broker must either use the AWS managed IAM policy AmazonMQFullAccess or have the correct set of Amazon EC2 permissions in your custom IAM policy. To learn more about the required Amazon EC2 permissions you need, see IAM permissions required to create an Amazon MQ broker. • Check if the subnet you are choosing for your broker is in a shared Amazon Virtual Private Cloud (VPC). To create an Amazon MQ broker in a shared Amazon VPC, you must create it in the account that owns the Amazon VPC. My broker restarted and I'm not sure why. If your broker has restarted automatically, it may be due to one of the following reasons. • Your broker may have restarted because of a scheduled weekly maintenance window. Periodically, Amazon MQ performs maintenance to the hardware, operating system, or the engine software of a message broker. The duration of the maintenance varies, but can last up to two hours, depending on the operations that are scheduled for your message broker. Brokers might restart at any point during the two hour maintenance window. For more information about broker maintenance windows, see the section called “Scheduling broker maintenance”. • Your broker instance type might not be suitable to your application workload. For example, running a production workload on a mq.t2.micro might result in the broker running out of resources. High CPU utilization, or high broker memory usage can cause a broker to unexpectedly SSL exceptions 299 Amazon MQ Developer Guide restart. To see how much CPU and memory is being utilized by your broker, use the following CloudWatch metrics for your engine type. • ActiveMQ on Amazon MQ – Check CpuUtilization for the percentage of allocated Amazon EC2 compute units that the broker currently uses. Check HeapUsagefor the percentage of the ActiveMQ JVM memory limit that the broker currently uses. • RabbitMQ on Amazon MQ – Check SystemCpuUtilization for the percentage of allocated Amazon EC2 compute units that the broker currently uses. Check RabbitMQMemUsed for the volume of RAM used in Bytes, and divide by RabbitMQMemLimit for the percentage of memory used by the RabbitMQ node. For more information about broker instance types and how to choose the right instance type for your workload, see Broker instance types. Troubleshooting ActiveMQ
amazon-mq-dg-085	amazon-mq-dg.pdf	85	CpuUtilization for the percentage of allocated Amazon EC2 compute units that the broker currently uses. Check HeapUsagefor the percentage of the ActiveMQ JVM memory limit that the broker currently uses. • RabbitMQ on Amazon MQ – Check SystemCpuUtilization for the percentage of allocated Amazon EC2 compute units that the broker currently uses. Check RabbitMQMemUsed for the volume of RAM used in Bytes, and divide by RabbitMQMemLimit for the percentage of memory used by the RabbitMQ node. For more information about broker instance types and how to choose the right instance type for your workload, see Broker instance types. Troubleshooting ActiveMQ on Amazon MQ Use the information in this section to help you diagnose and resolve common issues you might encounter when working with ActiveMQ on Amazon MQ brokers. Contents • I can't see general or audit logs for my broker in CloudWatch Logs even though I’ve activated logging. • After broker restart or maintenance window, I can't connect to my broker even though the status is RUNNING. Why? • I see some of my clients connecting to the broker, while others are unable to connect. • I'm seeing exception org.apache.jasper.JasperException: An exception occurred processing JSP page on the ActiveMQ console when performing operations. I can't see general or audit logs for my broker in CloudWatch Logs even though I’ve activated logging. If you’re unable to view logs for your broker in CloudWatch Logs, do the following. 1. Check if the user who creates or reboots the broker has the logs:CreateLogGroup permission. If you don't add the CreateLogGroup permission to a user before the user creates or reboots the broker, Amazon MQ will not create the log group. Troubleshooting ActiveMQ on Amazon MQ 300 Amazon MQ Developer Guide 2. Check if you have conﬁgured a resource-based policy to allow Amazon MQ to publish logs to CloudWatch Logs. To allow Amazon MQ to publish logs to your CloudWatch Logs log group, conﬁgure a resource-based policy to give Amazon MQ access to the following CloudWatch Logs API actions: • CreateLogStream – Creates a CloudWatch Logs log stream for the speciﬁed log group. • PutLogEvents – Delivers events to the speciﬁed CloudWatch Logs log stream. For more information about conﬁguring ActiveMQ on Amazon MQ to publish logs to CloudWatch Logs, see Conﬁguring logging. After broker restart or maintenance window, I can't connect to my broker even though the status is RUNNING. Why? You might be encountering connection issues after a broker restart you initiated, after a scheduled maintenance window is completed, or in a failure event, where the standby instance is activated. In either case, connection issues following a broker restart are most likely caused by unusually large numbers of messages persisted in your broker's Amazon EFS or Amazon EBS storage volume. During a restart, Amazon MQ moves persisted messages from storage to broker memory. To conﬁrm this diagnosis, you can monitor the following metrics on CloudWatch for your Amazon MQ for ActiveMQ broker: • StoragePercentUsage — Large percentages at or close to 100 percent can cause the broker to refuse connections. • JournalFilesForFullRecovery — Indicates the number of of journal ﬁles that will be replayed following an unclean shutdown and restart. An increasing, or consistently higher than one, value indicates unresolved transactions that can cause connection issues after restart. • OpenTransactionCount — A number larger than zero following a restart indicates that the broker will attempt to store previously consumed messages, as a result causing connection issues. To resolve this issue, we recommend resolving your XA transactions with either a rollback() or a commit(). For more information, and to see a code example of resolving XA transactions using rollback(), see recovering XA transactions. Connecting to broker after a restart 301 Amazon MQ Developer Guide I see some of my clients connecting to the broker, while others are unable to connect. If your broker is in the RUNNING status and some clients are able to connect to the broker successfully, while others are unable to do so, you may have reached the wire-level connections limit for the broker. To verify that you've reached the wire-level connections limit, do the following: • Check the general broker logs for your ActiveMQ on Amazon MQ broker in CloudWatch Logs. If the limit has been reached, you will see Reached Maximum Connections in the broker logs. For more information on CloudWatch Logs for ActiveMQ on Amazon MQ brokers, see the section called “Understanding the structure of logging in CloudWatch Logs”. Once the wire-level connections limit is reached, the broker will actively refuse additional incoming connections. To resolve this issue, we recommend upgrading your broker instance type. For more information on choosing the best instance type for your workload, see Broker instance types. If you've conﬁrmed that the number of your wire-level connections is less than the broker connection
amazon-mq-dg-086	amazon-mq-dg.pdf	86	CloudWatch Logs. If the limit has been reached, you will see Reached Maximum Connections in the broker logs. For more information on CloudWatch Logs for ActiveMQ on Amazon MQ brokers, see the section called “Understanding the structure of logging in CloudWatch Logs”. Once the wire-level connections limit is reached, the broker will actively refuse additional incoming connections. To resolve this issue, we recommend upgrading your broker instance type. For more information on choosing the best instance type for your workload, see Broker instance types. If you've conﬁrmed that the number of your wire-level connections is less than the broker connection limit, the issue might be related to rebooting clients. Check your broker logs for numerous and frequent entries of ... Inactive for longer than 600000 ms - removing .... The log entry is indicative of rebooting clients or connectivity issues. This eﬀect is more evident when clients connect to the broker via a Network Load Balancer (NLB) with clients that frequently disconnect and reconnect to the broker. This is more typically observed in container based clients. Check your client-side logs for further details. The broker will clean up inactive TCP connections after 600000 ms, and free up the connection socket. I'm seeing exception org.apache.jasper.JasperException: An exception occurred processing JSP page on the ActiveMQ console when performing operations. If you are using simple authentication and conﬁguring AuthorizationPlugin for queue and topic authorization, make sure to use the AuthorizationEntries element in your XML conﬁguration ﬁle, and allow the activemq-webconsole group permission to all queues and topics. This ensures that the ActiveMQ web console can communicate with the ActiveMQ broker. Some clients unable to connect 302 Amazon MQ Developer Guide The following example AuthorizationEntry grants read and write permissions for all queues and topics to the activemq-webconsole group. <authorizationEntries> <authorizationEntry admin="activemq-webconsole,admins,users" topic=">" read="activemq-webconsole,admins,users" write="activemq-webconsole,admins,users" /> <authorizationEntry admin="activemq-webconsole,admins,users" queue=">" read="activemq-webconsole,admins,users" write="activemq-webconsole,admins,users" /> </authorizationEntries> Similarly when integrating your broker with LDAP, make sure to grant permission for the amazonmq-console-admins group. For more information about LDAP integration, see the section called “How LDAP integration works”. Troubleshooting: RabbitMQ on Amazon MQ Use the information in this section to help you diagnose and resolve common issues you might encounter when working with RabbitMQ on Amazon MQ brokers. Contents • I can’t see metrics for my queues or virtual hosts in CloudWatch. • How do I enable plugins in RabbitMQ on Amazon MQ? • I'm unable to change Amazon VPC conﬁguration for the broker. I can’t see metrics for my queues or virtual hosts in CloudWatch. If you’re unable to view metrics for your queues or virtual hosts in CloudWatch, check if your queue or virtual host names contain any blank spaces, tabs, or other non-ASCII characters. Amazon MQ cannot publish metrics for virtual hosts and queues with names containing blank spaces, tabs or other non-ASCII characters. For more information about dimension names, see Dimension in the Amazon CloudWatch API Reference. Troubleshooting: RabbitMQ on Amazon MQ 303 Amazon MQ Developer Guide How do I enable plugins in RabbitMQ on Amazon MQ? RabbitMQ on Amazon MQ currently only supports the RabbitMQ management, shovel, federation, consistent-hash exchange plugin, which are enabled by default. For more information on using supported plugins, see the section called “Plugins”. I'm unable to change Amazon VPC conﬁguration for the broker. Amazon MQ does not support changing Amazon VPC conﬁguration after your broker is created. Please note that you will need to create a new broker with the new Amazon VPC conﬁguration and update the client connection URL with the new broker connection URL. ActiveMQ on Amazon MQ: Deleted Elastic Network Interface alarm ActiveMQ on Amazon MQ will raise a BROKER_ENI_DELETED alarm when you delete a broker’s Elastic Network Interface (ENI). When you ﬁrst create an Amazon MQ broker, Amazon MQ provisions an elastic network interface in the Virtual Private Cloud (VPC) under your account and, thus, requires a number of EC2 permissions. You must not modify or delete this network interface. Modifying or deleting the network interface can cause a permanent loss of connection between your VPC and your broker. If you wish to delete the network interface, you must delete the broker ﬁrst. ActiveMQ on Amazon MQ: Broker Out Of Memory alarm ActiveMQ on Amazon MQ will raise a BROKER_OOM alarm when the broker undergoes a restart loop due to the insuﬃcient memory capacity. When a broker is in a restart loop, also called a bounce loop, the broker initiates repeated recovery attempts within a short time window. Brokers that cannot complete start-up due to insuﬃcient memory capacity can enter a restart loop, during which interactions with the broker are limited. Amazon MQ enables metrics for your broker by default. You can view your broker metrics by accessing the Amazon CloudWatch console, or by using the CloudWatch API. The following metrics are useful when diagnosing
amazon-mq-dg-087	amazon-mq-dg.pdf	87	MQ will raise a BROKER_OOM alarm when the broker undergoes a restart loop due to the insuﬃcient memory capacity. When a broker is in a restart loop, also called a bounce loop, the broker initiates repeated recovery attempts within a short time window. Brokers that cannot complete start-up due to insuﬃcient memory capacity can enter a restart loop, during which interactions with the broker are limited. Amazon MQ enables metrics for your broker by default. You can view your broker metrics by accessing the Amazon CloudWatch console, or by using the CloudWatch API. The following metrics are useful when diagnosing the ActiveMQ BROKER_OOM alarm: How do I enable plugins in RabbitMQ on Amazon MQ? 304 Amazon MQ Developer Guide Amazon MQ CloudWatch metric TotalMessageCount HeapUsage ConnectionCount CpuUtilization TotalConsumerCount Reason for high memory use Messages are stored in memory until they are consumed or discarded. A high message count might indicate overutilization of resources and can lead to a high memory alarm. The percentage of the ActiveMQ JVM memory limit that the broker currently uses. A higher percentage indicates the broker is using signiﬁcant resources and may lead to an OOM alarm. Client connections utilize memory, and too many simultaneous connections can lead to a high memory alarm. The percentage of allocated EC2 compute units that the broker currently uses. For every consumer connected to the broker, a set number of messages are loaded from storage into memory before they are delivered to the consumer. A large number of consumer connections might cause high BROKER_OOM 305 Amazon MQ Developer Guide Amazon MQ CloudWatch metric Reason for high memory use memory usage and lead to a high memory alarm. To prevent restart loops and avoid the BROKER_OOM alarm, ensure that messages are consumed quickly. You can do this by choosing the most eﬀective broker instance type, and also cleaning your Dead Letter Queue to discard undeliverable or expired messages. You can learn more about ensuring eﬀective performance at ActiveMQ on Amazon MQ best practices. RabbitMQ on Amazon MQ: High memory alarm RabbitMQ will raise a high memory alarm when the broker's memory usage, identiﬁed by CloudWatch metric RabbitMQMemUsed, exceeds the memory limit, identiﬁed by RabbitMQMemLimit. RabbitMQMemLimit is set by Amazon MQ and has been speciﬁcally tuned considering the memory available for each host instance type. You can also enable CloudWatch logs to identify high memory alarm by the message Memory resource limit alarm set on host node rabbit@hostname. An RabbitMQ on Amazon MQ broker that has raised a high memory alarm will block all clients that are publishing messages. Due to high memory usage, your broker might also experience other issues that complicate diagnosis and resolution of the alarm. Single-instance brokers that can't complete start-up due to high memory usage might enter a restart loop, during which, interactions with the broker are limited. In cluster deployments, queues might experience paused synchronization of messages between replicas on diﬀerent nodes. Paused queue syncs prevent consumption of messages from queues and must be addressed separately while resolving the memory alarm. Amazon MQ will not restart a broker experiencing a high memory alarm and will return an exception for RebootBroker API operations as long as the broker continues to raise the alarm. Use the information in this section to help you diagnose and resolve RabbitMQ high memory alarms raised by your broker. RABBITMQ_MEMORY_ALARM 306 Amazon MQ Note Developer Guide It may take up to several hours for the RABBITMQ_MEMORY_ALARM status to clear after you take the required actions. Note You cannot downgrade a broker from an mq.m5. instance type to an mq.t3.micro instance type. If you wish to downgrade, you must delete your broker and create a new one. Topics • Diagnosing high memory alarm using the RabbitMQ web console • Diagnosing high memory alarm using Amazon MQ metrics • Addressing high memory alarm • Reducing the number of connections and channels • Addressing paused queue synchronizations in cluster deployments • Addressing restart loops in single-instance brokers • Preventing high memory alarms Diagnosing high memory alarm using the RabbitMQ web console The RabbitMQ web console can generate and display detailed memory usage information for each node. You can ﬁnd this information by doing the following: 1. Sign in to AWS Management Console and open your broker's RabbitMQ web console. 2. On the RabbitMQ console, on the Overview page, choose the name of a node from the Nodes list. 3. On the node detail page, choose Memory details to expand the section to view the node's memory usage information. The memory usage information that RabbitMQ provides in the web console can help you determine which resources might be consuming too much memory and contributing to the high Diagnosing high memory alarm using the RabbitMQ web console 307 Amazon MQ Developer Guide memory alarm. For more information about
amazon-mq-dg-088	amazon-mq-dg.pdf	88	Sign in to AWS Management Console and open your broker's RabbitMQ web console. 2. On the RabbitMQ console, on the Overview page, choose the name of a node from the Nodes list. 3. On the node detail page, choose Memory details to expand the section to view the node's memory usage information. The memory usage information that RabbitMQ provides in the web console can help you determine which resources might be consuming too much memory and contributing to the high Diagnosing high memory alarm using the RabbitMQ web console 307 Amazon MQ Developer Guide memory alarm. For more information about the memory usage details available via the RabbitMQ web console, see Reasoning About Memory Use on the RabbitMQ Server Documentation website. Diagnosing high memory alarm using Amazon MQ metrics Amazon MQ enables metrics for your broker by default. You can view your broker metrics by accessing the CloudWatch console, or by using the CloudWatch API. The following metrics are useful when diagnosing the RabbitMQ high memory alarm. Amazon MQ CloudWatch metric MessageCount QueueCount ConnectionCount ChannelCount Reason for high memory use Messages are stored in memory until they are consumed or discarded. A high message count might indicate overutilization of resources and can lead to a high memory alarm. Queues are stored in memory, and a high number of queues can lead to a high memory alarm. Client connections utilize memory, and too many simultaneous connections can lead to a high memory alarm. Similar to connections, channels established using each connection are also stored in node memory, and a high number of channels can lead to a high memory alarm. Diagnosing high memory alarm using Amazon MQ metrics 308 Amazon MQ Developer Guide Amazon MQ CloudWatch metric ConsumerCount PublishRate Reason for high memory use For every consumer connected to the broker, a set number of messages are loaded from storage into memory before they are delivered to the consumer. A large number of consumer connections might cause high memory usage and lead to a high memory alarm. Publishing messages utilizes the broker' memory. If the rate at which messages are published to the broker is too high and signiﬁcantly outpaces the rate at which the broker delivers messages to consumers, the broker might raise a high memory alarm. Addressing high memory alarm For each contributor that you identify, we recommended the following set of actions to mitigate and resolve the broker's high memory alarm. Reason for high memory use The number of messages in the queues is too high. Amazon MQ recommend ation Do any of the following: • Consume messages published to the queues. Addressing high memory alarm 309 Amazon MQ Developer Guide Reason for high memory use Amazon MQ recommend ation • Purge messages from queues. • Delete the queues from your broker. The number of queues conﬁgured on the broker is Reduce the number of queues. too high. The number of connections established on the broker is too high. Reduce the number of connections. For more information, see the section called “Reducing the number of connections and channels”. The number of channels established on the broker is Reduce the number of channels. For more informati too high. on see, the section called “Reducing the number of connections and channels”. The number of consumers connected to the broker is too Reduce the number of consumers connected to the high. broker. The message publishing rate is too high. The client connection attempt rate is too high. Reduce the rate at which publishers send messages to the broker. Reduce the frequency at which clients attempt to connect to the broker in order to publish or consume messages, or conﬁgure the broker. Addressing high memory alarm 310 Amazon MQ Developer Guide Reducing the number of connections and channels Connections to your RabbitMQ on Amazon MQ broker can be closed either by your client applications, or by manually closing them using the RabbitMQ web console. To close a connection using the RabbitMQ web console do the following. 1. Sign in to AWS Management Console and open your broker's RabbitMQ web console. 2. On the RabbitMQ console, choose the Connections tab. 3. On the Connections page, under All connections, choose the name of the connection you want to close from the list. 4. On the connection details page, choose Close this connection to expand the section, then choose Force Close. Optionally, you can replace the default text for Reason with your own description. RabbitMQ on Amazon MQ will return the reason you specify to the client when you close the connection. 5. Choose OK on the dialog box to conﬁrm and close the connection. When you close a connection, any channels associated with closed connection will also be closed. Note Your client applications may be conﬁgured to automatically re-establish connections to the broker after
amazon-mq-dg-089	amazon-mq-dg.pdf	89	connection you want to close from the list. 4. On the connection details page, choose Close this connection to expand the section, then choose Force Close. Optionally, you can replace the default text for Reason with your own description. RabbitMQ on Amazon MQ will return the reason you specify to the client when you close the connection. 5. Choose OK on the dialog box to conﬁrm and close the connection. When you close a connection, any channels associated with closed connection will also be closed. Note Your client applications may be conﬁgured to automatically re-establish connections to the broker after they are closed. In this case, closing connections from the broker web console will not be suﬃcient for reducing connection or channel counts. For brokers without public access, you can temporarily block connections by denying inbound traﬃc on the appropriate message protocol port, for example, port 5671 for AMQP connections. You can block the port in the security group that you provided to Amazon MQ when creating the broker. For more information on modifying your security group, see Adding rules to a security group in the Amazon VPC User Guide. Addressing paused queue synchronizations in cluster deployments While addressing RabbitMQ's high memory alarms, you may ﬁnd that messages on one or multiple queues cannot be consumed. These queues may be in the process of synchronizing messages between nodes, during which the respective queues become unavailable for publishing and Reducing the number of connections and channels 311 Amazon MQ Developer Guide consuming. Queue synchronizations might become paused due to the high memory alarm, and even contribute to the memory alarm. For information about stopping and retrying paused queue syncs, see the section called “Resolving paused queue sync”. Addressing restart loops in single-instance brokers An RabbitMQ on Amazon MQ single-instance broker that raises a high memory alarm is at risk of becoming unavailable if it restarts and does not have enough memory to start up. This can cause RabbitMQ to enter a restart loop and prevent any further interactions with the broker until the issue is resolved. If your broker is in a restart loop, you will not be able to apply the Amazon MQ recommended actions previously described in this section to resolve the high memory alarm. To recover your broker, we recommend upgrading to a larger instance type with more memory. Unlike in cluster deployments, you can upgrade a single-instance broker while it is experiencing a high memory alarm because there are no queue synchronizations to perform between nodes during a restart. Preventing high memory alarms For each contributing factor you identify, we recommends the following set of actions for preventing and reducing the occurrence of RabbitMQ high memory alarms. Reason high memory use The number of messages in the queues is too high. The number of queues conﬁgured on the broker is too high. Amazon MQ recommend ation Do the following: • Enable lazy queues. • Set, or reduce the queue depth limit. Set, or reduce the queue count limit. Addressing restart loops in single-instance brokers 312 Amazon MQ Developer Guide Reason high memory use Amazon MQ recommend ation The number of connections established on the broker is Set, or reduce the connection count limit. too high. The number of channels established on the broker is Set a maximum number of channels per connection on too high. client applications. The number of consumers connected to the broker is too Set a small consumer pre- fetch limit. high. The client connection attempt rate is too high. Use longer-lived connectio ns to reduce the number and frequency of connection attempts. After your broker's memory alarm has been resolved, you can upgrade your host instance type to an instance with additional resources. For information on how to update your broker's instance type see UpdateBrokerInput in the Amazon MQ REST API Reference. RabbitMQ on Amazon MQ: Invalid AWS Key Management Service Key RabbitMQ on Amazon MQ will raise an INVALID_KMS_KEY critical action required code when a broker created with a customer managed AWS KMS key(CMK) detects that the AWS Key Management Service (KMS) key is disabled. A RabbitMQ broker with a CMK periodically veriﬁes that the KMS key is enabled and the broker has all necessary grants. If RabbitMQ cannot verify that the key is enabled, the broker is quarantined and RabbitMQ will return INVALID_KMS_KEY. Without an active KMS key, the broker does not have basic permissions for customer managed KMS keys. The broker cannot perform cryptographic operations using your key until you re-enable your key and the broker restarts. A RabbitMQ broker with a disabled KMS key is quarantined to prevent deterioration. After RabbitMQ determines the KMS key is active again, your broker is removed RABBITMQ_INVALID_KMS_KEY 313 Amazon MQ Developer Guide from quarantine. Amazon MQ does not restart a broker with a
amazon-mq-dg-090	amazon-mq-dg.pdf	90	has all necessary grants. If RabbitMQ cannot verify that the key is enabled, the broker is quarantined and RabbitMQ will return INVALID_KMS_KEY. Without an active KMS key, the broker does not have basic permissions for customer managed KMS keys. The broker cannot perform cryptographic operations using your key until you re-enable your key and the broker restarts. A RabbitMQ broker with a disabled KMS key is quarantined to prevent deterioration. After RabbitMQ determines the KMS key is active again, your broker is removed RABBITMQ_INVALID_KMS_KEY 313 Amazon MQ Developer Guide from quarantine. Amazon MQ does not restart a broker with a disabled KMS key and returns an exception for RebootBroker API operations as long as the broker continues to have an invalid KMS key. Diagnosing and addressing INVALID_KMS_KEY To diagnose and address the INVALID_KMS_KEY action required code, you must use the AWS Command Line Interface (CLI) and the AWS Key Management Service console. To re-enable your KMS key 1. Call the DescribeBroker method to retrieve the kmsKeyId for your CMK broker. 2. Sign in to the AWS Key Management Service console. 3. On the Customer managed keys page, locate the KMS Key ID of the problematic broker and verify the status is Enabled. 4. If your KMS key has been disabled, re-enable the key by choosing Key Actions, then choose Enable. After your key has been re-enabled, you must wait for RabbitMQ to remove the broker from quarantine. To verify that the necessary grants are still associated with the broker's KMS key, call the ListGrantListGrant method to verify that mq_rabbit_grant and mq_grant are present. If the KMS grant or key has been deleted, you must delete the broker and create a new one with all necessary grants. For steps on deleting a broker, see Deleting a broker. To prevent the INVALID_KMS_KEY critical action required code, do not manually delete or disable a KMS key or CMK grant. If you wish to delete the key, delete the broker ﬁrst. RabbitMQ on Amazon MQ: Disk limit alarm Disk limit alarm is an indication that the volume of disk used by a RabbitMQ node has decreased due to a high number of messages not consumed while new messages were added. RabbitMQ will raise a disk limit alarm when the broker's free disk space, identiﬁed by Amazon CloudWatch metric RabbitMQDiskFree, reaches the disk limit, identiﬁed by RabbitMQDiskFreeLimit. RabbitMQDiskFreeLimit is set by Amazon MQ and has been deﬁned considering the disk space available for each broker instance type. An RabbitMQ on Amazon MQ broker that has raised a disk limit alarm will become unavailable for new messages being published. If you have a publisher and consumer on the same connection, the Diagnosing and addressing INVALID_KMS_KEY 314 Amazon MQ Developer Guide consumer will also be unavailable to receive messages. When running RabbitMQ in a cluster, the disk alarm is cluster-wide. If one node goes under the limit, all other nodes will block incoming messages. Due to the lack of disk space, your broker might also experience other issues that complicate diagnosis and resolution of the alarm. Amazon MQ will not restart a broker experiencing a disk alarm and will return an exception for RebootBroker API operations as long as the broker continues to raise the alarm. Note You cannot downgrade a broker from an mq.m5 instance type to an mq.t3.micro instance type. If you wish to downgrade, you must delete your broker and create a new one. Diagnosing and addressing disk limit alarm Amazon MQ enables metrics for your broker by default. You can view your broker metrics by accessing the Amazon CloudWatch console, or by using the CloudWatch API.MessageCount is a useful metric when diagnosing the RabbitMQ disk limit alarm. Messages are stored in memory until they are consumed or discarded. A high message count indicates overutilization of disk storage and can lead to a disk alarm. To diagnose the disk limit alarm, use the Amazon MQ Management Console to: • Create a new connection to consume messages published to the queues. • Purge messages from queues. • Delete the queues from your broker. Note It may take up to several hours for the RABBITMQ_DISK_ALARM status to clear after you take the required actions. To prevent the disk limit alarm from reoccurring, you can upgrade your host instance type to an instance with additional resources. For information on how to update your broker's instance type see UpdateBrokerInput in the Amazon MQ REST API Reference. We also recommend keeping your publishers and consumers on diﬀerent connections. Diagnosing and addressing disk limit alarm 315 Amazon MQ Developer Guide RabbitMQ on Amazon MQ quorum queues alarm Quorum queues are only supported on RabbitMQ on Amazon MQ versions 3.13 and above. RabbitMQ on Amazon MQ will raise the critical required action code RABBITMQ_QUORUM_QUEUES_NOT_SUPPORTED_ON_CURRENT_VERSION when you attempt to create quorum queues
amazon-mq-dg-091	amazon-mq-dg.pdf	91	the disk limit alarm from reoccurring, you can upgrade your host instance type to an instance with additional resources. For information on how to update your broker's instance type see UpdateBrokerInput in the Amazon MQ REST API Reference. We also recommend keeping your publishers and consumers on diﬀerent connections. Diagnosing and addressing disk limit alarm 315 Amazon MQ Developer Guide RabbitMQ on Amazon MQ quorum queues alarm Quorum queues are only supported on RabbitMQ on Amazon MQ versions 3.13 and above. RabbitMQ on Amazon MQ will raise the critical required action code RABBITMQ_QUORUM_QUEUES_NOT_SUPPORTED_ON_CURRENT_VERSION when you attempt to create quorum queues on a single instance or cluster broker using version 3.12 and below. To diagnose and address the RABBITMQ_QUORUM_QUEUES_NOT_SUPPORTED_ON_CURRENT_VERSION alarm, you can view your list of quorum queues in the RabbitMQ management dashboard: • If you do not need to retain messages, you can delete the quorum queues, upgrade your broker to version 3.13 or above, and recreate the quorum queues after upgrading the broker. • If you need to retain messages, you must create a new broker on version 3.13 and above, then create quorum queues on the new broker. After creating the new broker and quorum queues, you can migrate messages from the old broker to the new broker using the Shovel or Federation plug-in. Then, delete the old broker. To prevent a RABBITMQ_QUORUM_QUEUES_NOT_SUPPORTED_ON_CURRENT_VERSION, upgrade your broker to version 3.13 or above before creating quorum queues on that broker. RABBITMQ_QUORUM_QUEUES_NOT_SUPPORTED_ON_CURRENT_VERSION 316 Amazon MQ Developer Guide Related resources Amazon MQ resources The following table lists useful resources for working with Amazon MQ. Resource Description Amazon MQ REST API Reference Descriptions of REST resources, example requests, HTTP methods, schemas, parameter s, and the errors that the service returns. Amazon MQ in the AWS CLI Command Reference Descriptions of the AWS CLI commands that you can use to work with message brokers. Amazon MQ in the AWS CloudFormation User Guide The AWS::Amazon MQ::Broker resource lets you create Amazon MQ brokers, add conﬁguration changes or modify users for the speciﬁed broker, return information about the speciﬁed broker, and delete the speciﬁed broker. The AWS::Amazon MQ::Configuration resource lets you create Amazon MQ conﬁgurations, add conﬁguration changes or modify users, and return information about the speciﬁed conﬁguration. Information about Amazon MQ regions and endpoints The primary web page for information about Amazon MQ. A community-based forum for developers to discuss technical questions related to Amazon MQ. Regions and Endpoints Product Page Discussion Forum Amazon MQ resources 317 Amazon MQ Resource AWS Premium Support Information Developer Guide Description The primary web page for information about AWS Premium Support, a one-on-one, fast- response support channel to help you build and run applications on AWS infrastructure services Amazon MQ for ActiveMQ resources The following table lists useful resources for working with Apache ActiveMQ. Resource Description Apache ActiveMQ Getting Started Guide ActiveMQ in Action Cross-Language Clients The oﬃcial documentation of Apache ActiveMQ. A guide to Apache ActiveMQ that covers the anatomy of JMS messages, connectors, message persistence, authentication, and authorization. A list of programming languages and corresponding Apache ActiveMQ libraries. See also ActiveMQ Client and QpidJMS Client. Amazon MQ for RabbitMQ resources The following table lists useful resources for working with RabbitMQ. Resource Description The RabbitMQ Getting Started Guide The oﬃcial documentation of RabbitMQ. RabbitMQ Client Libraries and Developer Tools A guide to the oﬃcially supported client libraries and devloper tools for working with Amazon MQ for ActiveMQ resources 318 Amazon MQ Resource RabbitMQ Best Practices Developer Guide Description RabbitMQ using a variety of programming languages and platforms. CloudAMQP's guide on best practices and recommendations for working with RabbitMQ. Amazon MQ for RabbitMQ resources 319 Amazon MQ Developer Guide Amazon MQ release notes The following table lists Amazon MQ feature releases and improvements. Date Documentation Update April 22, 2025 You can now delete Amazon MQ broker conﬁgurations using the DeleteConfiguration API. For more information, see Conﬁgurations in the Amazon MQ API Reference. April 16, 2025 Amazon MQ for RabbitMQ now supports using dual-stack (IPv4 and IPv6) endpoints to connect to public and private brokers. For more informati on, see Connecting to Amazon MQ and Conﬁguring a private Amazon MQ broker. April 7, 2025 Amazon MQ is now available in Asia Paciﬁc (Thailand) and Mexico (Central) Regions. For information on available regions, see AWS Regions and Endpoints in the AWS General Reference guide. February 13, 2025 Amazon MQ API FIPS endpoints are now available in the Canada (Central) and Canada West (Calgary) Regions. February 12, 2025 For more information on using FIPS endpoints with the Amazon MQ API, see Connecting to Amazon MQ. For information on available regions, see AWS Regions and Endpoints in the AWS General Reference guide. Amazon MQ is announcing the following instance type end of support dates: Broker instance types • ActiveMQ mq.t2.micro : May 12,
amazon-mq-dg-092	amazon-mq-dg.pdf	92	Asia Paciﬁc (Thailand) and Mexico (Central) Regions. For information on available regions, see AWS Regions and Endpoints in the AWS General Reference guide. February 13, 2025 Amazon MQ API FIPS endpoints are now available in the Canada (Central) and Canada West (Calgary) Regions. February 12, 2025 For more information on using FIPS endpoints with the Amazon MQ API, see Connecting to Amazon MQ. For information on available regions, see AWS Regions and Endpoints in the AWS General Reference guide. Amazon MQ is announcing the following instance type end of support dates: Broker instance types • ActiveMQ mq.t2.micro : May 12, 2025 • ActiveMQ mq.m4.large : May 12, 2025 320 Amazon MQ Developer Guide Date Documentation Update You cannot create brokers on mq.t2.micro or mq.m4.large after March 17, 2025. December 10, 2024 Amazon MQ now supports using AWS PrivateLink to connect between your virtual private clouds (VPCs) and the Amazon MQ API without exposing your traﬃc to the public internet. For more information, see the section called “Connect to Amazon MQ using AWS PrivateLink”. November 18, 2024 Amazon MQ is now available in the Asia Paciﬁc (Malaysia) Region. For information on available regions, see AWS Regions and Endpoints in the AWS General Reference guide. November 14, 2024 Amazon MQ is announcing the following engine version end of support dates: Managing Amazon MQ for ActiveMQ engine versions • ActiveMQ 5.17: June 16, 2025 Managing Amazon MQ for RabbitMQ engine versions • RabbitMQ 3.11: February 17, 2025 • RabbitMQ 3.12: March 17, 2025 For more information on upgrading to the latest version, see Upgrading an Amazon MQ broker engine version November 13, 2024 Amazon MQ now supports dual-stack service endpoints which you can connect to using either IPv4 or IPv6. Amazon MQ dual-stack Regional service endpoints can be resolved with both A and AAAA DNS records. For more information, see ???. 321 Amazon MQ Developer Guide Date Documentation Update July 25, 2024 Amazon MQ now supports ActiveMQ 5.18, a new minor engine version release. For more information, see the following: • ActiveMQ 5.18 Release Page • Managing Amazon MQ for ActiveMQ engine versions • Upgrading an Amazon MQ broker engine version • Using Spring XML conﬁguration ﬁles July 22, 2024 Amazon MQ now supports quorum queues only on brokers using version 3.13 and above. Quorum queues are a replicated FIFO queue type that use the Raft consensus algorithm to maintain data consistency. Quorum queues provide poison message handling, which can help you manage unprocessed messages. To get started with quorum queues, see Quorum queues for RabbitMQ on Amazon MQ. July 2, 2024 Amazon MQ for RabbitMQ now supports RabbitMQ 3.13, a minor version release. For all brokers using engine version 3.13 and above, Amazon MQ manages upgrades to the latest supported patch version during the maintenance window. For more information, see Upgrading an Amazon MQ broker engine version. Amazon MQ for RabbitMQ sizing guidelines have been updated to include new limits for queues, consumers per channel, and shovels for brokers using engine version 3.13. For more information about the ﬁxes and features in this release, see the RabbitMQ 3.13 release notes on the RabbitMQ server GitHub repository. For more information about supported Amazon MQ for RabbitMQ versions and broker upgrades, see Managing Amazon MQ for RabbitMQ engine versions. 322 Amazon MQ Developer Guide Date Documentation Update June 10, 2024 Amazon MQ is now available in the Canada West (Calgary) Region. For information on available regions, see AWS Regions and Endpoints in the AWS General Reference guide. May 10, 2024 The Amazon MQ version support calendar indicates when a broker engine version reaches end of support. When an engine version reaches end of support, Amazon MQ updates all brokers on the version to the next supported minor version automatically. Amazon MQ provides at least a 90 day notice before an engine version reaches end of support. To view the version support calendar and end of support, see the following: • Managing Amazon MQ for ActiveMQ engine versions • Managing Amazon MQ for RabbitMQ engine versions You can also enable automatic minor version upgrades for your broker to update to the next patch version during a maintenance window. For more information, see Upgrading an Amazon MQ broker engine version May 9, 2024 Amazon MQ for RabbitMQ now supports RabbitMQ 3.12, a minor version release. All brokers on 3.12.13 and above use Classic Queues version 2 (CQv2), and all queues on 3.12.13 and above behave as lazy queues. We recommend brokers on versions prior to 3.12.13 enable CQv2 and lazy queues, or upgrade to the newest version of Amazon MQ for RabbitMQ. For more information about the ﬁxes and features in this release, see the following: • RabbitMQ 3.12 release notes on the RabbitMQ server GitHub repository. For more information about supported Amazon MQ for RabbitMQ
amazon-mq-dg-093	amazon-mq-dg.pdf	93	MQ broker engine version May 9, 2024 Amazon MQ for RabbitMQ now supports RabbitMQ 3.12, a minor version release. All brokers on 3.12.13 and above use Classic Queues version 2 (CQv2), and all queues on 3.12.13 and above behave as lazy queues. We recommend brokers on versions prior to 3.12.13 enable CQv2 and lazy queues, or upgrade to the newest version of Amazon MQ for RabbitMQ. For more information about the ﬁxes and features in this release, see the following: • RabbitMQ 3.12 release notes on the RabbitMQ server GitHub repository. For more information about supported Amazon MQ for RabbitMQ versions and broker upgrades, see Managing Amazon MQ for RabbitMQ engine versions. 323 Amazon MQ Developer Guide Date Documentation Update March 4, 2024 Amazon MQ for RabbitMQ now supports RabbitMQ 3.11.28. For more information about the ﬁxes and features in this release, see the following: • RabbitMQ 3.11.28 release notes on the RabbitMQ server GitHub repositor y • RabbitMQ changelog For more information about supported Amazon MQ for RabbitMQ versions and broker upgrades, see Managing Amazon MQ for RabbitMQ engine versions. January 19, 2024 Amazon MQ for RabbitMQ does not support the username "guest", and will delete the default guest account when you create a new broker. Amazon MQ will also periodically delete any customer created account called "guest". December 15, 2023 Amazon MQ is now available in the Israel (Tel Aviv) Region. For information on available regions, see AWS Regions and Endpoints in the AWS General Reference guide. December 11, 2023 Amazon MQ for RabbitMQ now supports RabbitMQ 3.10.25. For more information about the ﬁxes and features in this release, see the following: • RabbitMQ 3.10.25 release notes on the RabbitMQ server GitHub repositor y • RabbitMQ changelog For more information about supported Amazon MQ for RabbitMQ versions and broker upgrades, see Managing Amazon MQ for RabbitMQ engine versions. 324 Amazon MQ Developer Guide Date Documentation Update October 26, 2023 Amazon MQ has released the latest ActiveMQ minor versions 5.15.16, 5.16.7, 5.17.6 with a critical update. We have deprecated the older minor versions of ActiveMQ and will be updating all brokers on any version of 5.15 to 5.15.16, or 5.16 to 5.16.7 and 5.17 to 5.17.6. For more information on updating your ActiveMQ broker, see Managing Amazon MQ for ActiveMQ engine versions. September 27, 2023 Amazon MQ for RabbitMQ now supports RabbitMQ 3.11.20. For more information about the ﬁxes and features in this release, see the following: • RabbitMQ 3.11.20 release notes on the RabbitMQ server GitHub repositor y • RabbitMQ changelog For more information about supported Amazon MQ for RabbitMQ versions and broker upgrades, see Managing Amazon MQ for RabbitMQ engine versions. July 27, 2023 Amazon MQ for RabbitMQ now supports RabbitMQ 3.11.16 For more information about the ﬁxes and features in this release, see the following: • RabbitMQ 3.11.16 release notes on the RabbitMQ server GitHub repositor y • RabbitMQ changelog For more information about supported Amazon MQ for RabbitMQ versions and broker upgrades, see Managing Amazon MQ for RabbitMQ engine versions. 325 Amazon MQ Developer Guide Date Documentation Update July 27, 2023 Amazon MQ for RabbitMQ now supports creating and applying conﬁgura tions to your RabbitMQ broker. For more information on adding confgurations to your broker, see RabbitMQ Broker Conﬁgurations. For more information about this feature, see: • Operator policies • Changes to the operator policies June 23, 2023 Amazon MQ now supports ActiveMQ 5.17.3, a new minor engine version release. This release supports the new cross-Region data replication (CRDR) feature from Amazon MQ. For more information, see the following: June 21, 2023 • To get started with CRDR, see Cross-Region data replication for Amazon MQ for ActiveMQ in the Developer Guide. • ActiveMQ 5.17.3 Release Page • Managing Amazon MQ for ActiveMQ engine versions • Upgrading an Amazon MQ broker engine version • Using Spring XML conﬁguration ﬁles Amazon MQ for ActiveMQ now oﬀers a cross-Region data replication (CRDR) feature that allows for asynchronous message replication from the primary broker in a primary AWS Region to the replica broker in a replica Region. If the primary broker in the primary Region fails, you can promote the replica broker in the secondary Region to primary by initiating a switchover or failover. To get started with CRDR, see Cross-Region data replication for Amazon MQ for ActiveMQ in the Developer Guide. 326 Amazon MQ Developer Guide Date Documentation Update May 18, 2023 Amazon MQ is now available in the following regions: • Asia Paciﬁc (Melbourne) • Asia Paciﬁc (Hyderabad) • Europe (Spain) • Europe (Zurich) For information on available regions, see AWS Regions and Endpoints in the AWS General Reference guide. April 14, 2023 Amazon MQ for RabbitMQ now supports RabbitMQ version 3.9.27. For more information about the ﬁxes and features in this release, see the following: •
amazon-mq-dg-094	amazon-mq-dg.pdf	94	initiating a switchover or failover. To get started with CRDR, see Cross-Region data replication for Amazon MQ for ActiveMQ in the Developer Guide. 326 Amazon MQ Developer Guide Date Documentation Update May 18, 2023 Amazon MQ is now available in the following regions: • Asia Paciﬁc (Melbourne) • Asia Paciﬁc (Hyderabad) • Europe (Spain) • Europe (Zurich) For information on available regions, see AWS Regions and Endpoints in the AWS General Reference guide. April 14, 2023 Amazon MQ for RabbitMQ now supports RabbitMQ version 3.9.27. For more information about the ﬁxes and features in this release, see the following: • RabbitMQ 3.9.27 release notes on the RabbitMQ server GitHub repository • RabbitMQ changelog For more information about supported Amazon MQ for RabbitMQ versions and broker upgrades, see Managing Amazon MQ for RabbitMQ engine versions. April 14, 2023 Amazon MQ for RabbitMQ now supports RabbitMQ version 3.10.20. For more information about the ﬁxes and features in this release, see the following: • RabbitMQ 3.10.20 release notes on the RabbitMQ server GitHub repositor y • RabbitMQ changelog For more information about supported Amazon MQ for RabbitMQ versions and broker upgrades, see Managing Amazon MQ for RabbitMQ engine versions. 327 Amazon MQ Developer Guide Date Documentation Update March 31, 2023 Amazon MQ for RabbitMQ has disabled RabbitMQ engine version 3.10.17 The Amazon MQ for RabbitMQ team, and the open source maintainers of RabbitMQ, have identiﬁed an issue with the RabbitMQ management console on version 3.10.17. Amazon MQ has retracted this version. To mitigate the impacts of this issue, create new brokers with version 3.10.20 while we work to support a new patch version of RabbitMQ. We recommend activating the auto minor version upgrade option to automatically get the latest bug ﬁxes, security updates and performance enhancements. For more information on available Amazon MQ for RabbitMQ versions, see Amazon MQ for RabbitMQ engine versions. March 1, 2023 Amazon MQ for RabbitMQ now supports RabbitMQ version 3.10.17. For more information about the ﬁxes and features in this release, see the following: • RabbitMQ 3.10.17 release notes on the RabbitMQ server GitHub repositor y • RabbitMQ changelog For more information about supported Amazon MQ for RabbitMQ versions and broker upgrades, see Managing Amazon MQ for RabbitMQ engine versions. 328 Amazon MQ Developer Guide Date Documentation Update February 21, 2023 Amazon MQ for RabbitMQ now integrates with AWS Key Management Service (KMS) to oﬀer server-side encryption. You can now select your own customer managed CMK, or use an AWS managed KMS key in your AWS KMS account. For more information, see Encryption at rest. Amazon MQ supports using AWS KMS keys in the following ways. • Amazon MQ owned KMS key (default) — The key is owned and managed by Amazon MQ and is not in your account. • AWS managed KMS key — The AWS managed KMS key (aws/mq) is a KMS key in your account that is created, managed, and used on your behalf by Amazon MQ. • Select existing customer managed KMS key — Customer managed KMS keys are created and managed by you in AWS Key Management Service (KMS). January 13, 2023 Amazon MQ for RabbitMQ now supports RabbitMQ version 3.8.34. For more information about the ﬁxes and features in this release, see the following: • RabbitMQ 3.8.34 release notes on the RabbitMQ server GitHub repository • RabbitMQ changelog For more information about supported Amazon MQ for RabbitMQ versions and broker upgrades, see Managing Amazon MQ for RabbitMQ engine versions. 329 Amazon MQ Developer Guide Date Documentation Update December 15, 2022 Amazon MQ for RabbitMQ now supports RabbitMQ version 3.9.24. For more information about the ﬁxes and features in this release, see the following: • RabbitMQ 3.9.24 release notes on the RabbitMQ server GitHub repository • RabbitMQ changelog For more information about supported Amazon MQ for RabbitMQ versions and broker upgrades, see Managing Amazon MQ for RabbitMQ engine versions. December 13, 2022 Amazon MQ is now available in the Middle East (UAE) Region. For informati on on available regions, see AWS Regions and Endpoints in the AWS General Reference guide. November 14, 2022 Amazon MQ for RabbitMQ now supports 3.10, a major engine version release. You can now enable classic Queues version 2 (CQv2) on your RabbitMQ queues. Direct updates from 3.8 to 3.10 are not supported. For more information, see the following: • RabbitMQ 3.10.10 release notes • RabbitMQ changelog For more information about supported Amazon MQ for RabbitMQ versions and broker upgrades, see Managing Amazon MQ for RabbitMQ engine versions. November 9, 2022 Amazon MQ now supports ActiveMQ 5.17.2, a new minor engine version release. For more information, see the following: • ActiveMQ 5.17.2 Release Page • Managing Amazon MQ for ActiveMQ engine versions • Upgrading an Amazon MQ broker engine version • Using Spring XML conﬁguration ﬁles 330 Amazon MQ
amazon-mq-dg-095	amazon-mq-dg.pdf	95	(CQv2) on your RabbitMQ queues. Direct updates from 3.8 to 3.10 are not supported. For more information, see the following: • RabbitMQ 3.10.10 release notes • RabbitMQ changelog For more information about supported Amazon MQ for RabbitMQ versions and broker upgrades, see Managing Amazon MQ for RabbitMQ engine versions. November 9, 2022 Amazon MQ now supports ActiveMQ 5.17.2, a new minor engine version release. For more information, see the following: • ActiveMQ 5.17.2 Release Page • Managing Amazon MQ for ActiveMQ engine versions • Upgrading an Amazon MQ broker engine version • Using Spring XML conﬁguration ﬁles 330 Amazon MQ Developer Guide Date Documentation Update August 17, 2022 Amazon MQ now supports ActiveMQ 5.17.1, a new major engine version release. For more information, see the following: • ActiveMQ 5.17.1 Release Page • Managing Amazon MQ for ActiveMQ engine versions • Upgrading an Amazon MQ broker engine version • Using Spring XML conﬁguration ﬁles July 14, 2022 Amazon MQ now supports ActiveMQ 5.16.5, a minor engine version release. For more information, see the following: • ActiveMQ 5.16.5 Release Page • Managing Amazon MQ for ActiveMQ engine versions • Using Spring XML conﬁguration ﬁles • Upgrading an Amazon MQ broker engine version May 4, 2022 Amazon MQ adds inclusive language for networkConnector element in broker conﬁguration. • Creating and conﬁguring an Amazon MQ network of brokers April 25, 2022 Amazon MQ This release adds the CRITICAL_ACTION_REQUIRED broker state and the ActionRequired API property. CRITICAL_ACTION_RE QUIRED informs you when your broker is degraded. ActionRequired provides you with a code which you can use to ﬁnd instructions in the Developer Guide on how to resolve the issue. • Troubleshooting • ActionRequired documentation in the Amazon MQ API Reference. 331 Amazon MQ Developer Guide Date Documentation Update April 20, 2022 Amazon MQ now supports ActiveMQ 5.16.4, a minor engine version release. For more information, see the following: • ActiveMQ 5.16.4 Release Page • Managing Amazon MQ for ActiveMQ engine versions • Using Spring XML conﬁguration ﬁles • Upgrading an Amazon MQ broker engine version March 1, 2022 Amazon MQ is now available in the Asia Paciﬁc (Jakarta) Region. For information on available regions, see AWS Regions and Endpoints in the AWS General Reference guide. February 25, 2022 Amazon MQ for RabbitMQ now supports RabbitMQ version 3.8.27. For more information about the ﬁxes and features in this release, see the following: • RabbitMQ 3.8.27 release notes on the RabbitMQ server GitHub repository • RabbitMQ changelog For more information about supported Amazon MQ for RabbitMQ versions and broker upgrades, see Managing Amazon MQ for RabbitMQ engine versions. February 16, 2022 Amazon MQ is now available in the Africa (Cape Town) Region. For informati on on available regions, see AWS Regions and Endpoints in the AWS General Reference guide. 332 Amazon MQ Developer Guide Date Documentation Update February 14, 2022 Amazon MQ for RabbitMQ now supports RabbitMQ version 3.9.13. Automatic minor version upgrades cannot be used to upgrade from Rabbit 3.8 to 3.9. To do so, manually upgrade your broker. For more information on new features introduced in RabbitMQ 3.9, see the release notes page for version 3.9.0 on the GitHub website. Note Currently, Amazon MQ does not support streams, or using structure d logging in JSON, introduced in RabbitMQ 3.9. For more information about the ﬁxes and features in this release, see the following: • RabbitMQ 3.9.13 release notes on the RabbitMQ server GitHub repository • RabbitMQ changelog For more information about supported Amazon MQ for RabbitMQ versions and broker upgrades, see Managing Amazon MQ for RabbitMQ engine versions. February 07, 2022 Amazon MQ for RabbitMQ introduces new broker metrics, allowing you to monitor average resource utilization across all three nodes in a cluster deployment. For more information, see the following: • the section called “Metrics for RabbitMQ” 333 Amazon MQ Developer Guide Date Documentation Update January 18, 2022 Amazon MQ for RabbitMQ now supports RabbitMQ version 3.8.26. For more information about the ﬁxes and features in this release, see the following: • RabbitMQ 3.8.26 release notes on the RabbitMQ server GitHub repository • RabbitMQ changelog For more information about supported Amazon MQ for RabbitMQ versions and broker upgrades, see Managing Amazon MQ for RabbitMQ engine versions. January 13, 2022 Amazon MQ introduces the RABBITMQ_MEMORY_ALARM status code to inform you when your broker has raised a high memory alarm and is in an unhealthy state. Amazon MQ provides detailed information and recommend ations to help you diagnose, resolve and prevent high memory alarms. For more information, see the following. • the section called “ RABBITMQ_MEMORY_ALARM ” January 6, 2022 When you conﬁgure CloudWatch Logs for Amazon MQ for ActiveMQ brokers, Amazon MQ supports using the aws:SourceArn and aws:Sourc eAccount global condition context keys in IAM resource-based policies to prevent the confused deputy problem. For more information, see
amazon-mq-dg-096	amazon-mq-dg.pdf	96	January 13, 2022 Amazon MQ introduces the RABBITMQ_MEMORY_ALARM status code to inform you when your broker has raised a high memory alarm and is in an unhealthy state. Amazon MQ provides detailed information and recommend ations to help you diagnose, resolve and prevent high memory alarms. For more information, see the following. • the section called “ RABBITMQ_MEMORY_ALARM ” January 6, 2022 When you conﬁgure CloudWatch Logs for Amazon MQ for ActiveMQ brokers, Amazon MQ supports using the aws:SourceArn and aws:Sourc eAccount global condition context keys in IAM resource-based policies to prevent the confused deputy problem. For more information, see the following. • the section called “Cross-service confused deputy prevention” December 20, 2021 Amazon MQ for ActiveMQ introduces a set of new metrics, allowing you to monitor the maximum number of connections you can make to your broker using diﬀerent supported transport protocols, as well as an additional new metric that allows you to monitor the number of nodes connected to your broker in a network of brokers. For more information, see the following. • the section called “Metrics for ActiveMQ” 334 Amazon MQ Developer Guide Date Documentation Update November 16, 2021 Amazon MQ for RabbitMQ now supports RabbitMQ version 3.8.23. For more information about the ﬁxes and features in this release, see the following: • RabbitMQ 3.8.23 release notes on the RabbitMQ server GitHub repository • RabbitMQ changelog For more information about supported Amazon MQ for RabbitMQ versions and broker upgrades, see Managing Amazon MQ for RabbitMQ engine versions. October 12, 2021 Amazon MQ now supports ActiveMQ 5.16.3, a minor engine version release. For more information, see the following: • ActiveMQ 5.16.3 Release Page • Managing Amazon MQ for ActiveMQ engine versions • Upgrading an Amazon MQ broker engine version • Using Spring XML conﬁguration ﬁles September 8, 2021 Amazon MQ for RabbitMQ now supports RabbitMQ version 3.8.22. This release includes a ﬁx for an issue with queues using per-message TTL (time to live), identiﬁed in the previously supported version, RabbitMQ 3.8.17. We recommend upgrading your existing brokers to version 3.8.22. For more information about the ﬁxes and features in this release, see the following: • RabbitMQ 3.8.22 release notes on the RabbitMQ server GitHub repository • RabbitMQ changelog For more information about supported Amazon MQ for RabbitMQ versions and broker upgrades, see Managing Amazon MQ for RabbitMQ engine versions 335 Amazon MQ Developer Guide Date Documentation Update August 25, 2021 Amazon MQ for RabbitMQ has temporarily disabled RabbitMQ engine version 3.8.17 due to an issue identiﬁed with queues using per-message time-to-live (TTL). We recommend using version 3.8.11. July 29, 2021 Amazon MQ for RabbitMQ now supports RabbitMQ version 3.8.17. For more information about the ﬁxes and features contained in this update, see the following: • RabbitMQ 3.8.17 release notes on the RabbitMQ server GitHub repository • RabbitMQ changelog • Managing Amazon MQ for RabbitMQ engine versions July 16, 2021 You can now adjust the maintenance window of an Amazon MQ broker using the AWS Management Console, AWS CLI, or the Amazon MQ API. To learn more about broker maintenance windows, see the following. • Scheduling the maintenance window for an Amazon MQ broker July 6, 2021 Amazon MQ for RabbitMQ introduces support for the Consistent Hash exchange type. Consistent Hash exchanges route messages to queues based on a hash value calculated from the routing key of a message. For more information, see the following: • Consistent Hash exchange plugin • RabbitMQ Consistent Hash Exchange Type on the RabbitMQ GitHub repository June 7, 2021 Amazon MQ now supports ActiveMQ 5.16.2, a new major engine version release. For more information, see the following: • ActiveMQ 5.16.2 Release Page • Managing Amazon MQ for ActiveMQ engine versions • Upgrading an Amazon MQ broker engine version • Using Spring XML conﬁguration ﬁles 336 Amazon MQ Developer Guide Date Documentation Update May 26, 2021 Amazon MQ for RabbitMQ is now available in the China (Beijing) and China (Ningxia) Regions. For information on available regions, see AWS Regions and Endpoints. May 18, 2021 Amazon MQ for RabbitMQ implements broker defaults. When you ﬁrst create a broker, Amazon MQ creates a set of broker policies and vhost limits based on the instance type and deployment mode you choose, in order to optimize the broker's performance. For more informati on, see the following: • Amazon MQ for RabbitMQ broker defaults May 5, 2021 Amazon MQ now supports ActiveMQ 5.15.15. For more information, see the following: • ActiveMQ 5.15.15 Release Page • Managing Amazon MQ for ActiveMQ engine versions • Using Spring XML conﬁguration ﬁles May 5, 2021 Amazon MQ started tracking changes to AWS managed policies. For more information, see the following: • the section called “AWS managed policies” April 14, 2021 Amazon MQ is now available in the China (Beijing) and China (Ningxia) Regions. For
amazon-mq-dg-097	amazon-mq-dg.pdf	97	mode you choose, in order to optimize the broker's performance. For more informati on, see the following: • Amazon MQ for RabbitMQ broker defaults May 5, 2021 Amazon MQ now supports ActiveMQ 5.15.15. For more information, see the following: • ActiveMQ 5.15.15 Release Page • Managing Amazon MQ for ActiveMQ engine versions • Using Spring XML conﬁguration ﬁles May 5, 2021 Amazon MQ started tracking changes to AWS managed policies. For more information, see the following: • the section called “AWS managed policies” April 14, 2021 Amazon MQ is now available in the China (Beijing) and China (Ningxia) Regions. For information on available regions, see AWS Regions and Endpoints. April 7, 2021 Amazon MQ now supports RabbitMQ 3.8.11. For more information about the ﬁxes and features contained in this update, see the following: • RabbitMQ 3.8.11 release notes on the RabbitMQ server GitHub repository • RabbitMQ changelog • Managing Amazon MQ for RabbitMQ engine versions 337 Amazon MQ Developer Guide Date Documentation Update April 1, 2021 Amazon MQ is now available in the Asia Paciﬁc (Osaka) Region. For informati on about available regions, see Amazon MQ regions and endpoints. December 21, 2020 Amazon MQ now supports ActiveMQ 5.15.14. For more information, see the following: • ActiveMQ 5.15.14 Release Notes • Managing Amazon MQ for ActiveMQ engine versions • Using Spring XML conﬁguration ﬁles • Important Due to a known Apache ActiveMQ issue in this release, the new Pause Queue button in the ActiveMQ web console cannot be used with Amazon MQ for ActiveMQ brokers. For more information about this issue, see AMQ-8104. 338 Amazon MQ Developer Guide Date Documentation Update November 4, 2020 Amazon MQ now supports RabbitMQ, a popular open source message broker. This enables you to migrate your existing RabbitMQ message brokers to AWS without having to rewrite code. Amazon MQ for RabbitMQ manages both individual and clustered message brokers and handles tasks like provisioning the infrastructure, setting up the broker, and updating the software. • Amazon MQ supports RabbitMQ 3.8.6. For more information about supported engine versions, see the section called “Version management”. • The AWS Free Tier includes up to 750 hours of a single-instance mq.t3.micro broker and up to 20GB of storage per month for one year. For more information about supported instance types, see Broker instance types. • With Amazon MQ for RabbitMQ, you can access your brokers using AMQP 0-9-1, and with any language supported by the RabbitMQ client libraries . For more information about supported protocols and cipher suites, see the section called “Amazon MQ for RabbitMQ protocols”. • Amazon MQ for RabbitMQ is available in all regions that Amazon MQ is currently available. To learn more about all of the available regions, see the AWS Region Table. To get started with using Amazon MQ, create a broker, and connect a JVM- based application to your RabbitMQ broker, see Getting started: Creating and connecting to a RabbitMQ broker. October 22, 2020 Amazon MQ supports ActiveMQ 5.15.13. For more information, see the following: • ActiveMQ 5.15.13 Release Notes • Managing Amazon MQ for ActiveMQ engine versions • Using Spring XML conﬁguration ﬁles 339 Amazon MQ Developer Guide Date Documentation Update September 30, 2020 Amazon MQ is now available in the Europe (Milan) Region. For information about available regions, see Amazon MQ regions and endpoints. July 27, 2020 You can authenticate Amazon MQ users using the credentials stored in your Active Directory or other LDAP server. You can also add, delete, and modify Amazon MQ users and assign permissions to topics and queues. For more information, see Integrate LDAP with ActiveMQ. July 17, 2020 Amazon MQ now supports the mq.t3.micro instance type. For more information, see Broker instance types. June 30, 2020 Amazon MQ supports ActiveMQ 5.15.12. For more information, see the following: • ActiveMQ 5.15.12 Release Notes • Managing Amazon MQ for ActiveMQ engine versions • Using Spring XML conﬁguration ﬁles April 30, 2020 Amazon MQ supports a new child collection element, systemUsage , on the broker element. For more information, see systemUsage. Amazon MQ also supports three new attributes on the kahaDB child element. • journalDiskSyncInterval - Interval (ms) for when to perform a disk sync if journalDiskSyncStrategy=periodic . • journalDiskSyncStrategy - conﬁgures the disk sync policy. • preallocationStrategy - conﬁgures how the broker will try to preallocate the journal ﬁles when a new journal ﬁle is needed. For more information, see Attributes. 340 Amazon MQ Developer Guide Date Documentation Update March 3, 2020 Amazon MQ supports two new CloudWatch metrics • TempPercentUsage - The percentage of available temporary storage used by non-persistent messages. • JobSchedulerStorePercentUsage - The percentage of disk space used by the job scheduler store. For more information, see Monitoring and logging Amazon MQ brokers. February 4, 2020 Amazon MQ is available in the Asia Paciﬁc (Hong Kong) and
amazon-mq-dg-098	amazon-mq-dg.pdf	98	conﬁgures the disk sync policy. • preallocationStrategy - conﬁgures how the broker will try to preallocate the journal ﬁles when a new journal ﬁle is needed. For more information, see Attributes. 340 Amazon MQ Developer Guide Date Documentation Update March 3, 2020 Amazon MQ supports two new CloudWatch metrics • TempPercentUsage - The percentage of available temporary storage used by non-persistent messages. • JobSchedulerStorePercentUsage - The percentage of disk space used by the job scheduler store. For more information, see Monitoring and logging Amazon MQ brokers. February 4, 2020 Amazon MQ is available in the Asia Paciﬁc (Hong Kong) and Middle East (Bahrain) regions. For information on available regions, see AWS Regions and Endpoints. January 22, 2020 Amazon MQ supports ActiveMQ 5.15.10. For more information, see the following: • ActiveMQ 5.15.10 Release Notes • Managing Amazon MQ for ActiveMQ engine versions • Using Spring XML conﬁguration ﬁles December 19, 2019 Amazon MQ is available in the Europe (Stockholm) and South America (São Paulo) regions. For information on available regions, see AWS Regions and Endpoints. 341 Amazon MQ Developer Guide Date Documentation Update December 16, 2019 Amazon MQ supports creating throughput-optimized brokers by using Amazon Elastic Block Store (EBS)—instead of the default Amazon Elastic File System (Amazon EFS)—for broker storage. To take advantage of high durability and replication across multiple Availability Zones, use Amazon EFS. To take advantage of low latency and high throughput, use Amazon EBS. Important • You can use Amazon EBS only with the mq.m5 broker instance type family. • Although you can change the broker instance type, you can't change the broker storage type after you create the broker. • Amazon EBS replicates data within a single Availability Zone and doesn't support the ActiveMQ active/standby deployment mode. For more information, see the following: • Storage • Choose the correct broker storage type for the best throughput • The storageType property of the broker-instance-options resource in the Amazon MQ REST API Reference • The BurstBalance , VolumeReadOps , and VolumeWriteOps metrics in the Monitoring and logging Amazon MQ brokers section. October 18, 2019 Two Amazon CloudWatch metrics are available: TotalEnqueueCount and TotalDequeueCount . For more information, seeMonitoring and logging Amazon MQ brokers 342 Amazon MQ Developer Guide Date Documentation Update October 11, 2019 Amazon MQ now supports Federal Information Processing Standard 140-2 (FIPS) compliant endpoints in U.S. commercial regions. For more information see the following: • Federal Information Processing Standard (FIPS) 140-2 • Amazon MQ Regions and Endpoints September 30, 2019 Amazon MQ now includes the ability to scale your brokers by changing the host instance type. For more information, see the hostInstanceType property of UpdateBrokerInput , and the pendingHostInstanc eType property of DescribeBrokerOutput . August 30, 2019 You can now update the security groups associated with a broker, both in the console and with UpdateBrokerInput . July 22, 2019 Amazon MQ integrates with AWS Key Management Service (KMS) to oﬀer server-side encryption. You can now select your own customer managed CMK, or use an AWS managed KMS key in your AWS KMS account. For more information, see Encryption at rest. Amazon MQ supports using AWS KMS keys in the following ways. • AWS owned KMS key — The key is owned Amazon MQ and is not in your account. • AWS managed KMS key — The AWS managed KMS key (aws/mq) is a KMS key in your account that is created, managed, and used on your behalf by Amazon MQ. • Select existing customer managed CMK — Customer managed CMKs are created and managed by you in AWS Key Management Service (KMS). June 19, 2019 Amazon MQ is available in the Europe (Paris) and Asia Paciﬁc (Mumbai) regions. For information on available regions, see AWS Regions and Endpoints. 343 Amazon MQ Developer Guide Date Documentation Update June 12, 2019 Amazon MQ is available in the Canada (Central) region. For information on available regions, see AWS Regions and Endpoints. June 3, 2019 Two new Amazon CloudWatch metrics are available: Establish edConnectionsCount more information, see the following: and InactiveDurableSubscribers . For • Monitoring and logging Amazon MQ brokers • Monitoring and logging Amazon MQ brokers May 10, 2019 Data storage for new mq.t2.micro instance types is limited to 20 GB. For more information, see the following: • the section called “Data Storage” • Broker instance types April 29, 2019 You can now use tag-based policies and resource-level permissions. For more information, see the following: • How Amazon MQ works with IAM • Resource-level permissions for Amazon MQ API actions April 16, 2019 You can now retrieve information about broker engine and broker instance options using the REST API. For more information, see the following: • Broker instance options • Broker engine types April 8, 2019 Amazon MQ supports ActiveMQ 5.15.9. For more information, see the following: • ActiveMQ 5.15.9
amazon-mq-dg-099	amazon-mq-dg.pdf	99	GB. For more information, see the following: • the section called “Data Storage” • Broker instance types April 29, 2019 You can now use tag-based policies and resource-level permissions. For more information, see the following: • How Amazon MQ works with IAM • Resource-level permissions for Amazon MQ API actions April 16, 2019 You can now retrieve information about broker engine and broker instance options using the REST API. For more information, see the following: • Broker instance options • Broker engine types April 8, 2019 Amazon MQ supports ActiveMQ 5.15.9. For more information, see the following: • ActiveMQ 5.15.9 Release Notes • Managing Amazon MQ for ActiveMQ engine versions • Using Spring XML conﬁguration ﬁles 344 Amazon MQ Developer Guide Date Documentation Update March 4, 2019 Improved the documentation for conﬁguring dynamic failover and the rebalancing of clients for a network of brokers. Enable dynamic failover by conﬁguring transportConnectors conﬁguration options. For more information, see the following: along with networkConnectors • Dynamic Failover With Transport Connectors • Amazon MQ network of brokers • Amazon MQ Broker Conﬁguration Parameters February 27, 2019 Amazon MQ is available in the Europe (London) Region in addition to the following regions: • Asia Paciﬁc (Singapore) • US East (Ohio) • US East (N. Virginia) • US West (N. California) • US West (Oregon) • Asia Paciﬁc (Tokyo) • Asia Paciﬁc (Seoul) • Asia Paciﬁc (Sydney) • Europe (Frankfurt) • Europe (Ireland) January 24, 2019 January 17, 2019 The default conﬁguration now includes a policy to purge inactive destinati ons. Amazon MQ mq.t2.micro instance types now support only 100 connectio ns per wire-level protocol. For more information, see, Quotas in Amazon MQ. 345 Amazon MQ Developer Guide Date Documentation Update December 19, 2018 You can conﬁgure a series of Amazon MQ brokers in a network of brokers. For more information, see the following sections: • Amazon MQ network of brokers • Creating and Conﬁguring a Network of Brokers • Conﬁgure Your Network of Brokers Correctly • networkConnector • networkConnectionStartAsync December 11, 2018 Amazon MQ supports ActiveMQ 5.15.8, 5.15.6, and 5.15.0. • Resolved bugs and improvements in ActiveMQ: • ActiveMQ 5.15.8 Release Notes • ActiveMQ 5.15.7 Release Notes December 5, 2018 AWS supports resource tagging to help track your cost allocation. You can tag resources when creating them, or by viewing the details of that resource. For more information, see Tagging resources. November 19, 2018 AWS has expanded its SOC compliance program to include Amazon MQ as an SOC compliant service. October 15, 2018 • The maximum number of groups per user is 20. For more information, see Users. • The maximum number of connections per broker, per wire-level protocol is 1,000. For more information, see Brokers. October 2, 2018 AWS has expanded its HIPAA compliance program to include Amazon MQ as a HIPAA Eligible Service. 346 Amazon MQ Developer Guide Date Documentation Update September 27, 2018 Amazon MQ supports ActiveMQ 5.15.6, in addition to 5.15.0. For more information, see the following: • Getting started: Creating and connecting to an ActiveMQ broker • Resolved bugs and improvements in the ActiveMQ documentation: • ActiveMQ 5.15.6 Release Notes • ActiveMQ 5.15.5 Release Notes • ActiveMQ 5.15.4 Release Notes • ActiveMQ 5.15.3 Release Notes • ActiveMQ 5.15.2 Release Notes • ActiveMQ 5.15.1 Release Notes • ActiveMQ Client 5.15.6 August 31, 2018 • The following metrics are available: • CurrentConnectionsCount • TotalConsumerCount • TotalProducerCount For more information, see the Monitoring and logging Amazon MQ brokers section. • The IP address of the broker is displayed on the Details page. Note For brokers with public accessibility disabled, the internal IP address is displayed. 347 Amazon MQ Developer Guide Date Documentation Update August 30, 2018 Amazon MQ is available in the Asia Paciﬁc (Singapore) Region in addition to the following regions: • US East (Ohio) • US East (N. Virginia) • US West (N. California) • US West (Oregon) • Asia Paciﬁc (Tokyo) • Asia Paciﬁc (Seoul) • Asia Paciﬁc (Sydney) • Europe (Frankfurt) • Europe (Ireland) July 30, 2018 You can conﬁgure Amazon MQ to publish general and audit logs to Amazon CloudWatch Logs. For more information, see Monitoring and logging Amazon MQ brokers. July 25, 2018 Amazon MQ is available in the Asia Paciﬁc (Tokyo) and Asia Paciﬁc (Seoul) Regions in addition to the following regions: • US East (Ohio) • US East (N. Virginia) • US West (N. California) • US West (Oregon) • Asia Paciﬁc (Sydney) • Europe (Frankfurt) • Europe (Ireland) July 19, 2018 You can use AWS CloudTrail to log Amazon MQ API calls. For more informati on, see Logging Amazon MQ API calls using CloudTrail. 348 Amazon MQ Developer Guide Date Documentation Update 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
amazon-mq-dg-100	amazon-mq-dg.pdf	100	in the Asia Paciﬁc (Tokyo) and Asia Paciﬁc (Seoul) Regions in addition to the following regions: • US East (Ohio) • US East (N. Virginia) • US West (N. California) • US West (Oregon) • Asia Paciﬁc (Sydney) • Europe (Frankfurt) • Europe (Ireland) July 19, 2018 You can use AWS CloudTrail to log Amazon MQ API calls. For more informati on, see Logging Amazon MQ API calls using CloudTrail. 348 Amazon MQ Developer Guide Date Documentation Update 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 productio n workloads that require high throughput: • mq.m5.large • mq.m5.xlarge • mq.m5.2xlarge • mq.m5.4xlarge For more information, see Broker instance types. June 27, 2018 Amazon MQ is available in the US West (N. California) Region in addition to the following regions: • US East (Ohio) • US East (N. Virginia) • US West (Oregon) • Asia Paciﬁc (Sydney) • Europe (Frankfurt) • Europe (Ireland) 349 Amazon MQ Developer Guide Date Documentation Update June 14, 2018 • You can use the AWS::Amazon MQ::Broker resource to perform the following actions: AWS CloudFormation • Create a broker. • Add conﬁguration changes or modify users for the speciﬁed broker. • Return information about the speciﬁed broker. • Delete the speciﬁed broker. Note When you change any property of the Amazon MQ Broker ConﬁgurationId or Amazon MQ Broker User property type, the broker is rebooted immediately. • You can use the AWS::Amazon MQ::Configuration AWS CloudForm ation resource to perform the following actions: • Create a conﬁguration. • Update the speciﬁed conﬁguration. • Return information about the speciﬁed conﬁguration. Note You can use AWS CloudFormation to modify—but not delete—an Amazon MQ conﬁguration. June 7, 2018 The Amazon MQ console supports German, Brazilian Portuguese, Spanish, Italian, and Traditional Chinese. May 17, 2018 The limit of number of users per broker is 250. For more information, see Users. March 13, 2018 Creating a broker takes about 15 minutes. For more information, see Finish creating the broker. 350 Amazon MQ Developer Guide Date Documentation Update March 1, 2018 • You can conﬁgure the concurrent store and dispatch for Apache KahaDB using the concurrentStoreAndDispatchQueues attribute. • The >CpuCreditBalance CloudWatch metric is available for mq.t2.micro broker instance type. January 10, 2018 The following changes aﬀect the Amazon MQ console: • In the broker list, the Creation column is hidden by default. To customize the page size and columns, choose • On the MyBroker page, in the Connections section, choosing the name of your security group or . opens the EC2 console (instead of the VPC console). The EC2 console allows more intuitive conﬁguration of inbound and outbound rules. For more information, see the updated Connecting a Java application to your broker section. January 9, 2018 • The permission for REST operation ID UpdateBroker is listed correctly as mq:UpdateBroker on the IAM console. • The erroneous mq:DescribeEngine permission is removed from the IAM console. 351 Amazon MQ Developer Guide Date Documentation Update November 28, 2017 This is the initial release of Amazon MQ and the Amazon MQ Developer Guide. • Amazon MQ is avaialble in the following regions: • US East (Ohio) • US East (N. Virginia) • US West (Oregon) • Asia Paciﬁc (Sydney) • Europe (Frankfurt) • Europe (Ireland) Using the mq.t2.micro instance type is subject to CPU credits and baseline performance—with the ability to burst above the baseline level (for more information, see the CpuCreditBalance metric). If your application requires ﬁxed performance, consider using an mq.m5.large instance type. • You can create mq.m4.large and mq.t2.micro brokers. Using the mq.t2.micro instance type is subject to CPU credits and baseline performance—with the ability to burst above the baseline level (for more information, see the CpuCreditBalance metric). If your application requires ﬁxed performance, consider using an mq.m5.large instance type. • You can use the ActiveMQ 5.15.0 broker engine. • You can also create and manage brokers programmatically using Amazon MQ REST API and AWS SDKs. • You can access your brokers by using any programming language that ActiveMQ supports and by enabling TLS explicitly for the following protocols: • AMQP • MQTT • MQTT over WebSocket • OpenWire 352 Amazon MQ Developer Guide Date Documentation Update • STOMP • STOMP over WebSocket • You can connect to ActiveMQ brokers using various ActiveMQ clients. We recommend using the ActiveMQ Client. For more information, see Connecting a Java application to your broker. • Your broker can send and receive messages of any size. 353
amazon-mq-mg-001	amazon-mq-mg.pdf	1	Amazon MQ Migration Guide Amazon MQ Copyright © 2025 Amazon Web Services, Inc. and/or its aﬃliates. All rights reserved. Amazon MQ Amazon MQ Migration Guide Amazon MQ: Amazon MQ Migration Guide Copyright © 2025 Amazon Web Services, Inc. and/or its aﬃliates. All rights reserved. Amazon's trademarks and trade dress may not be used in connection with any product or service that is not Amazon's, in any manner that is likely to cause confusion among customers, or in any manner that disparages or discredits Amazon. All other trademarks not owned by Amazon are the property of their respective owners, who may or may not be aﬃliated with, connected to, or sponsored by Amazon. Amazon MQ Table of Contents Amazon MQ Migration Guide What is the Amazon MQ migration guide? .................................................................................... 1 Concepts for migrating to Amazon MQ .................................................................................................. 1 Messaging protocols ............................................................................................................................... 1 Message persistence ............................................................................................................................... 1 Network options ...................................................................................................................................... 2 Availability options ................................................................................................................................. 2 Messaging patterns ................................................................................................................................. 3 Performance and scalability ................................................................................................................. 3 Latency ...................................................................................................................................................... 5 Destination options ................................................................................................................................. 5 Security and authentication .................................................................................................................. 6 Broker quotas ........................................................................................................................................... 7 Conﬁguration options ............................................................................................................................ 7 Cost estimation ........................................................................................................................................ 7 Migration approaches ...................................................................................................................... 9 Rehost ............................................................................................................................................................. 9 Replatform ..................................................................................................................................................... 9 Refactor (re-architect) .................................................................................................................................. 9 Phased migration ....................................................................................................................................... 10 Migrating without service interruption ........................................................................................ 11 Without service interruption .................................................................................................................... 11 To migrate to Amazon MQ without service interruption ............................................................. 12 Migrating from IBM MQ ................................................................................................................ 14 Terminologies .............................................................................................................................................. 14 IBM MQ architecture for migration ........................................................................................................ 20 Option one: IBM MQ high availability topology running on AWS .............................................. 20 Option Two: IBM MQ HA/DR topology running on-premises ...................................................... 22 Replicating IBM MQ architecture with Amazon MQ ........................................................................... 23 Re-platforming IBM MQ to Amazon MQ .............................................................................................. 25 Validating your migration to Amazon MQ ........................................................................................... 29 Migrating from TIBCO EMS ........................................................................................................... 31 Terminologies .............................................................................................................................................. 31 TIBCO EMS architecture for migration .................................................................................................. 34 Option 1: TIBCO EMS cross-regional architecture in AWS ........................................................... 34 iii Amazon MQ Amazon MQ Migration Guide Option 2: TIBCO EMS high availability architecture ...................................................................... 35 Replicating TIBCO EMS architecture with Amazon MQ ...................................................................... 36 Re-platforming TIBCO EMS to Amazon MQ ......................................................................................... 38 Validating your migration to Amazon MQ ........................................................................................... 40 Migrating to Amazon MQ for RabbitMQ ...................................................................................... 42 Prerequisites ................................................................................................................................................ 42 Step 1: Exporting deﬁnitions ................................................................................................................... 42 Step 2: Moving existing messages to your new Amazon MQ managed broker ............................. 43 Additional resources .................................................................................................................................. 44 Amazon MQ for ActiveMQ Throughput benchmarks .................................................................. 45 mq.m4.large ............................................................................................................................................. 46 mq.m5.large ............................................................................................................................................. 46 mq.m5.xlarge ........................................................................................................................................... 47 mq.m5.2xlarge ........................................................................................................................................ 48 mq.m5.4xlarge ........................................................................................................................................ 49 Supported plugins ......................................................................................................................... 50 Document history .......................................................................................................................... 51 iv Amazon MQ Amazon MQ Migration Guide What is the Amazon MQ migration guide? Amazon MQ is a managed message broker service that makes it easy to migrate to a message broker in the cloud. Amazon MQ currently supports Apache ActiveMQ and RabbitMQ engines. Amazon MQ for ActiveMQ simpliﬁes the migration of commercial brokers, such as IBM MQ and TIBCO Enterprise Management Service (EMS), to the cloud. Amazon MQ for ActiveMQ brokers are compatible with popular APIs and protocols, such as Java Message Service (JMS), allowing you to migrate applications with minimal code changes. Amazon MQ for RabbitMQ oﬀers cross-region data replication capabilities. Concepts for migrating to Amazon MQ Before migrating, review the following key concepts to consider when migrating a commercial message broker to Amazon MQ. Messaging protocols You can connect your broker to Amazon MQ without any code changes if you currently use one of the following industry-standard protocols: • AMQP • MQTT • MQTT over WebSocket • OpenWire • STOMP • STOMP over WebSocket For more information about connecting to an Amazon MQ managed broker, see Working Examples of Using Java Message Service (JMS) with ActiveMQ in the Amazon MQ Developer Guide. Message persistence To replicate persistence mode or sync point control options with Amazon MQ, you can deploy your brokers as active/standby brokers. In the active/standby deployment, brokers use shared storage across multiple Availability Zones, with an optional time to live (TTL). Concepts for migrating to Amazon MQ 1 Amazon MQ Amazon MQ Migration Guide For more information about how Amazon MQ ensures message durability, see the section called “Availability options”. Network options Depending on the interlopability of your applications and the type of access that they need, you can permit public access, VPN access, or VPC access using Amazon Virtual Private Cloud (Amazon VPC). In a hybrid architecture where on-premises systems need access to resources in the cloud, we recommend setting up your Amazon MQ managed brokers with public network access. You can also achieve a hybrid solution by using AWS VPN or AWS Direct Connect. Tip If your resources are primarily deployed within the AWS Cloud, we recommend conﬁguring your Amazon MQ brokers with Amazon VPC. For network access across multiple VPCs, you can use VPC peering. Availability options Amazon MQ supports
amazon-mq-mg-002	amazon-mq-mg.pdf	2	access that they need, you can permit public access, VPN access, or VPC access using Amazon Virtual Private Cloud (Amazon VPC). In a hybrid architecture where on-premises systems need access to resources in the cloud, we recommend setting up your Amazon MQ managed brokers with public network access. You can also achieve a hybrid solution by using AWS VPN or AWS Direct Connect. Tip If your resources are primarily deployed within the AWS Cloud, we recommend conﬁguring your Amazon MQ brokers with Amazon VPC. For network access across multiple VPCs, you can use VPC peering. Availability options Amazon MQ supports durability-optimized brokers backed by Amazon Elastic File System (Amazon EFS). You can conﬁgure single-instance brokers (one broker in one Availability Zone) or active/ standby brokers (two brokers in two diﬀerent Availability Zones). In either conﬁguration, Amazon MQ can automatically provision infrastructure for high message durability by storing messages redundantly across multiple Availability Zones. Note In the event of a broker or Availability Zone failure, active/standby brokers automatically fail over to a standby instance in another Availability Zone. To achieve high availability and message durability, you can use a network of brokers. A network of brokers is a series of simultaneously active single-instance or active/standby brokers that allows you to rapidly scale your throughput and connection count. You can conﬁgure a network of brokers in a variety of topologies depending on your application's needs. Network options 2 Amazon MQ Messaging patterns Amazon MQ Migration Guide Amazon MQ oﬀers the following topology options to support a variety of messaging patterns: • Point-to-point • Request-response • Hub and spoke • Mesh • Enterprise service bus For more information about using Amazon MQ to set up the right broker topology for your cloud architecture, see Amazon MQ Broker Architecture in the Amazon MQ Developer Guide. Important Revising a broker conﬁguration or an ActiveMQ user does not immediately apply those changes. For your changes to take eﬀect, you must wait for the next maintenance window or reboot the broker. For more information, see Amazon MQ Broker Conﬁguration Lifecycle in the Amazon MQ Developer Guide. Performance and scalability With Amazon MQ you can scale your messaging middleware horizontally, vertically, or in a hybrid model. Horizontal scaling enables you to increase your throughput and connection count without interruptions, because your resources remain active and online. To scale horizontally, you can deploy a network of brokers in an active/standby conﬁguration across multiple Availability Zones. To scale your resources vertically, you can increase the compute capacity of your broker instances from mq.t2.micro (1 vCPU and 1 GiB) up to mq.m5.4xlarge (16 vCPU and 64 GiB). For more information about Amazon MQ instance types, see Instance Types in the Amazon MQ Developer Guide. Messaging patterns 3 Amazon MQ Note Amazon MQ Migration Guide Choosing larger broker instance types might not improve overall system throughput. Overall latency is due to many factors, such as message size, the type of protocol, the number of active producers and consumers, consumption speed, and message persistence. Amazon MQ also supports creating throughput-optimized message brokers backed by Amazon Elastic Block Store (Amazon EBS). These brokers are ideal for applications such as high-volume order processing, stock trading, and text processing. To instruct Amazon MQ to optimize for queues with slow consumers, set the concurrentStorageAndDispatchQueues attribute to false. The following table shows the throughput of an mq.m5.2xlarge broker conﬁgured with these options: • Broker instance – mq.m5.2xlarge • Persistent – TRUE • Client – m5.xlarge • CSAD – TRUE • Protocol – OpenWire Producers/Consumers Message size Metrics 25 1 KB TPS 2,250 CPU% 8% 5 KB TPS CPU% 10 KB TPS CPU% 2,067 10% 1,900 15% 50 4,300 15% 3,834 17% 3,467 24% 100 8,467 27% 7,150 30% 7,083 48% 200 16,334 58% 14,516 63% 11,334 80% Performance and scalability 4 Amazon MQ Amazon MQ Migration Guide Producers/Consumers Message size Metrics 25 50 KB TPS CPU% 100 KB TPS CPU% 1,592 30% 1,250 42% 50 2,917 52% 2,184 72% 100 4,500 83% 2,513 85% 200 4,917 92% 2,770 92% Note Performance numbers can vary depending on multiple conﬁguration parameters. For more information on Amazon MQ throughput measurements, see Throughput Benchmarks. You can measure the throughput of your Amazon MQ brokers using JMS Benchmark. Latency You can set up your Amazon MQ brokers for low-latency messaging, with latency often as low as single-digit milliseconds. Use an always-on connection to help reduce the amount of time that it takes to deliver messages to a consumer. Using in-memory storage can further reduce overall latency across your messaging architecture. For more information on how diﬀerent storage types can aﬀect latency, see Diﬀerences Between Storage Types in the Amazon MQ Developer Guide. Destination options You can set up Amazon MQ managed brokers as queues or topics. Amazon MQ queues are, by default, ﬁrst
amazon-mq-mg-003	amazon-mq-mg.pdf	3	MQ brokers using JMS Benchmark. Latency You can set up your Amazon MQ brokers for low-latency messaging, with latency often as low as single-digit milliseconds. Use an always-on connection to help reduce the amount of time that it takes to deliver messages to a consumer. Using in-memory storage can further reduce overall latency across your messaging architecture. For more information on how diﬀerent storage types can aﬀect latency, see Diﬀerences Between Storage Types in the Amazon MQ Developer Guide. Destination options You can set up Amazon MQ managed brokers as queues or topics. Amazon MQ queues are, by default, ﬁrst in, ﬁrst out (FIFO) queues, also known as ordered queues. You can scale FIFO queues using Message Groups. You can conﬁgure your broker destinations with at-least-once delivery, at- most-once delivery, or exactly-once delivery options. Latency 5 Amazon MQ Amazon MQ Migration Guide Topics in Amazon MQ use the publisher/subscriber pattern and can be durable or non-durable. Amazon MQ topics also support Virtual Destinations, where publishers broadcast messages to a pool of subscribers through queues. We recommend using this method instead of durable topics. Tip You can optimize and ﬁne-tune the performance of your topics. For more information, see Performance Tuning on the Apache ActiveMQ website. Security and authentication With Amazon MQ you control who is allowed to create or modify brokers, and which applications are allowed to send and receive messages. For more information about authentication options, and how to integrate the Lightweight Directory Access Protocol (LDAP) with your Amazon MQ brokers, see Messaging Authentication and Authorization for ActiveMQ in the Amazon MQ Developer Guide. Connections to Amazon MQ brokers use Transport Layer Security (TLS). To isolate your brokers in a private virtual network, you can restrict access to a private endpoint within a VPC. To control network access to your brokers, you can conﬁgure security groups in the VPC. For more information, see Security Best Practices for Amazon MQ in the Amazon MQ Developer Guide. Amazon MQ encrypts messages at rest and in transit using encryption keys that it manages and stores securely in AWS Key Management Service (AWS KMS). AWS KMS helps reduce the operational burden and complexity involved in protecting sensitive data. With encryption at rest, you can build security-sensitive applications that meet encryption compliance and regulatory requirements. Tip For additional security, we highly recommend designing your application to use client-side encryption. For more information about Amazon MQ security and how messaging data is encrypted, see Data Protection in Amazon MQ in the Amazon MQ Developer Guide. Security and authentication 6 Amazon MQ Broker quotas Amazon MQ Migration Guide By default, each Amazon MQ broker can support 1,000 connections (or 100 connections for mq.t2.micro brokers). To allow multiple consumers to share connections to your Amazon MQ brokers and to improve overall performance, we recommend using pooled connections. For more information, see Always Use Connection Pooling in the Amazon MQ Developer Guide. You can request an increase for many broker usage quotas for your AWS account. For more information, see AWS service quotas in the AWS General Reference. Conﬁguration options Amazon MQ supports standard JMS features including point-to-point (message queues), publish- subscribe (topics), request/reply, persistent and non-persistent modes, JMS transactions, and distributed (XA) transactions. Amazon MQ brokers can also support more complex messaging patterns such as composite destinations, which enable producers to send the same message to multiple destinations, and virtual destinations, which enable publishers to broadcast messages via a topic to a pool of receivers subscribing through queues. For more information, see Amazon MQ Broker Conﬁguration Parameters in the Amazon MQ Developer Guide. Cost estimation With Amazon MQ, you pay only for the provisioned capacity that you use. Factors such as broker instance type, the amount of data stored on each broker instance, and the AWS Region in which you deploy your brokers can aﬀect your total cost of ownership. To estimate your broker costs for Amazon MQ, you can us the AWS Pricing Calculator. Note For data transferred in and out of Amazon MQ, you pay standard AWS data transfer charges. To get started, Amazon MQ oﬀers a Free Tier, which includes up to 750 hours of a single-instance mq.t2.micro or mq.t3.micro broker per month, and up to 5 GB of durability-optimized storage Broker quotas 7 Amazon MQ Amazon MQ Migration Guide per month for one year. For more information on the Free Tier, pricing, and associated costs, see Amazon MQ Pricing. Cost estimation 8 Amazon MQ Amazon MQ Migration Guide Options for migrating to Amazon MQ The ﬁrst step in migrating your commercial message broker to Amazon MQ is determining the right migration approach for your existing application architecture. The following are the most common approaches to migration: Topics • Rehost • Replatform • Refactor (re-architect) • Phased migration Rehost The rehost ("lift and shift")
amazon-mq-mg-004	amazon-mq-mg.pdf	4	up to 5 GB of durability-optimized storage Broker quotas 7 Amazon MQ Amazon MQ Migration Guide per month for one year. For more information on the Free Tier, pricing, and associated costs, see Amazon MQ Pricing. Cost estimation 8 Amazon MQ Amazon MQ Migration Guide Options for migrating to Amazon MQ The ﬁrst step in migrating your commercial message broker to Amazon MQ is determining the right migration approach for your existing application architecture. The following are the most common approaches to migration: Topics • Rehost • Replatform • Refactor (re-architect) • Phased migration Rehost The rehost ("lift and shift") approach is ideal for moving on-premises workloads to the cloud when time is critical and ambiguity is high. Rehosting is the process of moving your existing applications from one infrastructure to another. The most signiﬁcant beneﬁt of this approach is that it enables you to migrate without changing large portions of application code. Fewer changes can also reduce the amount of re-training needed for engineers. Replatform The replatform strategy involves moving applications almost as-is, but replacing some components to take advantage of a cloud architecture. Here you might make a number of cloud-based optimizations to achieve some tangible beneﬁt, but you aren't changing the core architecture of your application. You may be looking only to reduce the amount of time that you spend managing your broker. Refactor (re-architect) Refactoring (also known as "re-architecting") maximizes the beneﬁts of moving to the cloud. Refactoring requires research, planning, experimentation, implementation, and deployment. These eﬀorts generally provide the greatest rate of return in the form of reduced hardware and storage costs, less operational maintenance, and the most ﬂexibility to meet future business needs. In Rehost 9 Amazon MQ Amazon MQ Migration Guide many cases, it involves breaking up the application into independent services and transitioning to a microservices architecture. Phased migration If you are interested in a phased, incremental migration approach, we recommend using a JMS proxy implementation such as Camel. For example, you can use the JMS Bridge Sample project, which allows you to bridge from your existing on-premises messaging broker to Amazon MQ. You can also use enterprise integration patternssample to learn how to use Apache Camel and Amazon MQ to implement common patterns for routing, message transformation, and integration with other AWS services. In the sample, you will use Amazon EKS to scale Apache Camel. You can apply the same approach to migrate from IBM MQ or TIBCO EMS to Amazon MQ. Phased migration 10 Amazon MQ Amazon MQ Migration Guide Migrating to Amazon MQ without service interruption Use the following topics to learn more about potential service interruptions before migrating your on-premises message broker to Amazon MQ. Migrating to Amazon MQ without service interruption You can migrate from an on-premises message broker to an Amazon MQ broker in the AWS Cloud without service interruption. Important This scenario might cause messages to be delivered out of order. The following diagrams illustrate the scenario of migrating from an on-premises message broker to an Amazon MQ broker in the AWS Cloud without service interruption. Without service interruption 11 Amazon MQ Amazon MQ Migration Guide On-Premises Message Broker Migration to Amazon MQ with Standard (Unordered) Queues To migrate to Amazon MQ without service interruption and conﬁgure an Amazon MQ broker and note your broker's endpoint, for example: Create ssl://b-1234a5b6-78cd-901e-2fgh-3i45j6k178l9-1.mq.us-east-2.amazonaws.com:61617 For either of the following cases, use the Failover Transport to allow your consumers to randomly connect to your on-premises broker's endpoint or your Amazon MQ broker's endpoint. For example: To migrate to Amazon MQ without service interruption 12 Amazon MQ Amazon MQ Migration Guide failover:(ssl://on-premises-broker.example.com:61617,ssl:// b-1234a5b6-78cd-901e-2fgh-3i45j6k178l9-1.mq.us-east-2.amazonaws.com:61617)? randomize=true 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 ﬂeet during the migration process, it is a best practice to scale it down afterward. One by one, stop each existing producer, point the producer to your Amazon MQ broker's endpoint, and then restart the producer. Wait for your consumers to drain the destinations on your on-premises broker. Change your consumers' Failover transport to include only your Amazon MQ broker's endpoint. For example: failover:(ssl://b-1234a5b6-78cd-901e-2fgh-3i45j6k178l9-1.mq.us- east-2.amazonaws.com:61617) Stop your on-premises broker. To migrate to Amazon MQ without service interruption 13 Amazon MQ Amazon MQ Migration Guide Migrating from IBM MQ queue manager to Amazon MQ You can migrate you IBM MQ system to Amazon MQ while keeping the same conﬁguration. Terminologies The following table is a list of common IBM MQ concepts, and how they relate to Amazon MQ. IBM MQ Amazon MQ Component Description Component Description Broker Broker in Amazon MQ is equivalent to IBM MQ Queue Manager. Network of Brokers Amazon MQ provides Network of Brokers to route
amazon-mq-mg-005	amazon-mq-mg.pdf	5	MQ broker's endpoint. For example: failover:(ssl://b-1234a5b6-78cd-901e-2fgh-3i45j6k178l9-1.mq.us- east-2.amazonaws.com:61617) Stop your on-premises broker. To migrate to Amazon MQ without service interruption 13 Amazon MQ Amazon MQ Migration Guide Migrating from IBM MQ queue manager to Amazon MQ You can migrate you IBM MQ system to Amazon MQ while keeping the same conﬁguration. Terminologies The following table is a list of common IBM MQ concepts, and how they relate to Amazon MQ. IBM MQ Amazon MQ Component Description Component Description Broker Broker in Amazon MQ is equivalent to IBM MQ Queue Manager. Network of Brokers Amazon MQ provides Network of Brokers to route traﬃc to multiple brokers. Queues This is equivalent to queues in Amazon MQ. Standard Queue Manager Gateway Queue Manager Local Queues Standard Queue Manager is similar to a broker but one server can have multiple IBM MQ Queue Managers A gateway Queue Manager is used to balance the workload. by routing traﬃc across multiple IBM MQ Queue Managers. A local queue is a deﬁnition of both a queue and the set of messages that are associated with a queue. The hosting IBM MQ Queue Manager receives messages in its local queues. Local queues Terminologies 14 Amazon MQ Amazon MQ Migration Guide IBM MQ Amazon MQ Remote Queues Network of Brokers support several IBM MQ speciﬁc propertie s like put, get, inhibits, etc. Remote queues are used to refer to a queue which physically exists on a diﬀerent IBM MQ Queue Manager, but connectivity is established using channels (Sender Channel and Receiver Channel) Alias Queues Alias queues are used to give a diﬀerent Composite and Virtual Destinations name to a diﬀerent physical queue. It allows setting diﬀerent security settings to the same physical queue. Model Queues Acts as a template for a queue deﬁnition. Destination Policy This is achieved using a Network of Brokers. Networks of Brokers connect to one another on a Network Connector . With a Netowork of Brokers, you can create connectio ns across diﬀerent Regions and Availabil ity Zones. Composite Destinati ons and Virtual destinations provide the same functiona lity in the Amazon MQ world. You can achieve this by making a minor change in a broker conﬁguration ﬁle. This can be achieved using Destination Policies in the broker conﬁguration ﬁle Terminologies 15 Amazon MQ Amazon MQ Migration Guide IBM MQ Amazon MQ Transmission Queues Used for remote queue connectivity Network of Brokers A network of Brokers provides equivalent conﬁguration using Network Connector Topics Pub-Sub destination Topics Topics in Amazon MQ Provides the details for the connection point for producers and consumers to connect to a broker. Server connection channel Basic construct through which direct Transport Connector connectivity from a remote applicati on client to an MQ server is established. Admins can create multiple connection channels to enforce diﬀerent policies. A default server connection channel is created for each IBM MQ Queue Manager. Allows for monitoring of connections from remote clients. Terminologies 16 Amazon MQ Amazon MQ Migration Guide IBM MQ Amazon MQ Client Connection Channel Client connection channel in IBM MQ Transport Connector Transport Connector provides the details for the connection point for producers and consumers to connect to a broker. allows a connection mode where a conﬁg ﬁle (client connectio n deﬁnition table, or CCDT) is kept on the client application side which speciﬁes options around connecting to an IBM MQ Queue Manager. Usually, legacy applications prior to JMS were written using this mechanism. Channel level Firewall is used to blacklist/ whitelist IP address, protocols Channel level Firewall Security Group With Amazon MQ, use the Security Group at the broker level and use NACL at the subnet level to create a ﬁrewall. Terminologies 17 Amazon MQ Amazon MQ Migration Guide IBM MQ Amazon MQ Error Logs Listener Amazon CloudWatch Broker Instance Each IBM MQ Queue Manager has a conﬁguration around transaction logs. It's similar to database logs. It has a size and policy (circular /linear). Any time there is a shared JMS transaction, the state is written in a log ﬁle for rollback or commit. A listener is an IBM MQ process that listens for connectio ns to the IBM MQ Queue Manager. LDAP Authentication IBM MQ provides out of box connectivity IAM and LDAP Authentication to LDAP and group- based access to QM, queues, topics, etc. It also supports ﬁne-grained access control at queue and topic levels. CloudWatch logs are fully integrate d with Amazon MQ. For more informati on, see Monitoring Amazon MQ Brokers Using Amazon CloudWatch. Amazon MQ is a managed broker and acts as a listener by itself. Simple authentic ation is available with Amazon MQ. Fine-grained access is only available at the broker user level. Fine-Grained Access Control at queue and topic level with access options to Get, Put. To learn more, see Messaging Authentication and Authorization. Terminologies 18 Amazon
amazon-mq-mg-006	amazon-mq-mg.pdf	6	Authentication to LDAP and group- based access to QM, queues, topics, etc. It also supports ﬁne-grained access control at queue and topic levels. CloudWatch logs are fully integrate d with Amazon MQ. For more informati on, see Monitoring Amazon MQ Brokers Using Amazon CloudWatch. Amazon MQ is a managed broker and acts as a listener by itself. Simple authentic ation is available with Amazon MQ. Fine-grained access is only available at the broker user level. Fine-Grained Access Control at queue and topic level with access options to Get, Put. To learn more, see Messaging Authentication and Authorization. Terminologies 18 Amazon MQ Amazon MQ Migration Guide IBM MQ Amazon MQ Not Applicable Not Applicable Plugins Limited plugins supported. To learn more, see Supported plugins Network of Brokers Using Network of Brokers and each broker with Active-St andby conﬁguration Message channel agent (MCA) Channel exit programs Queue Manager Group MCA is used to enforce an alternate level of security. The default conﬁgura tion is at the server connection channel level. Channel exit programs are programs that are called at deﬁned places in the processing sequence of a Message channel agent (MCA). Users and vendors can write their own channel exit programs. Some are supplied by IBM. Queue Manager Group is used to support a cluster of IBM MQ Queue Managers. It is based on providing a high availability but providing a set of IBM MQ Queue Manager for connectivity. Terminologies 19 Amazon MQ Amazon MQ Migration Guide IBM MQ Amazon MQ Network Connector A duplex communica tion channel between 2 brokers. Sender / Receiver Channels A message channel, a unidirectional communications link between two IBM MQ Queue Managers. WebSphere MQ uses message channels to transfer messages between the IBM MQ Queue Managers. To send messages in both direction s, you must deﬁne a channel for each direction. Which IBM MQ architectures are used for migrating to Amazon MQ? You can migrate from IBM MQ to Amazon MQ using IBM MQ high availability topology running on AWS or IBM MQ HA/DR topology running on-premises. Option one: IBM MQ high availability topology running on AWS The below diagram shows a typical architecture of IBM MQ connections between two IBM MQ queue managers in a High Availability cluster as seen in many enterprise applications. IBM MQ queue manager QM_ORANGE is deployed in the us-east-1 region and QM_APPLE is deployed in the us-east-2 region. IBM MQ architecture for migration 20 Amazon MQ Amazon MQ Migration Guide For application App 1 to communicate with App 2: 1. App 1 uses a communications channel to send messages to QM_ORANGE on Remote Q1. 2. Messages from several such queues, though not shown in the diagram, are pooled into transmission Queue Q QM_APPLE. 3. Sender channels read messages from the transmission queue, and communicate with a receiver channel to place messages on Local Q1 on queue manager QM_APPLE ,which are then consumed by App 2. Option one: IBM MQ high availability topology running on AWS 21 Amazon MQ Amazon MQ Migration Guide Option Two: IBM MQ HA/DR topology running on-premises In the above diagram, the MQ Cluster is comprised of two separate queue managers and all messages are routed via cluster channels and queueing. If one queue manager fails, messages are then re-routed to another queue manager. The Server Cluster is made up of just a single queue manager with three distinct IP addresses. In this conﬁguration, all applications are connected to the Server Cluster IP addresses. If failure is detected, the SAN begins pointing to the secondary server. In case, of a failure event, channel connections do not have to be changed, and connectivity remains uninterrupted for users. The Multi-Instance queue manager is comprised of a single queue manager with identical queues on both servers, and two distinct IP addresses. If failure is detected, a queue manager must be manually activated on the seconrd server and channel connections must be changed, resulting in possible service interruptions. Option Two: IBM MQ HA/DR topology running on-premises 22 Amazon MQ Amazon MQ Migration Guide To ensure disaster recovery, data is replicated in real-time to a separate server in a diﬀerent location. In case of a disaster, manual eﬀort is required to process the data stored on the Disaster Recovery (DR) server, and change channel connections, resulting in possible service interruptions. Replicating IBM MQ architecture with Amazon MQ Amazon MQ provides a variety of broker conﬁgurations, various instance sizes for diﬀerent workloads, and broker options such as single instance, single instance mesh, active/standby instance or active/standby mesh for high availabilty and message durability. To learn more about supported broker options, see Amazon MQ Broker Architecture. In this section, we replicate the IBM MQ system shown in the previous section with Amazon MQ, while keeping the same conﬁguration. Amazon MQ manages the work involved
amazon-mq-mg-007	amazon-mq-mg.pdf	7	the data stored on the Disaster Recovery (DR) server, and change channel connections, resulting in possible service interruptions. Replicating IBM MQ architecture with Amazon MQ Amazon MQ provides a variety of broker conﬁgurations, various instance sizes for diﬀerent workloads, and broker options such as single instance, single instance mesh, active/standby instance or active/standby mesh for high availabilty and message durability. To learn more about supported broker options, see Amazon MQ Broker Architecture. In this section, we replicate the IBM MQ system shown in the previous section with Amazon MQ, while keeping the same conﬁguration. Amazon MQ manages the work involved in setting up an ActiveMQ message broker, from provisioning the infrastructure capacity (server instances and storage) to installing the broker software. Once your broker is up and running, Amazon MQ automates common administrative tasks such as patching the ActiveMQ software that power your brokers. Note If you wish to use a single region, you can simply deploy your Amazon MQ brokers in one region with the active/standby conﬁguration. You can also optimize the performance of your Amazon MQ brokers by taking advantage of the Apache ActiveMQ optimization settings. The following diagram illustrates Amazon MQ conﬁgured across two regions with a linear connection between two active/standby brokers: Replicating IBM MQ architecture with Amazon MQ 23 Amazon MQ Amazon MQ Migration Guide For App 1 to communicate with App 2: 1. Client applications can use a transport connector and put messages onto a Queue or publish to a Topic. 2. Brokers connect to each other over a network connector either in one direction or both directions in cases where request-reply messaging is required. 3. Queues and users can be created and managed in the AWS Console. To learn more, see Amazon MQ Basic Elements. Note • A transmit queue in IBM MQ is a local queue, except it is used to forward messages to a remote IBM MQ queue manager through a sender-receiver channel pair. In Amazon MQ, a transmit queue is not required. Once 2 brokers are connected using a network connector, they begin to share all queues/topics, and their data. • A remote queue in IBM MQ is a local impression of a remote queue available at a remote IBM MQ queue manager. For external applications, there is no diﬀerence between local or remote queues. In Amazon MQ, there is no remote queue mechanism and it is not required. Replicating IBM MQ architecture with Amazon MQ 24 Amazon MQ Amazon MQ Migration Guide • Sender or receiver channels in IBM MQ are used as network paths to connect 2 IBM MQ queue managers. In Amazon MQ, this functionality is implemented using network connectors. • Currently, Amazon MQ only supports JMS 1.1. Applications written for JMS 2.0 can be migrated to Amazon MQ using the Qpid JMS library, which uses AMQP instead of the default, higher-performing Openwire protocol. For more details, refer to the Amazon MQ workshop. Re-platforming IBM MQ to Amazon MQ The following procedure shows how you can migrate an IBM MQ to an equivalent Amazon MQ without impacting App 1 or App 2: 1. Create an active/standby broker in us-east-1 and another in us-east-2 named as AMQ_ORANGE and AMQ_APPLE. 2. Create a Network Bridge between 2 brokers by adding a duplex network connector deﬁnition to one of the queues: <networkConnectors> <networkConnector duplex="true" name="connector_AMQ_ORANGE_to_AMQ_APPLE" uri="masterslave:(ssl://b-d63bcc4d-682b-40a2-8227-31386bcf1e3d-1.mq.us- east-2.amazonaws.com:61617,ssl://b-d63bcc4d-682b-40a2-8227-31386bcf1e3d-2.mq.us- east-2.amazonaws.com:61617)" userName="amqadmin"/> </networkConnectors> After the reboot of AMQ_ORANGE, there should be a Network Bridge created between both brokers as illustrated below: Re-platforming IBM MQ to Amazon MQ 25 Amazon MQ Amazon MQ Migration Guide Note Steps 1 and 2 can be replicated using a AWS CloudFormation template. For more information about using AWS CloudFormation to set up Amazon MQ brokers, see the Amazon MQ AWS CloudFormation Template Reference. 3. Log in to IBM MQ Queue Manager Host and list the queues/topics deﬁnitions. In QM_ORANGE, you can list the queues and topics from IBM MQ using the following command: $ sudo dmpmqcfg -m QM_ORANGE -t queue -o 1line \| grep -v "SYSTEM" \| grep -v "AUTHREC" \| grep -v "*" \| Re-platforming IBM MQ to Amazon MQ 26 Amazon MQ Amazon MQ Migration Guide gawk -F: '{ print $1 }‘ The output: DEFINE QREMOTE('Q1') RQMNAME('QM_APPLE') RNAME('Q1') XMITQ('QM_APPLE') REPLACE DEFINE QLOCAL('Q2') DISTL(NO) MAXDEPTH(5000) REPLACE DEFINE QLOCAL('QM_APPLE') GET(DISABLED) MAXDEPTH(5000) USAGE(XMITQ) REPLACE In the example above, Q1 is the link to the remote queue, QM_APPLE is the transit queue, and Q2 is the local queue. We only need local queue Q2 for the Amazon MQ setup, which can be deﬁned in the broker conﬁguration as <queue physicalName="Q2"/> Q1 is a local queue on QM_APPLE and Q2 is a local queue in QM_ORANGE. You can conﬁgure these resources accordingly in AMQ_APPLE and AMQ_ORANGE by using the following conﬁguration <destinations> <queue physicalName="localQ1"/> </destinations> Similairly, get the list of queues
amazon-mq-mg-008	amazon-mq-mg.pdf	8	RQMNAME('QM_APPLE') RNAME('Q1') XMITQ('QM_APPLE') REPLACE DEFINE QLOCAL('Q2') DISTL(NO) MAXDEPTH(5000) REPLACE DEFINE QLOCAL('QM_APPLE') GET(DISABLED) MAXDEPTH(5000) USAGE(XMITQ) REPLACE In the example above, Q1 is the link to the remote queue, QM_APPLE is the transit queue, and Q2 is the local queue. We only need local queue Q2 for the Amazon MQ setup, which can be deﬁned in the broker conﬁguration as <queue physicalName="Q2"/> Q1 is a local queue on QM_APPLE and Q2 is a local queue in QM_ORANGE. You can conﬁgure these resources accordingly in AMQ_APPLE and AMQ_ORANGE by using the following conﬁguration <destinations> <queue physicalName="localQ1"/> </destinations> Similairly, get the list of queues and topics from QM_APPLE. 4. Manually create a dead letter queue strategy in the AMQ conﬁguration ﬁle. The defaultdead letter queue in ActiveMQ is called ActiveMQ.DLQ. All un-deliverable messages will get routed to this queue. To streamline this process, you can set up an individualDeadLetterStrategy in the destination policy map of the activemq.xml conﬁguration ﬁle, allowing you to specify a speciﬁc dead letter queue preﬁx for a given queue or topic. You can apply this strategy using a wild-card so that all queues can be set up with their own dead-letter queues, as is shown in the example below: <broker> <destinationPolicy> <policyMap> <policyEntries> <!-- Set the following policy on all queues using the '>' wildcard --> <policyEntry queue=">"> <deadLetterStrategy> Re-platforming IBM MQ to Amazon MQ 27 Amazon MQ Amazon MQ Migration Guide <!-- Use the prefix 'DLQ.' for the destination name, and make the DLQ a queue rather than a topic --> <individualDeadLetterStrategy queuePrefix="DLQ." useQueueForQueueMessages="true"/> </deadLetterStrategy> </policyEntry> </policyEntries> </policyMap> </destinationPolicy> </broker> Note Dead-Letter queue expiration - By default, ActiveMQ will never expire messages sent to a Dead-Letter Queue (DLQ). However, beginning with ActiveMQ 5.12, the deadLetterStrategy supports an expiration attribute whose value is given in milliseconds as shown below: <broker> <destinationPolicy> <policyMap> <policyEntries> <policyEntry queue="QueueWhereItIsOkToExpireDLQEntries"> <deadLetterStrategy> <.... expiration="300000"/> </deadLetterStrategy> </policyEntry> </policyEntries> </policyMap> </destinationPolicy> </broker> Re-platforming IBM MQ to Amazon MQ 28 Amazon MQ Amazon MQ Migration Guide 5. Create local queue Q1 on AMQ_ORANGE and Q2 on AMQ_APPLE as shown in the following: Validating your migration to Amazon MQ Learn how to test and validate the availbability of your brokers using the following procedure. 1. Subscribe to Q1 on AMQ_APPLE and Q2 on AMQ_ORANGE. Using a Network Bridge, create a queue replica on both sides. Note The process for external subscribers is the same as subscribing to local queues. Validating your migration to Amazon MQ 29 Amazon MQ Amazon MQ Migration Guide The following example shows the AMQ_ORANGE broker with consumers in us-east-1 and AMQ_APPLE with consumers in us-east-2 : 2. Both queues are now available to both brokers, producers can send messages to any broker, and subscribers can receive messages from any broker. For JMS 1.1 compliant applications, change the endpoint URL to an ActiveMQ failover URL. Note To learn more about a phased migration approach from IBM MQ to Amazon MQ, refer to this post. Validating your migration to Amazon MQ 30 Amazon MQ Amazon MQ Migration Guide Migrating from TIBCO EMS server to Amazon MQ You can migrate from TIBCO EMS to Amazon MQ. Terminologies The following is a list of common TIBCO EMS concepts and how they relate to Amazon MQ. TIBCO EMS Amazon MQ Component Description Component Description EMS Server Static Destination Dynamic Destination Broker Startup Destination Destination TIBCO EMS Server is a message broker that supports standards- based Java Message Service (JMS) 1.1 and 2.0. It also supports TIBCO proprietary messaging formats, FTL, Rendezvous, and SmartSockets. Conﬁguration information for a static destination is stored in conﬁgura tion ﬁles for the EMS server. Dynamic Destinati on is created as required by the client application and exists as long as there are messages or Broker in Amazon MQ is equivalent to TIBCO EMS Server. It provides support for industry-standard APIs such as JMS and NMS, and protocols such as AMQP, STOMP, MQTT, and WebSocket. Amazon MQ allows you to create destinations when the broker is started by conﬁguring Startup Destinations. In Amazon MQ, a destination is, by default, created automatically when it is used. You can use the Delete Inactive Destinations feature Terminologies 31 Amazon MQ Amazon MQ Migration Guide TIBCO EMS Amazon MQ consumers associated with a destination. in order to replicate the behavior of Dynamic Destinations in TIBCO EMS. Temporary Destinati on A Temporary Destination is used Temporary Destinati on A Temporary Destination is used for reply messages in request/reply interactions. Queue A queue is a mode to provide point to point Queue Route messaging channel from producers to consumers TIBCO EMS servers have to enable and conﬁgure routing to route messages to one or more servers. A route forwards messages between corresponding global destinations. Network Connector for reply messages in request/reply interactions. Similar to that of TIBCO EMS, Amazon MQ’s Queue is a
amazon-mq-mg-009	amazon-mq-mg.pdf	9	with a destination. in order to replicate the behavior of Dynamic Destinations in TIBCO EMS. Temporary Destinati on A Temporary Destination is used Temporary Destinati on A Temporary Destination is used for reply messages in request/reply interactions. Queue A queue is a mode to provide point to point Queue Route messaging channel from producers to consumers TIBCO EMS servers have to enable and conﬁgure routing to route messages to one or more servers. A route forwards messages between corresponding global destinations. Network Connector for reply messages in request/reply interactions. Similar to that of TIBCO EMS, Amazon MQ’s Queue is a mode to provide point-to-point messaging channels from producers to consumers Networks of Brokers can connectto each other on a Network Connector and allows connections across Availability Zones and region. Terminologies 32 Amazon MQ Amazon MQ Migration Guide TIBCO EMS Amazon MQ Routed Queue Topic Global Topic Network of Brokers This is achieved using a network of brokers. Amazon MQ provides a richer feature-set to work with destination behavior in Networks of Brokers. Topics Topics in Amazon MQ are equivalent to topics in TIBCO EMS. Network of Brokers This is achieved using a network of brokers. Amazon MQ provides a richer feature-set to work with destination behavior in Networks of Brokers. A Routed Queue has to be conﬁgure d on another EMS server for messages to be forwarded to or from a Queue. Queue messages can travel only one hop to the home queue, and one hop from the home queue. Topics implement publish and subscribe messaging, and are equivalent to topics in Amazon MQ. A Global Topic has to be conﬁgured on another EMS server for messages to be forwarded to or from a Topic. In a multi-hop zone, Topic messages are forwarded to all servers connected by routers within the zone. In a one-hop zone, topic messages travel only one hop. Terminologies 33 Amazon MQ Amazon MQ Migration Guide TIBCO EMS Amazon MQ Destination Bridges This allows all messages delivered Virtual Topics and Composite Destinati Topic to queue bridge-like functiona to one destination ons to also be delivered to the bridged destination. It is most commonly used to create durability of messages published on a topic using the topic to queue bridge. EMS server writes persistent messages to disk and provides ﬁle-based and database stores. For ﬁle-based stores, you have to truncate the ﬁles periodically to relinquish disk space. N/A lity can be achieved using Virtual Topics in Amazon MQ. Other bridges can be migrated using Composite Destinati ons in Amazon MQ. Amazon MQ also supports message persistence. Amazon MQ is a managed service and the overall storage is fully managed by AWS. Message Store Which TIBCO EMS architectures are used for migrating to Amazon MQ? You can migrate from TIBCO EMS to Amazon MQ using cross-regional architecture in AWS or TIBCO EMS high availability architecture. Option 1: TIBCO EMS cross-regional architecture in AWS The below diagram shows the typical architecture of TIBCO EMS routing between two TIBCO EMS Servers in diﬀerent regions, common in many enterprise systems. TIBCO EMS Server EMS_ORANGE is deployed in the us-east-1 region and EMS_APPLE is deployed in the us-east-2 region: TIBCO EMS architecture for migration 34 Amazon MQ Amazon MQ Migration Guide For application App 1 to communicate with App 2: 1. App 1 uses a topic destination, Topic1 on server EMS_ORANGE to publish messages. 2. Published messages are transmitted to topic Topic1 on server EMS_APPLE using the conﬁgured route. 3. On EMS_APPLE, a bridge is conﬁgured to move messages from topic, Topic1 to queue, Queue1. Messages are then consumed by App 2. Option 2: TIBCO EMS high availability architecture In this conﬁguration, High availability is provided by conﬁguring a pair of servers, Primary and Secondary. In a typical enterprise architecture, two high availability conﬁgurations, shared and unshared. The shared state setup is the most widely used setup in enterprise settings. The Option 2: TIBCO EMS high availability architecture 35 Amazon MQ Amazon MQ Migration Guide following diagram demonstrates the Shared State conﬁguration for a pair of messaging servers: In the above diagram, a pair of messaging servers share a state by sharing ﬁle-based storage. The primary server attains the lock on the shared storage capacity, becomes active, and accepts client connections, while the secondary server remains in passive mode. Meanwhile, the primary and secondary servers will be made aware of one another's status via periodic, heartbeat pings. In te case of a failover, the secondary server will assume the state of the primary server, and acquire the lock on the shared state. Note The above conﬁguration is unable to support more than two servers, and data replication across the servers for durability. Replicating TIBCO EMS architecture with Amazon MQ Amazon MQ provides a variety of broker conﬁgurations, various instance sizes for diﬀerent
amazon-mq-mg-010	amazon-mq-mg.pdf	10	shared storage capacity, becomes active, and accepts client connections, while the secondary server remains in passive mode. Meanwhile, the primary and secondary servers will be made aware of one another's status via periodic, heartbeat pings. In te case of a failover, the secondary server will assume the state of the primary server, and acquire the lock on the shared state. Note The above conﬁguration is unable to support more than two servers, and data replication across the servers for durability. Replicating TIBCO EMS architecture with Amazon MQ Amazon MQ provides a variety of broker conﬁgurations, various instance sizes for diﬀerent workloads, and broker options such as single instance, single instance mesh, active/standby instance or active/standby mesh for high availabilty and message durability. To learn more about supported broker options, see Amazon MQ Broker Architecture. In this section, we replicate the architecture of the TIBCO EMS system shown in the previous section with Amazon MQ while keeping the same conﬁguration. Replicating TIBCO EMS architecture with Amazon MQ 36 Amazon MQ Note Amazon MQ Migration Guide If you wish to use a single region, you can simply deploy your Amazon MQ brokers in one region with the active/standby conﬁguration. You can also optimize the performance of your Amazon MQ brokers by taking advantage of the Apache ActiveMQ optimization settings. The following diagram illustrates Amazon MQ conﬁgured across two regions with a linear connection between two active/standby brokers: For App 1 to communicate with App 2: 1. Client applications can use a transport connector and put messages onto a Queue or publish to a Topic. 2. Brokers connect to each other over a network connector either in one direction or both directions in cases where request-reply messaging is required. 3. Queues and users can be created and managed in the AWS Console. To learn more, see Amazon MQ Basic Elements. Note • A Global Topic with the same name has to be created on other EMS Servers for forwarding messages to the Topic on those EMS Servers. In Amazon MQ, a global topic Replicating TIBCO EMS architecture with Amazon MQ 37 Amazon MQ Amazon MQ Migration Guide is not required. Once 2 brokers are connected using a network connector, they begin to share all queues/topics, and their data. • In Amazon MQ, a routed queue as implemented by a TIBCO EMS server is not required. • A network bridge from a topic to a queue can be used in TIBCO EMS architecture to avoid the naming issue with routed queues and to provide multi-hop capability between EMS servers using a Topic. In Amazon MQ, queue names are consistent and all topic/queue messages are shared among a Networks of Brokers. • Currently, Amazon MQ only supports JMS 1.1. Applications written for JMS 2.0 can be migrated to Amazon MQ using the Qpid JMS library, which uses AMQP instead of the default, higher-performing Openwire protocol. For more details, refer to the Amazon MQ workshop. Re-platforming TIBCO EMS to Amazon MQ You can use the following procedure to migrate the TIBCO EMS architecture shown here to an equivalent Amazon MQ architecture without impacting App 1 or App 2: 1. Create an active/standby broker in us-east-1 and another in us-east-2 named as AMQ_ORANGE and AMQ_APPLE. 2. Create a Network Bridge between 2 brokers by adding a duplex network connector deﬁnition to one of the queues: <networkConnectors> <networkConnector duplex="true" name="connector_AMQ_ORANGE_to_AMQ_APPLE" uri="masterslave:(ssl://b-d63bcc4d-682b-40a2-8227-31386bcf1e3d-1.mq.us- east-2.amazonaws.com:61617,ssl://b-d63bcc4d-682b-40a2-8227-31386bcf1e3d-2.mq.us- east-2.amazonaws.com:61617)" userName="amqadmin"/> </networkConnectors> Re-platforming TIBCO EMS to Amazon MQ 38 Amazon MQ Amazon MQ Migration Guide After the reboot of AMQ_ORANGE, there should be a Network Bridge created between both brokers as illustrated below: Note Steps 1 and 2 can be replicated using a AWS CloudFormation template. For more information about using AWS CloudFormation to set up Amazon MQ brokers, see the Amazon MQ AWS CloudFormation Template Reference. 3. Retrieve the list of static TIBCO EMS server destinations from the conﬁg ﬁles, queues.conf and topics.conf or by using the following tibemsadmin commands: show queues * static show topics * static When ﬁnished, update the Amazon MQ broker AMQ_ORANGE conﬁguration ﬁle to add startup destinations as shown here: <destinations> <queue physicalName="FOO.BAR"/> <topic physicalName="SOME.TOPIC"/> </destinations> 4. Destination properties for TIBCO EMS can be found in queues.conf and topics.conf ﬁles. Per Destination level Policy can be set in Amazon MQ using the destinationPolicy section in the conﬁguration ﬁle. 5. Retrieve the list of TIBCO EMS Bridges from bridges.conf. For example, the Bridge from source topic NOTIFY.FOOBAR to target queues FOO and BAR is shown as: [topic:NOTIFY.FOOBAR] Re-platforming TIBCO EMS to Amazon MQ 39 Amazon MQ queue=FOO queue=BAR Amazon MQ Migration Guide When ﬁnished, up the Amazon MQ broker AMQ_ORANGE conﬁguration ﬁle to add Composite Destinations that match TIBCO EMS bridges. Note Simple Topic to Queue bridges are needed in TIBCO EMS to support m-hop routing. In Amazon MQ this
amazon-mq-mg-011	amazon-mq-mg.pdf	11	ﬁles. Per Destination level Policy can be set in Amazon MQ using the destinationPolicy section in the conﬁguration ﬁle. 5. Retrieve the list of TIBCO EMS Bridges from bridges.conf. For example, the Bridge from source topic NOTIFY.FOOBAR to target queues FOO and BAR is shown as: [topic:NOTIFY.FOOBAR] Re-platforming TIBCO EMS to Amazon MQ 39 Amazon MQ queue=FOO queue=BAR Amazon MQ Migration Guide When ﬁnished, up the Amazon MQ broker AMQ_ORANGE conﬁguration ﬁle to add Composite Destinations that match TIBCO EMS bridges. Note Simple Topic to Queue bridges are needed in TIBCO EMS to support m-hop routing. In Amazon MQ this is not needed and queues can be used directly with a Network of Brokers. Validating your migration to Amazon MQ In the the section called “TIBCO EMS architecture for migration” section, a Topic to Queue bridge was used to forward messages to other EMS servers. In Amazon MQ, App 1 would send messages directly to Q1 because messages on a queue are forwarded in a Network of Brokers. In the TIBCO EMS example, messages from App 2 are sent to Q2 and then forwarded to Q2@EMS_APPLE. In Amazon MQ, the queue name, Q2, would be the same on both message brokers, simplifying the conﬁguration of App 1. The following example shows the AMQ_ORANGE broker with consumers in us-east-1 and AMQ_APPLE with consumers in us-east-2 Validating your migration to Amazon MQ 40 Amazon MQ Amazon MQ Migration Guide Validating your migration to Amazon MQ 41 Amazon MQ Amazon MQ Migration Guide Migrating to Amazon MQ for RabbitMQ Amazon MQ supports migration from self managed Classic Mirrored Queues to Amazon MQ managed Classic Mirrored Queues on all supported cluster instances running RabbitMQ version 3.10.x or higher. You can export the conﬁguration from your self-managed RabbitMQ cluster and import it into Amazon MQ for RabbitMQ. Queue, exchange, user, and policy deﬁnitions are imported. You can edit the exported JSON from the existing RabbitMQ cluster to remove the deﬁnitions that are not supported. The current default queue type is Classic Mirrored Queues. We recommend Customers use the latest Amazon MQ for RabbitMQ supported version when using Classic Mirrored Queues. Important Amazon MQ for RabbitMQ has an enforced policy of ha-mode=all and ha-sync- mode=automatic which will override any custom policy. Prerequisites Complete the following prerequisites before migrating to Amazon MQ for RabbitMQ: • Review the Concepts for migrating to Amazon MQ and Options for migrating to Amazon MQ for migration to AWS managed Amazon MQ • Create a RabbitMQ broker: You will import the conﬁguration from your self-managed RabbitMQ cluster into an existing Amazon MQ for RabbitMQ broker. For instructions on how to create a Amazon MQ for RabbitMQ broker, see Creating and connecting to a RabbitMQ broker. Step 1: Exporting deﬁnitions To export the deﬁnitions from a self-managed RabbitMQ cluster and import them into Amazon MQ for RabbitMQ, do the following: 1. Go to the RabbitMQ console of your existing self-managed cluster by signing on to any of the brokers. Choose the overview tab, then select Export Definitions to produce a link to export the deﬁnition. Prerequisites 42 Amazon MQ Amazon MQ Migration Guide 2. Next, login to the Amazon MQ RabbitMQ console. Navigate to the existing broker you would like to apply the conﬁgurations to. Click on the overview tab, then click import deﬁnitions to upload the conﬁguration ﬁle that you exported in the previous step. 3. Once the conﬁguration ﬁle is imported, you can view all the queues and exchange deﬁnitions that were deﬁned in the self-managed broker. Step 2: Moving existing messages to your new Amazon MQ managed broker Amazon MQ for RabbitMQ currently supports the Federation and Shovel plugins for moving messages from a self-managed RabbitMQ broker to an Amazon MQ for RabbitMQ broker. Shovel The Shovel plugin is used to move messages from an on-premises RabbitMQ broker without internet access to a private Amazon MQ managed broker. The Shovel plug in is conﬁgured on the on-premises broker to push messages to the Amazon MQ managed broker. Using the Shovel plug in requires a VPN connection between the Amazon Managed VPC and the on-premises network. For more information on using the Shovel plug in, see How do I set up the RabbitMQ Shovel plugin on my Amazon MQ broker? Federation The Federation plugin facilitates moving messages from a public upstream broker to a downstream broker. The plugin is conﬁgured on the downstream broker, which in this case is Step 2: Moving existing messages to your new Amazon MQ managed broker 43 Amazon MQ Amazon MQ Migration Guide the new Amazon MQ for RabbitMQ broker created in the previous section. For more information on using the RabbitMQ federation plug in, see the RabbitMQ Federation Plugin documentation. Additional resources Versions When you create a new Amazon MQ for RabbitMQ broker, you can
amazon-mq-mg-012	amazon-mq-mg.pdf	12	the RabbitMQ Shovel plugin on my Amazon MQ broker? Federation The Federation plugin facilitates moving messages from a public upstream broker to a downstream broker. The plugin is conﬁgured on the downstream broker, which in this case is Step 2: Moving existing messages to your new Amazon MQ managed broker 43 Amazon MQ Amazon MQ Migration Guide the new Amazon MQ for RabbitMQ broker created in the previous section. For more information on using the RabbitMQ federation plug in, see the RabbitMQ Federation Plugin documentation. Additional resources Versions When you create a new Amazon MQ for RabbitMQ broker, you can specify any supported RabbitMQ engine version. The diﬀerent engine versions support certain features. For optimal performance, we suggest using the latest engine version. Sizing The broker instance type determines system throughput. Before migrating, review the sizing documentation to determine the best broker instance type for your application. Limits Amazon MQ for RabbitMQ brokers, conﬁgurations, users, data storage, and API throttling have default limits. To request an increase for a limit, see AWS Service Quotas in the Amazon Web Services General Reference. Best practices Learn more about ensuring eﬀective performance in all areas of your RabbitMQ application by reviewing the RabbitMQ best practices documentation. Additional resources 44 Amazon MQ Amazon MQ Migration Guide Amazon MQ for ActiveMQ Throughput benchmarks Benchmarking can help you choose the correct instance type and size for your workload messaging requirements. Scenarios for benchmarking include: • Cluster Stability: understanding how stable your cluster is during increasing, ﬂuctuating, and stable load types. • Deﬁning performance limits: approximating the maximum performance and throughput capabilities (i.e. cluster limits) of your cluster to help better scale your broker nodes when the number of messages published to your broker increases. • Optimal architecture and parameters: determining the most suitable architecture/parameters for your clusters, such as the number of destinations, persistent mode, message size, etc. Amazon MQ provides benchmarking ﬁgures for the diﬀerent instance types and sizes available for Amazon MQ for ActiveMQ. Amazon MQ uses the ActiveMQ Maven 2 Performance Test to calculate benchmarks. Amazon MQ tests with an active/stanby deployment broker with an EFS volume as a storage type. The results are from a performance test conducted on a ECS cluster with a Fargate deployment which consists of a conﬁguration of 4vCPUs and 16 GiBs of memory (equivalent to an EC2 m5.xlarge instance). Concurrent Store And Dispatch Queues (CSAD) are set to true for all tests performed. The duration for each test conducted is 5 minutes. Note When run in your own environment, results may diﬀer by 3-6%. The following tables provide performance and throughput benchmarks for Amazon MQ supported instance types to help you choose the correct instance sizes for your messaging workload. Topics • mq.m4.large • mq.m5.large • mq.m5.xlarge 45 Amazon MQ Migration Guide Amazon MQ • mq.m5.2xlarge • mq.m5.4xlarge mq.m4.large Conﬁguration options: • Broker Instance - mq.m4.large • Persistent - TRUE • Client - m5.xlarge • CSAD - TRUE • Protocol - Openwire Producers/Consumers Message size Metrics 1KB 5KB 10KB TPS CPU% TPS CPU% TPS CPU% 25 1849 29% 1672 33% 1586 44% 50 3335 37% 2561 47% 1670 87% 100 4665 47% 2970 76% 2268 89% mq.m5.large Conﬁguration options: • Broker Instance - mq.m5.large • Persistent - TRUE • Client - m5.xlarge mq.m4.large 46 Amazon MQ • CSAD - TRUE • Protocol - Openwire Message size Metrics 1KB 5KB 10KB TPS CPU% TPS CPU% TPS CPU% mq.m5.xlarge Conﬁguration options: • Broker Instance - mq.m5.xlarge • Persistent - TRUE • Client - m5.xlarge • CSAD - TRUE • Protocol - Openwire Message size Metrics 1KB mq.m5.xlarge TPS CPU% Amazon MQ Migration Guide Producers/Consumers 25 2247 26% 1636 37% 1668 40% 50 4041 32% 3205 63% 3104 53% 100 7566 48% 4443 58% 3227 86% Producers/Consumers 25 2255 28% 50 3932 32% 100 7453 54% 47 Amazon MQ Amazon MQ Migration Guide Producers/Consumers Message size Metrics 5KB 10KB TPS CPU% TPS CPU% 25 1766 29% 1641 36% 50 3495 51% 3240 61% mq.m5.2xlarge Conﬁguration options: • Broker Instance - mq.m5.2xlarge • Persistent - TRUE • Client - m5.xlarge • CSAD - TRUE • Protocol - Openwire Producers/Consumers Message size Metrics 1KB 5KB 10KB TPS CPU% TPS CPU% TPS CPU% 25 2025 12% 1865 15% 1747 18% 50 4089 18% 3736 27% 3511 36% 100 6215 82% 5613 89% 100 8093 35% 6845 54% 7057 67% mq.m5.2xlarge 48 Amazon MQ Migration Guide Amazon MQ mq.m5.4xlarge Conﬁguration options: • Broker Instance - mq.m5.4xlarge • Persistent - TRUE • Client - m5.xlarge • CSAD - TRUE • Protocol - Openwire Producers/Consumers Message size Metrics 1KB 5KB 10KB TPS CPU% TPS CPU% TPS CPU% 25 2094 6% 1742 7% 1733 9% 50 4055 9% 3586 13% 3288 16% 100 8153 17% 7158 25% 6671 31% mq.m5.4xlarge 49 Amazon MQ Amazon MQ Migration Guide
amazon-mq-mg-013	amazon-mq-mg.pdf	13	25 2025 12% 1865 15% 1747 18% 50 4089 18% 3736 27% 3511 36% 100 6215 82% 5613 89% 100 8093 35% 6845 54% 7057 67% mq.m5.2xlarge 48 Amazon MQ Migration Guide Amazon MQ mq.m5.4xlarge Conﬁguration options: • Broker Instance - mq.m5.4xlarge • Persistent - TRUE • Client - m5.xlarge • CSAD - TRUE • Protocol - Openwire Producers/Consumers Message size Metrics 1KB 5KB 10KB TPS CPU% TPS CPU% TPS CPU% 25 2094 6% 1742 7% 1733 9% 50 4055 9% 3586 13% 3288 16% 100 8153 17% 7158 25% 6671 31% mq.m5.4xlarge 49 Amazon MQ Amazon MQ Migration Guide Supported plugins for Amazon MQ A plugin in Amazon MQ is a software module that adds a speciﬁc feature to a broker. Amazon MQ managed brokers support the following plugins: • authorizationPlugin: Allows you to control access at the granularity level of destinations or of individual messages. • discardingDLQBrokerPlugin: Provides ﬁne-grained options to discard your dead-letter queue. • redeliveryPlugin: Enables you to replace the regular DLQ handling with re-delivery to the original destination following a delay period. • forcePersistencyModeBrokerPlugin: Allows you to force every incoming message to be persistent or non-persistent. This is useful if you've set up a broker usage policy to process only persistent or non-persistent messages. • statisticsBrokerPlugin: Enables you to retrieve statistics from the broker or its destinations. • timeStampingBrokerPlugin: Allows you to update a JMS Client's timestamp on a message with a broker timestamp. You can trust the timestamp set on your Amazon MQ brokers when client-side machine clocks are known to be incorrect. 50 Amazon MQ Amazon MQ Migration Guide Amazon MQ Migration Guide document history The following table lists changes to the Amazon MQ Amazon MQ Migration Guide. For Amazon MQ feature releases and improvements, see Amazon MQ Release Notes. Date Documentation Update May 14, 2023 Amazon MQ updated the Amazon MQ for ActiveMQ throughput benchmark s. Throughput benchmarks have been updated for messages sizes 1KB, 5KB, and 10KB with 25, 50, and 100 producers/consumers. Untested values were removed from the documentation. For more information on the testing procedure and the updated benchmarking ﬁgures, see Amazon MQ for ActiveMQ Throughput benchmarks. May 14, 2023 Amazon MQ is now oﬀering the Amazon MQ for RabbitMQ Migration Guide for migrating from self-managed RabbitMQ to Amazon MQ for RabbitMQ Classic Mirrored Queues. October 5, 2020 Amazon MQ is now oﬀering a comprehensive guide for migrating on-premis es commercial message-brokers, such as IBM MQ and TIBCO EMS, to the cloud. 51

Subsets and Splits

No community queries yet

The top public SQL queries from the community will appear here once available.