feat(client-docdb): Add support for setting Serverless Scaling Configuration on clusters.

awstools · awstools · commit 7601d95f059b · 2025-07-30T18:17:46.000Z
diff --git a/clients/client-docdb/src/commands/CreateDBClusterCommand.ts b/clients/client-docdb/src/commands/CreateDBClusterCommand.ts
@@ -68,6 +68,10 @@ export interface CreateDBClusterCommandOutput extends CreateDBClusterResult, __M
  *   DeletionProtection: true || false,
  *   GlobalClusterIdentifier: "STRING_VALUE",
  *   StorageType: "STRING_VALUE",
+ *   ServerlessV2ScalingConfiguration: { // ServerlessV2ScalingConfiguration
+ *     MinCapacity: Number("double"),
+ *     MaxCapacity: Number("double"),
+ *   },
  *   ManageMasterUserPassword: true || false,
  *   MasterUserSecretKmsKeyId: "STRING_VALUE",
  * };
@@ -131,6 +135,10 @@ export interface CreateDBClusterCommandOutput extends CreateDBClusterResult, __M
  * //     ],
  * //     DeletionProtection: true || false,
  * //     StorageType: "STRING_VALUE",
+ * //     ServerlessV2ScalingConfiguration: { // ServerlessV2ScalingConfigurationInfo
+ * //       MinCapacity: Number("double"),
+ * //       MaxCapacity: Number("double"),
+ * //     },
  * //     MasterUserSecret: { // ClusterMasterUserSecret
  * //       SecretArn: "STRING_VALUE",
  * //       SecretStatus: "STRING_VALUE",
diff --git a/clients/client-docdb/src/commands/DeleteDBClusterCommand.ts b/clients/client-docdb/src/commands/DeleteDBClusterCommand.ts
@@ -101,6 +101,10 @@ export interface DeleteDBClusterCommandOutput extends DeleteDBClusterResult, __M
  * //     ],
  * //     DeletionProtection: true || false,
  * //     StorageType: "STRING_VALUE",
+ * //     ServerlessV2ScalingConfiguration: { // ServerlessV2ScalingConfigurationInfo
+ * //       MinCapacity: Number("double"),
+ * //       MaxCapacity: Number("double"),
+ * //     },
  * //     MasterUserSecret: { // ClusterMasterUserSecret
  * //       SecretArn: "STRING_VALUE",
  * //       SecretStatus: "STRING_VALUE",
diff --git a/clients/client-docdb/src/commands/DescribeDBClustersCommand.ts b/clients/client-docdb/src/commands/DescribeDBClustersCommand.ts
@@ -115,6 +115,10 @@ export interface DescribeDBClustersCommandOutput extends DBClusterMessage, __Met
  * //       ],
  * //       DeletionProtection: true || false,
  * //       StorageType: "STRING_VALUE",
+ * //       ServerlessV2ScalingConfiguration: { // ServerlessV2ScalingConfigurationInfo
+ * //         MinCapacity: Number("double"),
+ * //         MaxCapacity: Number("double"),
+ * //       },
  * //       MasterUserSecret: { // ClusterMasterUserSecret
  * //         SecretArn: "STRING_VALUE",
  * //         SecretStatus: "STRING_VALUE",
diff --git a/clients/client-docdb/src/commands/DescribeDBEngineVersionsCommand.ts b/clients/client-docdb/src/commands/DescribeDBEngineVersionsCommand.ts
@@ -81,6 +81,10 @@ export interface DescribeDBEngineVersionsCommandOutput extends DBEngineVersionMe
  * //         "STRING_VALUE",
  * //       ],
  * //       SupportsCertificateRotationWithoutRestart: true || false,
+ * //       ServerlessV2FeaturesSupport: { // ServerlessV2FeaturesSupport
+ * //         MinCapacity: Number("double"),
+ * //         MaxCapacity: Number("double"),
+ * //       },
  * //     },
  * //   ],
  * // };
