Skip to content

Commit

Permalink
docs(client-rds): Updates Amazon RDS documentation for corrections an…
Browse files Browse the repository at this point in the history
…d minor improvements.
  • Loading branch information
awstools committed Oct 5, 2023
1 parent 79d3bd7 commit d451b86
Show file tree
Hide file tree
Showing 6 changed files with 549 additions and 524 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -43,8 +43,8 @@ export interface CreateDBInstanceReadReplicaCommandOutput extends CreateDBInstan
* MySQL, MariaDB, Oracle, PostgreSQL, or SQL Server. You can create a read replica for a
* 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
* 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>
* <p>Amazon Aurora doesn't support this operation. Call the <code>CreateDBInstance</code>
* operation to create a DB instance for an Aurora DB cluster.</p>
* <p>Amazon Aurora doesn't support this operation. To create a DB instance for an Aurora DB cluster, use the <code>CreateDBInstance</code>
* operation.</p>
* <p>All read replica DB instances are created with backups disabled. All other attributes
* (including DB security groups and DB parameter groups) are inherited from the source DB
* instance or cluster, except as specified.</p>
Expand Down
20 changes: 10 additions & 10 deletions clients/client-rds/src/commands/DeleteDBInstanceCommand.ts
Original file line number Diff line number Diff line change
Expand Up @@ -37,12 +37,11 @@ export interface DeleteDBInstanceCommandOutput extends DeleteDBInstanceResult, _

/**
* @public
* <p>The DeleteDBInstance action deletes a previously provisioned DB instance.
* <p>Deletes a previously provisioned DB instance.
* When you delete a DB instance, all automated backups for that instance are deleted and can't be recovered.
* Manual DB snapshots of the DB instance to be deleted by <code>DeleteDBInstance</code> are not deleted.</p>
* <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. The API action <code>DescribeDBInstance</code>
* is used to monitor the status of this operation. The action can't be canceled or reverted once submitted.</p>
* However, manual DB snapshots of the DB instance aren't deleted.</p>
* <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.
* This operation can't be canceled or reverted after it begins. To monitor the status of this operation, use <code>DescribeDBInstance</code>.</p>
* <p>When a DB instance is in a failure state and has a status of <code>failed</code>, <code>incompatible-restore</code>,
* 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>
* <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
Expand All @@ -55,11 +54,12 @@ export interface DeleteDBInstanceCommandOutput extends DeleteDBInstanceResult, _
* <p>The DB instance is the only instance in the DB cluster.</p>
* </li>
* </ul>
* <p>To delete a DB instance in this case, first call the
* <code>PromoteReadReplicaDBCluster</code> API action to promote the DB cluster so
* it's no longer a read replica. After the promotion completes, then call the
* <code>DeleteDBInstance</code> API action to delete the final instance in the DB
* cluster.</p>
* <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.
* After the promotion completes, use the <code>DeleteDBInstance</code> operation to delete the final instance in the DB cluster.</p>
* <important>
* <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
* these resources before you delete the DB instance. Otherwise, deleting the DB instance and creation of the final snapshot might fail.</p>
* </important>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ export interface DescribeDBEngineVersionsCommandOutput extends DBEngineVersionMe

/**
* @public
* <p>Returns a list of the available DB engines.</p>
* <p>Describes the properties of specific versions of DB engines.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
Loading

0 comments on commit d451b86

Please sign in to comment.