feat!: updating the AmazonMQ broker engine versions (#47)

This PR includes:
- upgrading a list of available ActiveMQ Engine Versions according to [the AWS documentation](https://docs.aws.amazon.com/amazon-mq/latest/developer-guide/activemq-version-management.html#activemq-version-management-calendar). This includes removing an already deprecated version from the available engines.
- upgrading a list of available RabbitMQ Engine Versions according to [the AWS documentation](https://docs.aws.amazon.com/amazon-mq/latest/developer-guide/rabbitmq-version-management.html#rabbitmq-version-management-calendar). This includes removing an already deprecated version from the available engines.
- making `autoMinorVersionUpgrade` optional as the newest versions of ActiveMQ and RabbitMQ do not take this parameter into considerations

README.md

@@ -80,15 +80,14 @@ declare const brokerUser: ISecret;
 
 const broker = new ActiveMqBrokerInstance(stack, 'ActiveMqBroker', {
   publiclyAccessible: false,
-  version: ActiveMqBrokerEngineVersion.V5_17_6,
+  version: ActiveMqBrokerEngineVersion.V5_18,
   instanceType: InstanceType.of(InstanceClass.T3, InstanceSize.MICRO),
   userManagement: ActiveMqBrokerUserManagement.simple({
     users: [{
       username: brokerUser.secretValueFromJson('username').unsafeUnwrap(),
       password: brokerUser.secretValueFromJson('password'),
     }],
   }),
-  autoMinorVersionUpgrade: true,
 });
 ```
 
@@ -116,15 +115,14 @@ declare const vpcSubnets: SubnetSelection;
 
 const brokerPair = new ActiveMqBrokerRedundantPair(stack, 'ActiveMqBrokerPair', {
   publiclyAccessible: false,
-  version: ActiveMqBrokerEngineVersion.V5_17_6,
+  version: ActiveMqBrokerEngineVersion.V5_18,
   instanceType: InstanceType.of(InstanceClass.M5, InstanceSize.LARGE),
   userManagement: ActiveMqBrokerUserManagement.simple({
     users: [{
       username: brokerUser.secretValueFromJson('username').unsafeUnwrap(),
       password: brokerUser.secretValueFromJson('password'),
     }],
   }),
-  autoMinorVersionUpgrade: true,
   vpc,
   vpcSubnets,
 });
@@ -230,7 +228,6 @@ const broker = new ActiveMqBrokerInstance(stack, 'Broker', {
       password: brokerUser.secretValueFromJson('password'),
     }],
   }),
-  autoMinorVersionUpgrade: true,
   configuration: customConfiguration
 });
 ```
@@ -295,7 +292,7 @@ declare const serviceAccountSecret: ISecret;
 
 const broker = new ActiveMqBrokerInstance(stack, 'ActiveMqBrokerInstance', {
   publiclyAccessible: false,
-  version: ActiveMqBrokerEngineVersion.V5_17_6,
+  version: ActiveMqBrokerEngineVersion.V5_18,
   instanceType: InstanceType.of(InstanceClass.T3, InstanceSize.MICRO),
   userManagement: ActiveMqBrokerUserManagement.ldap({
     hosts: ['ldap.example.com'],
@@ -308,7 +305,6 @@ const broker = new ActiveMqBrokerInstance(stack, 'ActiveMqBrokerInstance', {
     serviceAccountPassword: serviceAccountSecret.secretValueFromJson('password'),
     serviceAccountUsername: serviceAccountSecret.secretValueFromJson('username'),
   }),
-  autoMinorVersionUpgrade: true,
 });
 ```
 
@@ -393,13 +389,12 @@ declare const adminSecret: ISecret;
 
 const broker = new RabbitMqBrokerInstance(stack, 'RabbitMqBroker', {
   publiclyAccessible: false,
-  version: RabbitMqBrokerEngineVersion.V3_11_20,
+  version: RabbitMqBrokerEngineVersion.V3_13,
   instanceType: InstanceType.of(InstanceClass.T3, InstanceSize.MICRO),
   admin: {
     username: adminSecret.secretValueFromJson('username').unsafeUnwrap(),
     password: adminSecret.secretValueFromJson('password'),
    },
-  autoMinorVersionUpgrade: true,
 });
 ```
 
@@ -418,13 +413,12 @@ declare const adminSecret: ISecret;
 
 const broker = new RabbitMqBrokerCluster(stack, 'RabbitMqBroker', {
   publiclyAccessible: false,
-  version: RabbitMqBrokerEngineVersion.V3_11_20,
+  version: RabbitMqBrokerEngineVersion.V3_13,
   instanceType: InstanceType.of(InstanceClass.M5, InstanceSize.LARGE),
   admin: {
     username: adminSecret.secretValueFromJson('username').unsafeUnwrap(),
     password: adminSecret.secretValueFromJson('password'),
    },
-  autoMinorVersionUpgrade: true,
 });
 ```
 
@@ -485,21 +479,20 @@ declare const adminSecret: ISecret;
 const customConfiguration = new RabbitMqBrokerConfiguration(stack, 'CustomConfiguration', {
   configurationName: 'ConfigurationName',
   description: 'ConfigurationDescription',
-  engineVersion: RabbitMqBrokerEngineVersion.V3_11_20,
+  engineVersion: RabbitMqBrokerEngineVersion.V3_13,
   definition: RabbitMqBrokerConfigurationDefinition.parameters({
     consumerTimeout: Duration.minutes(20),
   }),
 });
 
 const broker = new RabbitMqBrokerInstance(stack, 'Broker', {
   publiclyAccessible: false,
-  version: RabbitMqBrokerEngineVersion.V3_11_20,
+  version: RabbitMqBrokerEngineVersion.V3_13,
   instanceType: InstanceType.of(InstanceClass.T3, InstanceSize.MICRO),
   admin: {
     username: adminSecret.secretValueFromJson('username').unsafeUnwrap(),
     password: adminSecret.secretValueFromJson('password'),
    },
-  autoMinorVersionUpgrade: true,
   configuration: customConfiguration
 });
 ```

src/activemq/activemq-broker-engine-version.ts

@@ -4,18 +4,19 @@ SPDX-License-Identifier: Apache-2.0
 */
 
 /**
+ * The Amazon ActiveMQ Broker Engine version.
  *
- * @see: https://docs.aws.amazon.com/amazon-mq/latest/developer-guide/activemq-version-management.html
+ * @see https://docs.aws.amazon.com/amazon-mq/latest/developer-guide/activemq-version-management.html
  */
 export class ActiveMqBrokerEngineVersion {
   public static readonly V5_18 = new ActiveMqBrokerEngineVersion('5.18');
 
+  /** it is recommended to use V5_18 instead */
   public static readonly V5_17_6 = new ActiveMqBrokerEngineVersion('5.17.6');
 
+  /** @deprecated use V5_18 instead */
   public static readonly V5_16_7 = new ActiveMqBrokerEngineVersion('5.16.7');
 
-  public static readonly V5_15_16 = new ActiveMqBrokerEngineVersion('5.15.16');
-
   public static of(version: string): ActiveMqBrokerEngineVersion {
     return new ActiveMqBrokerEngineVersion(version);
   }

src/broker-deployment.ts

@@ -86,11 +86,13 @@ export interface BrokerDeploymentProps {
   readonly instanceType: InstanceType;
 
   /**
-   * Determines whether the broker will undergo a minor version upgrade during the maintenance window.
+   * Determines whether the broker will undergo a patch version upgrade during the maintenance window.
    *
-   * @default - false. No minor version upgrade happens.
+   * NOTE: Contrary to the name this  setting does not upgrade the minor versions, but patch versions (i.e. in the X.Y.Z notation - only the Z numbers are upgraded)
+   *
+   * @default - for versions with the patch version number the default is not to upgrade the patch versions; for versions withouth the patch version number patch versions are updated and this setting takes no effect.
    */
-  readonly autoMinorVersionUpgrade: boolean;
+  readonly autoMinorVersionUpgrade?: boolean;
   readonly maintenanceWindowStartTime?: MaintenanceWindowStartTime;
 
   /**

src/rabbitmq/rabbitmq-broker-engine-version.ts

@@ -3,21 +3,24 @@ Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 SPDX-License-Identifier: Apache-2.0
 */
 /**
+ * The Amazon RabbitMQ Broker Engine version.
  *
- * @see: https://docs.aws.amazon.com/amazon-mq/latest/developer-guide/rabbitmq-version-management.html
+ * @see https://docs.aws.amazon.com/amazon-mq/latest/developer-guide/rabbitmq-version-management.html
  */
 export class RabbitMqBrokerEngineVersion {
   public static readonly V3_13 = new RabbitMqBrokerEngineVersion('3.13');
 
+  /** @deprecated use V3_13 instead */
   public static readonly V3_12_13 = new RabbitMqBrokerEngineVersion('3.12.13');
 
-  public static readonly V3_11_20 = new RabbitMqBrokerEngineVersion('3.11.20');
-
-  public static readonly V3_10_20 = new RabbitMqBrokerEngineVersion('3.10.20');
+  /** @deprecated use V3_13 instead */
+  public static readonly V3_11_28 = new RabbitMqBrokerEngineVersion('3.11.28');
 
-  public static readonly V3_9_27 = new RabbitMqBrokerEngineVersion('3.9.27');
+  /** @deprecated use V3_13 instead */
+  public static readonly V3_11_20 = new RabbitMqBrokerEngineVersion('3.11.20');
 
-  public static readonly V3_8_34 = new RabbitMqBrokerEngineVersion('3.8.34');
+  /** @deprecated use V3_13 instead */
+  public static readonly V3_11_16 = new RabbitMqBrokerEngineVersion('3.11.16');
 
   public static of(version: string): RabbitMqBrokerEngineVersion {
     return new RabbitMqBrokerEngineVersion(version);

test/activemq/activemq-broker-configuration.test.ts

@@ -14,7 +14,7 @@ describe('ActiveMqBrokerConfiguration', () => {
     new ActiveMqBrokerConfiguration(stack, 'TestConfig', {
       description: 'Test Description',
       definition: ActiveMqBrokerConfigurationDefinition.data('Test Definition'),
-      engineVersion: ActiveMqBrokerEngineVersion.V5_15_16,
+      engineVersion: ActiveMqBrokerEngineVersion.V5_18,
     });
 
     const template = Template.fromStack(stack);
@@ -23,7 +23,7 @@ describe('ActiveMqBrokerConfiguration', () => {
       Data: { 'Fn::Base64': 'Test Definition' },
       Description: 'Test Description',
       EngineType: 'ACTIVEMQ',
-      EngineVersion: '5.15.16',
+      EngineVersion: '5.18',
       Name: 'TestConfig',
     });
   });
@@ -34,12 +34,12 @@ describe('ActiveMqBrokerConfiguration', () => {
     const config = new ActiveMqBrokerConfiguration(stack, 'TestConfig', {
       description: 'Test Description',
       definition: ActiveMqBrokerConfigurationDefinition.data('Test Definition'),
-      engineVersion: ActiveMqBrokerEngineVersion.V5_15_16,
+      engineVersion: ActiveMqBrokerEngineVersion.V5_18,
     });
 
     const broker = new ActiveMqBrokerInstance(stack, 'TestBroker', {
       publiclyAccessible: true,
-      version: ActiveMqBrokerEngineVersion.V5_15_16,
+      version: ActiveMqBrokerEngineVersion.V5_18,
       instanceType: InstanceType.of(InstanceClass.M5, InstanceSize.LARGE),
       userManagement: ActiveMqBrokerUserManagement.simple({
         users: [{
@@ -63,7 +63,7 @@ describe('ActiveMqBrokerConfiguration', () => {
       Data: { 'Fn::Base64': 'Test Definition' },
       Description: 'Test Description',
       EngineType: 'ACTIVEMQ',
-      EngineVersion: '5.15.16',
+      EngineVersion: '5.18',
       Name: 'TestConfig',
     });
 
@@ -118,12 +118,12 @@ describe('ActiveMqBrokerConfiguration', () => {
     const config = new ActiveMqBrokerConfiguration(stack, 'TestConfig', {
       description: 'Test Description',
       definition: ActiveMqBrokerConfigurationDefinition.data('Test Definition'),
-      engineVersion: ActiveMqBrokerEngineVersion.V5_15_16,
+      engineVersion: ActiveMqBrokerEngineVersion.V5_18,
     });
 
     const broker = new ActiveMqBrokerInstance(stack, 'TestBroker', {
       publiclyAccessible: true,
-      version: ActiveMqBrokerEngineVersion.V5_15_16,
+      version: ActiveMqBrokerEngineVersion.V5_18,
       instanceType: InstanceType.of(InstanceClass.M5, InstanceSize.LARGE),
       userManagement: ActiveMqBrokerUserManagement.simple({
         users: [{
@@ -142,7 +142,7 @@ describe('ActiveMqBrokerConfiguration', () => {
       Data: { 'Fn::Base64': 'Test Definition' },
       Description: 'Test Description',
       EngineType: 'ACTIVEMQ',
-      EngineVersion: '5.15.16',
+      EngineVersion: '5.18',
       Name: 'TestConfig',
     });
 

test/activemq/activemq-broker-deployment.test.ts

@@ -17,7 +17,7 @@ describe('ActiveMqBrokerDeployment', () => {
 
     const broker: IActiveMqBrokerDeployment = new ActiveMqBrokerInstance(stack, 'TestBroker', {
       publiclyAccessible: false,
-      version: ActiveMqBrokerEngineVersion.V5_15_16,
+      version: ActiveMqBrokerEngineVersion.V5_18,
       instanceType: InstanceType.of(InstanceClass.M5, InstanceSize.LARGE),
       userManagement: ActiveMqBrokerUserManagement.simple({
         users: [{

test/activemq/activemq-broker-endpoints.test.ts

@@ -14,7 +14,7 @@ import {
 const createBroker = (stack: Stack) => {
   return new ActiveMqBrokerInstance(stack, 'TestBroker', {
     publiclyAccessible: true,
-    version: ActiveMqBrokerEngineVersion.V5_15_16,
+    version: ActiveMqBrokerEngineVersion.V5_18,
     instanceType: InstanceType.of(InstanceClass.M5, InstanceSize.LARGE),
     userManagement: ActiveMqBrokerUserManagement.simple({
       users: [

test/activemq/activemq-broker-engine-version.test.ts

@@ -10,7 +10,6 @@ describe('ActiveMqBrokerEngineVersion', () => {
       { version: '5.18' },
       { version: '5.17.6' },
       { version: '5.16.7' },
-      { version: '5.15.16' },
     ];
     const actualEngineVersions = Object.values(ActiveMqBrokerEngineVersion);
 

test/activemq/activemq-broker-instance.test.ts

@@ -16,7 +16,7 @@ describe('ActiveMqBrokerInstance', () => {
 
     const broker = new ActiveMqBrokerInstance(stack, 'TestBroker', {
       publiclyAccessible: true,
-      version: ActiveMqBrokerEngineVersion.V5_15_16,
+      version: ActiveMqBrokerEngineVersion.V5_18,
       instanceType: InstanceType.of(InstanceClass.M5, InstanceSize.LARGE),
       userManagement: ActiveMqBrokerUserManagement.simple({
         users: [{
@@ -41,7 +41,7 @@ describe('ActiveMqBrokerInstance', () => {
       DeploymentMode: 'SINGLE_INSTANCE',
       EncryptionOptions: { UseAwsOwnedKey: true },
       EngineType: 'ACTIVEMQ',
-      EngineVersion: '5.15.16',
+      EngineVersion: '5.18',
       HostInstanceType: 'mq.m5.large',
       PubliclyAccessible: true,
       Users: [{
@@ -59,7 +59,7 @@ describe('ActiveMqBrokerInstance', () => {
     const broker = new ActiveMqBrokerInstance(stack, 'TestBroker', {
       publiclyAccessible: true,
       key,
-      version: ActiveMqBrokerEngineVersion.V5_15_16,
+      version: ActiveMqBrokerEngineVersion.V5_18,
       instanceType: InstanceType.of(InstanceClass.M5, InstanceSize.LARGE),
       userManagement: ActiveMqBrokerUserManagement.simple({
         users: [{
@@ -93,7 +93,7 @@ describe('ActiveMqBrokerInstance', () => {
         UseAwsOwnedKey: false,
       },
       EngineType: 'ACTIVEMQ',
-      EngineVersion: '5.15.16',
+      EngineVersion: '5.18',
       HostInstanceType: 'mq.m5.large',
       PubliclyAccessible: true,
       Users: [{
@@ -108,7 +108,7 @@ describe('ActiveMqBrokerInstance', () => {
 
     const broker = new ActiveMqBrokerInstance(stack, 'TestBroker', {
       publiclyAccessible: false,
-      version: ActiveMqBrokerEngineVersion.V5_15_16,
+      version: ActiveMqBrokerEngineVersion.V5_18,
       instanceType: InstanceType.of(InstanceClass.M5, InstanceSize.LARGE),
       userManagement: ActiveMqBrokerUserManagement.simple({
         users: [{
@@ -133,7 +133,7 @@ describe('ActiveMqBrokerInstance', () => {
       DeploymentMode: 'SINGLE_INSTANCE',
       EncryptionOptions: { UseAwsOwnedKey: true },
       EngineType: 'ACTIVEMQ',
-      EngineVersion: '5.15.16',
+      EngineVersion: '5.18',
       HostInstanceType: 'mq.m5.large',
       PubliclyAccessible: false,
       Users: [{
@@ -152,7 +152,7 @@ describe('ActiveMqBrokerInstance', () => {
 
     const broker = new ActiveMqBrokerInstance(stack, 'TestBroker', {
       publiclyAccessible: false,
-      version: ActiveMqBrokerEngineVersion.V5_15_16,
+      version: ActiveMqBrokerEngineVersion.V5_18,
       instanceType: InstanceType.of(InstanceClass.M5, InstanceSize.LARGE),
       userManagement: ActiveMqBrokerUserManagement.simple({
         users: [{
@@ -203,7 +203,7 @@ describe('ActiveMqBrokerInstance', () => {
       DeploymentMode: 'SINGLE_INSTANCE',
       EncryptionOptions: { UseAwsOwnedKey: true },
       EngineType: 'ACTIVEMQ',
-      EngineVersion: '5.15.16',
+      EngineVersion: '5.18',
       HostInstanceType: 'mq.m5.large',
       PubliclyAccessible: false,
       Users: [{