diff --git a/clients/client-docdb/src/commands/FailoverDBClusterCommand.ts b/clients/client-docdb/src/commands/FailoverDBClusterCommand.ts
@@ -101,6 +101,10 @@ export interface FailoverDBClusterCommandOutput extends FailoverDBClusterResult,
  * //     ],
  * //     DeletionProtection: true || false,
  * //     StorageType: "STRING_VALUE",
+ * //     ServerlessV2ScalingConfiguration: { // ServerlessV2ScalingConfigurationInfo
+ * //       MinCapacity: Number("double"),
+ * //       MaxCapacity: Number("double"),
+ * //     },
  * //     MasterUserSecret: { // ClusterMasterUserSecret
  * //       SecretArn: "STRING_VALUE",
  * //       SecretStatus: "STRING_VALUE",
diff --git a/clients/client-docdb/src/commands/ModifyDBClusterCommand.ts b/clients/client-docdb/src/commands/ModifyDBClusterCommand.ts
@@ -62,6 +62,10 @@ export interface ModifyDBClusterCommandOutput extends ModifyDBClusterResult, __M
  *   AllowMajorVersionUpgrade: true || false,
  *   DeletionProtection: true || false,
  *   StorageType: "STRING_VALUE",
+ *   ServerlessV2ScalingConfiguration: { // ServerlessV2ScalingConfiguration
+ *     MinCapacity: Number("double"),
+ *     MaxCapacity: Number("double"),
+ *   },
  *   ManageMasterUserPassword: true || false,
  *   MasterUserSecretKmsKeyId: "STRING_VALUE",
  *   RotateMasterUserPassword: true || false,
@@ -126,6 +130,10 @@ export interface ModifyDBClusterCommandOutput extends ModifyDBClusterResult, __M
  * //     ],
  * //     DeletionProtection: true || false,
  * //     StorageType: "STRING_VALUE",
+ * //     ServerlessV2ScalingConfiguration: { // ServerlessV2ScalingConfigurationInfo
+ * //       MinCapacity: Number("double"),
+ * //       MaxCapacity: Number("double"),
+ * //     },
  * //     MasterUserSecret: { // ClusterMasterUserSecret
  * //       SecretArn: "STRING_VALUE",
  * //       SecretStatus: "STRING_VALUE",
diff --git a/clients/client-docdb/src/commands/RestoreDBClusterFromSnapshotCommand.ts b/clients/client-docdb/src/commands/RestoreDBClusterFromSnapshotCommand.ts
@@ -64,6 +64,10 @@ export interface RestoreDBClusterFromSnapshotCommandOutput
  *   ],
  *   DeletionProtection: true || false,
  *   DBClusterParameterGroupName: "STRING_VALUE",
+ *   ServerlessV2ScalingConfiguration: { // ServerlessV2ScalingConfiguration
+ *     MinCapacity: Number("double"),
+ *     MaxCapacity: Number("double"),
+ *   },
  *   StorageType: "STRING_VALUE",
  * };
  * const command = new RestoreDBClusterFromSnapshotCommand(input);
@@ -126,6 +130,10 @@ export interface RestoreDBClusterFromSnapshotCommandOutput
  * //     ],
  * //     DeletionProtection: true || false,
  * //     StorageType: "STRING_VALUE",
+ * //     ServerlessV2ScalingConfiguration: { // ServerlessV2ScalingConfigurationInfo
+ * //       MinCapacity: Number("double"),
+ * //       MaxCapacity: Number("double"),
+ * //     },
  * //     MasterUserSecret: { // ClusterMasterUserSecret
  * //       SecretArn: "STRING_VALUE",
  * //       SecretStatus: "STRING_VALUE",
diff --git a/clients/client-docdb/src/commands/RestoreDBClusterToPointInTimeCommand.ts b/clients/client-docdb/src/commands/RestoreDBClusterToPointInTimeCommand.ts
@@ -66,6 +66,10 @@ export interface RestoreDBClusterToPointInTimeCommandOutput
  *     "STRING_VALUE",
  *   ],
  *   DeletionProtection: true || false,
