aws-sdk-rds 1.134.0 → 1.138.0

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

@@ -173,7 +173,7 @@ module Aws::RDS
     #   Constraints: Must match the name of an existing DBSubnetGroup. Must
     #   not be default.
     #
-    #   Example: `mySubnetgroup`
+    #   Example: `mydbsubnetgroup`
     #
     #   Valid for: Aurora DB clusters and Multi-AZ DB clusters
     # @option options [required, String] :engine
@@ -183,7 +183,8 @@ module Aws::RDS
     #
     #   * `aurora` (for MySQL 5.6-compatible Aurora)
     #
-    #   * `aurora-mysql` (for MySQL 5.7-compatible Aurora)
+    #   * `aurora-mysql` (for MySQL 5.7-compatible and MySQL 8.0-compatible
+    #     Aurora)
     #
     #   * `aurora-postgresql`
     #
@@ -202,7 +203,7 @@ module Aws::RDS
     #   "DBEngineVersions[].EngineVersion"`
     #
     #   To list all of the available engine versions for MySQL 5.7-compatible
-    #   Aurora, use the following command:
+    #   and MySQL 8.0-compatible Aurora, use the following command:
     #
     #   `aws rds describe-db-engine-versions --engine aurora-mysql --query
     #   "DBEngineVersions[].EngineVersion"`
@@ -623,11 +624,11 @@ module Aws::RDS
     #
     #   This setting is required to create a Multi-AZ DB cluster.
     #
-    #   Valid values: `standard | gp2 | io1`
+    #   Valid values: `io1`
     #
-    #   If you specify `io1`, also include a value for the `Iops` parameter.
+    #   When specified, a value for the `Iops` parameter is required.
     #
-    #   Default: `io1` if the `Iops` parameter is specified, otherwise `gp2`
+    #   Default: `io1`
     #
     #   Valid for: Multi-AZ DB clusters only
     # @option options [Integer] :iops
@@ -795,7 +796,7 @@ module Aws::RDS
     #
     #   **Aurora MySQL**
     #
-    #   Example: `aurora5.6`, `aurora-mysql5.7`
+    #   Example: `aurora5.6`, `aurora-mysql5.7`, `aurora-mysql8.0`
     #
     #   **Aurora PostgreSQL**
     #
@@ -830,7 +831,8 @@ module Aws::RDS
     #
     #   * `aurora` (for MySQL 5.6-compatible Aurora)
     #
-    #   * `aurora-mysql` (for MySQL 5.7-compatible Aurora)
+    #   * `aurora-mysql` (for MySQL 5.7-compatible and MySQL 8.0-compatible
+    #     Aurora)
     #
     #   * `aurora-postgresql`
     #
@@ -979,7 +981,7 @@ module Aws::RDS
     #
     #   ^
     #
-    #   **Amazon RDS Custom**
+    #   **Amazon RDS Custom for Oracle**
     #
     #   The Oracle System ID (SID) of the created RDS Custom DB instance. If
     #   you don't specify a value, the default value is `ORCL`.
@@ -994,6 +996,10 @@ module Aws::RDS
     #
     #   * It can't be a word reserved by the database engine.
     #
+    #   **Amazon RDS Custom for SQL Server**
+    #
+    #   Not applicable. Must be null.
+    #
     #   **SQL Server**
     #
     #   Not applicable. Must be null.
@@ -1057,9 +1063,11 @@ module Aws::RDS
     #   following:
     #
     #   * General Purpose (SSD) storage (gp2): Must be an integer from 40 to
-    #     65536.
+    #     65536 for RDS Custom for Oracle, 16384 for RDS Custom for SQL
+    #     Server.
     #
-    #   * Provisioned IOPS storage (io1): Must be an integer from 40 to 65536.
+    #   * Provisioned IOPS storage (io1): Must be an integer from 40 to 65536
+    #     for RDS Custom for Oracle, 16384 for RDS Custom for SQL Server.
     #
     #   **MySQL**
     #
@@ -1120,21 +1128,21 @@ module Aws::RDS
     #
     #   * General Purpose (SSD) storage (gp2):
     #
-    #     * Enterprise and Standard editions: Must be an integer from 200 to
+    #     * Enterprise and Standard editions: Must be an integer from 20 to
     #       16384.
     #
     #     * Web and Express editions: Must be an integer from 20 to 16384.
     #
     #   * Provisioned IOPS storage (io1):
     #
