aws-sdk-rds 1.128.0 → 1.132.0

data/lib/aws-sdk-rds/db_cluster_parameter_group.rb

@@ -217,6 +217,14 @@ module Aws::RDS
     #
     #   Example: `aurora-postgresql9.6`
     #
+    #   **RDS for MySQL**
+    #
+    #   Example: `mysql8.0`
+    #
+    #   **RDS for PostgreSQL**
+    #
+    #   Example: `postgres12`
+    #
     #   To list all of the available parameter group families for a DB engine,
     #   use the following command:
     #
@@ -241,6 +249,10 @@ module Aws::RDS
     #   * `aurora-mysql` (for MySQL 5.7-compatible Aurora)
     #
     #   * `aurora-postgresql`
+    #
+    #   * `mysql`
+    #
+    #   * `postgres`
     # @option options [required, String] :description
     #   The description for the DB cluster parameter group.
     # @option options [Array<Types::Tag>] :tags

data/lib/aws-sdk-rds/db_cluster_snapshot.rb

@@ -146,8 +146,7 @@ module Aws::RDS
     # identifier for the encrypted DB cluster snapshot.
     #
     # The Amazon Web Services KMS key identifier is the key ARN, key ID,
-    # alias ARN, or alias name for the Amazon Web Services KMS customer
-    # master key (CMK).
+    # alias ARN, or alias name for the KMS key.
     # @return [String]
     def kms_key_id
       data[:kms_key_id]
@@ -379,15 +378,13 @@ module Aws::RDS
     # @option options [String] :kms_key_id
     #   The Amazon Web Services KMS key identifier for an encrypted DB cluster
     #   snapshot. The Amazon Web Services KMS key identifier is the key ARN,
-    #   key ID, alias ARN, or alias name for the Amazon Web Services KMS
-    #   customer master key (CMK).
+    #   key ID, alias ARN, or alias name for the Amazon Web Services KMS key.
     #
     #   If you copy an encrypted DB cluster snapshot from your Amazon Web
     #   Services account, you can specify a value for `KmsKeyId` to encrypt
-    #   the copy with a new Amazon Web Services KMS CMK. If you don't specify
-    #   a value for `KmsKeyId`, then the copy of the DB cluster snapshot is
-    #   encrypted with the same Amazon Web Services KMS key as the source DB
-    #   cluster snapshot.
+    #   the copy with a new KMS key. If you don't specify a value for
+    #   `KmsKeyId`, then the copy of the DB cluster snapshot is encrypted with
+    #   the same KMS key as the source DB cluster snapshot.
     #
     #   If you copy an encrypted DB cluster snapshot that is shared from
     #   another Amazon Web Services account, then you must specify a value for
@@ -396,10 +393,10 @@ module Aws::RDS
     #   To copy an encrypted DB cluster snapshot to another Amazon Web
     #   Services Region, you must set `KmsKeyId` to the Amazon Web Services
     #   KMS key identifier you want to use to encrypt the copy of the DB
-    #   cluster snapshot in the destination Amazon Web Services Region. Amazon
-    #   Web Services KMS CMKs are specific to the Amazon Web Services Region
-    #   that they are created in, and you can't use CMKs from one Amazon Web
-    #   Services Region in another Amazon Web Services Region.
+    #   cluster snapshot in the destination Amazon Web Services Region. KMS
+    #   keys are specific to the Amazon Web Services Region that they are
+    #   created in, and you can't use KMS keys from one Amazon Web Services
+    #   Region in another Amazon Web Services Region.
     #
     #   If you copy an unencrypted DB cluster snapshot and specify a value for
     #   the `KmsKeyId` parameter, an error is returned.
@@ -418,12 +415,12 @@ module Aws::RDS
     #   snapshot to be copied. The pre-signed URL request must contain the
     #   following parameter values:
     #
