aws-sdk-rds 1.183.0 → 1.184.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 78e3446d88c63ecb0c8b5cbcd0da68566218af7431d1483a13468940fbf22d42
-  data.tar.gz: ad0c0a28e66651deb6d77bc401bc722f19230b791d636741532171095f153fab
+  metadata.gz: 53962220e71684b99302d4c6cacc4f22684b10c5ccdd82b7c23044cfdfaa1743
+  data.tar.gz: 14b446547fd58b16e3a455bb31f8ba26bfcf2c24578b9e49cccf5cbce241b10f
 SHA512:
-  metadata.gz: '0868cd9f9368d40dc14cd2a2ff4f3d17afbd1b290eac44e1482a94164bd37a48673414414cb5f87ab57cd23b30cf6416da02cfa42d65c7533a0a4c9cc99582d1'
-  data.tar.gz: 7c9d498f5d4ed72fdbc3319b77064dcc0436cefaad46f35ab60bec366950aa83cae7bc815788b24f53b2c9e0e4e4f331055d468dc7a048676e4c910f9338dede
+  metadata.gz: e51ef3da75db6a57fa85f205e38416b42931d2b515bf480d57a11d5cd17eac22e9abe8d649cfb42c7b0fc466645db612c3e113fa6cfcde5200fad84bce1764e3
+  data.tar.gz: a7157c85f6184ad956b5303d7a4b7bca7a4e32aca9e8cbfcca5dc26bb7bf6bd6be1a32554938b76c6789606e826e416b7782949a2e91238ea4259f5ada6e950f

data/CHANGELOG.md

@@ -1,6 +1,11 @@
 Unreleased Changes
 ------------------
 
+1.184.0 (2023-07-06)
+------------------
+
+* Feature - Updates Amazon RDS documentation for creating DB instances and creating Aurora global clusters.
+
 1.183.0 (2023-06-28)
 ------------------
 

data/VERSION

@@ -1 +1 @@
-1.183.0
+1.184.0

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

@@ -28,6 +28,7 @@ require 'aws-sdk-core/plugins/client_metrics_send_plugin.rb'
 require 'aws-sdk-core/plugins/transfer_encoding.rb'
 require 'aws-sdk-core/plugins/http_checksum.rb'
 require 'aws-sdk-core/plugins/checksum_algorithm.rb'
+require 'aws-sdk-core/plugins/request_compression.rb'
 require 'aws-sdk-core/plugins/defaults_mode.rb'
 require 'aws-sdk-core/plugins/recursion_detection.rb'
 require 'aws-sdk-core/plugins/sign.rb'
@@ -78,6 +79,7 @@ module Aws::RDS
     add_plugin(Aws::Plugins::TransferEncoding)
     add_plugin(Aws::Plugins::HttpChecksum)
     add_plugin(Aws::Plugins::ChecksumAlgorithm)
+    add_plugin(Aws::Plugins::RequestCompression)
     add_plugin(Aws::Plugins::DefaultsMode)
     add_plugin(Aws::Plugins::RecursionDetection)
     add_plugin(Aws::Plugins::Sign)
@@ -192,6 +194,10 @@ module Aws::RDS
     #     Set to true to disable SDK automatically adding host prefix
     #     to default service endpoint when available.
     #
+    #   @option options [Boolean] :disable_request_compression (false)
+    #     When set to 'true' the request body will not be compressed
+    #     for supported operations.
+    #
     #   @option options [String] :endpoint
     #     The client endpoint is normally constructed from the `:region`
     #     option. You should only configure an `:endpoint` when connecting
@@ -232,6 +238,11 @@ module Aws::RDS
     #     Used when loading credentials from the shared credentials file
     #     at HOME/.aws/credentials.  When not specified, 'default' is used.
     #
+    #   @option options [Integer] :request_min_compression_size_bytes (10240)
+    #     The minimum size in bytes that triggers compression for request
+    #     bodies. The value must be non-negative integer value between 0
+    #     and 10485780 bytes inclusive.
+    #
     #   @option options [Proc] :retry_backoff
     #     A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay.
     #     This option is only used in the `legacy` retry mode.
@@ -3997,14 +4008,6 @@ module Aws::RDS
     #   engine.
     #
     #   Amazon Aurora MySQL
-    #   Amazon Aurora PostgreSQL
-    #   Amazon RDS Custom for Oracle
-    #   Amazon RDS Custom for SQL Server
-    #   RDS for MariaDB
-    #   RDS for MySQL
-    #   RDS for Oracle
-    #   RDS for PostgreSQL
-    #   RDS for SQL Server
     #
     #   : The name of the database to create when the primary DB instance of
     #     the Aurora MySQL DB cluster is created. If you don't specify a
