Skip to content

Commit

Permalink
docs(client-rds): Updates Amazon RDS documentation for io2 storage fo…
Browse files Browse the repository at this point in the history 
…r Multi-AZ DB clusters
  • Loading branch information
awstools committed Mar 7, 2024
1 parent b6f2e1d commit 2864eaa
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 8 deletions.
4 changes: 3 additions & 1 deletion clients/client-rds/src/models/models_0.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4897,7 +4897,7 @@ export interface CreateDBClusterMessage {
* </p>
* </li>
* <li>
* <p>Multi-AZ DB clusters - <code>io1</code>
* <p>Multi-AZ DB clusters - <code>io1 | io2 | gp3</code>
* </p>
* </li>
* </ul>
Expand Down Expand Up @@ -5133,6 +5133,8 @@ export interface CreateDBClusterMessage {
/**
* @public
* <p>The CA certificate identifier to use for the DB cluster's server certificate.</p>
* <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.SSL.html">Using SSL/TLS to encrypt a connection to a DB
* instance</a> in the <i>Amazon RDS User Guide</i>.</p>
* <p>Valid for Cluster Type: Multi-AZ DB clusters</p>
*/
CACertificateIdentifier?: string;
Expand Down
6 changes: 4 additions & 2 deletions clients/client-rds/src/models/models_1.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7681,7 +7681,7 @@ export interface ModifyDBClusterMessage {
* </p>
* </li>
* <li>
* <p>Multi-AZ DB clusters - <code>io1</code>
* <p>Multi-AZ DB clusters - <code>io1 | io2 | gp3</code>
* </p>
* </li>
* </ul>
Expand Down Expand Up @@ -7938,6 +7938,8 @@ export interface ModifyDBClusterMessage {
/**
* @public
* <p>The CA certificate identifier to use for the DB cluster's server certificate.</p>
* <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.SSL.html">Using SSL/TLS to encrypt a connection to a DB
* instance</a> in the <i>Amazon RDS User Guide</i>.</p>
* <p>Valid for Cluster Type: Multi-AZ DB clusters</p>
*/
CACertificateIdentifier?: string;
Expand Down Expand Up @@ -8653,7 +8655,7 @@ export interface ModifyDBInstanceMessage {
/**
* @public
* <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>
* <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
Expand Down
10 changes: 5 additions & 5 deletions codegen/sdk-codegen/aws-models/rds.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4366,7 +4366,7 @@
"StorageType": {
"target": "com.amazonaws.rds#String",
"traits": {
"smithy.api#documentation": "<p>The storage type to associate with the DB cluster.</p>\n <p>For information on storage types for Aurora DB clusters, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Overview.StorageReliability.html#aurora-storage-type\">Storage configurations for Amazon Aurora DB clusters</a>. For information on storage types for Multi-AZ DB\n clusters, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/create-multi-az-db-cluster.html#create-multi-az-db-cluster-settings\">Settings for creating Multi-AZ DB clusters</a>.</p>\n <p>This setting is required to create a Multi-AZ DB cluster.</p>\n <p>When specified for a Multi-AZ DB cluster, a value for the <code>Iops</code> parameter is required.</p>\n <p>Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters</p>\n <p>Valid Values:</p>\n <ul>\n <li>\n <p>Aurora DB clusters - <code>aurora | aurora-iopt1</code>\n </p>\n </li>\n <li>\n <p>Multi-AZ DB clusters - <code>io1</code>\n </p>\n </li>\n </ul>\n <p>Default:</p>\n <ul>\n <li>\n <p>Aurora DB clusters - <code>aurora</code>\n </p>\n </li>\n <li>\n <p>Multi-AZ DB clusters - <code>io1</code>\n </p>\n </li>\n </ul>\n <note>\n <p>When you create an Aurora DB cluster with the storage type set to <code>aurora-iopt1</code>, the storage type is returned\n in the response. The storage type isn't returned when you set it to <code>aurora</code>.</p>\n </note>"
"smithy.api#documentation": "<p>The storage type to associate with the DB cluster.</p>\n <p>For information on storage types for Aurora DB clusters, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Overview.StorageReliability.html#aurora-storage-type\">Storage configurations for Amazon Aurora DB clusters</a>. For information on storage types for Multi-AZ DB\n clusters, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/create-multi-az-db-cluster.html#create-multi-az-db-cluster-settings\">Settings for creating Multi-AZ DB clusters</a>.</p>\n <p>This setting is required to create a Multi-AZ DB cluster.</p>\n <p>When specified for a Multi-AZ DB cluster, a value for the <code>Iops</code> parameter is required.</p>\n <p>Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters</p>\n <p>Valid Values:</p>\n <ul>\n <li>\n <p>Aurora DB clusters - <code>aurora | aurora-iopt1</code>\n </p>\n </li>\n <li>\n <p>Multi-AZ DB clusters - <code>io1 | io2 | gp3</code>\n </p>\n </li>\n </ul>\n <p>Default:</p>\n <ul>\n <li>\n <p>Aurora DB clusters - <code>aurora</code>\n </p>\n </li>\n <li>\n <p>Multi-AZ DB clusters - <code>io1</code>\n </p>\n </li>\n </ul>\n <note>\n <p>When you create an Aurora DB cluster with the storage type set to <code>aurora-iopt1</code>, the storage type is returned\n in the response. The storage type isn't returned when you set it to <code>aurora</code>.</p>\n </note>"
}
},
"Iops": {
Expand Down Expand Up @@ -4459,7 +4459,7 @@
"CACertificateIdentifier": {
"target": "com.amazonaws.rds#String",
"traits": {
"smithy.api#documentation": "<p>The CA certificate identifier to use for the DB cluster's server certificate.</p>\n <p>Valid for Cluster Type: Multi-AZ DB clusters</p>"
"smithy.api#documentation": "<p>The CA certificate identifier to use for the DB cluster's server certificate.</p>\n <p>For more information, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.SSL.html\">Using SSL/TLS to encrypt a connection to a DB \n instance</a> in the <i>Amazon RDS User Guide</i>.</p>\n <p>Valid for Cluster Type: Multi-AZ DB clusters</p>"
}
}
},
Expand Down Expand Up @@ -21449,7 +21449,7 @@
"StorageType": {
"target": "com.amazonaws.rds#String",
"traits": {
"smithy.api#documentation": "<p>The storage type to associate with the DB cluster.</p>\n <p>For information on storage types for Aurora DB clusters, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Overview.StorageReliability.html#aurora-storage-type\">Storage configurations for Amazon Aurora DB clusters</a>. For information on storage types for Multi-AZ DB\n clusters, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/create-multi-az-db-cluster.html#create-multi-az-db-cluster-settings\">Settings for creating Multi-AZ DB clusters</a>.</p>\n <p>When specified for a Multi-AZ DB cluster, a value for the <code>Iops</code> parameter is required.</p>\n <p>Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters</p>\n <p>Valid Values:</p>\n <ul>\n <li>\n <p>Aurora DB clusters - <code>aurora | aurora-iopt1</code>\n </p>\n </li>\n <li>\n <p>Multi-AZ DB clusters - <code>io1</code>\n </p>\n </li>\n </ul>\n <p>Default:</p>\n <ul>\n <li>\n <p>Aurora DB clusters - <code>aurora</code>\n </p>\n </li>\n <li>\n <p>Multi-AZ DB clusters - <code>io1</code>\n </p>\n </li>\n </ul>"
"smithy.api#documentation": "<p>The storage type to associate with the DB cluster.</p>\n <p>For information on storage types for Aurora DB clusters, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Overview.StorageReliability.html#aurora-storage-type\">Storage configurations for Amazon Aurora DB clusters</a>. For information on storage types for Multi-AZ DB\n clusters, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/create-multi-az-db-cluster.html#create-multi-az-db-cluster-settings\">Settings for creating Multi-AZ DB clusters</a>.</p>\n <p>When specified for a Multi-AZ DB cluster, a value for the <code>Iops</code> parameter is required.</p>\n <p>Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters</p>\n <p>Valid Values:</p>\n <ul>\n <li>\n <p>Aurora DB clusters - <code>aurora | aurora-iopt1</code>\n </p>\n </li>\n <li>\n <p>Multi-AZ DB clusters - <code>io1 | io2 | gp3</code>\n </p>\n </li>\n </ul>\n <p>Default:</p>\n <ul>\n <li>\n <p>Aurora DB clusters - <code>aurora</code>\n </p>\n </li>\n <li>\n <p>Multi-AZ DB clusters - <code>io1</code>\n </p>\n </li>\n </ul>"
}
},
"Iops": {
Expand Down Expand Up @@ -21554,7 +21554,7 @@
"CACertificateIdentifier": {
"target": "com.amazonaws.rds#String",
"traits": {
"smithy.api#documentation": "<p>The CA certificate identifier to use for the DB cluster's server certificate.</p>\n <p>Valid for Cluster Type: Multi-AZ DB clusters</p>"
"smithy.api#documentation": "<p>The CA certificate identifier to use for the DB cluster's server certificate.</p>\n <p>For more information, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.SSL.html\">Using SSL/TLS to encrypt a connection to a DB \n instance</a> in the <i>Amazon RDS User Guide</i>.</p>\n <p>Valid for Cluster Type: Multi-AZ DB clusters</p>"
}
}
},
Expand Down Expand Up @@ -21986,7 +21986,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 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>"
}
},
"TdeCredentialArn": {
Expand Down

0 comments on commit 2864eaa

Please sign in to comment.