-    #   * `KmsKeyId` - The Amazon Web Services KMS key identifier for the
-    #     customer master key (CMK) to use to encrypt the copy of the DB
-    #     cluster snapshot in the destination Amazon Web Services Region. This
-    #     is the same identifier for both the `CopyDBClusterSnapshot` action
-    #     that is called in the destination Amazon Web Services Region, and
-    #     the action contained in the pre-signed URL.
+    #   * `KmsKeyId` - The Amazon Web Services KMS key identifier for the KMS
+    #     key to use to encrypt the copy of the DB cluster snapshot in the
+    #     destination Amazon Web Services Region. This is the same identifier
+    #     for both the `CopyDBClusterSnapshot` action that is called in the
+    #     destination Amazon Web Services Region, and the action contained in
+    #     the pre-signed URL.
     #
     #   * `DestinationRegion` - The name of the Amazon Web Services Region
     #     that the DB cluster snapshot is to be created in.
@@ -533,11 +530,17 @@ module Aws::RDS
     #     copy_tags_to_snapshot: false,
     #     domain: "String",
     #     domain_iam_role_name: "String",
+    #     db_cluster_instance_class: "String",
+    #     storage_type: "String",
+    #     iops: 1,
+    #     publicly_accessible: false,
     #   })
     # @param [Hash] options ({})
     # @option options [Array<String>] :availability_zones
     #   Provides the list of Availability Zones (AZs) where instances in the
     #   restored DB cluster can be created.
+    #
+    #   Valid for: Aurora DB clusters only
     # @option options [required, String] :db_cluster_identifier
     #   The name of the DB cluster to create from the DB snapshot or DB
     #   cluster snapshot. This parameter isn't case-sensitive.
@@ -551,52 +554,84 @@ module Aws::RDS
     #   * Can't end with a hyphen or contain two consecutive hyphens
     #
     #   Example: `my-snapshot-id`
+    #
+    #   Valid for: Aurora DB clusters and Multi-AZ DB clusters
     # @option options [required, String] :engine
     #   The database engine to use for the new DB cluster.
     #
     #   Default: The same as source
     #
     #   Constraint: Must be compatible with the engine of the source
+    #
+    #   Valid for: Aurora DB clusters and Multi-AZ DB clusters
     # @option options [String] :engine_version
     #   The version of the database engine to use for the new DB cluster.
     #
-    #   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 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 `aurora-mysql` (for
-    #   MySQL 5.7-compatible Aurora), use the following command:
+    #   To list all of the available engine versions for MySQL 5.7-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`,
+    #   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"`
     #
-    #   <note markdown="1"> If you aren't using the default engine version, then you must specify
-    #   the engine version.
+    #   To list all of the available engine versions for RDS for MySQL, use
+    #   the following command:
     #
-    #    </note>
+    #   `aws rds describe-db-engine-versions --engine mysql --query
+    #   "DBEngineVersions[].EngineVersion"`
+    #
+    #   To list all of the available engine versions for RDS for PostgreSQL,
+    #   use the following command:
+    #
+    #   `aws rds describe-db-engine-versions --engine postgres --query
+    #   "DBEngineVersions[].EngineVersion"`
     #
     #   **Aurora MySQL**
     #
-    #   Example: `5.6.10a`, `5.6.mysql_aurora.1.19.2`, `5.7.12`,
-    #   `5.7.mysql_aurora.2.04.5`
+    #   See [MySQL on Amazon RDS Versions][1] in the *Amazon Aurora User
+    #   Guide.*
     #
     #   **Aurora PostgreSQL**
     #
-    #   Example: `9.6.3`, `10.7`
+    #   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.*
+    #
+    #   **PostgreSQL**
+    #
+    #   See [Amazon RDS for PostgreSQL versions and extensions][4] in the
+    #   *Amazon RDS User Guide.*
+    #
+    #   Valid for: Aurora DB clusters and Multi-AZ DB clusters
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraMySQL.Updates.html
+    #   [2]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraPostgreSQL.Updates.20180305.html
+    #   [3]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_MySQL.html#MySQL.Concepts.VersionMgmt
+    #   [4]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_PostgreSQL.html#PostgreSQL.Concepts
     # @option options [Integer] :port
     #   The port number on which the new DB cluster accepts connections.
     #
     #   Constraints: This value must be `1150-65535`
     #
     #   Default: The same port as the original DB cluster.
