diff --git a/.changes/1.35.89.json b/.changes/1.35.89.json new file mode 100644 index 0000000000..5de6390c0f --- /dev/null +++ b/.changes/1.35.89.json @@ -0,0 +1,7 @@ +[ + { + "category": "``rds``", + "description": "Updates Amazon RDS documentation to correct various descriptions.", + "type": "api-change" + } +] \ No newline at end of file diff --git a/CHANGELOG.rst b/CHANGELOG.rst index 8a6791eb8c..3de78bcd18 100644 --- a/CHANGELOG.rst +++ b/CHANGELOG.rst @@ -2,6 +2,12 @@ CHANGELOG ========= +1.35.89 +======= + +* api-change:``rds``: Updates Amazon RDS documentation to correct various descriptions. + + 1.35.88 ======= diff --git a/botocore/__init__.py b/botocore/__init__.py index 8dbf48b71a..8b19242175 100644 --- a/botocore/__init__.py +++ b/botocore/__init__.py @@ -16,7 +16,7 @@ import os import re -__version__ = '1.35.88' +__version__ = '1.35.89' class NullHandler(logging.Handler): diff --git a/botocore/data/rds/2014-10-31/service-2.json b/botocore/data/rds/2014-10-31/service-2.json index 318afb7638..e4e051dc96 100644 --- a/botocore/data/rds/2014-10-31/service-2.json +++ b/botocore/data/rds/2014-10-31/service-2.json @@ -3669,11 +3669,11 @@ "members":{ "EnableLogTypes":{ "shape":"LogTypeList", - "documentation":"
The list of log types to enable.
" + "documentation":"The list of log types to enable.
The following values are valid for each DB engine:
Aurora MySQL - audit | error | general | slowquery
Aurora PostgreSQL - postgresql
RDS for MySQL - error | general | slowquery
RDS for PostgreSQL - postgresql | upgrade
The list of log types to disable.
" + "documentation":"The list of log types to disable.
The following values are valid for each DB engine:
Aurora MySQL - audit | error | general | slowquery
Aurora PostgreSQL - postgresql
RDS for MySQL - error | general | slowquery
RDS for PostgreSQL - postgresql | upgrade
The configuration setting for the log types to be enabled for export to CloudWatch Logs for a specific DB instance or DB cluster.
The EnableLogTypes
and DisableLogTypes
arrays determine which logs will be exported (or not exported) to CloudWatch Logs. The values within these arrays depend on the DB engine being used.
For more information about exporting CloudWatch Logs for Amazon RDS DB instances, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.
For more information about exporting CloudWatch Logs for Amazon Aurora DB clusters, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.
" @@ -4298,31 +4298,31 @@ }, "AutoMinorVersionUpgrade":{ "shape":"BooleanOptional", - "documentation":"Specifies whether minor engine upgrades are applied automatically to the DB cluster during the maintenance window. By default, minor engine upgrades are applied automatically.
Valid for Cluster Type: Multi-AZ DB clusters only
" + "documentation":"Specifies whether minor engine upgrades are applied automatically to the DB cluster during the maintenance window. By default, minor engine upgrades are applied automatically.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB cluster
" }, "MonitoringInterval":{ "shape":"IntegerOptional", - "documentation":"The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster. To turn off collecting Enhanced Monitoring metrics, specify 0
.
If MonitoringRoleArn
is specified, also set MonitoringInterval
to a value other than 0
.
Valid for Cluster Type: Multi-AZ DB clusters only
Valid Values: 0 | 1 | 5 | 10 | 15 | 30 | 60
Default: 0
The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster. To turn off collecting Enhanced Monitoring metrics, specify 0
.
If MonitoringRoleArn
is specified, also set MonitoringInterval
to a value other than 0
.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Valid Values: 0 | 1 | 5 | 10 | 15 | 30 | 60
Default: 0
The Amazon Resource Name (ARN) for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs. An example is arn:aws:iam:123456789012:role/emaccess
. For information on creating a monitoring role, see Setting 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
" + "documentation":"The Amazon Resource Name (ARN) for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs. An example is arn:aws:iam:123456789012:role/emaccess
. For information on creating a monitoring role, see Setting 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":{ "shape":"DatabaseInsightsMode", - "documentation":"Specifies the mode of Database Insights to enable for the cluster.
" + "documentation":"The mode of Database Insights to enable for the DB cluster.
If you set this value to advanced
, you must also set the PerformanceInsightsEnabled
parameter to true
and the PerformanceInsightsRetentionPeriod
parameter to 465.
Valid for Cluster Type: Aurora DB clusters only
" }, "EnablePerformanceInsights":{ "shape":"BooleanOptional", - "documentation":"Specifies whether to turn on Performance Insights for the DB cluster.
For more information, see Using Amazon Performance Insights in the Amazon RDS User Guide.
Valid for Cluster Type: Multi-AZ DB clusters only
" + "documentation":"Specifies whether to turn on Performance Insights for the DB cluster.
For more information, see Using Amazon Performance Insights in the Amazon RDS User Guide.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
" }, "PerformanceInsightsKMSKeyId":{ "shape":"String", - "documentation":"The Amazon Web Services KMS key identifier for encryption of Performance Insights data.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
If you don't specify a value for PerformanceInsightsKMSKeyId
, 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.
Valid for Cluster Type: Multi-AZ DB clusters only
" + "documentation":"The Amazon Web Services KMS key identifier for encryption of Performance Insights data.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
If you don't specify a value for PerformanceInsightsKMSKeyId
, 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.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
" }, "PerformanceInsightsRetentionPeriod":{ "shape":"IntegerOptional", - "documentation":"The number of days to retain Performance Insights data.
Valid for Cluster Type: Multi-AZ DB clusters only
Valid Values:
7
month * 31, where month is a number of months from 1-23. Examples: 93
(3 months * 31), 341
(11 months * 31), 589
(19 months * 31)
731
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.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Valid Values:
7
month * 31, where month is a number of months from 1-23. Examples: 93
(3 months * 31), 341
(11 months * 31), 589
(19 months * 31)
731
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.
" + "documentation":"The mode of Database Insights to enable for the DB instance.
This setting only applies to Amazon Aurora DB instances.
Currently, this value is inherited from the DB cluster and can't be changed.
Specifies the mode of Database Insights.
" + "documentation":"The mode of Database Insights to enable for the read replica.
Currently, this setting is not supported.
The amount of storage (in gibibytes) to allocate initially for the read replica. Follow the allocation rules specified in CreateDBInstance
.
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.
The amount of storage (in gibibytes) to allocate initially for the read replica. Follow the allocation rules specified in CreateDBInstance
.
This setting isn't valid for RDS for SQL Server.
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.
Indicates whether minor version patches are applied automatically.
This setting is only for non-Aurora Multi-AZ DB clusters.
" + "documentation":"Indicates whether minor version patches are applied automatically.
This setting is for Aurora DB clusters and Multi-AZ DB clusters.
" }, "MonitoringInterval":{ "shape":"IntegerOptional", - "documentation":"The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster.
This setting is only for non-Aurora Multi-AZ DB clusters.
" + "documentation":"The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster.
This setting is only for -Aurora DB clusters and Multi-AZ DB clusters.
" }, "MonitoringRoleArn":{ "shape":"String", - "documentation":"The ARN for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.
This setting is only for non-Aurora Multi-AZ DB clusters.
" + "documentation":"The ARN for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.
This setting is only for Aurora DB clusters and Multi-AZ DB clusters.
" }, "DatabaseInsightsMode":{ "shape":"DatabaseInsightsMode", - "documentation":"The mode of Database Insights that is enabled for the cluster.
" + "documentation":"The mode of Database Insights that is enabled for the DB cluster.
" }, "PerformanceInsightsEnabled":{ "shape":"BooleanOptional", - "documentation":"Indicates whether Performance Insights is enabled for the DB cluster.
This setting is only for non-Aurora Multi-AZ DB clusters.
" + "documentation":"Indicates whether Performance Insights is enabled for the DB cluster.
This setting is only for Aurora DB clusters and Multi-AZ DB clusters.
" }, "PerformanceInsightsKMSKeyId":{ "shape":"String", - "documentation":"The Amazon Web Services KMS key identifier for encryption of Performance Insights data.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
This setting is only for non-Aurora Multi-AZ DB clusters.
" + "documentation":"The Amazon Web Services KMS key identifier for encryption of Performance Insights data.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
This setting is only for Aurora DB clusters and Multi-AZ DB clusters.
" }, "PerformanceInsightsRetentionPeriod":{ "shape":"IntegerOptional", - "documentation":"The number of days to retain Performance Insights data.
This setting is only for non-Aurora Multi-AZ DB clusters.
Valid Values:
7
month * 31, where month is a number of months from 1-23. Examples: 93
(3 months * 31), 341
(11 months * 31), 589
(19 months * 31)
731
Default: 7
days
The number of days to retain Performance Insights data.
This setting is only for Aurora DB clusters and Multi-AZ DB clusters.
Valid Values:
7
month * 31, where month is a number of months from 1-23. Examples: 93
(3 months * 31), 341
(11 months * 31), 589
(19 months * 31)
731
Default: 7
days
A specific source to return parameters for.
Valid Values:
customer
engine
service
A specific source to return parameters for.
Valid Values:
engine-default
system
user
This parameter isn't currently supported.
" + "documentation":"A filter that specifies one or more DB cluster parameters to describe.
The 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.
" + "documentation":"A filter that specifies one or more DB parameters to describe.
The 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.
" + "documentation":"A filter that specifies one or more parameters to describe.
The 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. By default, minor engine upgrades are applied automatically.
Valid for Cluster Type: Multi-AZ DB clusters only
" + "documentation":"Specifies whether minor engine upgrades are applied automatically to the DB cluster during the maintenance window. By default, minor engine upgrades are applied automatically.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
" }, "MonitoringInterval":{ "shape":"IntegerOptional", @@ -12407,7 +12407,7 @@ }, "DatabaseInsightsMode":{ "shape":"DatabaseInsightsMode", - "documentation":"Specifies the mode of Database Insights to enable for the cluster.
" + "documentation":"Specifies the mode of Database Insights to enable for the DB cluster.
If you change the value from standard
to advanced
, you must set the PerformanceInsightsEnabled
parameter to true
and the PerformanceInsightsRetentionPeriod
parameter to 465.
If you change the value from advanced
to standard
, you must set the PerformanceInsightsEnabled
parameter to false
.
Valid for Cluster Type: Aurora DB clusters only
" }, "EnablePerformanceInsights":{ "shape":"BooleanOptional", @@ -12415,11 +12415,11 @@ }, "PerformanceInsightsKMSKeyId":{ "shape":"String", - "documentation":"The Amazon Web Services KMS key identifier for encryption of Performance Insights data.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
If you don't specify a value for PerformanceInsightsKMSKeyId
, 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.
Valid for Cluster Type: Multi-AZ DB clusters only
" + "documentation":"The Amazon Web Services KMS key identifier for encryption of Performance Insights data.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
If you don't specify a value for PerformanceInsightsKMSKeyId
, 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.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
" }, "PerformanceInsightsRetentionPeriod":{ "shape":"IntegerOptional", - "documentation":"The number of days to retain Performance Insights data.
Valid for Cluster Type: Multi-AZ DB clusters only
Valid Values:
7
month * 31, where month is a number of months from 1-23. Examples: 93
(3 months * 31), 341
(11 months * 31), 589
(19 months * 31)
731
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.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Valid Values:
7
month * 31, where month is a number of months from 1-23. Examples: 93
(3 months * 31), 341
(11 months * 31), 589
(19 months * 31)
731
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.
" + "documentation":"Specifies the mode of Database Insights to enable for the DB instance.
This setting only applies to Amazon Aurora DB instances.
Currently, this value is inherited from the DB cluster and can't be changed.
The log types to be enabled for export to CloudWatch Logs for a specific DB instance.
A change to the CloudwatchLogsExportConfiguration
parameter is always applied to the DB instance immediately. Therefore, the ApplyImmediately
parameter has no effect.
This setting doesn't apply to RDS Custom DB instances.
" + "documentation":"The log types to be enabled for export to CloudWatch Logs for a specific DB instance.
A change to the CloudwatchLogsExportConfiguration
parameter is always applied to the DB instance immediately. Therefore, the ApplyImmediately
parameter has no effect.
This setting doesn't apply to RDS Custom DB instances.
The following values are valid for each DB engine:
Aurora MySQL - audit | error | general | slowquery
Aurora PostgreSQL - postgresql
RDS for MySQL - error | general | slowquery
RDS for PostgreSQL - postgresql | upgrade
For more information about exporting CloudWatch Logs for Amazon RDS, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.
For more information about exporting CloudWatch Logs for Amazon Aurora, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.
" }, "ProcessorFeatures":{ "shape":"ProcessorFeatureList", @@ -15474,7 +15474,7 @@ }, "AllocatedStorage":{ "shape":"IntegerOptional", - "documentation":"The amount of storage (in gibibytes) to allocate initially for the DB instance. 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. You can also allocate additional storage for future growth.
The amount of storage (in gibibytes) to allocate initially for the DB instance. Follow the allocation rules specified in CreateDBInstance.
This setting isn't valid for RDS for SQL Server.
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.
The amount of storage (in gibibytes) to allocate initially for the DB instance. 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. You can also allocate additional storage for future growth.
The amount of storage (in gibibytes) to allocate initially for the DB instance. Follow the allocation rules specified in CreateDBInstance
.
This setting isn't valid for RDS for SQL Server.
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.
Specifies the mode of Database Insights to enable for the instance.
" + "documentation":"Specifies the mode of Database Insights to enable for the DB instance.
This setting only applies to Amazon Aurora DB instances.
Currently, this value is inherited from the DB cluster and can't be changed.
The amount of storage (in gibibytes) to allocate initially for the DB instance. 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. You can also allocate additional storage for future growth.
The amount of storage (in gibibytes) to allocate initially for the DB instance. Follow the allocation rules specified in CreateDBInstance
.
This setting isn't valid for RDS for SQL Server.
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.