aws-sdk-rds 1.146.0 → 1.147.0

data/lib/aws-sdk-rds/db_instance.rb

@@ -483,8 +483,24 @@ module Aws::RDS
       data[:performance_insights_kms_key_id]
     end
 
-    # The amount of time, in days, to retain Performance Insights data.
-    # Valid values are 7 or 731 (2 years).
+    # The number of days to retain Performance Insights data. The default is
+    # 7 days. The following values are valid:
+    #
+    # * 7
+    #
+    # * *month* * 31, where *month* is a number of months from 1-23
+    #
+    # * 731
+    #
+    # For example, the following values are valid:
+    #
+    # * 93 (3 months * 31)
+    #
+    # * 341 (11 months * 31)
+    #
+    # * 589 (19 months * 31)
+    #
+    # * 731
     # @return [Integer]
     def performance_insights_retention_period
       data[:performance_insights_retention_period]
@@ -1119,14 +1135,16 @@ module Aws::RDS
     #     * Web and Express editions: Must be an integer from 20 to 1024.
     # @option options [required, String] :db_instance_class
     #   The compute and memory capacity of the DB instance, for example
-    #   db.m4.large. Not all DB instance classes are available in all Amazon
+    #   db.m5.large. Not all DB instance classes are available in all Amazon
     #   Web Services Regions, or for all database engines. For the full list
     #   of DB instance classes, and availability for your engine, see [DB
-    #   Instance Class][1] in the *Amazon RDS User Guide*.
+    #   instance classes][1] in the *Amazon RDS User Guide* or [Aurora DB
+    #   instance classes][2] in the *Amazon Aurora User Guide*.
     #
     #
     #
     #   [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html
+    #   [2]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Concepts.DBInstanceClass.html
     # @option options [required, String] :engine
     #   The name of the database engine to be used for this instance.
     #
@@ -1221,7 +1239,9 @@ module Aws::RDS
     # @option options [Array<String>] :db_security_groups
     #   A list of DB security groups to associate with this DB instance.
     #
-    #   Default: The default DB security group for the database engine.
+    #   This setting applies to the legacy EC2-Classic platform, which is no
+    #   longer used to create new DB instances. Use the `VpcSecurityGroupIds`
+    #   setting instead.
     # @option options [Array<String>] :vpc_security_group_ids
     #   A list of Amazon EC2 VPC security groups to associate with this DB
     #   instance.
@@ -1315,7 +1335,7 @@ module Aws::RDS
     #
     #   * Can't be set to 0 if the DB instance is a source to read replicas
     #
-    #   * Can't be set to 0 or 35 for an RDS Custom for Oracle DB instance
+    #   * Can't be set to 0 for an RDS Custom for Oracle DB instance
     # @option options [String] :preferred_backup_window
     #   The daily time range during which automated backups are created if
     #   automated backups are enabled, using the `BackupRetentionPeriod`
@@ -1394,11 +1414,16 @@ module Aws::RDS
     #   instance is a Multi-AZ deployment.
     #
     #   This setting doesn't apply to RDS Custom.
+    #
+    #   **Amazon Aurora**
+    #
+    #   Not applicable. DB instance Availability Zones (AZs) are managed by
+    #   the DB cluster.
     # @option options [String] :engine_version
     #   The version number of the database engine to use.
     #
     #   For a list of valid engine versions, use the
-    #   `DescribeDBEngineVersions` action.
+    #   `DescribeDBEngineVersions` operation.
     #
     #   The following are the database engines and links to information about
     #   the major and minor versions that are available with Amazon RDS. Not
@@ -1471,6 +1496,10 @@ module Aws::RDS
     #   `general-public-license`
     #
     #   This setting doesn't apply to RDS Custom.
+    #
+    #   **Amazon Aurora**
+    #
+    #   Not applicable.
     # @option options [Integer] :iops
     #   The amount of Provisioned IOPS (input/output operations per second) to
     #   be initially allocated for the DB instance. For information about
@@ -1482,6 +1511,10 @@ module Aws::RDS
     #   instance. For SQL Server DB instances, must be a multiple between 1
     #   and 50 of the storage amount for the DB instance.
     #
+    #   **Amazon Aurora**
+    #
+    #   Not applicable. Storage is managed by the DB cluster.
+    #
     #
     #
     #   [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Storage.html#USER_PIOPS
@@ -1495,6 +1528,10 @@ module Aws::RDS
     #   instance.
     #
     #   This setting doesn't apply to RDS Custom.
