lib/aws-sdk-rds/resource.rb in aws-sdk-rds-1.69.0 vs lib/aws-sdk-rds/resource.rb in aws-sdk-rds-1.70.0
- old
+ new
@@ -107,11 +107,12 @@
# * Can't end with a hyphen or contain two consecutive hyphens.
#
# Example: `my-cluster1`
# @option options [String] :db_cluster_parameter_group_name
# The name of the DB cluster parameter group to associate with this DB
- # cluster. If this argument is omitted, `default.aurora5.6` is used.
+ # cluster. If you do not specify a value, then the default DB cluster
+ # parameter group for the specified DB engine and version is used.
#
# Constraints:
#
# * If supplied, must match the name of an existing DB cluster parameter
# group.
@@ -244,18 +245,18 @@
# encryption key. If you are creating a DB cluster with the same AWS
# account that owns the KMS encryption key used to encrypt the new DB
# cluster, then you can use the KMS key alias instead of the ARN for the
# KMS encryption key.
#
- # If an encryption key is not specified in `KmsKeyId`\:
+ # If an encryption key isn't specified in `KmsKeyId`\:
#
# * If `ReplicationSourceIdentifier` identifies an encrypted source,
# then Amazon RDS will use the encryption key used to encrypt the
# source. Otherwise, Amazon RDS will use your default encryption key.
#
# * If the `StorageEncrypted` parameter is enabled and
- # `ReplicationSourceIdentifier` is not specified, then Amazon RDS will
+ # `ReplicationSourceIdentifier` isn't specified, then Amazon RDS will
# use your default encryption key.
#
# AWS KMS creates the default encryption key for your AWS account. Your
# AWS account has a different default encryption key for each AWS
# Region.
@@ -297,12 +298,20 @@
#
# To learn how to generate a Signature Version 4 signed request, see [
# Authenticating Requests: Using Query Parameters (AWS Signature Version
# 4)][1] and [ Signature Version 4 Signing Process][2].
#
+ # <note markdown="1"> If you are using an AWS SDK tool or the AWS CLI, you can specify
+ # `SourceRegion` (or `--source-region` for the AWS 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 AWS Region.
#
+ # </note>
#
+ #
+ #
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/API/sigv4-query-string-auth.html
# [2]: https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html
# @option options [Boolean] :enable_iam_database_authentication
# A value that indicates whether to enable mapping of AWS Identity and
# Access Management (IAM) accounts to database accounts. By default,
@@ -501,11 +510,11 @@
# you use.
#
# **MySQL**
#
# The name of the database to create when the DB instance is created. If
- # this parameter is not specified, no database is created in the DB
+ # this parameter isn't specified, no database is created in the DB
# instance.
#
# Constraints:
#
# * Must contain 1 to 64 letters or numbers.
@@ -513,11 +522,11 @@
# * Can't be a word reserved by the specified database engine
#
# **MariaDB**
#
# The name of the database to create when the DB instance is created. If
- # this parameter is not specified, no database is created in the DB
+ # this parameter isn't specified, no database is created in the DB
# instance.
#
# Constraints:
#
# * Must contain 1 to 64 letters or numbers.
@@ -525,11 +534,11 @@
# * Can't be a word reserved by the specified database engine
#
# **PostgreSQL**
#
# The name of the database to create when the DB instance is created. If
- # this parameter is not specified, the default "postgres" database is
+ # this parameter isn't specified, the default "postgres" database is
# created in the DB instance.
#
# Constraints:
#
# * Must contain 1 to 63 letters, numbers, or underscores.
@@ -558,11 +567,11 @@
# Not applicable. Must be null.
#
# **Amazon Aurora**
#
# The name of the database to create when the primary instance of the DB
- # cluster is created. If this parameter is not specified, no database is
+ # cluster is created. If this parameter isn't specified, no database is
# created in the DB instance.
#
# Constraints:
#
# * Must contain 1 to 64 letters or numbers.
@@ -870,12 +879,12 @@
#
#
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_UpgradeDBInstance.Maintenance.html#Concepts.DBMaintenance
# @option options [String] :db_parameter_group_name
# The name of the DB parameter group to associate with this DB instance.
- # If you do not specify a value for `DBParameterGroupName`, then the
- # default `DBParameterGroup` for the specified DB engine is used.
+ # If you do not specify a value, then the default DB parameter group for
+ # the specified DB engine and version is used.
#
# Constraints:
#
# * Must be 1 to 255 letters, numbers, or hyphens.
#
@@ -1065,27 +1074,27 @@
# more information, see `CreateDBCluster`.
# @option options [Boolean] :publicly_accessible
# A value that indicates whether the DB instance is publicly accessible.
# When the DB instance is publicly accessible, it is an Internet-facing
# instance with a publicly resolvable DNS name, which resolves to a
- # public IP address. When the DB instance is not publicly accessible, it
+ # public IP address. When the DB instance isn't publicly accessible, it
# is an internal instance with a DNS name that resolves to a private IP
# address.
#
# Default: The default behavior varies depending on whether
# `DBSubnetGroupName` is specified.
#
- # If `DBSubnetGroupName` is not specified, and `PubliclyAccessible` is
- # not specified, the following applies:
+ # If `DBSubnetGroupName` isn't specified, and `PubliclyAccessible`
+ # isn't specified, the following applies:
#
# * If the default VPC in the target region doesn’t have an Internet
# gateway attached to it, the DB instance is private.
#
# * If the default VPC in the target region has an Internet gateway
# attached to it, the DB instance is public.
#
- # If `DBSubnetGroupName` is specified, and `PubliclyAccessible` is not
+ # If `DBSubnetGroupName` is specified, and `PubliclyAccessible` isn't
# specified, the following applies:
#
# * If the subnets are part of a VPC that doesn’t have an Internet
# gateway attached to it, the DB instance is private.
#
@@ -1110,11 +1119,11 @@
# @option options [String] :tde_credential_password
# The password for the given ARN from the key store in order to access
# the device.
# @option options [Boolean] :storage_encrypted
# A value that indicates whether the DB instance is encrypted. By
- # default, it is not encrypted.
+ # default, it isn't encrypted.
#
# **Amazon Aurora**
#
# Not applicable. The encryption for DB instances is managed by the DB
# cluster.
@@ -1468,11 +1477,11 @@
# notification. The ARN is created by Amazon SNS when you create a topic
# and subscribe to it.
# @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 would
- # set this parameter to db-instance. if this value is not specified, all
+ # set this parameter to db-instance. 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`
# @option options [Array<String>] :event_categories
@@ -1506,11 +1515,11 @@
#
# * If the source type is a DB snapshot, a `DBSnapshotIdentifier` must
# be supplied.
# @option options [Boolean] :enabled
# A value that indicates whether to activate the subscription. If the
- # event notification subscription is not activated, the subscription is
+ # event notification subscription isn't activated, the subscription is
# created but not active.
# @option options [Array<Types::Tag>] :tags
# A list of tags. For more information, see [Tagging Amazon RDS
# Resources][1] in the *Amazon RDS User Guide.*
#
@@ -1629,16 +1638,16 @@
#
# * Must match an existing CertificateIdentifier.
#
# ^
# @option options [Array<Types::Filter>] :filters
- # This parameter is not currently supported.
+ # This parameter isn't currently supported.
# @option options [Integer] :max_records
# The maximum number of records to include in the response. If more
# records exist than the specified `MaxRecords` value, a pagination
- # token called a marker is included in the response so that you can
- # retrieve the remaining results.
+ # token called a marker is included in the response so you can retrieve
+ # the remaining results.
#
# Default: 100
#
# Constraints: Minimum 20, maximum 100.
# @option options [String] :marker
@@ -1704,16 +1713,16 @@
# * If supplied, must match the name of an existing
# DBClusterParameterGroup.
#
# ^
# @option options [Array<Types::Filter>] :filters
- # This parameter is not currently supported.
+ # This parameter isn't currently supported.
# @option options [Integer] :max_records
# The maximum number of records to include in the response. If more
# records exist than the specified `MaxRecords` value, a pagination
- # token called a marker is included in the response so that you can
- # retrieve the remaining results.
+ # token called a marker is included in the response so you can retrieve
+ # the remaining results.
#
# Default: 100
#
# Constraints: Minimum 20, maximum 100.
# @option options [String] :marker
@@ -1845,11 +1854,11 @@
#
# * If supplied, must match an existing DBParameterGroupFamily.
#
# ^
# @option options [Array<Types::Filter>] :filters
- # This parameter is not currently supported.
+ # This parameter isn't currently supported.
# @option options [Boolean] :default_only
# A value that indicates whether only the default version of the
# specified engine or engine and major version combination is returned.
# @option options [Boolean] :list_supported_character_sets
# A value that indicates whether to list the supported character sets
@@ -2001,11 +2010,11 @@
# * If supplied, must match the name of an existing
# DBClusterParameterGroup.
#
# ^
# @option options [Array<Types::Filter>] :filters
- # This parameter is not currently supported.
+ # This parameter isn't currently supported.
# @return [DBParameterGroup::Collection]
def db_parameter_groups(options = {})
batches = Enumerator.new do |y|
resp = @client.describe_db_parameter_groups(options)
resp.each_page do |page|
@@ -2045,11 +2054,11 @@
# })
# @param [Hash] options ({})
# @option options [String] :db_security_group_name
# The name of the DB security group to return details for.
# @option options [Array<Types::Filter>] :filters
- # This parameter is not currently supported.
+ # This parameter isn't currently supported.
# @return [DBSecurityGroup::Collection]
def db_security_groups(options = {})
batches = Enumerator.new do |y|
resp = @client.describe_db_security_groups(options)
resp.each_page do |page|
@@ -2085,11 +2094,11 @@
# })
# @param [Hash] options ({})
# @option options [String] :db_instance_identifier
# The ID of the DB instance to retrieve the list of DB snapshots for.
# This parameter can't be used in conjunction with
- # `DBSnapshotIdentifier`. This parameter is not case-sensitive.
+ # `DBSnapshotIdentifier`. This parameter isn't case-sensitive.
#
# Constraints:
#
# * If supplied, must match the identifier of an existing DBInstance.
#
@@ -2219,11 +2228,11 @@
# })
# @param [Hash] options ({})
# @option options [String] :db_subnet_group_name
# The name of the DB subnet group to return details for.
# @option options [Array<Types::Filter>] :filters
- # This parameter is not currently supported.
+ # This parameter isn't currently supported.
# @return [DBSubnetGroup::Collection]
def db_subnet_groups(options = {})
batches = Enumerator.new do |y|
resp = @client.describe_db_subnet_groups(options)
resp.each_page do |page|
@@ -2266,11 +2275,11 @@
# The type of source that is generating the events.
#
# Valid values: db-instance \| db-parameter-group \| db-security-group
# \| db-snapshot
# @option options [Array<Types::Filter>] :filters
- # This parameter is not currently supported.
+ # This parameter isn't currently supported.
# @return [EventCategoryMap::Collection]
def event_category_maps(options = {})
batches = Enumerator.new do |y|
batch = []
resp = @client.describe_event_categories(options)
@@ -2309,11 +2318,11 @@
# @param [Hash] options ({})
# @option options [String] :subscription_name
# The name of the RDS event notification subscription you want to
# describe.
# @option options [Array<Types::Filter>] :filters
- # This parameter is not currently supported.
+ # This parameter isn't currently supported.
# @return [EventSubscription::Collection]
def event_subscriptions(options = {})
batches = Enumerator.new do |y|
resp = @client.describe_event_subscriptions(options)
resp.each_page do |page|
@@ -2398,11 +2407,11 @@
# Default: 60
# @option options [Array<String>] :event_categories
# A list of event categories that trigger notifications for a event
# notification subscription.
# @option options [Array<Types::Filter>] :filters
- # This parameter is not currently supported.
+ # This parameter isn't currently supported.
# @return [Event::Collection]
def events(options = {})
batches = Enumerator.new do |y|
resp = @client.describe_events(options)
resp.each_page do |page|
@@ -2446,11 +2455,11 @@
# @param [Hash] options ({})
# @option options [String] :option_group_name
# The name of the option group to describe. Can't be supplied together
# with EngineName or MajorEngineVersion.
# @option options [Array<Types::Filter>] :filters
- # This parameter is not currently supported.
+ # This parameter isn't currently supported.
# @option options [String] :engine_name
# Filters the list of option groups to only include groups associated
# with a specific database engine.
# @option options [String] :major_engine_version
# Filters the list of option groups to only include groups associated
@@ -2548,11 +2557,11 @@
# <note markdown="1"> AWS Support might request the lease ID for an issue related to a
# reserved DB instance.
#
# </note>
# @option options [Array<Types::Filter>] :filters
- # This parameter is not currently supported.
+ # This parameter isn't currently supported.
# @return [ReservedDBInstance::Collection]
def reserved_db_instances(options = {})
batches = Enumerator.new do |y|
resp = @client.describe_reserved_db_instances(options)
resp.each_page do |page|
@@ -2625,10 +2634,10 @@
# Valid Values: `"Partial Upfront" | "All Upfront" | "No Upfront" `
# @option options [Boolean] :multi_az
# A value that indicates whether to show only those reservations that
# support Multi-AZ.
# @option options [Array<Types::Filter>] :filters
- # This parameter is not currently supported.
+ # This parameter isn't currently supported.
# @return [ReservedDBInstancesOffering::Collection]
def reserved_db_instances_offerings(options = {})
batches = Enumerator.new do |y|
resp = @client.describe_reserved_db_instances_offerings(options)
resp.each_page do |page|