-    #     * Enterprise and Standard editions: Must be an integer from 200 to
+    #     * Enterprise and Standard editions: Must be an integer from 100 to
     #       16384.
     #
     #     * Web and Express editions: Must be an integer from 100 to 16384.
     #
     #   * Magnetic storage (standard):
     #
-    #     * Enterprise and Standard editions: Must be an integer from 200 to
+    #     * Enterprise and Standard editions: Must be an integer from 20 to
     #       1024.
     #
     #     * Web and Express editions: Must be an integer from 20 to 1024.
@@ -1158,11 +1166,18 @@ module Aws::RDS
     #
     #   * `aurora` (for MySQL 5.6-compatible Aurora)
     #
-    #   * `aurora-mysql` (for MySQL 5.7-compatible Aurora)
+    #   * `aurora-mysql` (for MySQL 5.7-compatible and MySQL 8.0-compatible
+    #     Aurora)
     #
     #   * `aurora-postgresql`
     #
-    #   * `custom-oracle-ee (for RDS Custom instances)`
+    #   * `custom-oracle-ee (for RDS Custom for Oracle instances)`
+    #
+    #   * `custom-sqlserver-ee (for RDS Custom for SQL Server instances)`
+    #
+    #   * `custom-sqlserver-se (for RDS Custom for SQL Server instances)`
+    #
+    #   * `custom-sqlserver-web (for RDS Custom for SQL Server instances)`
     #
     #   * `mariadb`
     #
@@ -1252,6 +1267,10 @@ module Aws::RDS
     #   information on Amazon Web Services Regions and Availability Zones, see
     #   [Regions and Availability Zones][1].
     #
+    #   **Amazon Aurora**
+    #
+    #   Not applicable. Availability Zones are managed by the DB cluster.
+    #
     #   Default: A random, system-chosen Availability Zone in the endpoint's
     #   Amazon Web Services Region.
     #
@@ -1278,7 +1297,10 @@ module Aws::RDS
     # @option options [String] :db_subnet_group_name
     #   A DB subnet group to associate with this DB instance.
     #
-    #   If there is no DB subnet group, then it is a non-VPC DB instance.
+    #   Constraints: Must match the name of an existing DBSubnetGroup. Must
+    #   not be default.
+    #
+    #   Example: `mydbsubnetgroup`
     # @option options [String] :preferred_maintenance_window
     #   The time range each week during which system maintenance can occur, in
     #   Universal Coordinated Time (UTC). For more information, see [Amazon
@@ -1329,7 +1351,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 DB instance
+    #   * Can't be set to 0 or 35 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`
@@ -1424,47 +1446,53 @@ module Aws::RDS
     #   Not applicable. The version number of the database engine to be used
     #   by the DB instance is managed by the DB cluster.
     #
-    #   **Amazon RDS Custom**
+    #   **Amazon RDS Custom for Oracle**
     #
     #   A custom engine version (CEV) that you have previously created. This
-    #   setting is required for RDS Custom. The CEV name has the following
-    #   format: `19.customized_string `. An example identifier is
-    #   `19.my_cev1`. For more information, see [ Creating an RDS Custom DB
-    #   instance][1] in the *Amazon RDS User Guide.*.
+    #   setting is required for RDS Custom for Oracle. The CEV name has the
+    #   following format: `19.customized_string `. An example identifier is
+    #   `19.my_cev1`. For more information, see [ Creating an RDS Custom for
+    #   Oracle DB instance][1] in the *Amazon RDS User Guide.*.
+    #
+    #   **Amazon RDS Custom for SQL Server**
+    #
+    #   See [RDS Custom for SQL Server general requirements][2] in the *Amazon
+    #   RDS User Guide.*
     #
     #   **MariaDB**
     #
-    #   For information, see [MariaDB on Amazon RDS Versions][2] in the
+    #   For information, see [MariaDB on Amazon RDS Versions][3] in the
     #   *Amazon RDS User Guide.*
     #
     #   **Microsoft SQL Server**
     #
-    #   For information, see [Microsoft SQL Server Versions on Amazon RDS][3]
+    #   For information, see [Microsoft SQL Server Versions on Amazon RDS][4]
     #   in the *Amazon RDS User Guide.*
     #
     #   **MySQL**
     #
