Skip to content

Commit

Permalink
docs(client-rds): Updates Amazon RDS documentation to clarify the Res…
Browse files Browse the repository at this point in the history 
…toreDBClusterToPointInTime description.
  • Loading branch information
awstools committed Jan 8, 2025
1 parent 444cdc9 commit 4e29ba7
Show file tree
Hide file tree
Showing 3 changed files with 30 additions and 36 deletions.
9 changes: 0 additions & 9 deletions clients/client-rds/src/models/models_0.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5067,15 +5067,6 @@ export interface CreateDBClusterMessage {
* <p>When enabled, the HTTP endpoint provides a connectionless web service API (RDS Data API) for running
* SQL queries on the DB cluster. You can also query your database
* from inside the RDS console with the RDS query editor.</p>
* <p>RDS Data API is supported with the following DB clusters:</p>
* <ul>
* <li>
* <p>Aurora PostgreSQL Serverless v2 and provisioned</p>
* </li>
* <li>
* <p>Aurora PostgreSQL and Aurora MySQL Serverless v1</p>
* </li>
* </ul>
* <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
* <i>Amazon Aurora User Guide</i>.</p>
* <p>Valid for Cluster Type: Aurora DB clusters only</p>
Expand Down
49 changes: 26 additions & 23 deletions clients/client-rds/src/models/models_1.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8800,17 +8800,18 @@ export interface ModifyDBInstanceMessage {
* unless the <code>ApplyImmediately</code> parameter is enabled for this request.
* If you are migrating from Provisioned IOPS to standard storage, set this value to 0.
* The DB instance will require a reboot for the change in storage type to take effect.</p>
* <p>If you choose to migrate your DB instance from using standard storage to using
* Provisioned IOPS, or from using Provisioned IOPS to using standard storage, the process
* can take time. The duration of the migration depends on several factors such as database
* load, storage size, storage type (standard or Provisioned IOPS), amount of IOPS
* provisioned (if any), and the number of prior scale storage operations. Typical
* migration times are under 24 hours, but the process can take up to several days in some
* cases. During the migration, the DB instance is available for use, but might experience
* performance degradation. While the migration takes place, nightly backups for the
* instance are suspended. No other Amazon RDS operations can take place for the instance,
* including modifying the instance, rebooting the instance, deleting the instance,
* creating a read replica for the instance, and creating a DB snapshot of the instance.</p>
* <p>If you choose to migrate your DB instance from using standard storage to Provisioned
* IOPS (io1), or from Provisioned IOPS to standard storage, the process can take time. The
* duration of the migration depends on several factors such as database load, storage
* size, storage type (standard or Provisioned IOPS), amount of IOPS provisioned (if any),
* and the number of prior scale storage operations. Typical migration times are under 24
* hours, but the process can take up to several days in some cases. During the migration,
* the DB instance is available for use, but might experience performance degradation.
* While the migration takes place, nightly backups for the instance are suspended. No
* other Amazon RDS operations can take place for the instance, including modifying the
* instance, rebooting the instance, deleting the instance, creating a read replica for the
* instance, and creating a DB snapshot of the instance.</p>
* <p></p>
* <p>Constraints:</p>
* <ul>
* <li>
Expand Down Expand Up @@ -8870,17 +8871,18 @@ export interface ModifyDBInstanceMessage {
* <p>The storage type to associate with the DB instance.</p>
* <p>If you specify <code>io1</code>, <code>io2</code>, or <code>gp3</code>
* you must also include a value for the <code>Iops</code> parameter.</p>
* <p>If you choose to migrate your DB instance from using standard storage to using
* Provisioned IOPS, or from using Provisioned IOPS to using standard storage, the process
* can take time. The duration of the migration depends on several factors such as database
* load, storage size, storage type (standard or Provisioned IOPS), amount of IOPS
* provisioned (if any), and the number of prior scale storage operations. Typical
* migration times are under 24 hours, but the process can take up to several days in some
* cases. During the migration, the DB instance is available for use, but might experience
* performance degradation. While the migration takes place, nightly backups for the
* instance are suspended. No other Amazon RDS operations can take place for the instance,
* including modifying the instance, rebooting the instance, deleting the instance,
* creating a read replica for the instance, and creating a DB snapshot of the instance.</p>
* <p>If you choose to migrate your DB instance from using standard storage to gp2 (General
* Purpose SSD), gp3, or Provisioned IOPS (io1), or from these storage types to standard
* storage, the process can take time. The duration of the migration depends on several
* factors such as database load, storage size, storage type (standard or Provisioned
* IOPS), amount of IOPS provisioned (if any), and the number of prior scale storage
* operations. Typical migration times are under 24 hours, but the process can take up to
* several days in some cases. During the migration, the DB instance is available for use,
* but might experience performance degradation. While the migration takes place, nightly
* backups for the instance are suspended. No other Amazon RDS operations can take place
* for the instance, including modifying the instance, rebooting the instance, deleting the
* instance, creating a read replica for the instance, and creating a DB snapshot of the
* instance.</p>
* <p>Valid Values: <code>gp2 | gp3 | io1 | io2 | standard</code>
* </p>
* <p>Default: <code>io1</code>, if the <code>Iops</code> parameter
Expand Down Expand Up @@ -12451,7 +12453,8 @@ export interface RestoreDBClusterToPointInTimeMessage {
* depending on the type of the cluster you are creating. You can create an Aurora Serverless v1 clone
* from a provisioned cluster, or a provisioned clone from an Aurora Serverless v1 cluster. To create a clone
* that is an Aurora Serverless v1 cluster, the original cluster must be an Aurora Serverless v1 cluster or
* an encrypted provisioned cluster.</p>
* an encrypted provisioned cluster. To create a full copy that is an Aurora Serverless v1 cluster, specify
* the engine mode <code>serverless</code>.</p>
* <p>Valid for: Aurora DB clusters only</p>
* @public
*/
Expand Down
8 changes: 4 additions & 4 deletions codegen/sdk-codegen/aws-models/rds.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4374,7 +4374,7 @@
"EnableHttpEndpoint": {
"target": "com.amazonaws.rds#BooleanOptional",
"traits": {
"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>"
"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>"
}
},
"CopyTagsToSnapshot": {
Expand Down Expand Up @@ -22263,7 +22263,7 @@
"Iops": {
"target": "com.amazonaws.rds#IntegerOptional",
"traits": {
"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>"
"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>"
}
},
"OptionGroupName": {
Expand All @@ -22281,7 +22281,7 @@
"StorageType": {
"target": "com.amazonaws.rds#String",
"traits": {
"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>"
"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>"
}
},
"TdeCredentialArn": {
Expand Down Expand Up @@ -27676,7 +27676,7 @@
"EngineMode": {
"target": "com.amazonaws.rds#String",
"traits": {
"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>"
"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>"
}
},
"DBClusterInstanceClass": {
Expand Down

0 comments on commit 4e29ba7

Please sign in to comment.