@@ -4016,6 +4019,8 @@ module Aws::RDS
     #
     #     * Can't be a word reserved by the database engine.
     #
+    #   Amazon Aurora PostgreSQL
+    #
     #   : The name of the database to create when the primary DB instance of
     #     the Aurora PostgreSQL DB cluster is created.
     #
@@ -4030,6 +4035,8 @@ module Aws::RDS
     #
     #     * Can't be a word reserved by the database engine.
     #
+    #   Amazon RDS Custom for Oracle
+    #
     #   : The Oracle System ID (SID) of the created RDS Custom DB instance.
     #
     #     Default: `ORCL`
@@ -4042,8 +4049,12 @@ module Aws::RDS
     #
     #     * Can't be a word reserved by the database engine.
     #
+    #   Amazon RDS Custom for SQL Server
+    #
     #   : Not applicable. Must be null.
     #
+    #   RDS for MariaDB
+    #
     #   : The name of the database to create when the DB instance is created.
     #     If you don't specify a value, Amazon RDS doesn't create a database
     #     in the DB instance.
@@ -4057,6 +4068,8 @@ module Aws::RDS
     #
     #     * Can't be a word reserved by the database engine.
     #
+    #   RDS for MySQL
+    #
     #   : The name of the database to create when the DB instance is created.
     #     If you don't specify a value, Amazon RDS doesn't create a database
     #     in the DB instance.
@@ -4070,6 +4083,8 @@ module Aws::RDS
     #
     #     * Can't be a word reserved by the database engine.
     #
+    #   RDS for Oracle
+    #
     #   : The Oracle System ID (SID) of the created DB instance.
     #
     #     Default: `ORCL`
@@ -4081,6 +4096,8 @@ module Aws::RDS
     #     * Can't be a word reserved by the database engine, such as the
     #       string `NULL`.
     #
+    #   RDS for PostgreSQL
+    #
     #   : The name of the database to create when the DB instance is created.
     #
     #     Default: `postgres`
@@ -4094,6 +4111,8 @@ module Aws::RDS
     #
     #     * Can't be a word reserved by the database engine.
     #
+    #   RDS for SQL Server
+    #
     #   : Not applicable. Must be null.
     #
     # @option params [required, String] :db_instance_identifier
@@ -4120,11 +4139,6 @@ module Aws::RDS
     #   use in an Aurora cluster volume.
     #
     #   Amazon RDS Custom
-    #   RDS for MariaDB
-    #   RDS for MySQL
-    #   RDS for Oracle
-    #   RDS for PostgreSQL
-    #   RDS for SQL Server
     #
     #   : Constraints to the amount of storage for each storage type are the
     #     following:
@@ -4137,6 +4151,8 @@ module Aws::RDS
     #       65536 for RDS Custom for Oracle, 16384 for RDS Custom for SQL
     #       Server.
     #
+    #   RDS for MariaDB
+    #
     #   : Constraints to the amount of storage for each storage type are the
     #     following:
     #
@@ -4148,6 +4164,8 @@ module Aws::RDS
     #
     #     * Magnetic storage (standard): Must be an integer from 5 to 3072.
     #
+    #   RDS for MySQL
+    #
     #   : Constraints to the amount of storage for each storage type are the
     #     following:
     #
@@ -4159,6 +4177,8 @@ module Aws::RDS
     #
     #     * Magnetic storage (standard): Must be an integer from 5 to 3072.
     #
+    #   RDS for Oracle
+    #
     #   : Constraints to the amount of storage for each storage type are the
     #     following:
     #
@@ -4170,6 +4190,8 @@ module Aws::RDS
     #
     #     * Magnetic storage (standard): Must be an integer from 10 to 3072.
     #
+    #   RDS for PostgreSQL
+    #
     #   : Constraints to the amount of storage for each storage type are the
     #     following:
     #
@@ -4181,6 +4203,8 @@ module Aws::RDS
     #
     #     * Magnetic storage (standard): Must be an integer from 5 to 3072.
     #
+    #   RDS for SQL Server
+    #
     #   : Constraints to the amount of storage for each storage type are the
     #     following:
     #
@@ -4498,12 +4522,6 @@ module Aws::RDS
     #   Region.
     #
     #   Amazon RDS Custom for Oracle
