@aws-sdk/client-rds 3.288.0 → 3.289.0

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

@@ -42,6 +42,99 @@ export interface RestoreDBInstanceFromDBSnapshotCommandOutput extends RestoreDBI
  * @see {@link RestoreDBInstanceFromDBSnapshotCommandOutput} for command's `response` shape.
  * @see {@link RDSClientResolvedConfig | config} for RDSClient's `config` shape.
  *
+ * @example To restore a DB instance from a DB snapshot.
+ * ```javascript
+ * // The following example restores a DB instance from a DB snapshot.
+ * const input = {
+ *   "DBInstanceIdentifier": "mysqldb-restored",
+ *   "DBSnapshotIdentifier": "rds:mysqldb-2014-04-22-08-15"
+ * };
+ * const command = new RestoreDBInstanceFromDBSnapshotCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "DBInstance": {
+ *     "AllocatedStorage": 200,
+ *     "AutoMinorVersionUpgrade": true,
+ *     "AvailabilityZone": "us-west-2b",
+ *     "BackupRetentionPeriod": 7,
+ *     "CACertificateIdentifier": "rds-ca-2015",
+ *     "CopyTagsToSnapshot": false,
+ *     "DBInstanceArn": "arn:aws:rds:us-west-2:123456789012:db:mysqldb-restored",
+ *     "DBInstanceClass": "db.t2.small",
+ *     "DBInstanceIdentifier": "mysqldb-restored",
+ *     "DBInstanceStatus": "available",
+ *     "DBName": "sample",
+ *     "DBParameterGroups": [
+ *       {
+ *         "DBParameterGroupName": "default.mysql5.6",
+ *         "ParameterApplyStatus": "in-sync"
+ *       }
+ *     ],
+ *     "DBSecurityGroups": [],
+ *     "DBSubnetGroup": {
+ *       "DBSubnetGroupDescription": "default",
+ *       "DBSubnetGroupName": "default",
+ *       "SubnetGroupStatus": "Complete",
+ *       "Subnets": [
+ *         {
+ *           "SubnetAvailabilityZone": {
+ *             "Name": "us-west-2a"
+ *           },
+ *           "SubnetIdentifier": "subnet-77e8db03",
+ *           "SubnetStatus": "Active"
+ *         },
+ *         {
+ *           "SubnetAvailabilityZone": {
+ *             "Name": "us-west-2b"
+ *           },
+ *           "SubnetIdentifier": "subnet-c39989a1",
+ *           "SubnetStatus": "Active"
+ *         },
+ *         {
+ *           "SubnetAvailabilityZone": {
+ *             "Name": "us-west-2c"
+ *           },
+ *           "SubnetIdentifier": "subnet-4b267b0d",
+ *           "SubnetStatus": "Active"
+ *         }
+ *       ],
+ *       "VpcId": "vpc-c1c5b3a3"
+ *     },
+ *     "DbInstancePort": 0,
+ *     "DbiResourceId": "db-VNZUCCBTEDC4WR7THXNJO72HVQ",
+ *     "DomainMemberships": [],
+ *     "Engine": "mysql",
+ *     "EngineVersion": "5.6.27",
+ *     "LicenseModel": "general-public-license",
+ *     "MasterUsername": "mymasteruser",
+ *     "MonitoringInterval": 0,
+ *     "MultiAZ": false,
+ *     "OptionGroupMemberships": [
+ *       {
+ *         "OptionGroupName": "default:mysql-5-6",
+ *         "Status": "in-sync"
+ *       }
+ *     ],
+ *     "PendingModifiedValues": {},
+ *     "PreferredBackupWindow": "12:58-13:28",
+ *     "PreferredMaintenanceWindow": "tue:10:16-tue:10:46",
+ *     "PubliclyAccessible": true,
+ *     "ReadReplicaDBInstanceIdentifiers": [],
+ *     "StorageEncrypted": false,
+ *     "StorageType": "gp2",
+ *     "VpcSecurityGroups": [
+ *       {
+ *         "Status": "active",
+ *         "VpcSecurityGroupId": "sg-e5e5b0d2"
+ *       }
+ *     ]
+ *   }
+ * }
+ * *\/
+ * // example id: to-restore-a-db-instance-from-a-db-snapshot-1473961657311
+ * ```
+ *
  */
 export declare class RestoreDBInstanceFromDBSnapshotCommand extends $Command<RestoreDBInstanceFromDBSnapshotCommandInput, RestoreDBInstanceFromDBSnapshotCommandOutput, RDSClientResolvedConfig> {
     readonly input: RestoreDBInstanceFromDBSnapshotCommandInput;

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

@@ -38,6 +38,100 @@ export interface RestoreDBInstanceToPointInTimeCommandOutput extends RestoreDBIn
  * @see {@link RestoreDBInstanceToPointInTimeCommandOutput} for command's `response` shape.
  * @see {@link RDSClientResolvedConfig | config} for RDSClient's `config` shape.
  *
+ * @example To restore a DB instance to a point in time.
+ * ```javascript
+ * // The following example restores a DB instance to a new DB instance at a point in time from the source DB instance.
+ * const input = {
+ *   "RestoreTime": "2016-09-13T18:45:00Z",
+ *   "SourceDBInstanceIdentifier": "mysql-sample",
+ *   "TargetDBInstanceIdentifier": "mysql-sample-restored"
+ * };
+ * const command = new RestoreDBInstanceToPointInTimeCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "DBInstance": {
+ *     "AllocatedStorage": 200,
+ *     "AutoMinorVersionUpgrade": true,
+ *     "AvailabilityZone": "us-west-2b",
+ *     "BackupRetentionPeriod": 7,
+ *     "CACertificateIdentifier": "rds-ca-2015",
+ *     "CopyTagsToSnapshot": false,
+ *     "DBInstanceArn": "arn:aws:rds:us-west-2:123456789012:db:mysql-sample-restored",
+ *     "DBInstanceClass": "db.t2.small",
+ *     "DBInstanceIdentifier": "mysql-sample-restored",
+ *     "DBInstanceStatus": "available",
+ *     "DBName": "sample",
+ *     "DBParameterGroups": [
+ *       {
+ *         "DBParameterGroupName": "default.mysql5.6",
+ *         "ParameterApplyStatus": "in-sync"
+ *       }
+ *     ],
+ *     "DBSecurityGroups": [],
+ *     "DBSubnetGroup": {
+ *       "DBSubnetGroupDescription": "default",
+ *       "DBSubnetGroupName": "default",
+ *       "SubnetGroupStatus": "Complete",
+ *       "Subnets": [
+ *         {
+ *           "SubnetAvailabilityZone": {
+ *             "Name": "us-west-2a"
+ *           },
+ *           "SubnetIdentifier": "subnet-77e8db03",
+ *           "SubnetStatus": "Active"
+ *         },
+ *         {
+ *           "SubnetAvailabilityZone": {
+ *             "Name": "us-west-2b"
+ *           },
+ *           "SubnetIdentifier": "subnet-c39989a1",
+ *           "SubnetStatus": "Active"
+ *         },
+ *         {
+ *           "SubnetAvailabilityZone": {
+ *             "Name": "us-west-2c"
+ *           },
+ *           "SubnetIdentifier": "subnet-4b267b0d",
+ *           "SubnetStatus": "Active"
+ *         }
+ *       ],
+ *       "VpcId": "vpc-c1c5b3a3"
+ *     },
+ *     "DbInstancePort": 0,
+ *     "DbiResourceId": "db-VNZUCCBTEDC4WR7THXNJO72HVQ",
+ *     "DomainMemberships": [],
+ *     "Engine": "mysql",
+ *     "EngineVersion": "5.6.27",
+ *     "LicenseModel": "general-public-license",
+ *     "MasterUsername": "mymasteruser",
+ *     "MonitoringInterval": 0,
+ *     "MultiAZ": false,
+ *     "OptionGroupMemberships": [
+ *       {
+ *         "OptionGroupName": "default:mysql-5-6",
+ *         "Status": "in-sync"
+ *       }
+ *     ],
+ *     "PendingModifiedValues": {},
+ *     "PreferredBackupWindow": "12:58-13:28",
+ *     "PreferredMaintenanceWindow": "tue:10:16-tue:10:46",
+ *     "PubliclyAccessible": true,
+ *     "ReadReplicaDBInstanceIdentifiers": [],
+ *     "StorageEncrypted": false,
+ *     "StorageType": "gp2",
+ *     "VpcSecurityGroups": [
+ *       {
+ *         "Status": "active",
+ *         "VpcSecurityGroupId": "sg-e5e5b0d2"
+ *       }
+ *     ]
+ *   }
+ * }
+ * *\/
+ * // example id: to-restore-a-db-instance-to-a-point-in-time-1473962652154
+ * ```
+ *
  */
 export declare class RestoreDBInstanceToPointInTimeCommand extends $Command<RestoreDBInstanceToPointInTimeCommandInput, RestoreDBInstanceToPointInTimeCommandOutput, RDSClientResolvedConfig> {
     readonly input: RestoreDBInstanceToPointInTimeCommandInput;

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

@@ -38,6 +38,23 @@ export interface RevokeDBSecurityGroupIngressCommandOutput extends RevokeDBSecur
  * @see {@link RevokeDBSecurityGroupIngressCommandOutput} for command's `response` shape.
  * @see {@link RDSClientResolvedConfig | config} for RDSClient's `config` shape.
  *
+ * @example To revoke ingress for a DB security group
+ * ```javascript
+ * // This example revokes ingress for the specified CIDR block associated with the specified DB security group.
+ * const input = {
+ *   "CIDRIP": "203.0.113.5/32",
+ *   "DBSecurityGroupName": "mydbsecuritygroup"
+ * };
+ * const command = new RevokeDBSecurityGroupIngressCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "DBSecurityGroup": {}
+ * }
+ * *\/
+ * // example id: revoke-db-security-group-ingress-ce5b2c1c-bd4e-4809-b04a-6d78ec448813
+ * ```
+ *
  */
 export declare class RevokeDBSecurityGroupIngressCommand extends $Command<RevokeDBSecurityGroupIngressCommandInput, RevokeDBSecurityGroupIngressCommandOutput, RDSClientResolvedConfig> {
     readonly input: RevokeDBSecurityGroupIngressCommandInput;

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.288.0",
+  "version": "3.289.0",
   "scripts": {
     "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
     "build:cjs": "tsc -p tsconfig.cjs.json",
@@ -20,40 +20,40 @@
   "dependencies": {
     "@aws-crypto/sha256-browser": "3.0.0",
     "@aws-crypto/sha256-js": "3.0.0",
-    "@aws-sdk/client-sts": "3.288.0",
-    "@aws-sdk/config-resolver": "3.287.0",
-    "@aws-sdk/credential-provider-node": "3.288.0",
-    "@aws-sdk/fetch-http-handler": "3.282.0",
-    "@aws-sdk/hash-node": "3.272.0",
-    "@aws-sdk/invalid-dependency": "3.272.0",
-    "@aws-sdk/middleware-content-length": "3.282.0",
-    "@aws-sdk/middleware-endpoint": "3.282.0",
-    "@aws-sdk/middleware-host-header": "3.282.0",
-    "@aws-sdk/middleware-logger": "3.288.0",
-    "@aws-sdk/middleware-recursion-detection": "3.282.0",
-    "@aws-sdk/middleware-retry": "3.287.0",
-    "@aws-sdk/middleware-sdk-rds": "3.282.0",
-    "@aws-sdk/middleware-serde": "3.272.0",
-    "@aws-sdk/middleware-signing": "3.282.0",
-    "@aws-sdk/middleware-stack": "3.272.0",
-    "@aws-sdk/middleware-user-agent": "3.282.0",
-    "@aws-sdk/node-config-provider": "3.287.0",
-    "@aws-sdk/node-http-handler": "3.282.0",
-    "@aws-sdk/protocol-http": "3.282.0",
-    "@aws-sdk/smithy-client": "3.279.0",
-    "@aws-sdk/types": "3.272.0",
-    "@aws-sdk/url-parser": "3.272.0",
+    "@aws-sdk/client-sts": "3.289.0",
+    "@aws-sdk/config-resolver": "3.289.0",
+    "@aws-sdk/credential-provider-node": "3.289.0",
+    "@aws-sdk/fetch-http-handler": "3.289.0",
+    "@aws-sdk/hash-node": "3.289.0",
+    "@aws-sdk/invalid-dependency": "3.289.0",
+    "@aws-sdk/middleware-content-length": "3.289.0",
+    "@aws-sdk/middleware-endpoint": "3.289.0",
+    "@aws-sdk/middleware-host-header": "3.289.0",
+    "@aws-sdk/middleware-logger": "3.289.0",
+    "@aws-sdk/middleware-recursion-detection": "3.289.0",
+    "@aws-sdk/middleware-retry": "3.289.0",
+    "@aws-sdk/middleware-sdk-rds": "3.289.0",
+    "@aws-sdk/middleware-serde": "3.289.0",
+    "@aws-sdk/middleware-signing": "3.289.0",
+    "@aws-sdk/middleware-stack": "3.289.0",
+    "@aws-sdk/middleware-user-agent": "3.289.0",
+    "@aws-sdk/node-config-provider": "3.289.0",
+    "@aws-sdk/node-http-handler": "3.289.0",
+    "@aws-sdk/protocol-http": "3.289.0",
+    "@aws-sdk/smithy-client": "3.289.0",
+    "@aws-sdk/types": "3.289.0",
+    "@aws-sdk/url-parser": "3.289.0",
     "@aws-sdk/util-base64": "3.208.0",
     "@aws-sdk/util-body-length-browser": "3.188.0",
     "@aws-sdk/util-body-length-node": "3.208.0",
-    "@aws-sdk/util-defaults-mode-browser": "3.279.0",
-    "@aws-sdk/util-defaults-mode-node": "3.287.0",
-    "@aws-sdk/util-endpoints": "3.272.0",
-    "@aws-sdk/util-retry": "3.272.0",
-    "@aws-sdk/util-user-agent-browser": "3.282.0",
-    "@aws-sdk/util-user-agent-node": "3.287.0",
+    "@aws-sdk/util-defaults-mode-browser": "3.289.0",
+    "@aws-sdk/util-defaults-mode-node": "3.289.0",
+    "@aws-sdk/util-endpoints": "3.289.0",
+    "@aws-sdk/util-retry": "3.289.0",
+    "@aws-sdk/util-user-agent-browser": "3.289.0",
+    "@aws-sdk/util-user-agent-node": "3.289.0",
     "@aws-sdk/util-utf8": "3.254.0",
-    "@aws-sdk/util-waiter": "3.272.0",
+    "@aws-sdk/util-waiter": "3.289.0",
     "fast-xml-parser": "4.1.2",
     "tslib": "^2.3.1"
   },