AWS amazon-mq documentation change
Summary
Removed section on automatic minor version upgrades, simplified manual upgrade steps, updated version examples to RabbitMQ, and clarified that patch upgrades are now automatic for all brokers during maintenance windows.
Security assessment
The change documents that patch upgrades are now automatically applied to all brokers during maintenance windows, improving security posture by ensuring critical updates are applied without user intervention. However, there's no evidence of a specific vulnerability being addressed. The removal of the 'automatic minor version upgrade' configuration suggests this is now mandatory behavior.
Diff
diff --git a/amazon-mq/latest/developer-guide/upgrading-brokers.md b/amazon-mq/latest/developer-guide/upgrading-brokers.md index 1e0eb4bcd..7c5957acc 100644 --- a//amazon-mq/latest/developer-guide/upgrading-brokers.md +++ b//amazon-mq/latest/developer-guide/upgrading-brokers.md @@ -5 +5 @@ -Manually upgrading the engine versionAutomatically upgrading the minor engine version +Manually upgrading the engine version @@ -11 +11 @@ Amazon MQ regularly provides new broker engine versions for all supported broker -Amazon MQ organizes version numbers according to semantic versioning specification as `X.Y.Z`. In Amazon MQ implementations, `X` denotes the major version, `Y` represents the minor version, and `Z` denotes the patch version number. There are two types of upgrades: +Amazon MQ organizes version numbers according to semantic versioning specification as `X.Y.Z`. In Amazon MQ implementations, `X` denotes the major version, `Y` represents the minor version, and `Z` denotes the patch version number. Amazon MQ supports two types of upgrades: @@ -13 +13 @@ Amazon MQ organizes version numbers according to semantic versioning specificati - * Major version upgrade – Occurs when the major engine version numbers change. For example, upgrading from version **1**.0 to version **2**.0 is considered a major version upgrade. + * Major version upgrade – Occurs when the major engine version numbers change. For example, upgrading from RabbitMQ version **3**.13 to version **4**.2 is considered a major version upgrade. @@ -15 +15 @@ Amazon MQ organizes version numbers according to semantic versioning specificati - * Minor version upgrade – Occurs when only the minor engine version number changes. For example, upgrading from version 1.**5** to version 1.**6** is considered a minor version upgrade. + * Minor version upgrade – Occurs when only the minor engine version number changes. For example, upgrading from version 3.**11** to version 3.**12** is considered a minor version upgrade. @@ -20,12 +20 @@ Amazon MQ organizes version numbers according to semantic versioning specificati -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](https://docs.aws.amazon.com/amazon-mq/latest/api-reference/brokers-broker-id.html#brokers-broker-id-prop-updatebrokerinput-autominorversionupgrade), Amazon MQ will upgrade your broker to the latest supported patch 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](./maintaining-brokers.html). Amazon MQ upgrades your broker to the next minor version when the current minor version reaches end of support. Both manual and automatic version upgrades occur during the scheduled maintenance window or after you [reboot your broker](./amazon-mq-rebooting-broker.html). - -The following topics describe how you can manually upgrade the broker engine version, and activate automatic minor version upgrades. - -###### Topics - - * Manually upgrading the engine version - - * Automatically upgrading the minor engine version - - - +You can manually upgrade your broker at any time to the next supported major or minor version. Amazon MQ manages upgrade to the latest supported patch version for all brokers during the scheduled [maintenance window](./maintaining-brokers.html). Both manual and automatic version upgrades occur during the scheduled maintenance window, or after you [reboot your broker](./amazon-mq-rebooting-broker.html). Amazon MQ upgrades your broker to the next minor version when the current minor version reaches end of support. @@ -35 +24 @@ The following topics describe how you can manually upgrade the broker engine ver -To manually upgrade the engine version of a broker to a new major or minor version, you can use the AWS Management Console, the AWS CLI, or the Amazon MQ API. +You can upgrade the engine version of a broker by using the AWS Management Console, the AWS CLI, or the Amazon MQ API. @@ -39,5 +28 @@ To manually upgrade the engine version of a broker to a new major or minor versi - 1. Sign in to the [Amazon MQ console](https://console.aws.amazon.com/amazon-mq/). - - 2. In the left navigation pane, choose **Brokers** , and then choose the broker that you want to upgrade from the list. - - 3. On the broker details page, choose **Edit**. + 1. On the broker details page, choose **Edit**. @@ -45 +30 @@ To manually upgrade the engine version of a broker to a new major or minor versi - 4. Under **Specifications** , for **Broker engine version** choose the new version number from the dropdown list. + 2. Under **Specifications** , for **Broker engine version** choose the new version number from the dropdown list. @@ -47 +32 @@ To manually upgrade the engine version of a broker to a new major or minor versi - 5. Scroll to the bottom of the page, and choose **Schedule modifications**. + 3. Scroll to the bottom of the page, and choose **Schedule modifications**. @@ -49 +34 @@ To manually upgrade the engine version of a broker to a new major or minor versi - 6. On the **Schedule broker modifications** page, for **When to apply modifications** , choose one of the following. + 4. On the **Schedule broker modifications** page, for **When to apply modifications** , choose one of the following. @@ -59 +44 @@ Single instance brokers are offline while being rebooted. For cluster brokers, o - 7. Choose **Apply** to finish applying the changes. + 5. Choose **Apply** to finish applying the changes. @@ -74 +59 @@ Single instance brokers are offline while being rebooted. For cluster brokers, o - 2. (Optional) Use the [reboot-broker](https://docs.aws.amazon.com/cli/latest/reference/mq/reboot-broker.html) CLI command to reboot your broker if, you want to upgrade the engine version immediately. + 2. (Optional) Use the [reboot-broker](https://docs.aws.amazon.com/cli/latest/reference/mq/reboot-broker.html) CLI command to reboot your broker if you want to upgrade the engine version immediately. @@ -103 +88 @@ Use `engineVersion` in the request payload to specify the version number for the - 2. (Optional) Use the [RebootBroker](https://docs.aws.amazon.com/amazon-mq/latest/api-reference/brokers-broker-id-reboot.html#RebootBroker) API operation to reboot your broker, if you want to upgrade the engine version immediately. `broker-id` is specified as a path parameter. + 2. (Optional) Use the [RebootBroker](https://docs.aws.amazon.com/amazon-mq/latest/api-reference/brokers-broker-id-reboot.html#RebootBroker) API operation to reboot your broker if you want to upgrade the engine version immediately. `broker-id` is specified as a path parameter. @@ -120,57 +104,0 @@ Single instance brokers are offline while being rebooted. For cluster brokers, o -## Automatically upgrading the minor engine version - -You can control whether automatic minor version upgrade is activated for a broker when you first create the broker, or by modifying broker preferences. To activate auto minor version upgrades for an existing broker, you can use the AWS Management Console, the AWS CLI, or the Amazon MQ API. - -###### To activate automatic minor version upgrades by using the AWS Management Console - - 1. Sign in to the [Amazon MQ console](https://console.aws.amazon.com/amazon-mq/). - - 2. In the left navigation pane, choose **Brokers** , and then choose the broker that you want to upgrade from the list. - - 3. On the broker details page, choose **Edit**. - - 4. Under **Maintenance** , choose **Enable automatic minor version upgrades**. - -###### Note - -If the option is already selected, you do not need to make any changes. - - 5. Choose **Save** at the bottom of the page. - - - - -To activate automatic minor version upgrades via the AWS CLI, use the [update-broker](https://docs.aws.amazon.com/cli/latest/reference/mq/update-broker.html) CLI command and specify the following parameters. - - * `--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-east-2:123456789012:broker:MyBroker:b-1234a5b6-78cd-901e-2fgh-3i45j6k178l9`, the broker ID would be `b-1234a5b6-78cd-901e-2fgh-3i45j6k178l9`. - - * `--auto-minor-version-upgrade` – Activates the auto minor version upgrade option. - - - - - - aws mq update-broker --broker-id broker-id --auto-minor-version-upgrade - -###### Note - -If you want to deactivate auto minor version upgrades for your ActiveMQ broker, use the `--no-auto-minor-version-upgrade` parameter. - -To activate automatic minor version upgrades via the Amazon MQ API, use the [UpdateBroker](https://docs.aws.amazon.com/amazon-mq/latest/api-reference/brokers-broker-id.html#UpdateBroker) API operation. Specify `broker-id` as a path parameter. The following example assumes a broker in the `us-west-2` region. For more information about available Amazon MQ endpoints, see [Amazon MQ endpoints and quotas.](https://docs.aws.amazon.com/general/latest/gr/amazon-mq.html#amazon-mq_region) in the _AWS General Reference_ - - - PUT /v1/brokers/broker-id HTTP/1.1 - Host: mq.us-west-2.amazonaws.com - Date: Mon, 7 June 2021 12:00:00 GMT - x-amz-date: Mon, 7 June 2021 12:00:00 GMT - Authorization: authorization-string - -Use the `autoMinorVersionUpgrade` property in the request payload to activate auto minor version upgrade. - - - { - "autoMinorVersionUpgrade": "true" - } - -If you want to deactivate auto minor version upgrades for your broker, set `"autoMinorVersionUpgrade": "false"` in the request payload. -