@aws-sdk/client-rds 3.315.0 → 3.317.0

package/dist-types/commands/CreateDBClusterCommand.d.ts

@@ -314,6 +314,133 @@ export interface CreateDBClusterCommandOutput extends CreateDBClusterResult, __M
  * // example id: to-create-a-postgresql--compatible-db-cluster-1679700161087
  * ```
  *
+ * @example To create a MySQL 5.7-compatible DB cluster
+ * ```javascript
+ * // The following example creates a MySQL 5.7-compatible Aurora DB cluster.
+ * const input = {
+ *   "DBClusterIdentifier": "sample-cluster",
+ *   "DBSubnetGroupName": "default",
+ *   "Engine": "aurora-mysql",
+ *   "EngineVersion": "5.7.12",
+ *   "MasterUserPassword": "mypassword",
+ *   "MasterUsername": "admin",
+ *   "VpcSecurityGroupIds": [
+ *     "sg-0b91305example"
+ *   ]
+ * };
+ * const command = new CreateDBClusterCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "DBCluster": {
+ *     "AllocatedStorage": 1,
+ *     "AssociatedRoles": [],
+ *     "AvailabilityZones": [
+ *       "us-east-1a",
+ *       "us-east-1b",
+ *       "us-east-1e"
+ *     ],
+ *     "BackupRetentionPeriod": 1,
+ *     "ClusterCreateTime": "2019-06-07T23:21:33.048Z",
+ *     "CopyTagsToSnapshot": false,
+ *     "DBClusterArn": "arn:aws:rds:us-east-1:123456789012:cluster:sample-cluster",
+ *     "DBClusterIdentifier": "sample-cluster",
+ *     "DBClusterMembers": [],
+ *     "DBClusterParameterGroup": "default.aurora-mysql5.7",
+ *     "DBSubnetGroup": "default",
+ *     "DbClusterResourceId": "cluster-ANPAJ4AE5446DAEXAMPLE",
+ *     "DeletionProtection": false,
+ *     "Endpoint": "sample-cluster.cluster-cnpexample.us-east-1.rds.amazonaws.com",
+ *     "Engine": "aurora-mysql",
+ *     "EngineMode": "provisioned",
+ *     "EngineVersion": "5.7.12",
+ *     "HostedZoneId": "Z2R2ITUGPM61AM",
+ *     "HttpEndpointEnabled": false,
+ *     "IAMDatabaseAuthenticationEnabled": false,
+ *     "MasterUsername": "master",
+ *     "MultiAZ": false,
+ *     "Port": 3306,
+ *     "PreferredBackupWindow": "09:12-09:42",
+ *     "PreferredMaintenanceWindow": "mon:04:31-mon:05:01",
+ *     "ReadReplicaIdentifiers": [],
+ *     "ReaderEndpoint": "sample-cluster.cluster-ro-cnpexample.us-east-1.rds.amazonaws.com",
+ *     "Status": "creating",
+ *     "StorageEncrypted": false,
+ *     "VpcSecurityGroups": [
+ *       {
+ *         "Status": "active",
+ *         "VpcSecurityGroupId": "sg-0b91305example"
+ *       }
+ *     ]
+ *   }
+ * }
+ * *\/
+ * // example id: to-create-a-mysql-57-compatible-db-cluster-1679699416154
+ * ```
+ *
+ * @example To create a PostgreSQL-compatible DB cluster
+ * ```javascript
+ * // The following example creates a PostgreSQL-compatible Aurora DB cluster.
+ * const input = {
+ *   "DBClusterIdentifier": "sample-pg-cluster",
+ *   "DBSubnetGroupName": "default",
+ *   "Engine": "aurora-postgresql",
+ *   "MasterUserPassword": "mypassword",
+ *   "MasterUsername": "admin",
+ *   "VpcSecurityGroupIds": [
+ *     "sg-0b91305example"
+ *   ]
+ * };
+ * const command = new CreateDBClusterCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "DBCluster": {
+ *     "AllocatedStorage": 1,
+ *     "AssociatedRoles": [],
+ *     "AvailabilityZones": [
+ *       "us-east-1a",
+ *       "us-east-1b",
+ *       "us-east-1c"
+ *     ],
+ *     "BackupRetentionPeriod": 1,
+ *     "ClusterCreateTime": "2019-06-07T23:26:08.371Z",
+ *     "CopyTagsToSnapshot": false,
+ *     "DBClusterArn": "arn:aws:rds:us-east-1:123456789012:cluster:sample-pg-cluster",
+ *     "DBClusterIdentifier": "sample-pg-cluster",
+ *     "DBClusterMembers": [],
+ *     "DBClusterParameterGroup": "default.aurora-postgresql9.6",
+ *     "DBSubnetGroup": "default",
+ *     "DbClusterResourceId": "cluster-ANPAJ4AE5446DAEXAMPLE",
+ *     "DeletionProtection": false,
+ *     "Endpoint": "sample-pg-cluster.cluster-cnpexample.us-east-1.rds.amazonaws.com",
+ *     "Engine": "aurora-postgresql",
+ *     "EngineMode": "provisioned",
+ *     "EngineVersion": "9.6.9",
+ *     "HostedZoneId": "Z2R2ITUGPM61AM",
+ *     "HttpEndpointEnabled": false,
+ *     "IAMDatabaseAuthenticationEnabled": false,
+ *     "MasterUsername": "master",
+ *     "MultiAZ": false,
+ *     "Port": 5432,
+ *     "PreferredBackupWindow": "09:56-10:26",
+ *     "PreferredMaintenanceWindow": "wed:03:33-wed:04:03",
+ *     "ReadReplicaIdentifiers": [],
+ *     "ReaderEndpoint": "sample-pg-cluster.cluster-ro-cnpexample.us-east-1.rds.amazonaws.com",
+ *     "Status": "creating",
+ *     "StorageEncrypted": false,
+ *     "VpcSecurityGroups": [
+ *       {
+ *         "Status": "active",
+ *         "VpcSecurityGroupId": "sg-0b91305example"
+ *       }
+ *     ]
+ *   }
+ * }
+ * *\/
+ * // example id: to-create-a-postgresql-compatible-db-cluster-1679700161087
+ * ```
+ *
  */
 export declare class CreateDBClusterCommand extends $Command<CreateDBClusterCommandInput, CreateDBClusterCommandOutput, RDSClientResolvedConfig> {
     readonly input: CreateDBClusterCommandInput;

package/dist-types/commands/ModifyDBInstanceCommand.d.ts

@@ -234,6 +234,55 @@ export interface ModifyDBInstanceCommandOutput extends ModifyDBInstanceResult, _
  * // example id: to-modify-parameters-in-a-db-cluster-parameter-group-1680377584537
  * ```
  *
