lib/aws-sdk-rds/resource.rb in aws-sdk-rds-1.229.0 vs lib/aws-sdk-rds/resource.rb in aws-sdk-rds-1.233.0

- old
+ new

@@ -108,26 +108,32 @@ # db_system_id: "String", # manage_master_user_password: false, # master_user_secret_kms_key_id: "String", # enable_local_write_forwarding: false, # ca_certificate_identifier: "String", + # engine_lifecycle_support: "String", # source_region: "String", # }) # @param [Hash] options ({}) # @option options [Array<String>] :availability_zones - # A list of Availability Zones (AZs) where DB instances in the DB - # cluster can be created. + # A list of Availability Zones (AZs) where you specifically want to + # create DB instances in the DB cluster. # - # For information on Amazon Web Services Regions and Availability Zones, - # see [Choosing the Regions and Availability Zones][1] in the *Amazon + # For information on AZs, see [Availability Zones][1] in the *Amazon # Aurora User Guide*. # # Valid for Cluster Type: Aurora DB clusters only # + # Constraints: # + # * Can't specify more than three AZs. # - # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Concepts.RegionsAndAvailabilityZones.html + # ^ + # + # + # + # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Concepts.RegionsAndAvailabilityZones.html#Concepts.RegionsAndAvailabilityZones.AvailabilityZones # @option options [Integer] :backup_retention_period # The number of days for which automated backups are retained. # # Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters # @@ -142,13 +148,13 @@ # The name of the character set (`CharacterSet`) to associate the DB # cluster with. # # Valid for Cluster Type: Aurora DB clusters only # @option options [String] :database_name - # The name for your database of up to 64 alphanumeric characters. If you - # don't provide a name, Amazon RDS doesn't create a database in the DB - # cluster you are creating. + # The name for your database of up to 64 alphanumeric characters. A + # database named `postgres` is always created. If this parameter is + # specified, an additional database with this name is created. # # Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters # @option options [required, String] :db_cluster_identifier # The identifier for this DB cluster. This parameter is stored as a # lowercase string. @@ -199,11 +205,26 @@ # @option options [required, String] :engine # The database engine to use for this DB cluster. # # Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters # - # Valid Values: `aurora-mysql | aurora-postgresql | mysql | postgres` + # Valid Values: + # + # * `aurora-mysql` + # + # * `aurora-postgresql` + # + # * `mysql` + # + # * `postgres` + # + # * `neptune` - For information about using Amazon Neptune, see the [ + # *Amazon Neptune User Guide* ][1]. + # + # + # + # [1]: https://docs.aws.amazon.com/neptune/latest/userguide/intro.html # @option options [String] :engine_version # The version number of the database engine to use. # # To list all of the available engine versions for Aurora MySQL version # 2 (5.7-compatible) and version 3 (MySQL 8.0-compatible), use the @@ -889,10 +910,45 @@ # Valid for Cluster Type: Multi-AZ DB clusters # # # # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.SSL.html + # @option options [String] :engine_lifecycle_support + # The life cycle type for this DB cluster. + # + # <note markdown="1"> By default, this value is set to `open-source-rds-extended-support`, + # which enrolls your DB cluster into Amazon RDS Extended Support. At the + # end of standard support, you can avoid charges for Extended Support by + # setting the value to `open-source-rds-extended-support-disabled`. In + # this case, creating the DB cluster will fail if the DB major version + # is past its end of standard support date. + # + # </note> + # + # You can use this setting to enroll your DB cluster into Amazon RDS + # Extended Support. With RDS Extended Support, you can run the selected + # major engine version on your DB cluster past the end of standard + # support for that engine version. For more information, see the + # following sections: + # + # * Amazon Aurora (PostgreSQL only) - [Using Amazon RDS Extended + # Support][1] in the *Amazon Aurora User Guide* + # + # * Amazon RDS - [Using Amazon RDS Extended Support][2] in the *Amazon + # RDS User Guide* + # + # Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters + # + # Valid Values: `open-source-rds-extended-support | + # open-source-rds-extended-support-disabled` + # + # Default: `open-source-rds-extended-support` + # + # + # + # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/extended-support.html + # [2]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/extended-support.html # @option options [String] :source_region # The source region of the snapshot. This is only needed when the # shapshot is encrypted and in a different region. # @return [DBCluster] def create_db_cluster(options = {}) @@ -1070,10 +1126,11 @@ # master_user_secret_kms_key_id: "String", # ca_certificate_identifier: "String", # db_system_id: "String", # dedicated_log_volume: false, # multi_tenant: false, + # engine_lifecycle_support: "String", # }) # @param [Hash] options ({}) # @option options [String] :db_name # The meaning of this parameter differs according to the database engine # you use. @@ -1092,13 +1149,13 @@ # * Can't be a word reserved by the database engine. # # Amazon Aurora PostgreSQL # # : The name of the database to create when the primary DB instance of - # the Aurora PostgreSQL DB cluster is created. If this parameter - # isn't specified for an Aurora PostgreSQL DB cluster, a database - # named `postgres` is created in the DB cluster. + # the Aurora PostgreSQL DB cluster is created. A database named + # `postgres` is always created. If this parameter is specified, an + # additional database with this name is created. # # Constraints: # # * It must contain 1 to 63 alphanumeric characters. # @@ -1189,12 +1246,12 @@ # ^ # # RDS for PostgreSQL # # : The name of the database to create when the DB instance is created. - # If this parameter isn't specified, a database named `postgres` is - # created in the DB instance. + # A database named `postgres` is always created. If this parameter is + # specified, an additional database with this name is created. # # Constraints: # # * Must contain 1 to 63 letters, numbers, or underscores. # @@ -1685,26 +1742,40 @@ # If you create an RDS Custom DB instance, you must set # `AutoMinorVersionUpgrade` to `false`. # @option options [String] :license_model # The license model information for this DB instance. # + # <note markdown="1"> License models for RDS for Db2 require additional configuration. The + # Bring Your Own License (BYOL) model requires a custom parameter group. + # The Db2 license through Amazon Web Services Marketplace model requires + # an Amazon Web Services Marketplace subscription. For more information, + # see [RDS for Db2 licensing options][1] in the *Amazon RDS User Guide*. + # + # The default for RDS for Db2 is `bring-your-own-license`. + # + # </note> + # # This setting doesn't apply to Amazon Aurora or RDS Custom DB # instances. # # Valid Values: # - # * RDS for Db2 - `bring-your-own-license` + # * RDS for Db2 - `bring-your-own-license | marketplace-license` # # * RDS for MariaDB - `general-public-license` # # * RDS for Microsoft SQL Server - `license-included` # # * RDS for MySQL - `general-public-license` # # * RDS for Oracle - `bring-your-own-license | license-included` # # * RDS for PostgreSQL - `postgresql-license` + # + # + # + # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/db2-licensing.html # @option options [Integer] :iops # The amount of Provisioned IOPS (input/output operations per second) to # initially allocate for the DB instance. For information about valid # IOPS values, see [Amazon RDS DB instance storage][1] in the *Amazon # RDS User Guide*. @@ -2255,10 +2326,41 @@ # the request fails. # # * If you specify the multi-tenant configuration when you create your # DB instance, you can't later modify this DB instance to use the # single-tenant configuration. + # @option options [String] :engine_lifecycle_support + # The life cycle type for this DB instance. + # + # <note markdown="1"> By default, this value is set to `open-source-rds-extended-support`, + # which enrolls your DB instance into Amazon RDS Extended Support. At + # the end of standard support, you can avoid charges for Extended + # Support by setting the value to + # `open-source-rds-extended-support-disabled`. In this case, creating + # the DB instance will fail if the DB major version is past its end of + # standard support date. + # + # </note> + # + # This setting applies only to RDS for MySQL and RDS for PostgreSQL. For + # Amazon Aurora DB instances, the life cycle type is managed by the DB + # cluster. + # + # You can use this setting to enroll your DB instance into Amazon RDS + # Extended Support. With RDS Extended Support, you can run the selected + # major engine version on your DB instance past the end of standard + # support for that engine version. For more information, see [Using + # Amazon RDS Extended Support][1] in the *Amazon RDS User Guide*. + # + # Valid Values: `open-source-rds-extended-support | + # open-source-rds-extended-support-disabled` + # + # Default: `open-source-rds-extended-support` + # + # + # + # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/extended-support.html # @return [DBInstance] def create_db_instance(options = {}) resp = Aws::Plugins::UserAgent.feature('resource') do @client.create_db_instance(options) end @@ -2493,12 +2595,12 @@ # 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`. 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-proxy` + # Valid Values:` db-instance | db-cluster | db-parameter-group | + # db-security-group | db-snapshot | db-cluster-snapshot | db-proxy | + # zero-etl | custom-engine-version | blue-green-deployment ` # @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 the "Amazon RDS event categories and event # messages" section of the [ *Amazon RDS User Guide* ][1] or the [