-    #   For information, see [MySQL on Amazon RDS Versions][4] in the *Amazon
+    #   For information, see [MySQL on Amazon RDS Versions][5] in the *Amazon
     #   RDS User Guide.*
     #
     #   **Oracle**
     #
-    #   For information, see [Oracle Database Engine Release Notes][5] in the
+    #   For information, see [Oracle Database Engine Release Notes][6] in the
     #   *Amazon RDS User Guide.*
     #
     #   **PostgreSQL**
     #
     #   For information, see [Amazon RDS for PostgreSQL versions and
-    #   extensions][6] in the *Amazon RDS User Guide.*
+    #   extensions][7] in the *Amazon RDS User Guide.*
     #
     #
     #
     #   [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-creating.html#custom-creating.create
-    #   [2]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_MariaDB.html#MariaDB.Concepts.VersionMgmt
-    #   [3]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_SQLServer.html#SQLServer.Concepts.General.VersionSupport
-    #   [4]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_MySQL.html#MySQL.Concepts.VersionMgmt
-    #   [5]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Appendix.Oracle.PatchComposition.html
-    #   [6]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_PostgreSQL.html#PostgreSQL.Concepts
+    #   [2]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-reqs-limits.html#custom-reqs-limits.reqsMS
+    #   [3]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_MariaDB.html#MariaDB.Concepts.VersionMgmt
+    #   [4]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_SQLServer.html#SQLServer.Concepts.General.VersionSupport
+    #   [5]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_MySQL.html#MySQL.Concepts.VersionMgmt
+    #   [6]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Appendix.Oracle.PatchComposition.html
+    #   [7]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_PostgreSQL.html#PostgreSQL.Concepts
     # @option options [Boolean] :auto_minor_version_upgrade
     #   A value that indicates whether minor engine upgrades are applied
     #   automatically to the DB instance during the maintenance window. By
@@ -1581,9 +1609,8 @@ module Aws::RDS
     #   A value that indicates whether the DB instance is encrypted. By
     #   default, it isn't encrypted.
     #
-    #   For RDS Custom Oracle instances, either set this parameter to `true`
-    #   or leave it unset. If you set this parameter to `false`, RDS reports
-    #   an error.
+    #   For RDS Custom instances, either set this parameter to `true` or leave
+    #   it unset. If you set this parameter to `false`, RDS reports an error.
     #
     #   **Amazon Aurora**
     #
@@ -1611,11 +1638,11 @@ module Aws::RDS
     #
     #   **Amazon RDS Custom**
     #
-    #   A KMS key is required for RDS Custom Oracle instances. For most RDS
-    #   engines, if you leave this parameter empty while enabling
-    #   `StorageEncrypted`, the engine uses the default KMS key. However, RDS
-    #   Custom for Oracle doesn't use the default key when this parameter is
-    #   empty. You must explicitly specify a key.
+    #   A KMS key is required for RDS Custom instances. For most RDS engines,
+    #   if you leave this parameter empty while enabling `StorageEncrypted`,
+    #   the engine uses the default KMS key. However, RDS Custom doesn't use
+    #   the default key when this parameter is empty. You must explicitly
+    #   specify a key.
     # @option options [String] :domain
     #   The Active Directory directory ID to create the DB instance in.
     #   Currently, only MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB
@@ -1924,7 +1951,8 @@ module Aws::RDS
     #
     #   * `aurora` (for MySQL 5.6-compatible Aurora)
     #
-    #   * `aurora-mysql` (for MySQL 5.7-compatible Aurora)
+    #   * `aurora-mysql` (for MySQL 5.7-compatible and MySQL 8.0-compatible
+    #     Aurora)
     #
     #   * `aurora-postgresql`
     #
@@ -2023,10 +2051,16 @@ module Aws::RDS
     #   The name for the DB subnet group. This value is stored as a lowercase
     #   string.
     #
-    #   Constraints: Must contain no more than 255 letters, numbers, periods,
-    #   underscores, spaces, or hyphens. Must not be default.
+    #   Constraints:
+    #
+    #   * Must contain no more than 255 letters, numbers, periods,
+    #     underscores, spaces, or hyphens.
     #
-    #   Example: `mySubnetgroup`
+    #   * Must not be default.
+    #
+    #   * First character must be a letter.
+    #
+    #   Example: `mydbsubnetgroup`
     # @option options [required, String] :db_subnet_group_description
     #   The description for the DB subnet group.
     # @option options [required, Array<String>] :subnet_ids