+    #
+    #   **Amazon Aurora**
+    #
+    #   Not applicable.
     # @option options [String] :character_set_name
     #   For supported engines, this value indicates that the DB instance
     #   should be associated with the specified `CharacterSet`.
@@ -1559,11 +1596,19 @@ module Aws::RDS
     #   parameter.
     #
     #   Default: `io1` if the `Iops` parameter is specified, otherwise `gp2`
+    #
+    #   **Amazon Aurora**
+    #
+    #   Not applicable. Storage is managed by the DB cluster.
     # @option options [String] :tde_credential_arn
     #   The ARN from the key store with which to associate the instance for
     #   TDE encryption.
     #
     #   This setting doesn't apply to RDS Custom.
+    #
+    #   **Amazon Aurora**
+    #
+    #   Not applicable.
     # @option options [String] :tde_credential_password
     #   The password for the given ARN from the key store in order to access
     #   the device.
@@ -1617,6 +1662,10 @@ module Aws::RDS
     #
     #   This setting doesn't apply to RDS Custom.
     #
+    #   **Amazon Aurora**
+    #
+    #   Not applicable. The domain is managed by the DB cluster.
+    #
     #
     #
     #   [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/kerberos-authentication.html
@@ -1660,6 +1709,10 @@ module Aws::RDS
     #   the Directory Service.
     #
     #   This setting doesn't apply to RDS Custom.
+    #
+    #   **Amazon Aurora**
+    #
+    #   Not applicable. The domain is managed by the DB cluster.
     # @option options [Integer] :promotion_tier
     #   A value that specifies the order in which an Aurora Replica is
     #   promoted to the primary instance after a failure of the existing
@@ -1687,13 +1740,16 @@ module Aws::RDS
     #   Services Identity and Access Management (IAM) accounts to database
     #   accounts. By default, mapping isn't enabled.
     #
-    #   This setting doesn't apply to RDS Custom or Amazon Aurora. In Aurora,
-    #   mapping Amazon Web Services IAM accounts to database accounts is
-    #   managed by the DB cluster.
-    #
     #   For more information, see [ IAM Database Authentication for MySQL and
     #   PostgreSQL][1] in the *Amazon RDS User Guide*.
     #
+    #   This setting doesn't apply to RDS Custom.
+    #
+    #   **Amazon Aurora**
+    #
+    #   Not applicable. Mapping Amazon Web Services IAM accounts to database
+    #   accounts is managed by the DB cluster.
+    #
     #
     #
     #   [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.IAMDBAuth.html
@@ -1721,8 +1777,27 @@ module Aws::RDS
     #
     #   This setting doesn't apply to RDS Custom.
     # @option options [Integer] :performance_insights_retention_period
-    #   The amount of time, in days, to retain Performance Insights data.
-    #   Valid values are 7 or 731 (2 years).
+    #   The number of days to retain Performance Insights data. The default is
+    #   7 days. The following values are valid:
+    #
+    #   * 7
+    #
+    #   * *month* * 31, where *month* is a number of months from 1-23
+    #
+    #   * 731
+    #
+    #   For example, the following values are valid:
+    #
+    #   * 93 (3 months * 31)
+    #
+    #   * 341 (11 months * 31)
+    #
+    #   * 589 (19 months * 31)
+    #
+    #   * 731
+    #
+    #   If you specify a retention period such as 94, which isn't a valid
+    #   value, RDS issues an error.
     #
     #   This setting doesn't apply to RDS Custom.
     # @option options [Array<String>] :enable_cloudwatch_logs_exports
@@ -1768,6 +1843,10 @@ module Aws::RDS
     #   instance class of the DB instance.
     #
     #   This setting doesn't apply to RDS Custom.
+    #
+    #   **Amazon Aurora**
+    #
+    #   Not applicable.
     # @option options [Boolean] :deletion_protection
     #   A value that indicates whether the DB instance has deletion protection
     #   enabled. The database can't be deleted when deletion protection is
@@ -1794,6 +1873,10 @@ module Aws::RDS
     #
     #   This setting doesn't apply to RDS Custom.
     #
+    #   **Amazon Aurora**
+    #
+    #   Not applicable. Storage is managed by the DB cluster.
+    #
     #
     #
     #   [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PIOPS.StorageTypes.html#USER_PIOPS.Autoscaling
@@ -1998,7 +2081,7 @@ module Aws::RDS
     #   specified DB engine for a cross-Region read replica.
     #
     #   Specifying a parameter group for this operation is only supported for
-    #   Oracle DB instances. It isn't supported for RDS Custom.
+    #   MySQL and Oracle DB instances. It isn't supported for RDS Custom.
     #
     #   Constraints:
     #
