diff --git a/tools/code-generation/smithy/api-descriptions/rds.json b/tools/code-generation/smithy/api-descriptions/rds.json index 7906ba4e51e..d41295db5b1 100644 --- a/tools/code-generation/smithy/api-descriptions/rds.json +++ b/tools/code-generation/smithy/api-descriptions/rds.json @@ -2906,13 +2906,13 @@ "EnableLogTypes": { "target": "com.amazonaws.rds#LogTypeList", "traits": { - "smithy.api#documentation": "
The list of log types to enable.
" + "smithy.api#documentation": "The list of log types to enable.
\nThe following values are valid for each DB engine:
\nAurora MySQL - audit | error | general | slowquery
\n
Aurora PostgreSQL - postgresql
\n
RDS for MySQL - error | general | slowquery
\n
RDS for PostgreSQL - postgresql | upgrade
\n
The list of log types to disable.
" + "smithy.api#documentation": "The list of log types to disable.
\nThe following values are valid for each DB engine:
\nAurora MySQL - audit | error | general | slowquery
\n
Aurora PostgreSQL - postgresql
\n
RDS for MySQL - error | general | slowquery
\n
RDS for PostgreSQL - postgresql | upgrade
\n
Specifies whether minor engine upgrades are applied automatically to the DB cluster during the maintenance window. \n By default, minor engine upgrades are applied automatically.
\nValid for Cluster Type: Multi-AZ DB clusters only
" + "smithy.api#documentation": "Specifies whether minor engine upgrades are applied automatically to the DB cluster during the maintenance window. \n By default, minor engine upgrades are applied automatically.
\nValid for Cluster Type: Aurora DB clusters and Multi-AZ DB cluster
" } }, "MonitoringInterval": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster. To turn off \n collecting Enhanced Monitoring metrics, specify 0
.
If MonitoringRoleArn
is specified, also set MonitoringInterval
\n to a value other than 0
.
Valid for Cluster Type: Multi-AZ DB clusters only
\nValid Values: 0 | 1 | 5 | 10 | 15 | 30 | 60
\n
Default: 0
\n
The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster. To turn off \n collecting Enhanced Monitoring metrics, specify 0
.
If MonitoringRoleArn
is specified, also set MonitoringInterval
\n to a value other than 0
.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
\nValid Values: 0 | 1 | 5 | 10 | 15 | 30 | 60
\n
Default: 0
\n
The Amazon Resource Name (ARN) for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs. \n An example is arn:aws:iam:123456789012:role/emaccess
. For information on creating a monitoring role,\n see Setting \n up and enabling Enhanced Monitoring in the Amazon RDS User Guide.
If MonitoringInterval
is set to a value other than 0
, supply a MonitoringRoleArn
value.
Valid for Cluster Type: Multi-AZ DB clusters only
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs. \n An example is arn:aws:iam:123456789012:role/emaccess
. For information on creating a monitoring role,\n see Setting \n up and enabling Enhanced Monitoring in the Amazon RDS User Guide.
If MonitoringInterval
is set to a value other than 0
, supply a MonitoringRoleArn
value.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
" } }, "DatabaseInsightsMode": { "target": "com.amazonaws.rds#DatabaseInsightsMode", "traits": { - "smithy.api#documentation": "Specifies the mode of Database Insights to enable for the cluster.
" + "smithy.api#documentation": "The mode of Database Insights to enable for the DB cluster.
\nIf you set this value to advanced
, you must also set the PerformanceInsightsEnabled
\n parameter to true
and the PerformanceInsightsRetentionPeriod
parameter to 465.
Valid for Cluster Type: Aurora DB clusters only
" } }, "EnablePerformanceInsights": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "Specifies whether to turn on Performance Insights for the DB cluster.
\nFor more information, see \n Using Amazon Performance Insights in the Amazon RDS User Guide.
\nValid for Cluster Type: Multi-AZ DB clusters only
" + "smithy.api#documentation": "Specifies whether to turn on Performance Insights for the DB cluster.
\nFor more information, see \n Using Amazon Performance Insights in the Amazon RDS User Guide.
\nValid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
" } }, "PerformanceInsightsKMSKeyId": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The Amazon Web Services KMS key identifier for encryption of Performance Insights data.
\nThe Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
\nIf you don't specify a value for PerformanceInsightsKMSKeyId
, then Amazon RDS \n uses your default KMS key. There is a default KMS key for your Amazon Web Services account. \n Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.
Valid for Cluster Type: Multi-AZ DB clusters only
" + "smithy.api#documentation": "The Amazon Web Services KMS key identifier for encryption of Performance Insights data.
\nThe Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
\nIf you don't specify a value for PerformanceInsightsKMSKeyId
, then Amazon RDS \n uses your default KMS key. There is a default KMS key for your Amazon Web Services account. \n Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
" } }, "PerformanceInsightsRetentionPeriod": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "The number of days to retain Performance Insights data.
\nValid for Cluster Type: Multi-AZ DB clusters only
\nValid Values:
\n\n 7
\n
\n month * 31, where month is a number of months from 1-23. \n Examples: 93
(3 months * 31), 341
(11 months * 31), 589
(19 months * 31)
\n 731
\n
Default: 7
days
If you specify a retention period that isn't valid, such as 94
, Amazon RDS issues an error.
The number of days to retain Performance Insights data.
\nValid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
\nValid Values:
\n\n 7
\n
\n month * 31, where month is a number of months from 1-23. \n Examples: 93
(3 months * 31), 341
(11 months * 31), 589
(19 months * 31)
\n 731
\n
Default: 7
days
If you specify a retention period that isn't valid, such as 94
, Amazon RDS issues an error.
Specifies the mode of Database Insights to enable for the instance.
" + "smithy.api#documentation": "The mode of Database Insights to enable for the DB instance.
\nThis setting only applies to Amazon Aurora DB instances.
\nCurrently, this value is inherited from the DB cluster and can't be changed.
\nSpecifies the mode of Database Insights.
" + "smithy.api#documentation": "The mode of Database Insights to enable for the read replica.
\nCurrently, this setting is not supported.
\nThe amount of storage (in gibibytes) to allocate initially for the read replica.\n Follow the allocation rules specified in CreateDBInstance
.
Be sure to allocate enough storage for your read replica so that the create operation can succeed.\n You can also allocate additional storage for future growth.
\nThe amount of storage (in gibibytes) to allocate initially for the read replica.\n Follow the allocation rules specified in CreateDBInstance
.
This setting isn't valid for RDS for SQL Server.
\nBe sure to allocate enough storage for your read replica so that the create operation can succeed.\n You can also allocate additional storage for future growth.
\nIndicates whether minor version patches are applied automatically.
\nThis setting is only for non-Aurora Multi-AZ DB clusters.
" + "smithy.api#documentation": "Indicates whether minor version patches are applied automatically.
\nThis setting is for Aurora DB clusters and Multi-AZ DB clusters.
" } }, "MonitoringInterval": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster.
\nThis setting is only for non-Aurora Multi-AZ DB clusters.
" + "smithy.api#documentation": "The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster.
\nThis setting is only for -Aurora DB clusters and Multi-AZ DB clusters.
" } }, "MonitoringRoleArn": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The ARN for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.
\nThis setting is only for non-Aurora Multi-AZ DB clusters.
" + "smithy.api#documentation": "The ARN for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.
\nThis setting is only for Aurora DB clusters and Multi-AZ DB clusters.
" } }, "DatabaseInsightsMode": { "target": "com.amazonaws.rds#DatabaseInsightsMode", "traits": { - "smithy.api#documentation": "The mode of Database Insights that is enabled for the cluster.
" + "smithy.api#documentation": "The mode of Database Insights that is enabled for the DB cluster.
" } }, "PerformanceInsightsEnabled": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "Indicates whether Performance Insights is enabled for the DB cluster.
\nThis setting is only for non-Aurora Multi-AZ DB clusters.
" + "smithy.api#documentation": "Indicates whether Performance Insights is enabled for the DB cluster.
\nThis setting is only for Aurora DB clusters and Multi-AZ DB clusters.
" } }, "PerformanceInsightsKMSKeyId": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The Amazon Web Services KMS key identifier for encryption of Performance Insights data.
\nThe Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
\nThis setting is only for non-Aurora Multi-AZ DB clusters.
" + "smithy.api#documentation": "The Amazon Web Services KMS key identifier for encryption of Performance Insights data.
\nThe Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
\nThis setting is only for Aurora DB clusters and Multi-AZ DB clusters.
" } }, "PerformanceInsightsRetentionPeriod": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "The number of days to retain Performance Insights data.
\nThis setting is only for non-Aurora Multi-AZ DB clusters.
\nValid Values:
\n\n 7
\n
\n month * 31, where month is a number of months from 1-23. \n Examples: 93
(3 months * 31), 341
(11 months * 31), 589
(19 months * 31)
\n 731
\n
Default: 7
days
The number of days to retain Performance Insights data.
\nThis setting is only for Aurora DB clusters and Multi-AZ DB clusters.
\nValid Values:
\n\n 7
\n
\n month * 31, where month is a number of months from 1-23. \n Examples: 93
(3 months * 31), 341
(11 months * 31), 589
(19 months * 31)
\n 731
\n
Default: 7
days
A specific source to return parameters for.
\nValid Values:
\n\n customer
\n
\n engine
\n
\n service
\n
A specific source to return parameters for.
\nValid Values:
\n\n engine-default
\n
\n system
\n
\n user
\n
This parameter isn't currently supported.
" + "smithy.api#documentation": "A filter that specifies one or more DB cluster parameters to describe.
\nThe only supported filter is parameter-name
. The results list only includes information about the DB cluster parameters with these names.
This parameter isn't currently supported.
" + "smithy.api#documentation": "A filter that specifies one or more DB parameters to describe.
\nThe only supported filter is parameter-name
. The results list only includes information about the DB parameters with these names.
This parameter isn't currently supported.
" + "smithy.api#documentation": "A filter that specifies one or more parameters to describe.
\nThe only supported filter is parameter-name
. The results list only includes information about the parameters with these names.
Specifies whether minor engine upgrades are applied automatically to the DB cluster during the maintenance window. \n By default, minor engine upgrades are applied automatically.
\nValid for Cluster Type: Multi-AZ DB clusters only
" + "smithy.api#documentation": "Specifies whether minor engine upgrades are applied automatically to the DB cluster during the maintenance window. \n By default, minor engine upgrades are applied automatically.
\nValid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
" } }, "MonitoringInterval": { @@ -21889,7 +21889,7 @@ "DatabaseInsightsMode": { "target": "com.amazonaws.rds#DatabaseInsightsMode", "traits": { - "smithy.api#documentation": "Specifies the mode of Database Insights to enable for the cluster.
" + "smithy.api#documentation": "Specifies the mode of Database Insights to enable for the DB cluster.
\nIf you change the value from standard
to advanced
, you must set the \n PerformanceInsightsEnabled
parameter to true
and the \n PerformanceInsightsRetentionPeriod
parameter to 465.
If you change the value from advanced
to standard
, you must \n set the PerformanceInsightsEnabled
parameter to false
.
Valid for Cluster Type: Aurora DB clusters only
" } }, "EnablePerformanceInsights": { @@ -21901,13 +21901,13 @@ "PerformanceInsightsKMSKeyId": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The Amazon Web Services KMS key identifier for encryption of Performance Insights data.
\nThe Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
\nIf you don't specify a value for PerformanceInsightsKMSKeyId
, then Amazon RDS \n uses your default KMS key. There is a default KMS key for your Amazon Web Services account. \n Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.
Valid for Cluster Type: Multi-AZ DB clusters only
" + "smithy.api#documentation": "The Amazon Web Services KMS key identifier for encryption of Performance Insights data.
\nThe Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
\nIf you don't specify a value for PerformanceInsightsKMSKeyId
, then Amazon RDS \n uses your default KMS key. There is a default KMS key for your Amazon Web Services account. \n Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
" } }, "PerformanceInsightsRetentionPeriod": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "The number of days to retain Performance Insights data.
\nValid for Cluster Type: Multi-AZ DB clusters only
\nValid Values:
\n\n 7
\n
\n month * 31, where month is a number of months from 1-23. \n Examples: 93
(3 months * 31), 341
(11 months * 31), 589
(19 months * 31)
\n 731
\n
Default: 7
days
If you specify a retention period that isn't valid, such as 94
, Amazon RDS issues an error.
The number of days to retain Performance Insights data.
\nValid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
\nValid Values:
\n\n 7
\n
\n month * 31, where month is a number of months from 1-23. \n Examples: 93
(3 months * 31), 341
(11 months * 31), 589
(19 months * 31)
\n 731
\n
Default: 7
days
If you specify a retention period that isn't valid, such as 94
, Amazon RDS issues an error.
Specifies the mode of Database Insights to enable for the instance.
" + "smithy.api#documentation": "Specifies the mode of Database Insights to enable for the DB instance.
\nThis setting only applies to Amazon Aurora DB instances.
\nCurrently, this value is inherited from the DB cluster and can't be changed.
\nThe log types to be enabled for export to CloudWatch Logs for a \n specific DB instance.
\nA change to the CloudwatchLogsExportConfiguration
parameter is always applied to the DB instance \n immediately. Therefore, the ApplyImmediately
parameter has no effect.
This setting doesn't apply to RDS Custom DB instances.
" + "smithy.api#documentation": "The log types to be enabled for export to CloudWatch Logs for a \n specific DB instance.
\nA change to the CloudwatchLogsExportConfiguration
parameter is always applied to the DB instance \n immediately. Therefore, the ApplyImmediately
parameter has no effect.
This setting doesn't apply to RDS Custom DB instances.
\nThe following values are valid for each DB engine:
\nAurora MySQL - audit | error | general | slowquery
\n
Aurora PostgreSQL - postgresql
\n
RDS for MySQL - error | general | slowquery
\n
RDS for PostgreSQL - postgresql | upgrade
\n
For more information about exporting CloudWatch Logs for Amazon RDS, see \n Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.
\nFor more information about exporting CloudWatch Logs for Amazon Aurora, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.
" } }, "ProcessorFeatures": { @@ -28289,7 +28289,7 @@ "AllocatedStorage": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "The amount of storage (in gibibytes) to allocate initially for the DB instance. Follow the allocation rules specified in\n CreateDBInstance.
\nBe sure to allocate enough storage for your new DB instance so that the restore operation can succeed. You can also\n allocate additional storage for future growth.
\nThe amount of storage (in gibibytes) to allocate initially for the DB instance. Follow the allocation rules specified in\n CreateDBInstance.
\nThis setting isn't valid for RDS for SQL Server.
\nBe sure to allocate enough storage for your new DB instance so that the restore operation can succeed. You can also\n allocate additional storage for future growth.
\nThe amount of storage (in gibibytes) to allocate initially for the DB instance.\n Follow the allocation rules specified in CreateDBInstance
.
Be sure to allocate enough storage for your new DB instance so that the restore operation can succeed.\n You can also allocate additional storage for future growth.
\nThe amount of storage (in gibibytes) to allocate initially for the DB instance.\n Follow the allocation rules specified in CreateDBInstance
.
This setting isn't valid for RDS for SQL Server.
\nBe sure to allocate enough storage for your new DB instance so that the restore operation can succeed.\n You can also allocate additional storage for future growth.
\nSpecifies the mode of Database Insights to enable for the instance.
" + "smithy.api#documentation": "Specifies the mode of Database Insights to enable for the DB instance.
\nThis setting only applies to Amazon Aurora DB instances.
\nCurrently, this value is inherited from the DB cluster and can't be changed.
\nThe amount of storage (in gibibytes) to allocate initially for the DB instance.\n Follow the allocation rules specified in CreateDBInstance
.
Be sure to allocate enough storage for your new DB instance so that the restore operation can succeed.\n You can also allocate additional storage for future growth.
\nThe amount of storage (in gibibytes) to allocate initially for the DB instance.\n Follow the allocation rules specified in CreateDBInstance
.
This setting isn't valid for RDS for SQL Server.
\nBe sure to allocate enough storage for your new DB instance so that the restore operation can succeed.\n You can also allocate additional storage for future growth.
\n