Skip to content

Commit 4e29ba7

Browse files
author
awstools
committed
docs(client-rds): Updates Amazon RDS documentation to clarify the RestoreDBClusterToPointInTime description.
1 parent 444cdc9 commit 4e29ba7

File tree

3 files changed

+30
-36
lines changed

3 files changed

+30
-36
lines changed

clients/client-rds/src/models/models_0.ts

Lines changed: 0 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -5067,15 +5067,6 @@ export interface CreateDBClusterMessage {
50675067
* <p>When enabled, the HTTP endpoint provides a connectionless web service API (RDS Data API) for running
50685068
* SQL queries on the DB cluster. You can also query your database
50695069
* from inside the RDS console with the RDS query editor.</p>
5070-
* <p>RDS Data API is supported with the following DB clusters:</p>
5071-
* <ul>
5072-
* <li>
5073-
* <p>Aurora PostgreSQL Serverless v2 and provisioned</p>
5074-
* </li>
5075-
* <li>
5076-
* <p>Aurora PostgreSQL and Aurora MySQL Serverless v1</p>
5077-
* </li>
5078-
* </ul>
50795070
* <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/data-api.html">Using RDS Data API</a> in the
50805071
* <i>Amazon Aurora User Guide</i>.</p>
50815072
* <p>Valid for Cluster Type: Aurora DB clusters only</p>

clients/client-rds/src/models/models_1.ts

Lines changed: 26 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -8800,17 +8800,18 @@ export interface ModifyDBInstanceMessage {
88008800
* unless the <code>ApplyImmediately</code> parameter is enabled for this request.
88018801
* If you are migrating from Provisioned IOPS to standard storage, set this value to 0.
88028802
* The DB instance will require a reboot for the change in storage type to take effect.</p>
8803-
* <p>If you choose to migrate your DB instance from using standard storage to using
8804-
* Provisioned IOPS, or from using Provisioned IOPS to using standard storage, the process
8805-
* can take time. The duration of the migration depends on several factors such as database
8806-
* load, storage size, storage type (standard or Provisioned IOPS), amount of IOPS
8807-
* provisioned (if any), and the number of prior scale storage operations. Typical
8808-
* migration times are under 24 hours, but the process can take up to several days in some
8809-
* cases. During the migration, the DB instance is available for use, but might experience
8810-
* performance degradation. While the migration takes place, nightly backups for the
8811-
* instance are suspended. No other Amazon RDS operations can take place for the instance,
8812-
* including modifying the instance, rebooting the instance, deleting the instance,
8813-
* creating a read replica for the instance, and creating a DB snapshot of the instance.</p>
8803+
* <p>If you choose to migrate your DB instance from using standard storage to Provisioned
8804+
* IOPS (io1), or from Provisioned IOPS to standard storage, the process can take time. The
8805+
* duration of the migration depends on several factors such as database load, storage
8806+
* size, storage type (standard or Provisioned IOPS), amount of IOPS provisioned (if any),
8807+
* and the number of prior scale storage operations. Typical migration times are under 24
8808+
* hours, but the process can take up to several days in some cases. During the migration,
8809+
* the DB instance is available for use, but might experience performance degradation.
8810+
* While the migration takes place, nightly backups for the instance are suspended. No
8811+
* other Amazon RDS operations can take place for the instance, including modifying the
8812+
* instance, rebooting the instance, deleting the instance, creating a read replica for the
8813+
* instance, and creating a DB snapshot of the instance.</p>
8814+
* <p></p>
88148815
* <p>Constraints:</p>
88158816
* <ul>
88168817
* <li>
@@ -8870,17 +8871,18 @@ export interface ModifyDBInstanceMessage {
88708871
* <p>The storage type to associate with the DB instance.</p>
88718872
* <p>If you specify <code>io1</code>, <code>io2</code>, or <code>gp3</code>
88728873
* you must also include a value for the <code>Iops</code> parameter.</p>
8873-
* <p>If you choose to migrate your DB instance from using standard storage to using
8874-
* Provisioned IOPS, or from using Provisioned IOPS to using standard storage, the process
8875-
* can take time. The duration of the migration depends on several factors such as database
8876-
* load, storage size, storage type (standard or Provisioned IOPS), amount of IOPS
8877-
* provisioned (if any), and the number of prior scale storage operations. Typical
8878-
* migration times are under 24 hours, but the process can take up to several days in some
8879-
* cases. During the migration, the DB instance is available for use, but might experience
8880-
* performance degradation. While the migration takes place, nightly backups for the
8881-
* instance are suspended. No other Amazon RDS operations can take place for the instance,
8882-
* including modifying the instance, rebooting the instance, deleting the instance,
8883-
* creating a read replica for the instance, and creating a DB snapshot of the instance.</p>
8874+
* <p>If you choose to migrate your DB instance from using standard storage to gp2 (General
8875+
* Purpose SSD), gp3, or Provisioned IOPS (io1), or from these storage types to standard
8876+
* storage, the process can take time. The duration of the migration depends on several
8877+
* factors such as database load, storage size, storage type (standard or Provisioned
8878+
* IOPS), amount of IOPS provisioned (if any), and the number of prior scale storage
8879+
* operations. Typical migration times are under 24 hours, but the process can take up to
8880+
* several days in some cases. During the migration, the DB instance is available for use,
8881+
* but might experience performance degradation. While the migration takes place, nightly
8882+
* backups for the instance are suspended. No other Amazon RDS operations can take place
8883+
* for the instance, including modifying the instance, rebooting the instance, deleting the
8884+
* instance, creating a read replica for the instance, and creating a DB snapshot of the
8885+
* instance.</p>
88848886
* <p>Valid Values: <code>gp2 | gp3 | io1 | io2 | standard</code>
88858887
* </p>
88868888
* <p>Default: <code>io1</code>, if the <code>Iops</code> parameter
@@ -12451,7 +12453,8 @@ export interface RestoreDBClusterToPointInTimeMessage {
1245112453
* depending on the type of the cluster you are creating. You can create an Aurora Serverless v1 clone
1245212454
* from a provisioned cluster, or a provisioned clone from an Aurora Serverless v1 cluster. To create a clone
1245312455
* that is an Aurora Serverless v1 cluster, the original cluster must be an Aurora Serverless v1 cluster or
12454-
* an encrypted provisioned cluster.</p>
12456+
* an encrypted provisioned cluster. To create a full copy that is an Aurora Serverless v1 cluster, specify
12457+
* the engine mode <code>serverless</code>.</p>
1245512458
* <p>Valid for: Aurora DB clusters only</p>
1245612459
* @public
1245712460
*/

codegen/sdk-codegen/aws-models/rds.json

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4374,7 +4374,7 @@
43744374
"EnableHttpEndpoint": {
43754375
"target": "com.amazonaws.rds#BooleanOptional",
43764376
"traits": {
4377-
"smithy.api#documentation": "<p>Specifies whether to enable the HTTP endpoint for the DB cluster. By default, the HTTP endpoint \n isn't enabled.</p>\n <p>When enabled, the HTTP endpoint provides a connectionless web service API (RDS Data API) for running\n SQL queries on the DB cluster. You can also query your database\n from inside the RDS console with the RDS query editor.</p>\n <p>RDS Data API is supported with the following DB clusters:</p>\n <ul>\n <li>\n <p>Aurora PostgreSQL Serverless v2 and provisioned</p>\n </li>\n <li>\n <p>Aurora PostgreSQL and Aurora MySQL Serverless v1</p>\n </li>\n </ul>\n <p>For more information, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/data-api.html\">Using RDS Data API</a> in the \n <i>Amazon Aurora User Guide</i>.</p>\n <p>Valid for Cluster Type: Aurora DB clusters only</p>"
4377+
"smithy.api#documentation": "<p>Specifies whether to enable the HTTP endpoint for the DB cluster. By default, the HTTP endpoint \n isn't enabled.</p>\n <p>When enabled, the HTTP endpoint provides a connectionless web service API (RDS Data API) for running\n SQL queries on the DB cluster. You can also query your database\n from inside the RDS console with the RDS query editor.</p>\n <p>For more information, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/data-api.html\">Using RDS Data API</a> in the \n <i>Amazon Aurora User Guide</i>.</p>\n <p>Valid for Cluster Type: Aurora DB clusters only</p>"
43784378
}
43794379
},
43804380
"CopyTagsToSnapshot": {
@@ -22263,7 +22263,7 @@
2226322263
"Iops": {
2226422264
"target": "com.amazonaws.rds#IntegerOptional",
2226522265
"traits": {
22266-
"smithy.api#documentation": "<p>The new Provisioned IOPS (I/O operations per second) value for the RDS instance.</p>\n <p>Changing this setting doesn't result in an outage and\n the change is applied during the next maintenance window\n unless the <code>ApplyImmediately</code> parameter is enabled for this request.\n If you are migrating from Provisioned IOPS to standard storage, set this value to 0. \n The DB instance will require a reboot for the change in storage type to take effect.</p>\n <p>If you choose to migrate your DB instance from using standard storage to using\n Provisioned IOPS, or from using Provisioned IOPS to using standard storage, the process\n can take time. The duration of the migration depends on several factors such as database\n load, storage size, storage type (standard or Provisioned IOPS), amount of IOPS\n provisioned (if any), and the number of prior scale storage operations. Typical\n migration times are under 24 hours, but the process can take up to several days in some\n cases. During the migration, the DB instance is available for use, but might experience\n performance degradation. While the migration takes place, nightly backups for the\n instance are suspended. No other Amazon RDS operations can take place for the instance,\n including modifying the instance, rebooting the instance, deleting the instance,\n creating a read replica for the instance, and creating a DB snapshot of the instance.</p>\n <p>Constraints:</p>\n <ul>\n <li>\n <p>For RDS for MariaDB, RDS for MySQL, RDS for Oracle, and RDS for PostgreSQL - The value supplied must be at least 10% greater than the current value. \n Values that are not at least 10% greater than the existing value are rounded up so that they are 10% greater than the current value.</p>\n </li>\n <li>\n <p>When you increase the Provisioned IOPS, you must also specify the\n <code>AllocatedStorage</code> parameter. You can use the current value for\n <code>AllocatedStorage</code>.</p>\n </li>\n </ul>\n <p>Default: Uses existing setting</p>"
22266+
"smithy.api#documentation": "<p>The new Provisioned IOPS (I/O operations per second) value for the RDS instance.</p>\n <p>Changing this setting doesn't result in an outage and\n the change is applied during the next maintenance window\n unless the <code>ApplyImmediately</code> parameter is enabled for this request.\n If you are migrating from Provisioned IOPS to standard storage, set this value to 0. \n The DB instance will require a reboot for the change in storage type to take effect.</p>\n <p>If you choose to migrate your DB instance from using standard storage to Provisioned\n IOPS (io1), or from Provisioned IOPS to standard storage, the process can take time. The\n duration of the migration depends on several factors such as database load, storage\n size, storage type (standard or Provisioned IOPS), amount of IOPS provisioned (if any),\n and the number of prior scale storage operations. Typical migration times are under 24\n hours, but the process can take up to several days in some cases. During the migration,\n the DB instance is available for use, but might experience performance degradation.\n While the migration takes place, nightly backups for the instance are suspended. No\n other Amazon RDS operations can take place for the instance, including modifying the\n instance, rebooting the instance, deleting the instance, creating a read replica for the\n instance, and creating a DB snapshot of the instance.</p>\n <p></p>\n <p>Constraints:</p>\n <ul>\n <li>\n <p>For RDS for MariaDB, RDS for MySQL, RDS for Oracle, and RDS for PostgreSQL - The value supplied must be at least 10% greater than the current value. \n Values that are not at least 10% greater than the existing value are rounded up so that they are 10% greater than the current value.</p>\n </li>\n <li>\n <p>When you increase the Provisioned IOPS, you must also specify the\n <code>AllocatedStorage</code> parameter. You can use the current value for\n <code>AllocatedStorage</code>.</p>\n </li>\n </ul>\n <p>Default: Uses existing setting</p>"
2226722267
}
2226822268
},
2226922269
"OptionGroupName": {
@@ -22281,7 +22281,7 @@
2228122281
"StorageType": {
2228222282
"target": "com.amazonaws.rds#String",
2228322283
"traits": {
22284-
"smithy.api#documentation": "<p>The storage type to associate with the DB instance.</p>\n <p>If you specify <code>io1</code>, <code>io2</code>, or <code>gp3</code> \n you must also include a value for the <code>Iops</code> parameter.</p>\n <p>If you choose to migrate your DB instance from using standard storage to using\n Provisioned IOPS, or from using Provisioned IOPS to using standard storage, the process\n can take time. The duration of the migration depends on several factors such as database\n load, storage size, storage type (standard or Provisioned IOPS), amount of IOPS\n provisioned (if any), and the number of prior scale storage operations. Typical\n migration times are under 24 hours, but the process can take up to several days in some\n cases. During the migration, the DB instance is available for use, but might experience\n performance degradation. While the migration takes place, nightly backups for the\n instance are suspended. No other Amazon RDS operations can take place for the instance,\n including modifying the instance, rebooting the instance, deleting the instance,\n creating a read replica for the instance, and creating a DB snapshot of the instance.</p>\n <p>Valid Values: <code>gp2 | gp3 | io1 | io2 | standard</code>\n </p>\n <p>Default: <code>io1</code>, if the <code>Iops</code> parameter\n is specified. Otherwise, <code>gp2</code>.</p>"
22284+
"smithy.api#documentation": "<p>The storage type to associate with the DB instance.</p>\n <p>If you specify <code>io1</code>, <code>io2</code>, or <code>gp3</code> \n you must also include a value for the <code>Iops</code> parameter.</p>\n <p>If you choose to migrate your DB instance from using standard storage to gp2 (General\n Purpose SSD), gp3, or Provisioned IOPS (io1), or from these storage types to standard\n storage, the process can take time. The duration of the migration depends on several\n factors such as database load, storage size, storage type (standard or Provisioned\n IOPS), amount of IOPS provisioned (if any), and the number of prior scale storage\n operations. Typical migration times are under 24 hours, but the process can take up to\n several days in some cases. During the migration, the DB instance is available for use,\n but might experience performance degradation. While the migration takes place, nightly\n backups for the instance are suspended. No other Amazon RDS operations can take place\n for the instance, including modifying the instance, rebooting the instance, deleting the\n instance, creating a read replica for the instance, and creating a DB snapshot of the\n instance.</p>\n <p>Valid Values: <code>gp2 | gp3 | io1 | io2 | standard</code>\n </p>\n <p>Default: <code>io1</code>, if the <code>Iops</code> parameter\n is specified. Otherwise, <code>gp2</code>.</p>"
2228522285
}
2228622286
},
2228722287
"TdeCredentialArn": {
@@ -27676,7 +27676,7 @@
2767627676
"EngineMode": {
2767727677
"target": "com.amazonaws.rds#String",
2767827678
"traits": {
27679-
"smithy.api#documentation": "<p>The engine mode of the new cluster. Specify <code>provisioned</code> or <code>serverless</code>,\n depending on the type of the cluster you are creating. You can create an Aurora Serverless v1 clone\n from a provisioned cluster, or a provisioned clone from an Aurora Serverless v1 cluster. To create a clone\n that is an Aurora Serverless v1 cluster, the original cluster must be an Aurora Serverless v1 cluster or\n an encrypted provisioned cluster.</p>\n <p>Valid for: Aurora DB clusters only</p>"
27679+
"smithy.api#documentation": "<p>The engine mode of the new cluster. Specify <code>provisioned</code> or <code>serverless</code>,\n depending on the type of the cluster you are creating. You can create an Aurora Serverless v1 clone\n from a provisioned cluster, or a provisioned clone from an Aurora Serverless v1 cluster. To create a clone\n that is an Aurora Serverless v1 cluster, the original cluster must be an Aurora Serverless v1 cluster or\n an encrypted provisioned cluster. To create a full copy that is an Aurora Serverless v1 cluster, specify \n the engine mode <code>serverless</code>.</p>\n <p>Valid for: Aurora DB clusters only</p>"
2768027680
}
2768127681
},
2768227682
"DBClusterInstanceClass": {

0 commit comments

Comments
 (0)