-    #   Amazon RDS Custom for SQL Server
-    #   RDS for MariaDB
-    #   RDS for Microsoft SQL Server
-    #   RDS for MySQL
-    #   RDS for Oracle
-    #   RDS for PostgreSQL
     #
     #   : A custom engine version (CEV) that you have previously created. This
     #     setting is required for RDS Custom for Oracle. The CEV name has the
@@ -4511,21 +4529,33 @@ module Aws::RDS
     #     `19.my_cev1`. For more information, see [ Creating an RDS Custom for
     #     Oracle DB instance][1] in the *Amazon RDS User Guide*.
     #
+    #   Amazon RDS Custom for SQL Server
+    #
     #   : See [RDS Custom for SQL Server general requirements][2] in the
     #     *Amazon RDS User Guide*.
     #
+    #   RDS for MariaDB
+    #
     #   : For information, see [MariaDB on Amazon RDS versions][3] in the
     #     *Amazon RDS User Guide*.
     #
+    #   RDS for Microsoft SQL Server
+    #
     #   : For information, see [Microsoft SQL Server versions on Amazon
     #     RDS][4] in the *Amazon RDS User Guide*.
     #
+    #   RDS for MySQL
+    #
     #   : For information, see [MySQL on Amazon RDS versions][5] in the
     #     *Amazon RDS User Guide*.
     #
+    #   RDS for Oracle
+    #
     #   : For information, see [Oracle Database Engine release notes][6] in
     #     the *Amazon RDS User Guide*.
     #
+    #   RDS for PostgreSQL
+    #
     #   : For information, see [Amazon RDS for PostgreSQL versions and
     #     extensions][7] in the *Amazon RDS User Guide*.
     #
@@ -4739,12 +4769,11 @@ module Aws::RDS
     #   [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/kerberos-authentication.html
     #
     # @option params [String] :domain_fqdn
-    #   Specifies the fully qualified domain name of an Active Directory
-    #   domain.
+    #   The fully qualified domain name (FQDN) of an Active Directory domain.
     #
     #   Constraints:
     #
-    #   * Cannot be greater than 64 characters.
+    #   * Can't be longer than 64 characters.
     #
     #   ^
     #
@@ -4757,14 +4786,14 @@ module Aws::RDS
     #
     #   * Must be in the distinguished name format.
     #
-    #   * Cannot be greater than 64 characters.
+    #   * Can't be longer than 64 characters.
     #
     #   Example:
     #   `OU=mymanagedADtestOU,DC=mymanagedADtest,DC=mymanagedAD,DC=mydomain`
     #
     # @option params [String] :domain_auth_secret_arn
-    #   The ARN for the Secrets Manager secret that contains the credentials
-    #   for the user performing the domain join.
+    #   The ARN for the Secrets Manager secret with the credentials for the
+    #   user joining the domain.
     #
     #   Example:
     #   `arn:aws:secretsmanager:region:account-number:secret:myselfmanagedADtestsecret-123456`
@@ -4784,8 +4813,8 @@ module Aws::RDS
     #   Example: `123.124.125.126,234.235.236.237`
     #
     # @option params [Boolean] :copy_tags_to_snapshot
-    #   Spcifies whether to copy tags from the DB instance to snapshots of the
-    #   DB instance. By default, tags are not copied.
+    #   Specifies whether to copy tags from the DB instance to snapshots of
+    #   the DB instance. By default, tags are not copied.
     #
     #   This setting doesn't apply to Amazon Aurora DB instances. Copying
     #   tags to snapshots is managed by the DB cluster. Setting this value for
@@ -5960,12 +5989,11 @@ module Aws::RDS
     #   This setting doesn't apply to RDS Custom.
     #
     # @option params [String] :domain_fqdn
-    #   Specifies the fully qualified domain name of an Active Directory
-    #   domain.
+    #   The fully qualified domain name (FQDN) of an Active Directory domain.
     #
     #   Constraints:
     #
-    #   * Cannot be greater than 64 characters.
+    #   * Can't be longer than 64 characters.
     #
     #   ^
     #
@@ -5978,14 +6006,14 @@ module Aws::RDS
     #
     #   * Must be in the distinguished name format.
     #
-    #   * Cannot be greater than 64 characters.
+    #   * Can't be longer than 64 characters.
     #
     #   Example:
     #   `OU=mymanagedADtestOU,DC=mymanagedADtest,DC=mymanagedAD,DC=mydomain`
     #
     # @option params [String] :domain_auth_secret_arn
