feat(client-mq): This release makes the EngineVersion field optional …

…for both broker and configuration and uses the latest available version by default. The AutoMinorVersionUpgrade field is also now optional for broker creation and defaults to 'true'.
aws · Jun 27, 2024 · 8c6b66a · 8c6b66a
1 parent 85a220c
commit 8c6b66a
Show file tree

Hide file tree

Showing 4 changed files with 34 additions and 39 deletions.
diff --git a/clients/client-mq/src/commands/CreateBrokerCommand.ts b/clients/client-mq/src/commands/CreateBrokerCommand.ts
@@ -37,7 +37,7 @@ export interface CreateBrokerCommandOutput extends CreateBrokerResponse, __Metad
  * const client = new MqClient(config);
  * const input = { // CreateBrokerRequest
  *   AuthenticationStrategy: "SIMPLE" || "LDAP",
- *   AutoMinorVersionUpgrade: true || false, // required
+ *   AutoMinorVersionUpgrade: true || false,
  *   BrokerName: "STRING_VALUE", // required
  *   Configuration: { // ConfigurationId
  *     Id: "STRING_VALUE", // required
@@ -50,7 +50,7 @@ export interface CreateBrokerCommandOutput extends CreateBrokerResponse, __Metad
  *     UseAwsOwnedKey: true || false, // required
  *   },
  *   EngineType: "ACTIVEMQ" || "RABBITMQ", // required
- *   EngineVersion: "STRING_VALUE", // required
+ *   EngineVersion: "STRING_VALUE",
  *   HostInstanceType: "STRING_VALUE", // required
  *   LdapServerMetadata: { // LdapServerMetadataInput
  *     Hosts: [ // __listOf__string // required

diff --git a/clients/client-mq/src/commands/CreateConfigurationCommand.ts b/clients/client-mq/src/commands/CreateConfigurationCommand.ts
@@ -38,7 +38,7 @@ export interface CreateConfigurationCommandOutput extends CreateConfigurationRes
  * const input = { // CreateConfigurationRequest
  *   AuthenticationStrategy: "SIMPLE" || "LDAP",
  *   EngineType: "ACTIVEMQ" || "RABBITMQ", // required
- *   EngineVersion: "STRING_VALUE", // required
+ *   EngineVersion: "STRING_VALUE",
  *   Name: "STRING_VALUE", // required
  *   Tags: { // __mapOf__string
  *     "<keys>": "STRING_VALUE",

diff --git a/clients/client-mq/src/models/models_0.ts b/clients/client-mq/src/models/models_0.ts
@@ -319,7 +319,7 @@ export interface Configuration {
   EngineType: EngineType | undefined;
 
   /**
-   * <p>Required. The broker engine's version. For a list of supported engine versions, see, <a href="https://docs.aws.amazon.com//amazon-mq/latest/developer-guide/broker-engine.html">Supported engines</a>.</p>
+   * <p>The broker engine version. Defaults to the latest available version for the specified broker engine type. For a list of supported engine versions, see the <a href="https://docs.aws.amazon.com//amazon-mq/latest/developer-guide/activemq-version-management.html">ActiveMQ version management</a> and the <a href="https://docs.aws.amazon.com//amazon-mq/latest/developer-guide/rabbitmq-version-management.html">RabbitMQ version management</a> sections in the Amazon MQ Developer Guide.</p>
    * @public
    */
   EngineVersion: string | undefined;
@@ -747,10 +747,10 @@ export interface CreateBrokerRequest {
   AuthenticationStrategy?: AuthenticationStrategy;
 
   /**
-   * <p>Enables automatic upgrades to new minor versions for brokers, as new versions are released and supported by Amazon MQ. Automatic upgrades occur during the scheduled maintenance window of the broker or after a manual broker reboot. Set to true by default, if no value is specified.</p>
+   * <p>Enables automatic upgrades to new patch versions for brokers as new versions are released and supported by Amazon MQ. Automatic upgrades occur during the scheduled maintenance window or after a manual broker reboot. Set to true by default, if no value is specified.</p> <note><p>Must be set to true for ActiveMQ brokers version 5.18 and above and for RabbitMQ brokers version 3.13 and above.</p></note>
    * @public
    */
-  AutoMinorVersionUpgrade: boolean | undefined;
+  AutoMinorVersionUpgrade?: boolean;
 
   /**
    * <p>Required. The broker's name. This value must be unique in your Amazon Web Services account, 1-50 characters long, must contain only letters, numbers, dashes, and underscores, and must not contain white spaces, brackets, wildcard characters, or special characters.</p> <important><p>Do not add personally identifiable information (PII) or other confidential or sensitive information in broker names. Broker names are accessible to other Amazon Web Services services, including CloudWatch Logs. Broker names are not intended to be used for private or sensitive data.</p></important>
@@ -789,10 +789,10 @@ export interface CreateBrokerRequest {
   EngineType: EngineType | undefined;
 
   /**
-   * <p>Required. The broker engine's version. For a list of supported engine versions, see <a href="https://docs.aws.amazon.com//amazon-mq/latest/developer-guide/broker-engine.html">Supported engines</a>.</p>
+   * <p>The broker engine version. Defaults to the latest available version for the specified broker engine type. For more information, see the <a href="https://docs.aws.amazon.com//amazon-mq/latest/developer-guide/activemq-version-management.html">ActiveMQ version management</a> and the <a href="https://docs.aws.amazon.com//amazon-mq/latest/developer-guide/rabbitmq-version-management.html">RabbitMQ version management</a> sections in the Amazon MQ Developer Guide.</p>
    * @public
    */
-  EngineVersion: string | undefined;
+  EngineVersion?: string;
 
   /**
    * <p>Required. The broker's instance type.</p>
@@ -1001,10 +1001,10 @@ export interface CreateConfigurationRequest {
   EngineType: EngineType | undefined;
 
   /**
-   * <p>Required. The broker engine's version. For a list of supported engine versions, see <a href="https://docs.aws.amazon.com//amazon-mq/latest/developer-guide/broker-engine.html">Supported engines</a>.</p>
+   * <p>The broker engine version. Defaults to the latest available version for the specified broker engine type. For more information, see the <a href="https://docs.aws.amazon.com//amazon-mq/latest/developer-guide/activemq-version-management.html">ActiveMQ version management</a> and the <a href="https://docs.aws.amazon.com//amazon-mq/latest/developer-guide/rabbitmq-version-management.html">RabbitMQ version management</a> sections in the Amazon MQ Developer Guide.</p>
    * @public
    */
-  EngineVersion: string | undefined;
+  EngineVersion?: string;
 
   /**
    * <p>Required. The name of the configuration. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 1-150 characters long.</p>
@@ -1407,7 +1407,7 @@ export interface DescribeBrokerResponse {
   AuthenticationStrategy?: AuthenticationStrategy;
 
   /**
-   * <p>Enables automatic upgrades to new minor versions for brokers, as new versions are released and supported by Amazon MQ. Automatic upgrades occur during the scheduled maintenance window of the broker or after a manual broker reboot.</p>
+   * <p>Enables automatic upgrades to new patch versions for brokers as new versions are released and supported by Amazon MQ. Automatic upgrades occur during the scheduled maintenance window or after a manual broker reboot.</p>
    * @public
    */
   AutoMinorVersionUpgrade?: boolean;
@@ -1473,7 +1473,7 @@ export interface DescribeBrokerResponse {
   EngineType?: EngineType;
 
   /**
-   * <p>The broker engine's version. For a list of supported engine versions, see <a href="https://docs.aws.amazon.com//amazon-mq/latest/developer-guide/broker-engine.html">Supported engines</a>.</p>
+   * <p>The broker engine version. For more information, see the <a href="https://docs.aws.amazon.com//amazon-mq/latest/developer-guide/activemq-version-management.html">ActiveMQ version management</a> and the <a href="https://docs.aws.amazon.com//amazon-mq/latest/developer-guide/rabbitmq-version-management.html">RabbitMQ version management</a> sections in the Amazon MQ Developer Guide.</p>
    * @public
    */
   EngineVersion?: string;
@@ -1509,7 +1509,7 @@ export interface DescribeBrokerResponse {
   PendingAuthenticationStrategy?: AuthenticationStrategy;
 
   /**
-   * <p>The broker engine version to upgrade to. For a list of supported engine versions, see <a href="https://docs.aws.amazon.com//amazon-mq/latest/developer-guide/broker-engine.html">Supported engines</a>.</p>
+   * <p>The broker engine version to upgrade to. For more information, see the <a href="https://docs.aws.amazon.com//amazon-mq/latest/developer-guide/activemq-version-management.html">ActiveMQ version management</a> and the <a href="https://docs.aws.amazon.com//amazon-mq/latest/developer-guide/rabbitmq-version-management.html">RabbitMQ version management</a> sections in the Amazon MQ Developer Guide.</p>
    * @public
    */
   PendingEngineVersion?: string;
@@ -1743,7 +1743,7 @@ export interface DescribeConfigurationResponse {
   EngineType?: EngineType;
 
   /**
-   * <p>Required. The broker engine's version. For a list of supported engine versions, see, <a href="https://docs.aws.amazon.com//amazon-mq/latest/developer-guide/broker-engine.html">Supported engines</a>.</p>
+   * <p>The broker engine version. Defaults to the latest available version for the specified broker engine type. For a list of supported engine versions, see the <a href="https://docs.aws.amazon.com//amazon-mq/latest/developer-guide/activemq-version-management.html">ActiveMQ version management</a> and the <a href="https://docs.aws.amazon.com//amazon-mq/latest/developer-guide/rabbitmq-version-management.html">RabbitMQ version management</a> sections in the Amazon MQ Developer Guide.</p>
    * @public
    */
   EngineVersion?: string;
@@ -2172,7 +2172,7 @@ export interface UpdateBrokerRequest {
   AuthenticationStrategy?: AuthenticationStrategy;
 
   /**
-   * <p>Enables automatic upgrades to new minor versions for brokers, as new versions are released and supported by Amazon MQ. Automatic upgrades occur during the scheduled maintenance window of the broker or after a manual broker reboot.</p>
+   * <p>Enables automatic upgrades to new patch versions for brokers as new versions are released and supported by Amazon MQ. Automatic upgrades occur during the scheduled maintenance window or after a manual broker reboot.</p> <note><p>Must be set to true for ActiveMQ brokers version 5.18 and above and for RabbitMQ brokers version 3.13 and above.</p></note>
    * @public
    */
   AutoMinorVersionUpgrade?: boolean;
@@ -2190,7 +2190,7 @@ export interface UpdateBrokerRequest {
   Configuration?: ConfigurationId;
 
   /**
-   * <p>The broker engine version. For a list of supported engine versions, see <a href="https://docs.aws.amazon.com//amazon-mq/latest/developer-guide/broker-engine.html">Supported engines</a>.</p>
+   * <p>The broker engine version. For more information, see the <a href="https://docs.aws.amazon.com//amazon-mq/latest/developer-guide/activemq-version-management.html">ActiveMQ version management</a> and the <a href="https://docs.aws.amazon.com//amazon-mq/latest/developer-guide/rabbitmq-version-management.html">RabbitMQ version management</a> sections in the Amazon MQ Developer Guide.</p> <note><p>When upgrading to ActiveMQ version 5.18 and above or RabbitMQ version 3.13 and above, you must have autoMinorVersionUpgrade set to true for the broker.</p></note>
    * @public
    */
   EngineVersion?: string;
@@ -2243,7 +2243,7 @@ export interface UpdateBrokerResponse {
   AuthenticationStrategy?: AuthenticationStrategy;
 
   /**
-   * <p>The new boolean value that specifies whether broker engines automatically upgrade to new minor versions as new versions are released and supported by Amazon MQ.</p>
+   * <p>Enables automatic upgrades to new patch versions for brokers as new versions are released and supported by Amazon MQ. Automatic upgrades occur during the scheduled maintenance window or after a manual broker reboot.</p>
    * @public
    */
   AutoMinorVersionUpgrade?: boolean;
@@ -2261,7 +2261,7 @@ export interface UpdateBrokerResponse {
   Configuration?: ConfigurationId;
 
   /**
-   * <p>The broker engine version to upgrade to. For a list of supported engine versions, see <a href="https://docs.aws.amazon.com//amazon-mq/latest/developer-guide/broker-engine.html">Supported engines</a>.</p>
+   * <p>The broker engine version to upgrade to. For more information, see the <a href="https://docs.aws.amazon.com//amazon-mq/latest/developer-guide/activemq-version-management.html">ActiveMQ version management</a> and the <a href="https://docs.aws.amazon.com//amazon-mq/latest/developer-guide/rabbitmq-version-management.html">RabbitMQ version management</a> sections in the Amazon MQ Developer Guide.</p>
    * @public
    */
   EngineVersion?: string;