+    #
+    #   Valid for: Aurora DB clusters and Multi-AZ DB clusters
     # @option options [String] :db_subnet_group_name
     #   The name of the DB subnet group to use for the new DB cluster.
     #
@@ -604,41 +639,55 @@ module Aws::RDS
     #   group.
     #
     #   Example: `mySubnetgroup`
+    #
+    #   Valid for: Aurora DB clusters and Multi-AZ DB clusters
     # @option options [String] :database_name
     #   The database name for the restored DB cluster.
+    #
+    #   Valid for: Aurora DB clusters and Multi-AZ DB clusters
     # @option options [String] :option_group_name
     #   The name of the option group to use for the restored DB cluster.
+    #
+    #   DB clusters are associated with a default option group that can't be
+    #   modified.
     # @option options [Array<String>] :vpc_security_group_ids
     #   A list of VPC security groups that the new DB cluster will belong to.
+    #
+    #   Valid for: Aurora DB clusters and Multi-AZ DB clusters
     # @option options [Array<Types::Tag>] :tags
     #   The tags to be assigned to the restored DB cluster.
+    #
+    #   Valid for: Aurora DB clusters and Multi-AZ DB clusters
     # @option options [String] :kms_key_id
     #   The Amazon Web Services KMS key identifier to use when restoring an
     #   encrypted DB cluster from a DB snapshot or DB cluster snapshot.
     #
     #   The Amazon Web Services KMS key identifier is the key ARN, key ID,
-    #   alias ARN, or alias name for the Amazon Web Services KMS customer
-    #   master key (CMK). To use a CMK in a different Amazon Web Services
-    #   account, specify the key ARN or alias ARN.
+    #   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 you don't specify a value for the `KmsKeyId` parameter, then the
     #   following occurs:
     #
     #   * If the DB snapshot or DB cluster snapshot in `SnapshotIdentifier` is
-    #     encrypted, then the restored DB cluster is encrypted using the
-    #     Amazon Web Services KMS CMK that was used to encrypt the DB snapshot
-    #     or DB cluster snapshot.
+    #     encrypted, then the restored DB cluster is encrypted using the KMS
+    #     key that was used to encrypt the DB snapshot or DB cluster snapshot.
     #
     #   * If the DB snapshot or DB cluster snapshot in `SnapshotIdentifier`
     #     isn't encrypted, then the restored DB cluster isn't encrypted.
+    #
+    #   Valid for: Aurora DB clusters and Multi-AZ DB clusters
     # @option options [Boolean] :enable_iam_database_authentication
     #   A value that indicates whether to enable mapping of Amazon Web
     #   Services Identity and Access Management (IAM) accounts to database
-    #   accounts. By default, mapping is disabled.
+    #   accounts. By default, mapping isn't enabled.
     #
     #   For more information, see [ IAM Database Authentication][1] in the
     #   *Amazon Aurora User Guide.*
     #
+    #   Valid for: Aurora DB clusters only
+    #
     #
     #
     #   [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.IAMDBAuth.html
@@ -658,12 +707,18 @@ module Aws::RDS
     #     (72 hours).
     #
     #   ^
+    #
+    #   Valid for: Aurora DB clusters only
     # @option options [Array<String>] :enable_cloudwatch_logs_exports
     #   The list of logs that the restored DB cluster is to export to Amazon
     #   CloudWatch Logs. The values in the list depend on the DB engine being
-    #   used. For more information, see [Publishing Database Logs to Amazon
+    #   used.
+    #
+    #   For more information, see [Publishing Database Logs to Amazon
     #   CloudWatch Logs ][1] in the *Amazon Aurora User Guide*.
     #
+    #   Valid for: Aurora DB clusters only
+    #
     #
     #
     #   [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch
@@ -673,12 +728,16 @@ module Aws::RDS
     #
     #   For more information, see [ CreateDBCluster][1].
     #
+    #   Valid for: Aurora DB clusters only
+    #
     #
     #
     #   [1]: https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBCluster.html
     # @option options [Types::ScalingConfiguration] :scaling_configuration
     #   For DB clusters in `serverless` DB engine mode, the scaling properties
     #   of the DB cluster.