-    #   The ARN for the Secrets Manager secret that contains the credentials
-    #   for the user performing the domain join.
+    #   The ARN for the Secrets Manager secret with the credentials for the
+    #   user joining the domain.
     #
     #   Example:
     #   `arn:aws:secretsmanager:region:account-number:secret:myselfmanagedADtestsecret-123456`
@@ -7317,35 +7345,82 @@ module Aws::RDS
     # existing Aurora cluster during the create operation, and this cluster
     # becomes the primary cluster of the global database.
     #
-    # <note markdown="1"> This action applies only to Aurora DB clusters.
+    # <note markdown="1"> This operation applies only to Aurora DB clusters.
     #
     #  </note>
     #
     # @option params [String] :global_cluster_identifier
-    #   The cluster identifier of the new global database cluster. This
+    #   The cluster identifier for this global database cluster. This
     #   parameter is stored as a lowercase string.
     #
     # @option params [String] :source_db_cluster_identifier
     #   The Amazon Resource Name (ARN) to use as the primary cluster of the
-    #   global database. This parameter is optional.
+    #   global database.
+    #
+    #   If you provide a value for this parameter, don't specify values for
+    #   the following settings because Amazon Aurora uses the values from the
+    #   specified source DB cluster:
+    #
+    #   * `DatabaseName`
+    #
+    #   * `Engine`
+    #
+    #   * `EngineVersion`
+    #
+    #   * `StorageEncrypted`
     #
     # @option params [String] :engine
-    #   The name of the database engine to be used for this DB cluster.
+    #   The database engine to use for this global database cluster.
+    #
+    #   Valid Values: `aurora-mysql | aurora-postgresql`
+    #
+    #   Constraints:
+    #
+    #   * Can't be specified if `SourceDBClusterIdentifier` is specified. In
+    #     this case, Amazon Aurora uses the engine of the source DB cluster.
+    #
+    #   ^
     #
     # @option params [String] :engine_version
-    #   The engine version of the Aurora global database.
+    #   The engine version to use for this global database cluster.
+    #
+    #   Constraints:
+    #
+    #   * Can't be specified if `SourceDBClusterIdentifier` is specified. In
+    #     this case, Amazon Aurora uses the engine version of the source DB
+    #     cluster.
+    #
+    #   ^
     #
     # @option params [Boolean] :deletion_protection
-    #   The deletion protection setting for the new global database. The
-    #   global database can't be deleted when deletion protection is enabled.
+    #   Specifies whether to enable deletion protection for the new global
+    #   database cluster. The global database can't be deleted when deletion
+    #   protection is enabled.
     #
     # @option params [String] :database_name
     #   The name for your database of up to 64 alphanumeric characters. If you
-    #   do not provide a name, Amazon Aurora will not create a database in the
-    #   global database cluster you are creating.
+    #   don't specify a name, Amazon Aurora doesn't create a database in the
+    #   global database cluster.
+    #
+    #   Constraints:
+    #
+    #   * Can't be specified if `SourceDBClusterIdentifier` is specified. In
+    #     this case, Amazon Aurora uses the database name from the source DB
+    #     cluster.
+    #
+    #   ^
     #
     # @option params [Boolean] :storage_encrypted
-    #   The storage encryption setting for the new global database cluster.
+    #   Specifies whether to enable storage encryption for the new global
+    #   database cluster.
+    #
+    #   Constraints:
+    #
+    #   * Can't be specified if `SourceDBClusterIdentifier` is specified. In
+    #     this case, Amazon Aurora uses the setting from the source DB
+    #     cluster.
+    #
+    #   ^
     #
     # @return [Types::CreateGlobalClusterResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
     #
@@ -18057,12 +18132,11 @@ module Aws::RDS
     #   [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/kerberos-authentication.html
     #
     # @option params [String] :domain_fqdn
-    #   Specifies the fully qualified domain name of an Active Directory
-    #   domain.
+    #   The fully qualified domain name (FQDN) of an Active Directory domain.
     #
     #   Constraints:
     #
-    #   * Cannot be greater than 64 characters.
+    #   * Can't be longer than 64 characters.
     #
     #   ^
     #
@@ -18075,14 +18149,14 @@ module Aws::RDS
     #
     #   * Must be in the distinguished name format.
     #
-    #   * Cannot be greater than 64 characters.
+    #   * Can't be longer than 64 characters.
     #
     #   Example:
     #   `OU=mymanagedADtestOU,DC=mymanagedADtest,DC=mymanagedAD,DC=mydomain`
     #
     # @option params [String] :domain_auth_secret_arn