+ * @example To modify a DB instance
+ * ```javascript
+ * // The following example associates an option group and a parameter group with a compatible Microsoft SQL Server DB instance. The ApplyImmediately parameter causes the option and parameter groups to be associated immediately, instead of waiting until the next maintenance window.
+ * const input = {
+ *   "ApplyImmediately": true,
+ *   "DBInstanceIdentifier": "database-2",
+ *   "DBParameterGroupName": "test-sqlserver-se-2017",
+ *   "OptionGroupName": "test-se-2017"
+ * };
+ * const command = new ModifyDBInstanceCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "DBInstance": {
+ *     "AssociatedRoles": [],
+ *     "AutoMinorVersionUpgrade": false,
+ *     "AvailabilityZone": "us-west-2d",
+ *     "CharacterSetName": "SQL_Latin1_General_CP1_CI_AS",
+ *     "DBInstanceClass": "db.r4.large",
+ *     "DBInstanceIdentifier": "database-2",
+ *     "DBInstanceStatus": "available",
+ *     "DBParameterGroups": [
+ *       {
+ *         "DBParameterGroupName": "test-sqlserver-se-2017",
+ *         "ParameterApplyStatus": "applying"
+ *       }
+ *     ],
+ *     "DeletionProtection": false,
+ *     "Engine": "sqlserver-se",
+ *     "EngineVersion": "14.00.3281.6.v1",
+ *     "LicenseModel": "license-included",
+ *     "MaxAllocatedStorage": 1000,
+ *     "MultiAZ": true,
+ *     "OptionGroupMemberships": [
+ *       {
+ *         "OptionGroupName": "test-se-2017",
+ *         "Status": "pending-apply"
+ *       }
+ *     ],
+ *     "PubliclyAccessible": true,
+ *     "ReadReplicaDBInstanceIdentifiers": [],
+ *     "SecondaryAvailabilityZone": "us-west-2c",
+ *     "StorageType": "gp2"
+ *   }
+ * }
+ * *\/
+ * // example id: to-modify-a-db-instance-1680377584537
+ * ```
+ *
  */
 export declare class ModifyDBInstanceCommand extends $Command<ModifyDBInstanceCommandInput, ModifyDBInstanceCommandOutput, RDSClientResolvedConfig> {
     readonly input: ModifyDBInstanceCommandInput;

package/dist-types/models/models_0.d.ts

@@ -2717,7 +2717,10 @@ export interface CreateCustomDBEngineVersionMessage {
      */
     DatabaseInstallationFilesS3Prefix?: string;
     /**
-     * <p>The ID of the AMI. An AMI ID is required to create a CEV for RDS Custom for SQL Server.</p>
+     * <p>The ID of the Amazon Machine Image (AMI). For RDS Custom for SQL Server, an AMI ID is required
+     *             to create a CEV. For RDS Custom for Oracle, the default is the most recent AMI available,
+     *             but you can specify an AMI ID that was used in a different Oracle CEV. Find the AMIs
+     *             used by your CEVs by calling the <a href="https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DescribeDBEngineVersions.html">DescribeDBEngineVersions</a> operation.</p>
      */
     ImageId?: string;
     /**
@@ -4839,12 +4842,12 @@ export interface CreateDBClusterParameterGroupMessage {
      *          <p>
      *             <b>Aurora MySQL</b>
      *          </p>
-     *          <p>Example: <code>aurora5.6</code>, <code>aurora-mysql5.7</code>, <code>aurora-mysql8.0</code>
+     *          <p>Example: <code>aurora-mysql5.7</code>, <code>aurora-mysql8.0</code>
      *          </p>
      *          <p>
      *             <b>Aurora PostgreSQL</b>
      *          </p>
-     *          <p>Example: <code>aurora-postgresql9.6</code>
+     *          <p>Example: <code>aurora-postgresql14</code>
      *          </p>
      *          <p>
      *             <b>RDS for MySQL</b>
@@ -4871,11 +4874,8 @@ export interface CreateDBClusterParameterGroupMessage {
      *          <ul>
      *             <li>
      *                <p>
-     *                   <code>aurora</code> (for MySQL 5.6-compatible Aurora)</p>
-     *             </li>
-     *             <li>
-     *                <p>
-     *                   <code>aurora-mysql</code> (for MySQL 5.7-compatible and MySQL 8.0-compatible Aurora)</p>
+     *                   <code>aurora-mysql</code>
+     *                </p>
      *             </li>
      *             <li>
      *                <p>
@@ -5298,16 +5298,11 @@ export interface CreateDBInstanceMessage {
      *          <ul>
      *             <li>
      *                <p>
-     *                   <code>aurora</code> (for MySQL 5.6-compatible Aurora)</p>
-     *             </li>
-     *             <li>
-     *                <p>
-     *                   <code>aurora-mysql</code> (for MySQL 5.7-compatible and MySQL 8.0-compatible Aurora)</p>
+     *                   <code>aurora-mysql</code> (for Aurora MySQL DB instances)</p>
      *             </li>
      *             <li>
      *                <p>
-     *                   <code>aurora-postgresql</code>
-     *                </p>
+     *                   <code>aurora-postgresql</code> (for Aurora PostgreSQL DB instances)</p>
      *             </li>
      *             <li>
      *                <p>
@@ -6851,16 +6846,13 @@ export interface DBInstance {
     Timezone?: string;
     /**
      * <p>True if mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.</p>
-     *          <p>IAM database authentication can be enabled for the following database engines</p>
+     *          <p>IAM database authentication can be enabled for the following database engines:</p>
      *          <ul>
      *             <li>
-     *                <p>For MySQL 5.6, minor version 5.6.34 or higher</p>
-     *             </li>
-     *             <li>
-     *                <p>For MySQL 5.7, minor version 5.7.16 or higher</p>
+     *                <p>For MySQL 5.7, minor version 5.7.16 or higher.</p>
      *             </li>
      *             <li>
-     *                <p>Aurora 5.6 or higher. To enable IAM database authentication for Aurora, see DBCluster Type.</p>
+     *                <p>For Amazon Aurora, all versions of Aurora MySQL and Aurora PostgreSQL.</p>
      *             </li>
      *          </ul>
      */
@@ -7747,11 +7739,8 @@ export interface CreateDBParameterGroupMessage {
      *          <ul>
      *             <li>
      *                <p>
-     *                   <code>aurora</code> (for MySQL 5.6-compatible Aurora)</p>
-     *             </li>
-     *             <li>
-     *                <p>
-     *                   <code>aurora-mysql</code> (for MySQL 5.7-compatible and MySQL 8.0-compatible Aurora)</p>
+     *                   <code>aurora-mysql</code>
+     *                </p>
      *             </li>
      *             <li>
      *                <p>
@@ -10733,7 +10722,8 @@ export interface DescribeDBEngineVersionsMessage {
      *          <ul>
      *             <li>
      *                <p>
-     *                   <code>aurora-mysql</code> (for MySQL 5.7-compatible and MySQL 8.0-compatible Aurora)</p>
+     *                   <code>aurora-mysql</code>
+     *                </p>
      *             </li>
      *             <li>
      *                <p>
@@ -10742,6 +10732,11 @@ export interface DescribeDBEngineVersionsMessage {
      *             </li>
      *             <li>
      *                <p>
+     *                   <code>custom-oracle-ee</code>
+     *                </p>
+     *             </li>
+     *             <li>
+     *                <p>
      *                   <code>mariadb</code>
      *                </p>
      *             </li>

package/dist-types/models/models_1.d.ts

@@ -837,11 +837,6 @@ export interface DescribeEngineDefaultParametersMessage {
      *          <ul>
      *             <li>
      *                <p>
-     *                   <code>aurora5.6</code>
-     *                </p>
-     *             </li>
-     *             <li>
-     *                <p>
      *                   <code>aurora-mysql5.7</code>
      *                </p>
      *             </li>
@@ -1879,7 +1874,8 @@ export interface DescribeOrderableDBInstanceOptionsMessage {
      *          <ul>
      *             <li>
      *                <p>
-     *                   <code>aurora-mysql</code> (for MySQL 5.7-compatible and MySQL 8.0-compatible Aurora)</p>
+     *                   <code>aurora-mysql</code>
+     *                </p>
      *             </li>
      *             <li>
      *                <p>
@@ -1888,6 +1884,11 @@ export interface DescribeOrderableDBInstanceOptionsMessage {
      *             </li>
      *             <li>
      *                <p>
+     *                   <code>custom-oracle-ee</code>
+     *                </p>
+     *             </li>
+     *             <li>
+     *                <p>
      *                   <code>mariadb</code>
      *                </p>
      *             </li>
@@ -3398,16 +3399,11 @@ export interface ModifyDBClusterMessage {
      *          <p>If the cluster that you're modifying has one or more read replicas, all replicas must
      *             be running an engine version that's the same or later than the version you
      *             specify.</p>
-     *          <p>To list all of the available engine versions for Aurora MySQL version 2 (5.7-compatible) and version 3 (MySQL 8.0-compatible),
-     *             use the following command:</p>
+     *          <p>To list all of the available engine versions for Aurora MySQL, use the following command:</p>
      *          <p>
      *             <code>aws rds describe-db-engine-versions --engine aurora-mysql --query
      *                 "DBEngineVersions[].EngineVersion"</code>
      *          </p>
-     *          <p>To list all of the available engine versions for MySQL 5.6-compatible Aurora, use the following command:</p>
-     *          <p>
-     *             <code>aws rds describe-db-engine-versions --engine aurora --query "DBEngineVersions[].EngineVersion"</code>
-     *          </p>
      *          <p>To list all of the available engine versions for Aurora PostgreSQL, use the following command:</p>
      *          <p>
      *             <code>aws rds describe-db-engine-versions --engine aurora-postgresql --query "DBEngineVersions[].EngineVersion"</code>
@@ -5139,15 +5135,11 @@ export interface ModifyGlobalClusterMessage {
      * <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 <code>aurora</code> (for MySQL 5.6-compatible Aurora), use the following command:</p>
-     *          <p>
-     *             <code>aws rds describe-db-engine-versions --engine aurora --query '*[]|[?SupportsGlobalDatabases == `true`].[EngineVersion]'</code>
-     *          </p>
-     *          <p>To list all of the available engine versions for <code>aurora-mysql</code> (for MySQL 5.7-compatible and MySQL 8.0-compatible Aurora), use the following command:</p>
+     *          <p>To list all of the available engine versions for <code>aurora-mysql</code> (for MySQL-based Aurora global databases), use the following command:</p>
      *          <p>
      *             <code>aws rds describe-db-engine-versions --engine aurora-mysql --query '*[]|[?SupportsGlobalDatabases == `true`].[EngineVersion]'</code>
      *          </p>
-     *          <p>To list all of the available engine versions for <code>aurora-postgresql</code>, use the following command:</p>
+     *          <p>To list all of the available engine versions for <code>aurora-postgresql</code> (for PostgreSQL-based Aurora global databases), use the following command:</p>
      *          <p>
      *             <code>aws rds describe-db-engine-versions --engine aurora-postgresql --query '*[]|[?SupportsGlobalDatabases == `true`].[EngineVersion]'</code>
      *          </p>
@@ -5806,7 +5798,7 @@ export interface RestoreDBClusterFromS3Message {
     DBClusterIdentifier: string | undefined;
     /**
      * <p>The name of the DB cluster parameter group to associate
-     *             with the restored DB cluster. If this argument is omitted, <code>default.aurora5.6</code> is used.</p>
+     *             with the restored DB cluster. If this argument is omitted, the default parameter group for the engine version is used.</p>
      *          <p>Constraints:</p>
      *          <ul>
      *             <li>
@@ -5828,13 +5820,12 @@ export interface RestoreDBClusterFromS3Message {
     DBSubnetGroupName?: string;
     /**
      * <p>The name of the database engine to be used for this DB cluster.</p>
-     *          <p>Valid Values: <code>aurora-mysql</code> (for MySQL 5.7-compatible and MySQL 8.0-compatible Aurora)</p>
+     *          <p>Valid Values: <code>aurora-mysql</code> (for Aurora MySQL)</p>
      */
     Engine: string | undefined;
     /**
      * <p>The version number of the database engine to use.</p>
-     *          <p>To list all of the available engine versions for <code>aurora-mysql</code> (MySQL 5.7-compatible and MySQL 8.0-compatible
-     *             Aurora), use the following command:</p>
+     *          <p>To list all of the available engine versions for <code>aurora-mysql</code> (Aurora MySQL), use the following command:</p>
      *          <p>
      *             <code>aws rds describe-db-engine-versions --engine aurora-mysql --query "DBEngineVersions[].EngineVersion"</code>
      *          </p>
@@ -6196,7 +6187,7 @@ export interface RestoreDBClusterFromSnapshotMessage {
     /**
      * <p>The version of the database engine to use for the new DB cluster. If you don't specify an engine version, the default version
      *             for the database engine in the Amazon Web Services Region is used.</p>
-     *          <p>To list all of the available engine versions for MySQL 5.7-compatible and MySQL 8.0-compatible Aurora, use the following command:</p>
+     *          <p>To list all of the available engine versions for Aurora MySQL, use the following command:</p>
      *          <p>
      *             <code>aws rds describe-db-engine-versions --engine aurora-mysql --query "DBEngineVersions[].EngineVersion"</code>
      *          </p>
@@ -6347,8 +6338,7 @@ export interface RestoreDBClusterFromSnapshotMessage {
      */
     EnableCloudwatchLogsExports?: string[];
     /**
-     * <p>The DB engine mode of the DB cluster, either <code>provisioned</code>, <code>serverless</code>,
-     *             <code>parallelquery</code>, <code>global</code>, or <code>multimaster</code>.</p>
+     * <p>The DB engine mode of the DB cluster, either <code>provisioned</code> or <code>serverless</code>.</p>
      *          <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBCluster.html">
      *             CreateDBCluster</a>.</p>
      *          <p>Valid for: Aurora DB clusters only</p>
@@ -6559,7 +6549,6 @@ export interface RestoreDBClusterToPointInTimeMessage {
      *                 source DB cluster.</p>
      *             </li>
      *          </ul>
-     *          <p>Constraints: You can't specify <code>copy-on-write</code> if the engine version of the source DB cluster is earlier than 1.11.</p>
      *          <p>If you don't specify a <code>RestoreType</code> value, then the new DB cluster is
      *             restored as a full copy of the source DB cluster.</p>
      *          <p>Valid for: Aurora DB clusters and Multi-AZ DB clusters</p>

package/dist-types/ts3.4/RDS.d.ts

@@ -564,7 +564,7 @@ import {
   SwitchoverReadReplicaCommandOutput,
 } from "./commands/SwitchoverReadReplicaCommand";
 import { RDSClient } from "./RDSClient";
-export declare class RDS extends RDSClient {
+export interface RDS {
   addRoleToDBCluster(
     args: AddRoleToDBClusterCommandInput,
     options?: __HttpHandlerOptions
@@ -2471,3 +2471,4 @@ export declare class RDS extends RDSClient {
     cb: (err: any, data?: SwitchoverReadReplicaCommandOutput) => void
   ): void;
 }
+export declare class RDS extends RDSClient implements RDS {}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@aws-sdk/client-rds",
   "description": "AWS SDK for JavaScript Rds Client for Node.js, Browser and React Native",
-  "version": "3.315.0",
+  "version": "3.317.0",
   "scripts": {
     "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
     "build:cjs": "tsc -p tsconfig.cjs.json",
@@ -21,9 +21,9 @@
   "dependencies": {
     "@aws-crypto/sha256-browser": "3.0.0",
     "@aws-crypto/sha256-js": "3.0.0",
-    "@aws-sdk/client-sts": "3.315.0",
+    "@aws-sdk/client-sts": "3.316.0",
     "@aws-sdk/config-resolver": "3.310.0",
-    "@aws-sdk/credential-provider-node": "3.315.0",
+    "@aws-sdk/credential-provider-node": "3.316.0",
     "@aws-sdk/fetch-http-handler": "3.310.0",
     "@aws-sdk/hash-node": "3.310.0",
     "@aws-sdk/invalid-dependency": "3.310.0",
@@ -41,14 +41,14 @@
     "@aws-sdk/node-config-provider": "3.310.0",
     "@aws-sdk/node-http-handler": "3.310.0",
     "@aws-sdk/protocol-http": "3.310.0",
-    "@aws-sdk/smithy-client": "3.315.0",
+    "@aws-sdk/smithy-client": "3.316.0",
     "@aws-sdk/types": "3.310.0",
     "@aws-sdk/url-parser": "3.310.0",
     "@aws-sdk/util-base64": "3.310.0",
     "@aws-sdk/util-body-length-browser": "3.310.0",
     "@aws-sdk/util-body-length-node": "3.310.0",
-    "@aws-sdk/util-defaults-mode-browser": "3.315.0",
-    "@aws-sdk/util-defaults-mode-node": "3.315.0",
+    "@aws-sdk/util-defaults-mode-browser": "3.316.0",
+    "@aws-sdk/util-defaults-mode-node": "3.316.0",
     "@aws-sdk/util-endpoints": "3.310.0",
     "@aws-sdk/util-retry": "3.310.0",
     "@aws-sdk/util-user-agent-browser": "3.310.0",