feat(client-docdb): Added major version upgrade option in ModifyDBClu…

…ster API
aws · Jul 17, 2023 · c12cffb · c12cffb
1 parent 5e3726d
commit c12cffb
Show file tree

Hide file tree

Showing 8 changed files with 136 additions and 7 deletions.
diff --git a/clients/client-docdb/README.md b/clients/client-docdb/README.md
@@ -6,7 +6,9 @@
 
 AWS SDK for JavaScript DocDB Client for Node.js, Browser and React Native.
 
-<p>Amazon DocumentDB API documentation</p>
+<p>Amazon DocumentDB is a fast, reliable, and fully managed database service.
+Amazon DocumentDB makes it easy to set up, operate, and scale MongoDB-compatible databases in the cloud.
+With Amazon DocumentDB, you can run the same application code and use the same drivers and tools that you use with MongoDB.</p>
 
 ## Installing
 

diff --git a/clients/client-docdb/src/DocDB.ts b/clients/client-docdb/src/DocDB.ts
@@ -1209,7 +1209,9 @@ export interface DocDB {
 
 /**
  * @public
- * <p>Amazon DocumentDB API documentation</p>
+ * <p>Amazon DocumentDB is a fast, reliable, and fully managed database service.
+ *          Amazon DocumentDB makes it easy to set up, operate, and scale MongoDB-compatible databases in the cloud.
+ *          With Amazon DocumentDB, you can run the same application code and use the same drivers and tools that you use with MongoDB.</p>
  */
 export class DocDB extends DocDBClient implements DocDB {}
 createAggregatedClient(commands, DocDB);
diff --git a/clients/client-docdb/src/DocDBClient.ts b/clients/client-docdb/src/DocDBClient.ts
@@ -512,7 +512,9 @@ export interface DocDBClientResolvedConfig extends DocDBClientResolvedConfigType
 
 /**
  * @public
- * <p>Amazon DocumentDB API documentation</p>
+ * <p>Amazon DocumentDB is a fast, reliable, and fully managed database service.
+ *          Amazon DocumentDB makes it easy to set up, operate, and scale MongoDB-compatible databases in the cloud.
+ *          With Amazon DocumentDB, you can run the same application code and use the same drivers and tools that you use with MongoDB.</p>
  */
 export class DocDBClient extends __Client<
   __HttpHandlerOptions,

diff --git a/clients/client-docdb/src/commands/ModifyDBClusterCommand.ts b/clients/client-docdb/src/commands/ModifyDBClusterCommand.ts
@@ -67,6 +67,7 @@ export interface ModifyDBClusterCommandOutput extends ModifyDBClusterResult, __M
  *     ],
  *   },
  *   EngineVersion: "STRING_VALUE",
+ *   AllowMajorVersionUpgrade: true || false,
  *   DeletionProtection: true || false,
  * };
  * const command = new ModifyDBClusterCommand(input);

diff --git a/clients/client-docdb/src/index.ts b/clients/client-docdb/src/index.ts
@@ -1,7 +1,9 @@
 // smithy-typescript generated code
 /* eslint-disable */
 /**
- * <p>Amazon DocumentDB API documentation</p>
+ * <p>Amazon DocumentDB is a fast, reliable, and fully managed database service.
+ *          Amazon DocumentDB makes it easy to set up, operate, and scale MongoDB-compatible databases in the cloud.
+ *          With Amazon DocumentDB, you can run the same application code and use the same drivers and tools that you use with MongoDB.</p>
  *
  * @packageDocumentation
  */

diff --git a/clients/client-docdb/src/models/models_0.ts b/clients/client-docdb/src/models/models_0.ts
@@ -4714,10 +4714,24 @@ export interface ModifyDBClusterMessage {
   CloudwatchLogsExportConfiguration?: CloudwatchLogsExportConfiguration;
 
   /**
-   * <p>The version number of the database engine to which you want to upgrade. Modifying engine version is not supported on Amazon DocumentDB.</p>
+   * <p>The version number of the database engine to which you want to upgrade.
+   *              Changing this parameter results in an outage. The change is applied during
+   *              the next maintenance window unless <code>ApplyImmediately</code> is enabled.</p>
+   *          <p>To list all of the available engine versions for Amazon DocumentDB use the following command:</p>
+   *          <p>
+   *             <code>aws docdb describe-db-engine-versions --engine docdb --query "DBEngineVersions[].EngineVersion"</code>
+   *          </p>
    */
   EngineVersion?: string;
 
+  /**
+   * <p>A value that indicates whether major version upgrades are allowed.</p>
+   *          <p>Constraints: You must allow major version upgrades when specifying a value for the
+   *              <code>EngineVersion</code> parameter that is a different major version than the DB
+   *              cluster's current version.</p>
+   */
+  AllowMajorVersionUpgrade?: boolean;
+
   /**
    * <p>Specifies whether this cluster can be deleted. If <code>DeletionProtection</code> is
    *             enabled, the cluster cannot be deleted unless it is modified and

diff --git a/clients/client-docdb/src/protocols/Aws_query.ts b/clients/client-docdb/src/protocols/Aws_query.ts
@@ -6317,6 +6317,9 @@ const se_ModifyDBClusterMessage = (input: ModifyDBClusterMessage, context: __Ser
   if (input.EngineVersion != null) {
     entries["EngineVersion"] = input.EngineVersion;
   }
+  if (input.AllowMajorVersionUpgrade != null) {
+    entries["AllowMajorVersionUpgrade"] = input.AllowMajorVersionUpgrade;
+  }
   if (input.DeletionProtection != null) {
     entries["DeletionProtection"] = input.DeletionProtection;
   }