Skip to content

Commit d451b86

Browse files
author
awstools
committed
docs(client-rds): Updates Amazon RDS documentation for corrections and minor improvements.
1 parent 79d3bd7 commit d451b86

File tree

6 files changed

+549
-524
lines changed

6 files changed

+549
-524
lines changed

clients/client-rds/src/commands/CreateDBInstanceReadReplicaCommand.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -43,8 +43,8 @@ export interface CreateDBInstanceReadReplicaCommandOutput extends CreateDBInstan
4343
* MySQL, MariaDB, Oracle, PostgreSQL, or SQL Server. You can create a read replica for a
4444
* Multi-AZ DB cluster running MySQL or PostgreSQL. For more information, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_ReadRepl.html">Working
4545
* with read replicas</a> and <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html#multi-az-db-clusters-migrating-to-instance-with-read-replica">Migrating from a Multi-AZ DB cluster to a DB instance using a read replica</a> in the <i>Amazon RDS User Guide</i>.</p>
46-
* <p>Amazon Aurora doesn't support this operation. Call the <code>CreateDBInstance</code>
47-
* operation to create a DB instance for an Aurora DB cluster.</p>
46+
* <p>Amazon Aurora doesn't support this operation. To create a DB instance for an Aurora DB cluster, use the <code>CreateDBInstance</code>
47+
* operation.</p>
4848
* <p>All read replica DB instances are created with backups disabled. All other attributes
4949
* (including DB security groups and DB parameter groups) are inherited from the source DB
5050
* instance or cluster, except as specified.</p>

clients/client-rds/src/commands/DeleteDBInstanceCommand.ts

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -37,12 +37,11 @@ export interface DeleteDBInstanceCommandOutput extends DeleteDBInstanceResult, _
3737

3838
/**
3939
* @public
40-
* <p>The DeleteDBInstance action deletes a previously provisioned DB instance.
40+
* <p>Deletes a previously provisioned DB instance.
4141
* When you delete a DB instance, all automated backups for that instance are deleted and can't be recovered.
42-
* Manual DB snapshots of the DB instance to be deleted by <code>DeleteDBInstance</code> are not deleted.</p>
43-
* <p>If you request a final DB snapshot
44-
* the status of the Amazon RDS DB instance is <code>deleting</code> until the DB snapshot is created. The API action <code>DescribeDBInstance</code>
45-
* is used to monitor the status of this operation. The action can't be canceled or reverted once submitted.</p>
42+
* However, manual DB snapshots of the DB instance aren't deleted.</p>
43+
* <p>If you request a final DB snapshot, the status of the Amazon RDS DB instance is <code>deleting</code> until the DB snapshot is created.
44+
* This operation can't be canceled or reverted after it begins. To monitor the status of this operation, use <code>DescribeDBInstance</code>.</p>
4645
* <p>When a DB instance is in a failure state and has a status of <code>failed</code>, <code>incompatible-restore</code>,
4746
* or <code>incompatible-network</code>, you can only delete it when you skip creation of the final snapshot with the <code>SkipFinalSnapshot</code> parameter.</p>
4847
* <p>If the specified DB instance is part of an Amazon Aurora DB cluster, you can't delete the DB instance if both of the following
@@ -55,11 +54,12 @@ export interface DeleteDBInstanceCommandOutput extends DeleteDBInstanceResult, _
5554
* <p>The DB instance is the only instance in the DB cluster.</p>
5655
* </li>
5756
* </ul>
58-
* <p>To delete a DB instance in this case, first call the
59-
* <code>PromoteReadReplicaDBCluster</code> API action to promote the DB cluster so
60-
* it's no longer a read replica. After the promotion completes, then call the
61-
* <code>DeleteDBInstance</code> API action to delete the final instance in the DB
62-
* cluster.</p>
57+
* <p>To delete a DB instance in this case, first use the <code>PromoteReadReplicaDBCluster</code> operation to promote the DB cluster so that it's no longer a read replica.
58+
* After the promotion completes, use the <code>DeleteDBInstance</code> operation to delete the final instance in the DB cluster.</p>
59+
* <important>
60+
* <p>For RDS Custom DB instances, deleting the DB instance permanently deletes the EC2 instance and the associated EBS volumes. Make sure that you don't terminate or delete
61+
* these resources before you delete the DB instance. Otherwise, deleting the DB instance and creation of the final snapshot might fail.</p>
62+
* </important>
6363
* @example
6464
* Use a bare-bones client and the command you need to make an API call.
6565
* ```javascript

clients/client-rds/src/commands/DescribeDBEngineVersionsCommand.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ export interface DescribeDBEngineVersionsCommandOutput extends DBEngineVersionMe
3838

3939
/**
4040
* @public
41-
* <p>Returns a list of the available DB engines.</p>
41+
* <p>Describes the properties of specific versions of DB engines.</p>
4242
* @example
4343
* Use a bare-bones client and the command you need to make an API call.
4444
* ```javascript

0 commit comments

Comments
 (0)