+ *   ServerlessV2ScalingConfiguration: { // ServerlessV2ScalingConfiguration
+ *     MinCapacity: Number("double"),
+ *     MaxCapacity: Number("double"),
+ *   },
  *   StorageType: "STRING_VALUE",
  * };
  * const command = new RestoreDBClusterToPointInTimeCommand(input);
@@ -128,6 +132,10 @@ export interface RestoreDBClusterToPointInTimeCommandOutput
  * //     ],
  * //     DeletionProtection: true || false,
  * //     StorageType: "STRING_VALUE",
+ * //     ServerlessV2ScalingConfiguration: { // ServerlessV2ScalingConfigurationInfo
+ * //       MinCapacity: Number("double"),
+ * //       MaxCapacity: Number("double"),
+ * //     },
  * //     MasterUserSecret: { // ClusterMasterUserSecret
  * //       SecretArn: "STRING_VALUE",
  * //       SecretStatus: "STRING_VALUE",
diff --git a/clients/client-docdb/src/commands/StartDBClusterCommand.ts b/clients/client-docdb/src/commands/StartDBClusterCommand.ts
@@ -100,6 +100,10 @@ export interface StartDBClusterCommandOutput extends StartDBClusterResult, __Met
  * //     ],
  * //     DeletionProtection: true || false,
  * //     StorageType: "STRING_VALUE",
+ * //     ServerlessV2ScalingConfiguration: { // ServerlessV2ScalingConfigurationInfo
+ * //       MinCapacity: Number("double"),
+ * //       MaxCapacity: Number("double"),
+ * //     },
  * //     MasterUserSecret: { // ClusterMasterUserSecret
  * //       SecretArn: "STRING_VALUE",
  * //       SecretStatus: "STRING_VALUE",
diff --git a/clients/client-docdb/src/commands/StopDBClusterCommand.ts b/clients/client-docdb/src/commands/StopDBClusterCommand.ts
@@ -101,6 +101,10 @@ export interface StopDBClusterCommandOutput extends StopDBClusterResult, __Metad
  * //     ],
  * //     DeletionProtection: true || false,
  * //     StorageType: "STRING_VALUE",
+ * //     ServerlessV2ScalingConfiguration: { // ServerlessV2ScalingConfigurationInfo
+ * //       MinCapacity: Number("double"),
+ * //       MaxCapacity: Number("double"),
+ * //     },
  * //     MasterUserSecret: { // ClusterMasterUserSecret
  * //       SecretArn: "STRING_VALUE",
  * //       SecretStatus: "STRING_VALUE",