@@ -2071,20 +2105,24 @@ module Aws::RDS
     # @option options [String] :source_type
     #   The type of source that is generating the events. For example, if you
     #   want to be notified of events generated by a DB instance, you set this
-    #   parameter to `db-instance`. If this value isn't specified, all events
-    #   are returned.
+    #   parameter to `db-instance`. For RDS Proxy events, specify `db-proxy`.
+    #   If this value isn't specified, all events are returned.
     #
     #   Valid values: `db-instance` \| `db-cluster` \| `db-parameter-group` \|
-    #   `db-security-group` \| `db-snapshot` \| `db-cluster-snapshot`
+    #   `db-security-group` \| `db-snapshot` \| `db-cluster-snapshot` \|
+    #   `db-proxy`
     # @option options [Array<String>] :event_categories
     #   A list of event categories for a particular source type (`SourceType`)
     #   that you want to subscribe to. You can see a list of the categories
-    #   for a given source type in [Events][1] in the *Amazon RDS User Guide*
-    #   or by using the `DescribeEventCategories` operation.
+    #   for a given source type in the "Amazon RDS event categories and event
+    #   messages" section of the [ *Amazon RDS User Guide* ][1] or the [
+    #   *Amazon Aurora User Guide* ][2]. You can also see this list by using
+    #   the `DescribeEventCategories` operation.
     #
     #
     #
-    #   [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Events.html
+    #   [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Events.Messages.html
+    #   [2]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_Events.Messages.html
     # @option options [Array<String>] :source_ids
     #   The list of identifiers of the event sources for which events are
     #   returned. If not specified, then all sources are included in the
@@ -2113,6 +2151,9 @@ module Aws::RDS
     #
     #   * If the source type is a DB cluster snapshot, a
     #     `DBClusterSnapshotIdentifier` value must be supplied.
+    #
+    #   * If the source type is an RDS Proxy, a `DBProxyName` value must be
+    #     supplied.
     # @option options [Boolean] :enabled
     #   A value that indicates whether to activate the subscription. If the
     #   event notification subscription isn't activated, the subscription is
@@ -2451,7 +2492,8 @@ module Aws::RDS
     #
     #   * `aurora` (for MySQL 5.6-compatible Aurora)
     #
-    #   * `aurora-mysql` (for MySQL 5.7-compatible Aurora)
+    #   * `aurora-mysql` (for MySQL 5.7-compatible and MySQL 8.0-compatible
+    #     Aurora)
     #
     #   * `aurora-postgresql`
     #
@@ -2918,10 +2960,12 @@ module Aws::RDS
     #   })
     # @param [Hash] options ({})
     # @option options [String] :source_type
-    #   The type of source that is generating the events.
+    #   The type of source that is generating the events. For RDS Proxy
+    #   events, specify `db-proxy`.
     #
     #   Valid values: `db-instance` \| `db-cluster` \| `db-parameter-group` \|
-    #   `db-security-group` \| `db-snapshot` \| `db-cluster-snapshot`
+    #   `db-security-group` \| `db-snapshot` \| `db-cluster-snapshot` \|
+    #   `db-proxy`
     # @option options [Array<Types::Filter>] :filters
     #   This parameter isn't currently supported.
     # @return [EventCategoryMap::Collection]
@@ -2990,7 +3034,7 @@ module Aws::RDS
     #
     #   events = rds.events({
     #     source_identifier: "String",
-    #     source_type: "db-instance", # accepts db-instance, db-parameter-group, db-security-group, db-snapshot, db-cluster, db-cluster-snapshot, custom-engine-version
+    #     source_type: "db-instance", # accepts db-instance, db-parameter-group, db-security-group, db-snapshot, db-cluster, db-cluster-snapshot, custom-engine-version, db-proxy
     #     start_time: Time.now,
     #     end_time: Time.now,
     #     duration: 1,
@@ -3030,6 +3074,9 @@ module Aws::RDS
     #   * If the source type is a DB cluster snapshot, a
     #     `DBClusterSnapshotIdentifier` value must be supplied.
     #
+    #   * If the source type is an RDS Proxy, a `DBProxyName` value must be
+    #     supplied.
+    #
     #   * Can't end with a hyphen or contain two consecutive hyphens.
     # @option options [String] :source_type
     #   The event source to retrieve events for. If no value is specified, all