Skip to content

Commit 2864eaa

Browse files
author
awstools
committed
docs(client-rds): Updates Amazon RDS documentation for io2 storage for Multi-AZ DB clusters
1 parent b6f2e1d commit 2864eaa

File tree

3 files changed

+12
-8
lines changed

3 files changed

+12
-8
lines changed

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

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4897,7 +4897,7 @@ export interface CreateDBClusterMessage {
48974897
* </p>
48984898
* </li>
48994899
* <li>
4900-
* <p>Multi-AZ DB clusters - <code>io1</code>
4900+
* <p>Multi-AZ DB clusters - <code>io1 | io2 | gp3</code>
49014901
* </p>
49024902
* </li>
49034903
* </ul>
@@ -5133,6 +5133,8 @@ export interface CreateDBClusterMessage {
51335133
/**
51345134
* @public
51355135
* <p>The CA certificate identifier to use for the DB cluster's server certificate.</p>
5136+
* <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
5137+
* instance</a> in the <i>Amazon RDS User Guide</i>.</p>
51365138
* <p>Valid for Cluster Type: Multi-AZ DB clusters</p>
51375139
*/
51385140
CACertificateIdentifier?: string;

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

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7681,7 +7681,7 @@ export interface ModifyDBClusterMessage {
76817681
* </p>
76827682
* </li>
76837683
* <li>
7684-
* <p>Multi-AZ DB clusters - <code>io1</code>
7684+
* <p>Multi-AZ DB clusters - <code>io1 | io2 | gp3</code>
76857685
* </p>
76867686
* </li>
76877687
* </ul>
@@ -7938,6 +7938,8 @@ export interface ModifyDBClusterMessage {
79387938
/**
79397939
* @public
79407940
* <p>The CA certificate identifier to use for the DB cluster's server certificate.</p>
7941+
* <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
7942+
* instance</a> in the <i>Amazon RDS User Guide</i>.</p>
79417943
* <p>Valid for Cluster Type: Multi-AZ DB clusters</p>
79427944
*/
79437945
CACertificateIdentifier?: string;
@@ -8653,7 +8655,7 @@ export interface ModifyDBInstanceMessage {
86538655
/**
86548656
* @public
86558657
* <p>The storage type to associate with the DB instance.</p>
8656-
* <p>If you specify <code>io1</code>), <code>io2</code>, or <code>gp3</code>
8658+
* <p>If you specify <code>io1</code>, <code>io2</code>, or <code>gp3</code>
86578659
* you must also include a value for the <code>Iops</code> parameter.</p>
86588660
* <p>If you choose to migrate your DB instance from using standard storage to using
86598661
* Provisioned IOPS, or from using Provisioned IOPS to using standard storage, the process

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

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4366,7 +4366,7 @@
43664366
"StorageType": {
43674367
"target": "com.amazonaws.rds#String",
43684368
"traits": {
4369-
"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>"
4369+
"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>"
43704370
}
43714371
},
43724372
"Iops": {
@@ -4459,7 +4459,7 @@
44594459
"CACertificateIdentifier": {
44604460
"target": "com.amazonaws.rds#String",
44614461
"traits": {
4462-
"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>"
4462+
"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>"
44634463
}
44644464
}
44654465
},
@@ -21449,7 +21449,7 @@
2144921449
"StorageType": {
2145021450
"target": "com.amazonaws.rds#String",
2145121451
"traits": {
21452-
"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>"
21452+
"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>"
2145321453
}
2145421454
},
2145521455
"Iops": {
@@ -21554,7 +21554,7 @@
2155421554
"CACertificateIdentifier": {
2155521555
"target": "com.amazonaws.rds#String",
2155621556
"traits": {
21557-
"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>"
21557+
"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>"
2155821558
}
2155921559
}
2156021560
},
@@ -21986,7 +21986,7 @@
2198621986
"StorageType": {
2198721987
"target": "com.amazonaws.rds#String",
2198821988
"traits": {
21989-
"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>"
21989+
"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>"
2199021990
}
2199121991
},
2199221992
"TdeCredentialArn": {

0 commit comments

Comments
 (0)