@@ -2127,9 +2210,16 @@ module Aws::RDS
     #   This setting doesn't apply to RDS Custom, which uses the same KMS key
     #   as the primary replica.
     # @option options [String] :pre_signed_url
-    #   The URL that contains a Signature Version 4 signed request for the
-    #   `CreateDBInstanceReadReplica` API action in the source Amazon Web
-    #   Services Region that contains the source DB instance.
+    #   When you are creating a read replica from one Amazon Web Services
+    #   GovCloud (US) Region to another or from one China Amazon Web Services
+    #   Region to another, the URL that contains a Signature Version 4 signed
+    #   request for the `CreateDBInstanceReadReplica` API operation in the
+    #   source Amazon Web Services Region that contains the source DB
+    #   instance.
+    #
+    #   This setting applies only to Amazon Web Services GovCloud (US) Regions
+    #   and China Amazon Web Services Regions. It's ignored in other Amazon
+    #   Web Services Regions.
     #
     #   You must specify this parameter when you create an encrypted read
     #   replica from another Amazon Web Services Region by using the Amazon
@@ -2137,32 +2227,31 @@ module Aws::RDS
     #   encrypted read replica in the same Amazon Web Services Region.
     #
     #   The presigned URL must be a valid request for the
-    #   `CreateDBInstanceReadReplica` API action that can be executed in the
-    #   source Amazon Web Services Region that contains the encrypted source
-    #   DB instance. The presigned URL request must contain the following
+    #   `CreateDBInstanceReadReplica` API operation that can run in the source
+    #   Amazon Web Services Region that contains the encrypted source DB
+    #   instance. The presigned URL request must contain the following
     #   parameter values:
     #
     #   * `DestinationRegion` - The Amazon Web Services Region that the
     #     encrypted read replica is created in. This Amazon Web Services
     #     Region is the same one where the `CreateDBInstanceReadReplica`
-    #     action is called that contains this presigned URL.
+    #     operation is called that contains this presigned URL.
     #
     #     For example, if you create an encrypted DB instance in the us-west-1
     #     Amazon Web Services Region, from a source DB instance in the
     #     us-east-2 Amazon Web Services Region, then you call the
-    #     `CreateDBInstanceReadReplica` action in the us-east-1 Amazon Web
+    #     `CreateDBInstanceReadReplica` operation in the us-east-1 Amazon Web
     #     Services Region and provide a presigned URL that contains a call to
-    #     the `CreateDBInstanceReadReplica` action in the us-west-2 Amazon Web
-    #     Services Region. For this example, the `DestinationRegion` in the
-    #     presigned URL must be set to the us-east-1 Amazon Web Services
+    #     the `CreateDBInstanceReadReplica` operation in the us-west-2 Amazon
+    #     Web Services Region. For this example, the `DestinationRegion` in
+    #     the presigned URL must be set to the us-east-1 Amazon Web Services
     #     Region.
     #
-    #   * `KmsKeyId` - The Amazon Web Services KMS key identifier for the key
-    #     to use to encrypt the read replica in the destination Amazon Web
-    #     Services Region. This is the same identifier for both the
-    #     `CreateDBInstanceReadReplica` action that is called in the
-    #     destination Amazon Web Services Region, and the action contained in
-    #     the presigned URL.
+    #   * `KmsKeyId` - The KMS key identifier for the key to use to encrypt
+    #     the read replica in the destination Amazon Web Services Region. This
+    #     is the same identifier for both the `CreateDBInstanceReadReplica`
+    #     operation that is called in the destination Amazon Web Services
+    #     Region, and the operation contained in the presigned URL.
     #
     #   * `SourceDBInstanceIdentifier` - The DB instance identifier for the
     #     encrypted DB instance to be replicated. This identifier must be in
@@ -2181,11 +2270,10 @@ module Aws::RDS
     #   specify `SourceRegion` (or `--source-region` for the CLI) instead of
     #   specifying `PreSignedUrl` manually. Specifying `SourceRegion`
     #   autogenerates a presigned URL that is a valid request for the
-    #   operation that can be executed in the source Amazon Web Services
-    #   Region.
+    #   operation that can run in the source Amazon Web Services Region.
     #
-    #    `SourceRegion` isn't supported for SQL Server, because SQL Server on
-    #   Amazon RDS doesn't support cross-Region read replicas.
+    #    `SourceRegion` isn't supported for SQL Server, because Amazon RDS for
+    #   SQL Server doesn't support cross-Region read replicas.
     #
     #    </note>
     #
