lib/aws-sdk-rds/client.rb in aws-sdk-rds-1.172.0 vs lib/aws-sdk-rds/client.rb in aws-sdk-rds-1.173.0
- old
+ new
@@ -2129,26 +2129,33 @@
req.send_request(options)
end
# Creates a new Amazon Aurora DB cluster or Multi-AZ DB cluster.
#
+ # If you create an Aurora DB cluster, the request creates an empty
+ # cluster. You must explicitly create the writer instance for your DB
+ # cluster using the [CreateDBInstance][1] operation. If you create a
+ # Multi-AZ DB cluster, the request creates a writer and two reader DB
+ # instances for you, each in a different Availability Zone.
+ #
# You can use the `ReplicationSourceIdentifier` parameter to create an
# Amazon Aurora DB cluster as a read replica of another DB cluster or
# Amazon RDS MySQL or PostgreSQL DB instance. For more information about
- # Amazon Aurora, see [What is Amazon Aurora?][1] in the *Amazon Aurora
+ # Amazon Aurora, see [What is Amazon Aurora?][2] in the *Amazon Aurora
# User Guide*.
#
# You can also use the `ReplicationSourceIdentifier` parameter to create
# a Multi-AZ DB cluster read replica with an RDS for PostgreSQL DB
# instance as the source. For more information about Multi-AZ DB
- # clusters, see [Multi-AZ DB cluster deployments][2] in the *Amazon RDS
+ # clusters, see [Multi-AZ DB cluster deployments][3] in the *Amazon RDS
# User Guide*.
#
#
#
- # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html
- # [2]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html
+ # [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.
#
@@ -2238,15 +2245,12 @@
# @option params [required, String] :engine
# The name of the database engine to be used for this DB cluster.
#
# Valid Values:
#
- # * `aurora` (for MySQL 5.6-compatible Aurora)
+ # * `aurora-mysql`
#
- # * `aurora-mysql` (for MySQL 5.7-compatible and MySQL 8.0-compatible
- # Aurora)
- #
# * `aurora-postgresql`
#
# * `mysql`
#
# * `postgres`
@@ -2254,22 +2258,20 @@
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
#
# @option params [String] :engine_version
# The version number of the database engine to use.
#
- # To list all of the available engine versions for MySQL 5.6-compatible
- # Aurora, use the following command:
+ # 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
+ # following command:
#
- # `aws rds describe-db-engine-versions --engine aurora --query
- # "DBEngineVersions[].EngineVersion"`
- #
- # To list all of the available engine versions for MySQL 5.7-compatible
- # and MySQL 8.0-compatible Aurora, use the following command:
- #
# `aws rds describe-db-engine-versions --engine aurora-mysql --query
# "DBEngineVersions[].EngineVersion"`
#
+ # You can supply either `5.7` or `8.0` to use the default engine version
+ # for Aurora MySQL version 2 or version 3, respectively.
+ #
# To list all of the available engine versions for Aurora PostgreSQL,
# use the following command:
#
# `aws rds describe-db-engine-versions --engine aurora-postgresql
# --query "DBEngineVersions[].EngineVersion"`
@@ -2286,27 +2288,27 @@
# `aws rds describe-db-engine-versions --engine postgres --query
# "DBEngineVersions[].EngineVersion"`
#
# **Aurora MySQL**
#
- # For information, see [MySQL on Amazon RDS Versions][1] in the *Amazon
- # Aurora User Guide*.
+ # For information, see [Database engine updates for Amazon Aurora
+ # MySQL][1] in the *Amazon Aurora User Guide*.
#
# **Aurora PostgreSQL**
#
# For information, see [Amazon Aurora PostgreSQL releases and engine
# versions][2] in the *Amazon Aurora User Guide*.
#
# **MySQL**
#
- # For information, see [MySQL on Amazon RDS Versions][3] in the *Amazon
- # RDS User Guide*.
+ # For information, see [Amazon RDS for MySQL][3] in the *Amazon RDS User
+ # Guide*.
#
# **PostgreSQL**
#
- # For information, see [Amazon RDS for PostgreSQL versions and
- # extensions][4] in the *Amazon RDS User Guide*.
+ # For information, see [Amazon RDS for PostgreSQL][4] in the *Amazon RDS
+ # User Guide*.
#
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
#
#
#
@@ -2437,11 +2439,11 @@
# The Amazon Web Services KMS key identifier is the key ARN, key ID,
# alias ARN, or alias name for the KMS key. To use a KMS key in a
# different Amazon Web Services account, specify the key ARN or alias
# ARN.
#
- # When a KMS key isn't specified in `KmsKeyId`\:
+ # When a KMS key isn't specified in `KmsKeyId`:
#
# * If `ReplicationSourceIdentifier` identifies an encrypted source,
# then Amazon RDS will use the KMS key used to encrypt the source.
# Otherwise, Amazon RDS will use your default KMS key.
#
@@ -2577,54 +2579,36 @@
#
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch
# [2]: https://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`,
- # `serverless`, `parallelquery`, `global`, or `multimaster`.
+ # The DB engine mode of the DB cluster, either `provisioned` or
+ # `serverless`.
#
- # The `parallelquery` engine mode isn't required for Aurora MySQL
- # version 1.23 and higher 1.x versions, and version 2.09 and higher 2.x
- # versions.
- #
- # The `global` engine mode isn't required for Aurora MySQL version 1.22
- # and higher 1.x versions, and `global` engine mode isn't required for
- # any 2.x versions.
- #
- # The `multimaster` engine mode only applies for DB clusters created
- # with Aurora MySQL version 5.6.10a.
- #
# The `serverless` engine mode only applies for Aurora Serverless v1 DB
# clusters.
#
- # For Aurora PostgreSQL, the `global` engine mode isn't required, and
- # both the `parallelquery` and the `multimaster` engine modes currently
- # aren't supported.
- #
# Limitations and requirements apply to some DB engine modes. For more
# information, see the following sections in the *Amazon Aurora User
- # Guide*\:
+ # Guide*:
#
# * [Limitations of Aurora Serverless v1][1]
#
# * [Requirements for Aurora Serverless v2][2]
#
- # * [Limitations of Parallel Query][3]
+ # * [Limitations of parallel query][3]
#
- # * [Limitations of Aurora Global Databases][4]
+ # * [Limitations of Aurora global databases][4]
#
- # * [Limitations of Multi-Master Clusters][5]
- #
# Valid for: Aurora DB clusters only
#
#
#
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless.html#aurora-serverless.limitations
# [2]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless-v2.requirements.html
# [3]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-mysql-parallel-query.html#aurora-mysql-parallel-query-limitations
# [4]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-global-database.html#aurora-global-database.limitations
- # [5]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-multi-master.html#aurora-multi-master-limitations
#
# @option params [Types::ScalingConfiguration] :scaling_configuration
# For DB clusters in `serverless` DB engine mode, the scaling properties
# of the DB cluster.
#
@@ -2747,12 +2731,12 @@
# @option params [Integer] :iops
# The amount of Provisioned IOPS (input/output operations per second) to
# be initially allocated for each DB instance in the Multi-AZ DB
# cluster.
#
- # For information about valid IOPS values, see [Amazon RDS Provisioned
- # IOPS storage][1] in the *Amazon RDS User Guide*.
+ # For information about valid IOPS values, see [Provisioned IOPS
+ # storage][1] in the *Amazon RDS User Guide*.
#
# This setting is required to create a Multi-AZ DB cluster.
#
# Constraints: Must be a multiple between .5 and 50 of the storage
# amount for the DB cluster.
@@ -9566,12 +9550,10 @@
# @option params [String] :engine
# The database engine to return.
#
# Valid Values:
#
- # * `aurora` (for MySQL 5.6-compatible Aurora)
- #
# * `aurora-mysql` (for MySQL 5.7-compatible and MySQL 8.0-compatible
# Aurora)
#
# * `aurora-postgresql`
#
@@ -12368,12 +12350,10 @@
# @option params [required, String] :engine
# The name of the engine to retrieve DB instance options for.
#
# Valid Values:
#
- # * `aurora` (for MySQL 5.6-compatible Aurora)
- #
# * `aurora-mysql` (for MySQL 5.7-compatible and MySQL 8.0-compatible
# Aurora)
#
# * `aurora-postgresql`
#
@@ -14197,19 +14177,14 @@
# The version number of the database engine to which you want to
# upgrade. Changing this parameter results in an outage. The change is
# applied during the next maintenance window unless `ApplyImmediately`
# is enabled.
#
- # To list all of the available engine versions for MySQL 5.6-compatible
- # Aurora, use the following command:
+ # 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
+ # following command:
#
- # `aws rds describe-db-engine-versions --engine aurora --query
- # "DBEngineVersions[].EngineVersion"`
- #
- # To list all of the available engine versions for MySQL 5.7-compatible
- # and MySQL 8.0-compatible Aurora, use the following command:
- #
# `aws rds describe-db-engine-versions --engine aurora-mysql --query
# "DBEngineVersions[].EngineVersion"`
#
# To list all of the available engine versions for Aurora PostgreSQL,
# use the following command:
@@ -18747,34 +18722,26 @@
# Example: `mydbsubnetgroup`
#
# @option params [required, String] :engine
# The name of the database engine to be used for this DB cluster.
#
- # Valid Values: `aurora` (for MySQL 5.6-compatible Aurora) and
- # `aurora-mysql` (for MySQL 5.7-compatible and MySQL 8.0-compatible
- # Aurora)
+ # Valid Values: `aurora-mysql` (for MySQL 5.7-compatible and MySQL
+ # 8.0-compatible Aurora)
#
# @option params [String] :engine_version
# The version number of the database engine to use.
#
- # To list all of the available engine versions for `aurora` (for MySQL
- # 5.6-compatible Aurora), use the following command:
+ # To list all of the available engine versions for `aurora-mysql` (MySQL
+ # 5.7-compatible and MySQL 8.0-compatible Aurora), use the following
+ # command:
#
- # `aws rds describe-db-engine-versions --engine aurora --query
- # "DBEngineVersions[].EngineVersion"`
- #
- # To list all of the available engine versions for `aurora-mysql` (for
- # MySQL 5.7-compatible and MySQL 8.0-compatible Aurora), use the
- # following command:
- #
# `aws rds describe-db-engine-versions --engine aurora-mysql --query
# "DBEngineVersions[].EngineVersion"`
#
# **Aurora MySQL**
#
- # Example: `5.6.10a`, `5.6.mysql_aurora.1.19.2`,
- # `5.7.mysql_aurora.2.07.1`, `8.0.mysql_aurora.3.02.0`
+ # Examples: `5.7.mysql_aurora.2.07.1`, `8.0.mysql_aurora.3.02.0`
#
# @option params [Integer] :port
# The port number on which the instances in the restored DB cluster
# accept connections.
#
@@ -18943,14 +18910,10 @@
#
# **Aurora MySQL**
#
# Possible values are `audit`, `error`, `general`, and `slowquery`.
#
- # **Aurora PostgreSQL**
- #
- # Possible value is `postgresql`.
- #
# For more information about exporting CloudWatch Logs for Amazon
# Aurora, see [Publishing Database Logs to Amazon CloudWatch Logs][1] in
# the *Amazon Aurora User Guide*.
#
#
@@ -19305,18 +19268,14 @@
# Constraint: Must be compatible with the engine of the source
#
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
#
# @option params [String] :engine_version
- # The version of the database engine to use for the new DB cluster.
+ # The version of the database engine to use for the new DB cluster. If
+ # you don't specify an engine version, the default version for the
+ # database engine in the Amazon Web Services Region is used.
#
- # To list all of the available engine versions for MySQL 5.6-compatible
- # Aurora, use the following command:
- #
- # `aws rds describe-db-engine-versions --engine aurora --query
- # "DBEngineVersions[].EngineVersion"`
- #
# To list all of the available engine versions for MySQL 5.7-compatible
# and MySQL 8.0-compatible Aurora, use the following command:
#
# `aws rds describe-db-engine-versions --engine aurora-mysql --query
# "DBEngineVersions[].EngineVersion"`
@@ -19339,21 +19298,21 @@
# `aws rds describe-db-engine-versions --engine postgres --query
# "DBEngineVersions[].EngineVersion"`
#
# **Aurora MySQL**
#
- # See [MySQL on Amazon RDS Versions][1] in the *Amazon Aurora User
- # Guide*.
+ # See [Database engine updates for Amazon Aurora MySQL][1] in the
+ # *Amazon Aurora User Guide*.
#
# **Aurora PostgreSQL**
#
# See [Amazon Aurora PostgreSQL releases and engine versions][2] in the
# *Amazon Aurora User Guide*.
#
# **MySQL**
#
- # See [MySQL on Amazon RDS Versions][3] in the *Amazon RDS User Guide.*
+ # See [Amazon RDS for MySQL][3] in the *Amazon RDS User Guide.*
#
# **PostgreSQL**
#
# See [Amazon RDS for PostgreSQL versions and extensions][4] in the
# *Amazon RDS User Guide.*
@@ -23403,12 +23362,12 @@
# cluster data to Amazon S3][3] in the *Amazon Aurora User Guide*.
#
#
#
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_ExportSnapshot.html
- # [2]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/aurora-export-snapshot.html
- # [3]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/export-cluster-data.html
+ # [2]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-export-snapshot.html
+ # [3]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/export-cluster-data.html
#
# @option params [required, String] :export_task_identifier
# A unique identifier for the export task. This ID isn't an identifier
# for the Amazon S3 bucket where the data is to be exported.
#
@@ -23422,10 +23381,32 @@
#
# @option params [required, String] :iam_role_arn
# The name of the IAM role to use for writing to the Amazon S3 bucket
# when exporting a snapshot or cluster.
#
+ # In the IAM policy attached to your IAM role, include the following
+ # required actions to allow the transfer of files from Amazon RDS or
+ # Amazon Aurora to an S3 bucket:
+ #
+ # * s3:PutObject*
+ #
+ # * s3:GetObject*
+ #
+ # * s3:ListBucket
+ #
+ # * s3:DeleteObject*
+ #
+ # * s3:GetBucketLocation
+ #
+ # In the policy, include the resources to identify the S3 bucket and
+ # objects in the bucket. The following list of resources shows the
+ # Amazon Resource Name (ARN) format for accessing S3:
+ #
+ # * `arn:aws:s3:::your-s3-bucket `
+ #
+ # * `arn:aws:s3:::your-s3-bucket/*`
+ #
# @option params [required, String] :kms_key_id
# The ID of the Amazon Web Services KMS key to use to encrypt the data
# exported to Amazon S3. The Amazon Web Services KMS key identifier is
# the key ARN, key ID, alias ARN, or alias name for the KMS key. The
# caller of this operation must be authorized to run the following
@@ -24271,10 +24252,10 @@
operation: config.api.operation(operation_name),
client: self,
params: params,
config: config)
context[:gem_name] = 'aws-sdk-rds'
- context[:gem_version] = '1.172.0'
+ context[:gem_version] = '1.173.0'
Seahorse::Client::Request.new(handlers, context)
end
# Polls an API operation until a resource enters a desired state.
#