-    #   The ARN for the Secrets Manager secret that contains the credentials
-    #   for the user performing the domain join.
+    #   The ARN for the Secrets Manager secret with the credentials for the
+    #   user joining the domain.
     #
     #   Example:
     #   `arn:aws:secretsmanager:region:account-number:secret:myselfmanagedADtestsecret-123456`
@@ -18203,7 +18277,7 @@ module Aws::RDS
     #   This setting doesn't apply to RDS Custom DB instances.
     #
     # @option params [Boolean] :disable_domain
-    #   Boolean. If present, removes the instance from the Active Directory
+    #   Specifies whether to remove the DB instance from the Active Directory
     #   domain.
     #
     # @option params [Integer] :promotion_tier
@@ -23762,12 +23836,11 @@ module Aws::RDS
     #   [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/kerberos-authentication.html
     #
     # @option params [String] :domain_fqdn
-    #   Specifies the fully qualified domain name of an Active Directory
-    #   domain.
+    #   The fully qualified domain name (FQDN) of an Active Directory domain.
     #
     #   Constraints:
     #
-    #   * Cannot be greater than 64 characters.
+    #   * Can't be longer than 64 characters.
     #
     #   ^
     #
@@ -23780,14 +23853,14 @@ module Aws::RDS
     #
     #   * Must be in the distinguished name format.
     #
-    #   * Cannot be greater than 64 characters.
+    #   * Can't be longer than 64 characters.
     #
     #   Example:
     #   `OU=mymanagedADtestOU,DC=mymanagedADtest,DC=mymanagedAD,DC=mydomain`
     #
     # @option params [String] :domain_auth_secret_arn
-    #   The ARN for the Secrets Manager secret that contains the credentials
-    #   for the user performing the domain join.
+    #   The ARN for the Secrets Manager secret with the credentials for the
+    #   user joining the domain.
     #
     #   Constraints:
     #
@@ -23827,10 +23900,10 @@ module Aws::RDS
     #   [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html#USER_Tagging.CopyTags
     #
     # @option params [String] :domain_iam_role_name
-    #   Specify the name of the IAM role to be used when making API calls to
-    #   the Directory Service.
+    #   The name of the IAM role to use when making API calls to the Directory
+    #   Service.
     #
-    #   This setting doesn't apply to RDS Custom.
+    #   This setting doesn't apply to RDS Custom DB instances.
     #
     # @option params [Boolean] :enable_iam_database_authentication
     #   A value that indicates whether to enable mapping of Amazon Web
@@ -25276,18 +25349,17 @@ module Aws::RDS
     #   [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/kerberos-authentication.html
     #
     # @option params [String] :domain_iam_role_name
-    #   Specify the name of the IAM role to be used when making API calls to
-    #   the Directory Service.
+    #   The name of the IAM role to use when making API calls to the Directory
+    #   Service.
     #
-    #   This setting doesn't apply to RDS Custom.
+    #   This setting doesn't apply to RDS Custom DB instances.
     #
     # @option params [String] :domain_fqdn
-    #   Specifies the fully qualified domain name of an Active Directory
-    #   domain.
+    #   The fully qualified domain name (FQDN) of an Active Directory domain.
     #
     #   Constraints:
     #
-    #   * Cannot be greater than 64 characters.
+    #   * Can't be longer than 64 characters.
     #
     #   ^
     #
@@ -25300,18 +25372,18 @@ module Aws::RDS
     #
     #   * Must be in the distinguished name format.
     #
-    #   * Cannot be greater than 64 characters.
+    #   * Can't be longer than 64 characters.
     #
     #   Example:
     #   `OU=mymanagedADtestOU,DC=mymanagedADtest,DC=mymanagedAD,DC=mydomain`
     #
     # @option params [String] :domain_auth_secret_arn
-    #   The ARN for the Secrets Manager secret that contains the credentials
-    #   for the user performing the domain join.
+    #   The ARN for the Secrets Manager secret with the credentials for the
+    #   user joining the domain.
     #
     #   Constraints:
     #
-    #   * Cannot be greater than 64 characters.
+    #   * Can't be longer than 64 characters.
     #
     #   ^
     #
@@ -27768,7 +27840,7 @@ module Aws::RDS
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-rds'
-      context[:gem_version] = '1.183.0'
+      context[:gem_version] = '1.184.0'
       Seahorse::Client::Request.new(handlers, context)
     end