lib/aws-sdk-rds/client.rb in aws-sdk-rds-1.26.0 vs lib/aws-sdk-rds/client.rb in aws-sdk-rds-1.27.0
- old
+ new
@@ -157,16 +157,17 @@
end
# @!group API Operations
# Associates an Identity and Access Management (IAM) role from an Aurora
- # DB cluster. For more information, see [Authorizing Amazon Aurora to
- # Access Other AWS Services On Your Behalf][1].
+ # DB cluster. For more information, see [Authorizing Amazon Aurora MySQL
+ # to Access Other AWS Services on Your Behalf][1] in the *Amazon Aurora
+ # User Guide*.
#
#
#
- # [1]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Aurora.Authorizing.AWSServices.html
+ # [1]: http://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraMySQL.Integrating.Authorizing.html
#
# @option params [required, String] :db_cluster_identifier
# The name of the DB cluster to associate the IAM role with.
#
# @option params [required, String] :role_arn
@@ -513,15 +514,15 @@
# Backtracks a DB cluster to a specific time, without creating a new DB
# cluster.
#
# For more information on backtracking, see [ Backtracking an Aurora DB
- # Cluster][1] in the *Amazon RDS User Guide.*
+ # Cluster][1] in the *Amazon Aurora User Guide.*
#
#
#
- # [1]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/AuroraMySQL.Managing.Backtrack.html
+ # [1]: http://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraMySQL.Managing.Backtrack.html
#
# @option params [required, String] :db_cluster_identifier
# The DB cluster identifier of the DB cluster to be backtracked. This
# parameter is stored as a lowercase string.
#
@@ -607,11 +608,12 @@
# Copies the specified DB cluster parameter group.
#
# @option params [required, String] :source_db_cluster_parameter_group_identifier
# The identifier or Amazon Resource Name (ARN) for the source DB cluster
# parameter group. For information about creating an ARN, see [
- # Constructing an RDS Amazon Resource Name (ARN)][1].
+ # Constructing an ARN for Amazon RDS][1] in the *Amazon Aurora User
+ # Guide*.
#
# Constraints:
#
# * Must specify a valid DB cluster parameter group.
#
@@ -624,11 +626,11 @@
# example
# `arn:aws:rds:us-east-1:123456789012:cluster-pg:custom-cluster-group1`.
#
#
#
- # [1]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.ARN.html#USER_Tagging.ARN.Constructing
+ # [1]: http://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_Tagging.ARN.html#USER_Tagging.ARN.Constructing
#
# @option params [required, String] :target_db_cluster_parameter_group_identifier
# The identifier for the copied DB cluster parameter group.
#
# Constraints:
@@ -646,11 +648,11 @@
# @option params [required, String] :target_db_cluster_parameter_group_description
# A description for the copied DB cluster parameter group.
#
# @option params [Array<Types::Tag>] :tags
# A list of tags. For more information, see [Tagging Amazon RDS
- # Resources][1].
+ # Resources][1] in the *Amazon RDS User Guide.*
#
#
#
# [1]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html
#
@@ -767,23 +769,22 @@
# To cancel the copy operation once it is in progress, delete the target
# DB cluster snapshot identified by `TargetDBClusterSnapshotIdentifier`
# while that DB cluster snapshot is in "copying" status.
#
# For more information on copying encrypted DB cluster snapshots from
- # one AWS Region to another, see [ Copying a DB Cluster Snapshot in the
- # Same Account, Either in the Same Region or Across Regions][3] in the
- # *Amazon RDS User Guide.*
+ # one AWS Region to another, see [ Copying a Snapshot][3] in the *Amazon
+ # Aurora User Guide.*
#
- # For more information on Amazon Aurora, see [Aurora on Amazon RDS][4]
- # in the *Amazon RDS User Guide.*
+ # For more information on Amazon Aurora, see the [ *Amazon Aurora User
+ # Guide.* ][4]
#
#
#
# [1]: http://docs.aws.amazon.com/AmazonS3/latest/API/sigv4-query-string-auth.html
# [2]: http://docs.aws.amazon.com/general/latest/gr/signature-version-4.html
- # [3]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_CopySnapshot.html#USER_CopyDBClusterSnapshot.CrossRegion
- # [4]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Aurora.html
+ # [3]: http://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_CopySnapshot.html
+ # [4]: http://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html
#
# @option params [required, String] :source_db_cluster_snapshot_identifier
# The identifier of the DB cluster snapshot to copy. This parameter is
# not case-sensitive.
#
@@ -797,17 +798,18 @@
# * If the source snapshot is in the same AWS Region as the copy,
# specify a valid DB snapshot identifier.
#
# * If the source snapshot is in a different AWS Region than the copy,
# specify a valid DB cluster snapshot ARN. For more information, go to
- # [ Copying a DB Snapshot or DB Cluster Snapshot][1].
+ # [ Copying Snapshots Across AWS Regions][1] in the *Amazon Aurora
+ # User Guide.*
#
# Example: `my-cluster-snapshot1`
#
#
#
- # [1]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_CopySnapshot.html
+ # [1]: http://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_CopySnapshot.html#USER_CopySnapshot.AcrossRegions
#
# @option params [required, String] :target_db_cluster_snapshot_identifier
# The identifier of the new DB cluster snapshot to create from the
# source DB cluster snapshot. This parameter is not case-sensitive.
#
@@ -889,11 +891,11 @@
# True to copy all tags from the source DB cluster snapshot to the
# target DB cluster snapshot, and otherwise false. The default is false.
#
# @option params [Array<Types::Tag>] :tags
# A list of tags. For more information, see [Tagging Amazon RDS
- # Resources][1].
+ # Resources][1] in the *Amazon RDS User Guide.*
#
#
#
# [1]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html
#
@@ -973,12 +975,12 @@
# Copies the specified DB parameter group.
#
# @option params [required, String] :source_db_parameter_group_identifier
# The identifier or ARN for the source DB parameter group. For
- # information about creating an ARN, see [ Constructing an RDS Amazon
- # Resource Name (ARN)][1].
+ # information about creating an ARN, see [ Constructing an ARN for
+ # Amazon RDS][1] in the *Amazon RDS User Guide*.
#
# Constraints:
#
# * Must specify a valid DB parameter group.
#
@@ -1007,11 +1009,11 @@
# @option params [required, String] :target_db_parameter_group_description
# A description for the copied DB parameter group.
#
# @option params [Array<Types::Tag>] :tags
# A list of tags. For more information, see [Tagging Amazon RDS
- # Resources][1].
+ # Resources][1] in the *Amazon RDS User Guide.*
#
#
#
# [1]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html
#
@@ -1146,11 +1148,11 @@
# keys are specific to the AWS Region that they are created in, and you
# can't use encryption keys from one AWS Region in another AWS Region.
#
# @option params [Array<Types::Tag>] :tags
# A list of tags. For more information, see [Tagging Amazon RDS
- # Resources][1].
+ # Resources][1] in the *Amazon RDS User Guide.*
#
#
#
# [1]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html
#
@@ -1214,11 +1216,11 @@
# Specify this option if you are copying a snapshot from one AWS Region
# to another, and your DB instance uses a nondefault option group. If
# your source DB instance uses Transparent Data Encryption for Oracle or
# Microsoft SQL Server, you must specify this option when copying across
# AWS Regions. For more information, see [Option Group
- # Considerations][1].
+ # Considerations][1] in the *Amazon RDS User Guide.*
#
#
#
# [1]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_CopySnapshot.html#USER_CopySnapshot.Options
#
@@ -1307,12 +1309,12 @@
# Copies the specified option group.
#
# @option params [required, String] :source_option_group_identifier
# The identifier or ARN for the source option group. For information
- # about creating an ARN, see [ Constructing an RDS Amazon Resource Name
- # (ARN)][1].
+ # about creating an ARN, see [ Constructing an ARN for Amazon RDS][1] in
+ # the *Amazon RDS User Guide*.
#
# Constraints:
#
# * Must specify a valid option group.
#
@@ -1346,11 +1348,11 @@
# @option params [required, String] :target_option_group_description
# The description for the copied option group.
#
# @option params [Array<Types::Tag>] :tags
# A list of tags. For more information, see [Tagging Amazon RDS
- # Resources][1].
+ # Resources][1] in the *Amazon RDS User Guide.*
#
#
#
# [1]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html
#
@@ -1437,25 +1439,26 @@
# DB cluster as a Read Replica of another DB cluster or Amazon RDS MySQL
# DB instance. For cross-region replication where the DB cluster
# identified by `ReplicationSourceIdentifier` is encrypted, you must
# also specify the `PreSignedUrl` parameter.
#
- # For more information on Amazon Aurora, see [Aurora on Amazon RDS][1]
- # in the *Amazon RDS User Guide.*
+ # For more information on Amazon Aurora, see the [ *Amazon Aurora User
+ # Guide.* ][1]
#
#
#
- # [1]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Aurora.html
+ # [1]: http://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html
#
# @option params [Array<String>] :availability_zones
# A list of EC2 Availability Zones that instances in the DB cluster can
# be created in. For information on AWS Regions and Availability Zones,
- # see [Regions and Availability Zones][1].
+ # see [Choosing the Regions and Availability Zones][1] in the *Amazon
+ # Aurora User Guide*.
#
#
#
- # [1]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.RegionsAndAvailabilityZones.html
+ # [1]: http://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Concepts.RegionsAndAvailabilityZones.html
#
# @option params [Integer] :backup_retention_period
# The number of days for which automated backups are retained. You must
# specify a minimum value of 1.
#
@@ -1567,12 +1570,12 @@
# automated backups are enabled using the `BackupRetentionPeriod`
# parameter.
#
# The default is a 30-minute window selected at random from an 8-hour
# block of time for each AWS Region. To see the time blocks available,
- # see [ Adjusting the Preferred Maintenance Window][1] in the *Amazon
- # RDS User Guide.*
+ # see [ Adjusting the Preferred DB Cluster Maintenance Window][1] in the
+ # *Amazon Aurora User Guide.*
#
# Constraints:
#
# * Must be in the format `hh24:mi-hh24:mi`.
#
@@ -1582,38 +1585,38 @@
#
# * Must be at least 30 minutes.
#
#
#
- # [1]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/AdjustingTheMaintenanceWindow.html
+ # [1]: http://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_UpgradeDBInstance.Maintenance.html#AdjustingTheMaintenanceWindow.Aurora
#
# @option params [String] :preferred_maintenance_window
# The weekly time range during which system maintenance can occur, in
# Universal Coordinated Time (UTC).
#
# Format: `ddd:hh24:mi-ddd:hh24:mi`
#
# The default is a 30-minute window selected at random from an 8-hour
# block of time for each AWS Region, occurring on a random day of the
# week. To see the time blocks available, see [ Adjusting the Preferred
- # Maintenance Window][1] in the *Amazon RDS User Guide.*
+ # DB Cluster Maintenance Window][1] in the *Amazon Aurora User Guide.*
#
# Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.
#
# Constraints: Minimum 30-minute window.
#
#
#
- # [1]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/AdjustingTheMaintenanceWindow.html
+ # [1]: http://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_UpgradeDBInstance.Maintenance.html#AdjustingTheMaintenanceWindow.Aurora
#
# @option params [String] :replication_source_identifier
# The Amazon Resource Name (ARN) of the source DB instance or DB cluster
# if this DB cluster is created as a Read Replica.
#
# @option params [Array<Types::Tag>] :tags
# A list of tags. For more information, see [Tagging Amazon RDS
- # Resources][1].
+ # Resources][1] in the *Amazon RDS User Guide.*
#
#
#
# [1]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html
#
@@ -1709,16 +1712,15 @@
#
# @option params [Array<String>] :enable_cloudwatch_logs_exports
# The list of log types that need to be enabled for exporting to
# CloudWatch Logs. The values in the list depend on the DB engine being
# used. For more information, see [Publishing Database Logs to Amazon
- # CloudWatch Logs ][1] in the *Amazon Relational Database Service User
- # Guide*.
+ # CloudWatch Logs][1] in the *Amazon Aurora User Guide*.
#
#
#
- # [1]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch
+ # [1]: http://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch
#
# @option params [String] :engine_mode
# The DB engine mode of the DB cluster, either `provisioned` or
# `serverless`.
#
@@ -1900,17 +1902,17 @@
# the default database defined by the `character_set_database`
# parameter. You can use the *Parameter Groups* option of the [Amazon
# RDS console][1] or the DescribeDBClusterParameters command to verify
# that your DB cluster parameter group has been created or modified.
#
- # For more information on Amazon Aurora, see [Aurora on Amazon RDS][2]
- # in the *Amazon RDS User Guide.*
+ # For more information on Amazon Aurora, see the [ *Amazon Aurora User
+ # Guide* ][2].
#
#
#
# [1]: https://console.aws.amazon.com/rds/
- # [2]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Aurora.html
+ # [2]: http://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html
#
# @option params [required, String] :db_cluster_parameter_group_name
# The name of the DB cluster parameter group.
#
# Constraints:
@@ -1941,11 +1943,11 @@
# @option params [required, String] :description
# The description for the DB cluster parameter group.
#
# @option params [Array<Types::Tag>] :tags
# A list of tags. For more information, see [Tagging Amazon RDS
- # Resources][1].
+ # Resources][1] in the *Amazon RDS User Guide.*
#
#
#
# [1]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html
#
@@ -1999,15 +2001,15 @@
req = build_request(:create_db_cluster_parameter_group, params)
req.send_request(options)
end
# Creates a snapshot of a DB cluster. For more information on Amazon
- # Aurora, see [Aurora on Amazon RDS][1] in the *Amazon RDS User Guide.*
+ # Aurora, see the [ *Amazon Aurora User Guide* ][1].
#
#
#
- # [1]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Aurora.html
+ # [1]: http://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html
#
# @option params [required, String] :db_cluster_snapshot_identifier
# The identifier of the DB cluster snapshot. This parameter is stored as
# a lowercase string.
#
@@ -2513,20 +2515,22 @@
# * Cannot be set to 0 if the DB instance is a source to Read Replicas
#
# @option params [String] :preferred_backup_window
# The daily time range during which automated backups are created if
# automated backups are enabled, using the `BackupRetentionPeriod`
- # parameter. For more information, see [The Backup Window][1].
+ # parameter. For more information, see [The Backup Window][1] in the
+ # *Amazon RDS User Guide*.
#
# **Amazon Aurora**
#
# Not applicable. The daily time range for creating automated backups is
# managed by the DB cluster. For more information, see CreateDBCluster.
#
# The default is a 30-minute window selected at random from an 8-hour
# block of time for each AWS Region. To see the time blocks available,
- # see [ Adjusting the Preferred DB Instance Maintenance Window][2].
+ # see [ Adjusting the Preferred DB Instance Maintenance Window][2] in
+ # the *Amazon RDS User Guide*.
#
# Constraints:
#
# * Must be in the format `hh24:mi-hh24:mi`.
#
@@ -2655,11 +2659,11 @@
#
# @option params [Integer] :iops
# The amount of Provisioned IOPS (input/output operations per second) to
# be initially allocated for the DB instance. For information about
# valid Iops values, see see [Amazon RDS Provisioned IOPS Storage to
- # Improve Performance][1].
+ # Improve Performance][1] in the *Amazon RDS User Guide*.
#
# Constraints: Must be a multiple between 1 and 50 of the storage amount
# for the DB instance. Must also be an integer multiple of 1000. For
# example, if the size of your DB instance is 500 GiB, then your `Iops`
# value can be 2000, 3000, 4000, or 5000.
@@ -2714,11 +2718,11 @@
# * If the subnets are part of a VPC that has an Internet gateway
# attached to it, the DB instance is public.
#
# @option params [Array<Types::Tag>] :tags
# A list of tags. For more information, see [Tagging Amazon RDS
- # Resources][1].
+ # Resources][1] in the *Amazon RDS User Guide.*
#
#
#
# [1]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html
#
@@ -2798,11 +2802,11 @@
# @option params [String] :monitoring_role_arn
# The ARN for the IAM role that permits RDS to send enhanced monitoring
# metrics to Amazon CloudWatch Logs. For example,
# `arn:aws:iam:123456789012:role/emaccess`. For information on creating
# a monitoring role, go to [Setting Up and Enabling Enhanced
- # Monitoring][1].
+ # Monitoring][1] in the *Amazon RDS User Guide*.
#
# If `MonitoringInterval` is set to a value other than 0, then you must
# supply a `MonitoringRoleArn` value.
#
#
@@ -2815,19 +2819,19 @@
#
# @option params [Integer] :promotion_tier
# A value that specifies the order in which an Aurora Replica is
# promoted to the primary instance after a failure of the existing
# primary instance. For more information, see [ Fault Tolerance for an
- # Aurora DB Cluster][1].
+ # Aurora DB Cluster][1] in the *Amazon Aurora User Guide*.
#
# Default: 1
#
# Valid Values: 0 - 15
#
#
#
- # [1]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Aurora.Managing.html#Aurora.Managing.FaultTolerance
+ # [1]: http://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Managing.Backups.html#Aurora.Managing.FaultTolerance
#
# @option params [String] :timezone
# The time zone of the DB instance. The time zone parameter is currently
# supported only by [Microsoft SQL Server][1].
#
@@ -3090,11 +3094,12 @@
end
# Creates a new DB instance that acts as a Read Replica for an existing
# source DB instance. You can create a Read Replica for a DB instance
# running MySQL, MariaDB, or PostgreSQL. For more information, see
- # [Working with PostgreSQL, MySQL, and MariaDB Read Replicas][1].
+ # [Working with PostgreSQL, MySQL, and MariaDB Read Replicas][1] in the
+ # *Amazon RDS User Guide*.
#
# Amazon Aurora doesn't support this action. You must call the
# `CreateDBInstance` action to create a DB instance for an Aurora DB
# cluster.
#
@@ -3136,11 +3141,12 @@
# * If the source DB instance is in the same AWS Region as the Read
# Replica, specify a valid DB instance identifier.
#
# * If the source DB instance is in a different AWS Region than the Read
# Replica, specify a valid DB instance ARN. For more information, go
- # to [ Constructing a Amazon RDS Amazon Resource Name (ARN)][1].
+ # to [ Constructing an ARN for Amazon RDS][1] in the *Amazon RDS User
+ # Guide*.
#
#
#
# [1]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.ARN.html#USER_Tagging.ARN.Constructing
#
@@ -3202,11 +3208,11 @@
# specifies an internal instance with a DNS name that resolves to a
# private IP address. For more information, see CreateDBInstance.
#
# @option params [Array<Types::Tag>] :tags
# A list of tags. For more information, see [Tagging Amazon RDS
- # Resources][1].
+ # Resources][1] in the *Amazon RDS User Guide.*
#
#
#
# [1]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html
#
@@ -3265,11 +3271,11 @@
# @option params [String] :monitoring_role_arn
# The ARN for the IAM role that permits RDS to send enhanced monitoring
# metrics to Amazon CloudWatch Logs. For example,
# `arn:aws:iam:123456789012:role/emaccess`. For information on creating
# a monitoring role, go to [To create an IAM role for Amazon RDS
- # Enhanced Monitoring][1].
+ # Enhanced Monitoring][1] in the *Amazon RDS User Guide*.
#
# If `MonitoringInterval` is set to a value other than 0, then you must
# supply a `MonitoringRoleArn` value.
#
#
@@ -3365,11 +3371,11 @@
# @option params [Boolean] :enable_performance_insights
# True to enable Performance Insights for the read replica, and
# otherwise false.
#
# For more information, see [Using Amazon Performance Insights][1] in
- # the *Amazon Relational Database Service User Guide*.
+ # the *Amazon RDS User Guide*.
#
#
#
# [1]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.html
#
@@ -3384,11 +3390,11 @@
#
# @option params [Array<String>] :enable_cloudwatch_logs_exports
# The list of logs that the new DB instance is to export to CloudWatch
# Logs. The values in the list depend on the DB engine being used. For
# more information, see [Publishing Database Logs to Amazon CloudWatch
- # Logs ][1] in the *Amazon Relational Database Service User Guide*.
+ # Logs ][1] in the *Amazon RDS User Guide*.
#
#
#
# [1]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch
#
@@ -3654,11 +3660,11 @@
# @option params [required, String] :description
# The description for the DB parameter group.
#
# @option params [Array<Types::Tag>] :tags
# A list of tags. For more information, see [Tagging Amazon RDS
- # Resources][1].
+ # Resources][1] in the *Amazon RDS User Guide.*
#
#
#
# [1]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html
#
@@ -3740,11 +3746,11 @@
# @option params [required, String] :db_security_group_description
# The description for the DB security group.
#
# @option params [Array<Types::Tag>] :tags
# A list of tags. For more information, see [Tagging Amazon RDS
- # Resources][1].
+ # Resources][1] in the *Amazon RDS User Guide.*
#
#
#
# [1]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html
#
@@ -3834,11 +3840,11 @@
#
# ^
#
# @option params [Array<Types::Tag>] :tags
# A list of tags. For more information, see [Tagging Amazon RDS
- # Resources][1].
+ # Resources][1] in the *Amazon RDS User Guide.*
#
#
#
# [1]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html
#
@@ -3934,11 +3940,11 @@
# @option params [required, Array<String>] :subnet_ids
# The EC2 Subnet IDs for the DB subnet group.
#
# @option params [Array<Types::Tag>] :tags
# A list of tags. For more information, see [Tagging Amazon RDS
- # Resources][1].
+ # Resources][1] in the *Amazon RDS User Guide.*
#
#
#
# [1]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html
#
@@ -4043,11 +4049,11 @@
# `db-security-group` \| `db-snapshot` \| `db-cluster-snapshot`
#
# @option params [Array<String>] :event_categories
# A list of event categories for a SourceType that you want to subscribe
# to. You can see a list of the categories for a given SourceType in the
- # [Events][1] topic in the Amazon RDS User Guide or by using the
+ # [Events][1] topic in the *Amazon RDS User Guide* or by using the
# **DescribeEventCategories** action.
#
#
#
# [1]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Events.html
@@ -4079,11 +4085,11 @@
# A Boolean value; set to **true** to activate the subscription, set to
# **false** to create the subscription but not active it.
#
# @option params [Array<Types::Tag>] :tags
# A list of tags. For more information, see [Tagging Amazon RDS
- # Resources][1].
+ # Resources][1] in the *Amazon RDS User Guide.*
#
#
#
# [1]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html
#
@@ -4182,11 +4188,11 @@
# @option params [required, String] :option_group_description
# The description of the option group.
#
# @option params [Array<Types::Tag>] :tags
# A list of tags. For more information, see [Tagging Amazon RDS
- # Resources][1].
+ # Resources][1] in the *Amazon RDS User Guide.*
#
#
#
# [1]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html
#
@@ -4274,16 +4280,16 @@
# DB cluster are deleted and can't be recovered. Manual DB cluster
# snapshots of the specified DB cluster are not deleted.
#
#
#
- # For more information on Amazon Aurora, see [Aurora on Amazon RDS][1]
- # in the *Amazon RDS User Guide.*
+ # For more information on Amazon Aurora, see the [ *Amazon Aurora User
+ # Guide* ][1].
#
#
#
- # [1]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Aurora.html
+ # [1]: http://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html
#
# @option params [required, String] :db_cluster_identifier
# The DB cluster identifier for the DB cluster to be deleted. This
# parameter isn't case-sensitive.
#
@@ -4424,16 +4430,16 @@
# Deletes a specified DB cluster parameter group. The DB cluster
# parameter group to be deleted can't be associated with any DB
# clusters.
#
- # For more information on Amazon Aurora, see [Aurora on Amazon RDS][1]
- # in the *Amazon RDS User Guide.*
+ # For more information on Amazon Aurora, see the [ *Amazon Aurora User
+ # Guide* ][1].
#
#
#
- # [1]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Aurora.html
+ # [1]: http://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html
#
# @option params [required, String] :db_cluster_parameter_group_name
# The name of the DB cluster parameter group.
#
# Constraints:
@@ -4476,16 +4482,16 @@
# <note markdown="1"> The DB cluster snapshot must be in the `available` state to be
# deleted.
#
# </note>
#
- # For more information on Amazon Aurora, see [Aurora on Amazon RDS][1]
- # in the *Amazon RDS User Guide.*
+ # For more information on Amazon Aurora, see the [ *Amazon Aurora User
+ # Guide* ][1].
#
#
#
- # [1]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Aurora.html
+ # [1]: http://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html
#
# @option params [required, String] :db_cluster_snapshot_identifier
# The identifier of the DB cluster snapshot to delete.
#
# Constraints: Must be the name of an existing DB cluster snapshot in
@@ -5204,16 +5210,16 @@
req.send_request(options)
end
# Returns information about backtracks for a DB cluster.
#
- # For more information on Amazon Aurora, see [Aurora on Amazon RDS][1]
- # in the *Amazon RDS User Guide.*
+ # For more information on Amazon Aurora, see the [ *Amazon Aurora User
+ # Guide* ][1].
#
#
#
- # [1]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Aurora.html
+ # [1]: http://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html
#
# @option params [required, String] :db_cluster_identifier
# The DB cluster identifier of the DB cluster to be described. This
# parameter is stored as a lowercase string.
#
@@ -5327,16 +5333,16 @@
# Returns a list of `DBClusterParameterGroup` descriptions. If a
# `DBClusterParameterGroupName` parameter is specified, the list will
# contain only the description of the specified DB cluster parameter
# group.
#
- # For more information on Amazon Aurora, see [Aurora on Amazon RDS][1]
- # in the *Amazon RDS User Guide.*
+ # For more information on Amazon Aurora, see the [ *Amazon Aurora User
+ # Guide* ][1].
#
#
#
- # [1]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Aurora.html
+ # [1]: http://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html
#
# @option params [String] :db_cluster_parameter_group_name
# The name of a specific DB cluster parameter group to return details
# for.
#
@@ -5417,16 +5423,16 @@
end
# Returns the detailed parameter list for a particular DB cluster
# parameter group.
#
- # For more information on Amazon Aurora, see [Aurora on Amazon RDS][1]
- # in the *Amazon RDS User Guide.*
+ # For more information on Amazon Aurora, see the [ *Amazon Aurora User
+ # Guide* ][1].
#
#
#
- # [1]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Aurora.html
+ # [1]: http://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html
#
# @option params [required, String] :db_cluster_parameter_group_name
# The name of a specific DB cluster parameter group to return parameter
# details for.
#
@@ -5581,16 +5587,16 @@
end
# Returns information about DB cluster snapshots. This API action
# supports pagination.
#
- # For more information on Amazon Aurora, see [Aurora on Amazon RDS][1]
- # in the *Amazon RDS User Guide.*
+ # For more information on Amazon Aurora, see the [ *Amazon Aurora User
+ # Guide* ][1].
#
#
#
- # [1]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Aurora.html
+ # [1]: http://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html
#
# @option params [String] :db_cluster_identifier
# The ID of the DB cluster to retrieve the list of DB cluster snapshots
# for. This parameter can't be used in conjunction with the
# `DBClusterSnapshotIdentifier` parameter. This parameter is not
@@ -5752,16 +5758,16 @@
end
# Returns information about provisioned Aurora DB clusters. This API
# supports pagination.
#
- # For more information on Amazon Aurora, see [Aurora on Amazon RDS][1]
- # in the *Amazon RDS User Guide.*
+ # For more information on Amazon Aurora, see the [ *Amazon Aurora User
+ # Guide* ][1].
#
#
#
- # [1]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Aurora.html
+ # [1]: http://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html
#
# @option params [String] :db_cluster_identifier
# The user-supplied DB cluster identifier. If this parameter is
# specified, information from only the specific DB cluster is returned.
# This parameter isn't case-sensitive.
@@ -6908,16 +6914,16 @@
end
# Returns the default engine and system parameter information for the
# cluster database engine.
#
- # For more information on Amazon Aurora, see [Aurora on Amazon RDS][1]
- # in the *Amazon RDS User Guide.*
+ # For more information on Amazon Aurora, see the [ *Amazon Aurora User
+ # Guide* ][1].
#
#
#
- # [1]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Aurora.html
+ # [1]: http://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html
#
# @option params [required, String] :db_parameter_group_family
# The name of the DB cluster parameter group family to return engine
# parameter information for.
#
@@ -8343,16 +8349,16 @@
# when you want to simulate a failure of a primary instance for testing.
# Because each instance in a DB cluster has its own endpoint address,
# you will need to clean up and re-establish any existing connections
# that use those endpoint addresses when the failover is complete.
#
- # For more information on Amazon Aurora, see [Aurora on Amazon RDS][1]
- # in the *Amazon RDS User Guide.*
+ # For more information on Amazon Aurora, see the [ *Amazon Aurora User
+ # Guide* ][1].
#
#
#
- # [1]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Aurora.html
+ # [1]: http://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html
#
# @option params [String] :db_cluster_identifier
# A DB cluster identifier to force a failover for. This parameter is not
# case-sensitive.
#
@@ -8467,20 +8473,21 @@
end
# Lists all tags on an Amazon RDS resource.
#
# For an overview on tagging an Amazon RDS resource, see [Tagging Amazon
- # RDS Resources][1].
+ # RDS Resources][1] in the *Amazon RDS User Guide*.
#
#
#
# [1]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Overview.Tagging.html
#
# @option params [required, String] :resource_name
# The Amazon RDS resource with tags to be listed. This value is an
# Amazon Resource Name (ARN). For information about creating an ARN, see
- # [ Constructing an RDS Amazon Resource Name (ARN)][1].
+ # [ Constructing an ARN for Amazon RDS][1] in the *Amazon RDS User
+ # Guide*.
#
#
#
# [1]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.ARN.html#USER_Tagging.ARN.Constructing
#
@@ -8543,22 +8550,22 @@
# After this call sets the DB cluster capacity, Aurora Serverless can
# automatically scale the DB cluster based on the cooldown period for
# scaling up and the cooldown period for scaling down.
#
# For more information about Aurora Serverless, see [Using Amazon Aurora
- # Serverless][1] in the *Amazon RDS User Guide*.
+ # Serverless][1] in the *Amazon Aurora User Guide*.
#
# If you call `ModifyCurrentDBClusterCapacity` with the default
# `TimeoutAction`, connections that prevent Aurora Serverless from
# finding a scaling point might be dropped. For more information about
# scaling points, see [ Autoscaling for Aurora Serverless][2] in the
- # *Amazon RDS User Guide*.
+ # *Amazon Aurora User Guide*.
#
#
#
- # [1]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/aurora-serverless.html
- # [2]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/aurora-serverless.how-it-works.html#aurora-serverless.how-it-works.auto-scaling
+ # [1]: http://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless.html
+ # [2]: http://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless.how-it-works.html#aurora-serverless.how-it-works.auto-scaling
#
# @option params [required, String] :db_cluster_identifier
# The DB cluster identifier for the cluster being modified. This
# parameter is not case-sensitive.
#
@@ -8631,16 +8638,15 @@
end
# Modify a setting for an Amazon Aurora DB cluster. You can change one
# or more database configuration parameters by specifying these
# parameters and the new values in the request. For more information on
- # Amazon Aurora, see [Aurora on Amazon RDS][1] in the *Amazon RDS User
- # Guide.*
+ # Amazon Aurora, see the [ *Amazon Aurora User Guide* ][1].
#
#
#
- # [1]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Aurora.html
+ # [1]: http://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html
#
# @option params [required, String] :db_cluster_identifier
# The DB cluster identifier for the cluster being modified. This
# parameter is not case-sensitive.
#
@@ -8670,16 +8676,17 @@
# possible, regardless of the `PreferredMaintenanceWindow` setting for
# the DB cluster. If this parameter is set to `false`, changes to the DB
# cluster are applied during the next maintenance window.
#
# The `ApplyImmediately` parameter only affects the
- # `NewDBClusterIdentifier` and `MasterUserPassword` values. If you set
- # the `ApplyImmediately` parameter value to false, then changes to the
- # `NewDBClusterIdentifier` and `MasterUserPassword` values are applied
- # during the next maintenance window. All other changes are applied
- # immediately, regardless of the value of the `ApplyImmediately`
- # parameter.
+ # `EnableIAMDatabaseAuthentication`, `MasterUserPassword`, and
+ # `NewDBClusterIdentifier` values. If you set the `ApplyImmediately`
+ # parameter value to false, then changes to the
+ # `EnableIAMDatabaseAuthentication`, `MasterUserPassword`, and
+ # `NewDBClusterIdentifier` values are applied during the next
+ # maintenance window. All other changes are applied immediately,
+ # regardless of the value of the `ApplyImmediately` parameter.
#
# Default: `false`
#
# @option params [Integer] :backup_retention_period
# The number of days for which automated backups are retained. You must
@@ -8731,12 +8738,12 @@
# automated backups are enabled, using the `BackupRetentionPeriod`
# parameter.
#
# The default is a 30-minute window selected at random from an 8-hour
# block of time for each AWS Region. To see the time blocks available,
- # see [ Adjusting the Preferred Maintenance Window][1] in the *Amazon
- # RDS User Guide.*
+ # see [ Adjusting the Preferred DB Cluster Maintenance Window][1] in the
+ # *Amazon Aurora User Guide.*
#
# Constraints:
#
# * Must be in the format `hh24:mi-hh24:mi`.
#
@@ -8746,30 +8753,30 @@
#
# * Must be at least 30 minutes.
#
#
#
- # [1]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/AdjustingTheMaintenanceWindow.html
+ # [1]: http://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_UpgradeDBInstance.Maintenance.html#AdjustingTheMaintenanceWindow.Aurora
#
# @option params [String] :preferred_maintenance_window
# The weekly time range during which system maintenance can occur, in
# Universal Coordinated Time (UTC).
#
# Format: `ddd:hh24:mi-ddd:hh24:mi`
#
# The default is a 30-minute window selected at random from an 8-hour
# block of time for each AWS Region, occurring on a random day of the
# week. To see the time blocks available, see [ Adjusting the Preferred
- # Maintenance Window][1] in the *Amazon RDS User Guide.*
+ # DB Cluster Maintenance Window][1] in the *Amazon Aurora User Guide.*
#
# Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.
#
# Constraints: Minimum 30-minute window.
#
#
#
- # [1]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/AdjustingTheMaintenanceWindow.html
+ # [1]: http://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_UpgradeDBInstance.Maintenance.html#AdjustingTheMaintenanceWindow.Aurora
#
# @option params [Boolean] :enable_iam_database_authentication
# True to enable mapping of AWS Identity and Access Management (IAM)
# accounts to database accounts, and otherwise false.
#
@@ -8932,12 +8939,12 @@
# Modifies the parameters of a DB cluster parameter group. To modify
# more than one parameter, submit a list of the following:
# `ParameterName`, `ParameterValue`, and `ApplyMethod`. A maximum of 20
# parameters can be modified in a single request.
#
- # For more information on Amazon Aurora, see [Aurora on Amazon RDS][1]
- # in the *Amazon RDS User Guide.*
+ # For more information on Amazon Aurora, see the [ *Amazon Aurora User
+ # Guide* ][1].
#
# <note markdown="1"> Changes to dynamic parameters are applied immediately. Changes to
# static parameters require a reboot without failover to the DB cluster
# associated with the parameter group before the change can take effect.
#
@@ -8955,11 +8962,11 @@
# the DescribeDBClusterParameters command to verify that your DB cluster
# parameter group has been created or modified.
#
#
#
- # [1]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Aurora.html
+ # [1]: http://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html
# [2]: https://console.aws.amazon.com/rds/
#
# @option params [required, String] :db_cluster_parameter_group_name
# The name of the DB cluster parameter group to modify.
#
@@ -9178,11 +9185,11 @@
# @option params [String] :db_subnet_group_name
# The new DB subnet group for the DB instance. You can use this
# parameter to move your DB instance to a different VPC. If your DB
# instance is not in a VPC, you can also use this parameter to move your
# DB instance into a VPC. For more information, see [Updating the VPC
- # for a DB Instance][1].
+ # for a DB Instance][1] in the *Amazon RDS User Guide.*
#
# Changing the subnet group causes an outage during the change. The
# change is applied during the next maintenance window, unless you
# specify `true` for the `ApplyImmediately` parameter.
#
@@ -9230,13 +9237,13 @@
# If this parameter is set to `false`, changes to the DB instance are
# applied during the next maintenance window. Some parameter changes can
# cause an outage and are applied on the next call to RebootDBInstance,
# or the next failure reboot. Review the table of parameters in
# [Modifying a DB Instance and Using the Apply Immediately Parameter][1]
- # to see the impact that setting `ApplyImmediately` to `true` or `false`
- # has for each modified parameter and to determine when the changes are
- # applied.
+ # in the *Amazon RDS User Guide.* to see the impact that setting
+ # `ApplyImmediately` to `true` or `false` has for each modified
+ # parameter and to determine when the changes are applied.
#
# Default: `false`
#
#
#
@@ -9607,11 +9614,11 @@
# @option params [String] :monitoring_role_arn
# The ARN for the IAM role that permits RDS to send enhanced monitoring
# metrics to Amazon CloudWatch Logs. For example,
# `arn:aws:iam:123456789012:role/emaccess`. For information on creating
# a monitoring role, go to [To create an IAM role for Amazon RDS
- # Enhanced Monitoring][1].
+ # Enhanced Monitoring][1] in the *Amazon RDS User Guide.*
#
# If `MonitoringInterval` is set to a value other than 0, then you must
# supply a `MonitoringRoleArn` value.
#
#
@@ -9624,19 +9631,19 @@
#
# @option params [Integer] :promotion_tier
# A value that specifies the order in which an Aurora Replica is
# promoted to the primary instance after a failure of the existing
# primary instance. For more information, see [ Fault Tolerance for an
- # Aurora DB Cluster][1].
+ # Aurora DB Cluster][1] in the *Amazon Aurora User Guide*.
#
# Default: 1
#
# Valid Values: 0 - 15
#
#
#
- # [1]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Aurora.Managing.html#Aurora.Managing.FaultTolerance
+ # [1]: http://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Managing.Backups.html#Aurora.Managing.FaultTolerance
#
# @option params [Boolean] :enable_iam_database_authentication
# True to enable mapping of AWS Identity and Access Management (IAM)
# accounts to database accounts, and otherwise false.
#
@@ -10024,11 +10031,11 @@
# The option group to identify with the upgraded DB snapshot.
#
# You can specify this parameter when you upgrade an Oracle DB snapshot.
# The same option group considerations apply when upgrading a DB
# snapshot as when upgrading a DB instance. For more information, see
- # [Option Group Considerations][1].
+ # [Option Group Considerations][1] in the *Amazon RDS User Guide.*
#
#
#
# [1]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_UpgradeDBInstance.Oracle.html#USER_UpgradeDBInstance.Oracle.OGPG.OG
#
@@ -10258,11 +10265,11 @@
# source identifiers for a subscription, use the
# AddSourceIdentifierToSubscription and
# RemoveSourceIdentifierFromSubscription calls.
#
# You can see a list of the event categories for a given SourceType in
- # the [Events][1] topic in the Amazon RDS User Guide or by using the
+ # the [Events][1] topic in the *Amazon RDS User Guide* or by using the
# **DescribeEventCategories** action.
#
#
#
# [1]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Events.html
@@ -10285,11 +10292,11 @@
# \| db-snapshot
#
# @option params [Array<String>] :event_categories
# A list of event categories for a SourceType that you want to subscribe
# to. You can see a list of the categories for a given SourceType in the
- # [Events][1] topic in the Amazon RDS User Guide or by using the
+ # [Events][1] topic in the *Amazon RDS User Guide* or by using the
# **DescribeEventCategories** action.
#
#
#
# [1]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Events.html
@@ -10800,11 +10807,11 @@
#
# Default: `1`
#
# @option params [Array<Types::Tag>] :tags
# A list of tags. For more information, see [Tagging Amazon RDS
- # Resources][1].
+ # Resources][1] in the *Amazon RDS User Guide.*
#
#
#
# [1]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html
#
@@ -10878,12 +10885,12 @@
#
# Rebooting a DB instance restarts the database engine service.
# Rebooting a DB instance results in a momentary outage, during which
# the DB instance status is set to rebooting.
#
- # For more information about rebooting, see [Rebooting a DB
- # Instance][1].
+ # For more information about rebooting, see [Rebooting a DB Instance][1]
+ # in the *Amazon RDS User Guide.*
#
#
#
# [1]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_RebootInstance.html
#
@@ -11046,15 +11053,16 @@
req.send_request(options)
end
# Disassociates an Identity and Access Management (IAM) role from an
# Aurora DB cluster. For more information, see [Authorizing Amazon
- # Aurora to Access Other AWS Services On Your Behalf][1].
+ # Aurora MySQL to Access Other AWS Services on Your Behalf ][1] in the
+ # *Amazon Aurora User Guide*.
#
#
#
- # [1]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Aurora.Authorizing.AWSServices.html
+ # [1]: http://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraMySQL.Integrating.Authorizing.html
#
# @option params [required, String] :db_cluster_identifier
# The name of the DB cluster to disassociate the IAM role from.
#
# @option params [required, String] :role_arn
@@ -11144,20 +11152,21 @@
end
# Removes metadata tags from an Amazon RDS resource.
#
# For an overview on tagging an Amazon RDS resource, see [Tagging Amazon
- # RDS Resources][1].
+ # RDS Resources][1] in the *Amazon RDS User Guide.*
#
#
#
# [1]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Overview.Tagging.html
#
# @option params [required, String] :resource_name
# The Amazon RDS resource that the tags are removed from. This value is
# an Amazon Resource Name (ARN). For information about creating an ARN,
- # see [ Constructing an RDS Amazon Resource Name (ARN)][1].
+ # see [ Constructing an ARN for Amazon RDS][1] in the *Amazon RDS User
+ # Guide.*
#
#
#
# [1]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.ARN.html#USER_Tagging.ARN.Constructing
#
@@ -11204,16 +11213,16 @@
# immediately and static parameters are set to `pending-reboot` to take
# effect on the next DB instance restart or RebootDBInstance request.
# You must call RebootDBInstance for every DB instance in your DB
# cluster that you want the updated static parameter to apply to.
#
- # For more information on Amazon Aurora, see [Aurora on Amazon RDS][1]
- # in the *Amazon RDS User Guide.*
+ # For more information on Amazon Aurora, see the [ *Amazon Aurora User
+ # Guide* ][1].
#
#
#
- # [1]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Aurora.html
+ # [1]: http://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html
#
# @option params [required, String] :db_cluster_parameter_group_name
# The name of the DB cluster parameter group to reset.
#
# @option params [Boolean] :reset_all_parameters
@@ -11385,16 +11394,16 @@
end
# Creates an Amazon Aurora DB cluster from data stored in an Amazon S3
# bucket. Amazon RDS must be authorized to access the Amazon S3 bucket
# and the data must be created using the Percona XtraBackup utility as
- # described in [Migrating Data from MySQL by Using an Amazon S3
- # Bucket][1].
+ # described in [ Migrating Data to an Amazon Aurora MySQL DB Cluster][1]
+ # in the *Amazon Aurora User Guide*.
#
#
#
- # [1]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Aurora.Migrate.MySQL.html#Aurora.Migrate.MySQL.S3
+ # [1]: http://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraMySQL.Migrating.html
#
# @option params [Array<String>] :availability_zones
# A list of EC2 Availability Zones that instances in the restored DB
# cluster can be created in.
#
@@ -11509,11 +11518,11 @@
# parameter.
#
# The default is a 30-minute window selected at random from an 8-hour
# block of time for each AWS Region. To see the time blocks available,
# see [ Adjusting the Preferred Maintenance Window][1] in the *Amazon
- # RDS User Guide.*
+ # Aurora User Guide.*
#
# Constraints:
#
# * Must be in the format `hh24:mi-hh24:mi`.
#
@@ -11523,34 +11532,34 @@
#
# * Must be at least 30 minutes.
#
#
#
- # [1]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/AdjustingTheMaintenanceWindow.html
+ # [1]: http://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_UpgradeDBInstance.Maintenance.html#AdjustingTheMaintenanceWindow.Aurora
#
# @option params [String] :preferred_maintenance_window
# The weekly time range during which system maintenance can occur, in
# Universal Coordinated Time (UTC).
#
# Format: `ddd:hh24:mi-ddd:hh24:mi`
#
# The default is a 30-minute window selected at random from an 8-hour
# block of time for each AWS Region, occurring on a random day of the
# week. To see the time blocks available, see [ Adjusting the Preferred
- # Maintenance Window][1] in the *Amazon RDS User Guide.*
+ # Maintenance Window][1] in the *Amazon Aurora User Guide.*
#
# Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.
#
# Constraints: Minimum 30-minute window.
#
#
#
- # [1]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/AdjustingTheMaintenanceWindow.html
+ # [1]: http://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_UpgradeDBInstance.Maintenance.html#AdjustingTheMaintenanceWindow.Aurora
#
# @option params [Array<Types::Tag>] :tags
# A list of tags. For more information, see [Tagging Amazon RDS
- # Resources][1].
+ # Resources][1] in the *Amazon RDS User Guide.*
#
#
#
# [1]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html
#
@@ -11621,16 +11630,15 @@
#
# @option params [Array<String>] :enable_cloudwatch_logs_exports
# The list of logs that the restored DB cluster is to export to
# CloudWatch Logs. The values in the list depend on the DB engine being
# used. For more information, see [Publishing Database Logs to Amazon
- # CloudWatch Logs ][1] in the *Amazon Relational Database Service User
- # Guide*.
+ # CloudWatch Logs][1] in the *Amazon Aurora User Guide*.
#
#
#
- # [1]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch
+ # [1]: http://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch
#
# @return [Types::RestoreDBClusterFromS3Result] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::RestoreDBClusterFromS3Result#db_cluster #db_cluster} => Types::DBCluster
#
@@ -11751,16 +11759,16 @@
# If a DB cluster snapshot is specified, the target DB cluster is
# created from the source DB cluster restore point with the same
# configuration as the original source DB cluster, except that the new
# DB cluster is created with the default security group.
#
- # For more information on Amazon Aurora, see [Aurora on Amazon RDS][1]
- # in the *Amazon RDS User Guide.*
+ # For more information on Amazon Aurora, see the [ *Amazon Aurora User
+ # Guide* ][1].
#
#
#
- # [1]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Aurora.html
+ # [1]: http://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html
#
# @option params [Array<String>] :availability_zones
# Provides the list of EC2 Availability Zones that instances in the
# restored DB cluster can be created in.
#
@@ -11870,16 +11878,15 @@
#
# @option params [Array<String>] :enable_cloudwatch_logs_exports
# The list of logs that the restored DB cluster is to export to
# CloudWatch Logs. The values in the list depend on the DB engine being
# used. For more information, see [Publishing Database Logs to Amazon
- # CloudWatch Logs ][1] in the *Amazon Relational Database Service User
- # Guide*.
+ # CloudWatch Logs ][1] in the *Amazon Aurora User Guide*.
#
#
#
- # [1]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch
+ # [1]: http://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch
#
# @option params [String] :engine_mode
# The DB engine mode of the DB cluster, either `provisioned` or
# `serverless`.
#
@@ -12025,16 +12032,16 @@
# instances only after the `RestoreDBClusterToPointInTime` action has
# completed and the DB cluster is available.
#
# </note>
#
- # For more information on Amazon Aurora, see [Aurora on Amazon RDS][1]
- # in the *Amazon RDS User Guide.*
+ # For more information on Amazon Aurora, see the [ *Amazon Aurora User
+ # Guide* ][1].
#
#
#
- # [1]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Aurora.html
+ # [1]: http://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html
#
# @option params [required, String] :db_cluster_identifier
# The name of the new DB cluster to be created.
#
# Constraints:
@@ -12119,11 +12126,11 @@
# @option params [Array<String>] :vpc_security_group_ids
# A list of VPC security groups that the new DB cluster belongs to.
#
# @option params [Array<Types::Tag>] :tags
# A list of tags. For more information, see [Tagging Amazon RDS
- # Resources][1].
+ # Resources][1] in the *Amazon RDS User Guide.*
#
#
#
# [1]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html
#
@@ -12176,16 +12183,15 @@
#
# @option params [Array<String>] :enable_cloudwatch_logs_exports
# The list of logs that the restored DB cluster is to export to
# CloudWatch Logs. The values in the list depend on the DB engine being
# used. For more information, see [Publishing Database Logs to Amazon
- # CloudWatch Logs ][1] in the *Amazon Relational Database Service User
- # Guide*.
+ # CloudWatch Logs][1] in the *Amazon Aurora User Guide*.
#
#
#
- # [1]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch
+ # [1]: http://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch
#
# @return [Types::RestoreDBClusterToPointInTimeResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::RestoreDBClusterToPointInTimeResult#db_cluster #db_cluster} => Types::DBCluster
#
@@ -12464,11 +12470,12 @@
# The conversion takes additional time, though your DB instance is
# available for connections before the conversion starts.
#
# The provisioned IOPS value must follow the requirements for your
# database engine. For more information, see [Amazon RDS Provisioned
- # IOPS Storage to Improve Performance][1].
+ # IOPS Storage to Improve Performance][1] in the *Amazon RDS User
+ # Guide.*
#
# Constraints: Must be an integer greater than 1000.
#
#
#
@@ -12482,11 +12489,11 @@
# can't be removed from a DB instance once it is associated with a DB
# instance
#
# @option params [Array<Types::Tag>] :tags
# A list of tags. For more information, see [Tagging Amazon RDS
- # Resources][1].
+ # Resources][1] in the *Amazon RDS User Guide.*
#
#
#
# [1]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html
#
@@ -12535,16 +12542,15 @@
#
# @option params [Array<String>] :enable_cloudwatch_logs_exports
# The list of logs that the restored DB instance is to export to
# CloudWatch Logs. The values in the list depend on the DB engine being
# used. For more information, see [Publishing Database Logs to Amazon
- # CloudWatch Logs ][1] in the *Amazon Relational Database Service User
- # Guide*.
+ # CloudWatch Logs][1] in the *Amazon Aurora User Guide*.
#
#
#
- # [1]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch
+ # [1]: http://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch
#
# @option params [Array<Types::ProcessorFeature>] :processor_features
# The number of CPU cores and the number of threads per core for the DB
# instance class of the DB instance.
#
@@ -12810,11 +12816,11 @@
# Amazon Relational Database Service (Amazon RDS) supports importing
# MySQL databases by using backup files. You can create a backup of your
# on-premises database, store it on Amazon Simple Storage Service
# (Amazon S3), and then restore the backup file onto a new Amazon RDS DB
# instance running MySQL. For more information, see [Importing Data into
- # an Amazon RDS MySQL DB Instance][1].
+ # an Amazon RDS MySQL DB Instance][1] in the *Amazon RDS User Guide.*
#
#
#
# [1]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/MySQL.Procedural.Importing.html
#
@@ -12891,11 +12897,11 @@
# A list of VPC security groups to associate with this DB instance.
#
# @option params [String] :availability_zone
# The Availability Zone that the DB instance is created in. For
# information about AWS Regions and Availability Zones, see [Regions and
- # Availability Zones][1].
+ # Availability Zones][1] in the *Amazon RDS User Guide.*
#
# Default: A random, system-chosen Availability Zone in the endpoint's
# AWS Region.
#
# Example: `us-east-1d`
@@ -12912,11 +12918,11 @@
# A DB subnet group to associate with this DB instance.
#
# @option params [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
- # RDS Maintenance Window][1].
+ # RDS Maintenance Window][1] in the *Amazon RDS User Guide.*
#
# Constraints:
#
# * Must be in the format `ddd:hh24:mi-ddd:hh24:mi`.
#
@@ -12943,11 +12949,11 @@
# information, see CreateDBInstance.
#
# @option params [String] :preferred_backup_window
# The time range each day during which automated backups are created if
# automated backups are enabled. For more information, see [The Backup
- # Window][1].
+ # Window][1] in the *Amazon RDS User Guide.*
#
# Constraints:
#
# * Must be in the format `hh24:mi-hh24:mi`.
#
@@ -12990,11 +12996,11 @@
#
# @option params [Integer] :iops
# The amount of Provisioned IOPS (input/output operations per second) to
# allocate initially for the DB instance. For information about valid
# Iops values, see see [Amazon RDS Provisioned IOPS Storage to Improve
- # Performance][1].
+ # Performance][1] in the *Amazon RDS User Guide.*
#
#
#
# [1]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Storage.html#USER_PIOPS
#
@@ -13010,11 +13016,12 @@
# specifies an internal instance with a DNS name that resolves to a
# private IP address. For more information, see CreateDBInstance.
#
# @option params [Array<Types::Tag>] :tags
# A list of tags to associate with this DB instance. For more
- # information, see [Tagging Amazon RDS Resources][1].
+ # information, see [Tagging Amazon RDS Resources][1] in the *Amazon RDS
+ # User Guide.*
#
#
#
# [1]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html
#
@@ -13068,11 +13075,11 @@
# @option params [String] :monitoring_role_arn
# The ARN for the IAM role that permits RDS to send enhanced monitoring
# metrics to Amazon CloudWatch Logs. For example,
# `arn:aws:iam:123456789012:role/emaccess`. For information on creating
# a monitoring role, see [Setting Up and Enabling Enhanced
- # Monitoring][1].
+ # Monitoring][1] in the *Amazon RDS User Guide.*
#
# If `MonitoringInterval` is set to a value other than 0, then you must
# supply a `MonitoringRoleArn` value.
#
#
@@ -13128,12 +13135,11 @@
#
# @option params [Array<String>] :enable_cloudwatch_logs_exports
# The list of logs that the restored DB instance is to export to
# CloudWatch Logs. The values in the list depend on the DB engine being
# used. For more information, see [Publishing Database Logs to Amazon
- # CloudWatch Logs ][1] in the *Amazon Relational Database Service User
- # Guide*.
+ # CloudWatch Logs][1] in the *Amazon RDS User Guide*.
#
#
#
# [1]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch
#
@@ -13507,11 +13513,11 @@
# True to copy all tags from the restored DB instance to snapshots of
# the DB instance, and otherwise false. The default is false.
#
# @option params [Array<Types::Tag>] :tags
# A list of tags. For more information, see [Tagging Amazon RDS
- # Resources][1].
+ # Resources][1] in the *Amazon RDS User Guide.*
#
#
#
# [1]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html
#
@@ -13556,12 +13562,11 @@
#
# @option params [Array<String>] :enable_cloudwatch_logs_exports
# The list of logs that the restored DB instance is to export to
# CloudWatch Logs. The values in the list depend on the DB engine being
# used. For more information, see [Publishing Database Logs to Amazon
- # CloudWatch Logs ][1] in the *Amazon Relational Database Service User
- # Guide*.
+ # CloudWatch Logs][1] in the *Amazon RDS User Guide*.
#
#
#
# [1]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch
#
@@ -14214,10 +14219,10 @@
operation: config.api.operation(operation_name),
client: self,
params: params,
config: config)
context[:gem_name] = 'aws-sdk-rds'
- context[:gem_version] = '1.26.0'
+ context[:gem_version] = '1.27.0'
Seahorse::Client::Request.new(handlers, context)
end
# Polls an API operation until a resource enters a desired state.
#