@aws-sdk/client-rds 3.306.0 → 3.309.0

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

@@ -171,22 +171,67 @@ export interface RestoreDBClusterFromSnapshotCommandOutput extends RestoreDBClus
  *             available across all DB instances.</p>
  *
  *
- * @example To restore an Amazon Aurora DB cluster from a DB cluster snapshot
+ * @example To restore a DB cluster from a snapshot
  * ```javascript
- * // The following example restores an Amazon Aurora DB cluster from a DB cluster snapshot.
+ * // The following example restores an Aurora PostgreSQL DB cluster compatible with PostgreSQL version 10.7 from a DB cluster snapshot named test-instance-snapshot.
  * const input = {
- *   "DBClusterIdentifier": "restored-cluster1",
- *   "Engine": "aurora",
- *   "SnapshotIdentifier": "sample-cluster-snapshot1"
+ *   "DBClusterIdentifier": "newdbcluster",
+ *   "Engine": "aurora-postgresql",
+ *   "EngineVersion": "10.7",
+ *   "SnapshotIdentifier": "test-instance-snapshot"
  * };
  * const command = new RestoreDBClusterFromSnapshotCommand(input);
  * const response = await client.send(command);
  * /* response ==
  * {
- *   "DBCluster": {}
+ *   "DBCluster": {
+ *     "AllocatedStorage": 1,
+ *     "AssociatedRoles": [],
+ *     "AvailabilityZones": [
+ *       "us-west-2c",
+ *       "us-west-2a",
+ *       "us-west-2b"
+ *     ],
+ *     "BackupRetentionPeriod": 7,
+ *     "ClusterCreateTime": "2020-06-05T15:06:58.634Z",
+ *     "CopyTagsToSnapshot": false,
+ *     "CrossAccountClone": false,
+ *     "DBClusterArn": "arn:aws:rds:us-west-2:123456789012:cluster:newdbcluster",
+ *     "DBClusterIdentifier": "newdbcluster",
+ *     "DBClusterMembers": [],
+ *     "DBClusterParameterGroup": "default.aurora-postgresql10",
+ *     "DBSubnetGroup": "default",
+ *     "DatabaseName": "",
+ *     "DbClusterResourceId": "cluster-5DSB5IFQDDUVAWOUWM1EXAMPLE",
+ *     "DeletionProtection": false,
+ *     "DomainMemberships": [],
+ *     "Endpoint": "newdbcluster.cluster-############.us-west-2.rds.amazonaws.com",
+ *     "Engine": "aurora-postgresql",
+ *     "EngineMode": "provisioned",
+ *     "EngineVersion": "10.7",
+ *     "HostedZoneId": "Z1PVIF0EXAMPLE",
+ *     "HttpEndpointEnabled": false,
+ *     "IAMDatabaseAuthenticationEnabled": false,
+ *     "KmsKeyId": "arn:aws:kms:us-west-2:123456789012:key/287364e4-33e3-4755-a3b0-a1b2c3d4e5f6",
+ *     "MasterUsername": "postgres",
+ *     "MultiAZ": false,
+ *     "Port": 5432,
+ *     "PreferredBackupWindow": "09:33-10:03",
+ *     "PreferredMaintenanceWindow": "sun:12:22-sun:12:52",
+ *     "ReadReplicaIdentifiers": [],
+ *     "ReaderEndpoint": "newdbcluster.cluster-ro-############.us-west-2.rds.amazonaws.com",
+ *     "Status": "creating",
+ *     "StorageEncrypted": true,
+ *     "VpcSecurityGroups": [
+ *       {
+ *         "Status": "active",
+ *         "VpcSecurityGroupId": "sg-########"
+ *       }
+ *     ]
+ *   }
  * }
  * *\/
- * // example id: to-restore-an-amazon-aurora-db-cluster-from-a-db-cluster-snapshot-1473958144325
+ * // example id: to-restore-a-db-cluster-from-a-snapshot-1680069287853
  * ```
  *
  */

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

@@ -169,22 +169,67 @@ export interface RestoreDBClusterToPointInTimeCommandOutput extends RestoreDBClu
  *             available across all DB instances.</p>
  *
  *