+    #
+    #   Valid for: Aurora DB clusters only
     # @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, the default DB cluster parameter
@@ -694,14 +753,20 @@ module Aws::RDS
     #   * First character must be a letter.
     #
     #   * Can't end with a hyphen or contain two consecutive hyphens.
+    #
+    #   Valid for: Aurora DB clusters and Multi-AZ DB clusters
     # @option options [Boolean] :deletion_protection
     #   A value that indicates whether the DB cluster has deletion protection
     #   enabled. The database can't be deleted when deletion protection is
-    #   enabled. By default, deletion protection is disabled.
+    #   enabled. By default, deletion protection isn't enabled.
+    #
+    #   Valid for: Aurora DB clusters and Multi-AZ DB clusters
     # @option options [Boolean] :copy_tags_to_snapshot
     #   A value that indicates whether to copy all tags from the restored DB
     #   cluster to snapshots of the restored DB cluster. The default is not to
     #   copy them.
+    #
+    #   Valid for: Aurora DB clusters only
     # @option options [String] :domain
     #   Specify the Active Directory directory ID to restore the DB cluster
     #   in. The domain must be created prior to this operation. Currently,
@@ -711,12 +776,95 @@ module Aws::RDS
     #   For more information, see [ Kerberos Authentication][1] in the *Amazon
     #   RDS User Guide*.
     #
+    #   Valid for: Aurora DB clusters only
+    #
     #
     #
     #   [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/kerberos-authentication.html
     # @option options [String] :domain_iam_role_name
     #   Specify the name of the IAM role to be used when making API calls to
     #   the Directory Service.
+    #
+    #   Valid for: Aurora DB clusters only
+    # @option options [String] :db_cluster_instance_class
+    #   The compute and memory capacity of the each DB instance in the
+    #   Multi-AZ DB cluster, for example db.m6g.xlarge. Not all DB instance
+    #   classes are available in all Amazon Web Services Regions, or for all
+    #   database engines.
+    #
+    #   For the full list of DB instance classes, and availability for your
+    #   engine, see [DB Instance Class][1] in the *Amazon RDS User Guide.*
+    #
+    #   Valid for: Aurora DB clusters and Multi-AZ DB clusters
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html
+    # @option options [String] :storage_type
+    #   Specifies the storage type to be associated with the each DB instance
+    #   in the Multi-AZ DB cluster.
+    #
+    #   Valid values: `standard | gp2 | io1`
+    #
+    #   If you specify `io1`, you must also include a value for the `Iops`
+    #   parameter.
+    #
+    #   Default: `io1` if the `Iops` parameter is specified, otherwise `gp2`
+    #
+    #   Valid for: Aurora DB clusters and Multi-AZ DB clusters
+    # @option options [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 to Improve Performance][1] in the *Amazon RDS User
+    #   Guide*.
+    #
+    #   Constraints: Must be a multiple between .5 and 50 of the storage
+    #   amount for the DB instance.
+    #
+    #   Valid for: Aurora DB clusters and Multi-AZ DB clusters
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Storage.html#USER_PIOPS
+    # @option options [Boolean] :publicly_accessible
+    #   A value that indicates whether the DB cluster is publicly accessible.
+    #
+    #   When the DB cluster is publicly accessible, its Domain Name System
+    #   (DNS) endpoint resolves to the private IP address from within the DB
+    #   cluster's virtual private cloud (VPC). It resolves to the public IP
+    #   address from outside of the DB cluster's VPC. Access to the DB
+    #   cluster is ultimately controlled by the security group it uses. That
+    #   public access is not permitted if the security group assigned to the
+    #   DB cluster doesn't permit it.
+    #
+    #   When the DB cluster isn't publicly accessible, it is an internal DB
+    #   cluster with a DNS name that resolves to a private IP address.
+    #
+    #   Default: The default behavior varies depending on whether
+    #   `DBSubnetGroupName` is specified.
+    #
+    #   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 cluster is private.
+    #
+    #   * If the default VPC in the target Region has an internet gateway
+    #     attached to it, the DB cluster is public.
+    #
+    #   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 cluster is private.
+    #
+    #   * If the subnets are part of a VPC that has an internet gateway
+    #     attached to it, the DB cluster is public.
+    #
+    #   Valid for: Aurora DB clusters and Multi-AZ DB clusters
     # @return [DBCluster]
     def restore(options = {})
       options = options.merge(snapshot_identifier: @snapshot_id)

