@aws-sdk/client-rds 3.316.0 → 3.319.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/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.316.0",
+  "version": "3.319.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.316.0",
+    "@aws-sdk/client-sts": "3.319.0",
     "@aws-sdk/config-resolver": "3.310.0",
-    "@aws-sdk/credential-provider-node": "3.316.0",
+    "@aws-sdk/credential-provider-node": "3.319.0",
     "@aws-sdk/fetch-http-handler": "3.310.0",
     "@aws-sdk/hash-node": "3.310.0",
     "@aws-sdk/invalid-dependency": "3.310.0",
@@ -33,11 +33,11 @@
     "@aws-sdk/middleware-logger": "3.310.0",
     "@aws-sdk/middleware-recursion-detection": "3.310.0",
     "@aws-sdk/middleware-retry": "3.310.0",
-    "@aws-sdk/middleware-sdk-rds": "3.310.0",
+    "@aws-sdk/middleware-sdk-rds": "3.319.0",
     "@aws-sdk/middleware-serde": "3.310.0",
     "@aws-sdk/middleware-signing": "3.310.0",
     "@aws-sdk/middleware-stack": "3.310.0",
-    "@aws-sdk/middleware-user-agent": "3.310.0",
+    "@aws-sdk/middleware-user-agent": "3.319.0",
     "@aws-sdk/node-config-provider": "3.310.0",
     "@aws-sdk/node-http-handler": "3.310.0",
     "@aws-sdk/protocol-http": "3.310.0",
@@ -49,7 +49,7 @@
     "@aws-sdk/util-body-length-node": "3.310.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-endpoints": "3.319.0",
     "@aws-sdk/util-retry": "3.310.0",
     "@aws-sdk/util-user-agent-browser": "3.310.0",
     "@aws-sdk/util-user-agent-node": "3.310.0",