@@ -2235,8 +2323,27 @@ module Aws::RDS
     #
     #   This setting doesn't apply to RDS Custom.
     # @option options [Integer] :performance_insights_retention_period
-    #   The amount of time, in days, to retain Performance Insights data.
-    #   Valid values are 7 or 731 (2 years).
+    #   The number of days to retain Performance Insights data. The default is
+    #   7 days. The following values are valid:
+    #
+    #   * 7
+    #
+    #   * *month* * 31, where *month* is a number of months from 1-23
+    #
+    #   * 731
+    #
+    #   For example, the following values are valid:
+    #
+    #   * 93 (3 months * 31)
+    #
+    #   * 341 (11 months * 31)
+    #
+    #   * 589 (19 months * 31)
+    #
+    #   * 731
+    #
+    #   If you specify a retention period such as 94, which isn't a valid
+    #   value, RDS issues an error.
     #
     #   This setting doesn't apply to RDS Custom.
     # @option options [Array<String>] :enable_cloudwatch_logs_exports
@@ -2561,10 +2668,11 @@ module Aws::RDS
     #   `CreateDBInstance`.
     # @option options [String] :db_instance_class
     #   The new compute and memory capacity of the DB instance, for example
-    #   db.m4.large. Not all DB instance classes are available in all Amazon
+    #   db.m5.large. Not all DB instance classes are available in all Amazon
     #   Web Services Regions, or for all database engines. For the full list
     #   of DB instance classes, and availability for your engine, see [DB
-    #   Instance Class][1] in the *Amazon RDS User Guide*.
+    #   instance classes][1] in the *Amazon RDS User Guide* or [Aurora DB
+    #   instance classes][2] in the *Amazon Aurora User Guide*.
     #
     #   If you modify the DB instance class, an outage occurs during the
     #   change. The change is applied during the next maintenance window,
@@ -2577,6 +2685,7 @@ module Aws::RDS
     #
     #
     #   [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html
+    #   [2]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Concepts.DBInstanceClass.html
     # @option options [String] :db_subnet_group_name
     #   The new DB subnet group for the DB instance. You can use this
     #   parameter to move your DB instance to a different VPC. If your DB
@@ -2683,7 +2792,7 @@ module Aws::RDS
     #
     #   Constraints: Must contain from 8 to 128 characters.
     #
-    #   <note markdown="1"> Amazon RDS API actions never return the password, so this action
+    #   <note markdown="1"> Amazon RDS API operations never return the password, so this action
     #   provides a way to regain access to a primary instance user if the
     #   password is lost. This includes restoring privileges that might have
     #   been accidentally revoked.
@@ -2733,8 +2842,8 @@ module Aws::RDS
     #   Constraints:
     #
     #   * It must be a value from 0 to 35. It can't be set to 0 if the DB
-    #     instance is a source to read replicas. It can't be set to 0 or 35
-    #     for an RDS Custom for Oracle DB instance.
+    #     instance is a source to read replicas. It can't be set to 0 for an
+    #     RDS Custom for Oracle DB instance.
     #
     #   * It can be specified for a MySQL read replica only if the source is
     #     running MySQL 5.6 or later.
@@ -3122,7 +3231,7 @@ module Aws::RDS
     #   DB instance.
     #
     #   For more information, see [Using Amazon Performance Insights][1] in
-    #   the *Amazon RDS User Guide.*.
+    #   the *Amazon RDS User Guide*.
     #
     #   This setting doesn't apply to RDS Custom.
     #
@@ -3143,8 +3252,27 @@ module Aws::RDS
     #
     #   This setting doesn't apply to RDS Custom.
     # @option options [Integer] :performance_insights_retention_period
-    #   The amount of time, in days, to retain Performance Insights data.
-    #   Valid values are 7 or 731 (2 years).
+    #   The number of days to retain Performance Insights data. The default is
+    #   7 days. The following values are valid:
+    #
+    #   * 7
+    #
+    #   * *month* * 31, where *month* is a number of months from 1-23
+    #
+    #   * 731
+    #
+    #   For example, the following values are valid:
+    #
+    #   * 93 (3 months * 31)
+    #
+    #   * 341 (11 months * 31)
+    #
+    #   * 589 (19 months * 31)
+    #
+    #   * 731
+    #
+    #   If you specify a retention period such as 94, which isn't a valid
+    #   value, RDS issues an error.
     #
     #   This setting doesn't apply to RDS Custom.
     # @option options [Types::CloudwatchLogsExportConfiguration] :cloudwatch_logs_export_configuration

