Skip to content

Commit 291e15e

Browse files
aws-sdk-dotnet-automationaws-sdk-dotnet-automation
committed
Updates Amazon RDS documentation to correct various descriptions.
1 parent f6f7119 commit 291e15e

15 files changed

+254
-94
lines changed

‎generator/ServiceModels/rds/rds-2014-10-31.docs.json

Lines changed: 33 additions & 33 deletions
Large diffs are not rendered by default.

‎generator/ServiceModels/rds/rds-2014-10-31.normal.json

Lines changed: 33 additions & 33 deletions
Large diffs are not rendered by default.

‎sdk/src/Services/RDS/Generated/Model/CloudwatchLogsExportConfiguration.cs

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -62,6 +62,27 @@ public partial class CloudwatchLogsExportConfiguration
6262
/// <para>
6363
/// The list of log types to disable.
6464
/// </para>
65+
///
66+
/// <para>
67+
/// The following values are valid for each DB engine:
68+
/// </para>
69+
/// <ul> <li>
70+
/// <para>
71+
/// Aurora MySQL - <c>audit | error | general | slowquery</c>
72+
/// </para>
73+
/// </li> <li>
74+
/// <para>
75+
/// Aurora PostgreSQL - <c>postgresql</c>
76+
/// </para>
77+
/// </li> <li>
78+
/// <para>
79+
/// RDS for MySQL - <c>error | general | slowquery</c>
80+
/// </para>
81+
/// </li> <li>
82+
/// <para>
83+
/// RDS for PostgreSQL - <c>postgresql | upgrade</c>
84+
/// </para>
85+
/// </li> </ul>
6586
/// </summary>
6687
public List<string> DisableLogTypes
6788
{
@@ -80,6 +101,27 @@ internal bool IsSetDisableLogTypes()
80101
/// <para>
81102
/// The list of log types to enable.
82103
/// </para>
104+
///
105+
/// <para>
106+
/// The following values are valid for each DB engine:
107+
/// </para>
108+
/// <ul> <li>
109+
/// <para>
110+
/// Aurora MySQL - <c>audit | error | general | slowquery</c>
111+
/// </para>
112+
/// </li> <li>
113+
/// <para>
114+
/// Aurora PostgreSQL - <c>postgresql</c>
115+
/// </para>
116+
/// </li> <li>
117+
/// <para>
118+
/// RDS for MySQL - <c>error | general | slowquery</c>
119+
/// </para>
120+
/// </li> <li>
121+
/// <para>
122+
/// RDS for PostgreSQL - <c>postgresql | upgrade</c>
123+
/// </para>
124+
/// </li> </ul>
83125
/// </summary>
84126
public List<string> EnableLogTypes
85127
{

‎sdk/src/Services/RDS/Generated/Model/CreateDBClusterRequest.cs

Lines changed: 17 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -149,7 +149,7 @@ internal bool IsSetAllocatedStorage()
149149
/// </para>
150150
///
151151
/// <para>
152-
/// Valid for Cluster Type: Multi-AZ DB clusters only
152+
/// Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB cluster
153153
/// </para>
154154
/// </summary>
155155
public bool AutoMinorVersionUpgrade
@@ -376,7 +376,17 @@ internal bool IsSetCopyTagsToSnapshot()
376376
/// <summary>
377377
/// Gets and sets the property DatabaseInsightsMode.
378378
/// <para>
379-
/// Specifies the mode of Database Insights to enable for the cluster.
379+
/// The mode of Database Insights to enable for the DB cluster.
380+
/// </para>
381+
///
382+
/// <para>
383+
/// If you set this value to <c>advanced</c>, you must also set the <c>PerformanceInsightsEnabled</c>
384+
/// parameter to <c>true</c> and the <c>PerformanceInsightsRetentionPeriod</c> parameter
385+
/// to 465.
386+
/// </para>
387+
///
388+
/// <para>
389+
/// Valid for Cluster Type: Aurora DB clusters only
380390
/// </para>
381391
/// </summary>
382392
public DatabaseInsightsMode DatabaseInsightsMode
@@ -885,7 +895,7 @@ internal bool IsSetEnableLocalWriteForwarding()
885895
/// </para>
886896
///
887897
/// <para>
888-
/// Valid for Cluster Type: Multi-AZ DB clusters only
898+
/// Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
889899
/// </para>
890900
/// </summary>
891901
public bool EnablePerformanceInsights
@@ -1435,7 +1445,7 @@ internal bool IsSetMasterUserSecretKmsKeyId()
14351445
/// </para>
14361446
///
14371447
/// <para>
1438-
/// Valid for Cluster Type: Multi-AZ DB clusters only
1448+
/// Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
14391449
/// </para>
14401450
///
14411451
/// <para>
@@ -1473,7 +1483,7 @@ internal bool IsSetMonitoringInterval()
14731483
/// </para>
14741484
///
14751485
/// <para>
1476-
/// Valid for Cluster Type: Multi-AZ DB clusters only
1486+
/// Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
14771487
/// </para>
14781488
/// </summary>
14791489
public string MonitoringRoleArn
@@ -1567,7 +1577,7 @@ internal bool IsSetOptionGroupName()
15671577
/// </para>
15681578
///
15691579
/// <para>
1570-
/// Valid for Cluster Type: Multi-AZ DB clusters only
1580+
/// Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
15711581
/// </para>
15721582
/// </summary>
15731583
public string PerformanceInsightsKMSKeyId
@@ -1589,7 +1599,7 @@ internal bool IsSetPerformanceInsightsKMSKeyId()
15891599
/// </para>
15901600
///
15911601
/// <para>
1592-
/// Valid for Cluster Type: Multi-AZ DB clusters only
1602+
/// Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
15931603
/// </para>
15941604
///
15951605
/// <para>

‎sdk/src/Services/RDS/Generated/Model/CreateDBInstanceReadReplicaRequest.cs

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -127,6 +127,10 @@ public CreateDBInstanceReadReplicaRequest(string dbInstanceIdentifier, string so
127127
/// The amount of storage (in gibibytes) to allocate initially for the read replica. Follow
128128
/// the allocation rules specified in <c>CreateDBInstance</c>.
129129
/// </para>
130+
///
131+
/// <para>
132+
/// This setting isn't valid for RDS for SQL Server.
133+
/// </para>
130134
/// <note>
131135
/// <para>
132136
/// Be sure to allocate enough storage for your read replica so that the create operation
@@ -293,8 +297,13 @@ internal bool IsSetCustomIamInstanceProfile()
293297
/// <summary>
294298
/// Gets and sets the property DatabaseInsightsMode.
295299
/// <para>
296-
/// Specifies the mode of Database Insights.
300+
/// The mode of Database Insights to enable for the read replica.
297301
/// </para>
302+
/// <note>
303+
/// <para>
304+
/// Currently, this setting is not supported.
305+
/// </para>
306+
/// </note>
298307
/// </summary>
299308
public DatabaseInsightsMode DatabaseInsightsMode
300309
{

‎sdk/src/Services/RDS/Generated/Model/CreateDBInstanceRequest.cs

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -592,8 +592,17 @@ internal bool IsSetCustomIamInstanceProfile()
592592
/// <summary>
593593
/// Gets and sets the property DatabaseInsightsMode.
594594
/// <para>
595-
/// Specifies the mode of Database Insights to enable for the instance.
595+
/// The mode of Database Insights to enable for the DB instance.
596596
/// </para>
597+
///
598+
/// <para>
599+
/// This setting only applies to Amazon Aurora DB instances.
600+
/// </para>
601+
/// <note>
602+
/// <para>
603+
/// Currently, this value is inherited from the DB cluster and can't be changed.
604+
/// </para>
605+
/// </note>
597606
/// </summary>
598607
public DatabaseInsightsMode DatabaseInsightsMode
599608
{

‎sdk/src/Services/RDS/Generated/Model/DBCluster.cs

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -290,7 +290,7 @@ internal bool IsSetAutomaticRestartTime()
290290
/// </para>
291291
///
292292
/// <para>
293-
/// This setting is only for non-Aurora Multi-AZ DB clusters.
293+
/// This setting is for Aurora DB clusters and Multi-AZ DB clusters.
294294
/// </para>
295295
/// </summary>
296296
public bool AutoMinorVersionUpgrade
@@ -568,7 +568,7 @@ internal bool IsSetCustomEndpoints()
568568
/// <summary>
569569
/// Gets and sets the property DatabaseInsightsMode.
570570
/// <para>
571-
/// The mode of Database Insights that is enabled for the cluster.
571+
/// The mode of Database Insights that is enabled for the DB cluster.
572572
/// </para>
573573
/// </summary>
574574
public DatabaseInsightsMode DatabaseInsightsMode
@@ -1250,7 +1250,7 @@ internal bool IsSetMasterUserSecret()
12501250
/// </para>
12511251
///
12521252
/// <para>
1253-
/// This setting is only for non-Aurora Multi-AZ DB clusters.
1253+
/// This setting is only for -Aurora DB clusters and Multi-AZ DB clusters.
12541254
/// </para>
12551255
/// </summary>
12561256
public int MonitoringInterval
@@ -1273,7 +1273,7 @@ internal bool IsSetMonitoringInterval()
12731273
/// </para>
12741274
///
12751275
/// <para>
1276-
/// This setting is only for non-Aurora Multi-AZ DB clusters.
1276+
/// This setting is only for Aurora DB clusters and Multi-AZ DB clusters.
12771277
/// </para>
12781278
/// </summary>
12791279
public string MonitoringRoleArn
@@ -1387,7 +1387,7 @@ internal bool IsSetPercentProgress()
13871387
/// </para>
13881388
///
13891389
/// <para>
1390-
/// This setting is only for non-Aurora Multi-AZ DB clusters.
1390+
/// This setting is only for Aurora DB clusters and Multi-AZ DB clusters.
13911391
/// </para>
13921392
/// </summary>
13931393
public bool PerformanceInsightsEnabled
@@ -1415,7 +1415,7 @@ internal bool IsSetPerformanceInsightsEnabled()
14151415
/// </para>
14161416
///
14171417
/// <para>
1418-
/// This setting is only for non-Aurora Multi-AZ DB clusters.
1418+
/// This setting is only for Aurora DB clusters and Multi-AZ DB clusters.
14191419
/// </para>
14201420
/// </summary>
14211421
public string PerformanceInsightsKMSKeyId
@@ -1437,7 +1437,7 @@ internal bool IsSetPerformanceInsightsKMSKeyId()
14371437
/// </para>
14381438
///
14391439
/// <para>
1440-
/// This setting is only for non-Aurora Multi-AZ DB clusters.
1440+
/// This setting is only for Aurora DB clusters and Multi-AZ DB clusters.
14411441
/// </para>
14421442
///
14431443
/// <para>

‎sdk/src/Services/RDS/Generated/Model/DescribeDBClusterParametersRequest.cs

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,12 @@ internal bool IsSetDBClusterParameterGroupName()
8383
/// <summary>
8484
/// Gets and sets the property Filters.
8585
/// <para>
86-
/// This parameter isn't currently supported.
86+
/// A filter that specifies one or more DB cluster parameters to describe.
87+
/// </para>
88+
///
89+
/// <para>
90+
/// The only supported filter is <c>parameter-name</c>. The results list only includes
91+
/// information about the DB cluster parameters with these names.
8792
/// </para>
8893
/// </summary>
8994
public List<Filter> Filters
@@ -157,15 +162,15 @@ internal bool IsSetMaxRecords()
157162
/// </para>
158163
/// <ul> <li>
159164
/// <para>
160-
/// <c>customer</c>
165+
/// <c>engine-default</c>
161166
/// </para>
162167
/// </li> <li>
163168
/// <para>
164-
/// <c>engine</c>
169+
/// <c>system</c>
165170
/// </para>
166171
/// </li> <li>
167172
/// <para>
168-
/// <c>service</c>
173+
/// <c>user</c>
169174
/// </para>
170175
/// </li> </ul>
171176
/// </summary>

‎sdk/src/Services/RDS/Generated/Model/DescribeDBParametersRequest.cs

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,12 @@ internal bool IsSetDBParameterGroupName()
8686
/// <summary>
8787
/// Gets and sets the property Filters.
8888
/// <para>
89-
/// This parameter isn't currently supported.
89+
/// A filter that specifies one or more DB parameters to describe.
90+
/// </para>
91+
///
92+
/// <para>
93+
/// The only supported filter is <c>parameter-name</c>. The results list only includes
94+
/// information about the DB parameters with these names.
9095
/// </para>
9196
/// </summary>
9297
public List<Filter> Filters

‎sdk/src/Services/RDS/Generated/Model/DescribeEngineDefaultParametersRequest.cs

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -278,7 +278,12 @@ internal bool IsSetDBParameterGroupFamily()
278278
/// <summary>
279279
/// Gets and sets the property Filters.
280280
/// <para>
281-
/// This parameter isn't currently supported.
281+
/// A filter that specifies one or more parameters to describe.
282+
/// </para>
283+
///
284+
/// <para>
285+
/// The only supported filter is <c>parameter-name</c>. The results list only includes
286+
/// information about the parameters with these names.
282287
/// </para>
283288
/// </summary>
284289
public List<Filter> Filters

0 commit comments

Comments
 (0)