Skip to content

Commit

Permalink
docs(client-rds): Updates Amazon RDS documentation to correct various…
Browse files Browse the repository at this point in the history 
… descriptions.
  • Loading branch information
awstools committed Dec 27, 2024
1 parent d6160ef commit b0b5547
Show file tree
Hide file tree
Showing 3 changed files with 152 additions and 61 deletions.
43 changes: 27 additions & 16 deletions clients/client-rds/src/models/models_0.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5227,7 +5227,7 @@ export interface CreateDBClusterMessage {
/**
* <p>Specifies whether minor engine upgrades are applied automatically to the DB cluster during the maintenance window.
* By default, minor engine upgrades are applied automatically.</p>
* <p>Valid for Cluster Type: Multi-AZ DB clusters only</p>
* <p>Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB cluster</p>
* @public
*/
AutoMinorVersionUpgrade?: boolean | undefined;
Expand All @@ -5237,7 +5237,7 @@ export interface CreateDBClusterMessage {
* collecting Enhanced Monitoring metrics, specify <code>0</code>.</p>
* <p>If <code>MonitoringRoleArn</code> is specified, also set <code>MonitoringInterval</code>
* to a value other than <code>0</code>.</p>
* <p>Valid for Cluster Type: Multi-AZ DB clusters only</p>
* <p>Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters</p>
* <p>Valid Values: <code>0 | 1 | 5 | 10 | 15 | 30 | 60</code>
* </p>
* <p>Default: <code>0</code>
Expand All @@ -5252,13 +5252,16 @@ export interface CreateDBClusterMessage {
* see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Monitoring.OS.html#USER_Monitoring.OS.Enabling">Setting
* up and enabling Enhanced Monitoring</a> in the <i>Amazon RDS User Guide</i>.</p>
* <p>If <code>MonitoringInterval</code> is set to a value other than <code>0</code>, supply a <code>MonitoringRoleArn</code> value.</p>
* <p>Valid for Cluster Type: Multi-AZ DB clusters only</p>
* <p>Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters</p>
* @public
*/
MonitoringRoleArn?: string | undefined;

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

/**
* <p>The number of days to retain Performance Insights data.</p>
* <p>Valid for Cluster Type: Multi-AZ DB clusters only</p>
* <p>Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters</p>
* <p>Valid Values:</p>
* <ul>
* <li>
Expand Down Expand Up @@ -6412,49 +6415,49 @@ export interface DBCluster {

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

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

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

/**
* <p>The mode of Database Insights that is enabled for the cluster.</p>
* <p>The mode of Database Insights that is enabled for the DB cluster.</p>
* @public
*/
DatabaseInsightsMode?: DatabaseInsightsMode | undefined;

/**
* <p>Indicates whether Performance Insights is enabled for the DB cluster.</p>
* <p>This setting is only for non-Aurora Multi-AZ DB clusters.</p>
* <p>This setting is only for Aurora DB clusters and Multi-AZ DB clusters.</p>
* @public
*/
PerformanceInsightsEnabled?: boolean | undefined;

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

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

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

/**
* <p>Specifies the mode of Database Insights.</p>
* <p>The mode of Database Insights to enable for the read replica.</p>
* <note>
* <p>Currently, this setting is not supported.</p>
* </note>
* @public
*/
DatabaseInsightsMode?: DatabaseInsightsMode | undefined;
Expand Down Expand Up @@ -10665,6 +10675,7 @@ export interface CreateDBInstanceReadReplicaMessage {
/**
* <p>The amount of storage (in gibibytes) to allocate initially for the read replica.
* Follow the allocation rules specified in <code>CreateDBInstance</code>.</p>
* <p>This setting isn't valid for RDS for SQL Server.</p>
* <note>
* <p>Be sure to allocate enough storage for your read replica so that the create operation can succeed.
* You can also allocate additional storage for future growth.</p>
Expand Down
104 changes: 92 additions & 12 deletions clients/client-rds/src/models/models_1.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -976,17 +976,17 @@ export interface DescribeDBClusterParametersMessage {
* <ul>
* <li>
* <p>
* <code>customer</code>
* <code>engine-default</code>
* </p>
* </li>
* <li>
* <p>
* <code>engine</code>
* <code>system</code>
* </p>
* </li>
* <li>
* <p>
* <code>service</code>
* <code>user</code>
* </p>
* </li>
* </ul>
Expand All @@ -995,7 +995,8 @@ export interface DescribeDBClusterParametersMessage {
Source?: string | undefined;

/**
* <p>This parameter isn't currently supported.</p>
* <p>A filter that specifies one or more DB cluster parameters to describe.</p>
* <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>
* @public
*/
Filters?: Filter[] | undefined;
Expand Down Expand Up @@ -2076,7 +2077,8 @@ export interface DescribeDBParametersMessage {
Source?: string | undefined;

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

/**
* <p>This parameter isn't currently supported.</p>
* <p>A filter that specifies one or more parameters to describe.</p>
* <p>The only supported filter is <code>parameter-name</code>. The results list only includes information about the parameters with these names.</p>
* @public
*/
Filters?: Filter[] | undefined;
Expand Down Expand Up @@ -7413,12 +7416,50 @@ export interface ModifyCustomDBEngineVersionMessage {
export interface CloudwatchLogsExportConfiguration {
/**
* <p>The list of log types to enable.</p>
* <p>The following values are valid for each DB engine:</p>
* <ul>
* <li>
* <p>Aurora MySQL - <code>audit | error | general | slowquery</code>
* </p>
* </li>
* <li>
* <p>Aurora PostgreSQL - <code>postgresql</code>
* </p>
* </li>
* <li>
* <p>RDS for MySQL - <code>error | general | slowquery</code>
* </p>
* </li>
* <li>
* <p>RDS for PostgreSQL - <code>postgresql | upgrade</code>
* </p>
* </li>
* </ul>
* @public
*/
EnableLogTypes?: string[] | undefined;

/**
* <p>The list of log types to disable.</p>
* <p>The following values are valid for each DB engine:</p>
* <ul>
* <li>
* <p>Aurora MySQL - <code>audit | error | general | slowquery</code>
* </p>
* </li>
* <li>
* <p>Aurora PostgreSQL - <code>postgresql</code>
* </p>
* </li>
* <li>
* <p>RDS for MySQL - <code>error | general | slowquery</code>
* </p>
* </li>
* <li>
* <p>RDS for PostgreSQL - <code>postgresql | upgrade</code>
* </p>
* </li>
* </ul>
* @public
*/
DisableLogTypes?: string[] | undefined;
Expand Down Expand Up @@ -7863,7 +7904,7 @@ export interface ModifyDBClusterMessage {
/**
* <p>Specifies whether minor engine upgrades are applied automatically to the DB cluster during the maintenance window.
* By default, minor engine upgrades are applied automatically.</p>
* <p>Valid for Cluster Type: Multi-AZ DB clusters only</p>
* <p>Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters</p>
* @public
*/
AutoMinorVersionUpgrade?: boolean | undefined;
Expand Down Expand Up @@ -7895,7 +7936,13 @@ export interface ModifyDBClusterMessage {
MonitoringRoleArn?: string | undefined;

/**
* <p>Specifies the mode of Database Insights to enable for the cluster.</p>
* <p>Specifies the mode of Database Insights to enable for the DB cluster.</p>
* <p>If you change the value from <code>standard</code> to <code>advanced</code>, you must set the
* <code>PerformanceInsightsEnabled</code> parameter to <code>true</code> and the
* <code>PerformanceInsightsRetentionPeriod</code> parameter to 465.</p>
* <p>If you change the value from <code>advanced</code> to <code>standard</code>, you must
* set the <code>PerformanceInsightsEnabled</code> parameter to <code>false</code>.</p>
* <p>Valid for Cluster Type: Aurora DB clusters only</p>
* @public
*/
DatabaseInsightsMode?: DatabaseInsightsMode | undefined;
Expand All @@ -7915,14 +7962,14 @@ export interface ModifyDBClusterMessage {
* <p>If you don't specify a value for <code>PerformanceInsightsKMSKeyId</code>, then Amazon RDS
* uses your default KMS key. There is a default KMS key for your Amazon Web Services account.
* Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.</p>
* <p>Valid for Cluster Type: Multi-AZ DB clusters only</p>
* <p>Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters</p>
* @public
*/
PerformanceInsightsKMSKeyId?: string | undefined;

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

/**
* <p>Specifies the mode of Database Insights to enable for the instance.</p>
* <p>Specifies the mode of Database Insights to enable for the DB instance.</p>
* <p>This setting only applies to Amazon Aurora DB instances.</p>
* <note>
* <p>Currently, this value is inherited from the DB cluster and can't be changed.</p>
* </note>
* @public
*/
DatabaseInsightsMode?: DatabaseInsightsMode | undefined;
Expand Down Expand Up @@ -9137,6 +9188,28 @@ export interface ModifyDBInstanceMessage {
* <p>A change to the <code>CloudwatchLogsExportConfiguration</code> parameter is always applied to the DB instance
* immediately. Therefore, the <code>ApplyImmediately</code> parameter has no effect.</p>
* <p>This setting doesn't apply to RDS Custom DB instances.</p>
* <p>The following values are valid for each DB engine:</p>
* <ul>
* <li>
* <p>Aurora MySQL - <code>audit | error | general | slowquery</code>
* </p>
* </li>
* <li>
* <p>Aurora PostgreSQL - <code>postgresql</code>
* </p>
* </li>
* <li>
* <p>RDS for MySQL - <code>error | general | slowquery</code>
* </p>
* </li>
* <li>
* <p>RDS for PostgreSQL - <code>postgresql | upgrade</code>
* </p>
* </li>
* </ul>
* <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">
* Publishing Database Logs to Amazon CloudWatch Logs</a> in the <i>Amazon RDS User Guide</i>.</p>
* <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>
* @public
*/
CloudwatchLogsExportConfiguration?: CloudwatchLogsExportConfiguration | undefined;
Expand Down Expand Up @@ -13198,6 +13271,7 @@ export interface RestoreDBInstanceFromDBSnapshotMessage {
/**
* <p>The amount of storage (in gibibytes) to allocate initially for the DB instance. Follow the allocation rules specified in
* CreateDBInstance.</p>
* <p>This setting isn't valid for RDS for SQL Server.</p>
* <note>
* <p>Be sure to allocate enough storage for your new DB instance so that the restore operation can succeed. You can also
* allocate additional storage for future growth.</p>
Expand Down Expand Up @@ -13293,6 +13367,7 @@ export interface RestoreDBInstanceFromS3Message {
/**
* <p>The amount of storage (in gibibytes) to allocate initially for the DB instance.
* Follow the allocation rules specified in <code>CreateDBInstance</code>.</p>
* <p>This setting isn't valid for RDS for SQL Server.</p>
* <note>
* <p>Be sure to allocate enough storage for your new DB instance so that the restore operation can succeed.
* You can also allocate additional storage for future growth.</p>
Expand Down Expand Up @@ -13678,7 +13753,11 @@ export interface RestoreDBInstanceFromS3Message {
S3IngestionRoleArn: string | undefined;

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

0 comments on commit b0b5547

Please sign in to comment.