- * @example To restore a DB cluster to a point in time.
+ * @example To restore a DB cluster to a specified time
  * ```javascript
- * // The following example restores a DB cluster to a new DB cluster at a point in time from the source DB cluster.
+ * // The following example restores the DB cluster named database-4 to the latest possible time. Using copy-on-write as the restore type restores the new DB cluster as a clone of the source DB cluster.
  * const input = {
- *   "DBClusterIdentifier": "sample-restored-cluster1",
- *   "RestoreToTime": "2016-09-13T18:45:00Z",
- *   "SourceDBClusterIdentifier": "sample-cluster1"
+ *   "DBClusterIdentifier": "sample-cluster-clone",
+ *   "RestoreType": "copy-on-write",
+ *   "SourceDBClusterIdentifier": "database-4",
+ *   "UseLatestRestorableTime": true
  * };
  * const command = new RestoreDBClusterToPointInTimeCommand(input);
  * const response = await client.send(command);
  * /* response ==
  * {
- *   "DBCluster": {}
+ *   "DBCluster": {
+ *     "AllocatedStorage": 1,
+ *     "AssociatedRoles": [],
+ *     "AvailabilityZones": [
+ *       "us-west-2c",
+ *       "us-west-2a",
+ *       "us-west-2b"
+ *     ],
+ *     "BackupRetentionPeriod": 7,
+ *     "CloneGroupId": "8d19331a-099a-45a4-b4aa-11aa22bb33cc44dd",
+ *     "ClusterCreateTime": "2020-03-10T19:57:38.967Z",
+ *     "CopyTagsToSnapshot": false,
+ *     "CrossAccountClone": false,
+ *     "DBClusterArn": "arn:aws:rds:us-west-2:123456789012:cluster:sample-cluster-clone",
+ *     "DBClusterIdentifier": "sample-cluster-clone",
+ *     "DBClusterMembers": [],
+ *     "DBClusterParameterGroup": "default.aurora-postgresql10",
+ *     "DBSubnetGroup": "default",
+ *     "DatabaseName": "",
+ *     "DbClusterResourceId": "cluster-BIZ77GDSA2XBSTNPFW1EXAMPLE",
+ *     "DeletionProtection": false,
+ *     "Endpoint": "sample-cluster-clone.cluster-############.us-west-2.rds.amazonaws.com",
+ *     "Engine": "aurora-postgresql",
+ *     "EngineMode": "provisioned",
+ *     "EngineVersion": "10.7",
+ *     "HostedZoneId": "Z1PVIF0EXAMPLE",
+ *     "HttpEndpointEnabled": false,
+ *     "IAMDatabaseAuthenticationEnabled": false,
+ *     "KmsKeyId": "arn:aws:kms:us-west-2:123456789012:key/287364e4-33e3-4755-a3b0-a1b2c3d4e5f6",
+ *     "MasterUsername": "postgres",
+ *     "MultiAZ": false,
+ *     "Port": 5432,
+ *     "PreferredBackupWindow": "09:33-10:03",
+ *     "PreferredMaintenanceWindow": "sun:12:22-sun:12:52",
+ *     "ReadReplicaIdentifiers": [],
+ *     "ReaderEndpoint": "sample-cluster-clone.cluster-ro-############.us-west-2.rds.amazonaws.com",
+ *     "Status": "creating",
+ *     "StorageEncrypted": true,
+ *     "VpcSecurityGroups": [
+ *       {
+ *         "Status": "active",
+ *         "VpcSecurityGroupId": "sg-########"
+ *       }
+ *     ]
+ *   }
  * }
  * *\/
- * // example id: to-restore-a-db-cluster-to-a-point-in-time-1473962082214
+ * // example id: to-restore-a-db-cluster-to-a-specified-time-1680069105508
  * ```
  *
  */

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

@@ -181,97 +181,39 @@ export interface RestoreDBInstanceFromDBSnapshotCommandOutput extends RestoreDBI
  *             with the DB instance.</p>
  *
  *
