lib/aws-sdk-rds/client.rb in aws-sdk-rds-1.229.0 vs lib/aws-sdk-rds/client.rb in aws-sdk-rds-1.233.0
- old
+ new
@@ -301,12 +301,13 @@
# in the future.
#
#
# @option options [String] :sdk_ua_app_id
# A unique and opaque application ID that is appended to the
- # User-Agent header as app/<sdk_ua_app_id>. It should have a
- # maximum length of 50.
+ # User-Agent header as app/sdk_ua_app_id. It should have a
+ # maximum length of 50. This variable is sourced from environment
+ # variable AWS_SDK_UA_APP_ID or the shared config profile attribute sdk_ua_app_id.
#
# @option options [String] :secret_access_key
#
# @option options [String] :session_token
#
@@ -614,16 +615,18 @@
# Adds metadata tags to an Amazon RDS resource. These tags can also be
# used with cost allocation reporting to track cost associated with
# Amazon RDS resources, or used in a Condition statement in an IAM
# policy for Amazon RDS.
#
- # For an overview on tagging Amazon RDS resources, see [Tagging Amazon
- # RDS Resources][1].
+ # For an overview on tagging your relational database resources, see
+ # [Tagging Amazon RDS Resources][1] or [Tagging Amazon Aurora and Amazon
+ # RDS Resources][2].
#
#
#
- # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Overview.Tagging.html
+ # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html
+ # [2]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_Tagging.html
#
# @option params [required, String] :resource_name
# The Amazon RDS resource that the tags are added to. This value is an
# Amazon Resource Name (ARN). For information about creating an ARN, see
# [ Constructing an RDS Amazon Resource Name (ARN)][1].
@@ -2536,23 +2539,28 @@
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBInstance.html
# [2]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html
# [3]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html
#
# @option params [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 params [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
#
@@ -2569,13 +2577,13 @@
# cluster with.
#
# Valid for Cluster Type: Aurora DB clusters only
#
# @option params [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 params [required, String] :db_cluster_identifier
# The identifier for this DB cluster. This parameter is stored as a
@@ -2631,12 +2639,27 @@
# @option params [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 params [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
@@ -3366,10 +3389,46 @@
#
#
#
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.SSL.html
#
+ # @option params [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 params [String] :source_region
# The source region of the snapshot. This is only needed when the
# shapshot is encrypted and in a different region.
#
# @return [Types::CreateDBClusterResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
@@ -3577,10 +3636,11 @@
# 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",
# })
#
# @example Response structure
#
@@ -3718,10 +3778,11 @@
# resp.db_cluster.limitless_database.status #=> String, one of "active", "not-in-use", "enabled", "disabled", "enabling", "disabling", "modifying-max-capacity", "error"
# resp.db_cluster.limitless_database.min_required_acu #=> Float
# resp.db_cluster.storage_throughput #=> Integer
# resp.db_cluster.certificate_details.ca_identifier #=> String
# resp.db_cluster.certificate_details.valid_till #=> Time
+ # resp.db_cluster.engine_lifecycle_support #=> String
#
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/CreateDBCluster AWS API Documentation
#
# @overload create_db_cluster(params = {})
# @param [Hash] params ({})
@@ -4194,13 +4255,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.
#
@@ -4291,12 +4352,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.
#
@@ -4806,16 +4867,26 @@
# `AutoMinorVersionUpgrade` to `false`.
#
# @option params [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`
#
@@ -4823,10 +4894,14 @@
#
# * 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 params [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*.
@@ -5419,10 +5494,42 @@
#
# * 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 params [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 [Types::CreateDBInstanceResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::CreateDBInstanceResult#db_instance #db_instance} => Types::DBInstance
#
#
@@ -5608,10 +5715,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",
# })
#
# @example Response structure
#
# resp.db_instance.db_instance_identifier #=> String
@@ -5772,10 +5880,11 @@
# resp.db_instance.read_replica_source_db_cluster_identifier #=> String
# resp.db_instance.percent_progress #=> String
# resp.db_instance.dedicated_log_volume #=> Boolean
# resp.db_instance.is_storage_config_upgrade_available #=> Boolean
# resp.db_instance.multi_tenant #=> Boolean
+ # resp.db_instance.engine_lifecycle_support #=> String
#
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/CreateDBInstance AWS API Documentation
#
# @overload create_db_instance(params = {})
# @param [Hash] params ({})
@@ -6711,10 +6820,11 @@
# resp.db_instance.read_replica_source_db_cluster_identifier #=> String
# resp.db_instance.percent_progress #=> String
# resp.db_instance.dedicated_log_volume #=> Boolean
# resp.db_instance.is_storage_config_upgrade_available #=> Boolean
# resp.db_instance.multi_tenant #=> Boolean
+ # resp.db_instance.engine_lifecycle_support #=> String
#
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/CreateDBInstanceReadReplica AWS API Documentation
#
# @overload create_db_instance_read_replica(params = {})
# @param [Hash] params ({})
@@ -7613,13 +7723,13 @@
# 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 params [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
@@ -7813,10 +7923,40 @@
# this case, Amazon Aurora uses the engine version of the source DB
# cluster.
#
# ^
#
+ # @option params [String] :engine_lifecycle_support
+ # The life cycle type for this global database cluster.
+ #
+ # <note markdown="1"> By default, this value is set to `open-source-rds-extended-support`,
+ # which enrolls your global 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 global cluster will fail if the DB major version is past its end
+ # of standard support date.
+ #
+ # </note>
+ #
+ # This setting only applies to Aurora PostgreSQL-based global databases.
+ #
+ # You can use this setting to enroll your global cluster into Amazon RDS
+ # Extended Support. With RDS Extended Support, you can run the selected
+ # major engine version on your global cluster past the end of standard
+ # support for that engine version. For more information, see [Using
+ # Amazon RDS Extended Support][1] in the *Amazon Aurora 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/AuroraUserGuide/extended-support.html
+ #
# @option params [Boolean] :deletion_protection
# Specifies whether to enable deletion protection for the new global
# database cluster. The global database can't be deleted when deletion
# protection is enabled.
#
@@ -7880,10 +8020,11 @@
# resp = client.create_global_cluster({
# global_cluster_identifier: "String",
# source_db_cluster_identifier: "String",
# engine: "String",
# engine_version: "String",
+ # engine_lifecycle_support: "String",
# deletion_protection: false,
# database_name: "String",
# storage_encrypted: false,
# })
#
@@ -7893,10 +8034,11 @@
# resp.global_cluster.global_cluster_resource_id #=> String
# resp.global_cluster.global_cluster_arn #=> String
# resp.global_cluster.status #=> String
# resp.global_cluster.engine #=> String
# resp.global_cluster.engine_version #=> String
+ # resp.global_cluster.engine_lifecycle_support #=> String
# resp.global_cluster.database_name #=> String
# resp.global_cluster.storage_encrypted #=> Boolean
# resp.global_cluster.deletion_protection #=> Boolean
# resp.global_cluster.global_cluster_members #=> Array
# resp.global_cluster.global_cluster_members[0].db_cluster_arn #=> String
@@ -8925,10 +9067,11 @@
# resp.db_cluster.limitless_database.status #=> String, one of "active", "not-in-use", "enabled", "disabled", "enabling", "disabling", "modifying-max-capacity", "error"
# resp.db_cluster.limitless_database.min_required_acu #=> Float
# resp.db_cluster.storage_throughput #=> Integer
# resp.db_cluster.certificate_details.ca_identifier #=> String
# resp.db_cluster.certificate_details.valid_till #=> Time
+ # resp.db_cluster.engine_lifecycle_support #=> String
#
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DeleteDBCluster AWS API Documentation
#
# @overload delete_db_cluster(params = {})
# @param [Hash] params ({})
@@ -9527,10 +9670,11 @@
# resp.db_instance.read_replica_source_db_cluster_identifier #=> String
# resp.db_instance.percent_progress #=> String
# resp.db_instance.dedicated_log_volume #=> Boolean
# resp.db_instance.is_storage_config_upgrade_available #=> Boolean
# resp.db_instance.multi_tenant #=> Boolean
+ # resp.db_instance.engine_lifecycle_support #=> String
#
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DeleteDBInstance AWS API Documentation
#
# @overload delete_db_instance(params = {})
# @param [Hash] params ({})
@@ -10167,10 +10311,11 @@
# resp.global_cluster.global_cluster_resource_id #=> String
# resp.global_cluster.global_cluster_arn #=> String
# resp.global_cluster.status #=> String
# resp.global_cluster.engine #=> String
# resp.global_cluster.engine_version #=> String
+ # resp.global_cluster.engine_lifecycle_support #=> String
# resp.global_cluster.database_name #=> String
# resp.global_cluster.storage_encrypted #=> Boolean
# resp.global_cluster.deletion_protection #=> Boolean
# resp.global_cluster.global_cluster_members #=> Array
# resp.global_cluster.global_cluster_members[0].db_cluster_arn #=> String
@@ -12354,10 +12499,11 @@
# resp.db_clusters[0].limitless_database.status #=> String, one of "active", "not-in-use", "enabled", "disabled", "enabling", "disabling", "modifying-max-capacity", "error"
# resp.db_clusters[0].limitless_database.min_required_acu #=> Float
# resp.db_clusters[0].storage_throughput #=> Integer
# resp.db_clusters[0].certificate_details.ca_identifier #=> String
# resp.db_clusters[0].certificate_details.valid_till #=> Time
+ # resp.db_clusters[0].engine_lifecycle_support #=> String
#
#
# The following waiters are defined for this operation (see {Client#wait_until} for detailed usage):
#
# * db_cluster_available
@@ -13097,10 +13243,11 @@
# resp.db_instances[0].read_replica_source_db_cluster_identifier #=> String
# resp.db_instances[0].percent_progress #=> String
# resp.db_instances[0].dedicated_log_volume #=> Boolean
# resp.db_instances[0].is_storage_config_upgrade_available #=> Boolean
# resp.db_instances[0].multi_tenant #=> Boolean
+ # resp.db_instances[0].engine_lifecycle_support #=> String
#
#
# The following waiters are defined for this operation (see {Client#wait_until} for detailed usage):
#
# * db_instance_available
@@ -15744,10 +15891,11 @@
# resp.global_clusters[0].global_cluster_resource_id #=> String
# resp.global_clusters[0].global_cluster_arn #=> String
# resp.global_clusters[0].status #=> String
# resp.global_clusters[0].engine #=> String
# resp.global_clusters[0].engine_version #=> String
+ # resp.global_clusters[0].engine_lifecycle_support #=> String
# resp.global_clusters[0].database_name #=> String
# resp.global_clusters[0].storage_encrypted #=> Boolean
# resp.global_clusters[0].deletion_protection #=> Boolean
# resp.global_clusters[0].global_cluster_members #=> Array
# resp.global_clusters[0].global_cluster_members[0].db_cluster_arn #=> String
@@ -17653,10 +17801,11 @@
# resp.db_cluster.limitless_database.status #=> String, one of "active", "not-in-use", "enabled", "disabled", "enabling", "disabling", "modifying-max-capacity", "error"
# resp.db_cluster.limitless_database.min_required_acu #=> Float
# resp.db_cluster.storage_throughput #=> Integer
# resp.db_cluster.certificate_details.ca_identifier #=> String
# resp.db_cluster.certificate_details.valid_till #=> Time
+ # resp.db_cluster.engine_lifecycle_support #=> String
#
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/FailoverDBCluster AWS API Documentation
#
# @overload failover_db_cluster(params = {})
# @param [Hash] params ({})
@@ -17778,10 +17927,11 @@
# resp.global_cluster.global_cluster_resource_id #=> String
# resp.global_cluster.global_cluster_arn #=> String
# resp.global_cluster.status #=> String
# resp.global_cluster.engine #=> String
# resp.global_cluster.engine_version #=> String
+ # resp.global_cluster.engine_lifecycle_support #=> String
# resp.global_cluster.database_name #=> String
# resp.global_cluster.storage_encrypted #=> Boolean
# resp.global_cluster.deletion_protection #=> Boolean
# resp.global_cluster.global_cluster_members #=> Array
# resp.global_cluster.global_cluster_members[0].db_cluster_arn #=> String
@@ -19335,10 +19485,11 @@
# resp.db_cluster.limitless_database.status #=> String, one of "active", "not-in-use", "enabled", "disabled", "enabling", "disabling", "modifying-max-capacity", "error"
# resp.db_cluster.limitless_database.min_required_acu #=> Float
# resp.db_cluster.storage_throughput #=> Integer
# resp.db_cluster.certificate_details.ca_identifier #=> String
# resp.db_cluster.certificate_details.valid_till #=> Time
+ # resp.db_cluster.engine_lifecycle_support #=> String
#
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/ModifyDBCluster AWS API Documentation
#
# @overload modify_db_cluster(params = {})
# @param [Hash] params ({})
@@ -21068,10 +21219,11 @@
# resp.db_instance.read_replica_source_db_cluster_identifier #=> String
# resp.db_instance.percent_progress #=> String
# resp.db_instance.dedicated_log_volume #=> Boolean
# resp.db_instance.is_storage_config_upgrade_available #=> Boolean
# resp.db_instance.multi_tenant #=> Boolean
+ # resp.db_instance.engine_lifecycle_support #=> String
#
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/ModifyDBInstance AWS API Documentation
#
# @overload modify_db_instance(params = {})
# @param [Hash] params ({})
@@ -22039,13 +22191,13 @@
# 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 would
# 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 params [Array<String>] :event_categories
# A list of event categories for a 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
@@ -22243,10 +22395,11 @@
# resp.global_cluster.global_cluster_resource_id #=> String
# resp.global_cluster.global_cluster_arn #=> String
# resp.global_cluster.status #=> String
# resp.global_cluster.engine #=> String
# resp.global_cluster.engine_version #=> String
+ # resp.global_cluster.engine_lifecycle_support #=> String
# resp.global_cluster.database_name #=> String
# resp.global_cluster.storage_encrypted #=> Boolean
# resp.global_cluster.deletion_protection #=> Boolean
# resp.global_cluster.global_cluster_members #=> Array
# resp.global_cluster.global_cluster_members[0].db_cluster_arn #=> String
@@ -22852,10 +23005,11 @@
# resp.db_instance.read_replica_source_db_cluster_identifier #=> String
# resp.db_instance.percent_progress #=> String
# resp.db_instance.dedicated_log_volume #=> Boolean
# resp.db_instance.is_storage_config_upgrade_available #=> Boolean
# resp.db_instance.multi_tenant #=> Boolean
+ # resp.db_instance.engine_lifecycle_support #=> String
#
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/PromoteReadReplica AWS API Documentation
#
# @overload promote_read_replica(params = {})
# @param [Hash] params ({})
@@ -23024,10 +23178,11 @@
# resp.db_cluster.limitless_database.status #=> String, one of "active", "not-in-use", "enabled", "disabled", "enabling", "disabling", "modifying-max-capacity", "error"
# resp.db_cluster.limitless_database.min_required_acu #=> Float
# resp.db_cluster.storage_throughput #=> Integer
# resp.db_cluster.certificate_details.ca_identifier #=> String
# resp.db_cluster.certificate_details.valid_till #=> Time
+ # resp.db_cluster.engine_lifecycle_support #=> String
#
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/PromoteReadReplicaDBCluster AWS API Documentation
#
# @overload promote_read_replica_db_cluster(params = {})
# @param [Hash] params ({})
@@ -23319,10 +23474,11 @@
# resp.db_cluster.limitless_database.status #=> String, one of "active", "not-in-use", "enabled", "disabled", "enabling", "disabling", "modifying-max-capacity", "error"
# resp.db_cluster.limitless_database.min_required_acu #=> Float
# resp.db_cluster.storage_throughput #=> Integer
# resp.db_cluster.certificate_details.ca_identifier #=> String
# resp.db_cluster.certificate_details.valid_till #=> Time
+ # resp.db_cluster.engine_lifecycle_support #=> String
#
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/RebootDBCluster AWS API Documentation
#
# @overload reboot_db_cluster(params = {})
# @param [Hash] params ({})
@@ -23564,10 +23720,11 @@
# resp.db_instance.read_replica_source_db_cluster_identifier #=> String
# resp.db_instance.percent_progress #=> String
# resp.db_instance.dedicated_log_volume #=> Boolean
# resp.db_instance.is_storage_config_upgrade_available #=> Boolean
# resp.db_instance.multi_tenant #=> Boolean
+ # resp.db_instance.engine_lifecycle_support #=> String
#
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/RebootDBInstance AWS API Documentation
#
# @overload reboot_db_instance(params = {})
# @param [Hash] params ({})
@@ -23750,10 +23907,11 @@
# resp.global_cluster.global_cluster_resource_id #=> String
# resp.global_cluster.global_cluster_arn #=> String
# resp.global_cluster.status #=> String
# resp.global_cluster.engine #=> String
# resp.global_cluster.engine_version #=> String
+ # resp.global_cluster.engine_lifecycle_support #=> String
# resp.global_cluster.database_name #=> String
# resp.global_cluster.storage_encrypted #=> Boolean
# resp.global_cluster.deletion_protection #=> Boolean
# resp.global_cluster.global_cluster_members #=> Array
# resp.global_cluster.global_cluster_members[0].db_cluster_arn #=> String
@@ -24587,10 +24745,47 @@
#
# Default: `aurora`
#
# Valid for: Aurora DB clusters only
#
+ # @option params [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, RDS automatically upgrades your restored DB cluster to a
+ # higher engine version, if the major engine 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
+ #
# @return [Types::RestoreDBClusterFromS3Result] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::RestoreDBClusterFromS3Result#db_cluster #db_cluster} => Types::DBCluster
#
#
@@ -24707,10 +24902,11 @@
# },
# network_type: "String",
# manage_master_user_password: false,
# master_user_secret_kms_key_id: "String",
# storage_type: "String",
+ # engine_lifecycle_support: "String",
# })
#
# @example Response structure
#
# resp.db_cluster.allocated_storage #=> Integer
@@ -24847,10 +25043,11 @@
# resp.db_cluster.limitless_database.status #=> String, one of "active", "not-in-use", "enabled", "disabled", "enabling", "disabling", "modifying-max-capacity", "error"
# resp.db_cluster.limitless_database.min_required_acu #=> Float
# resp.db_cluster.storage_throughput #=> Integer
# resp.db_cluster.certificate_details.ca_identifier #=> String
# resp.db_cluster.certificate_details.valid_till #=> Time
+ # resp.db_cluster.engine_lifecycle_support #=> String
#
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/RestoreDBClusterFromS3 AWS API Documentation
#
# @overload restore_db_cluster_from_s3(params = {})
# @param [Hash] params ({})
@@ -25305,10 +25502,47 @@
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html
#
# @option params [Types::RdsCustomClusterConfiguration] :rds_custom_cluster_configuration
# Reserved for future use.
#
+ # @option params [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, RDS automatically upgrades your restored DB cluster to a
+ # higher engine version, if the major engine 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
+ #
# @return [Types::RestoreDBClusterFromSnapshotResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::RestoreDBClusterFromSnapshotResult#db_cluster #db_cluster} => Types::DBCluster
#
#
@@ -25426,10 +25660,11 @@
# rds_custom_cluster_configuration: {
# interconnect_subnet_id: "String",
# transit_gateway_multicast_domain_id: "String",
# replica_mode: "open-read-only", # accepts open-read-only, mounted
# },
+ # engine_lifecycle_support: "String",
# })
#
# @example Response structure
#
# resp.db_cluster.allocated_storage #=> Integer
@@ -25566,10 +25801,11 @@
# resp.db_cluster.limitless_database.status #=> String, one of "active", "not-in-use", "enabled", "disabled", "enabling", "disabling", "modifying-max-capacity", "error"
# resp.db_cluster.limitless_database.min_required_acu #=> Float
# resp.db_cluster.storage_throughput #=> Integer
# resp.db_cluster.certificate_details.ca_identifier #=> String
# resp.db_cluster.certificate_details.valid_till #=> Time
+ # resp.db_cluster.engine_lifecycle_support #=> String
#
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/RestoreDBClusterFromSnapshot AWS API Documentation
#
# @overload restore_db_cluster_from_snapshot(params = {})
# @param [Hash] params ({})
@@ -26000,10 +26236,47 @@
# The resource ID of the source DB cluster from which to restore.
#
# @option params [Types::RdsCustomClusterConfiguration] :rds_custom_cluster_configuration
# Reserved for future use.
#
+ # @option params [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, RDS automatically upgrades your restored DB cluster to a
+ # higher engine version, if the major engine 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
+ #
# @return [Types::RestoreDBClusterToPointInTimeResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::RestoreDBClusterToPointInTimeResult#db_cluster #db_cluster} => Types::DBCluster
#
#
@@ -26120,10 +26393,11 @@
# rds_custom_cluster_configuration: {
# interconnect_subnet_id: "String",
# transit_gateway_multicast_domain_id: "String",
# replica_mode: "open-read-only", # accepts open-read-only, mounted
# },
+ # engine_lifecycle_support: "String",
# })
#
# @example Response structure
#
# resp.db_cluster.allocated_storage #=> Integer
@@ -26260,10 +26534,11 @@
# resp.db_cluster.limitless_database.status #=> String, one of "active", "not-in-use", "enabled", "disabled", "enabling", "disabling", "modifying-max-capacity", "error"
# resp.db_cluster.limitless_database.min_required_acu #=> Float
# resp.db_cluster.storage_throughput #=> Integer
# resp.db_cluster.certificate_details.ca_identifier #=> String
# resp.db_cluster.certificate_details.valid_till #=> Time
+ # resp.db_cluster.engine_lifecycle_support #=> String
#
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/RestoreDBClusterToPointInTime AWS API Documentation
#
# @overload restore_db_cluster_to_point_in_time(params = {})
# @param [Hash] params ({})
@@ -26401,17 +26676,41 @@
# parameter.
#
# @option params [String] :license_model
# License model information for the restored DB instance.
#
- # This setting doesn't apply to RDS Custom.
+ # <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*.
#
- # Default: Same as source.
+ # </note>
#
- # Valid Values: `license-included` \| `bring-your-own-license` \|
- # `general-public-license`
+ # This setting doesn't apply to Amazon Aurora or RDS Custom DB
+ # instances.
#
+ # Valid Values:
+ #
+ # * 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`
+ #
+ # Default: Same as the source.
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/db2-licensing.html
+ #
# @option params [String] :db_name
# The name of the database for the restored DB instance.
#
# This parameter only applies to RDS for Oracle and RDS for SQL Server
# DB instances. It doesn't apply to the other engines or to RDS Custom
@@ -26813,10 +27112,43 @@
#
#
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.SSL.html
# [2]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.SSL.html
#
+ # @option params [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, RDS
+ # automatically upgrades your restored DB instance to a higher engine
+ # version, if the major engine version is past its end of standard
+ # support date.
+ #
+ # </note>
+ #
+ # 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*.
+ #
+ # 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.
+ #
+ # 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 [Types::RestoreDBInstanceFromDBSnapshotResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::RestoreDBInstanceFromDBSnapshotResult#db_instance #db_instance} => Types::DBInstance
#
#
@@ -26909,10 +27241,11 @@
# storage_throughput: 1,
# db_cluster_snapshot_identifier: "String",
# allocated_storage: 1,
# dedicated_log_volume: false,
# ca_certificate_identifier: "String",
+ # engine_lifecycle_support: "String",
# })
#
# @example Response structure
#
# resp.db_instance.db_instance_identifier #=> String
@@ -27073,10 +27406,11 @@
# resp.db_instance.read_replica_source_db_cluster_identifier #=> String
# resp.db_instance.percent_progress #=> String
# resp.db_instance.dedicated_log_volume #=> Boolean
# resp.db_instance.is_storage_config_upgrade_available #=> Boolean
# resp.db_instance.multi_tenant #=> Boolean
+ # resp.db_instance.engine_lifecycle_support #=> String
#
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/RestoreDBInstanceFromDBSnapshot AWS API Documentation
#
# @overload restore_db_instance_from_db_snapshot(params = {})
# @param [Hash] params ({})
@@ -27425,13 +27759,19 @@
#
# @option params [String] :s3_prefix
# The prefix of your Amazon S3 bucket.
#
# @option params [required, String] :s3_ingestion_role_arn
- # An Amazon Web Services Identity and Access Management (IAM) role to
- # allow Amazon RDS to access your Amazon S3 bucket.
+ # An Amazon Web Services Identity and Access Management (IAM) role with
+ # a trust policy and a permissions policy that allows Amazon RDS to
+ # access your Amazon S3 bucket. For information about this role, see [
+ # Creating an IAM role manually][1] in the *Amazon RDS User Guide.*
#
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/MySQL.Procedural.Importing.html#MySQL.Procedural.Importing.Enabling.IAM
+ #
# @option params [Boolean] :enable_performance_insights
# Specifies whether to enable Performance Insights for the DB instance.
#
# For more information, see [Using Amazon Performance Insights][1] in
# the *Amazon RDS User Guide*.
@@ -27599,10 +27939,43 @@
#
#
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.SSL.html
# [2]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.SSL.html
#
+ # @option params [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, RDS
+ # automatically upgrades your restored DB instance to a higher engine
+ # version, if the major engine version is past its end of standard
+ # support date.
+ #
+ # </note>
+ #
+ # 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*.
+ #
+ # 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.
+ #
+ # 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 [Types::RestoreDBInstanceFromS3Result] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::RestoreDBInstanceFromS3Result#db_instance #db_instance} => Types::DBInstance
#
# @example Request syntax with placeholder values
@@ -27666,10 +28039,11 @@
# storage_throughput: 1,
# manage_master_user_password: false,
# master_user_secret_kms_key_id: "String",
# dedicated_log_volume: false,
# ca_certificate_identifier: "String",
+ # engine_lifecycle_support: "String",
# })
#
# @example Response structure
#
# resp.db_instance.db_instance_identifier #=> String
@@ -27830,10 +28204,11 @@
# resp.db_instance.read_replica_source_db_cluster_identifier #=> String
# resp.db_instance.percent_progress #=> String
# resp.db_instance.dedicated_log_volume #=> Boolean
# resp.db_instance.is_storage_config_upgrade_available #=> Boolean
# resp.db_instance.multi_tenant #=> Boolean
+ # resp.db_instance.engine_lifecycle_support #=> String
#
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/RestoreDBInstanceFromS3 AWS API Documentation
#
# @overload restore_db_instance_from_s3(params = {})
# @param [Hash] params ({})
@@ -27990,17 +28365,41 @@
# This setting doesn't apply to RDS Custom.
#
# @option params [String] :license_model
# The license model information for the restored DB instance.
#
- # This setting doesn't apply to RDS Custom.
+ # <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*.
#
- # Valid Values: `license-included` \| `bring-your-own-license` \|
- # `general-public-license`
+ # </note>
#
+ # This setting doesn't apply to Amazon Aurora or RDS Custom DB
+ # instances.
+ #
+ # Valid Values:
+ #
+ # * 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`
+ #
# Default: Same as the source.
#
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/db2-licensing.html
+ #
# @option params [String] :db_name
# The database name for the restored DB instance.
#
# This parameter doesn't apply to the following DB instances:
#
@@ -28399,10 +28798,43 @@
#
#
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.SSL.html
# [2]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.SSL.html
#
+ # @option params [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, RDS
+ # automatically upgrades your restored DB instance to a higher engine
+ # version, if the major engine version is past its end of standard
+ # support date.
+ #
+ # </note>
+ #
+ # 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*.
+ #
+ # 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.
+ #
+ # 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 [Types::RestoreDBInstanceToPointInTimeResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::RestoreDBInstanceToPointInTimeResult#db_instance #db_instance} => Types::DBInstance
#
#
@@ -28558,10 +28990,11 @@
# network_type: "String",
# storage_throughput: 1,
# allocated_storage: 1,
# dedicated_log_volume: false,
# ca_certificate_identifier: "String",
+ # engine_lifecycle_support: "String",
# })
#
# @example Response structure
#
# resp.db_instance.db_instance_identifier #=> String
@@ -28722,10 +29155,11 @@
# resp.db_instance.read_replica_source_db_cluster_identifier #=> String
# resp.db_instance.percent_progress #=> String
# resp.db_instance.dedicated_log_volume #=> Boolean
# resp.db_instance.is_storage_config_upgrade_available #=> Boolean
# resp.db_instance.multi_tenant #=> Boolean
+ # resp.db_instance.engine_lifecycle_support #=> String
#
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/RestoreDBInstanceToPointInTime AWS API Documentation
#
# @overload restore_db_instance_to_point_in_time(params = {})
# @param [Hash] params ({})
@@ -29122,10 +29556,11 @@
# resp.db_cluster.limitless_database.status #=> String, one of "active", "not-in-use", "enabled", "disabled", "enabling", "disabling", "modifying-max-capacity", "error"
# resp.db_cluster.limitless_database.min_required_acu #=> Float
# resp.db_cluster.storage_throughput #=> Integer
# resp.db_cluster.certificate_details.ca_identifier #=> String
# resp.db_cluster.certificate_details.valid_till #=> Time
+ # resp.db_cluster.engine_lifecycle_support #=> String
#
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/StartDBCluster AWS API Documentation
#
# @overload start_db_cluster(params = {})
# @param [Hash] params ({})
@@ -29339,10 +29774,11 @@
# resp.db_instance.read_replica_source_db_cluster_identifier #=> String
# resp.db_instance.percent_progress #=> String
# resp.db_instance.dedicated_log_volume #=> Boolean
# resp.db_instance.is_storage_config_upgrade_available #=> Boolean
# resp.db_instance.multi_tenant #=> Boolean
+ # resp.db_instance.engine_lifecycle_support #=> String
#
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/StartDBInstance AWS API Documentation
#
# @overload start_db_instance(params = {})
# @param [Hash] params ({})
@@ -29963,10 +30399,11 @@
# resp.db_cluster.limitless_database.status #=> String, one of "active", "not-in-use", "enabled", "disabled", "enabling", "disabling", "modifying-max-capacity", "error"
# resp.db_cluster.limitless_database.min_required_acu #=> Float
# resp.db_cluster.storage_throughput #=> Integer
# resp.db_cluster.certificate_details.ca_identifier #=> String
# resp.db_cluster.certificate_details.valid_till #=> Time
+ # resp.db_cluster.engine_lifecycle_support #=> String
#
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/StopDBCluster AWS API Documentation
#
# @overload stop_db_cluster(params = {})
# @param [Hash] params ({})
@@ -30187,10 +30624,11 @@
# resp.db_instance.read_replica_source_db_cluster_identifier #=> String
# resp.db_instance.percent_progress #=> String
# resp.db_instance.dedicated_log_volume #=> Boolean
# resp.db_instance.is_storage_config_upgrade_available #=> Boolean
# resp.db_instance.multi_tenant #=> Boolean
+ # resp.db_instance.engine_lifecycle_support #=> String
#
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/StopDBInstance AWS API Documentation
#
# @overload stop_db_instance(params = {})
# @param [Hash] params ({})
@@ -30576,10 +31014,11 @@
# resp.global_cluster.global_cluster_resource_id #=> String
# resp.global_cluster.global_cluster_arn #=> String
# resp.global_cluster.status #=> String
# resp.global_cluster.engine #=> String
# resp.global_cluster.engine_version #=> String
+ # resp.global_cluster.engine_lifecycle_support #=> String
# resp.global_cluster.database_name #=> String
# resp.global_cluster.storage_encrypted #=> Boolean
# resp.global_cluster.deletion_protection #=> Boolean
# resp.global_cluster.global_cluster_members #=> Array
# resp.global_cluster.global_cluster_members[0].db_cluster_arn #=> String
@@ -30787,10 +31226,11 @@
# resp.db_instance.read_replica_source_db_cluster_identifier #=> String
# resp.db_instance.percent_progress #=> String
# resp.db_instance.dedicated_log_volume #=> Boolean
# resp.db_instance.is_storage_config_upgrade_available #=> Boolean
# resp.db_instance.multi_tenant #=> Boolean
+ # resp.db_instance.engine_lifecycle_support #=> String
#
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/SwitchoverReadReplica AWS API Documentation
#
# @overload switchover_read_replica(params = {})
# @param [Hash] params ({})
@@ -30810,10 +31250,10 @@
operation: config.api.operation(operation_name),
client: self,
params: params,
config: config)
context[:gem_name] = 'aws-sdk-rds'
- context[:gem_version] = '1.229.0'
+ context[:gem_version] = '1.233.0'
Seahorse::Client::Request.new(handlers, context)
end
# Polls an API operation until a resource enters a desired state.
#