lib/aws-sdk-rds/client.rb in aws-sdk-rds-1.183.0 vs lib/aws-sdk-rds/client.rb in aws-sdk-rds-1.184.0

- old
+ new

@@ -26,10 +26,11 @@ require 'aws-sdk-core/plugins/client_metrics_plugin.rb' 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' require 'aws-sdk-core/plugins/protocols/query.rb' require 'aws-sdk-rds/plugins/cross_region_copying.rb' @@ -76,10 +77,11 @@ add_plugin(Aws::Plugins::ClientMetricsPlugin) add_plugin(Aws::Plugins::ClientMetricsSendPlugin) 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) add_plugin(Aws::Plugins::Protocols::Query) add_plugin(Aws::RDS::Plugins::CrossRegionCopying) @@ -190,10 +192,14 @@ # # @option options [Boolean] :disable_host_prefix_injection (false) # 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 # to test or custom endpoints. This should be a valid HTTP(S) URI. # @@ -230,10 +236,15 @@ # # @option options [String] :profile ("default") # 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. # # @option options [Float] :retry_base_delay (0.3) @@ -3995,18 +4006,10 @@ # @option params [String] :db_name # The meaning of this parameter differs depending on the database # 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 # value, Amazon RDS doesn't create a database in the DB cluster. # @@ -4014,10 +4017,12 @@ # # * Must contain 1 to 64 alphanumeric characters. # # * 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. # # Default: `postgres` # @@ -4028,10 +4033,12 @@ # * Must begin with a letter. Subsequent characters can be letters, # underscores, or digits (0 to 9). # # * 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` # # Constraints: @@ -4040,12 +4047,16 @@ # # * Must contain a letter. # # * 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. # # Constraints: @@ -4055,10 +4066,12 @@ # * Must begin with a letter. Subsequent characters can be letters, # underscores, or digits (0-9). # # * 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. # # Constraints: @@ -4068,10 +4081,12 @@ # * Must begin with a letter. Subsequent characters can be letters, # underscores, or digits (0-9). # # * 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` # # Constraints: @@ -4079,10 +4094,12 @@ # * Can't be longer than 8 characters. # # * 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` # # Constraints: @@ -4092,10 +4109,12 @@ # * Must begin with a letter. Subsequent characters can be letters, # underscores, or digits (0-9). # # * 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 # The identifier for this DB instance. This parameter is stored as a # lowercase string. @@ -4118,15 +4137,10 @@ # cluster volumes automatically grow as the amount of data in your # database increases, though you are only charged for the space that you # 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: # # * General Purpose (SSD) storage (gp2, gp3): Must be an integer from @@ -4135,10 +4149,12 @@ # # * Provisioned IOPS storage (io1): Must be an integer from 40 to # 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: # # * General Purpose (SSD) storage (gp2, gp3): Must be an integer from # 20 to 65536. @@ -4146,10 +4162,12 @@ # * Provisioned IOPS storage (io1): Must be an integer from 100 to # 65536. # # * 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: # # * General Purpose (SSD) storage (gp2, gp3): Must be an integer from # 20 to 65536. @@ -4157,10 +4175,12 @@ # * Provisioned IOPS storage (io1): Must be an integer from 100 to # 65536. # # * 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: # # * General Purpose (SSD) storage (gp2, gp3): Must be an integer from # 20 to 65536. @@ -4168,10 +4188,12 @@ # * Provisioned IOPS storage (io1): Must be an integer from 100 to # 65536. # # * 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: # # * General Purpose (SSD) storage (gp2, gp3): Must be an integer from # 20 to 65536. @@ -4179,10 +4201,12 @@ # * Provisioned IOPS storage (io1): Must be an integer from 100 to # 65536. # # * 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: # # * General Purpose (SSD) storage (gp2, gp3): # @@ -4496,38 +4520,44 @@ # the major and minor versions that are available with Amazon RDS. Not # every database engine is available for every Amazon Web Services # 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 # following format: 19.*customized\_string*. A valid CEV name is # `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*. # # # @@ -4737,16 +4767,15 @@ # # # [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. # # ^ # # Example: `mymanagedADtest.mymanagedAD.mydomain` # @@ -4755,18 +4784,18 @@ # # Constraints: # # * 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` # # @option params [Array<String>] :domain_dns_ips @@ -4782,12 +4811,12 @@ # ^ # # 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 # an Aurora DB instance has no effect on the DB cluster setting. # @@ -5958,16 +5987,15 @@ # Directory Service. # # 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. # # ^ # # Example: `mymanagedADtest.mymanagedAD.mydomain` # @@ -5976,18 +6004,18 @@ # # Constraints: # # * 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` # # @option params [Array<String>] :domain_dns_ips @@ -7315,40 +7343,87 @@ # You can create a global database that is initially empty, and then add # a primary cluster and a secondary cluster to it. Or you can specify an # 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: # # * {Types::CreateGlobalClusterResult#global_cluster #global_cluster} => Types::GlobalCluster # # @@ -18055,16 +18130,15 @@ # # # [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. # # ^ # # Example: `mymanagedADtest.mymanagedAD.mydomain` # @@ -18073,18 +18147,18 @@ # # Constraints: # # * 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` # # @option params [Array<String>] :domain_dns_ips @@ -18201,11 +18275,11 @@ # Service. # # 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 # The order of priority in which an Aurora Replica is promoted to the # primary instance after a failure of the existing primary instance. For @@ -23760,16 +23834,15 @@ # # # [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. # # ^ # # Example: `mymanagedADtest.mymanagedAD.mydomain` # @@ -23778,18 +23851,18 @@ # # Constraints: # # * 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: # # Example: # `arn:aws:secretsmanager:region:account-number:secret:myselfmanagedADtestsecret-123456` @@ -23825,14 +23898,14 @@ # # # [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 # Services Identity and Access Management (IAM) accounts to database # accounts. By default, mapping is disabled. @@ -25274,22 +25347,21 @@ # # # [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. # # ^ # # Example: `mymanagedADtest.mymanagedAD.mydomain` # @@ -25298,22 +25370,22 @@ # # Constraints: # # * 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. # # ^ # # Example: # `arn:aws:secretsmanager:region:account-number:secret:myselfmanagedADtestsecret-123456` @@ -27766,10 +27838,10 @@ operation: config.api.operation(operation_name), client: self, 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 # Polls an API operation until a resource enters a desired state. #