- * @example To restore a DB instance from a DB snapshot.
+ * @example To restore a DB instance from a DB snapshot
  * ```javascript
- * // The following example restores a DB instance from a DB snapshot.
+ * // The following example creates a new DB instance named db7-new-instance with the db.t3.small DB instance class from the specified DB snapshot. The source DB instance from which the snapshot was taken uses a deprecated DB instance class, so you can't upgrade it.
  * const input = {
- *   "DBInstanceIdentifier": "mysqldb-restored",
- *   "DBSnapshotIdentifier": "rds:mysqldb-2014-04-22-08-15"
+ *   "DBInstanceClass": "db.t3.small",
+ *   "DBInstanceIdentifier": "db7-new-instance",
+ *   "DBSnapshotIdentifier": "db7-test-snapshot"
  * };
  * const command = new RestoreDBInstanceFromDBSnapshotCommand(input);
  * const response = await client.send(command);
  * /* response ==
  * {
  *   "DBInstance": {
- *     "AllocatedStorage": 200,
+ *     "AssociatedRoles": [],
  *     "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": [],
+ *     "DBInstanceArn": "arn:aws:rds:us-west-2:123456789012:db:db7-new-instance",
+ *     "DBInstanceClass": "db.t3.small",
+ *     "DBInstanceIdentifier": "db7-new-instance",
+ *     "DBInstanceStatus": "creating",
+ *     "DeletionProtection": false,
  *     "Engine": "mysql",
- *     "EngineVersion": "5.6.27",
+ *     "EngineVersion": "5.7.22",
+ *     "IAMDatabaseAuthenticationEnabled": false,
  *     "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"
- *       }
- *     ]
+ *     "PerformanceInsightsEnabled": false,
+ *     "PreferredMaintenanceWindow": "mon:07:37-mon:08:07",
+ *     "ReadReplicaDBInstanceIdentifiers": []
  *   }
  * }
  * *\/
- * // example id: to-restore-a-db-instance-from-a-db-snapshot-1473961657311
+ * // example id: to-restore-a-db-instance-from-a-db-snapshot-1680093236214
  * ```
  *
  */

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

@@ -186,13 +186,13 @@ export interface RestoreDBInstanceToPointInTimeCommandOutput extends RestoreDBIn
  *             with the DB instance.</p>
  *
  *
- * @example To restore a DB instance to a point in time.
+ * @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.
+ * // The following example restores test-instance to a new DB instance named restored-test-instance, as of the specified time.
  * const input = {
- *   "RestoreTime": "2016-09-13T18:45:00Z",
- *   "SourceDBInstanceIdentifier": "mysql-sample",
- *   "TargetDBInstanceIdentifier": "mysql-sample-restored"
+ *   "RestoreTime": "2018-07-30T23:45:00.000Z",
+ *   "SourceDBInstanceIdentifier": "test-instance",
+ *   "TargetDBInstanceIdentifier": "restored-test-instance"
  * };
  * const command = new RestoreDBInstanceToPointInTimeCommand(input);
  * const response = await client.send(command);
@@ -205,9 +205,9 @@ export interface RestoreDBInstanceToPointInTimeCommandOutput extends RestoreDBIn
  *     "BackupRetentionPeriod": 7,
  *     "CACertificateIdentifier": "rds-ca-2015",
  *     "CopyTagsToSnapshot": false,
- *     "DBInstanceArn": "arn:aws:rds:us-west-2:123456789012:db:mysql-sample-restored",
+ *     "DBInstanceArn": "arn:aws:rds:us-west-2:123456789012:db:restored-test-instance",
  *     "DBInstanceClass": "db.t2.small",
- *     "DBInstanceIdentifier": "mysql-sample-restored",
+ *     "DBInstanceIdentifier": "restored-test-instance",
  *     "DBInstanceStatus": "available",
  *     "DBName": "sample",
  *     "DBParameterGroups": [
@@ -277,7 +277,7 @@ export interface RestoreDBInstanceToPointInTimeCommandOutput extends RestoreDBIn
  *   }
  * }
  * *\/