data/lib/aws-sdk-rds/db_snapshot.rb

@@ -478,39 +478,46 @@ module Aws::RDS
     #   A value that indicates whether to copy all tags from the source DB
     #   snapshot to the target DB snapshot. By default, tags are not copied.
     # @option options [String] :pre_signed_url
-    #   The URL that contains a Signature Version 4 signed request for the
-    #   `CopyDBSnapshot` API action in the source Amazon Web Services Region
-    #   that contains the source DB snapshot to copy.
+    #   When you are copying a snapshot from one Amazon Web Services GovCloud
+    #   (US) Region to another, the URL that contains a Signature Version 4
+    #   signed request for the `CopyDBSnapshot` API operation in the source
+    #   Amazon Web Services Region that contains the source DB snapshot to
+    #   copy.
+    #
+    #   This setting applies only to Amazon Web Services GovCloud (US)
+    #   Regions. It's ignored in other Amazon Web Services Regions.
     #
     #   You must specify this parameter when you copy an encrypted DB snapshot
     #   from another Amazon Web Services Region by using the Amazon RDS API.
     #   Don't specify `PreSignedUrl` when you are copying an encrypted DB
     #   snapshot in the same Amazon Web Services Region.
     #
-    #   The presigned URL must be a valid request for the `CopyDBSnapshot` API
-    #   action that can be executed in the source Amazon Web Services Region
-    #   that contains the encrypted DB snapshot to be copied. The presigned
-    #   URL request must contain the following parameter values:
+    #   The presigned URL must be a valid request for the
+    #   `CopyDBClusterSnapshot` API operation that can run in the source
+    #   Amazon Web Services Region that contains the encrypted DB cluster
+    #   snapshot to copy. The presigned URL request must contain the following
+    #   parameter values:
     #
     #   * `DestinationRegion` - The Amazon Web Services Region that the
     #     encrypted DB snapshot is copied to. This Amazon Web Services Region
-    #     is the same one where the `CopyDBSnapshot` action is called that
+    #     is the same one where the `CopyDBSnapshot` operation is called that
     #     contains this presigned URL.
     #
     #     For example, if you copy an encrypted DB snapshot from the us-west-2
     #     Amazon Web Services Region to the us-east-1 Amazon Web Services
-    #     Region, then you call the `CopyDBSnapshot` action in the us-east-1
-    #     Amazon Web Services Region and provide a presigned URL that contains
-    #     a call to the `CopyDBSnapshot` action in the us-west-2 Amazon Web
-    #     Services Region. For this example, the `DestinationRegion` in the
-    #     presigned URL must be set to the us-east-1 Amazon Web Services
-    #     Region.
-    #
-    #   * `KmsKeyId` - The Amazon Web Services KMS key identifier for the KMS
-    #     key to use to encrypt the copy of the DB snapshot in the destination
-    #     Amazon Web Services Region. This is the same identifier for both the
-    #     `CopyDBSnapshot` action that is called in the destination Amazon Web
-    #     Services Region, and the action contained in the presigned URL.
+    #     Region, then you call the `CopyDBSnapshot` operation in the
+    #     us-east-1 Amazon Web Services Region and provide a presigned URL
+    #     that contains a call to the `CopyDBSnapshot` operation in the
+    #     us-west-2 Amazon Web Services Region. For this example, the
+    #     `DestinationRegion` in the presigned URL must be set to the
+    #     us-east-1 Amazon Web Services Region.
+    #
+    #   * `KmsKeyId` - The KMS key identifier for the KMS key to use to
+    #     encrypt the copy of the DB snapshot in the destination Amazon Web
+    #     Services Region. This is the same identifier for both the
+    #     `CopyDBSnapshot` operation that is called in the destination Amazon
+    #     Web Services Region, and the operation contained in the presigned
+    #     URL.
     #
     #   * `SourceDBSnapshotIdentifier` - The DB snapshot identifier for the
     #     encrypted snapshot to be copied. This identifier must be in the
@@ -527,9 +534,8 @@ module Aws::RDS
     #   <note markdown="1"> If you are using an Amazon Web Services SDK tool or the CLI, you can
     #   specify `SourceRegion` (or `--source-region` for the CLI) instead of
     #   specifying `PreSignedUrl` manually. Specifying `SourceRegion`
-    #   autogenerates a pre-signed URL that is a valid request for the
-    #   operation that can be executed in the source Amazon Web Services
-    #   Region.
+    #   autogenerates a presigned URL that is a valid request for the
+    #   operation that can run in the source Amazon Web Services Region.
     #
     #    </note>
     #