diff --git a/clients/client-docdb/src/models/models_0.ts b/clients/client-docdb/src/models/models_0.ts
@@ -860,7 +860,7 @@ export interface DBClusterSnapshot {
   SourceDBClusterSnapshotArn?: string | undefined;
 
   /**
-   * <p>Storage type associated with your cluster snapshot </p>
+   * <p>Storage type associated with your cluster snapshot</p>
    *          <p>For information on storage types for Amazon DocumentDB clusters, see
    *             Cluster storage configurations in the <i>Amazon DocumentDB Developer Guide</i>.</p>
    *          <p>Valid values for storage type - <code>standard | iopt1</code>
@@ -984,6 +984,26 @@ export class SnapshotQuotaExceededFault extends __BaseException {
   }
 }
 
+/**
+ * <p>Sets the scaling configuration of an Amazon DocumentDB Serverless cluster.</p>
+ * @public
+ */
+export interface ServerlessV2ScalingConfiguration {
+  /**
+   * <p>The minimum number of Amazon DocumentDB capacity units (DCUs) for an instance in an Amazon DocumentDB Serverless cluster.
+   *             You can specify DCU values in half-step increments, such as 8, 8.5, 9, and so on.</p>
+   * @public
+   */
+  MinCapacity?: number | undefined;
+
+  /**
+   * <p>The maximum number of Amazon DocumentDB capacity units (DCUs) for an instance in an Amazon DocumentDB Serverless cluster.
+   *             You can specify DCU values in half-step increments, such as 32, 32.5, 33, and so on.</p>
+   * @public
+   */
+  MaxCapacity?: number | undefined;
+}
+
 /**
  * <p>Represents the input to <a>CreateDBCluster</a>.
  *         </p>
@@ -1223,6 +1243,12 @@ export interface CreateDBClusterMessage {
    */
   StorageType?: string | undefined;
 
+  /**
+   * <p>Contains the scaling configuration of an Amazon DocumentDB Serverless cluster.</p>
+   * @public
+   */
+  ServerlessV2ScalingConfiguration?: ServerlessV2ScalingConfiguration | undefined;
+
   /**
    * <p>Specifies whether to manage the master user password with Amazon Web Services Secrets Manager.</p>
    *          <p>Constraint: You can't manage the master user password with Amazon Web Services Secrets Manager if <code>MasterUserPassword</code> is specified.</p>
@@ -1353,6 +1379,26 @@ export interface ClusterMasterUserSecret {
   KmsKeyId?: string | undefined;
 }
 
+/**
+ * <p>Retrieves the scaling configuration for an Amazon DocumentDB Serverless cluster.</p>
+ * @public
+ */
+export interface ServerlessV2ScalingConfigurationInfo {
+  /**
+   * <p>The minimum number of Amazon DocumentDB capacity units (DCUs) for an instance in an Amazon DocumentDB Serverless cluster.
+   *             You can specify DCU values in half-step increments, such as 8, 8.5, 9, and so on.</p>
+   * @public
+   */
+  MinCapacity?: number | undefined;
+
+  /**
+   * <p>The maximum number of Amazon DocumentDB capacity units (DCUs) for an instance in an Amazon DocumentDB Serverless cluster.
+   *             You can specify DCU values in half-step increments, such as 32, 32.5, 33, and so on. </p>
+   * @public
+   */
+  MaxCapacity?: number | undefined;
+}
+
 /**
  * <p>Used as a response element for queries on virtual private cloud (VPC) security group
  *             membership.</p>
@@ -1586,7 +1632,6 @@ export interface DBCluster {
 
   /**
    * <p>Storage type associated with your cluster</p>
-   *          <p>Storage type associated with your cluster</p>
    *          <p>For information on storage types for Amazon DocumentDB clusters, see
    *             Cluster storage configurations in the <i>Amazon DocumentDB Developer Guide</i>.</p>
    *          <p>Valid values for storage type - <code>standard | iopt1</code>
@@ -1597,6 +1642,12 @@ export interface DBCluster {
    */
   StorageType?: string | undefined;
 
+  /**
+   * <p>The scaling configuration of an Amazon DocumentDB Serverless cluster.</p>
+   * @public
+   */
+  ServerlessV2ScalingConfiguration?: ServerlessV2ScalingConfigurationInfo | undefined;
+
   /**
    * <p>The secret managed by Amazon DocumentDB in Amazon Web Services Secrets Manager for the master user password.</p>
    * @public
@@ -3090,7 +3141,7 @@ export interface GlobalClusterMember {
   DBClusterArn?: string | undefined;
 
   /**
-   * <p>The Amazon Resource Name (ARN) for each read-only secondary cluster associated with the Aurora global cluster.</p>
+   * <p>The Amazon Resource Name (ARN) for each read-only secondary cluster associated with the Amazon DocumentDB global cluster.</p>
    * @public
    */
   Readers?: string[] | undefined;
@@ -3114,7 +3165,8 @@ export interface GlobalCluster {
   GlobalClusterIdentifier?: string | undefined;
 
   /**
-   * <p>The Amazon Web Services Region-unique, immutable identifier for the global database cluster. This identifier is found in CloudTrail log entries whenever the KMS customer master key (CMK) for the cluster is accessed. </p>
+   * <p>The Amazon Web Services RegionRegion-unique, immutable identifier for the global database cluster.
+   *             This identifier is found in CloudTrail log entries whenever the KMS customer master key (CMK) for the cluster is accessed. </p>
    * @public
    */
   GlobalClusterResourceId?: string | undefined;
@@ -4125,6 +4177,28 @@ export interface DescribeDBClusterSnapshotsMessage {
   IncludePublic?: boolean | undefined;
 }
 
+/**
+ * <p>Specifies any Amazon DocumentDB Serverless properties or limits that differ between Amazon DocumentDB engine versions.
+ *             You can test the values of this attribute when deciding which Amazon DocumentDB version to use in a new or upgraded cluster.
+ *             You can also retrieve the version of an existing cluster and check whether that version supports certain Amazon DocumentDB Serverless features before you attempt to use those features.</p>
+ * @public
+ */
+export interface ServerlessV2FeaturesSupport {
+  /**
+   * <p>The minimum number of Amazon DocumentDB capacity units (DCUs) for an instance in an Amazon DocumentDB Serverless cluster.
+   *             You can specify DCU values in half-step increments, such as 8, 8.5, 9, and so on.</p>
+   * @public
+   */
+  MinCapacity?: number | undefined;
+
+  /**
+   * <p>The maximum number of Amazon DocumentDB capacity units (DCUs) for an instance in an Amazon DocumentDB Serverless cluster.
+   *             You can specify DCU values in half-step increments, such as 32, 32.5, 33, and so on.</p>
+   * @public
+   */
+  MaxCapacity?: number | undefined;
+}
+
 /**
  * <p>The version of the database engine that an instance can be upgraded to.</p>
  * @public
@@ -4234,6 +4308,14 @@ export interface DBEngineVersion {
    * @public
    */
   SupportsCertificateRotationWithoutRestart?: boolean | undefined;
+
+  /**
+   * <p>Specifies any Amazon DocumentDB Serverless properties or limits that differ between Amazon DocumentDB engine versions.
+   *             You can test the values of this attribute when deciding which Amazon DocumentDB version to use in a new or upgraded cluster.
+   *             You can also retrieve the version of an existing cluster and check whether that version supports certain Amazon DocumentDB Serverless features before you attempt to use those features.</p>
+   * @public
+   */
+  ServerlessV2FeaturesSupport?: ServerlessV2FeaturesSupport | undefined;
 }
 
 /**
@@ -5449,6 +5531,12 @@ export interface ModifyDBClusterMessage {
    */
   StorageType?: string | undefined;
 
+  /**
+   * <p>Contains the scaling configuration of an Amazon DocumentDB Serverless cluster.</p>
+   * @public
+   */
+  ServerlessV2ScalingConfiguration?: ServerlessV2ScalingConfiguration | undefined;
+
   /**
    * <p>Specifies whether to manage the master user password with Amazon Web Services Secrets Manager.
    *             If the cluster doesn't manage the master user password with Amazon Web Services Secrets Manager, you can turn on this management.
@@ -6290,6 +6378,12 @@ export interface RestoreDBClusterFromSnapshotMessage {
    */
   DBClusterParameterGroupName?: string | undefined;
 
+  /**
+   * <p>Contains the scaling configuration of an Amazon DocumentDB Serverless cluster.</p>
+   * @public
+   */
+  ServerlessV2ScalingConfiguration?: ServerlessV2ScalingConfiguration | undefined;
+
   /**
    * <p>The storage type to associate with the DB cluster.</p>
    *          <p>For information on storage types for Amazon DocumentDB clusters, see
@@ -6467,6 +6561,12 @@ export interface RestoreDBClusterToPointInTimeMessage {
    */
   DeletionProtection?: boolean | undefined;
 
+  /**
+   * <p>Contains the scaling configuration of an Amazon DocumentDB Serverless cluster.</p>
+   * @public
+   */
+  ServerlessV2ScalingConfiguration?: ServerlessV2ScalingConfiguration | undefined;
+
   /**
    * <p>The storage type to associate with the DB cluster.</p>
    *          <p>For information on storage types for Amazon DocumentDB clusters, see
diff --git a/clients/client-docdb/src/protocols/Aws_query.ts b/clients/client-docdb/src/protocols/Aws_query.ts
diff --git a/codegen/sdk-codegen/aws-models/docdb.json b/codegen/sdk-codegen/aws-models/docdb.json