- * // example id: to-restore-a-db-instance-to-a-point-in-time-1473962652154
+ * // example id: to-restore-a-db-instance-to-a-point-in-time-1680036021951
  * ```
  *
  */

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

@@ -71,6 +71,29 @@ export interface StartActivityStreamCommandOutput extends StartActivityStreamRes
  *  <p>The specified resource ID was not found.</p>
  *
  *
+ * @example To start a database activity stream
+ * ```javascript
+ * // The following example starts an asynchronous activity stream to monitor an Aurora cluster named my-pg-cluster.
+ * const input = {
+ *   "ApplyImmediately": true,
+ *   "KmsKeyId": "arn:aws:kms:us-east-1:1234567890123:key/a12c345d-6ef7-890g-h123-456i789jk0l1",
+ *   "Mode": "async",
+ *   "ResourceArn": "arn:aws:rds:us-east-1:1234567890123:cluster:my-pg-cluster"
+ * };
+ * const command = new StartActivityStreamCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "ApplyImmediately": true,
+ *   "KinesisStreamName": "aws-rds-das-cluster-0ABCDEFGHI1JKLM2NOPQ3R4S",
+ *   "KmsKeyId": "arn:aws:kms:us-east-1:1234567890123:key/a12c345d-6ef7-890g-h123-456i789jk0l1",
+ *   "Mode": "async",
+ *   "Status": "starting"
+ * }
+ * *\/
+ * // example id: to-start-a-database-activity-stream-1680035656463
+ * ```
+ *
  */
 export declare class StartActivityStreamCommand extends $Command<StartActivityStreamCommandInput, StartActivityStreamCommandOutput, RDSClientResolvedConfig> {
     readonly input: StartActivityStreamCommandInput;

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

@@ -57,6 +57,32 @@ export interface StartDBClusterCommandOutput extends StartDBClusterResult, __Met
  *  <p>The DB instance isn't in a valid state.</p>
  *
  *
+ * @example To start a DB cluster
+ * ```javascript
+ * // The following example starts a DB cluster and its DB instances.
+ * const input = {
+ *   "DBClusterIdentifier": "mydbcluster"
+ * };
+ * const command = new StartDBClusterCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "DBCluster": {
+ *     "AllocatedStorage": 1,
+ *     "AvailabilityZones": [
+ *       "us-east-1a",
+ *       "us-east-1e",
+ *       "us-east-1b"
+ *     ],
+ *     "BackupRetentionPeriod": 1,
+ *     "DBClusterIdentifier": "mydbcluster",
+ *     "DatabaseName": "mydb"
+ *   }
+ * }
+ * *\/
+ * // example id: to-start-a-db-cluster-1680035521632
+ * ```
+ *
  */
 export declare class StartDBClusterCommand extends $Command<StartDBClusterCommandInput, StartDBClusterCommandOutput, RDSClientResolvedConfig> {
     readonly input: StartDBClusterCommandInput;

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

@@ -66,6 +66,43 @@ export interface StartDBInstanceAutomatedBackupsReplicationCommandOutput extends
  *             with the DB instance.</p>
  *
  *
+ * @example To enable cross-Region automated backups
+ * ```javascript
+ * // The following example replicates automated backups from a DB instance in the US East (N. Virginia) Region. The backup retention period is 14 days.
+ * const input = {
+ *   "BackupRetentionPeriod": 14,
+ *   "SourceDBInstanceArn": "arn:aws:rds:us-east-1:123456789012:db:new-orcl-db"
+ * };
+ * const command = new StartDBInstanceAutomatedBackupsReplicationCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "DBInstanceAutomatedBackup": {
+ *     "AllocatedStorage": 20,
+ *     "BackupRetentionPeriod": 14,
+ *     "DBInstanceArn": "arn:aws:rds:us-east-1:123456789012:db:new-orcl-db",
+ *     "DBInstanceAutomatedBackupsArn": "arn:aws:rds:us-west-2:123456789012:auto-backup:ab-jkib2gfq5rv7replzadausbrktni2bn4example",
+ *     "DBInstanceIdentifier": "new-orcl-db",
+ *     "DbiResourceId": "db-JKIB2GFQ5RV7REPLZA4EXAMPLE",
+ *     "Encrypted": false,
+ *     "Engine": "oracle-se2",
+ *     "EngineVersion": "12.1.0.2.v21",
+ *     "IAMDatabaseAuthenticationEnabled": false,
+ *     "InstanceCreateTime": "2020-12-04T15:28:31Z",
+ *     "LicenseModel": "bring-your-own-license",
+ *     "MasterUsername": "admin",
+ *     "OptionGroupName": "default:oracle-se2-12-1",
+ *     "Port": 1521,
+ *     "Region": "us-east-1",
+ *     "RestoreWindow": {},
+ *     "Status": "pending",
+ *     "StorageType": "gp2"
+ *   }
+ * }
+ * *\/
+ * // example id: to-enable-cross-region-automated-backups-1680033438352
+ * ```
+ *
  */
 export declare class StartDBInstanceAutomatedBackupsReplicationCommand extends $Command<StartDBInstanceAutomatedBackupsReplicationCommandInput, StartDBInstanceAutomatedBackupsReplicationCommandOutput, RDSClientResolvedConfig> {
     readonly input: StartDBInstanceAutomatedBackupsReplicationCommandInput;

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

@@ -90,6 +90,24 @@ export interface StartDBInstanceCommandOutput extends StartDBInstanceResult, __M
  *  <p>An error occurred accessing an Amazon Web Services KMS key.</p>
  *
  *
+ * @example To start a DB instance
+ * ```javascript
+ * // The following example starts the specified DB instance.
+ * const input = {
+ *   "DBInstanceIdentifier": "test-instance"
+ * };
+ * const command = new StartDBInstanceCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "DBInstance": {
+ *     "DBInstanceStatus": "starting"
+ *   }
+ * }
+ * *\/
+ * // example id: to-start-a-db-instance-1679951967681
+ * ```
+ *
  */
 export declare class StartDBInstanceCommand extends $Command<StartDBInstanceCommandInput, StartDBInstanceCommandOutput, RDSClientResolvedConfig> {
     readonly input: StartDBInstanceCommandInput;

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

@@ -94,6 +94,34 @@ export interface StartExportTaskCommandOutput extends ExportTask, __MetadataBear
  *  <p>An error occurred accessing an Amazon Web Services KMS key.</p>
  *
  *
+ * @example To export a snapshot to Amazon S3
+ * ```javascript
+ * // The following example exports a DB snapshot named db5-snapshot-test to the Amazon S3 bucket named mybucket.
+ * const input = {
+ *   "ExportTaskIdentifier": "my-s3-export",
+ *   "IamRoleArn": "arn:aws:iam::123456789012:role/service-role/ExportRole",
+ *   "KmsKeyId": "arn:aws:kms:us-west-2:123456789012:key/abcd0000-7fca-4128-82f2-aabbccddeeff",
+ *   "S3BucketName": "mybucket",
+ *   "SourceArn": "arn:aws:rds:us-west-2:123456789012:snapshot:db5-snapshot-test"
+ * };
+ * const command = new StartExportTaskCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "ExportTaskIdentifier": "my-s3-export",
+ *   "IamRoleArn": "arn:aws:iam::123456789012:role/service-role/ExportRole",
+ *   "KmsKeyId": "arn:aws:kms:us-west-2:123456789012:key/abcd0000-7fca-4128-82f2-aabbccddeeff",
+ *   "PercentProgress": 0,
+ *   "S3Bucket": "mybucket",
+ *   "SnapshotTime": "2020-03-27T20:48:42.023Z",
+ *   "SourceArn": "arn:aws:rds:us-west-2:123456789012:snapshot:db5-snapshot-test",
+ *   "Status": "STARTING",
+ *   "TotalExtractedDataInGB": 0
+ * }
+ * *\/
+ * // example id: to-export-a-snapshot-to-amazon-s3-1679950669718
+ * ```
+ *
  */
 export declare class StartExportTaskCommand extends $Command<StartExportTaskCommandInput, StartExportTaskCommandOutput, RDSClientResolvedConfig> {
     readonly input: StartExportTaskCommandInput;

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

@@ -66,6 +66,25 @@ export interface StopActivityStreamCommandOutput extends StopActivityStreamRespo
  *  <p>The specified resource ID was not found.</p>
  *
  *
+ * @example To stop a database activity stream
+ * ```javascript
+ * // The following example stops an activity stream in an Aurora cluster named my-pg-cluster.
+ * const input = {
+ *   "ApplyImmediately": true,
+ *   "ResourceArn": "arn:aws:rds:us-east-1:1234567890123:cluster:my-pg-cluster"
+ * };
+ * const command = new StopActivityStreamCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "KinesisStreamName": "aws-rds-das-cluster-0ABCDEFGHI1JKLM2NOPQ3R4S",
+ *   "KmsKeyId": "arn:aws:kms:us-east-1:1234567890123:key/a12c345d-6ef7-890g-h123-456i789jk0l1",
+ *   "Status": "stopping"
+ * }
+ * *\/
+ * // example id: to-stop-a-database-activity-stream-1679945843823
+ * ```
+ *
  */
 export declare class StopActivityStreamCommand extends $Command<StopActivityStreamCommandInput, StopActivityStreamCommandOutput, RDSClientResolvedConfig> {
     readonly input: StopActivityStreamCommandInput;

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

@@ -58,6 +58,32 @@ export interface StopDBClusterCommandOutput extends StopDBClusterResult, __Metad
  *  <p>The DB instance isn't in a valid state.</p>
  *
  *
+ * @example To stop a DB cluster
+ * ```javascript
+ * // The following example stops a DB cluster and its DB instances.
+ * const input = {
+ *   "DBClusterIdentifier": "mydbcluster"
+ * };
+ * const command = new StopDBClusterCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "DBCluster": {
+ *     "AllocatedStorage": 1,
+ *     "AvailabilityZones": [
+ *       "us-east-1a",
+ *       "us-east-1e",
+ *       "us-east-1b"
+ *     ],
+ *     "BackupRetentionPeriod": 1,
+ *     "DBClusterIdentifier": "mydbcluster",
+ *     "DatabaseName": "mydb"
+ *   }
+ * }
+ * *\/
+ * // example id: to-stop-a-db-cluster-1679701988603
+ * ```
+ *
  */
 export declare class StopDBClusterCommand extends $Command<StopDBClusterCommandInput, StopDBClusterCommandOutput, RDSClientResolvedConfig> {
     readonly input: StopDBClusterCommandInput;

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

@@ -51,6 +51,45 @@ export interface StopDBInstanceAutomatedBackupsReplicationCommandOutput extends
  *  <p>The DB instance isn't in a valid state.</p>
  *
  *
+ * @example To stop replicating automated backups
+ * ```javascript
+ * // The following example ends replication of automated backups. Replicated backups are retained according to the set backup retention period.
+ * const input = {
+ *   "SourceDBInstanceArn": "arn:aws:rds:us-east-1:123456789012:db:new-orcl-db"
+ * };
+ * const command = new StopDBInstanceAutomatedBackupsReplicationCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "DBInstanceAutomatedBackup": {
+ *     "AllocatedStorage": 20,
+ *     "BackupRetentionPeriod": 7,
+ *     "DBInstanceArn": "arn:aws:rds:us-east-1:123456789012:db:new-orcl-db",
+ *     "DBInstanceAutomatedBackupsArn": "arn:aws:rds:us-west-2:123456789012:auto-backup:ab-jkib2gfq5rv7replzadausbrktni2bn4example",
+ *     "DBInstanceIdentifier": "new-orcl-db",
+ *     "DbiResourceId": "db-JKIB2GFQ5RV7REPLZA4EXAMPLE",
+ *     "Encrypted": false,
+ *     "Engine": "oracle-se2",
+ *     "EngineVersion": "12.1.0.2.v21",
+ *     "IAMDatabaseAuthenticationEnabled": false,
+ *     "InstanceCreateTime": "2020-12-04T15:28:31Z",
+ *     "LicenseModel": "bring-your-own-license",
+ *     "MasterUsername": "admin",
+ *     "OptionGroupName": "default:oracle-se2-12-1",
+ *     "Port": 1521,
+ *     "Region": "us-east-1",
+ *     "RestoreWindow": {
+ *       "EarliestTime": "2020-12-04T23:13:21.030Z",
+ *       "LatestTime": "2020-12-07T19:59:57Z"
+ *     },
+ *     "Status": "replicating",
+ *     "StorageType": "gp2"
+ *   }
+ * }
+ * *\/
+ * // example id: to-stop-replicating-automated-backups-1679701787115
+ * ```
+ *
  */
 export declare class StopDBInstanceAutomatedBackupsReplicationCommand extends $Command<StopDBInstanceAutomatedBackupsReplicationCommandInput, StopDBInstanceAutomatedBackupsReplicationCommandOutput, RDSClientResolvedConfig> {
     readonly input: StopDBInstanceAutomatedBackupsReplicationCommandInput;

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

@@ -70,6 +70,24 @@ export interface StopDBInstanceCommandOutput extends StopDBInstanceResult, __Met
  *             snapshots.</p>
  *
  *
+ * @example To stop a DB instance
+ * ```javascript
+ * // The following example stops the specified DB instance.
+ * const input = {
+ *   "DBInstanceIdentifier": "test-instance"
+ * };
+ * const command = new StopDBInstanceCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "DBInstance": {
+ *     "DBInstanceStatus": "stopping"
+ *   }
+ * }
+ * *\/
+ * // example id: to-stop-a-db-instance-1679701630959
+ * ```
+ *
  */
 export declare class StopDBInstanceCommand extends $Command<StopDBInstanceCommandInput, StopDBInstanceCommandOutput, RDSClientResolvedConfig> {
     readonly input: StopDBInstanceCommandInput;