Skip to content

Commit

Permalink
docs(client-rds): Updates Amazon RDS documentation with information u…
Browse files Browse the repository at this point in the history
…pgrading snapshots with unsupported engine versions for RDS for MySQL and RDS for PostgreSQL.
  • Loading branch information
awstools committed Sep 18, 2024
1 parent 13c3582 commit b08130e
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 1 deletion.
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,9 @@ export interface RestoreDBInstanceFromDBSnapshotCommandOutput
* DB instance with the DB instance created from the snapshot.</p>
* <p>If you are restoring from a shared manual DB snapshot, the <code>DBSnapshotIdentifier</code>
* must be the ARN of the shared DB snapshot.</p>
* <p>To restore from a DB snapshot with an unsupported engine version, you must first upgrade the
* engine version of the snapshot. For more information about upgrading a RDS for MySQL DB snapshot engine version, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/mysql-upgrade-snapshot.html">Upgrading a MySQL DB snapshot engine version</a>.
* For more information about upgrading a RDS for PostgreSQL DB snapshot engine version, <a href="https://docs.aws.amazon.com/USER_UpgradeDBSnapshot.PostgreSQL.html">Upgrading a PostgreSQL DB snapshot engine version</a>.</p>
* <note>
* <p>This command doesn't apply to Aurora MySQL and Aurora PostgreSQL. For Aurora, use <code>RestoreDBClusterFromSnapshot</code>.</p>
* </note>
Expand Down
2 changes: 1 addition & 1 deletion codegen/sdk-codegen/aws-models/rds.json
Original file line number Diff line number Diff line change
Expand Up @@ -27643,7 +27643,7 @@
}
],
"traits": {
"smithy.api#documentation": "<p>Creates a new DB instance from a DB snapshot. The target database is created from the source database restore point with most\n of the source's original configuration, including the default security group and DB parameter group. By default, the new DB\n instance is created as a Single-AZ deployment, except when the instance is a SQL Server instance that has an option group\n associated with mirroring. In this case, the instance becomes a Multi-AZ deployment, not a Single-AZ deployment.</p>\n <p>If you want to replace your original DB instance with the new, restored DB instance, then rename your original DB instance\n before you call the <code>RestoreDBInstanceFromDBSnapshot</code> operation. RDS doesn't allow two DB instances with the same name. After you\n have renamed your original DB instance with a different identifier, then you can pass the original name of the DB instance as\n the <code>DBInstanceIdentifier</code> in the call to the <code>RestoreDBInstanceFromDBSnapshot</code> operation. The result is that you replace the original\n DB instance with the DB instance created from the snapshot.</p>\n <p>If you are restoring from a shared manual DB snapshot, the <code>DBSnapshotIdentifier</code>\n must be the ARN of the shared DB snapshot.</p>\n <note>\n <p>This command doesn't apply to Aurora MySQL and Aurora PostgreSQL. For Aurora, use <code>RestoreDBClusterFromSnapshot</code>.</p>\n </note>",
"smithy.api#documentation": "<p>Creates a new DB instance from a DB snapshot. The target database is created from the source database restore point with most\n of the source's original configuration, including the default security group and DB parameter group. By default, the new DB\n instance is created as a Single-AZ deployment, except when the instance is a SQL Server instance that has an option group\n associated with mirroring. In this case, the instance becomes a Multi-AZ deployment, not a Single-AZ deployment.</p>\n <p>If you want to replace your original DB instance with the new, restored DB instance, then rename your original DB instance\n before you call the <code>RestoreDBInstanceFromDBSnapshot</code> operation. RDS doesn't allow two DB instances with the same name. After you\n have renamed your original DB instance with a different identifier, then you can pass the original name of the DB instance as\n the <code>DBInstanceIdentifier</code> in the call to the <code>RestoreDBInstanceFromDBSnapshot</code> operation. The result is that you replace the original\n DB instance with the DB instance created from the snapshot.</p>\n <p>If you are restoring from a shared manual DB snapshot, the <code>DBSnapshotIdentifier</code>\n must be the ARN of the shared DB snapshot.</p>\n <p>To restore from a DB snapshot with an unsupported engine version, you must first upgrade the \n engine version of the snapshot. For more information about upgrading a RDS for MySQL DB snapshot engine version, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/mysql-upgrade-snapshot.html\">Upgrading a MySQL DB snapshot engine version</a>. \n For more information about upgrading a RDS for PostgreSQL DB snapshot engine version, <a href=\"https://docs.aws.amazon.com/USER_UpgradeDBSnapshot.PostgreSQL.html\">Upgrading a PostgreSQL DB snapshot engine version</a>.</p>\n <note>\n <p>This command doesn't apply to Aurora MySQL and Aurora PostgreSQL. For Aurora, use <code>RestoreDBClusterFromSnapshot</code>.</p>\n </note>",
"smithy.api#examples": [
{
"title": "To restore a DB instance from a DB snapshot",
Expand Down

0 comments on commit b08130e

Please sign in to comment.