data/lib/aws-sdk-rds/db_engine.rb

@@ -292,6 +292,10 @@ module Aws::RDS
     #   If this parameter is enabled and the requested engine supports the
     #   `CharacterSetName` parameter for `CreateDBInstance`, the response
     #   includes a list of supported character sets for each engine version.
+    #
+    #   For RDS Custom, the default is not to list supported character sets.
+    #   If you set `ListSupportedCharacterSets` to `true`, RDS Custom returns
+    #   no results.
     # @option options [Boolean] :list_supported_timezones
     #   A value that indicates whether to list the supported time zones for
     #   each engine version.
@@ -299,6 +303,10 @@ module Aws::RDS
     #   If this parameter is enabled and the requested engine supports the
     #   `TimeZone` parameter for `CreateDBInstance`, the response includes a
     #   list of supported time zones for each engine version.
+    #
+    #   For RDS Custom, the default is not to list supported time zones. If
+    #   you set `ListSupportedTimezones` to `true`, RDS Custom returns no
+    #   results.
     # @option options [Boolean] :include_all
     #   A value that indicates whether to include engine versions that aren't
     #   available in the list. The default is to list only available engine

data/lib/aws-sdk-rds/db_engine_version.rb

@@ -124,12 +124,24 @@ module Aws::RDS
       data[:supported_engine_modes]
     end
 
-    # A list of features supported by the DB engine. Supported feature names
-    # include the following.
+    # A list of features supported by the DB engine.
     #
-    # * s3Import
+    # The supported features vary by DB engine and DB engine version.
     #
-    # ^
+    # To determine the supported features for a specific DB engine and DB
+    # engine version using the CLI, use the following command:
+    #
+    # `aws rds describe-db-engine-versions --engine <engine_name>
+    # --engine-version <engine_version>`
+    #
+    # For example, to determine the supported features for RDS for
+    # PostgreSQL version 13.3 using the CLI, use the following command:
+    #
+    # `aws rds describe-db-engine-versions --engine postgres
+    # --engine-version 13.3`
+    #
+    # The supported features are listed under `SupportedFeatureNames` in the
+    # output.
     # @return [Array<String>]
     def supported_feature_names
       data[:supported_feature_names]
@@ -156,6 +168,56 @@ module Aws::RDS
       data[:supports_global_databases]
     end
 
+    # The major engine version of the CEV.
+    # @return [String]
+    def major_engine_version
+      data[:major_engine_version]
+    end
+
+    # The name of the Amazon S3 bucket that contains your database
+    # installation files.
+    # @return [String]
+    def database_installation_files_s3_bucket_name
+      data[:database_installation_files_s3_bucket_name]
+    end
+
+    # The Amazon S3 directory that contains the database installation files.
+    # If not specified, then no prefix is assumed.
+    # @return [String]
+    def database_installation_files_s3_prefix
+      data[:database_installation_files_s3_prefix]
+    end
+
+    # The ARN of the custom engine version.
+    # @return [String]
+    def db_engine_version_arn
+      data[:db_engine_version_arn]
+    end
+
+    # The Amazon Web Services KMS key identifier for an encrypted CEV. This
+    # parameter is required for RDS Custom, but optional for Amazon RDS.
+    # @return [String]
+    def kms_key_id
+      data[:kms_key_id]
+    end
+
+    # The creation time of the DB engine version.
+    # @return [Time]
+    def create_time
+      data[:create_time]
+    end
+
+    # A list of tags. For more information, see [Tagging Amazon RDS
+    # Resources][1] in the *Amazon RDS User Guide.*
+    #
+    #
+    #
+    # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html
+    # @return [Array<Types::Tag>]
+    def tag_list
+      data[:tag_list]
+    end
+
     # @!endgroup
 
     # @return [Client]