Skip to content

Commit b0b5547

Browse files
author
awstools
committed
docs(client-rds): Updates Amazon RDS documentation to correct various descriptions.
1 parent d6160ef commit b0b5547

File tree

3 files changed

+152
-61
lines changed

3 files changed

+152
-61
lines changed

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

Lines changed: 27 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -5227,7 +5227,7 @@ export interface CreateDBClusterMessage {
52275227
/**
52285228
* <p>Specifies whether minor engine upgrades are applied automatically to the DB cluster during the maintenance window.
52295229
* By default, minor engine upgrades are applied automatically.</p>
5230-
* <p>Valid for Cluster Type: Multi-AZ DB clusters only</p>
5230+
* <p>Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB cluster</p>
52315231
* @public
52325232
*/
52335233
AutoMinorVersionUpgrade?: boolean | undefined;
@@ -5237,7 +5237,7 @@ export interface CreateDBClusterMessage {
52375237
* collecting Enhanced Monitoring metrics, specify <code>0</code>.</p>
52385238
* <p>If <code>MonitoringRoleArn</code> is specified, also set <code>MonitoringInterval</code>
52395239
* to a value other than <code>0</code>.</p>
5240-
* <p>Valid for Cluster Type: Multi-AZ DB clusters only</p>
5240+
* <p>Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters</p>
52415241
* <p>Valid Values: <code>0 | 1 | 5 | 10 | 15 | 30 | 60</code>
52425242
* </p>
52435243
* <p>Default: <code>0</code>
@@ -5252,13 +5252,16 @@ export interface CreateDBClusterMessage {
52525252
* see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Monitoring.OS.html#USER_Monitoring.OS.Enabling">Setting
52535253
* up and enabling Enhanced Monitoring</a> in the <i>Amazon RDS User Guide</i>.</p>
52545254
* <p>If <code>MonitoringInterval</code> is set to a value other than <code>0</code>, supply a <code>MonitoringRoleArn</code> value.</p>
5255-
* <p>Valid for Cluster Type: Multi-AZ DB clusters only</p>
5255+
* <p>Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters</p>
52565256
* @public
52575257
*/
52585258
MonitoringRoleArn?: string | undefined;
52595259

52605260
/**
5261-
* <p>Specifies the mode of Database Insights to enable for the cluster.</p>
5261+
* <p>The mode of Database Insights to enable for the DB cluster.</p>
5262+
* <p>If you set this value to <code>advanced</code>, you must also set the <code>PerformanceInsightsEnabled</code>
5263+
* parameter to <code>true</code> and the <code>PerformanceInsightsRetentionPeriod</code> parameter to 465.</p>
5264+
* <p>Valid for Cluster Type: Aurora DB clusters only</p>
52625265
* @public
52635266
*/
52645267
DatabaseInsightsMode?: DatabaseInsightsMode | undefined;
@@ -5267,7 +5270,7 @@ export interface CreateDBClusterMessage {
52675270
* <p>Specifies whether to turn on Performance Insights for the DB cluster.</p>
52685271
* <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.html">
52695272
* Using Amazon Performance Insights</a> in the <i>Amazon RDS User Guide</i>.</p>
5270-
* <p>Valid for Cluster Type: Multi-AZ DB clusters only</p>
5273+
* <p>Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters</p>
52715274
* @public
52725275
*/
52735276
EnablePerformanceInsights?: boolean | undefined;
@@ -5278,14 +5281,14 @@ export interface CreateDBClusterMessage {
52785281
* <p>If you don't specify a value for <code>PerformanceInsightsKMSKeyId</code>, then Amazon RDS
52795282
* uses your default KMS key. There is a default KMS key for your Amazon Web Services account.
52805283
* Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.</p>
5281-
* <p>Valid for Cluster Type: Multi-AZ DB clusters only</p>
5284+
* <p>Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters</p>
52825285
* @public
52835286
*/
52845287
PerformanceInsightsKMSKeyId?: string | undefined;
52855288

52865289
/**
52875290
* <p>The number of days to retain Performance Insights data.</p>
5288-
* <p>Valid for Cluster Type: Multi-AZ DB clusters only</p>
5291+
* <p>Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters</p>
52895292
* <p>Valid Values:</p>
52905293
* <ul>
52915294
* <li>
@@ -6412,49 +6415,49 @@ export interface DBCluster {
64126415

64136416
/**
64146417
* <p>Indicates whether minor version patches are applied automatically.</p>
6415-
* <p>This setting is only for non-Aurora Multi-AZ DB clusters.</p>
6418+
* <p>This setting is for Aurora DB clusters and Multi-AZ DB clusters.</p>
64166419
* @public
64176420
*/
64186421
AutoMinorVersionUpgrade?: boolean | undefined;
64196422

64206423
/**
64216424
* <p>The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster.</p>
6422-
* <p>This setting is only for non-Aurora Multi-AZ DB clusters.</p>
6425+
* <p>This setting is only for -Aurora DB clusters and Multi-AZ DB clusters.</p>
64236426
* @public
64246427
*/
64256428
MonitoringInterval?: number | undefined;
64266429

64276430
/**
64286431
* <p>The ARN for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.</p>
6429-
* <p>This setting is only for non-Aurora Multi-AZ DB clusters.</p>
6432+
* <p>This setting is only for Aurora DB clusters and Multi-AZ DB clusters.</p>
64306433
* @public
64316434
*/
64326435
MonitoringRoleArn?: string | undefined;
64336436

64346437
/**
6435-
* <p>The mode of Database Insights that is enabled for the cluster.</p>
6438+
* <p>The mode of Database Insights that is enabled for the DB cluster.</p>
64366439
* @public
64376440
*/
64386441
DatabaseInsightsMode?: DatabaseInsightsMode | undefined;
64396442

64406443
/**
64416444
* <p>Indicates whether Performance Insights is enabled for the DB cluster.</p>
6442-
* <p>This setting is only for non-Aurora Multi-AZ DB clusters.</p>
6445+
* <p>This setting is only for Aurora DB clusters and Multi-AZ DB clusters.</p>
64436446
* @public
64446447
*/
64456448
PerformanceInsightsEnabled?: boolean | undefined;
64466449

64476450
/**
64486451
* <p>The Amazon Web Services KMS key identifier for encryption of Performance Insights data.</p>
64496452
* <p>The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.</p>
6450-
* <p>This setting is only for non-Aurora Multi-AZ DB clusters.</p>
6453+
* <p>This setting is only for Aurora DB clusters and Multi-AZ DB clusters.</p>
64516454
* @public
64526455
*/
64536456
PerformanceInsightsKMSKeyId?: string | undefined;
64546457

64556458
/**
64566459
* <p>The number of days to retain Performance Insights data.</p>
6457-
* <p>This setting is only for non-Aurora Multi-AZ DB clusters.</p>
6460+
* <p>This setting is only for Aurora DB clusters and Multi-AZ DB clusters.</p>
64586461
* <p>Valid Values:</p>
64596462
* <ul>
64606463
* <li>
@@ -8413,7 +8416,11 @@ export interface CreateDBInstanceMessage {
84138416
EnableIAMDatabaseAuthentication?: boolean | undefined;
84148417

84158418
/**
8416-
* <p>Specifies the mode of Database Insights to enable for the instance.</p>
8419+
* <p>The mode of Database Insights to enable for the DB instance.</p>
8420+
* <p>This setting only applies to Amazon Aurora DB instances.</p>
8421+
* <note>
8422+
* <p>Currently, this value is inherited from the DB cluster and can't be changed.</p>
8423+
* </note>
84178424
* @public
84188425
*/
84198426
DatabaseInsightsMode?: DatabaseInsightsMode | undefined;
@@ -10406,7 +10413,10 @@ export interface CreateDBInstanceReadReplicaMessage {
1040610413
EnableIAMDatabaseAuthentication?: boolean | undefined;
1040710414

1040810415
/**
10409-
* <p>Specifies the mode of Database Insights.</p>
10416+
* <p>The mode of Database Insights to enable for the read replica.</p>
10417+
* <note>
10418+
* <p>Currently, this setting is not supported.</p>
10419+
* </note>
1041010420
* @public
1041110421
*/
1041210422
DatabaseInsightsMode?: DatabaseInsightsMode | undefined;
@@ -10665,6 +10675,7 @@ export interface CreateDBInstanceReadReplicaMessage {
1066510675
/**
1066610676
* <p>The amount of storage (in gibibytes) to allocate initially for the read replica.
1066710677
* Follow the allocation rules specified in <code>CreateDBInstance</code>.</p>
10678+
* <p>This setting isn't valid for RDS for SQL Server.</p>
1066810679
* <note>
1066910680
* <p>Be sure to allocate enough storage for your read replica so that the create operation can succeed.
1067010681
* You can also allocate additional storage for future growth.</p>

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

Lines changed: 92 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -976,17 +976,17 @@ export interface DescribeDBClusterParametersMessage {
976976
* <ul>
977977
* <li>
978978
* <p>
979-
* <code>customer</code>
979+
* <code>engine-default</code>
980980
* </p>
981981
* </li>
982982
* <li>
983983
* <p>
984-
* <code>engine</code>
984+
* <code>system</code>
985985
* </p>
986986
* </li>
987987
* <li>
988988
* <p>
989-
* <code>service</code>
989+
* <code>user</code>
990990
* </p>
991991
* </li>
992992
* </ul>
@@ -995,7 +995,8 @@ export interface DescribeDBClusterParametersMessage {
995995
Source?: string | undefined;
996996

997997
/**
998-
* <p>This parameter isn't currently supported.</p>
998+
* <p>A filter that specifies one or more DB cluster parameters to describe.</p>
999+
* <p>The only supported filter is <code>parameter-name</code>. The results list only includes information about the DB cluster parameters with these names.</p>
9991000
* @public
10001001
*/
10011002
Filters?: Filter[] | undefined;
@@ -2076,7 +2077,8 @@ export interface DescribeDBParametersMessage {
20762077
Source?: string | undefined;
20772078

20782079
/**
2079-
* <p>This parameter isn't currently supported.</p>
2080+
* <p>A filter that specifies one or more DB parameters to describe.</p>
2081+
* <p>The only supported filter is <code>parameter-name</code>. The results list only includes information about the DB parameters with these names.</p>
20802082
* @public
20812083
*/
20822084
Filters?: Filter[] | undefined;
@@ -4398,7 +4400,8 @@ export interface DescribeEngineDefaultParametersMessage {
43984400
DBParameterGroupFamily: string | undefined;
43994401

44004402
/**
4401-
* <p>This parameter isn't currently supported.</p>
4403+
* <p>A filter that specifies one or more parameters to describe.</p>
4404+
* <p>The only supported filter is <code>parameter-name</code>. The results list only includes information about the parameters with these names.</p>
44024405
* @public
44034406
*/
44044407
Filters?: Filter[] | undefined;
@@ -7413,12 +7416,50 @@ export interface ModifyCustomDBEngineVersionMessage {
74137416
export interface CloudwatchLogsExportConfiguration {
74147417
/**
74157418
* <p>The list of log types to enable.</p>
7419+
* <p>The following values are valid for each DB engine:</p>
7420+
* <ul>
7421+
* <li>
7422+
* <p>Aurora MySQL - <code>audit | error | general | slowquery</code>
7423+
* </p>
7424+
* </li>
7425+
* <li>
7426+
* <p>Aurora PostgreSQL - <code>postgresql</code>
7427+
* </p>
7428+
* </li>
7429+
* <li>
7430+
* <p>RDS for MySQL - <code>error | general | slowquery</code>
7431+
* </p>
7432+
* </li>
7433+
* <li>
7434+
* <p>RDS for PostgreSQL - <code>postgresql | upgrade</code>
7435+
* </p>
7436+
* </li>
7437+
* </ul>
74167438
* @public
74177439
*/
74187440
EnableLogTypes?: string[] | undefined;
74197441

74207442
/**
74217443
* <p>The list of log types to disable.</p>
7444+
* <p>The following values are valid for each DB engine:</p>
7445+
* <ul>
7446+
* <li>
7447+
* <p>Aurora MySQL - <code>audit | error | general | slowquery</code>
7448+
* </p>
7449+
* </li>
7450+
* <li>
7451+
* <p>Aurora PostgreSQL - <code>postgresql</code>
7452+
* </p>
7453+
* </li>
7454+
* <li>
7455+
* <p>RDS for MySQL - <code>error | general | slowquery</code>
7456+
* </p>
7457+
* </li>
7458+
* <li>
7459+
* <p>RDS for PostgreSQL - <code>postgresql | upgrade</code>
7460+
* </p>
7461+
* </li>
7462+
* </ul>
74227463
* @public
74237464
*/
74247465
DisableLogTypes?: string[] | undefined;
@@ -7863,7 +7904,7 @@ export interface ModifyDBClusterMessage {
78637904
/**
78647905
* <p>Specifies whether minor engine upgrades are applied automatically to the DB cluster during the maintenance window.
78657906
* By default, minor engine upgrades are applied automatically.</p>
7866-
* <p>Valid for Cluster Type: Multi-AZ DB clusters only</p>
7907+
* <p>Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters</p>
78677908
* @public
78687909
*/
78697910
AutoMinorVersionUpgrade?: boolean | undefined;
@@ -7895,7 +7936,13 @@ export interface ModifyDBClusterMessage {
78957936
MonitoringRoleArn?: string | undefined;
78967937

78977938
/**
7898-
* <p>Specifies the mode of Database Insights to enable for the cluster.</p>
7939+
* <p>Specifies the mode of Database Insights to enable for the DB cluster.</p>
7940+
* <p>If you change the value from <code>standard</code> to <code>advanced</code>, you must set the
7941+
* <code>PerformanceInsightsEnabled</code> parameter to <code>true</code> and the
7942+
* <code>PerformanceInsightsRetentionPeriod</code> parameter to 465.</p>
7943+
* <p>If you change the value from <code>advanced</code> to <code>standard</code>, you must
7944+
* set the <code>PerformanceInsightsEnabled</code> parameter to <code>false</code>.</p>
7945+
* <p>Valid for Cluster Type: Aurora DB clusters only</p>
78997946
* @public
79007947
*/
79017948
DatabaseInsightsMode?: DatabaseInsightsMode | undefined;
@@ -7915,14 +7962,14 @@ export interface ModifyDBClusterMessage {
79157962
* <p>If you don't specify a value for <code>PerformanceInsightsKMSKeyId</code>, then Amazon RDS
79167963
* uses your default KMS key. There is a default KMS key for your Amazon Web Services account.
79177964
* Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.</p>
7918-
* <p>Valid for Cluster Type: Multi-AZ DB clusters only</p>
7965+
* <p>Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters</p>
79197966
* @public
79207967
*/
79217968
PerformanceInsightsKMSKeyId?: string | undefined;
79227969

79237970
/**
79247971
* <p>The number of days to retain Performance Insights data.</p>
7925-
* <p>Valid for Cluster Type: Multi-AZ DB clusters only</p>
7972+
* <p>Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters</p>
79267973
* <p>Valid Values:</p>
79277974
* <ul>
79287975
* <li>
@@ -9079,7 +9126,11 @@ export interface ModifyDBInstanceMessage {
90799126
EnableIAMDatabaseAuthentication?: boolean | undefined;
90809127

90819128
/**
9082-
* <p>Specifies the mode of Database Insights to enable for the instance.</p>
9129+
* <p>Specifies the mode of Database Insights to enable for the DB instance.</p>
9130+
* <p>This setting only applies to Amazon Aurora DB instances.</p>
9131+
* <note>
9132+
* <p>Currently, this value is inherited from the DB cluster and can't be changed.</p>
9133+
* </note>
90839134
* @public
90849135
*/
90859136
DatabaseInsightsMode?: DatabaseInsightsMode | undefined;
@@ -9137,6 +9188,28 @@ export interface ModifyDBInstanceMessage {
91379188
* <p>A change to the <code>CloudwatchLogsExportConfiguration</code> parameter is always applied to the DB instance
91389189
* immediately. Therefore, the <code>ApplyImmediately</code> parameter has no effect.</p>
91399190
* <p>This setting doesn't apply to RDS Custom DB instances.</p>
9191+
* <p>The following values are valid for each DB engine:</p>
9192+
* <ul>
9193+
* <li>
9194+
* <p>Aurora MySQL - <code>audit | error | general | slowquery</code>
9195+
* </p>
9196+
* </li>
9197+
* <li>
9198+
* <p>Aurora PostgreSQL - <code>postgresql</code>
9199+
* </p>
9200+
* </li>
9201+
* <li>
9202+
* <p>RDS for MySQL - <code>error | general | slowquery</code>
9203+
* </p>
9204+
* </li>
9205+
* <li>
9206+
* <p>RDS for PostgreSQL - <code>postgresql | upgrade</code>
9207+
* </p>
9208+
* </li>
9209+
* </ul>
9210+
* <p>For more information about exporting CloudWatch Logs for Amazon RDS, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch">
9211+
* Publishing Database Logs to Amazon CloudWatch Logs</a> in the <i>Amazon RDS User Guide</i>.</p>
9212+
* <p>For more information about exporting CloudWatch Logs for Amazon Aurora, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch">Publishing Database Logs to Amazon CloudWatch Logs</a> in the <i>Amazon Aurora User Guide</i>.</p>
91409213
* @public
91419214
*/
91429215
CloudwatchLogsExportConfiguration?: CloudwatchLogsExportConfiguration | undefined;
@@ -13198,6 +13271,7 @@ export interface RestoreDBInstanceFromDBSnapshotMessage {
1319813271
/**
1319913272
* <p>The amount of storage (in gibibytes) to allocate initially for the DB instance. Follow the allocation rules specified in
1320013273
* CreateDBInstance.</p>
13274+
* <p>This setting isn't valid for RDS for SQL Server.</p>
1320113275
* <note>
1320213276
* <p>Be sure to allocate enough storage for your new DB instance so that the restore operation can succeed. You can also
1320313277
* allocate additional storage for future growth.</p>
@@ -13293,6 +13367,7 @@ export interface RestoreDBInstanceFromS3Message {
1329313367
/**
1329413368
* <p>The amount of storage (in gibibytes) to allocate initially for the DB instance.
1329513369
* Follow the allocation rules specified in <code>CreateDBInstance</code>.</p>
13370+
* <p>This setting isn't valid for RDS for SQL Server.</p>
1329613371
* <note>
1329713372
* <p>Be sure to allocate enough storage for your new DB instance so that the restore operation can succeed.
1329813373
* You can also allocate additional storage for future growth.</p>
@@ -13678,7 +13753,11 @@ export interface RestoreDBInstanceFromS3Message {
1367813753
S3IngestionRoleArn: string | undefined;
1367913754

1368013755
/**
13681-
* <p>Specifies the mode of Database Insights to enable for the instance.</p>
13756+
* <p>Specifies the mode of Database Insights to enable for the DB instance.</p>
13757+
* <p>This setting only applies to Amazon Aurora DB instances.</p>
13758+
* <note>
13759+
* <p>Currently, this value is inherited from the DB cluster and can't be changed.</p>
13760+
* </note>
1368213761
* @public
1368313762
*/
1368413763
DatabaseInsightsMode?: DatabaseInsightsMode | undefined;
@@ -14561,6 +14640,7 @@ export interface RestoreDBInstanceToPointInTimeMessage {
1456114640
/**
1456214641
* <p>The amount of storage (in gibibytes) to allocate initially for the DB instance.
1456314642
* Follow the allocation rules specified in <code>CreateDBInstance</code>.</p>
14643+
* <p>This setting isn't valid for RDS for SQL Server.</p>
1456414644
* <note>
1456514645
* <p>Be sure to allocate enough storage for your new DB instance so that the restore operation can succeed.
1456614646
* You can also allocate additional storage for future growth.</p>

0 commit comments

Comments
 (0)