aws-sdk-rds 1.181.0 → 1.182.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -1955,7 +1955,7 @@ module Aws::RDS
1955
1955
  # Zones, see [Choosing the Regions and Availability Zones][1] in the
1956
1956
  # *Amazon Aurora User Guide*.
1957
1957
  #
1958
- # Valid for: Aurora DB clusters only
1958
+ # Valid for Cluster Type: Aurora DB clusters only
1959
1959
  #
1960
1960
  #
1961
1961
  #
@@ -1965,35 +1965,37 @@ module Aws::RDS
1965
1965
  # @!attribute [rw] backup_retention_period
1966
1966
  # The number of days for which automated backups are retained.
1967
1967
  #
1968
- # Default: 1
1968
+ # Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
1969
+ #
1970
+ # Default: `1`
1969
1971
  #
1970
1972
  # Constraints:
1971
1973
  #
1972
- # * Must be a value from 1 to 35
1974
+ # * Must be a value from 1 to 35.
1973
1975
  #
1974
1976
  # ^
1975
- #
1976
- # Valid for: Aurora DB clusters and Multi-AZ DB clusters
1977
1977
  # @return [Integer]
1978
1978
  #
1979
1979
  # @!attribute [rw] character_set_name
1980
- # A value that indicates that the DB cluster should be associated with
1981
- # the specified CharacterSet.
1980
+ # The name of the character set (`CharacterSet`) to associate the DB
1981
+ # cluster with.
1982
1982
  #
1983
- # Valid for: Aurora DB clusters only
1983
+ # Valid for Cluster Type: Aurora DB clusters only
1984
1984
  # @return [String]
1985
1985
  #
1986
1986
  # @!attribute [rw] database_name
1987
1987
  # The name for your database of up to 64 alphanumeric characters. If
1988
- # you do not provide a name, Amazon RDS doesn't create a database in
1988
+ # you don't provide a name, Amazon RDS doesn't create a database in
1989
1989
  # the DB cluster you are creating.
1990
1990
  #
1991
- # Valid for: Aurora DB clusters and Multi-AZ DB clusters
1991
+ # Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
1992
1992
  # @return [String]
1993
1993
  #
1994
1994
  # @!attribute [rw] db_cluster_identifier
1995
- # The DB cluster identifier. This parameter is stored as a lowercase
1996
- # string.
1995
+ # The identifier for this DB cluster. This parameter is stored as a
1996
+ # lowercase string.
1997
+ #
1998
+ # Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
1997
1999
  #
1998
2000
  # Constraints:
1999
2001
  #
@@ -2004,29 +2006,27 @@ module Aws::RDS
2004
2006
  # * Can't end with a hyphen or contain two consecutive hyphens.
2005
2007
  #
2006
2008
  # Example: `my-cluster1`
2007
- #
2008
- # Valid for: Aurora DB clusters and Multi-AZ DB clusters
2009
2009
  # @return [String]
2010
2010
  #
2011
2011
  # @!attribute [rw] db_cluster_parameter_group_name
2012
2012
  # The name of the DB cluster parameter group to associate with this DB
2013
- # cluster. If you do not specify a value, then the default DB cluster
2013
+ # cluster. If you don't specify a value, then the default DB cluster
2014
2014
  # parameter group for the specified DB engine and version is used.
2015
2015
  #
2016
+ # Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
2017
+ #
2016
2018
  # Constraints:
2017
2019
  #
2018
2020
  # * If supplied, must match the name of an existing DB cluster
2019
2021
  # parameter group.
2020
2022
  #
2021
2023
  # ^
2022
- #
2023
- # Valid for: Aurora DB clusters and Multi-AZ DB clusters
2024
2024
  # @return [String]
2025
2025
  #
2026
2026
  # @!attribute [rw] vpc_security_group_ids
2027
2027
  # A list of EC2 VPC security groups to associate with this DB cluster.
2028
2028
  #
2029
- # Valid for: Aurora DB clusters and Multi-AZ DB clusters
2029
+ # Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
2030
2030
  # @return [Array<String>]
2031
2031
  #
2032
2032
  # @!attribute [rw] db_subnet_group_name
@@ -2034,28 +2034,23 @@ module Aws::RDS
2034
2034
  #
2035
2035
  # This setting is required to create a Multi-AZ DB cluster.
2036
2036
  #
2037
- # Constraints: Must match the name of an existing DBSubnetGroup. Must
2038
- # not be default.
2039
- #
2040
- # Example: `mydbsubnetgroup`
2041
- #
2042
- # Valid for: Aurora DB clusters and Multi-AZ DB clusters
2043
- # @return [String]
2037
+ # Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
2044
2038
  #
2045
- # @!attribute [rw] engine
2046
- # The name of the database engine to be used for this DB cluster.
2039
+ # Constraints:
2047
2040
  #
2048
- # Valid Values:
2041
+ # * Must match the name of an existing DB subnet group.
2049
2042
  #
2050
- # * `aurora-mysql`
2043
+ # * Must not be `default`.
2051
2044
  #
2052
- # * `aurora-postgresql`
2045
+ # Example: `mydbsubnetgroup`
2046
+ # @return [String]
2053
2047
  #
2054
- # * `mysql`
2048
+ # @!attribute [rw] engine
2049
+ # The database engine to use for this DB cluster.
2055
2050
  #
2056
- # * `postgres`
2051
+ # Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
2057
2052
  #
2058
- # Valid for: Aurora DB clusters and Multi-AZ DB clusters
2053
+ # Valid Values: `aurora-mysql | aurora-postgresql | mysql | postgres`
2059
2054
  # @return [String]
2060
2055
  #
2061
2056
  # @!attribute [rw] engine_version
@@ -2089,27 +2084,21 @@ module Aws::RDS
2089
2084
  # `aws rds describe-db-engine-versions --engine postgres --query
2090
2085
  # "DBEngineVersions[].EngineVersion"`
2091
2086
  #
2092
- # **Aurora MySQL**
2087
+ # For information about a specific engine, see the following topics:
2093
2088
  #
2094
- # For information, see [Database engine updates for Amazon Aurora
2095
- # MySQL][1] in the *Amazon Aurora User Guide*.
2089
+ # * Aurora MySQL - see [Database engine updates for Amazon Aurora
2090
+ # MySQL][1] in the *Amazon Aurora User Guide*.
2096
2091
  #
2097
- # **Aurora PostgreSQL**
2098
- #
2099
- # For information, see [Amazon Aurora PostgreSQL releases and engine
2100
- # versions][2] in the *Amazon Aurora User Guide*.
2092
+ # * Aurora PostgreSQL - see [Amazon Aurora PostgreSQL releases and
2093
+ # engine versions][2] in the *Amazon Aurora User Guide*.
2101
2094
  #
2102
- # **MySQL**
2095
+ # * RDS for MySQL - see [Amazon RDS for MySQL][3] in the *Amazon RDS
2096
+ # User Guide*.
2103
2097
  #
2104
- # For information, see [Amazon RDS for MySQL][3] in the *Amazon RDS
2105
- # User Guide*.
2106
- #
2107
- # **PostgreSQL**
2108
- #
2109
- # For information, see [Amazon RDS for PostgreSQL][4] in the *Amazon
2110
- # RDS User Guide*.
2098
+ # * RDS for PostgreSQL - see [Amazon RDS for PostgreSQL][4] in the
2099
+ # *Amazon RDS User Guide*.
2111
2100
  #
2112
- # Valid for: Aurora DB clusters and Multi-AZ DB clusters
2101
+ # Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
2113
2102
  #
2114
2103
  #
2115
2104
  #
@@ -2123,24 +2112,22 @@ module Aws::RDS
2123
2112
  # The port number on which the instances in the DB cluster accept
2124
2113
  # connections.
2125
2114
  #
2126
- # **RDS for MySQL and Aurora MySQL**
2127
- #
2128
- # Default: `3306`
2115
+ # Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
2129
2116
  #
2130
- # Valid values: `1150-65535`
2131
- #
2132
- # **RDS for PostgreSQL and Aurora PostgreSQL**
2117
+ # Valid Values: `1150-65535`
2133
2118
  #
2134
- # Default: `5432`
2119
+ # Default:
2135
2120
  #
2136
- # Valid values: `1150-65535`
2121
+ # * RDS for MySQL and Aurora MySQL - `3306`
2137
2122
  #
2138
- # Valid for: Aurora DB clusters and Multi-AZ DB clusters
2123
+ # * RDS for PostgreSQL and Aurora PostgreSQL - `5432`
2139
2124
  # @return [Integer]
2140
2125
  #
2141
2126
  # @!attribute [rw] master_username
2142
2127
  # The name of the master user for the DB cluster.
2143
2128
  #
2129
+ # Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
2130
+ #
2144
2131
  # Constraints:
2145
2132
  #
2146
2133
  # * Must be 1 to 16 letters or numbers.
@@ -2148,26 +2135,25 @@ module Aws::RDS
2148
2135
  # * First character must be a letter.
2149
2136
  #
2150
2137
  # * Can't be a reserved word for the chosen database engine.
2151
- #
2152
- # Valid for: Aurora DB clusters and Multi-AZ DB clusters
2153
2138
  # @return [String]
2154
2139
  #
2155
2140
  # @!attribute [rw] master_user_password
2156
- # The password for the master database user. This password can contain
2157
- # any printable ASCII character except "/", """, or "@".
2141
+ # The password for the master database user.
2142
+ #
2143
+ # Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
2158
2144
  #
2159
2145
  # Constraints:
2160
2146
  #
2161
2147
  # * Must contain from 8 to 41 characters.
2162
2148
  #
2163
- # * Can't be specified if `ManageMasterUserPassword` is turned on.
2149
+ # * Can contain any printable ASCII character except "/", """, or
2150
+ # "@".
2164
2151
  #
2165
- # Valid for: Aurora DB clusters and Multi-AZ DB clusters
2152
+ # * Can't be specified if `ManageMasterUserPassword` is turned on.
2166
2153
  # @return [String]
2167
2154
  #
2168
2155
  # @!attribute [rw] option_group_name
2169
- # A value that indicates that the DB cluster should be associated with
2170
- # the specified option group.
2156
+ # The option group to associate the DB cluster with.
2171
2157
  #
2172
2158
  # DB clusters are associated with a default option group that can't
2173
2159
  # be modified.
@@ -2178,6 +2164,8 @@ module Aws::RDS
2178
2164
  # automated backups are enabled using the `BackupRetentionPeriod`
2179
2165
  # parameter.
2180
2166
  #
2167
+ # Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
2168
+ #
2181
2169
  # The default is a 30-minute window selected at random from an 8-hour
2182
2170
  # block of time for each Amazon Web Services Region. To view the time
2183
2171
  # blocks available, see [ Backup window][1] in the *Amazon Aurora User
@@ -2193,18 +2181,15 @@ module Aws::RDS
2193
2181
  #
2194
2182
  # * Must be at least 30 minutes.
2195
2183
  #
2196
- # Valid for: Aurora DB clusters and Multi-AZ DB clusters
2197
- #
2198
2184
  #
2199
2185
  #
2200
2186
  # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Managing.Backups.html#Aurora.Managing.Backups.BackupWindow
2201
2187
  # @return [String]
2202
2188
  #
2203
2189
  # @!attribute [rw] preferred_maintenance_window
2204
- # The weekly time range during which system maintenance can occur, in
2205
- # Universal Coordinated Time (UTC).
2190
+ # The weekly time range during which system maintenance can occur.
2206
2191
  #
2207
- # Format: `ddd:hh24:mi-ddd:hh24:mi`
2192
+ # Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
2208
2193
  #
2209
2194
  # The default is a 30-minute window selected at random from an 8-hour
2210
2195
  # block of time for each Amazon Web Services Region, occurring on a
@@ -2212,11 +2197,15 @@ module Aws::RDS
2212
2197
  # Adjusting the Preferred DB Cluster Maintenance Window][1] in the
2213
2198
  # *Amazon Aurora User Guide*.
2214
2199
  #
2215
- # Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.
2200
+ # Constraints:
2216
2201
  #
2217
- # Constraints: Minimum 30-minute window.
2202
+ # * Must be in the format `ddd:hh24:mi-ddd:hh24:mi`.
2218
2203
  #
2219
- # Valid for: Aurora DB clusters and Multi-AZ DB clusters
2204
+ # * Days must be one of `Mon | Tue | Wed | Thu | Fri | Sat | Sun`.
2205
+ #
2206
+ # * Must be in Universal Coordinated Time (UTC).
2207
+ #
2208
+ # * Must be at least 30 minutes.
2220
2209
  #
2221
2210
  #
2222
2211
  #
@@ -2227,19 +2216,19 @@ module Aws::RDS
2227
2216
  # The Amazon Resource Name (ARN) of the source DB instance or DB
2228
2217
  # cluster if this DB cluster is created as a read replica.
2229
2218
  #
2230
- # Valid for: Aurora DB clusters and Multi-AZ DB clusters
2219
+ # Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
2231
2220
  # @return [String]
2232
2221
  #
2233
2222
  # @!attribute [rw] tags
2234
2223
  # Tags to assign to the DB cluster.
2235
2224
  #
2236
- # Valid for: Aurora DB clusters and Multi-AZ DB clusters
2225
+ # Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
2237
2226
  # @return [Array<Types::Tag>]
2238
2227
  #
2239
2228
  # @!attribute [rw] storage_encrypted
2240
- # A value that indicates whether the DB cluster is encrypted.
2229
+ # Specifies whether the DB cluster is encrypted.
2241
2230
  #
2242
- # Valid for: Aurora DB clusters and Multi-AZ DB clusters
2231
+ # Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
2243
2232
  # @return [Boolean]
2244
2233
  #
2245
2234
  # @!attribute [rw] kms_key_id
@@ -2254,24 +2243,24 @@ module Aws::RDS
2254
2243
  # When a KMS key isn't specified in `KmsKeyId`:
2255
2244
  #
2256
2245
  # * If `ReplicationSourceIdentifier` identifies an encrypted source,
2257
- # then Amazon RDS will use the KMS key used to encrypt the source.
2258
- # Otherwise, Amazon RDS will use your default KMS key.
2246
+ # then Amazon RDS uses the KMS key used to encrypt the source.
2247
+ # Otherwise, Amazon RDS uses your default KMS key.
2259
2248
  #
2260
2249
  # * If the `StorageEncrypted` parameter is enabled and
2261
2250
  # `ReplicationSourceIdentifier` isn't specified, then Amazon RDS
2262
- # will use your default KMS key.
2251
+ # uses your default KMS key.
2263
2252
  #
2264
2253
  # There is a default KMS key for your Amazon Web Services account.
2265
2254
  # Your Amazon Web Services account has a different default KMS key for
2266
2255
  # each Amazon Web Services Region.
2267
2256
  #
2268
2257
  # If you create a read replica of an encrypted DB cluster in another
2269
- # Amazon Web Services Region, you must set `KmsKeyId` to a KMS key
2258
+ # Amazon Web Services Region, make sure to set `KmsKeyId` to a KMS key
2270
2259
  # identifier that is valid in the destination Amazon Web Services
2271
2260
  # Region. This KMS key is used to encrypt the read replica in that
2272
2261
  # Amazon Web Services Region.
2273
2262
  #
2274
- # Valid for: Aurora DB clusters and Multi-AZ DB clusters
2263
+ # Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
2275
2264
  # @return [String]
2276
2265
  #
2277
2266
  # @!attribute [rw] pre_signed_url
@@ -2320,7 +2309,7 @@ module Aws::RDS
2320
2309
  #
2321
2310
  # </note>
2322
2311
  #
2323
- # Valid for: Aurora DB clusters only
2312
+ # Valid for Cluster Type: Aurora DB clusters only
2324
2313
  #
2325
2314
  #
2326
2315
  #
@@ -2329,14 +2318,14 @@ module Aws::RDS
2329
2318
  # @return [String]
2330
2319
  #
2331
2320
  # @!attribute [rw] enable_iam_database_authentication
2332
- # A value that indicates whether to enable mapping of Amazon Web
2333
- # Services Identity and Access Management (IAM) accounts to database
2334
- # accounts. By default, mapping isn't enabled.
2321
+ # Specifies whether to enable mapping of Amazon Web Services Identity
2322
+ # and Access Management (IAM) accounts to database accounts. By
2323
+ # default, mapping isn't enabled.
2335
2324
  #
2336
2325
  # For more information, see [ IAM Database Authentication][1] in the
2337
2326
  # *Amazon Aurora User Guide*.
2338
2327
  #
2339
- # Valid for: Aurora DB clusters only
2328
+ # Valid for Cluster Type: Aurora DB clusters only
2340
2329
  #
2341
2330
  #
2342
2331
  #
@@ -2345,9 +2334,11 @@ module Aws::RDS
2345
2334
  #
2346
2335
  # @!attribute [rw] backtrack_window
2347
2336
  # The target backtrack window, in seconds. To disable backtracking,
2348
- # set this value to 0.
2337
+ # set this value to `0`.
2349
2338
  #
2350
- # Default: 0
2339
+ # Valid for Cluster Type: Aurora MySQL DB clusters only
2340
+ #
2341
+ # Default: `0`
2351
2342
  #
2352
2343
  # Constraints:
2353
2344
  #
@@ -2355,30 +2346,23 @@ module Aws::RDS
2355
2346
  # (72 hours).
2356
2347
  #
2357
2348
  # ^
2358
- #
2359
- # Valid for: Aurora MySQL DB clusters only
2360
2349
  # @return [Integer]
2361
2350
  #
2362
2351
  # @!attribute [rw] enable_cloudwatch_logs_exports
2363
2352
  # The list of log types that need to be enabled for exporting to
2364
- # CloudWatch Logs. The values in the list depend on the DB engine
2365
- # being used.
2353
+ # CloudWatch Logs.
2366
2354
  #
2367
- # **RDS for MySQL**
2355
+ # Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
2368
2356
  #
2369
- # Possible values are `error`, `general`, and `slowquery`.
2357
+ # The following values are valid for each DB engine:
2370
2358
  #
2371
- # **RDS for PostgreSQL**
2359
+ # * Aurora MySQL - `audit | error | general | slowquery`
2372
2360
  #
2373
- # Possible values are `postgresql` and `upgrade`.
2361
+ # * Aurora PostgreSQL - `postgresql`
2374
2362
  #
2375
- # **Aurora MySQL**
2363
+ # * RDS for MySQL - `error | general | slowquery`
2376
2364
  #
2377
- # Possible values are `audit`, `error`, `general`, and `slowquery`.
2378
- #
2379
- # **Aurora PostgreSQL**
2380
- #
2381
- # Possible value is `postgresql`.
2365
+ # * RDS for PostgreSQL - `postgresql | upgrade`
2382
2366
  #
2383
2367
  # For more information about exporting CloudWatch Logs for Amazon RDS,
2384
2368
  # see [Publishing Database Logs to Amazon CloudWatch Logs][1] in the
@@ -2388,8 +2372,6 @@ module Aws::RDS
2388
2372
  # Aurora, see [Publishing Database Logs to Amazon CloudWatch Logs][2]
2389
2373
  # in the *Amazon Aurora User Guide*.
2390
2374
  #
2391
- # Valid for: Aurora DB clusters and Multi-AZ DB clusters
2392
- #
2393
2375
  #
2394
2376
  #
2395
2377
  # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch
@@ -2411,7 +2393,7 @@ module Aws::RDS
2411
2393
  #
2412
2394
  # * [Requirements for Aurora Serverless v2][2]
2413
2395
  #
2414
- # Valid for: Aurora DB clusters only
2396
+ # Valid for Cluster Type: Aurora DB clusters only
2415
2397
  #
2416
2398
  #
2417
2399
  #
@@ -2423,29 +2405,27 @@ module Aws::RDS
2423
2405
  # For DB clusters in `serverless` DB engine mode, the scaling
2424
2406
  # properties of the DB cluster.
2425
2407
  #
2426
- # Valid for: Aurora DB clusters only
2408
+ # Valid for Cluster Type: Aurora DB clusters only
2427
2409
  # @return [Types::ScalingConfiguration]
2428
2410
  #
2429
2411
  # @!attribute [rw] deletion_protection
2430
- # A value that indicates whether the DB cluster has deletion
2431
- # protection enabled. The database can't be deleted when deletion
2432
- # protection is enabled. By default, deletion protection isn't
2433
- # enabled.
2412
+ # Specifies whether the DB cluster has deletion protection enabled.
2413
+ # The database can't be deleted when deletion protection is enabled.
2414
+ # By default, deletion protection isn't enabled.
2434
2415
  #
2435
- # Valid for: Aurora DB clusters and Multi-AZ DB clusters
2416
+ # Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
2436
2417
  # @return [Boolean]
2437
2418
  #
2438
2419
  # @!attribute [rw] global_cluster_identifier
2439
2420
  # The global cluster ID of an Aurora cluster that becomes the primary
2440
2421
  # cluster in the new global database cluster.
2441
2422
  #
2442
- # Valid for: Aurora DB clusters only
2423
+ # Valid for Cluster Type: Aurora DB clusters only
2443
2424
  # @return [String]
2444
2425
  #
2445
2426
  # @!attribute [rw] enable_http_endpoint
2446
- # A value that indicates whether to enable the HTTP endpoint for an
2447
- # Aurora Serverless v1 DB cluster. By default, the HTTP endpoint is
2448
- # disabled.
2427
+ # Specifies whether to enable the HTTP endpoint for an Aurora
2428
+ # Serverless v1 DB cluster. By default, the HTTP endpoint is disabled.
2449
2429
  #
2450
2430
  # When enabled, the HTTP endpoint provides a connectionless web
2451
2431
  # service API for running SQL queries on the Aurora Serverless v1 DB
@@ -2455,7 +2435,7 @@ module Aws::RDS
2455
2435
  # For more information, see [Using the Data API for Aurora Serverless
2456
2436
  # v1][1] in the *Amazon Aurora User Guide*.
2457
2437
  #
2458
- # Valid for: Aurora DB clusters only
2438
+ # Valid for Cluster Type: Aurora DB clusters only
2459
2439
  #
2460
2440
  #
2461
2441
  #
@@ -2463,10 +2443,10 @@ module Aws::RDS
2463
2443
  # @return [Boolean]
2464
2444
  #
2465
2445
  # @!attribute [rw] copy_tags_to_snapshot
2466
- # A value that indicates whether to copy all tags from the DB cluster
2467
- # to snapshots of the DB cluster. The default is not to copy them.
2446
+ # Specifies whether to copy all tags from the DB cluster to snapshots
2447
+ # of the DB cluster. The default is not to copy them.
2468
2448
  #
2469
- # Valid for: Aurora DB clusters and Multi-AZ DB clusters
2449
+ # Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
2470
2450
  # @return [Boolean]
2471
2451
  #
2472
2452
  # @!attribute [rw] domain
@@ -2478,7 +2458,7 @@ module Aws::RDS
2478
2458
  # For more information, see [Kerberos authentication][1] in the
2479
2459
  # *Amazon Aurora User Guide*.
2480
2460
  #
2481
- # Valid for: Aurora DB clusters only
2461
+ # Valid for Cluster Type: Aurora DB clusters only
2482
2462
  #
2483
2463
  #
2484
2464
  #
@@ -2486,34 +2466,33 @@ module Aws::RDS
2486
2466
  # @return [String]
2487
2467
  #
2488
2468
  # @!attribute [rw] domain_iam_role_name
2489
- # Specify the name of the IAM role to be used when making API calls to
2490
- # the Directory Service.
2469
+ # The name of the IAM role to use when making API calls to the
2470
+ # Directory Service.
2491
2471
  #
2492
- # Valid for: Aurora DB clusters only
2472
+ # Valid for Cluster Type: Aurora DB clusters only
2493
2473
  # @return [String]
2494
2474
  #
2495
2475
  # @!attribute [rw] enable_global_write_forwarding
2496
- # A value that indicates whether to enable this DB cluster to forward
2497
- # write operations to the primary cluster of an Aurora global database
2498
- # (GlobalCluster). By default, write operations are not allowed on
2499
- # Aurora DB clusters that are secondary clusters in an Aurora global
2500
- # database.
2476
+ # Specifies whether to enable this DB cluster to forward write
2477
+ # operations to the primary cluster of a global cluster (Aurora global
2478
+ # database). By default, write operations are not allowed on Aurora DB
2479
+ # clusters that are secondary clusters in an Aurora global database.
2501
2480
  #
2502
2481
  # You can set this value only on Aurora DB clusters that are members
2503
2482
  # of an Aurora global database. With this parameter enabled, a
2504
- # secondary cluster can forward writes to the current primary cluster
2483
+ # secondary cluster can forward writes to the current primary cluster,
2505
2484
  # and the resulting changes are replicated back to this cluster. For
2506
2485
  # the primary DB cluster of an Aurora global database, this value is
2507
- # used immediately if the primary is demoted by the
2508
- # FailoverGlobalCluster API operation, but it does nothing until then.
2486
+ # used immediately if the primary is demoted by a global cluster API
2487
+ # operation, but it does nothing until then.
2509
2488
  #
2510
- # Valid for: Aurora DB clusters only
2489
+ # Valid for Cluster Type: Aurora DB clusters only
2511
2490
  # @return [Boolean]
2512
2491
  #
2513
2492
  # @!attribute [rw] db_cluster_instance_class
2514
2493
  # The compute and memory capacity of each DB instance in the Multi-AZ
2515
- # DB cluster, for example db.m6gd.xlarge. Not all DB instance classes
2516
- # are available in all Amazon Web Services Regions, or for all
2494
+ # DB cluster, for example `db.m6gd.xlarge`. Not all DB instance
2495
+ # classes are available in all Amazon Web Services Regions, or for all
2517
2496
  # database engines.
2518
2497
  #
2519
2498
  # For the full list of DB instance classes and availability for your
@@ -2521,7 +2500,7 @@ module Aws::RDS
2521
2500
  #
2522
2501
  # This setting is required to create a Multi-AZ DB cluster.
2523
2502
  #
2524
- # Valid for: Multi-AZ DB clusters only
2503
+ # Valid for Cluster Type: Multi-AZ DB clusters only
2525
2504
  #
2526
2505
  #
2527
2506
  #
@@ -2532,30 +2511,37 @@ module Aws::RDS
2532
2511
  # The amount of storage in gibibytes (GiB) to allocate to each DB
2533
2512
  # instance in the Multi-AZ DB cluster.
2534
2513
  #
2535
- # This setting is required to create a Multi-AZ DB cluster.
2514
+ # Valid for Cluster Type: Multi-AZ DB clusters only
2536
2515
  #
2537
- # Valid for: Multi-AZ DB clusters only
2516
+ # This setting is required to create a Multi-AZ DB cluster.
2538
2517
  # @return [Integer]
2539
2518
  #
2540
2519
  # @!attribute [rw] storage_type
2541
- # Specifies the storage type to be associated with the DB cluster.
2520
+ # The storage type to associate with the DB cluster.
2521
+ #
2522
+ # For information on storage types for Aurora DB clusters, see
2523
+ # [Storage configurations for Amazon Aurora DB clusters][1]. For
2524
+ # information on storage types for Multi-AZ DB clusters, see [Settings
2525
+ # for creating Multi-AZ DB clusters][2].
2542
2526
  #
2543
2527
  # This setting is required to create a Multi-AZ DB cluster.
2544
2528
  #
2545
2529
  # When specified for a Multi-AZ DB cluster, a value for the `Iops`
2546
2530
  # parameter is required.
2547
2531
  #
2548
- # Valid values: `aurora`, `aurora-iopt1` (Aurora DB clusters); `io1`
2549
- # (Multi-AZ DB clusters)
2532
+ # Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
2550
2533
  #
2551
- # Default: `aurora` (Aurora DB clusters); `io1` (Multi-AZ DB clusters)
2534
+ # Valid Values:
2552
2535
  #
2553
- # Valid for: Aurora DB clusters and Multi-AZ DB clusters
2536
+ # * Aurora DB clusters - `aurora | aurora-iopt1`
2554
2537
  #
2555
- # For more information on storage types for Aurora DB clusters, see
2556
- # [Storage configurations for Amazon Aurora DB clusters][1]. For more
2557
- # information on storage types for Multi-AZ DB clusters, see [Settings
2558
- # for creating Multi-AZ DB clusters][2].
2538
+ # * Multi-AZ DB clusters - `io1`
2539
+ #
2540
+ # Default:
2541
+ #
2542
+ # * Aurora DB clusters - `aurora`
2543
+ #
2544
+ # * Multi-AZ DB clusters - `io1`
2559
2545
  #
2560
2546
  #
2561
2547
  #
@@ -2573,10 +2559,14 @@ module Aws::RDS
2573
2559
  #
2574
2560
  # This setting is required to create a Multi-AZ DB cluster.
2575
2561
  #
2576
- # Constraints: Must be a multiple between .5 and 50 of the storage
2577
- # amount for the DB cluster.
2562
+ # Valid for Cluster Type: Multi-AZ DB clusters only
2578
2563
  #
2579
- # Valid for: Multi-AZ DB clusters only
2564
+ # Constraints:
2565
+ #
2566
+ # * Must be a multiple between .5 and 50 of the storage amount for the
2567
+ # DB cluster.
2568
+ #
2569
+ # ^
2580
2570
  #
2581
2571
  #
2582
2572
  #
@@ -2584,8 +2574,7 @@ module Aws::RDS
2584
2574
  # @return [Integer]
2585
2575
  #
2586
2576
  # @!attribute [rw] publicly_accessible
2587
- # A value that indicates whether the DB cluster is publicly
2588
- # accessible.
2577
+ # Specifies whether the DB cluster is publicly accessible.
2589
2578
  #
2590
2579
  # When the DB cluster is publicly accessible, its Domain Name System
2591
2580
  # (DNS) endpoint resolves to the private IP address from within the DB
@@ -2598,6 +2587,8 @@ module Aws::RDS
2598
2587
  # When the DB cluster isn't publicly accessible, it is an internal DB
2599
2588
  # cluster with a DNS name that resolves to a private IP address.
2600
2589
  #
2590
+ # Valid for Cluster Type: Multi-AZ DB clusters only
2591
+ #
2601
2592
  # Default: The default behavior varies depending on whether
2602
2593
  # `DBSubnetGroupName` is specified.
2603
2594
  #
@@ -2618,29 +2609,29 @@ module Aws::RDS
2618
2609
  #
2619
2610
  # * If the subnets are part of a VPC that has an internet gateway
2620
2611
  # attached to it, the DB cluster is public.
2621
- #
2622
- # Valid for: Multi-AZ DB clusters only
2623
2612
  # @return [Boolean]
2624
2613
  #
2625
2614
  # @!attribute [rw] auto_minor_version_upgrade
2626
- # A value that indicates whether minor engine upgrades are applied
2627
- # automatically to the DB cluster during the maintenance window. By
2628
- # default, minor engine upgrades are applied automatically.
2615
+ # Specifies whether minor engine upgrades are applied automatically to
2616
+ # the DB cluster during the maintenance window. By default, minor
2617
+ # engine upgrades are applied automatically.
2629
2618
  #
2630
- # Valid for: Multi-AZ DB clusters only
2619
+ # Valid for Cluster Type: Multi-AZ DB clusters only
2631
2620
  # @return [Boolean]
2632
2621
  #
2633
2622
  # @!attribute [rw] monitoring_interval
2634
2623
  # The interval, in seconds, between points when Enhanced Monitoring
2635
2624
  # metrics are collected for the DB cluster. To turn off collecting
2636
- # Enhanced Monitoring metrics, specify 0. The default is 0.
2625
+ # Enhanced Monitoring metrics, specify `0`.
2637
2626
  #
2638
2627
  # If `MonitoringRoleArn` is specified, also set `MonitoringInterval`
2639
- # to a value other than 0.
2628
+ # to a value other than `0`.
2640
2629
  #
2641
- # Valid Values: `0, 1, 5, 10, 15, 30, 60`
2630
+ # Valid for Cluster Type: Multi-AZ DB clusters only
2642
2631
  #
2643
- # Valid for: Multi-AZ DB clusters only
2632
+ # Valid Values: `0 | 1 | 5 | 10 | 15 | 30 | 60`
2633
+ #
2634
+ # Default: `0`
2644
2635
  # @return [Integer]
2645
2636
  #
2646
2637
  # @!attribute [rw] monitoring_role_arn
@@ -2650,10 +2641,10 @@ module Aws::RDS
2650
2641
  # on creating a monitoring role, see [Setting up and enabling Enhanced
2651
2642
  # Monitoring][1] in the *Amazon RDS User Guide*.
2652
2643
  #
2653
- # If `MonitoringInterval` is set to a value other than 0, supply a
2644
+ # If `MonitoringInterval` is set to a value other than `0`, supply a
2654
2645
  # `MonitoringRoleArn` value.
2655
2646
  #
2656
- # Valid for: Multi-AZ DB clusters only
2647
+ # Valid for Cluster Type: Multi-AZ DB clusters only
2657
2648
  #
2658
2649
  #
2659
2650
  #
@@ -2661,13 +2652,13 @@ module Aws::RDS
2661
2652
  # @return [String]
2662
2653
  #
2663
2654
  # @!attribute [rw] enable_performance_insights
2664
- # A value that indicates whether to turn on Performance Insights for
2665
- # the DB cluster.
2655
+ # Specifies whether to turn on Performance Insights for the DB
2656
+ # cluster.
2666
2657
  #
2667
2658
  # For more information, see [ Using Amazon Performance Insights][1] in
2668
2659
  # the *Amazon RDS User Guide*.
2669
2660
  #
2670
- # Valid for: Multi-AZ DB clusters only
2661
+ # Valid for Cluster Type: Multi-AZ DB clusters only
2671
2662
  #
2672
2663
  #
2673
2664
  #
@@ -2687,33 +2678,28 @@ module Aws::RDS
2687
2678
  # account has a different default KMS key for each Amazon Web Services
2688
2679
  # Region.
2689
2680
  #
2690
- # Valid for: Multi-AZ DB clusters only
2681
+ # Valid for Cluster Type: Multi-AZ DB clusters only
2691
2682
  # @return [String]
2692
2683
  #
2693
2684
  # @!attribute [rw] performance_insights_retention_period
2694
- # The number of days to retain Performance Insights data. The default
2695
- # is 7 days. The following values are valid:
2685
+ # The number of days to retain Performance Insights data.
2696
2686
  #
2697
- # * 7
2698
- #
2699
- # * *month* * 31, where *month* is a number of months from 1-23
2700
- #
2701
- # * 731
2702
- #
2703
- # For example, the following values are valid:
2687
+ # Valid for Cluster Type: Multi-AZ DB clusters only
2704
2688
  #
2705
- # * 93 (3 months * 31)
2689
+ # Valid Values:
2706
2690
  #
2707
- # * 341 (11 months * 31)
2691
+ # * `7`
2708
2692
  #
2709
- # * 589 (19 months * 31)
2693
+ # * *month* * 31, where *month* is a number of months from 1-23.
2694
+ # Examples: `93` (3 months * 31), `341` (11 months * 31), `589`
2695
+ # (19 months * 31)
2710
2696
  #
2711
- # * 731
2697
+ # * `731`
2712
2698
  #
2713
- # If you specify a retention period such as 94, which isn't a valid
2714
- # value, RDS issues an error.
2699
+ # Default: `7` days
2715
2700
  #
2716
- # Valid for: Multi-AZ DB clusters only
2701
+ # If you specify a retention period that isn't valid, such as `94`,
2702
+ # Amazon RDS issues an error.
2717
2703
  # @return [Integer]
2718
2704
  #
2719
2705
  # @!attribute [rw] serverless_v2_scaling_configuration
@@ -2731,12 +2717,6 @@ module Aws::RDS
2731
2717
  # @!attribute [rw] network_type
2732
2718
  # The network type of the DB cluster.
2733
2719
  #
2734
- # Valid values:
2735
- #
2736
- # * `IPV4`
2737
- #
2738
- # * `DUAL`
2739
- #
2740
2720
  # The network type is determined by the `DBSubnetGroup` specified for
2741
2721
  # the DB cluster. A `DBSubnetGroup` can support only the IPv4 protocol
2742
2722
  # or the IPv4 and the IPv6 protocols (`DUAL`).
@@ -2744,7 +2724,9 @@ module Aws::RDS
2744
2724
  # For more information, see [ Working with a DB instance in a VPC][1]
2745
2725
  # in the *Amazon Aurora User Guide.*
2746
2726
  #
2747
- # Valid for: Aurora DB clusters only
2727
+ # Valid for Cluster Type: Aurora DB clusters only
2728
+ #
2729
+ # Valid Values: `IPV4 | DUAL`
2748
2730
  #
2749
2731
  #
2750
2732
  #
@@ -2756,14 +2738,16 @@ module Aws::RDS
2756
2738
  # @return [String]
2757
2739
  #
2758
2740
  # @!attribute [rw] manage_master_user_password
2759
- # A value that indicates whether to manage the master user password
2760
- # with Amazon Web Services Secrets Manager.
2741
+ # Specifies whether to manage the master user password with Amazon Web
2742
+ # Services Secrets Manager.
2761
2743
  #
2762
2744
  # For more information, see [Password management with Amazon Web
2763
2745
  # Services Secrets Manager][1] in the *Amazon RDS User Guide* and
2764
2746
  # [Password management with Amazon Web Services Secrets Manager][2] in
2765
2747
  # the *Amazon Aurora User Guide.*
2766
2748
  #
2749
+ # Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
2750
+ #
2767
2751
  # Constraints:
2768
2752
  #
2769
2753
  # * Can't manage the master user password with Amazon Web Services
@@ -2771,8 +2755,6 @@ module Aws::RDS
2771
2755
  #
2772
2756
  # ^
2773
2757
  #
2774
- # Valid for: Aurora DB clusters and Multi-AZ DB clusters
2775
- #
2776
2758
  #
2777
2759
  #
2778
2760
  # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html
@@ -2802,7 +2784,7 @@ module Aws::RDS
2802
2784
  # Your Amazon Web Services account has a different default KMS key for
2803
2785
  # each Amazon Web Services Region.
2804
2786
  #
2805
- # Valid for: Aurora DB clusters and Multi-AZ DB clusters
2787
+ # Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
2806
2788
  # @return [String]
2807
2789
  #
2808
2790
  # @!attribute [rw] source_region
@@ -3063,124 +3045,114 @@ module Aws::RDS
3063
3045
  end
3064
3046
 
3065
3047
  # @!attribute [rw] db_name
3066
- # The meaning of this parameter differs according to the database
3067
- # engine you use.
3068
- #
3069
- # **MySQL**
3048
+ # The meaning of this parameter differs depending on the database
3049
+ # engine.
3070
3050
  #
3071
- # The name of the database to create when the DB instance is created.
3072
- # If this parameter isn't specified, no database is created in the DB
3073
- # instance.
3051
+ # Amazon Aurora MySQL
3052
+ # Amazon Aurora PostgreSQL
3053
+ # Amazon RDS Custom for Oracle
3054
+ # Amazon RDS Custom for SQL Server
3055
+ # RDS for MariaDB
3056
+ # RDS for MySQL
3057
+ # RDS for Oracle
3058
+ # RDS for PostgreSQL
3059
+ # RDS for SQL Server
3074
3060
  #
3075
- # Constraints:
3061
+ # : The name of the database to create when the primary DB instance of
3062
+ # the Aurora MySQL DB cluster is created. If you don't specify a
3063
+ # value, Amazon RDS doesn't create a database in the DB cluster.
3076
3064
  #
3077
- # * Must contain 1 to 64 letters or numbers.
3065
+ # Constraints:
3078
3066
  #
3079
- # * Must begin with a letter. Subsequent characters can be letters,
3080
- # underscores, or digits (0-9).
3067
+ # * Must contain 1 to 64 alphanumeric characters.
3081
3068
  #
3082
- # * Can't be a word reserved by the specified database engine
3069
+ # * Can't be a word reserved by the database engine.
3083
3070
  #
3084
- # **MariaDB**
3071
+ # : The name of the database to create when the primary DB instance of
3072
+ # the Aurora PostgreSQL DB cluster is created.
3085
3073
  #
3086
- # The name of the database to create when the DB instance is created.
3087
- # If this parameter isn't specified, no database is created in the DB
3088
- # instance.
3074
+ # Default: `postgres`
3089
3075
  #
3090
- # Constraints:
3076
+ # Constraints:
3091
3077
  #
3092
- # * Must contain 1 to 64 letters or numbers.
3078
+ # * Must contain 1 to 63 alphanumeric characters.
3093
3079
  #
3094
- # * Must begin with a letter. Subsequent characters can be letters,
3095
- # underscores, or digits (0-9).
3080
+ # * Must begin with a letter. Subsequent characters can be letters,
3081
+ # underscores, or digits (0 to 9).
3096
3082
  #
3097
- # * Can't be a word reserved by the specified database engine
3083
+ # * Can't be a word reserved by the database engine.
3098
3084
  #
3099
- # **PostgreSQL**
3085
+ # : The Oracle System ID (SID) of the created RDS Custom DB instance.
3100
3086
  #
3101
- # The name of the database to create when the DB instance is created.
3102
- # If this parameter isn't specified, a database named `postgres` is
3103
- # created in the DB instance.
3087
+ # Default: `ORCL`
3104
3088
  #
3105
- # Constraints:
3106
- #
3107
- # * Must contain 1 to 63 letters, numbers, or underscores.
3108
- #
3109
- # * Must begin with a letter. Subsequent characters can be letters,
3110
- # underscores, or digits (0-9).
3111
- #
3112
- # * Can't be a word reserved by the specified database engine
3089
+ # Constraints:
3113
3090
  #
3114
- # **Oracle**
3115
- #
3116
- # The Oracle System ID (SID) of the created DB instance. If you
3117
- # specify `null`, the default value `ORCL` is used. You can't specify
3118
- # the string NULL, or any other reserved word, for `DBName`.
3091
+ # * Must contain 1 to 8 alphanumeric characters.
3119
3092
  #
3120
- # Default: `ORCL`
3121
- #
3122
- # Constraints:
3093
+ # * Must contain a letter.
3123
3094
  #
3124
- # * Can't be longer than 8 characters
3095
+ # * Can't be a word reserved by the database engine.
3125
3096
  #
3126
- # ^
3097
+ # : Not applicable. Must be null.
3127
3098
  #
3128
- # **Amazon RDS Custom for Oracle**
3099
+ # : The name of the database to create when the DB instance is
3100
+ # created. If you don't specify a value, Amazon RDS doesn't create
3101
+ # a database in the DB instance.
3129
3102
  #
3130
- # The Oracle System ID (SID) of the created RDS Custom DB instance. If
3131
- # you don't specify a value, the default value is `ORCL`.
3103
+ # Constraints:
3132
3104
  #
3133
- # Default: `ORCL`
3105
+ # * Must contain 1 to 64 letters or numbers.
3134
3106
  #
3135
- # Constraints:
3107
+ # * Must begin with a letter. Subsequent characters can be letters,
3108
+ # underscores, or digits (0-9).
3136
3109
  #
3137
- # * It must contain 1 to 8 alphanumeric characters.
3110
+ # * Can't be a word reserved by the database engine.
3138
3111
  #
3139
- # * It must contain a letter.
3112
+ # : The name of the database to create when the DB instance is
3113
+ # created. If you don't specify a value, Amazon RDS doesn't create
3114
+ # a database in the DB instance.
3140
3115
  #
3141
- # * It can't be a word reserved by the database engine.
3116
+ # Constraints:
3142
3117
  #
3143
- # **Amazon RDS Custom for SQL Server**
3118
+ # * Must contain 1 to 64 letters or numbers.
3144
3119
  #
3145
- # Not applicable. Must be null.
3120
+ # * Must begin with a letter. Subsequent characters can be letters,
3121
+ # underscores, or digits (0-9).
3146
3122
  #
3147
- # **SQL Server**
3123
+ # * Can't be a word reserved by the database engine.
3148
3124
  #
3149
- # Not applicable. Must be null.
3125
+ # : The Oracle System ID (SID) of the created DB instance.
3150
3126
  #
3151
- # **Amazon Aurora MySQL**
3127
+ # Default: `ORCL`
3152
3128
  #
3153
- # The name of the database to create when the primary DB instance of
3154
- # the Aurora MySQL DB cluster is created. If this parameter isn't
3155
- # specified for an Aurora MySQL DB cluster, no database is created in
3156
- # the DB cluster.
3129
+ # Constraints:
3157
3130
  #
3158
- # Constraints:
3131
+ # * Can't be longer than 8 characters.
3159
3132
  #
3160
- # * It must contain 1 to 64 alphanumeric characters.
3133
+ # * Can't be a word reserved by the database engine, such as the
3134
+ # string `NULL`.
3161
3135
  #
3162
- # * It can't be a word reserved by the database engine.
3136
+ # : The name of the database to create when the DB instance is
3137
+ # created.
3163
3138
  #
3164
- # **Amazon Aurora PostgreSQL**
3139
+ # Default: `postgres`
3165
3140
  #
3166
- # The name of the database to create when the primary DB instance of
3167
- # the Aurora PostgreSQL DB cluster is created. If this parameter
3168
- # isn't specified for an Aurora PostgreSQL DB cluster, a database
3169
- # named `postgres` is created in the DB cluster.
3141
+ # Constraints:
3170
3142
  #
3171
- # Constraints:
3143
+ # * Must contain 1 to 63 letters, numbers, or underscores.
3172
3144
  #
3173
- # * It must contain 1 to 63 alphanumeric characters.
3145
+ # * Must begin with a letter. Subsequent characters can be letters,
3146
+ # underscores, or digits (0-9).
3174
3147
  #
3175
- # * It must begin with a letter. Subsequent characters can be letters,
3176
- # underscores, or digits (0 to 9).
3148
+ # * Can't be a word reserved by the database engine.
3177
3149
  #
3178
- # * It can't be a word reserved by the database engine.
3150
+ # : Not applicable. Must be null.
3179
3151
  # @return [String]
3180
3152
  #
3181
3153
  # @!attribute [rw] db_instance_identifier
3182
- # The DB instance identifier. This parameter is stored as a lowercase
3183
- # string.
3154
+ # The identifier for this DB instance. This parameter is stored as a
3155
+ # lowercase string.
3184
3156
  #
3185
3157
  # Constraints:
3186
3158
  #
@@ -3197,113 +3169,106 @@ module Aws::RDS
3197
3169
  # The amount of storage in gibibytes (GiB) to allocate for the DB
3198
3170
  # instance.
3199
3171
  #
3200
- # Type: Integer
3172
+ # This setting doesn't apply to Amazon Aurora DB instances. Aurora
3173
+ # cluster volumes automatically grow as the amount of data in your
3174
+ # database increases, though you are only charged for the space that
3175
+ # you use in an Aurora cluster volume.
3201
3176
  #
3202
- # **Amazon Aurora**
3177
+ # Amazon RDS Custom
3178
+ # RDS for MariaDB
3179
+ # RDS for MySQL
3180
+ # RDS for Oracle
3181
+ # RDS for PostgreSQL
3182
+ # RDS for SQL Server
3203
3183
  #
3204
- # Not applicable. Aurora cluster volumes automatically grow as the
3205
- # amount of data in your database increases, though you are only
3206
- # charged for the space that you use in an Aurora cluster volume.
3184
+ # : Constraints to the amount of storage for each storage type are the
3185
+ # following:
3207
3186
  #
3208
- # **Amazon RDS Custom**
3187
+ # * General Purpose (SSD) storage (gp2, gp3): Must be an integer
3188
+ # from 40 to 65536 for RDS Custom for Oracle, 16384 for RDS Custom
3189
+ # for SQL Server.
3209
3190
  #
3210
- # Constraints to the amount of storage for each storage type are the
3211
- # following:
3191
+ # * Provisioned IOPS storage (io1): Must be an integer from 40 to
3192
+ # 65536 for RDS Custom for Oracle, 16384 for RDS Custom for SQL
3193
+ # Server.
3212
3194
  #
3213
- # * General Purpose (SSD) storage (gp2, gp3): Must be an integer from
3214
- # 40 to 65536 for RDS Custom for Oracle, 16384 for RDS Custom for
3215
- # SQL Server.
3195
+ # : Constraints to the amount of storage for each storage type are the
3196
+ # following:
3216
3197
  #
3217
- # * Provisioned IOPS storage (io1): Must be an integer from 40 to
3218
- # 65536 for RDS Custom for Oracle, 16384 for RDS Custom for SQL
3219
- # Server.
3198
+ # * General Purpose (SSD) storage (gp2, gp3): Must be an integer
3199
+ # from 20 to 65536.
3220
3200
  #
3221
- # **MySQL**
3201
+ # * Provisioned IOPS storage (io1): Must be an integer from 100 to
3202
+ # 65536.
3222
3203
  #
3223
- # Constraints to the amount of storage for each storage type are the
3224
- # following:
3204
+ # * Magnetic storage (standard): Must be an integer from 5 to 3072.
3225
3205
  #
3226
- # * General Purpose (SSD) storage (gp2, gp3): Must be an integer from
3227
- # 20 to 65536.
3206
+ # : Constraints to the amount of storage for each storage type are the
3207
+ # following:
3228
3208
  #
3229
- # * Provisioned IOPS storage (io1): Must be an integer from 100 to
3230
- # 65536.
3209
+ # * General Purpose (SSD) storage (gp2, gp3): Must be an integer
3210
+ # from 20 to 65536.
3231
3211
  #
3232
- # * Magnetic storage (standard): Must be an integer from 5 to 3072.
3212
+ # * Provisioned IOPS storage (io1): Must be an integer from 100 to
3213
+ # 65536.
3233
3214
  #
3234
- # **MariaDB**
3215
+ # * Magnetic storage (standard): Must be an integer from 5 to 3072.
3235
3216
  #
3236
- # Constraints to the amount of storage for each storage type are the
3237
- # following:
3217
+ # : Constraints to the amount of storage for each storage type are the
3218
+ # following:
3238
3219
  #
3239
- # * General Purpose (SSD) storage (gp2, gp3): Must be an integer from
3240
- # 20 to 65536.
3220
+ # * General Purpose (SSD) storage (gp2, gp3): Must be an integer
3221
+ # from 20 to 65536.
3241
3222
  #
3242
- # * Provisioned IOPS storage (io1): Must be an integer from 100 to
3243
- # 65536.
3223
+ # * Provisioned IOPS storage (io1): Must be an integer from 100 to
3224
+ # 65536.
3244
3225
  #
3245
- # * Magnetic storage (standard): Must be an integer from 5 to 3072.
3226
+ # * Magnetic storage (standard): Must be an integer from 10 to 3072.
3246
3227
  #
3247
- # **PostgreSQL**
3228
+ # : Constraints to the amount of storage for each storage type are the
3229
+ # following:
3248
3230
  #
3249
- # Constraints to the amount of storage for each storage type are the
3250
- # following:
3231
+ # * General Purpose (SSD) storage (gp2, gp3): Must be an integer
3232
+ # from 20 to 65536.
3251
3233
  #
3252
- # * General Purpose (SSD) storage (gp2, gp3): Must be an integer from
3253
- # 20 to 65536.
3234
+ # * Provisioned IOPS storage (io1): Must be an integer from 100 to
3235
+ # 65536.
3254
3236
  #
3255
- # * Provisioned IOPS storage (io1): Must be an integer from 100 to
3256
- # 65536.
3237
+ # * Magnetic storage (standard): Must be an integer from 5 to 3072.
3257
3238
  #
3258
- # * Magnetic storage (standard): Must be an integer from 5 to 3072.
3239
+ # : Constraints to the amount of storage for each storage type are the
3240
+ # following:
3259
3241
  #
3260
- # **Oracle**
3242
+ # * General Purpose (SSD) storage (gp2, gp3):
3261
3243
  #
3262
- # Constraints to the amount of storage for each storage type are the
3263
- # following:
3264
- #
3265
- # * General Purpose (SSD) storage (gp2, gp3): Must be an integer from
3266
- # 20 to 65536.
3267
- #
3268
- # * Provisioned IOPS storage (io1): Must be an integer from 100 to
3269
- # 65536.
3270
- #
3271
- # * Magnetic storage (standard): Must be an integer from 10 to 3072.
3272
- #
3273
- # **SQL Server**
3274
- #
3275
- # Constraints to the amount of storage for each storage type are the
3276
- # following:
3277
- #
3278
- # * General Purpose (SSD) storage (gp2, gp3):
3244
+ # * Enterprise and Standard editions: Must be an integer from 20
3245
+ # to 16384.
3279
3246
  #
3280
- # * Enterprise and Standard editions: Must be an integer from 20 to
3281
- # 16384.
3247
+ # * Web and Express editions: Must be an integer from 20 to 16384.
3282
3248
  #
3283
- # * Web and Express editions: Must be an integer from 20 to 16384.
3249
+ # * Provisioned IOPS storage (io1):
3284
3250
  #
3285
- # * Provisioned IOPS storage (io1):
3251
+ # * Enterprise and Standard editions: Must be an integer from 100
3252
+ # to 16384.
3286
3253
  #
3287
- # * Enterprise and Standard editions: Must be an integer from 100 to
3288
- # 16384.
3254
+ # * Web and Express editions: Must be an integer from 100 to
3255
+ # 16384.
3289
3256
  #
3290
- # * Web and Express editions: Must be an integer from 100 to 16384.
3257
+ # * Magnetic storage (standard):
3291
3258
  #
3292
- # * Magnetic storage (standard):
3259
+ # * Enterprise and Standard editions: Must be an integer from 20
3260
+ # to 1024.
3293
3261
  #
3294
- # * Enterprise and Standard editions: Must be an integer from 20 to
3295
- # 1024.
3296
- #
3297
- # * Web and Express editions: Must be an integer from 20 to 1024.
3262
+ # * Web and Express editions: Must be an integer from 20 to 1024.
3298
3263
  # @return [Integer]
3299
3264
  #
3300
3265
  # @!attribute [rw] db_instance_class
3301
3266
  # The compute and memory capacity of the DB instance, for example
3302
- # db.m5.large. Not all DB instance classes are available in all Amazon
3303
- # Web Services Regions, or for all database engines. For the full list
3304
- # of DB instance classes, and availability for your engine, see [DB
3305
- # instance classes][1] in the *Amazon RDS User Guide* or [Aurora DB
3306
- # instance classes][2] in the *Amazon Aurora User Guide*.
3267
+ # `db.m5.large`. Not all DB instance classes are available in all
3268
+ # Amazon Web Services Regions, or for all database engines. For the
3269
+ # full list of DB instance classes, and availability for your engine,
3270
+ # see [DB instance classes][1] in the *Amazon RDS User Guide* or
3271
+ # [Aurora DB instance classes][2] in the *Amazon Aurora User Guide*.
3307
3272
  #
3308
3273
  #
3309
3274
  #
@@ -3312,9 +3277,9 @@ module Aws::RDS
3312
3277
  # @return [String]
3313
3278
  #
3314
3279
  # @!attribute [rw] engine
3315
- # The name of the database engine to be used for this instance.
3280
+ # The database engine to use for this DB instance.
3316
3281
  #
3317
- # Not every database engine is available for every Amazon Web Services
3282
+ # Not every database engine is available in every Amazon Web Services
3318
3283
  # Region.
3319
3284
  #
3320
3285
  # Valid Values:
@@ -3323,16 +3288,16 @@ module Aws::RDS
3323
3288
  #
3324
3289
  # * `aurora-postgresql` (for Aurora PostgreSQL DB instances)
3325
3290
  #
3326
- # * `custom-oracle-ee (for RDS Custom for Oracle DB instances)`
3291
+ # * `custom-oracle-ee` (for RDS Custom for Oracle DB instances)
3327
3292
  #
3328
- # * `custom-oracle-ee-cdb (for RDS Custom for Oracle DB instances)`
3293
+ # * `custom-oracle-ee-cdb` (for RDS Custom for Oracle DB instances)
3329
3294
  #
3330
- # * `custom-sqlserver-ee (for RDS Custom for SQL Server DB instances)`
3295
+ # * `custom-sqlserver-ee` (for RDS Custom for SQL Server DB instances)
3331
3296
  #
3332
- # * `custom-sqlserver-se (for RDS Custom for SQL Server DB instances)`
3297
+ # * `custom-sqlserver-se` (for RDS Custom for SQL Server DB instances)
3333
3298
  #
3334
- # * `custom-sqlserver-web (for RDS Custom for SQL Server DB
3335
- # instances)`
3299
+ # * `custom-sqlserver-web` (for RDS Custom for SQL Server DB
3300
+ # instances)
3336
3301
  #
3337
3302
  # * `mariadb`
3338
3303
  #
@@ -3360,17 +3325,13 @@ module Aws::RDS
3360
3325
  # @!attribute [rw] master_username
3361
3326
  # The name for the master user.
3362
3327
  #
3363
- # **Amazon Aurora**
3328
+ # This setting doesn't apply to Amazon Aurora DB instances. The name
3329
+ # for the master user is managed by the DB cluster.
3364
3330
  #
3365
- # Not applicable. The name for the master user is managed by the DB
3366
- # cluster.
3367
- #
3368
- # **Amazon RDS**
3331
+ # This setting is required for RDS DB instances.
3369
3332
  #
3370
3333
  # Constraints:
3371
3334
  #
3372
- # * Required.
3373
- #
3374
3335
  # * Must be 1 to 16 letters, numbers, or underscores.
3375
3336
  #
3376
3337
  # * First character must be a letter.
@@ -3379,36 +3340,30 @@ module Aws::RDS
3379
3340
  # @return [String]
3380
3341
  #
3381
3342
  # @!attribute [rw] master_user_password
3382
- # The password for the master user. The password can include any
3383
- # printable ASCII character except "/", """, or "@".
3384
- #
3385
- # **Amazon Aurora**
3386
- #
3387
- # Not applicable. The password for the master user is managed by the
3388
- # DB cluster.
3343
+ # The password for the master user.
3389
3344
  #
3390
- # Constraints: Can't be specified if `ManageMasterUserPassword` is
3391
- # turned on.
3392
- #
3393
- # **MariaDB**
3345
+ # This setting doesn't apply to Amazon Aurora DB instances. The
3346
+ # password for the master user is managed by the DB cluster.
3394
3347
  #
3395
- # Constraints: Must contain from 8 to 41 characters.
3348
+ # Constraints:
3396
3349
  #
3397
- # **Microsoft SQL Server**
3350
+ # * Can't be specified if `ManageMasterUserPassword` is turned on.
3398
3351
  #
3399
- # Constraints: Must contain from 8 to 128 characters.
3352
+ # * Can include any printable ASCII character except "/", """, or
3353
+ # "@".
3400
3354
  #
3401
- # **MySQL**
3355
+ # Length Constraints:
3402
3356
  #
3403
- # Constraints: Must contain from 8 to 41 characters.
3357
+ # * RDS for MariaDB - Must contain from 8 to 41 characters.
3404
3358
  #
3405
- # **Oracle**
3359
+ # * RDS for Microsoft SQL Server - Must contain from 8 to 128
3360
+ # characters.
3406
3361
  #
3407
- # Constraints: Must contain from 8 to 30 characters.
3362
+ # * RDS for MySQL - Must contain from 8 to 41 characters.
3408
3363
  #
3409
- # **PostgreSQL**
3364
+ # * RDS for Oracle - Must contain from 8 to 30 characters.
3410
3365
  #
3411
- # Constraints: Must contain from 8 to 128 characters.
3366
+ # * RDS for PostgreSQL - Must contain from 8 to 128 characters.
3412
3367
  # @return [String]
3413
3368
  #
3414
3369
  # @!attribute [rw] db_security_groups
@@ -3423,10 +3378,9 @@ module Aws::RDS
3423
3378
  # A list of Amazon EC2 VPC security groups to associate with this DB
3424
3379
  # instance.
3425
3380
  #
3426
- # **Amazon Aurora**
3427
- #
3428
- # Not applicable. The associated list of EC2 VPC security groups is
3429
- # managed by the DB cluster.
3381
+ # This setting doesn't apply to Amazon Aurora DB instances. The
3382
+ # associated list of EC2 VPC security groups is managed by the DB
3383
+ # cluster.
3430
3384
  #
3431
3385
  # Default: The default EC2 VPC security group for the DB subnet
3432
3386
  # group's VPC.
@@ -3437,22 +3391,23 @@ module Aws::RDS
3437
3391
  # information on Amazon Web Services Regions and Availability Zones,
3438
3392
  # see [Regions and Availability Zones][1].
3439
3393
  #
3440
- # **Amazon Aurora**
3441
- #
3442
- # Each Aurora DB cluster hosts copies of its storage in three separate
3443
- # Availability Zones. Specify one of these Availability Zones. Aurora
3444
- # automatically chooses an appropriate Availability Zone if you don't
3445
- # specify one.
3394
+ # For Amazon Aurora, each Aurora DB cluster hosts copies of its
3395
+ # storage in three separate Availability Zones. Specify one of these
3396
+ # Availability Zones. Aurora automatically chooses an appropriate
3397
+ # Availability Zone if you don't specify one.
3446
3398
  #
3447
3399
  # Default: A random, system-chosen Availability Zone in the
3448
3400
  # endpoint's Amazon Web Services Region.
3449
3401
  #
3450
- # Example: `us-east-1d`
3402
+ # Constraints:
3451
3403
  #
3452
- # Constraint: The `AvailabilityZone` parameter can't be specified if
3453
- # the DB instance is a Multi-AZ deployment. The specified Availability
3454
- # Zone must be in the same Amazon Web Services Region as the current
3455
- # endpoint.
3404
+ # * The `AvailabilityZone` parameter can't be specified if the DB
3405
+ # instance is a Multi-AZ deployment.
3406
+ #
3407
+ # * The specified Availability Zone must be in the same Amazon Web
3408
+ # Services Region as the current endpoint.
3409
+ #
3410
+ # Example: `us-east-1d`
3456
3411
  #
3457
3412
  #
3458
3413
  #
@@ -3462,26 +3417,35 @@ module Aws::RDS
3462
3417
  # @!attribute [rw] db_subnet_group_name
3463
3418
  # A DB subnet group to associate with this DB instance.
3464
3419
  #
3465
- # Constraints: Must match the name of an existing DBSubnetGroup. Must
3466
- # not be default.
3420
+ # Constraints:
3421
+ #
3422
+ # * Must match the name of an existing DB subnet group.
3423
+ #
3424
+ # * Must not be `default`.
3467
3425
  #
3468
3426
  # Example: `mydbsubnetgroup`
3469
3427
  # @return [String]
3470
3428
  #
3471
3429
  # @!attribute [rw] preferred_maintenance_window
3472
- # The time range each week during which system maintenance can occur,
3473
- # in Universal Coordinated Time (UTC). For more information, see
3474
- # [Amazon RDS Maintenance Window][1].
3475
- #
3476
- # Format: `ddd:hh24:mi-ddd:hh24:mi`
3430
+ # The time range each week during which system maintenance can occur.
3431
+ # For more information, see [Amazon RDS Maintenance Window][1] in the
3432
+ # *Amazon RDS User Guide.*
3477
3433
  #
3478
3434
  # The default is a 30-minute window selected at random from an 8-hour
3479
3435
  # block of time for each Amazon Web Services Region, occurring on a
3480
3436
  # random day of the week.
3481
3437
  #
3482
- # Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.
3438
+ # Constraints:
3483
3439
  #
3484
- # Constraints: Minimum 30-minute window.
3440
+ # * Must be in the format `ddd:hh24:mi-ddd:hh24:mi`.
3441
+ #
3442
+ # * The day values must be `mon | tue | wed | thu | fri | sat | sun`.
3443
+ #
3444
+ # * Must be in Universal Coordinated Time (UTC).
3445
+ #
3446
+ # * Must not conflict with the preferred backup window.
3447
+ #
3448
+ # * Must be at least 30 minutes.
3485
3449
  #
3486
3450
  #
3487
3451
  #
@@ -3490,39 +3454,38 @@ module Aws::RDS
3490
3454
  #
3491
3455
  # @!attribute [rw] db_parameter_group_name
3492
3456
  # The name of the DB parameter group to associate with this DB
3493
- # instance. If you do not specify a value, then the default DB
3494
- # parameter group for the specified DB engine and version is used.
3457
+ # instance. If you don't specify a value, then Amazon RDS uses the
3458
+ # default DB parameter group for the specified DB engine and version.
3495
3459
  #
3496
- # This setting doesn't apply to RDS Custom.
3460
+ # This setting doesn't apply to RDS Custom DB instances.
3497
3461
  #
3498
3462
  # Constraints:
3499
3463
  #
3500
- # * It must be 1 to 255 letters, numbers, or hyphens.
3464
+ # * Must be 1 to 255 letters, numbers, or hyphens.
3501
3465
  #
3502
3466
  # * The first character must be a letter.
3503
3467
  #
3504
- # * It can't end with a hyphen or contain two consecutive hyphens.
3468
+ # * Can't end with a hyphen or contain two consecutive hyphens.
3505
3469
  # @return [String]
3506
3470
  #
3507
3471
  # @!attribute [rw] backup_retention_period
3508
3472
  # The number of days for which automated backups are retained. Setting
3509
3473
  # this parameter to a positive number enables backups. Setting this
3510
- # parameter to 0 disables automated backups.
3511
- #
3512
- # **Amazon Aurora**
3474
+ # parameter to `0` disables automated backups.
3513
3475
  #
3514
- # Not applicable. The retention period for automated backups is
3515
- # managed by the DB cluster.
3476
+ # This setting doesn't apply to Amazon Aurora DB instances. The
3477
+ # retention period for automated backups is managed by the DB cluster.
3516
3478
  #
3517
- # Default: 1
3479
+ # Default: `1`
3518
3480
  #
3519
3481
  # Constraints:
3520
3482
  #
3521
- # * Must be a value from 0 to 35
3483
+ # * Must be a value from 0 to 35.
3522
3484
  #
3523
- # * Can't be set to 0 if the DB instance is a source to read replicas
3485
+ # * Can't be set to 0 if the DB instance is a source to read
3486
+ # replicas.
3524
3487
  #
3525
- # * Can't be set to 0 for an RDS Custom for Oracle DB instance
3488
+ # * Can't be set to 0 for an RDS Custom for Oracle DB instance.
3526
3489
  # @return [Integer]
3527
3490
  #
3528
3491
  # @!attribute [rw] preferred_backup_window
@@ -3533,10 +3496,9 @@ module Aws::RDS
3533
3496
  # more information, see [Backup window][1] in the *Amazon RDS User
3534
3497
  # Guide*.
3535
3498
  #
3536
- # **Amazon Aurora**
3537
- #
3538
- # Not applicable. The daily time range for creating automated backups
3539
- # is managed by the DB cluster.
3499
+ # This setting doesn't apply to Amazon Aurora DB instances. The daily
3500
+ # time range for creating automated backups is managed by the DB
3501
+ # cluster.
3540
3502
  #
3541
3503
  # Constraints:
3542
3504
  #
@@ -3556,68 +3518,51 @@ module Aws::RDS
3556
3518
  # @!attribute [rw] port
3557
3519
  # The port number on which the database accepts connections.
3558
3520
  #
3559
- # **MySQL**
3560
- #
3561
- # Default: `3306`
3562
- #
3563
- # Valid values: `1150-65535`
3564
- #
3565
- # Type: Integer
3566
- #
3567
- # **MariaDB**
3568
- #
3569
- # Default: `3306`
3570
- #
3571
- # Valid values: `1150-65535`
3521
+ # This setting doesn't apply to Aurora DB instances. The port number
3522
+ # is managed by the cluster.
3572
3523
  #
3573
- # Type: Integer
3574
- #
3575
- # **PostgreSQL**
3576
- #
3577
- # Default: `5432`
3578
- #
3579
- # Valid values: `1150-65535`
3580
- #
3581
- # Type: Integer
3582
- #
3583
- # **Oracle**
3524
+ # Valid Values: `1150-65535`
3584
3525
  #
3585
- # Default: `1521`
3526
+ # Default:
3586
3527
  #
3587
- # Valid values: `1150-65535`
3528
+ # * RDS for MariaDB - `3306`
3588
3529
  #
3589
- # **SQL Server**
3530
+ # * RDS for Microsoft SQL Server - `1433`
3590
3531
  #
3591
- # Default: `1433`
3532
+ # * RDS for MySQL - `3306`
3592
3533
  #
3593
- # Valid values: `1150-65535` except `1234`, `1434`, `3260`, `3343`,
3594
- # `3389`, `47001`, and `49152-49156`.
3534
+ # * RDS for Oracle - `1521`
3595
3535
  #
3596
- # **Amazon Aurora**
3536
+ # * RDS for PostgreSQL - `5432`
3597
3537
  #
3598
- # Default: `3306`
3538
+ # Constraints:
3599
3539
  #
3600
- # Valid values: `1150-65535`
3540
+ # * For RDS for Microsoft SQL Server, the value can't be `1234`,
3541
+ # `1434`, `3260`, `3343`, `3389`, `47001`, or `49152-49156`.
3601
3542
  #
3602
- # Type: Integer
3543
+ # ^
3603
3544
  # @return [Integer]
3604
3545
  #
3605
3546
  # @!attribute [rw] multi_az
3606
- # A value that indicates whether the DB instance is a Multi-AZ
3607
- # deployment. You can't set the `AvailabilityZone` parameter if the
3608
- # DB instance is a Multi-AZ deployment.
3547
+ # Specifies whether the DB instance is a Multi-AZ deployment. You
3548
+ # can't set the `AvailabilityZone` parameter if the DB instance is a
3549
+ # Multi-AZ deployment.
3609
3550
  #
3610
- # This setting doesn't apply to RDS Custom.
3551
+ # This setting doesn't apply to the following DB instances:
3611
3552
  #
3612
- # **Amazon Aurora**
3553
+ # * Amazon Aurora (DB instance Availability Zones (AZs) are managed by
3554
+ # the DB cluster.)
3613
3555
  #
3614
- # Not applicable. DB instance Availability Zones (AZs) are managed by
3615
- # the DB cluster.
3556
+ # * RDS Custom
3616
3557
  # @return [Boolean]
3617
3558
  #
3618
3559
  # @!attribute [rw] engine_version
3619
3560
  # The version number of the database engine to use.
3620
3561
  #
3562
+ # This setting doesn't apply to Amazon Aurora DB instances. The
3563
+ # version number of the database engine the DB instance uses is
3564
+ # managed by the DB cluster.
3565
+ #
3621
3566
  # For a list of valid engine versions, use the
3622
3567
  # `DescribeDBEngineVersions` operation.
3623
3568
  #
@@ -3626,48 +3571,37 @@ module Aws::RDS
3626
3571
  # RDS. Not every database engine is available for every Amazon Web
3627
3572
  # Services Region.
3628
3573
  #
3629
- # **Amazon Aurora**
3630
- #
3631
- # Not applicable. The version number of the database engine to be used
3632
- # by the DB instance is managed by the DB cluster.
3633
- #
3634
- # **Amazon RDS Custom for Oracle**
3635
- #
3636
- # A custom engine version (CEV) that you have previously created. This
3637
- # setting is required for RDS Custom for Oracle. The CEV name has the
3638
- # following format: 19.*customized\_string*. A valid CEV name is
3639
- # `19.my_cev1`. For more information, see [ Creating an RDS Custom for
3640
- # Oracle DB instance][1] in the *Amazon RDS User Guide*.
3641
- #
3642
- # **Amazon RDS Custom for SQL Server**
3643
- #
3644
- # See [RDS Custom for SQL Server general requirements][2] in the
3645
- # *Amazon RDS User Guide*.
3646
- #
3647
- # **MariaDB**
3648
- #
3649
- # For information, see [MariaDB on Amazon RDS Versions][3] in the
3650
- # *Amazon RDS User Guide*.
3651
- #
3652
- # **Microsoft SQL Server**
3653
- #
3654
- # For information, see [Microsoft SQL Server Versions on Amazon
3655
- # RDS][4] in the *Amazon RDS User Guide*.
3656
- #
3657
- # **MySQL**
3574
+ # Amazon RDS Custom for Oracle
3575
+ # Amazon RDS Custom for SQL Server
3576
+ # RDS for MariaDB
3577
+ # RDS for Microsoft SQL Server
3578
+ # RDS for MySQL
3579
+ # RDS for Oracle
3580
+ # RDS for PostgreSQL
3581
+ #
3582
+ # : A custom engine version (CEV) that you have previously created.
3583
+ # This setting is required for RDS Custom for Oracle. The CEV name
3584
+ # has the following format: 19.*customized\_string*. A valid CEV
3585
+ # name is `19.my_cev1`. For more information, see [ Creating an RDS
3586
+ # Custom for Oracle DB instance][1] in the *Amazon RDS User Guide*.
3587
+ #
3588
+ # : See [RDS Custom for SQL Server general requirements][2] in the
3589
+ # *Amazon RDS User Guide*.
3658
3590
  #
3659
- # For information, see [MySQL on Amazon RDS Versions][5] in the
3660
- # *Amazon RDS User Guide*.
3591
+ # : For information, see [MariaDB on Amazon RDS versions][3] in the
3592
+ # *Amazon RDS User Guide*.
3661
3593
  #
3662
- # **Oracle**
3594
+ # : For information, see [Microsoft SQL Server versions on Amazon
3595
+ # RDS][4] in the *Amazon RDS User Guide*.
3663
3596
  #
3664
- # For information, see [Oracle Database Engine Release Notes][6] in
3665
- # the *Amazon RDS User Guide*.
3597
+ # : For information, see [MySQL on Amazon RDS versions][5] in the
3598
+ # *Amazon RDS User Guide*.
3666
3599
  #
3667
- # **PostgreSQL**
3600
+ # : For information, see [Oracle Database Engine release notes][6] in
3601
+ # the *Amazon RDS User Guide*.
3668
3602
  #
3669
- # For information, see [Amazon RDS for PostgreSQL versions and
3670
- # extensions][7] in the *Amazon RDS User Guide*.
3603
+ # : For information, see [Amazon RDS for PostgreSQL versions and
3604
+ # extensions][7] in the *Amazon RDS User Guide*.
3671
3605
  #
3672
3606
  #
3673
3607
  #
@@ -3681,41 +3615,50 @@ module Aws::RDS
3681
3615
  # @return [String]
3682
3616
  #
3683
3617
  # @!attribute [rw] auto_minor_version_upgrade
3684
- # A value that indicates whether minor engine upgrades are applied
3685
- # automatically to the DB instance during the maintenance window. By
3686
- # default, minor engine upgrades are applied automatically.
3618
+ # Specifies whether minor engine upgrades are applied automatically to
3619
+ # the DB instance during the maintenance window. By default, minor
3620
+ # engine upgrades are applied automatically.
3687
3621
  #
3688
3622
  # If you create an RDS Custom DB instance, you must set
3689
3623
  # `AutoMinorVersionUpgrade` to `false`.
3690
3624
  # @return [Boolean]
3691
3625
  #
3692
3626
  # @!attribute [rw] license_model
3693
- # License model information for this DB instance.
3627
+ # The license model information for this DB instance.
3694
3628
  #
3695
- # Valid values: `license-included` \| `bring-your-own-license` \|
3696
- # `general-public-license`
3629
+ # This setting doesn't apply to Amazon Aurora or RDS Custom DB
3630
+ # instances.
3697
3631
  #
3698
- # This setting doesn't apply to RDS Custom.
3632
+ # Valid Values:
3633
+ #
3634
+ # * RDS for MariaDB - `general-public-license`
3699
3635
  #
3700
- # **Amazon Aurora**
3636
+ # * RDS for Microsoft SQL Server - `license-included`
3701
3637
  #
3702
- # Not applicable.
3638
+ # * RDS for MySQL - `general-public-license`
3639
+ #
3640
+ # * RDS for Oracle - `bring-your-own-license | license-included`
3641
+ #
3642
+ # * RDS for PostgreSQL - `postgresql-license`
3703
3643
  # @return [String]
3704
3644
  #
3705
3645
  # @!attribute [rw] iops
3706
3646
  # The amount of Provisioned IOPS (input/output operations per second)
3707
- # to be initially allocated for the DB instance. For information about
3647
+ # to initially allocate for the DB instance. For information about
3708
3648
  # valid IOPS values, see [Amazon RDS DB instance storage][1] in the
3709
3649
  # *Amazon RDS User Guide*.
3710
3650
  #
3711
- # Constraints: For MariaDB, MySQL, Oracle, and PostgreSQL DB
3712
- # instances, must be a multiple between .5 and 50 of the storage
3713
- # amount for the DB instance. For SQL Server DB instances, must be a
3714
- # multiple between 1 and 50 of the storage amount for the DB instance.
3651
+ # This setting doesn't apply to Amazon Aurora DB instances. Storage
3652
+ # is managed by the DB cluster.
3653
+ #
3654
+ # Constraints:
3715
3655
  #
3716
- # **Amazon Aurora**
3656
+ # * For RDS for MariaDB, MySQL, Oracle, and PostgreSQL - Must be a
3657
+ # multiple between .5 and 50 of the storage amount for the DB
3658
+ # instance.
3717
3659
  #
3718
- # Not applicable. Storage is managed by the DB cluster.
3660
+ # * For RDS for SQL Server - Must be a multiple between 1 and 50 of
3661
+ # the storage amount for the DB instance.
3719
3662
  #
3720
3663
  #
3721
3664
  #
@@ -3723,43 +3666,38 @@ module Aws::RDS
3723
3666
  # @return [Integer]
3724
3667
  #
3725
3668
  # @!attribute [rw] option_group_name
3726
- # A value that indicates that the DB instance should be associated
3727
- # with the specified option group.
3669
+ # The option group to associate the DB instance with.
3728
3670
  #
3729
3671
  # Permanent options, such as the TDE option for Oracle Advanced
3730
3672
  # Security TDE, can't be removed from an option group. Also, that
3731
3673
  # option group can't be removed from a DB instance after it is
3732
3674
  # associated with a DB instance.
3733
3675
  #
3734
- # This setting doesn't apply to RDS Custom.
3735
- #
3736
- # **Amazon Aurora**
3737
- #
3738
- # Not applicable.
3676
+ # This setting doesn't apply to Amazon Aurora or RDS Custom DB
3677
+ # instances.
3739
3678
  # @return [String]
3740
3679
  #
3741
3680
  # @!attribute [rw] character_set_name
3742
- # For supported engines, this value indicates that the DB instance
3743
- # should be associated with the specified `CharacterSet`.
3681
+ # For supported engines, the character set (`CharacterSet`) to
3682
+ # associate the DB instance with.
3744
3683
  #
3745
- # This setting doesn't apply to RDS Custom. However, if you need to
3746
- # change the character set, you can change it on the database itself.
3684
+ # This setting doesn't apply to the following DB instances:
3747
3685
  #
3748
- # **Amazon Aurora**
3686
+ # * Amazon Aurora - The character set is managed by the DB cluster.
3687
+ # For more information, see `CreateDBCluster`.
3749
3688
  #
3750
- # Not applicable. The character set is managed by the DB cluster. For
3751
- # more information, see `CreateDBCluster`.
3689
+ # * RDS Custom - However, if you need to change the character set, you
3690
+ # can change it on the database itself.
3752
3691
  # @return [String]
3753
3692
  #
3754
3693
  # @!attribute [rw] nchar_character_set_name
3755
3694
  # The name of the NCHAR character set for the Oracle DB instance.
3756
3695
  #
3757
- # This parameter doesn't apply to RDS Custom.
3696
+ # This setting doesn't apply to RDS Custom DB instances.
3758
3697
  # @return [String]
3759
3698
  #
3760
3699
  # @!attribute [rw] publicly_accessible
3761
- # A value that indicates whether the DB instance is publicly
3762
- # accessible.
3700
+ # Specifies whether the DB instance is publicly accessible.
3763
3701
  #
3764
3702
  # When the DB instance is publicly accessible, its Domain Name System
3765
3703
  # (DNS) endpoint resolves to the private IP address from within the DB
@@ -3799,56 +3737,51 @@ module Aws::RDS
3799
3737
  # @return [Array<Types::Tag>]
3800
3738
  #
3801
3739
  # @!attribute [rw] db_cluster_identifier
3802
- # The identifier of the DB cluster that the instance will belong to.
3740
+ # The identifier of the DB cluster that this DB instance will belong
3741
+ # to.
3803
3742
  #
3804
- # This setting doesn't apply to RDS Custom.
3743
+ # This setting doesn't apply to RDS Custom DB instances.
3805
3744
  # @return [String]
3806
3745
  #
3807
3746
  # @!attribute [rw] storage_type
3808
- # Specifies the storage type to be associated with the DB instance.
3809
- #
3810
- # Valid values: `gp2 | gp3 | io1 | standard`
3747
+ # The storage type to associate with the DB instance.
3811
3748
  #
3812
3749
  # If you specify `io1` or `gp3`, you must also include a value for the
3813
3750
  # `Iops` parameter.
3814
3751
  #
3815
- # Default: `io1` if the `Iops` parameter is specified, otherwise `gp2`
3752
+ # This setting doesn't apply to Amazon Aurora DB instances. Storage
3753
+ # is managed by the DB cluster.
3816
3754
  #
3817
- # **Amazon Aurora**
3755
+ # Valid Values: `gp2 | gp3 | io1 | standard`
3818
3756
  #
3819
- # Not applicable. Storage is managed by the DB cluster.
3757
+ # Default: `io1`, if the `Iops` parameter is specified. Otherwise,
3758
+ # `gp2`.
3820
3759
  # @return [String]
3821
3760
  #
3822
3761
  # @!attribute [rw] tde_credential_arn
3823
3762
  # The ARN from the key store with which to associate the instance for
3824
3763
  # TDE encryption.
3825
3764
  #
3826
- # This setting doesn't apply to RDS Custom.
3827
- #
3828
- # **Amazon Aurora**
3829
- #
3830
- # Not applicable.
3765
+ # This setting doesn't apply to Amazon Aurora or RDS Custom DB
3766
+ # instances.
3831
3767
  # @return [String]
3832
3768
  #
3833
3769
  # @!attribute [rw] tde_credential_password
3834
3770
  # The password for the given ARN from the key store in order to access
3835
3771
  # the device.
3836
3772
  #
3837
- # This setting doesn't apply to RDS Custom.
3773
+ # This setting doesn't apply to RDS Custom DB instances.
3838
3774
  # @return [String]
3839
3775
  #
3840
3776
  # @!attribute [rw] storage_encrypted
3841
- # A value that indicates whether the DB instance is encrypted. By
3842
- # default, it isn't encrypted.
3777
+ # Specifes whether the DB instance is encrypted. By default, it isn't
3778
+ # encrypted.
3843
3779
  #
3844
- # For RDS Custom instances, either set this parameter to `true` or
3845
- # leave it unset. If you set this parameter to `false`, RDS reports an
3846
- # error.
3780
+ # For RDS Custom DB instances, either enable this setting or leave it
3781
+ # unset. Otherwise, Amazon RDS reports an error.
3847
3782
  #
3848
- # **Amazon Aurora**
3849
- #
3850
- # Not applicable. The encryption for DB instances is managed by the DB
3851
- # cluster.
3783
+ # This setting doesn't apply to Amazon Aurora DB instances. The
3784
+ # encryption for DB instances is managed by the DB cluster.
3852
3785
  # @return [Boolean]
3853
3786
  #
3854
3787
  # @!attribute [rw] kms_key_id
@@ -3860,11 +3793,9 @@ module Aws::RDS
3860
3793
  # different Amazon Web Services account, specify the key ARN or alias
3861
3794
  # ARN.
3862
3795
  #
3863
- # **Amazon Aurora**
3864
- #
3865
- # Not applicable. The Amazon Web Services KMS key identifier is
3866
- # managed by the DB cluster. For more information, see
3867
- # `CreateDBCluster`.
3796
+ # This setting doesn't apply to Amazon Aurora DB instances. The
3797
+ # Amazon Web Services KMS key identifier is managed by the DB cluster.
3798
+ # For more information, see `CreateDBCluster`.
3868
3799
  #
3869
3800
  # If `StorageEncrypted` is enabled, and you do not specify a value for
3870
3801
  # the `KmsKeyId` parameter, then Amazon RDS uses your default KMS key.
@@ -3872,10 +3803,8 @@ module Aws::RDS
3872
3803
  # Your Amazon Web Services account has a different default KMS key for
3873
3804
  # each Amazon Web Services Region.
3874
3805
  #
3875
- # **Amazon RDS Custom**
3876
- #
3877
- # A KMS key is required for RDS Custom instances. For most RDS
3878
- # engines, if you leave this parameter empty while enabling
3806
+ # For Amazon RDS Custom, a KMS key is required for DB instances. For
3807
+ # most RDS engines, if you leave this parameter empty while enabling
3879
3808
  # `StorageEncrypted`, the engine uses the default KMS key. However,
3880
3809
  # RDS Custom doesn't use the default key when this parameter is
3881
3810
  # empty. You must explicitly specify a key.
@@ -3883,17 +3812,17 @@ module Aws::RDS
3883
3812
  #
3884
3813
  # @!attribute [rw] domain
3885
3814
  # The Active Directory directory ID to create the DB instance in.
3886
- # Currently, only MySQL, Microsoft SQL Server, Oracle, and PostgreSQL
3815
+ # Currently, only Microsoft SQL Server, MySQL, Oracle, and PostgreSQL
3887
3816
  # DB instances can be created in an Active Directory Domain.
3888
3817
  #
3889
3818
  # For more information, see [ Kerberos Authentication][1] in the
3890
3819
  # *Amazon RDS User Guide*.
3891
3820
  #
3892
- # This setting doesn't apply to RDS Custom.
3821
+ # This setting doesn't apply to the following DB instances:
3893
3822
  #
3894
- # **Amazon Aurora**
3823
+ # * Amazon Aurora (The domain is managed by the DB cluster.)
3895
3824
  #
3896
- # Not applicable. The domain is managed by the DB cluster.
3825
+ # * RDS Custom
3897
3826
  #
3898
3827
  #
3899
3828
  #
@@ -3901,27 +3830,27 @@ module Aws::RDS
3901
3830
  # @return [String]
3902
3831
  #
3903
3832
  # @!attribute [rw] copy_tags_to_snapshot
3904
- # A value that indicates whether to copy tags from the DB instance to
3905
- # snapshots of the DB instance. By default, tags are not copied.
3833
+ # Spcifies whether to copy tags from the DB instance to snapshots of
3834
+ # the DB instance. By default, tags are not copied.
3906
3835
  #
3907
- # **Amazon Aurora**
3908
- #
3909
- # Not applicable. Copying tags to snapshots is managed by the DB
3910
- # cluster. Setting this value for an Aurora DB instance has no effect
3911
- # on the DB cluster setting.
3836
+ # This setting doesn't apply to Amazon Aurora DB instances. Copying
3837
+ # tags to snapshots is managed by the DB cluster. Setting this value
3838
+ # for an Aurora DB instance has no effect on the DB cluster setting.
3912
3839
  # @return [Boolean]
3913
3840
  #
3914
3841
  # @!attribute [rw] monitoring_interval
3915
3842
  # The interval, in seconds, between points when Enhanced Monitoring
3916
3843
  # metrics are collected for the DB instance. To disable collection of
3917
- # Enhanced Monitoring metrics, specify 0. The default is 0.
3844
+ # Enhanced Monitoring metrics, specify `0`.
3918
3845
  #
3919
3846
  # If `MonitoringRoleArn` is specified, then you must set
3920
- # `MonitoringInterval` to a value other than 0.
3847
+ # `MonitoringInterval` to a value other than `0`.
3921
3848
  #
3922
- # This setting doesn't apply to RDS Custom.
3849
+ # This setting doesn't apply to RDS Custom DB instances.
3923
3850
  #
3924
- # Valid Values: `0, 1, 5, 10, 15, 30, 60`
3851
+ # Valid Values: `0 | 1 | 5 | 10 | 15 | 30 | 60`
3852
+ #
3853
+ # Default: `0`
3925
3854
  # @return [Integer]
3926
3855
  #
3927
3856
  # @!attribute [rw] monitoring_role_arn
@@ -3931,10 +3860,10 @@ module Aws::RDS
3931
3860
  # creating a monitoring role, see [Setting Up and Enabling Enhanced
3932
3861
  # Monitoring][1] in the *Amazon RDS User Guide*.
3933
3862
  #
3934
- # If `MonitoringInterval` is set to a value other than 0, then you
3863
+ # If `MonitoringInterval` is set to a value other than `0`, then you
3935
3864
  # must supply a `MonitoringRoleArn` value.
3936
3865
  #
3937
- # This setting doesn't apply to RDS Custom.
3866
+ # This setting doesn't apply to RDS Custom DB instances.
3938
3867
  #
3939
3868
  #
3940
3869
  #
@@ -3942,31 +3871,31 @@ module Aws::RDS
3942
3871
  # @return [String]
3943
3872
  #
3944
3873
  # @!attribute [rw] domain_iam_role_name
3945
- # Specify the name of the IAM role to be used when making API calls to
3946
- # the Directory Service.
3874
+ # The name of the IAM role to use when making API calls to the
3875
+ # Directory Service.
3947
3876
  #
3948
- # This setting doesn't apply to RDS Custom.
3877
+ # This setting doesn't apply to the following DB instances:
3949
3878
  #
3950
- # **Amazon Aurora**
3879
+ # * Amazon Aurora (The domain is managed by the DB cluster.)
3951
3880
  #
3952
- # Not applicable. The domain is managed by the DB cluster.
3881
+ # * RDS Custom
3953
3882
  # @return [String]
3954
3883
  #
3955
3884
  # @!attribute [rw] promotion_tier
3956
- # A value that specifies the order in which an Aurora Replica is
3957
- # promoted to the primary instance after a failure of the existing
3958
- # primary instance. For more information, see [ Fault Tolerance for an
3959
- # Aurora DB Cluster][1] in the *Amazon Aurora User Guide*.
3885
+ # The order of priority in which an Aurora Replica is promoted to the
3886
+ # primary instance after a failure of the existing primary instance.
3887
+ # For more information, see [ Fault Tolerance for an Aurora DB
3888
+ # Cluster][1] in the *Amazon Aurora User Guide*.
3960
3889
  #
3961
- # This setting doesn't apply to RDS Custom.
3890
+ # This setting doesn't apply to RDS Custom DB instances.
3962
3891
  #
3963
- # Default: 1
3892
+ # Default: `1`
3964
3893
  #
3965
- # Valid Values: 0 - 15
3894
+ # Valid Values: `0 - 15`
3966
3895
  #
3967
3896
  #
3968
3897
  #
3969
- # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Managing.Backups.html#Aurora.Managing.FaultTolerance
3898
+ # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Concepts.AuroraHighAvailability.html#Aurora.Managing.FaultTolerance
3970
3899
  # @return [Integer]
3971
3900
  #
3972
3901
  # @!attribute [rw] timezone
@@ -3979,19 +3908,19 @@ module Aws::RDS
3979
3908
  # @return [String]
3980
3909
  #
3981
3910
  # @!attribute [rw] enable_iam_database_authentication
3982
- # A value that indicates whether to enable mapping of Amazon Web
3983
- # Services Identity and Access Management (IAM) accounts to database
3984
- # accounts. By default, mapping isn't enabled.
3911
+ # Specifies whether to enable mapping of Amazon Web Services Identity
3912
+ # and Access Management (IAM) accounts to database accounts. By
3913
+ # default, mapping isn't enabled.
3985
3914
  #
3986
3915
  # For more information, see [ IAM Database Authentication for MySQL
3987
3916
  # and PostgreSQL][1] in the *Amazon RDS User Guide*.
3988
3917
  #
3989
- # This setting doesn't apply to RDS Custom.
3918
+ # This setting doesn't apply to the following DB instances:
3990
3919
  #
3991
- # **Amazon Aurora**
3920
+ # * Amazon Aurora (Mapping Amazon Web Services IAM accounts to
3921
+ # database accounts is managed by the DB cluster.)
3992
3922
  #
3993
- # Not applicable. Mapping Amazon Web Services IAM accounts to database
3994
- # accounts is managed by the DB cluster.
3923
+ # * RDS Custom
3995
3924
  #
3996
3925
  #
3997
3926
  #
@@ -3999,11 +3928,11 @@ module Aws::RDS
3999
3928
  # @return [Boolean]
4000
3929
  #
4001
3930
  # @!attribute [rw] enable_performance_insights
4002
- # A value that indicates whether to enable Performance Insights for
4003
- # the DB instance. For more information, see [Using Amazon Performance
3931
+ # Specifies whether to enable Performance Insights for the DB
3932
+ # instance. For more information, see [Using Amazon Performance
4004
3933
  # Insights][1] in the *Amazon RDS User Guide*.
4005
3934
  #
4006
- # This setting doesn't apply to RDS Custom.
3935
+ # This setting doesn't apply to RDS Custom DB instances.
4007
3936
  #
4008
3937
  #
4009
3938
  #
@@ -4017,76 +3946,59 @@ module Aws::RDS
4017
3946
  # The Amazon Web Services KMS key identifier is the key ARN, key ID,
4018
3947
  # alias ARN, or alias name for the KMS key.
4019
3948
  #
4020
- # If you do not specify a value for `PerformanceInsightsKMSKeyId`,
3949
+ # If you don't specify a value for `PerformanceInsightsKMSKeyId`,
4021
3950
  # then Amazon RDS uses your default KMS key. There is a default KMS
4022
3951
  # key for your Amazon Web Services account. Your Amazon Web Services
4023
3952
  # account has a different default KMS key for each Amazon Web Services
4024
3953
  # Region.
4025
3954
  #
4026
- # This setting doesn't apply to RDS Custom.
3955
+ # This setting doesn't apply to RDS Custom DB instances.
4027
3956
  # @return [String]
4028
3957
  #
4029
3958
  # @!attribute [rw] performance_insights_retention_period
4030
- # The number of days to retain Performance Insights data. The default
4031
- # is 7 days. The following values are valid:
4032
- #
4033
- # * 7
4034
- #
4035
- # * *month* * 31, where *month* is a number of months from 1-23
4036
- #
4037
- # * 731
3959
+ # The number of days to retain Performance Insights data.
4038
3960
  #
4039
- # For example, the following values are valid:
3961
+ # This setting doesn't apply to RDS Custom DB instances.
4040
3962
  #
4041
- # * 93 (3 months * 31)
3963
+ # Valid Values:
4042
3964
  #
4043
- # * 341 (11 months * 31)
3965
+ # * `7`
4044
3966
  #
4045
- # * 589 (19 months * 31)
3967
+ # * *month* * 31, where *month* is a number of months from 1-23.
3968
+ # Examples: `93` (3 months * 31), `341` (11 months * 31), `589`
3969
+ # (19 months * 31)
4046
3970
  #
4047
- # * 731
3971
+ # * `731`
4048
3972
  #
4049
- # If you specify a retention period such as 94, which isn't a valid
4050
- # value, RDS issues an error.
3973
+ # Default: `7` days
4051
3974
  #
4052
- # This setting doesn't apply to RDS Custom.
3975
+ # If you specify a retention period that isn't valid, such as `94`,
3976
+ # Amazon RDS returns an error.
4053
3977
  # @return [Integer]
4054
3978
  #
4055
3979
  # @!attribute [rw] enable_cloudwatch_logs_exports
4056
3980
  # The list of log types that need to be enabled for exporting to
4057
- # CloudWatch Logs. The values in the list depend on the DB engine. For
4058
- # more information, see [ Publishing Database Logs to Amazon
4059
- # CloudWatch Logs][1] in the *Amazon RDS User Guide*.
4060
- #
4061
- # **Amazon Aurora**
4062
- #
4063
- # Not applicable. CloudWatch Logs exports are managed by the DB
4064
- # cluster.
4065
- #
4066
- # **RDS Custom**
3981
+ # CloudWatch Logs. For more information, see [ Publishing Database
3982
+ # Logs to Amazon CloudWatch Logs][1] in the *Amazon RDS User Guide*.
4067
3983
  #
4068
- # Not applicable.
3984
+ # This setting doesn't apply to the following DB instances:
4069
3985
  #
4070
- # **MariaDB**
4071
- #
4072
- # Possible values are `audit`, `error`, `general`, and `slowquery`.
4073
- #
4074
- # **Microsoft SQL Server**
3986
+ # * Amazon Aurora (CloudWatch Logs exports are managed by the DB
3987
+ # cluster.)
4075
3988
  #
4076
- # Possible values are `agent` and `error`.
3989
+ # * RDS Custom
4077
3990
  #
4078
- # **MySQL**
3991
+ # The following values are valid for each DB engine:
4079
3992
  #
4080
- # Possible values are `audit`, `error`, `general`, and `slowquery`.
3993
+ # * RDS for MariaDB - `audit | error | general | slowquery`
4081
3994
  #
4082
- # **Oracle**
3995
+ # * RDS for Microsoft SQL Server - `agent | error`
4083
3996
  #
4084
- # Possible values are `alert`, `audit`, `listener`, `trace`, and
4085
- # `oemagent`.
3997
+ # * RDS for MySQL - `audit | error | general | slowquery`
4086
3998
  #
4087
- # **PostgreSQL**
3999
+ # * RDS for Oracle - `alert | audit | listener | trace | oemagent`
4088
4000
  #
4089
- # Possible values are `postgresql` and `upgrade`.
4001
+ # * RDS for PostgreSQL - `postgresql | upgrade`
4090
4002
  #
4091
4003
  #
4092
4004
  #
@@ -4097,25 +4009,21 @@ module Aws::RDS
4097
4009
  # The number of CPU cores and the number of threads per core for the
4098
4010
  # DB instance class of the DB instance.
4099
4011
  #
4100
- # This setting doesn't apply to RDS Custom.
4101
- #
4102
- # **Amazon Aurora**
4103
- #
4104
- # Not applicable.
4012
+ # This setting doesn't apply to Amazon Aurora or RDS Custom DB
4013
+ # instances.
4105
4014
  # @return [Array<Types::ProcessorFeature>]
4106
4015
  #
4107
4016
  # @!attribute [rw] deletion_protection
4108
- # A value that indicates whether the DB instance has deletion
4109
- # protection enabled. The database can't be deleted when deletion
4110
- # protection is enabled. By default, deletion protection isn't
4111
- # enabled. For more information, see [ Deleting a DB Instance][1].
4112
- #
4113
- # **Amazon Aurora**
4114
- #
4115
- # Not applicable. You can enable or disable deletion protection for
4116
- # the DB cluster. For more information, see `CreateDBCluster`. DB
4117
- # instances in a DB cluster can be deleted even when deletion
4118
- # protection is enabled for the DB cluster.
4017
+ # Specifies whether the DB instance has deletion protection enabled.
4018
+ # The database can't be deleted when deletion protection is enabled.
4019
+ # By default, deletion protection isn't enabled. For more
4020
+ # information, see [ Deleting a DB Instance][1].
4021
+ #
4022
+ # This setting doesn't apply to Amazon Aurora DB instances. You can
4023
+ # enable or disable deletion protection for the DB cluster. For more
4024
+ # information, see `CreateDBCluster`. DB instances in a DB cluster can
4025
+ # be deleted even when deletion protection is enabled for the DB
4026
+ # cluster.
4119
4027
  #
4120
4028
  #
4121
4029
  #
@@ -4130,11 +4038,11 @@ module Aws::RDS
4130
4038
  # apply to it, see [ Managing capacity automatically with Amazon RDS
4131
4039
  # storage autoscaling][1] in the *Amazon RDS User Guide*.
4132
4040
  #
4133
- # This setting doesn't apply to RDS Custom.
4041
+ # This setting doesn't apply to the following DB instances:
4134
4042
  #
4135
- # **Amazon Aurora**
4043
+ # * Amazon Aurora (Storage is managed by the DB cluster.)
4136
4044
  #
4137
- # Not applicable. Storage is managed by the DB cluster.
4045
+ # * RDS Custom
4138
4046
  #
4139
4047
  #
4140
4048
  #
@@ -4142,8 +4050,8 @@ module Aws::RDS
4142
4050
  # @return [Integer]
4143
4051
  #
4144
4052
  # @!attribute [rw] enable_customer_owned_ip
4145
- # A value that indicates whether to enable a customer-owned IP address
4146
- # (CoIP) for an RDS on Outposts DB instance.
4053
+ # Specifies whether to enable a customer-owned IP address (CoIP) for
4054
+ # an RDS on Outposts DB instance.
4147
4055
  #
4148
4056
  # A *CoIP* provides local or external connectivity to resources in
4149
4057
  # your Outpost subnets through your on-premises network. For some use
@@ -4166,8 +4074,11 @@ module Aws::RDS
4166
4074
  #
4167
4075
  # @!attribute [rw] custom_iam_instance_profile
4168
4076
  # The instance profile associated with the underlying Amazon EC2
4169
- # instance of an RDS Custom DB instance. The instance profile must
4170
- # meet the following requirements:
4077
+ # instance of an RDS Custom DB instance.
4078
+ #
4079
+ # This setting is required for RDS Custom.
4080
+ #
4081
+ # Constraints:
4171
4082
  #
4172
4083
  # * The profile must exist in your account.
4173
4084
  #
@@ -4180,18 +4091,21 @@ module Aws::RDS
4180
4091
  # For the list of permissions required for the IAM role, see [
4181
4092
  # Configure IAM and your VPC][1] in the *Amazon RDS User Guide*.
4182
4093
  #
4183
- # This setting is required for RDS Custom.
4184
- #
4185
4094
  #
4186
4095
  #
4187
4096
  # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-setup-orcl.html#custom-setup-orcl.iam-vpc
4188
4097
  # @return [String]
4189
4098
  #
4190
4099
  # @!attribute [rw] backup_target
4191
- # Specifies where automated backups and manual snapshots are stored.
4100
+ # The location for storing automated backups and manual snapshots.
4192
4101
  #
4193
- # Possible values are `outposts` (Amazon Web Services Outposts) and
4194
- # `region` (Amazon Web Services Region). The default is `region`.
4102
+ # Valie Values:
4103
+ #
4104
+ # * `outposts` (Amazon Web Services Outposts)
4105
+ #
4106
+ # * `region` (Amazon Web Services Region)
4107
+ #
4108
+ # Default: `region`
4195
4109
  #
4196
4110
  # For more information, see [Working with Amazon RDS on Amazon Web
4197
4111
  # Services Outposts][1] in the *Amazon RDS User Guide*.
@@ -4204,12 +4118,6 @@ module Aws::RDS
4204
4118
  # @!attribute [rw] network_type
4205
4119
  # The network type of the DB instance.
4206
4120
  #
4207
- # Valid values:
4208
- #
4209
- # * `IPV4`
4210
- #
4211
- # * `DUAL`
4212
- #
4213
4121
  # The network type is determined by the `DBSubnetGroup` specified for
4214
4122
  # the DB instance. A `DBSubnetGroup` can support only the IPv4
4215
4123
  # protocol or the IPv4 and the IPv6 protocols (`DUAL`).
@@ -4217,22 +4125,25 @@ module Aws::RDS
4217
4125
  # For more information, see [ Working with a DB instance in a VPC][1]
4218
4126
  # in the *Amazon RDS User Guide.*
4219
4127
  #
4128
+ # Valid Values: `IPV4 | DUAL`
4129
+ #
4220
4130
  #
4221
4131
  #
4222
4132
  # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html
4223
4133
  # @return [String]
4224
4134
  #
4225
4135
  # @!attribute [rw] storage_throughput
4226
- # Specifies the storage throughput value for the DB instance.
4136
+ # The storage throughput value for the DB instance.
4227
4137
  #
4228
4138
  # This setting applies only to the `gp3` storage type.
4229
4139
  #
4230
- # This setting doesn't apply to RDS Custom or Amazon Aurora.
4140
+ # This setting doesn't apply to Amazon Aurora or RDS Custom DB
4141
+ # instances.
4231
4142
  # @return [Integer]
4232
4143
  #
4233
4144
  # @!attribute [rw] manage_master_user_password
4234
- # A value that indicates whether to manage the master user password
4235
- # with Amazon Web Services Secrets Manager.
4145
+ # Specifies whether to manage the master user password with Amazon Web
4146
+ # Services Secrets Manager.
4236
4147
  #
4237
4148
  # For more information, see [Password management with Amazon Web
4238
4149
  # Services Secrets Manager][1] in the *Amazon RDS User Guide.*
@@ -4274,10 +4185,10 @@ module Aws::RDS
4274
4185
  # @return [String]
4275
4186
  #
4276
4187
  # @!attribute [rw] ca_certificate_identifier
4277
- # Specifies the CA certificate identifier to use for the DB instances
4278
- # server certificate.
4188
+ # The CA certificate identifier to use for the DB instance's server
4189
+ # certificate.
4279
4190
  #
4280
- # This setting doesn't apply to RDS Custom.
4191
+ # This setting doesn't apply to RDS Custom DB instances.
4281
4192
  #
4282
4193
  # For more information, see [Using SSL/TLS to encrypt a connection to
4283
4194
  # a DB instance][1] in the *Amazon RDS User Guide* and [ Using SSL/TLS
@@ -5836,13 +5747,12 @@ module Aws::RDS
5836
5747
  # @return [Integer]
5837
5748
  #
5838
5749
  # @!attribute [rw] availability_zones
5839
- # Provides the list of Availability Zones (AZs) where instances in the
5840
- # DB cluster can be created.
5750
+ # The list of Availability Zones (AZs) where instances in the DB
5751
+ # cluster can be created.
5841
5752
  # @return [Array<String>]
5842
5753
  #
5843
5754
  # @!attribute [rw] backup_retention_period
5844
- # Specifies the number of days for which automatic DB snapshots are
5845
- # retained.
5755
+ # The number of days for which automatic DB snapshots are retained.
5846
5756
  # @return [Integer]
5847
5757
  #
5848
5758
  # @!attribute [rw] character_set_name
@@ -5851,30 +5761,27 @@ module Aws::RDS
5851
5761
  # @return [String]
5852
5762
  #
5853
5763
  # @!attribute [rw] database_name
5854
- # Contains the name of the initial database of this DB cluster that
5855
- # was provided at create time, if one was specified when the DB
5856
- # cluster was created. This same name is returned for the life of the
5857
- # DB cluster.
5764
+ # The name of the initial database that was specified for the DB
5765
+ # cluster when it was created, if one was provided. This same name is
5766
+ # returned for the life of the DB cluster.
5858
5767
  # @return [String]
5859
5768
  #
5860
5769
  # @!attribute [rw] db_cluster_identifier
5861
- # Contains a user-supplied DB cluster identifier. This identifier is
5770
+ # The user-supplied identifier for the DB cluster. This identifier is
5862
5771
  # the unique key that identifies a DB cluster.
5863
5772
  # @return [String]
5864
5773
  #
5865
5774
  # @!attribute [rw] db_cluster_parameter_group
5866
- # Specifies the name of the DB cluster parameter group for the DB
5867
- # cluster.
5775
+ # The name of the DB cluster parameter group for the DB cluster.
5868
5776
  # @return [String]
5869
5777
  #
5870
5778
  # @!attribute [rw] db_subnet_group
5871
- # Specifies information on the subnet group associated with the DB
5872
- # cluster, including the name, description, and subnets in the subnet
5873
- # group.
5779
+ # Information about the subnet group associated with the DB cluster,
5780
+ # including the name, description, and subnets in the subnet group.
5874
5781
  # @return [String]
5875
5782
  #
5876
5783
  # @!attribute [rw] status
5877
- # Specifies the current state of this DB cluster.
5784
+ # The current state of this DB cluster.
5878
5785
  # @return [String]
5879
5786
  #
5880
5787
  # @!attribute [rw] automatic_restart_time
@@ -5882,7 +5789,7 @@ module Aws::RDS
5882
5789
  # @return [Time]
5883
5790
  #
5884
5791
  # @!attribute [rw] percent_progress
5885
- # Specifies the progress of the operation as a percentage.
5792
+ # The progress of the operation as a percentage.
5886
5793
  # @return [String]
5887
5794
  #
5888
5795
  # @!attribute [rw] earliest_restorable_time
@@ -5891,8 +5798,7 @@ module Aws::RDS
5891
5798
  # @return [Time]
5892
5799
  #
5893
5800
  # @!attribute [rw] endpoint
5894
- # Specifies the connection endpoint for the primary instance of the DB
5895
- # cluster.
5801
+ # The connection endpoint for the primary instance of the DB cluster.
5896
5802
  # @return [String]
5897
5803
  #
5898
5804
  # @!attribute [rw] reader_endpoint
@@ -5912,53 +5818,53 @@ module Aws::RDS
5912
5818
  # @return [String]
5913
5819
  #
5914
5820
  # @!attribute [rw] custom_endpoints
5915
- # Identifies all custom endpoints associated with the cluster.
5821
+ # The custom endpoints associated with the DB cluster.
5916
5822
  # @return [Array<String>]
5917
5823
  #
5918
5824
  # @!attribute [rw] multi_az
5919
- # Specifies whether the DB cluster has instances in multiple
5825
+ # Indicates whether the DB cluster has instances in multiple
5920
5826
  # Availability Zones.
5921
5827
  # @return [Boolean]
5922
5828
  #
5923
5829
  # @!attribute [rw] engine
5924
- # The name of the database engine to be used for this DB cluster.
5830
+ # The database engine used for this DB cluster.
5925
5831
  # @return [String]
5926
5832
  #
5927
5833
  # @!attribute [rw] engine_version
5928
- # Indicates the database engine version.
5834
+ # The version of the database engine.
5929
5835
  # @return [String]
5930
5836
  #
5931
5837
  # @!attribute [rw] latest_restorable_time
5932
- # Specifies the latest time to which a database can be restored with
5838
+ # The latest time to which a database can be restored with
5933
5839
  # point-in-time restore.
5934
5840
  # @return [Time]
5935
5841
  #
5936
5842
  # @!attribute [rw] port
5937
- # Specifies the port that the database engine is listening on.
5843
+ # The port that the database engine is listening on.
5938
5844
  # @return [Integer]
5939
5845
  #
5940
5846
  # @!attribute [rw] master_username
5941
- # Contains the master username for the DB cluster.
5847
+ # The master username for the DB cluster.
5942
5848
  # @return [String]
5943
5849
  #
5944
5850
  # @!attribute [rw] db_cluster_option_group_memberships
5945
- # Provides the list of option group memberships for this DB cluster.
5851
+ # The list of option group memberships for this DB cluster.
5946
5852
  # @return [Array<Types::DBClusterOptionGroupStatus>]
5947
5853
  #
5948
5854
  # @!attribute [rw] preferred_backup_window
5949
- # Specifies the daily time range during which automated backups are
5950
- # created if automated backups are enabled, as determined by the
5855
+ # The daily time range during which automated backups are created if
5856
+ # automated backups are enabled, as determined by the
5951
5857
  # `BackupRetentionPeriod`.
5952
5858
  # @return [String]
5953
5859
  #
5954
5860
  # @!attribute [rw] preferred_maintenance_window
5955
- # Specifies the weekly time range during which system maintenance can
5956
- # occur, in Universal Coordinated Time (UTC).
5861
+ # The weekly time range during which system maintenance can occur, in
5862
+ # Universal Coordinated Time (UTC).
5957
5863
  # @return [String]
5958
5864
  #
5959
5865
  # @!attribute [rw] replication_source_identifier
5960
- # Contains the identifier of the source DB cluster if this DB cluster
5961
- # is a read replica.
5866
+ # The identifier of the source DB cluster if this DB cluster is a read
5867
+ # replica.
5962
5868
  # @return [String]
5963
5869
  #
5964
5870
  # @!attribute [rw] read_replica_identifiers
@@ -5967,21 +5873,19 @@ module Aws::RDS
5967
5873
  # @return [Array<String>]
5968
5874
  #
5969
5875
  # @!attribute [rw] db_cluster_members
5970
- # Provides the list of instances that make up the DB cluster.
5876
+ # The list of DB instances that make up the DB cluster.
5971
5877
  # @return [Array<Types::DBClusterMember>]
5972
5878
  #
5973
5879
  # @!attribute [rw] vpc_security_groups
5974
- # Provides a list of VPC security groups that the DB cluster belongs
5975
- # to.
5880
+ # The list of VPC security groups that the DB cluster belongs to.
5976
5881
  # @return [Array<Types::VpcSecurityGroupMembership>]
5977
5882
  #
5978
5883
  # @!attribute [rw] hosted_zone_id
5979
- # Specifies the ID that Amazon Route 53 assigns when you create a
5980
- # hosted zone.
5884
+ # The ID that Amazon Route 53 assigns when you create a hosted zone.
5981
5885
  # @return [String]
5982
5886
  #
5983
5887
  # @!attribute [rw] storage_encrypted
5984
- # Specifies whether the DB cluster is encrypted.
5888
+ # Indicates whether the DB cluster is encrypted.
5985
5889
  # @return [Boolean]
5986
5890
  #
5987
5891
  # @!attribute [rw] kms_key_id
@@ -6004,25 +5908,24 @@ module Aws::RDS
6004
5908
  # @return [String]
6005
5909
  #
6006
5910
  # @!attribute [rw] associated_roles
6007
- # Provides a list of the Amazon Web Services Identity and Access
6008
- # Management (IAM) roles that are associated with the DB cluster. IAM
6009
- # roles that are associated with a DB cluster grant permission for the
6010
- # DB cluster to access other Amazon Web Services on your behalf.
5911
+ # A list of the Amazon Web Services Identity and Access Management
5912
+ # (IAM) roles that are associated with the DB cluster. IAM roles that
5913
+ # are associated with a DB cluster grant permission for the DB cluster
5914
+ # to access other Amazon Web Services on your behalf.
6011
5915
  # @return [Array<Types::DBClusterRole>]
6012
5916
  #
6013
5917
  # @!attribute [rw] iam_database_authentication_enabled
6014
- # A value that indicates whether the mapping of Amazon Web Services
6015
- # Identity and Access Management (IAM) accounts to database accounts
6016
- # is enabled.
5918
+ # Indicates whether the mapping of Amazon Web Services Identity and
5919
+ # Access Management (IAM) accounts to database accounts is enabled.
6017
5920
  # @return [Boolean]
6018
5921
  #
6019
5922
  # @!attribute [rw] clone_group_id
6020
- # Identifies the clone group to which the DB cluster is associated.
5923
+ # The ID of the clone group with which the DB cluster is associated.
6021
5924
  # @return [String]
6022
5925
  #
6023
5926
  # @!attribute [rw] cluster_create_time
6024
- # Specifies the time when the DB cluster was created, in Universal
6025
- # Coordinated Time (UTC).
5927
+ # The time when the DB cluster was created, in Universal Coordinated
5928
+ # Time (UTC).
6026
5929
  # @return [Time]
6027
5930
  #
6028
5931
  # @!attribute [rw] earliest_backtrack_time
@@ -6030,9 +5933,9 @@ module Aws::RDS
6030
5933
  # @return [Time]
6031
5934
  #
6032
5935
  # @!attribute [rw] backtrack_window
6033
- # The target backtrack window, in seconds. If this value is set to 0,
6034
- # backtracking is disabled for the DB cluster. Otherwise, backtracking
6035
- # is enabled.
5936
+ # The target backtrack window, in seconds. If this value is set to
5937
+ # `0`, backtracking is disabled for the DB cluster. Otherwise,
5938
+ # backtracking is enabled.
6036
5939
  # @return [Integer]
6037
5940
  #
6038
5941
  # @!attribute [rw] backtrack_consumed_change_records
@@ -6054,7 +5957,7 @@ module Aws::RDS
6054
5957
  #
6055
5958
  # @!attribute [rw] capacity
6056
5959
  # The current capacity of an Aurora Serverless v1 DB cluster. The
6057
- # capacity is 0 (zero) when the cluster is paused.
5960
+ # capacity is `0` (zero) when the cluster is paused.
6058
5961
  #
6059
5962
  # For more information about Aurora Serverless v1, see [Using Amazon
6060
5963
  # Aurora Serverless v1][1] in the *Amazon Aurora User Guide*.
@@ -6076,8 +5979,8 @@ module Aws::RDS
6076
5979
  # @return [String]
6077
5980
  #
6078
5981
  # @!attribute [rw] scaling_configuration_info
6079
- # Shows the scaling configuration for an Aurora DB cluster in
6080
- # `serverless` DB engine mode.
5982
+ # The scaling configuration for an Aurora DB cluster in `serverless`
5983
+ # DB engine mode.
6081
5984
  #
6082
5985
  # For more information, see [Using Amazon Aurora Serverless v1][1] in
6083
5986
  # the *Amazon Aurora User Guide*.
@@ -6088,13 +5991,13 @@ module Aws::RDS
6088
5991
  # @return [Types::ScalingConfigurationInfo]
6089
5992
  #
6090
5993
  # @!attribute [rw] deletion_protection
6091
- # Indicates if the DB cluster has deletion protection enabled. The
6092
- # database can't be deleted when deletion protection is enabled.
5994
+ # Indicates whether the DB cluster has deletion protection enabled.
5995
+ # The database can't be deleted when deletion protection is enabled.
6093
5996
  # @return [Boolean]
6094
5997
  #
6095
5998
  # @!attribute [rw] http_endpoint_enabled
6096
- # A value that indicates whether the HTTP endpoint for an Aurora
6097
- # Serverless v1 DB cluster is enabled.
5999
+ # Indicates whether the HTTP endpoint for an Aurora Serverless v1 DB
6000
+ # cluster is enabled.
6098
6001
  #
6099
6002
  # When enabled, the HTTP endpoint provides a connectionless web
6100
6003
  # service API for running SQL queries on the Aurora Serverless v1 DB
@@ -6134,12 +6037,12 @@ module Aws::RDS
6134
6037
  # @return [String]
6135
6038
  #
6136
6039
  # @!attribute [rw] copy_tags_to_snapshot
6137
- # Specifies whether tags are copied from the DB cluster to snapshots
6040
+ # Indicates whether tags are copied from the DB cluster to snapshots
6138
6041
  # of the DB cluster.
6139
6042
  # @return [Boolean]
6140
6043
  #
6141
6044
  # @!attribute [rw] cross_account_clone
6142
- # Specifies whether the DB cluster is a clone of a DB cluster owned by
6045
+ # Indicates whether the DB cluster is a clone of a DB cluster owned by
6143
6046
  # a different Amazon Web Services account.
6144
6047
  # @return [Boolean]
6145
6048
  #
@@ -6158,24 +6061,22 @@ module Aws::RDS
6158
6061
  # @return [Array<Types::Tag>]
6159
6062
  #
6160
6063
  # @!attribute [rw] global_write_forwarding_status
6161
- # Specifies whether a secondary cluster in an Aurora global database
6162
- # has write forwarding enabled, not enabled, or is in the process of
6163
- # enabling it.
6064
+ # The status of write forwarding for a secondary cluster in an Aurora
6065
+ # global database.
6164
6066
  # @return [String]
6165
6067
  #
6166
6068
  # @!attribute [rw] global_write_forwarding_requested
6167
- # Specifies whether you have requested to enable write forwarding for
6168
- # a secondary cluster in an Aurora global database. Because write
6169
- # forwarding takes time to enable, check the value of
6170
- # `GlobalWriteForwardingStatus` to confirm that the request has
6171
- # completed before using the write forwarding feature for this
6172
- # cluster.
6069
+ # Specifies whether write forwarding is enabled for a secondary
6070
+ # cluster in an Aurora global database. Because write forwarding takes
6071
+ # time to enable, check the value of `GlobalWriteForwardingStatus` to
6072
+ # confirm that the request has completed before using the write
6073
+ # forwarding feature for this cluster.
6173
6074
  # @return [Boolean]
6174
6075
  #
6175
6076
  # @!attribute [rw] pending_modified_values
6176
- # A value that specifies that changes to the DB cluster are pending.
6177
- # This element is only included when changes are pending. Specific
6178
- # changes are identified by subelements.
6077
+ # Information about pending changes to the DB cluster. This
6078
+ # information is returned only when there are pending changes.
6079
+ # Specific changes are identified by subelements.
6179
6080
  # @return [Types::ClusterPendingModifiedValues]
6180
6081
  #
6181
6082
  # @!attribute [rw] db_cluster_instance_class
@@ -6196,27 +6097,26 @@ module Aws::RDS
6196
6097
  # @return [Integer]
6197
6098
  #
6198
6099
  # @!attribute [rw] publicly_accessible
6199
- # Specifies the accessibility options for the DB instance.
6100
+ # Indicates whether the DB cluster is publicly accessible.
6200
6101
  #
6201
- # When the DB instance is publicly accessible, its Domain Name System
6102
+ # When the DB cluster is publicly accessible, its Domain Name System
6202
6103
  # (DNS) endpoint resolves to the private IP address from within the DB
6203
- # instance's virtual private cloud (VPC). It resolves to the public
6204
- # IP address from outside of the DB instance's VPC. Access to the DB
6205
- # instance is ultimately controlled by the security group it uses.
6206
- # That public access is not permitted if the security group assigned
6207
- # to the DB instance doesn't permit it.
6104
+ # cluster's virtual private cloud (VPC). It resolves to the public IP
6105
+ # address from outside of the DB cluster's VPC. Access to the DB
6106
+ # cluster is ultimately controlled by the security group it uses. That
6107
+ # public access isn't permitted if the security group assigned to the
6108
+ # DB cluster doesn't permit it.
6208
6109
  #
6209
- # When the DB instance isn't publicly accessible, it is an internal
6210
- # DB instance with a DNS name that resolves to a private IP address.
6110
+ # When the DB cluster isn't publicly accessible, it is an internal DB
6111
+ # cluster with a DNS name that resolves to a private IP address.
6211
6112
  #
6212
- # For more information, see CreateDBInstance.
6113
+ # For more information, see CreateDBCluster.
6213
6114
  #
6214
6115
  # This setting is only for non-Aurora Multi-AZ DB clusters.
6215
6116
  # @return [Boolean]
6216
6117
  #
6217
6118
  # @!attribute [rw] auto_minor_version_upgrade
6218
- # A value that indicates that minor version patches are applied
6219
- # automatically.
6119
+ # Indicates whether minor version patches are applied automatically.
6220
6120
  #
6221
6121
  # This setting is only for non-Aurora Multi-AZ DB clusters.
6222
6122
  # @return [Boolean]
@@ -6236,8 +6136,8 @@ module Aws::RDS
6236
6136
  # @return [String]
6237
6137
  #
6238
6138
  # @!attribute [rw] performance_insights_enabled
6239
- # True if Performance Insights is enabled for the DB cluster, and
6240
- # otherwise false.
6139
+ # Indicates whether Performance Insights is enabled for the DB
6140
+ # cluster.
6241
6141
  #
6242
6142
  # This setting is only for non-Aurora Multi-AZ DB clusters.
6243
6143
  # @return [Boolean]
@@ -6253,31 +6153,25 @@ module Aws::RDS
6253
6153
  # @return [String]
6254
6154
  #
6255
6155
  # @!attribute [rw] performance_insights_retention_period
6256
- # The number of days to retain Performance Insights data. The default
6257
- # is 7 days. The following values are valid:
6258
- #
6259
- # * 7
6260
- #
6261
- # * *month* * 31, where *month* is a number of months from 1-23
6262
- #
6263
- # * 731
6156
+ # The number of days to retain Performance Insights data.
6264
6157
  #
6265
- # For example, the following values are valid:
6158
+ # This setting is only for non-Aurora Multi-AZ DB clusters.
6266
6159
  #
6267
- # * 93 (3 months * 31)
6160
+ # Valid Values:
6268
6161
  #
6269
- # * 341 (11 months * 31)
6162
+ # * `7`
6270
6163
  #
6271
- # * 589 (19 months * 31)
6164
+ # * *month* * 31, where *month* is a number of months from 1-23.
6165
+ # Examples: `93` (3 months * 31), `341` (11 months * 31), `589`
6166
+ # (19 months * 31)
6272
6167
  #
6273
- # * 731
6168
+ # * `731`
6274
6169
  #
6275
- # This setting is only for non-Aurora Multi-AZ DB clusters.
6170
+ # Default: `7` days
6276
6171
  # @return [Integer]
6277
6172
  #
6278
6173
  # @!attribute [rw] serverless_v2_scaling_configuration
6279
- # Shows the scaling configuration for an Aurora Serverless v2 DB
6280
- # cluster.
6174
+ # The scaling configuration for an Aurora Serverless v2 DB cluster.
6281
6175
  #
6282
6176
  # For more information, see [Using Amazon Aurora Serverless v2][1] in
6283
6177
  # the *Amazon Aurora User Guide*.
@@ -6290,12 +6184,6 @@ module Aws::RDS
6290
6184
  # @!attribute [rw] network_type
6291
6185
  # The network type of the DB instance.
6292
6186
  #
6293
- # Valid values:
6294
- #
6295
- # * `IPV4`
6296
- #
6297
- # * `DUAL`
6298
- #
6299
6187
  # The network type is determined by the `DBSubnetGroup` specified for
6300
6188
  # the DB cluster. A `DBSubnetGroup` can support only the IPv4 protocol
6301
6189
  # or the IPv4 and the IPv6 protocols (`DUAL`).
@@ -6305,6 +6193,8 @@ module Aws::RDS
6305
6193
  #
6306
6194
  # This setting is only for Aurora DB clusters.
6307
6195
  #
6196
+ # Valid Values: `IPV4 | DUAL`
6197
+ #
6308
6198
  #
6309
6199
  #
6310
6200
  # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html
@@ -6315,8 +6205,8 @@ module Aws::RDS
6315
6205
  # @return [String]
6316
6206
  #
6317
6207
  # @!attribute [rw] master_user_secret
6318
- # Contains the secret managed by RDS in Amazon Web Services Secrets
6319
- # Manager for the master user password.
6208
+ # The secret managed by RDS in Amazon Web Services Secrets Manager for
6209
+ # the master user password.
6320
6210
  #
6321
6211
  # For more information, see [Password management with Amazon Web
6322
6212
  # Services Secrets Manager][1] in the *Amazon RDS User Guide* and
@@ -6704,7 +6594,7 @@ module Aws::RDS
6704
6594
  # `DescribeDBClusters` action.
6705
6595
  #
6706
6596
  # @!attribute [rw] marker
6707
- # A pagination token that can be used in a later DescribeDBClusters
6597
+ # A pagination token that can be used in a later `DescribeDBClusters`
6708
6598
  # request.
6709
6599
  # @return [String]
6710
6600
  #
@@ -7443,21 +7333,21 @@ module Aws::RDS
7443
7333
  # `StartDBInstance`, and `StopDBInstance`.
7444
7334
  #
7445
7335
  # @!attribute [rw] db_instance_identifier
7446
- # Contains a user-supplied database identifier. This identifier is the
7447
- # unique key that identifies a DB instance.
7336
+ # The user-supplied database identifier. This identifier is the unique
7337
+ # key that identifies a DB instance.
7448
7338
  # @return [String]
7449
7339
  #
7450
7340
  # @!attribute [rw] db_instance_class
7451
- # Contains the name of the compute and memory capacity class of the DB
7341
+ # The name of the compute and memory capacity class of the DB
7452
7342
  # instance.
7453
7343
  # @return [String]
7454
7344
  #
7455
7345
  # @!attribute [rw] engine
7456
- # The name of the database engine to be used for this DB instance.
7346
+ # The database engine used for this DB instance.
7457
7347
  # @return [String]
7458
7348
  #
7459
7349
  # @!attribute [rw] db_instance_status
7460
- # Specifies the current state of this database.
7350
+ # The current state of this database.
7461
7351
  #
7462
7352
  # For information about DB instance statuses, see [Viewing DB instance
7463
7353
  # status][1] in the *Amazon RDS User Guide.*
@@ -7472,55 +7362,49 @@ module Aws::RDS
7472
7362
  # @return [Time]
7473
7363
  #
7474
7364
  # @!attribute [rw] master_username
7475
- # Contains the master username for the DB instance.
7365
+ # The master username for the DB instance.
7476
7366
  # @return [String]
7477
7367
  #
7478
7368
  # @!attribute [rw] db_name
7479
- # The meaning of this parameter differs according to the database
7480
- # engine you use.
7481
- #
7482
- # **MySQL, MariaDB, SQL Server, PostgreSQL**
7483
- #
7484
- # Contains the name of the initial database of this instance that was
7485
- # provided at create time, if one was specified when the DB instance
7486
- # was created. This same name is returned for the life of the DB
7487
- # instance.
7488
- #
7489
- # Type: String
7369
+ # The meaning of this parameter differs depending on the database
7370
+ # engine.
7490
7371
  #
7491
- # **Oracle**
7372
+ # * For RDS for MariaDB, Microsoft SQL Server, MySQL, and PostgreSQL -
7373
+ # The name of the initial database specified for this DB instance
7374
+ # when it was created, if one was provided. This same name is
7375
+ # returned for the life of the DB instance.
7492
7376
  #
7493
- # Contains the Oracle System ID (SID) of the created DB instance. Not
7494
- # shown when the returned parameters do not apply to an Oracle DB
7495
- # instance.
7377
+ # * For RDS for Oracle - The Oracle System ID (SID) of the created DB
7378
+ # instance. This value is only returned when the object returned is
7379
+ # an Oracle DB instance.
7496
7380
  # @return [String]
7497
7381
  #
7498
7382
  # @!attribute [rw] endpoint
7499
- # Specifies the connection endpoint.
7383
+ # The connection endpoint for the DB instance.
7500
7384
  #
7501
- # <note markdown="1"> The endpoint might not be shown for instances whose status is
7385
+ # <note markdown="1"> The endpoint might not be shown for instances with the status of
7502
7386
  # `creating`.
7503
7387
  #
7504
7388
  # </note>
7505
7389
  # @return [Types::Endpoint]
7506
7390
  #
7507
7391
  # @!attribute [rw] allocated_storage
7508
- # Specifies the allocated storage size specified in gibibytes (GiB).
7392
+ # The amount of storage in gibibytes (GiB) allocated for the DB
7393
+ # instance.
7509
7394
  # @return [Integer]
7510
7395
  #
7511
7396
  # @!attribute [rw] instance_create_time
7512
- # Provides the date and time the DB instance was created.
7397
+ # The date and time when the DB instance was created.
7513
7398
  # @return [Time]
7514
7399
  #
7515
7400
  # @!attribute [rw] preferred_backup_window
7516
- # Specifies the daily time range during which automated backups are
7517
- # created if automated backups are enabled, as determined by the
7401
+ # The daily time range during which automated backups are created if
7402
+ # automated backups are enabled, as determined by the
7518
7403
  # `BackupRetentionPeriod`.
7519
7404
  # @return [String]
7520
7405
  #
7521
7406
  # @!attribute [rw] backup_retention_period
7522
- # Specifies the number of days for which automatic DB snapshots are
7523
- # retained.
7407
+ # The number of days for which automatic DB snapshots are retained.
7524
7408
  # @return [Integer]
7525
7409
  #
7526
7410
  # @!attribute [rw] db_security_groups
@@ -7529,73 +7413,69 @@ module Aws::RDS
7529
7413
  # @return [Array<Types::DBSecurityGroupMembership>]
7530
7414
  #
7531
7415
  # @!attribute [rw] vpc_security_groups
7532
- # Provides a list of VPC security group elements that the DB instance
7416
+ # The list of Amazon EC2 VPC security groups that the DB instance
7533
7417
  # belongs to.
7534
7418
  # @return [Array<Types::VpcSecurityGroupMembership>]
7535
7419
  #
7536
7420
  # @!attribute [rw] db_parameter_groups
7537
- # Provides the list of DB parameter groups applied to this DB
7538
- # instance.
7421
+ # The list of DB parameter groups applied to this DB instance.
7539
7422
  # @return [Array<Types::DBParameterGroupStatus>]
7540
7423
  #
7541
7424
  # @!attribute [rw] availability_zone
7542
- # Specifies the name of the Availability Zone the DB instance is
7543
- # located in.
7425
+ # The name of the Availability Zone where the DB instance is located.
7544
7426
  # @return [String]
7545
7427
  #
7546
7428
  # @!attribute [rw] db_subnet_group
7547
- # Specifies information on the subnet group associated with the DB
7548
- # instance, including the name, description, and subnets in the subnet
7549
- # group.
7429
+ # Information about the subnet group associated with the DB instance,
7430
+ # including the name, description, and subnets in the subnet group.
7550
7431
  # @return [Types::DBSubnetGroup]
7551
7432
  #
7552
7433
  # @!attribute [rw] preferred_maintenance_window
7553
- # Specifies the weekly time range during which system maintenance can
7554
- # occur, in Universal Coordinated Time (UTC).
7434
+ # The weekly time range during which system maintenance can occur, in
7435
+ # Universal Coordinated Time (UTC).
7555
7436
  # @return [String]
7556
7437
  #
7557
7438
  # @!attribute [rw] pending_modified_values
7558
- # A value that specifies that changes to the DB instance are pending.
7559
- # This element is only included when changes are pending. Specific
7560
- # changes are identified by subelements.
7439
+ # Information about pending changes to the DB instance. This
7440
+ # information is returned only when there are pending changes.
7441
+ # Specific changes are identified by subelements.
7561
7442
  # @return [Types::PendingModifiedValues]
7562
7443
  #
7563
7444
  # @!attribute [rw] latest_restorable_time
7564
- # Specifies the latest time to which a database can be restored with
7565
- # point-in-time restore.
7445
+ # The latest time to which a database in this DB instance can be
7446
+ # restored with point-in-time restore.
7566
7447
  # @return [Time]
7567
7448
  #
7568
7449
  # @!attribute [rw] multi_az
7569
- # Specifies if the DB instance is a Multi-AZ deployment. This setting
7570
- # doesn't apply to RDS Custom.
7450
+ # Indicates whether the DB instance is a Multi-AZ deployment. This
7451
+ # setting doesn't apply to RDS Custom DB instances.
7571
7452
  # @return [Boolean]
7572
7453
  #
7573
7454
  # @!attribute [rw] engine_version
7574
- # Indicates the database engine version.
7455
+ # The version of the database engine.
7575
7456
  # @return [String]
7576
7457
  #
7577
7458
  # @!attribute [rw] auto_minor_version_upgrade
7578
- # A value that indicates that minor version patches are applied
7579
- # automatically.
7459
+ # Indicates whether minor version patches are applied automatically.
7580
7460
  # @return [Boolean]
7581
7461
  #
7582
7462
  # @!attribute [rw] read_replica_source_db_instance_identifier
7583
- # Contains the identifier of the source DB instance if this DB
7584
- # instance is a read replica.
7463
+ # The identifier of the source DB instance if this DB instance is a
7464
+ # read replica.
7585
7465
  # @return [String]
7586
7466
  #
7587
7467
  # @!attribute [rw] read_replica_db_instance_identifiers
7588
- # Contains one or more identifiers of the read replicas associated
7589
- # with this DB instance.
7468
+ # The identifiers of the read replicas associated with this DB
7469
+ # instance.
7590
7470
  # @return [Array<String>]
7591
7471
  #
7592
7472
  # @!attribute [rw] read_replica_db_cluster_identifiers
7593
- # Contains one or more identifiers of Aurora DB clusters to which the
7594
- # RDS DB instance is replicated as a read replica. For example, when
7595
- # you create an Aurora read replica of an RDS for MySQL DB instance,
7596
- # the Aurora MySQL DB cluster for the Aurora read replica is shown.
7597
- # This output doesn't contain information about cross-Region Aurora
7598
- # read replicas.
7473
+ # The identifiers of Aurora DB clusters to which the RDS DB instance
7474
+ # is replicated as a read replica. For example, when you create an
7475
+ # Aurora read replica of an RDS for MySQL DB instance, the Aurora
7476
+ # MySQL DB cluster for the Aurora read replica is shown. This output
7477
+ # doesn't contain information about cross-Region Aurora read
7478
+ # replicas.
7599
7479
  #
7600
7480
  # <note markdown="1"> Currently, each RDS DB instance can have only one Aurora read
7601
7481
  # replica.
@@ -7618,16 +7498,17 @@ module Aws::RDS
7618
7498
  # @return [String]
7619
7499
  #
7620
7500
  # @!attribute [rw] license_model
7621
- # License model information for this DB instance. This setting
7622
- # doesn't apply to RDS Custom.
7501
+ # The license model information for this DB instance. This setting
7502
+ # doesn't apply to RDS Custom DB instances.
7623
7503
  # @return [String]
7624
7504
  #
7625
7505
  # @!attribute [rw] iops
7626
- # Specifies the Provisioned IOPS (I/O operations per second) value.
7506
+ # The Provisioned IOPS (I/O operations per second) value for the DB
7507
+ # instance.
7627
7508
  # @return [Integer]
7628
7509
  #
7629
7510
  # @!attribute [rw] option_group_memberships
7630
- # Provides the list of option group memberships for this DB instance.
7511
+ # The list of option group memberships for this DB instance.
7631
7512
  # @return [Array<Types::OptionGroupMembership>]
7632
7513
  #
7633
7514
  # @!attribute [rw] character_set_name
@@ -7647,7 +7528,7 @@ module Aws::RDS
7647
7528
  # @return [String]
7648
7529
  #
7649
7530
  # @!attribute [rw] publicly_accessible
7650
- # Specifies the accessibility options for the DB instance.
7531
+ # Indicates whether the DB instance is publicly accessible.
7651
7532
  #
7652
7533
  # When the DB cluster is publicly accessible, its Domain Name System
7653
7534
  # (DNS) endpoint resolves to the private IP address from within the DB
@@ -7664,12 +7545,12 @@ module Aws::RDS
7664
7545
  # @return [Boolean]
7665
7546
  #
7666
7547
  # @!attribute [rw] status_infos
7667
- # The status of a read replica. If the instance isn't a read replica,
7668
- # this is blank.
7548
+ # The status of a read replica. If the DB instance isn't a read
7549
+ # replica, the value is blank.
7669
7550
  # @return [Array<Types::DBInstanceStatusInfo>]
7670
7551
  #
7671
7552
  # @!attribute [rw] storage_type
7672
- # Specifies the storage type associated with the DB instance.
7553
+ # The storage type associated with the DB instance.
7673
7554
  # @return [String]
7674
7555
  #
7675
7556
  # @!attribute [rw] tde_credential_arn
@@ -7678,22 +7559,22 @@ module Aws::RDS
7678
7559
  # @return [String]
7679
7560
  #
7680
7561
  # @!attribute [rw] db_instance_port
7681
- # Specifies the port that the DB instance listens on. If the DB
7682
- # instance is part of a DB cluster, this can be a different port than
7683
- # the DB cluster port.
7562
+ # The port that the DB instance listens on. If the DB instance is part
7563
+ # of a DB cluster, this can be a different port than the DB cluster
7564
+ # port.
7684
7565
  # @return [Integer]
7685
7566
  #
7686
7567
  # @!attribute [rw] db_cluster_identifier
7687
- # If the DB instance is a member of a DB cluster, contains the name of
7688
- # the DB cluster that the DB instance is a member of.
7568
+ # If the DB instance is a member of a DB cluster, indicates the name
7569
+ # of the DB cluster that the DB instance is a member of.
7689
7570
  # @return [String]
7690
7571
  #
7691
7572
  # @!attribute [rw] storage_encrypted
7692
- # Specifies whether the DB instance is encrypted.
7573
+ # Indicates whether the DB instance is encrypted.
7693
7574
  # @return [Boolean]
7694
7575
  #
7695
7576
  # @!attribute [rw] kms_key_id
7696
- # If `StorageEncrypted` is true, the Amazon Web Services KMS key
7577
+ # If `StorageEncrypted` is enabled, the Amazon Web Services KMS key
7697
7578
  # identifier for the encrypted DB instance.
7698
7579
  #
7699
7580
  # The Amazon Web Services KMS key identifier is the key ARN, key ID,
@@ -7727,14 +7608,13 @@ module Aws::RDS
7727
7608
  # @return [Array<Types::DomainMembership>]
7728
7609
  #
7729
7610
  # @!attribute [rw] copy_tags_to_snapshot
7730
- # Specifies whether tags are copied from the DB instance to snapshots
7611
+ # Indicates whether tags are copied from the DB instance to snapshots
7731
7612
  # of the DB instance.
7732
7613
  #
7733
- # **Amazon Aurora**
7734
- #
7735
- # Not applicable. Copying tags to snapshots is managed by the DB
7736
- # cluster. Setting this value for an Aurora DB instance has no effect
7737
- # on the DB cluster setting. For more information, see `DBCluster`.
7614
+ # This setting doesn't apply to Amazon Aurora DB instances. Copying
7615
+ # tags to snapshots is managed by the DB cluster. Setting this value
7616
+ # for an Aurora DB instance has no effect on the DB cluster setting.
7617
+ # For more information, see `DBCluster`.
7738
7618
  # @return [Boolean]
7739
7619
  #
7740
7620
  # @!attribute [rw] monitoring_interval
@@ -7754,14 +7634,14 @@ module Aws::RDS
7754
7634
  # @return [String]
7755
7635
  #
7756
7636
  # @!attribute [rw] promotion_tier
7757
- # A value that specifies the order in which an Aurora Replica is
7758
- # promoted to the primary instance after a failure of the existing
7759
- # primary instance. For more information, see [ Fault Tolerance for an
7760
- # Aurora DB Cluster][1] in the *Amazon Aurora User Guide*.
7637
+ # The order of priority in which an Aurora Replica is promoted to the
7638
+ # primary instance after a failure of the existing primary instance.
7639
+ # For more information, see [ Fault Tolerance for an Aurora DB
7640
+ # Cluster][1] in the *Amazon Aurora User Guide*.
7761
7641
  #
7762
7642
  #
7763
7643
  #
7764
- # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Managing.Backups.html#Aurora.Managing.FaultTolerance
7644
+ # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Concepts.AuroraHighAvailability.html#Aurora.Managing.FaultTolerance
7765
7645
  # @return [Integer]
7766
7646
  #
7767
7647
  # @!attribute [rw] db_instance_arn
@@ -7775,9 +7655,9 @@ module Aws::RDS
7775
7655
  # @return [String]
7776
7656
  #
7777
7657
  # @!attribute [rw] iam_database_authentication_enabled
7778
- # True if mapping of Amazon Web Services Identity and Access
7779
- # Management (IAM) accounts to database accounts is enabled, and
7780
- # otherwise false.
7658
+ # Indicates whether mapping of Amazon Web Services Identity and Access
7659
+ # Management (IAM) accounts to database accounts is enabled for the DB
7660
+ # instance.
7781
7661
  #
7782
7662
  # For a list of engine versions that support IAM database
7783
7663
  # authentication, see [IAM database authentication][1] in the *Amazon
@@ -7791,8 +7671,8 @@ module Aws::RDS
7791
7671
  # @return [Boolean]
7792
7672
  #
7793
7673
  # @!attribute [rw] performance_insights_enabled
7794
- # True if Performance Insights is enabled for the DB instance, and
7795
- # otherwise false.
7674
+ # Indicates whether Performance Insights is enabled for the DB
7675
+ # instance.
7796
7676
  # @return [Boolean]
7797
7677
  #
7798
7678
  # @!attribute [rw] performance_insights_kms_key_id
@@ -7804,24 +7684,19 @@ module Aws::RDS
7804
7684
  # @return [String]
7805
7685
  #
7806
7686
  # @!attribute [rw] performance_insights_retention_period
7807
- # The number of days to retain Performance Insights data. The default
7808
- # is 7 days. The following values are valid:
7687
+ # The number of days to retain Performance Insights data.
7809
7688
  #
7810
- # * 7
7811
- #
7812
- # * *month* * 31, where *month* is a number of months from 1-23
7813
- #
7814
- # * 731
7815
- #
7816
- # For example, the following values are valid:
7689
+ # Valid Values:
7817
7690
  #
7818
- # * 93 (3 months * 31)
7691
+ # * `7`
7819
7692
  #
7820
- # * 341 (11 months * 31)
7693
+ # * *month* * 31, where *month* is a number of months from 1-23.
7694
+ # Examples: `93` (3 months * 31), `341` (11 months * 31), `589`
7695
+ # (19 months * 31)
7821
7696
  #
7822
- # * 589 (19 months * 31)
7697
+ # * `731`
7823
7698
  #
7824
- # * 731
7699
+ # Default: `7` days
7825
7700
  # @return [Integer]
7826
7701
  #
7827
7702
  # @!attribute [rw] enabled_cloudwatch_logs_exports
@@ -7829,7 +7704,7 @@ module Aws::RDS
7829
7704
  # CloudWatch Logs.
7830
7705
  #
7831
7706
  # Log types vary by DB engine. For information about the log types for
7832
- # each DB engine, see [Amazon RDS Database Log Files][1] in the
7707
+ # each DB engine, see [Monitoring Amazon RDS log files][1] in the
7833
7708
  # *Amazon RDS User Guide.*
7834
7709
  #
7835
7710
  #
@@ -7843,9 +7718,9 @@ module Aws::RDS
7843
7718
  # @return [Array<Types::ProcessorFeature>]
7844
7719
  #
7845
7720
  # @!attribute [rw] deletion_protection
7846
- # Indicates if the DB instance has deletion protection enabled. The
7847
- # database can't be deleted when deletion protection is enabled. For
7848
- # more information, see [ Deleting a DB Instance][1].
7721
+ # Indicates whether the DB instance has deletion protection enabled.
7722
+ # The database can't be deleted when deletion protection is enabled.
7723
+ # For more information, see [ Deleting a DB Instance][1].
7849
7724
  #
7850
7725
  #
7851
7726
  #
@@ -7858,7 +7733,7 @@ module Aws::RDS
7858
7733
  # @return [Array<Types::DBInstanceRole>]
7859
7734
  #
7860
7735
  # @!attribute [rw] listener_endpoint
7861
- # Specifies the listener connection endpoint for SQL Server Always On.
7736
+ # The listener connection endpoint for SQL Server Always On.
7862
7737
  # @return [Types::Endpoint]
7863
7738
  #
7864
7739
  # @!attribute [rw] max_allocated_storage
@@ -7881,7 +7756,7 @@ module Aws::RDS
7881
7756
  # @return [Array<Types::DBInstanceAutomatedBackupsReplication>]
7882
7757
  #
7883
7758
  # @!attribute [rw] customer_owned_ip_enabled
7884
- # Specifies whether a customer-owned IP address (CoIP) is enabled for
7759
+ # Indicates whether a customer-owned IP address (CoIP) is enabled for
7885
7760
  # an RDS on Outposts DB instance.
7886
7761
  #
7887
7762
  # A <i>CoIP </i>provides local or external connectivity to resources
@@ -7970,19 +7845,14 @@ module Aws::RDS
7970
7845
  # @return [String]
7971
7846
  #
7972
7847
  # @!attribute [rw] backup_target
7973
- # Specifies where automated backups and manual snapshots are stored:
7974
- # Amazon Web Services Outposts or the Amazon Web Services Region.
7848
+ # The location where automated backups and manual snapshots are
7849
+ # stored: Amazon Web Services Outposts or the Amazon Web Services
7850
+ # Region.
7975
7851
  # @return [String]
7976
7852
  #
7977
7853
  # @!attribute [rw] network_type
7978
7854
  # The network type of the DB instance.
7979
7855
  #
7980
- # Valid values:
7981
- #
7982
- # * `IPV4`
7983
- #
7984
- # * `DUAL`
7985
- #
7986
7856
  # The network type is determined by the `DBSubnetGroup` specified for
7987
7857
  # the DB instance. A `DBSubnetGroup` can support only the IPv4
7988
7858
  # protocol or the IPv4 and the IPv6 protocols (`DUAL`).
@@ -7991,6 +7861,8 @@ module Aws::RDS
7991
7861
  # in the *Amazon RDS User Guide* and [ Working with a DB instance in a
7992
7862
  # VPC][2] in the *Amazon Aurora User Guide.*
7993
7863
  #
7864
+ # Valid Values: `IPV4 | DUAL`
7865
+ #
7994
7866
  #
7995
7867
  #
7996
7868
  # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html
@@ -8002,20 +7874,20 @@ module Aws::RDS
8002
7874
  # @return [String]
8003
7875
  #
8004
7876
  # @!attribute [rw] storage_throughput
8005
- # Specifies the storage throughput for the DB instance.
7877
+ # The storage throughput for the DB instance.
8006
7878
  #
8007
7879
  # This setting applies only to the `gp3` storage type.
8008
7880
  # @return [Integer]
8009
7881
  #
8010
7882
  # @!attribute [rw] db_system_id
8011
7883
  # The Oracle system ID (Oracle SID) for a container database (CDB).
8012
- # The Oracle SID is also the name of the CDB. This setting is valid
8013
- # for RDS Custom only.
7884
+ # The Oracle SID is also the name of the CDB. This setting is only
7885
+ # valid for RDS Custom DB instances.
8014
7886
  # @return [String]
8015
7887
  #
8016
7888
  # @!attribute [rw] master_user_secret
8017
- # Contains the secret managed by RDS in Amazon Web Services Secrets
8018
- # Manager for the master user password.
7889
+ # The secret managed by RDS in Amazon Web Services Secrets Manager for
7890
+ # the master user password.
8019
7891
  #
8020
7892
  # For more information, see [Password management with Amazon Web
8021
7893
  # Services Secrets Manager][1] in the *Amazon RDS User Guide.*
@@ -8030,8 +7902,8 @@ module Aws::RDS
8030
7902
  # @return [Types::CertificateDetails]
8031
7903
  #
8032
7904
  # @!attribute [rw] read_replica_source_db_cluster_identifier
8033
- # Contains the identifier of the source DB cluster if this DB instance
8034
- # is a read replica.
7905
+ # The identifier of the source DB cluster if this DB instance is a
7906
+ # read replica.
8035
7907
  # @return [String]
8036
7908
  #
8037
7909
  # @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DBInstance AWS API Documentation
@@ -10735,12 +10607,12 @@ module Aws::RDS
10735
10607
  # @!attribute [rw] db_cluster_identifier
10736
10608
  # The user-supplied DB cluster identifier or the Amazon Resource Name
10737
10609
  # (ARN) of the DB cluster. If this parameter is specified, information
10738
- # from only the specific DB cluster is returned. This parameter isn't
10610
+ # for only the specific DB cluster is returned. This parameter isn't
10739
10611
  # case-sensitive.
10740
10612
  #
10741
10613
  # Constraints:
10742
10614
  #
10743
- # * If supplied, must match an existing DBClusterIdentifier.
10615
+ # * If supplied, must match an existing DB cluster identifier.
10744
10616
  #
10745
10617
  # ^
10746
10618
  # @return [String]
@@ -10748,7 +10620,7 @@ module Aws::RDS
10748
10620
  # @!attribute [rw] filters
10749
10621
  # A filter that specifies one or more DB clusters to describe.
10750
10622
  #
10751
- # Supported filters:
10623
+ # Supported Filters:
10752
10624
  #
10753
10625
  # * `clone-group-id` - Accepts clone group identifiers. The results
10754
10626
  # list only includes information about the DB clusters associated
@@ -10790,9 +10662,8 @@ module Aws::RDS
10790
10662
  # @return [String]
10791
10663
  #
10792
10664
  # @!attribute [rw] include_shared
10793
- # Optional Boolean parameter that specifies whether the output
10794
- # includes information about clusters shared from other Amazon Web
10795
- # Services accounts.
10665
+ # Specifies whether the output includes information about clusters
10666
+ # shared from other Amazon Web Services accounts.
10796
10667
  # @return [Boolean]
10797
10668
  #
10798
10669
  # @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DescribeDBClustersMessage AWS API Documentation
@@ -11052,7 +10923,7 @@ module Aws::RDS
11052
10923
  #
11053
10924
  # Constraints:
11054
10925
  #
11055
- # * If supplied, must match the identifier of an existing DBInstance.
10926
+ # * If supplied, must match the identifier of an existing DB instance.
11056
10927
  #
11057
10928
  # ^
11058
10929
  # @return [String]
@@ -11060,7 +10931,7 @@ module Aws::RDS
11060
10931
  # @!attribute [rw] filters
11061
10932
  # A filter that specifies one or more DB instances to describe.
11062
10933
  #
11063
- # Supported filters:
10934
+ # Supported Filters:
11064
10935
  #
11065
10936
  # * `db-cluster-id` - Accepts DB cluster identifiers and DB cluster
11066
10937
  # Amazon Resource Names (ARNs). The results list only includes
@@ -11072,7 +10943,7 @@ module Aws::RDS
11072
10943
  # information about the DB instances identified by these ARNs.
11073
10944
  #
11074
10945
  # * `dbi-resource-id` - Accepts DB instance resource identifiers. The
11075
- # results list will only include information about the DB instances
10946
+ # results list only includes information about the DB instances
11076
10947
  # identified by these DB instance resource identifiers.
11077
10948
  #
11078
10949
  # * `domain` - Accepts Active Directory directory IDs. The results
@@ -14396,35 +14267,38 @@ module Aws::RDS
14396
14267
  # The DB cluster identifier for the cluster being modified. This
14397
14268
  # parameter isn't case-sensitive.
14398
14269
  #
14399
- # Constraints: This identifier must match the identifier of an
14400
- # existing DB cluster.
14270
+ # Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
14401
14271
  #
14402
- # Valid for: Aurora DB clusters and Multi-AZ DB clusters
14272
+ # Constraints:
14273
+ #
14274
+ # * Must match the identifier of an existing DB cluster.
14275
+ #
14276
+ # ^
14403
14277
  # @return [String]
14404
14278
  #
14405
14279
  # @!attribute [rw] new_db_cluster_identifier
14406
14280
  # The new DB cluster identifier for the DB cluster when renaming a DB
14407
14281
  # cluster. This value is stored as a lowercase string.
14408
14282
  #
14283
+ # Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
14284
+ #
14409
14285
  # Constraints:
14410
14286
  #
14411
- # * Must contain from 1 to 63 letters, numbers, or hyphens
14287
+ # * Must contain from 1 to 63 letters, numbers, or hyphens.
14412
14288
  #
14413
- # * The first character must be a letter
14289
+ # * The first character must be a letter.
14414
14290
  #
14415
- # * Can't end with a hyphen or contain two consecutive hyphens
14291
+ # * Can't end with a hyphen or contain two consecutive hyphens.
14416
14292
  #
14417
14293
  # Example: `my-cluster2`
14418
- #
14419
- # Valid for: Aurora DB clusters and Multi-AZ DB clusters
14420
14294
  # @return [String]
14421
14295
  #
14422
14296
  # @!attribute [rw] apply_immediately
14423
- # A value that indicates whether the modifications in this request and
14424
- # any pending modifications are asynchronously applied as soon as
14425
- # possible, regardless of the `PreferredMaintenanceWindow` setting for
14426
- # the DB cluster. If this parameter is disabled, changes to the DB
14427
- # cluster are applied during the next maintenance window.
14297
+ # Specifies whether the modifications in this request and any pending
14298
+ # modifications are asynchronously applied as soon as possible,
14299
+ # regardless of the `PreferredMaintenanceWindow` setting for the DB
14300
+ # cluster. If this parameter is disabled, changes to the DB cluster
14301
+ # are applied during the next maintenance window.
14428
14302
  #
14429
14303
  # Most modifications can be applied immediately or during the next
14430
14304
  # scheduled maintenance window. Some modifications, such as turning on
@@ -14433,64 +14307,64 @@ module Aws::RDS
14433
14307
  #
14434
14308
  # By default, this parameter is disabled.
14435
14309
  #
14436
- # Valid for: Aurora DB clusters and Multi-AZ DB clusters
14310
+ # Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
14437
14311
  # @return [Boolean]
14438
14312
  #
14439
14313
  # @!attribute [rw] backup_retention_period
14440
14314
  # The number of days for which automated backups are retained. Specify
14441
- # a minimum value of 1.
14315
+ # a minimum value of `1`.
14442
14316
  #
14443
- # Default: 1
14317
+ # Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
14318
+ #
14319
+ # Default: `1`
14444
14320
  #
14445
14321
  # Constraints:
14446
14322
  #
14447
- # * Must be a value from 1 to 35
14323
+ # * Must be a value from 1 to 35.
14448
14324
  #
14449
14325
  # ^
14450
- #
14451
- # Valid for: Aurora DB clusters and Multi-AZ DB clusters
14452
14326
  # @return [Integer]
14453
14327
  #
14454
14328
  # @!attribute [rw] db_cluster_parameter_group_name
14455
14329
  # The name of the DB cluster parameter group to use for the DB
14456
14330
  # cluster.
14457
14331
  #
14458
- # Valid for: Aurora DB clusters and Multi-AZ DB clusters
14332
+ # Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
14459
14333
  # @return [String]
14460
14334
  #
14461
14335
  # @!attribute [rw] vpc_security_group_ids
14462
- # A list of VPC security groups that the DB cluster will belong to.
14336
+ # A list of EC2 VPC security groups to associate with this DB cluster.
14463
14337
  #
14464
- # Valid for: Aurora DB clusters and Multi-AZ DB clusters
14338
+ # Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
14465
14339
  # @return [Array<String>]
14466
14340
  #
14467
14341
  # @!attribute [rw] port
14468
14342
  # The port number on which the DB cluster accepts connections.
14469
14343
  #
14470
- # Constraints: Value must be `1150-65535`
14344
+ # Valid for Cluster Type: Aurora DB clusters only
14471
14345
  #
14472
- # Default: The same port as the original DB cluster.
14346
+ # Valid Values: `1150-65535`
14473
14347
  #
14474
- # Valid for: Aurora DB clusters only
14348
+ # Default: The same port as the original DB cluster.
14475
14349
  # @return [Integer]
14476
14350
  #
14477
14351
  # @!attribute [rw] master_user_password
14478
- # The new password for the master database user. This password can
14479
- # contain any printable ASCII character except "/", """, or
14480
- # "@".
14352
+ # The new password for the master database user.
14353
+ #
14354
+ # Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
14481
14355
  #
14482
14356
  # Constraints:
14483
14357
  #
14484
14358
  # * Must contain from 8 to 41 characters.
14485
14359
  #
14486
- # * Can't be specified if `ManageMasterUserPassword` is turned on.
14360
+ # * Can contain any printable ASCII character except "/", """, or
14361
+ # "@".
14487
14362
  #
14488
- # Valid for: Aurora DB clusters and Multi-AZ DB clusters
14363
+ # * Can't be specified if `ManageMasterUserPassword` is turned on.
14489
14364
  # @return [String]
14490
14365
  #
14491
14366
  # @!attribute [rw] option_group_name
14492
- # A value that indicates that the DB cluster should be associated with
14493
- # the specified option group.
14367
+ # The option group to associate the DB cluster with.
14494
14368
  #
14495
14369
  # DB clusters are associated with a default option group that can't
14496
14370
  # be modified.
@@ -14506,6 +14380,8 @@ module Aws::RDS
14506
14380
  # blocks available, see [ Backup window][1] in the *Amazon Aurora User
14507
14381
  # Guide*.
14508
14382
  #
14383
+ # Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
14384
+ #
14509
14385
  # Constraints:
14510
14386
  #
14511
14387
  # * Must be in the format `hh24:mi-hh24:mi`.
@@ -14516,8 +14392,6 @@ module Aws::RDS
14516
14392
  #
14517
14393
  # * Must be at least 30 minutes.
14518
14394
  #
14519
- # Valid for: Aurora DB clusters and Multi-AZ DB clusters
14520
- #
14521
14395
  #
14522
14396
  #
14523
14397
  # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Managing.Backups.html#Aurora.Managing.Backups.BackupWindow
@@ -14527,7 +14401,7 @@ module Aws::RDS
14527
14401
  # The weekly time range during which system maintenance can occur, in
14528
14402
  # Universal Coordinated Time (UTC).
14529
14403
  #
14530
- # Format: `ddd:hh24:mi-ddd:hh24:mi`
14404
+ # Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
14531
14405
  #
14532
14406
  # The default is a 30-minute window selected at random from an 8-hour
14533
14407
  # block of time for each Amazon Web Services Region, occurring on a
@@ -14535,11 +14409,15 @@ module Aws::RDS
14535
14409
  # Adjusting the Preferred DB Cluster Maintenance Window][1] in the
14536
14410
  # *Amazon Aurora User Guide*.
14537
14411
  #
14538
- # Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.
14412
+ # Constraints:
14539
14413
  #
14540
- # Constraints: Minimum 30-minute window.
14414
+ # * Must be in the format `ddd:hh24:mi-ddd:hh24:mi`.
14541
14415
  #
14542
- # Valid for: Aurora DB clusters and Multi-AZ DB clusters
14416
+ # * Days must be one of `Mon | Tue | Wed | Thu | Fri | Sat | Sun`.
14417
+ #
14418
+ # * Must be in Universal Coordinated Time (UTC).
14419
+ #
14420
+ # * Must be at least 30 minutes.
14543
14421
  #
14544
14422
  #
14545
14423
  #
@@ -14547,14 +14425,14 @@ module Aws::RDS
14547
14425
  # @return [String]
14548
14426
  #
14549
14427
  # @!attribute [rw] enable_iam_database_authentication
14550
- # A value that indicates whether to enable mapping of Amazon Web
14551
- # Services Identity and Access Management (IAM) accounts to database
14552
- # accounts. By default, mapping isn't enabled.
14428
+ # Specifies whether to enable mapping of Amazon Web Services Identity
14429
+ # and Access Management (IAM) accounts to database accounts. By
14430
+ # default, mapping isn't enabled.
14553
14431
  #
14554
14432
  # For more information, see [ IAM Database Authentication][1] in the
14555
14433
  # *Amazon Aurora User Guide*.
14556
14434
  #
14557
- # Valid for: Aurora DB clusters only
14435
+ # Valid for Cluster Type: Aurora DB clusters only
14558
14436
  #
14559
14437
  #
14560
14438
  #
@@ -14563,9 +14441,11 @@ module Aws::RDS
14563
14441
  #
14564
14442
  # @!attribute [rw] backtrack_window
14565
14443
  # The target backtrack window, in seconds. To disable backtracking,
14566
- # set this value to 0.
14444
+ # set this value to `0`.
14567
14445
  #
14568
- # Default: 0
14446
+ # Valid for Cluster Type: Aurora MySQL DB clusters only
14447
+ #
14448
+ # Default: `0`
14569
14449
  #
14570
14450
  # Constraints:
14571
14451
  #
@@ -14573,30 +14453,23 @@ module Aws::RDS
14573
14453
  # (72 hours).
14574
14454
  #
14575
14455
  # ^
14576
- #
14577
- # Valid for: Aurora MySQL DB clusters only
14578
14456
  # @return [Integer]
14579
14457
  #
14580
14458
  # @!attribute [rw] cloudwatch_logs_export_configuration
14581
14459
  # The configuration setting for the log types to be enabled for export
14582
- # to CloudWatch Logs for a specific DB cluster. The values in the list
14583
- # depend on the DB engine being used.
14584
- #
14585
- # **RDS for MySQL**
14586
- #
14587
- # Possible values are `error`, `general`, and `slowquery`.
14460
+ # to CloudWatch Logs for a specific DB cluster.
14588
14461
  #
14589
- # **RDS for PostgreSQL**
14462
+ # Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
14590
14463
  #
14591
- # Possible values are `postgresql` and `upgrade`.
14464
+ # The following values are valid for each DB engine:
14592
14465
  #
14593
- # **Aurora MySQL**
14466
+ # * Aurora MySQL - `audit | error | general | slowquery`
14594
14467
  #
14595
- # Possible values are `audit`, `error`, `general`, and `slowquery`.
14468
+ # * Aurora PostgreSQL - `postgresql`
14596
14469
  #
14597
- # **Aurora PostgreSQL**
14470
+ # * RDS for MySQL - `error | general | slowquery`
14598
14471
  #
14599
- # Possible value is `postgresql`.
14472
+ # * RDS for PostgreSQL - `postgresql | upgrade`
14600
14473
  #
14601
14474
  # For more information about exporting CloudWatch Logs for Amazon RDS,
14602
14475
  # see [ Publishing Database Logs to Amazon CloudWatch Logs][1] in the
@@ -14606,8 +14479,6 @@ module Aws::RDS
14606
14479
  # Aurora, see [Publishing Database Logs to Amazon CloudWatch Logs][2]
14607
14480
  # in the *Amazon Aurora User Guide*.
14608
14481
  #
14609
- # Valid for: Aurora DB clusters and Multi-AZ DB clusters
14610
- #
14611
14482
  #
14612
14483
  #
14613
14484
  # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch
@@ -14648,17 +14519,21 @@ module Aws::RDS
14648
14519
  # `aws rds describe-db-engine-versions --engine postgres --query
14649
14520
  # "DBEngineVersions[].EngineVersion"`
14650
14521
  #
14651
- # Valid for: Aurora DB clusters and Multi-AZ DB clusters
14522
+ # Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
14652
14523
  # @return [String]
14653
14524
  #
14654
14525
  # @!attribute [rw] allow_major_version_upgrade
14655
- # A value that indicates whether major version upgrades are allowed.
14526
+ # Specifies whether major version upgrades are allowed.
14656
14527
  #
14657
- # Constraints: You must allow major version upgrades when specifying a
14658
- # value for the `EngineVersion` parameter that is a different major
14659
- # version than the DB cluster's current version.
14528
+ # Valid for Cluster Type: Aurora DB clusters only
14660
14529
  #
14661
- # Valid for: Aurora DB clusters only
14530
+ # Constraints:
14531
+ #
14532
+ # * You must allow major version upgrades when specifying a value for
14533
+ # the `EngineVersion` parameter that is a different major version
14534
+ # than the DB cluster's current version.
14535
+ #
14536
+ # ^
14662
14537
  # @return [Boolean]
14663
14538
  #
14664
14539
  # @!attribute [rw] db_instance_parameter_group_name
@@ -14672,6 +14547,8 @@ module Aws::RDS
14672
14547
  #
14673
14548
  # </note>
14674
14549
  #
14550
+ # Valid for Cluster Type: Aurora DB clusters only
14551
+ #
14675
14552
  # Default: The existing name setting
14676
14553
  #
14677
14554
  # Constraints:
@@ -14682,8 +14559,6 @@ module Aws::RDS
14682
14559
  # * The `DBInstanceParameterGroupName` parameter is valid in
14683
14560
  # combination with the `AllowMajorVersionUpgrade` parameter for a
14684
14561
  # major version upgrade only.
14685
- #
14686
- # Valid for: Aurora DB clusters only
14687
14562
  # @return [String]
14688
14563
  #
14689
14564
  # @!attribute [rw] domain
@@ -14694,7 +14569,7 @@ module Aws::RDS
14694
14569
  # For more information, see [Kerberos Authentication][1] in the
14695
14570
  # *Amazon Aurora User Guide*.
14696
14571
  #
14697
- # Valid for: Aurora DB clusters only
14572
+ # Valid for Cluster Type: Aurora DB clusters only
14698
14573
  #
14699
14574
  #
14700
14575
  #
@@ -14702,32 +14577,30 @@ module Aws::RDS
14702
14577
  # @return [String]
14703
14578
  #
14704
14579
  # @!attribute [rw] domain_iam_role_name
14705
- # Specify the name of the IAM role to be used when making API calls to
14706
- # the Directory Service.
14580
+ # The name of the IAM role to use when making API calls to the
14581
+ # Directory Service.
14707
14582
  #
14708
- # Valid for: Aurora DB clusters only
14583
+ # Valid for Cluster Type: Aurora DB clusters only
14709
14584
  # @return [String]
14710
14585
  #
14711
14586
  # @!attribute [rw] scaling_configuration
14712
14587
  # The scaling properties of the DB cluster. You can only modify
14713
14588
  # scaling properties for DB clusters in `serverless` DB engine mode.
14714
14589
  #
14715
- # Valid for: Aurora DB clusters only
14590
+ # Valid for Cluster Type: Aurora DB clusters only
14716
14591
  # @return [Types::ScalingConfiguration]
14717
14592
  #
14718
14593
  # @!attribute [rw] deletion_protection
14719
- # A value that indicates whether the DB cluster has deletion
14720
- # protection enabled. The database can't be deleted when deletion
14721
- # protection is enabled. By default, deletion protection isn't
14722
- # enabled.
14594
+ # Specifies whether the DB cluster has deletion protection enabled.
14595
+ # The database can't be deleted when deletion protection is enabled.
14596
+ # By default, deletion protection isn't enabled.
14723
14597
  #
14724
- # Valid for: Aurora DB clusters and Multi-AZ DB clusters
14598
+ # Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
14725
14599
  # @return [Boolean]
14726
14600
  #
14727
14601
  # @!attribute [rw] enable_http_endpoint
14728
- # A value that indicates whether to enable the HTTP endpoint for an
14729
- # Aurora Serverless v1 DB cluster. By default, the HTTP endpoint is
14730
- # disabled.
14602
+ # Specifies whether to enable the HTTP endpoint for an Aurora
14603
+ # Serverless v1 DB cluster. By default, the HTTP endpoint is disabled.
14731
14604
  #
14732
14605
  # When enabled, the HTTP endpoint provides a connectionless web
14733
14606
  # service API for running SQL queries on the Aurora Serverless v1 DB
@@ -14737,7 +14610,7 @@ module Aws::RDS
14737
14610
  # For more information, see [Using the Data API for Aurora Serverless
14738
14611
  # v1][1] in the *Amazon Aurora User Guide*.
14739
14612
  #
14740
- # Valid for: Aurora DB clusters only
14613
+ # Valid for Cluster Type: Aurora DB clusters only
14741
14614
  #
14742
14615
  #
14743
14616
  #
@@ -14745,40 +14618,39 @@ module Aws::RDS
14745
14618
  # @return [Boolean]
14746
14619
  #
14747
14620
  # @!attribute [rw] copy_tags_to_snapshot
14748
- # A value that indicates whether to copy all tags from the DB cluster
14749
- # to snapshots of the DB cluster. The default is not to copy them.
14621
+ # Specifies whether to copy all tags from the DB cluster to snapshots
14622
+ # of the DB cluster. The default is not to copy them.
14750
14623
  #
14751
- # Valid for: Aurora DB clusters and Multi-AZ DB clusters
14624
+ # Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
14752
14625
  # @return [Boolean]
14753
14626
  #
14754
14627
  # @!attribute [rw] enable_global_write_forwarding
14755
- # A value that indicates whether to enable this DB cluster to forward
14756
- # write operations to the primary cluster of an Aurora global database
14757
- # (GlobalCluster). By default, write operations are not allowed on
14758
- # Aurora DB clusters that are secondary clusters in an Aurora global
14759
- # database.
14628
+ # Specifies whether to enable this DB cluster to forward write
14629
+ # operations to the primary cluster of a global cluster (Aurora global
14630
+ # database). By default, write operations are not allowed on Aurora DB
14631
+ # clusters that are secondary clusters in an Aurora global database.
14760
14632
  #
14761
14633
  # You can set this value only on Aurora DB clusters that are members
14762
14634
  # of an Aurora global database. With this parameter enabled, a
14763
- # secondary cluster can forward writes to the current primary cluster
14635
+ # secondary cluster can forward writes to the current primary cluster,
14764
14636
  # and the resulting changes are replicated back to this cluster. For
14765
14637
  # the primary DB cluster of an Aurora global database, this value is
14766
- # used immediately if the primary is demoted by the
14767
- # FailoverGlobalCluster API operation, but it does nothing until then.
14638
+ # used immediately if the primary is demoted by a global cluster API
14639
+ # operation, but it does nothing until then.
14768
14640
  #
14769
- # Valid for: Aurora DB clusters only
14641
+ # Valid for Cluster Type: Aurora DB clusters only
14770
14642
  # @return [Boolean]
14771
14643
  #
14772
14644
  # @!attribute [rw] db_cluster_instance_class
14773
14645
  # The compute and memory capacity of each DB instance in the Multi-AZ
14774
- # DB cluster, for example db.m6gd.xlarge. Not all DB instance classes
14775
- # are available in all Amazon Web Services Regions, or for all
14646
+ # DB cluster, for example `db.m6gd.xlarge`. Not all DB instance
14647
+ # classes are available in all Amazon Web Services Regions, or for all
14776
14648
  # database engines.
14777
14649
  #
14778
14650
  # For the full list of DB instance classes and availability for your
14779
14651
  # engine, see [ DB Instance Class][1] in the *Amazon RDS User Guide*.
14780
14652
  #
14781
- # Valid for: Multi-AZ DB clusters only
14653
+ # Valid for Cluster Type: Multi-AZ DB clusters only
14782
14654
  #
14783
14655
  #
14784
14656
  #
@@ -14789,21 +14661,38 @@ module Aws::RDS
14789
14661
  # The amount of storage in gibibytes (GiB) to allocate to each DB
14790
14662
  # instance in the Multi-AZ DB cluster.
14791
14663
  #
14792
- # Valid for: Multi-AZ DB clusters only
14664
+ # Valid for Cluster Type: Multi-AZ DB clusters only
14793
14665
  # @return [Integer]
14794
14666
  #
14795
14667
  # @!attribute [rw] storage_type
14796
- # Specifies the storage type to be associated with the DB cluster.
14668
+ # The storage type to associate with the DB cluster.
14669
+ #
14670
+ # For information on storage types for Aurora DB clusters, see
14671
+ # [Storage configurations for Amazon Aurora DB clusters][1]. For
14672
+ # information on storage types for Multi-AZ DB clusters, see [Settings
14673
+ # for creating Multi-AZ DB clusters][2].
14797
14674
  #
14798
14675
  # When specified for a Multi-AZ DB cluster, a value for the `Iops`
14799
14676
  # parameter is required.
14800
14677
  #
14801
- # Valid values: `aurora`, `aurora-iopt1` (Aurora DB clusters); `io1`
14802
- # (Multi-AZ DB clusters)
14678
+ # Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
14803
14679
  #
14804
- # Default: `aurora` (Aurora DB clusters); `io1` (Multi-AZ DB clusters)
14680
+ # Valid Values:
14805
14681
  #
14806
- # Valid for: Aurora DB clusters and Multi-AZ DB clusters
14682
+ # * Aurora DB clusters - `aurora | aurora-iopt1`
14683
+ #
14684
+ # * Multi-AZ DB clusters - `io1`
14685
+ #
14686
+ # Default:
14687
+ #
14688
+ # * Aurora DB clusters - `aurora`
14689
+ #
14690
+ # * Multi-AZ DB clusters - `io1`
14691
+ #
14692
+ #
14693
+ #
14694
+ # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Overview.StorageReliability.html#aurora-storage-type
14695
+ # [2]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/create-multi-az-db-cluster.html#create-multi-az-db-cluster-settings
14807
14696
  # @return [String]
14808
14697
  #
14809
14698
  # @!attribute [rw] iops
@@ -14814,10 +14703,14 @@ module Aws::RDS
14814
14703
  # For information about valid IOPS values, see [Amazon RDS Provisioned
14815
14704
  # IOPS storage][1] in the *Amazon RDS User Guide*.
14816
14705
  #
14817
- # Constraints: Must be a multiple between .5 and 50 of the storage
14818
- # amount for the DB cluster.
14706
+ # Valid for Cluster Type: Multi-AZ DB clusters only
14819
14707
  #
14820
- # Valid for: Multi-AZ DB clusters only
14708
+ # Constraints:
14709
+ #
14710
+ # * Must be a multiple between .5 and 50 of the storage amount for the
14711
+ # DB cluster.
14712
+ #
14713
+ # ^
14821
14714
  #
14822
14715
  #
14823
14716
  #
@@ -14825,24 +14718,26 @@ module Aws::RDS
14825
14718
  # @return [Integer]
14826
14719
  #
14827
14720
  # @!attribute [rw] auto_minor_version_upgrade
14828
- # A value that indicates whether minor engine upgrades are applied
14829
- # automatically to the DB cluster during the maintenance window. By
14830
- # default, minor engine upgrades are applied automatically.
14721
+ # Specifies whether minor engine upgrades are applied automatically to
14722
+ # the DB cluster during the maintenance window. By default, minor
14723
+ # engine upgrades are applied automatically.
14831
14724
  #
14832
- # Valid for: Multi-AZ DB clusters only
14725
+ # Valid for Cluster Type: Multi-AZ DB clusters only
14833
14726
  # @return [Boolean]
14834
14727
  #
14835
14728
  # @!attribute [rw] monitoring_interval
14836
14729
  # The interval, in seconds, between points when Enhanced Monitoring
14837
14730
  # metrics are collected for the DB cluster. To turn off collecting
14838
- # Enhanced Monitoring metrics, specify 0. The default is 0.
14731
+ # Enhanced Monitoring metrics, specify `0`.
14839
14732
  #
14840
14733
  # If `MonitoringRoleArn` is specified, also set `MonitoringInterval`
14841
- # to a value other than 0.
14734
+ # to a value other than `0`.
14842
14735
  #
14843
- # Valid Values: `0, 1, 5, 10, 15, 30, 60`
14736
+ # Valid for Cluster Type: Multi-AZ DB clusters only
14844
14737
  #
14845
- # Valid for: Multi-AZ DB clusters only
14738
+ # Valid Values: `0 | 1 | 5 | 10 | 15 | 30 | 60`
14739
+ #
14740
+ # Default: `0`
14846
14741
  # @return [Integer]
14847
14742
  #
14848
14743
  # @!attribute [rw] monitoring_role_arn
@@ -14852,10 +14747,10 @@ module Aws::RDS
14852
14747
  # on creating a monitoring role, see [To create an IAM role for Amazon
14853
14748
  # RDS Enhanced Monitoring][1] in the *Amazon RDS User Guide.*
14854
14749
  #
14855
- # If `MonitoringInterval` is set to a value other than 0, supply a
14750
+ # If `MonitoringInterval` is set to a value other than `0`, supply a
14856
14751
  # `MonitoringRoleArn` value.
14857
14752
  #
14858
- # Valid for: Multi-AZ DB clusters only
14753
+ # Valid for Cluster Type: Multi-AZ DB clusters only
14859
14754
  #
14860
14755
  #
14861
14756
  #
@@ -14863,13 +14758,13 @@ module Aws::RDS
14863
14758
  # @return [String]
14864
14759
  #
14865
14760
  # @!attribute [rw] enable_performance_insights
14866
- # A value that indicates whether to turn on Performance Insights for
14867
- # the DB cluster.
14761
+ # Specifies whether to turn on Performance Insights for the DB
14762
+ # cluster.
14868
14763
  #
14869
14764
  # For more information, see [ Using Amazon Performance Insights][1] in
14870
14765
  # the *Amazon RDS User Guide*.
14871
14766
  #
14872
- # Valid for: Multi-AZ DB clusters only
14767
+ # Valid for Cluster Type: Multi-AZ DB clusters only
14873
14768
  #
14874
14769
  #
14875
14770
  #
@@ -14889,33 +14784,28 @@ module Aws::RDS
14889
14784
  # account has a different default KMS key for each Amazon Web Services
14890
14785
  # Region.
14891
14786
  #
14892
- # Valid for: Multi-AZ DB clusters only
14787
+ # Valid for Cluster Type: Multi-AZ DB clusters only
14893
14788
  # @return [String]
14894
14789
  #
14895
14790
  # @!attribute [rw] performance_insights_retention_period
14896
- # The number of days to retain Performance Insights data. The default
14897
- # is 7 days. The following values are valid:
14898
- #
14899
- # * 7
14900
- #
14901
- # * *month* * 31, where *month* is a number of months from 1-23
14791
+ # The number of days to retain Performance Insights data.
14902
14792
  #
14903
- # * 731
14904
- #
14905
- # For example, the following values are valid:
14793
+ # Valid for Cluster Type: Multi-AZ DB clusters only
14906
14794
  #
14907
- # * 93 (3 months * 31)
14795
+ # Valid Values:
14908
14796
  #
14909
- # * 341 (11 months * 31)
14797
+ # * `7`
14910
14798
  #
14911
- # * 589 (19 months * 31)
14799
+ # * *month* * 31, where *month* is a number of months from 1-23.
14800
+ # Examples: `93` (3 months * 31), `341` (11 months * 31), `589`
14801
+ # (19 months * 31)
14912
14802
  #
14913
- # * 731
14803
+ # * `731`
14914
14804
  #
14915
- # If you specify a retention period such as 94, which isn't a valid
14916
- # value, RDS issues an error.
14805
+ # Default: `7` days
14917
14806
  #
14918
- # Valid for: Multi-AZ DB clusters only
14807
+ # If you specify a retention period that isn't valid, such as `94`,
14808
+ # Amazon RDS issues an error.
14919
14809
  # @return [Integer]
14920
14810
  #
14921
14811
  # @!attribute [rw] serverless_v2_scaling_configuration
@@ -14933,12 +14823,6 @@ module Aws::RDS
14933
14823
  # @!attribute [rw] network_type
14934
14824
  # The network type of the DB cluster.
14935
14825
  #
14936
- # Valid values:
14937
- #
14938
- # * `IPV4`
14939
- #
14940
- # * `DUAL`
14941
- #
14942
14826
  # The network type is determined by the `DBSubnetGroup` specified for
14943
14827
  # the DB cluster. A `DBSubnetGroup` can support only the IPv4 protocol
14944
14828
  # or the IPv4 and the IPv6 protocols (`DUAL`).
@@ -14946,7 +14830,9 @@ module Aws::RDS
14946
14830
  # For more information, see [ Working with a DB instance in a VPC][1]
14947
14831
  # in the *Amazon Aurora User Guide.*
14948
14832
  #
14949
- # Valid for: Aurora DB clusters only
14833
+ # Valid for Cluster Type: Aurora DB clusters only
14834
+ #
14835
+ # Valid Values: `IPV4 | DUAL`
14950
14836
  #
14951
14837
  #
14952
14838
  #
@@ -14954,8 +14840,8 @@ module Aws::RDS
14954
14840
  # @return [String]
14955
14841
  #
14956
14842
  # @!attribute [rw] manage_master_user_password
14957
- # A value that indicates whether to manage the master user password
14958
- # with Amazon Web Services Secrets Manager.
14843
+ # Specifies whether to manage the master user password with Amazon Web
14844
+ # Services Secrets Manager.
14959
14845
  #
14960
14846
  # If the DB cluster doesn't manage the master user password with
14961
14847
  # Amazon Web Services Secrets Manager, you can turn on this
@@ -14973,7 +14859,7 @@ module Aws::RDS
14973
14859
  # [Password management with Amazon Web Services Secrets Manager][2] in
14974
14860
  # the *Amazon Aurora User Guide.*
14975
14861
  #
14976
- # Valid for: Aurora DB clusters and Multi-AZ DB clusters
14862
+ # Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
14977
14863
  #
14978
14864
  #
14979
14865
  #
@@ -14982,8 +14868,8 @@ module Aws::RDS
14982
14868
  # @return [Boolean]
14983
14869
  #
14984
14870
  # @!attribute [rw] rotate_master_user_password
14985
- # A value that indicates whether to rotate the secret managed by
14986
- # Amazon Web Services Secrets Manager for the master user password.
14871
+ # Specifies whether to rotate the secret managed by Amazon Web
14872
+ # Services Secrets Manager for the master user password.
14987
14873
  #
14988
14874
  # This setting is valid only if the master user password is managed by
14989
14875
  # RDS in Amazon Web Services Secrets Manager for the DB cluster. The
@@ -14994,6 +14880,8 @@ module Aws::RDS
14994
14880
  # [Password management with Amazon Web Services Secrets Manager][2] in
14995
14881
  # the *Amazon Aurora User Guide.*
14996
14882
  #
14883
+ # Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
14884
+ #
14997
14885
  # Constraints:
14998
14886
  #
14999
14887
  # * You must apply the change immediately when rotating the master
@@ -15001,8 +14889,6 @@ module Aws::RDS
15001
14889
  #
15002
14890
  # ^
15003
14891
  #
15004
- # Valid for: Aurora DB clusters and Multi-AZ DB clusters
15005
- #
15006
14892
  #
15007
14893
  #
15008
14894
  # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html
@@ -15043,7 +14929,7 @@ module Aws::RDS
15043
14929
  # Your Amazon Web Services account has a different default KMS key for
15044
14930
  # each Amazon Web Services Region.
15045
14931
  #
15046
- # Valid for: Aurora DB clusters and Multi-AZ DB clusters
14932
+ # Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
15047
14933
  # @return [String]
15048
14934
  #
15049
14935
  # @!attribute [rw] engine_mode
@@ -15057,7 +14943,7 @@ module Aws::RDS
15057
14943
  #
15058
14944
  # For more information, see [ CreateDBCluster][1].
15059
14945
  #
15060
- # Valid for: Aurora DB clusters only
14946
+ # Valid for Cluster Type: Aurora DB clusters only
15061
14947
  #
15062
14948
  #
15063
14949
  #
@@ -15065,14 +14951,18 @@ module Aws::RDS
15065
14951
  # @return [String]
15066
14952
  #
15067
14953
  # @!attribute [rw] allow_engine_mode_change
15068
- # A value that indicates whether engine mode changes from `serverless`
15069
- # to `provisioned` are allowed.
14954
+ # Specifies whether engine mode changes from `serverless` to
14955
+ # `provisioned` are allowed.
14956
+ #
14957
+ # Valid for Cluster Type: Aurora Serverless v1 DB clusters only
15070
14958
  #
15071
- # Constraints: You must allow engine mode changes when specifying a
15072
- # different value for the `EngineMode` parameter from the DB
15073
- # cluster's current engine mode.
14959
+ # Constraints:
14960
+ #
14961
+ # * You must allow engine mode changes when specifying a different
14962
+ # value for the `EngineMode` parameter from the DB cluster's
14963
+ # current engine mode.
15074
14964
  #
15075
- # Valid for: Aurora Serverless v1 DB clusters only
14965
+ # ^
15076
14966
  # @return [Boolean]
15077
14967
  #
15078
14968
  # @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/ModifyDBClusterMessage AWS API Documentation
@@ -15270,12 +15160,12 @@ module Aws::RDS
15270
15160
  end
15271
15161
 
15272
15162
  # @!attribute [rw] db_instance_identifier
15273
- # The DB instance identifier. This value is stored as a lowercase
15274
- # string.
15163
+ # The identifier of DB instance to modify. This value is stored as a
15164
+ # lowercase string.
15275
15165
  #
15276
15166
  # Constraints:
15277
15167
  #
15278
- # * Must match the identifier of an existing DBInstance.
15168
+ # * Must match the identifier of an existing DB instance.
15279
15169
  #
15280
15170
  # ^
15281
15171
  # @return [String]
@@ -15284,10 +15174,11 @@ module Aws::RDS
15284
15174
  # The new amount of storage in gibibytes (GiB) to allocate for the DB
15285
15175
  # instance.
15286
15176
  #
15287
- # For MariaDB, MySQL, Oracle, and PostgreSQL, the value supplied must
15288
- # be at least 10% greater than the current value. Values that are not
15289
- # at least 10% greater than the existing value are rounded up so that
15290
- # they are 10% greater than the current value.
15177
+ # For RDS for MariaDB, RDS for MySQL, RDS for Oracle, and RDS for
15178
+ # PostgreSQL, the value supplied must be at least 10% greater than the
15179
+ # current value. Values that are not at least 10% greater than the
15180
+ # existing value are rounded up so that they are 10% greater than the
15181
+ # current value.
15291
15182
  #
15292
15183
  # For the valid values for allocated storage for each engine, see
15293
15184
  # `CreateDBInstance`.
@@ -15295,11 +15186,11 @@ module Aws::RDS
15295
15186
  #
15296
15187
  # @!attribute [rw] db_instance_class
15297
15188
  # The new compute and memory capacity of the DB instance, for example
15298
- # db.m4.large. Not all DB instance classes are available in all Amazon
15299
- # Web Services Regions, or for all database engines. For the full list
15300
- # of DB instance classes, and availability for your engine, see [DB
15301
- # Instance Class][1] in the *Amazon RDS User Guide* or [Aurora DB
15302
- # instance classes][2] in the *Amazon Aurora User Guide*. For RDS
15189
+ # `db.m4.large`. Not all DB instance classes are available in all
15190
+ # Amazon Web Services Regions, or for all database engines. For the
15191
+ # full list of DB instance classes, and availability for your engine,
15192
+ # see [DB Instance Class][1] in the *Amazon RDS User Guide* or [Aurora
15193
+ # DB instance classes][2] in the *Amazon Aurora User Guide*. For RDS
15303
15194
  # Custom, see [DB instance class support for RDS Custom for Oracle][3]
15304
15195
  # and [ DB instance class support for RDS Custom for SQL Server][4].
15305
15196
  #
@@ -15328,10 +15219,13 @@ module Aws::RDS
15328
15219
  # change is applied during the next maintenance window, unless you
15329
15220
  # enable `ApplyImmediately`.
15330
15221
  #
15331
- # This parameter doesn't apply to RDS Custom.
15222
+ # This parameter doesn't apply to RDS Custom DB instances.
15332
15223
  #
15333
- # Constraints: If supplied, must match the name of an existing
15334
- # DBSubnetGroup.
15224
+ # Constraints:
15225
+ #
15226
+ # * If supplied, must match existing DB subnet group.
15227
+ #
15228
+ # ^
15335
15229
  #
15336
15230
  # Example: `mydbsubnetgroup`
15337
15231
  #
@@ -15345,39 +15239,39 @@ module Aws::RDS
15345
15239
  # Changing this setting doesn't result in an outage and the change is
15346
15240
  # asynchronously applied as soon as possible.
15347
15241
  #
15348
- # This setting doesn't apply to RDS Custom.
15242
+ # This setting doesn't apply to RDS Custom DB instances.
15349
15243
  #
15350
15244
  # Constraints:
15351
15245
  #
15352
- # * If supplied, must match existing DBSecurityGroups.
15246
+ # * If supplied, must match existing DB security groups.
15353
15247
  #
15354
15248
  # ^
15355
15249
  # @return [Array<String>]
15356
15250
  #
15357
15251
  # @!attribute [rw] vpc_security_group_ids
15358
- # A list of Amazon EC2 VPC security groups to authorize on this DB
15252
+ # A list of Amazon EC2 VPC security groups to associate with this DB
15359
15253
  # instance. This change is asynchronously applied as soon as possible.
15360
15254
  #
15361
- # This setting doesn't apply to RDS Custom.
15255
+ # This setting doesn't apply to the following DB instances:
15362
15256
  #
15363
- # **Amazon Aurora**
15257
+ # * Amazon Aurora (The associated list of EC2 VPC security groups is
15258
+ # managed by the DB cluster. For more information, see
15259
+ # `ModifyDBCluster`.)
15364
15260
  #
15365
- # Not applicable. The associated list of EC2 VPC security groups is
15366
- # managed by the DB cluster. For more information, see
15367
- # `ModifyDBCluster`.
15261
+ # * RDS Custom
15368
15262
  #
15369
15263
  # Constraints:
15370
15264
  #
15371
- # * If supplied, must match existing VpcSecurityGroupIds.
15265
+ # * If supplied, must match existing VPC security group IDs.
15372
15266
  #
15373
15267
  # ^
15374
15268
  # @return [Array<String>]
15375
15269
  #
15376
15270
  # @!attribute [rw] apply_immediately
15377
- # A value that indicates whether the modifications in this request and
15378
- # any pending modifications are asynchronously applied as soon as
15379
- # possible, regardless of the `PreferredMaintenanceWindow` setting for
15380
- # the DB instance. By default, this parameter is disabled.
15271
+ # Specifies whether the modifications in this request and any pending
15272
+ # modifications are asynchronously applied as soon as possible,
15273
+ # regardless of the `PreferredMaintenanceWindow` setting for the DB
15274
+ # instance. By default, this parameter is disabled.
15381
15275
  #
15382
15276
  # If this parameter is disabled, changes to the DB instance are
15383
15277
  # applied during the next maintenance window. Some parameter changes
@@ -15394,8 +15288,7 @@ module Aws::RDS
15394
15288
  # @return [Boolean]
15395
15289
  #
15396
15290
  # @!attribute [rw] master_user_password
15397
- # The new password for the master user. The password can include any
15398
- # printable ASCII character except "/", """, or "@".
15291
+ # The new password for the master user.
15399
15292
  #
15400
15293
  # Changing this parameter doesn't result in an outage and the change
15401
15294
  # is asynchronously applied as soon as possible. Between the time of
@@ -15403,44 +15296,41 @@ module Aws::RDS
15403
15296
  # `MasterUserPassword` element exists in the `PendingModifiedValues`
15404
15297
  # element of the operation response.
15405
15298
  #
15406
- # This setting doesn't apply to RDS Custom.
15407
- #
15408
- # **Amazon Aurora**
15409
- #
15410
- # Not applicable. The password for the master user is managed by the
15411
- # DB cluster. For more information, see `ModifyDBCluster`.
15299
+ # <note markdown="1"> Amazon RDS API operations never return the password, so this action
15300
+ # provides a way to regain access to a primary instance user if the
15301
+ # password is lost. This includes restoring privileges that might have
15302
+ # been accidentally revoked.
15412
15303
  #
15413
- # Default: Uses existing setting
15304
+ # </note>
15414
15305
  #
15415
- # Constraints: Can't be specified if `ManageMasterUserPassword` is
15416
- # turned on.
15306
+ # This setting doesn't apply to the following DB instances:
15417
15307
  #
15418
- # **MariaDB**
15308
+ # * Amazon Aurora (The password for the master user is managed by the
15309
+ # DB cluster. For more information, see `ModifyDBCluster`.)
15419
15310
  #
15420
- # Constraints: Must contain from 8 to 41 characters.
15311
+ # * RDS Custom
15421
15312
  #
15422
- # **Microsoft SQL Server**
15313
+ # Default: Uses existing setting
15423
15314
  #
15424
- # Constraints: Must contain from 8 to 128 characters.
15315
+ # Constraints:
15425
15316
  #
15426
- # **MySQL**
15317
+ # * Can't be specified if `ManageMasterUserPassword` is turned on.
15427
15318
  #
15428
- # Constraints: Must contain from 8 to 41 characters.
15319
+ # * Can include any printable ASCII character except "/", """, or
15320
+ # "@".
15429
15321
  #
15430
- # **Oracle**
15322
+ # Length Constraints:
15431
15323
  #
15432
- # Constraints: Must contain from 8 to 30 characters.
15324
+ # * RDS for MariaDB - Must contain from 8 to 41 characters.
15433
15325
  #
15434
- # **PostgreSQL**
15326
+ # * RDS for Microsoft SQL Server - Must contain from 8 to 128
15327
+ # characters.
15435
15328
  #
15436
- # Constraints: Must contain from 8 to 128 characters.
15329
+ # * RDS for MySQL - Must contain from 8 to 41 characters.
15437
15330
  #
15438
- # <note markdown="1"> Amazon RDS API operations never return the password, so this action
15439
- # provides a way to regain access to a primary instance user if the
15440
- # password is lost. This includes restoring privileges that might have
15441
- # been accidentally revoked.
15331
+ # * RDS for Oracle - Must contain from 8 to 30 characters.
15442
15332
  #
15443
- # </note>
15333
+ # * RDS for PostgreSQL - Must contain from 8 to 128 characters.
15444
15334
  # @return [String]
15445
15335
  #
15446
15336
  # @!attribute [rw] db_parameter_group_name
@@ -15455,12 +15345,15 @@ module Aws::RDS
15455
15345
  # in the newly associated DB parameter group, these changes are
15456
15346
  # applied immediately without a reboot.
15457
15347
  #
15458
- # This setting doesn't apply to RDS Custom.
15348
+ # This setting doesn't apply to RDS Custom DB instances.
15459
15349
  #
15460
15350
  # Default: Uses existing setting
15461
15351
  #
15462
- # Constraints: The DB parameter group must be in the same DB parameter
15463
- # group family as the DB instance.
15352
+ # Constraints:
15353
+ #
15354
+ # * Must be in the same DB parameter group family as the DB instance.
15355
+ #
15356
+ # ^
15464
15357
  # @return [String]
15465
15358
  #
15466
15359
  # @!attribute [rw] backup_retention_period
@@ -15479,25 +15372,20 @@ module Aws::RDS
15479
15372
  # change the parameter from one non-zero value to another non-zero
15480
15373
  # value, the change is asynchronously applied as soon as possible.
15481
15374
  #
15482
- # **Amazon Aurora**
15483
- #
15484
- # Not applicable. The retention period for automated backups is
15485
- # managed by the DB cluster. For more information, see
15486
- # `ModifyDBCluster`.
15375
+ # This setting doesn't apply to Amazon Aurora DB instances. The
15376
+ # retention period for automated backups is managed by the DB cluster.
15377
+ # For more information, see `ModifyDBCluster`.
15487
15378
  #
15488
15379
  # Default: Uses existing setting
15489
15380
  #
15490
15381
  # Constraints:
15491
15382
  #
15492
- # * It must be a value from 0 to 35. It can't be set to 0 if the DB
15493
- # instance is a source to read replicas. It can't be set to 0 for
15494
- # an RDS Custom for Oracle DB instance.
15383
+ # * Must be a value from 0 to 35.
15495
15384
  #
15496
- # * It can be specified for a MySQL read replica only if the source is
15497
- # running MySQL 5.6 or later.
15385
+ # * Can't be set to 0 if the DB instance is a source to read
15386
+ # replicas.
15498
15387
  #
15499
- # * It can be specified for a PostgreSQL read replica only if the
15500
- # source is running PostgreSQL 9.3.5.
15388
+ # * Can't be set to 0 for an RDS Custom for Oracle DB instance.
15501
15389
  # @return [Integer]
15502
15390
  #
15503
15391
  # @!attribute [rw] preferred_backup_window
@@ -15508,23 +15396,21 @@ module Aws::RDS
15508
15396
  # as possible. The default is a 30-minute window selected at random
15509
15397
  # from an 8-hour block of time for each Amazon Web Services Region.
15510
15398
  # For more information, see [Backup window][1] in the *Amazon RDS User
15511
- # Guide.*
15512
- #
15513
- # **Amazon Aurora**
15399
+ # Guide*.
15514
15400
  #
15515
- # Not applicable. The daily time range for creating automated backups
15516
- # is managed by the DB cluster. For more information, see
15517
- # `ModifyDBCluster`.
15401
+ # This setting doesn't apply to Amazon Aurora DB instances. The daily
15402
+ # time range for creating automated backups is managed by the DB
15403
+ # cluster. For more information, see `ModifyDBCluster`.
15518
15404
  #
15519
15405
  # Constraints:
15520
15406
  #
15521
- # * Must be in the format hh24:mi-hh24:mi
15407
+ # * Must be in the format `hh24:mi-hh24:mi`.
15522
15408
  #
15523
- # * Must be in Universal Time Coordinated (UTC)
15409
+ # * Must be in Universal Coordinated Time (UTC).
15524
15410
  #
15525
- # * Must not conflict with the preferred maintenance window
15411
+ # * Must not conflict with the preferred maintenance window.
15526
15412
  #
15527
- # * Must be at least 30 minutes
15413
+ # * Must be at least 30 minutes.
15528
15414
  #
15529
15415
  #
15530
15416
  #
@@ -15532,13 +15418,13 @@ module Aws::RDS
15532
15418
  # @return [String]
15533
15419
  #
15534
15420
  # @!attribute [rw] preferred_maintenance_window
15535
- # The weekly time range (in UTC) during which system maintenance can
15536
- # occur, which might result in an outage. Changing this parameter
15537
- # doesn't result in an outage, except in the following situation, and
15538
- # the change is asynchronously applied as soon as possible. If there
15539
- # are pending actions that cause a reboot, and the maintenance window
15540
- # is changed to include the current time, then changing this parameter
15541
- # will cause a reboot of the DB instance. If moving this window to the
15421
+ # The weekly time range during which system maintenance can occur,
15422
+ # which might result in an outage. Changing this parameter doesn't
15423
+ # result in an outage, except in the following situation, and the
15424
+ # change is asynchronously applied as soon as possible. If there are
15425
+ # pending actions that cause a reboot, and the maintenance window is
15426
+ # changed to include the current time, then changing this parameter
15427
+ # causes a reboot of the DB instance. If you change this window to the
15542
15428
  # current time, there must be at least 30 minutes between the current
15543
15429
  # time and end of the window to ensure pending changes are applied.
15544
15430
  #
@@ -15547,11 +15433,17 @@ module Aws::RDS
15547
15433
  #
15548
15434
  # Default: Uses existing setting
15549
15435
  #
15550
- # Format: ddd:hh24:mi-ddd:hh24:mi
15436
+ # Constraints:
15437
+ #
15438
+ # * Must be in the format `ddd:hh24:mi-ddd:hh24:mi`.
15439
+ #
15440
+ # * The day values must be `mon | tue | wed | thu | fri | sat | sun`.
15441
+ #
15442
+ # * Must be in Universal Coordinated Time (UTC).
15551
15443
  #
15552
- # Valid Days: Mon \| Tue \| Wed \| Thu \| Fri \| Sat \| Sun
15444
+ # * Must not conflict with the preferred backup window.
15553
15445
  #
15554
- # Constraints: Must be at least 30 minutes
15446
+ # * Must be at least 30 minutes.
15555
15447
  #
15556
15448
  #
15557
15449
  #
@@ -15559,12 +15451,12 @@ module Aws::RDS
15559
15451
  # @return [String]
15560
15452
  #
15561
15453
  # @!attribute [rw] multi_az
15562
- # A value that indicates whether the DB instance is a Multi-AZ
15563
- # deployment. Changing this parameter doesn't result in an outage.
15564
- # The change is applied during the next maintenance window unless the
15565
- # `ApplyImmediately` parameter is enabled for this request.
15454
+ # Specifies whether the DB instance is a Multi-AZ deployment. Changing
15455
+ # this parameter doesn't result in an outage. The change is applied
15456
+ # during the next maintenance window unless the `ApplyImmediately`
15457
+ # parameter is enabled for this request.
15566
15458
  #
15567
- # This setting doesn't apply to RDS Custom.
15459
+ # This setting doesn't apply to RDS Custom DB instances.
15568
15460
  # @return [Boolean]
15569
15461
  #
15570
15462
  # @!attribute [rw] engine_version
@@ -15579,13 +15471,13 @@ module Aws::RDS
15579
15471
  # parameter group can be the default for that DB parameter group
15580
15472
  # family.
15581
15473
  #
15582
- # If you specify only a major version, Amazon RDS will update the DB
15474
+ # If you specify only a major version, Amazon RDS updates the DB
15583
15475
  # instance to the default minor version if the current minor version
15584
15476
  # is lower. For information about valid engine versions, see
15585
15477
  # `CreateDBInstance`, or call `DescribeDBEngineVersions`.
15586
15478
  #
15587
15479
  # If the instance that you're modifying is acting as a read replica,
15588
- # the engine version that you specify must be the same or later than
15480
+ # the engine version that you specify must be the same or higher than
15589
15481
  # the version that the source DB instance or cluster is running.
15590
15482
  #
15591
15483
  # In RDS Custom for Oracle, this parameter is supported for read
@@ -15593,21 +15485,25 @@ module Aws::RDS
15593
15485
  # @return [String]
15594
15486
  #
15595
15487
  # @!attribute [rw] allow_major_version_upgrade
15596
- # A value that indicates whether major version upgrades are allowed.
15597
- # Changing this parameter doesn't result in an outage and the change
15598
- # is asynchronously applied as soon as possible.
15488
+ # Specifies whether major version upgrades are allowed. Changing this
15489
+ # parameter doesn't result in an outage and the change is
15490
+ # asynchronously applied as soon as possible.
15599
15491
  #
15600
- # This setting doesn't apply to RDS Custom.
15492
+ # This setting doesn't apply to RDS Custom DB instances.
15493
+ #
15494
+ # Constraints:
15495
+ #
15496
+ # * Major version upgrades must be allowed when specifying a value for
15497
+ # the `EngineVersion` parameter that's a different major version
15498
+ # than the DB instance's current version.
15601
15499
  #
15602
- # Constraints: Major version upgrades must be allowed when specifying
15603
- # a value for the EngineVersion parameter that is a different major
15604
- # version than the DB instance's current version.
15500
+ # ^
15605
15501
  # @return [Boolean]
15606
15502
  #
15607
15503
  # @!attribute [rw] auto_minor_version_upgrade
15608
- # A value that indicates whether minor version upgrades are applied
15609
- # automatically to the DB instance during the maintenance window. An
15610
- # outage occurs when all the following conditions are met:
15504
+ # Specifies whether minor version upgrades are applied automatically
15505
+ # to the DB instance during the maintenance window. An outage occurs
15506
+ # when all the following conditions are met:
15611
15507
  #
15612
15508
  # * The automatic upgrade is enabled for the maintenance window.
15613
15509
  #
@@ -15615,20 +15511,30 @@ module Aws::RDS
15615
15511
  #
15616
15512
  # * RDS has enabled automatic patching for the engine version.
15617
15513
  #
15618
- # If any of the preceding conditions isn't met, RDS applies the
15619
- # change as soon as possible and doesn't cause an outage.
15514
+ # If any of the preceding conditions isn't met, Amazon RDS applies
15515
+ # the change as soon as possible and doesn't cause an outage.
15620
15516
  #
15621
- # For an RDS Custom DB instance, set `AutoMinorVersionUpgrade` to
15622
- # `false`. Otherwise, the operation returns an error.
15517
+ # For an RDS Custom DB instance, don't enable this setting.
15518
+ # Otherwise, the operation returns an error.
15623
15519
  # @return [Boolean]
15624
15520
  #
15625
15521
  # @!attribute [rw] license_model
15626
15522
  # The license model for the DB instance.
15627
15523
  #
15628
- # This setting doesn't apply to RDS Custom.
15524
+ # This setting doesn't apply to Amazon Aurora or RDS Custom DB
15525
+ # instances.
15629
15526
  #
15630
- # Valid values: `license-included` \| `bring-your-own-license` \|
15631
- # `general-public-license`
15527
+ # Valid Values:
15528
+ #
15529
+ # * RDS for MariaDB - `general-public-license`
15530
+ #
15531
+ # * RDS for Microsoft SQL Server - `license-included`
15532
+ #
15533
+ # * RDS for MySQL - `general-public-license`
15534
+ #
15535
+ # * RDS for Oracle - `bring-your-own-license | license-included`
15536
+ #
15537
+ # * RDS for PostgreSQL - `postgresql-license`
15632
15538
  # @return [String]
15633
15539
  #
15634
15540
  # @!attribute [rw] iops
@@ -15658,17 +15564,21 @@ module Aws::RDS
15658
15564
  # read replica for the instance, and creating a DB snapshot of the
15659
15565
  # instance.
15660
15566
  #
15661
- # Constraints: For MariaDB, MySQL, Oracle, and PostgreSQL, the value
15662
- # supplied must be at least 10% greater than the current value. Values
15663
- # that are not at least 10% greater than the existing value are
15664
- # rounded up so that they are 10% greater than the current value.
15567
+ # Constraints:
15568
+ #
15569
+ # * For RDS for MariaDB, RDS for MySQL, RDS for Oracle, and RDS for
15570
+ # PostgreSQL - The value supplied must be at least 10% greater than
15571
+ # the current value. Values that are not at least 10% greater than
15572
+ # the existing value are rounded up so that they are 10% greater
15573
+ # than the current value.
15574
+ #
15575
+ # ^
15665
15576
  #
15666
15577
  # Default: Uses existing setting
15667
15578
  # @return [Integer]
15668
15579
  #
15669
15580
  # @!attribute [rw] option_group_name
15670
- # A value that indicates the DB instance should be associated with the
15671
- # specified option group.
15581
+ # The option group to associate the DB instance with.
15672
15582
  #
15673
15583
  # Changing this parameter doesn't result in an outage, with one
15674
15584
  # exception. If the parameter change results in an option group that
@@ -15684,17 +15594,17 @@ module Aws::RDS
15684
15594
  # option group can't be removed from a DB instance after it is
15685
15595
  # associated with a DB instance.
15686
15596
  #
15687
- # This setting doesn't apply to RDS Custom.
15597
+ # This setting doesn't apply to RDS Custom DB instances.
15688
15598
  # @return [String]
15689
15599
  #
15690
15600
  # @!attribute [rw] new_db_instance_identifier
15691
- # The new DB instance identifier for the DB instance when renaming a
15692
- # DB instance. When you change the DB instance identifier, an instance
15693
- # reboot occurs immediately if you enable `ApplyImmediately`, or will
15694
- # occur during the next maintenance window if you disable Apply
15695
- # Immediately. This value is stored as a lowercase string.
15601
+ # The new identifier for the DB instance when renaming a DB instance.
15602
+ # When you change the DB instance identifier, an instance reboot
15603
+ # occurs immediately if you enable `ApplyImmediately`, or will occur
15604
+ # during the next maintenance window if you disable
15605
+ # `ApplyImmediately`. This value is stored as a lowercase string.
15696
15606
  #
15697
- # This setting doesn't apply to RDS Custom.
15607
+ # This setting doesn't apply to RDS Custom DB instances.
15698
15608
  #
15699
15609
  # Constraints:
15700
15610
  #
@@ -15708,7 +15618,7 @@ module Aws::RDS
15708
15618
  # @return [String]
15709
15619
  #
15710
15620
  # @!attribute [rw] storage_type
15711
- # Specifies the storage type to be associated with the DB instance.
15621
+ # The storage type to associate with the DB instance.
15712
15622
  #
15713
15623
  # If you specify Provisioned IOPS (`io1`), you must also include a
15714
15624
  # value for the `Iops` parameter.
@@ -15729,30 +15639,31 @@ module Aws::RDS
15729
15639
  # read replica for the instance, and creating a DB snapshot of the
15730
15640
  # instance.
15731
15641
  #
15732
- # Valid values: `gp2 | gp3 | io1 | standard`
15642
+ # Valid Values: `gp2 | gp3 | io1 | standard`
15733
15643
  #
15734
- # Default: `io1` if the `Iops` parameter is specified, otherwise `gp2`
15644
+ # Default: `io1`, if the `Iops` parameter is specified. Otherwise,
15645
+ # `gp2`.
15735
15646
  # @return [String]
15736
15647
  #
15737
15648
  # @!attribute [rw] tde_credential_arn
15738
15649
  # The ARN from the key store with which to associate the instance for
15739
15650
  # TDE encryption.
15740
15651
  #
15741
- # This setting doesn't apply to RDS Custom.
15652
+ # This setting doesn't apply to RDS Custom DB instances.
15742
15653
  # @return [String]
15743
15654
  #
15744
15655
  # @!attribute [rw] tde_credential_password
15745
15656
  # The password for the given ARN from the key store in order to access
15746
15657
  # the device.
15747
15658
  #
15748
- # This setting doesn't apply to RDS Custom.
15659
+ # This setting doesn't apply to RDS Custom DB instances.
15749
15660
  # @return [String]
15750
15661
  #
15751
15662
  # @!attribute [rw] ca_certificate_identifier
15752
- # Specifies the CA certificate identifier to use for the DB instance’s
15753
- # server certificate.
15663
+ # The CA certificate identifier to use for the DB instance6's server
15664
+ # certificate.
15754
15665
  #
15755
- # This setting doesn't apply to RDS Custom.
15666
+ # This setting doesn't apply to RDS Custom DB instances.
15756
15667
  #
15757
15668
  # For more information, see [Using SSL/TLS to encrypt a connection to
15758
15669
  # a DB instance][1] in the *Amazon RDS User Guide* and [ Using SSL/TLS
@@ -15775,7 +15686,7 @@ module Aws::RDS
15775
15686
  # For more information, see [ Kerberos Authentication][1] in the
15776
15687
  # *Amazon RDS User Guide*.
15777
15688
  #
15778
- # This setting doesn't apply to RDS Custom.
15689
+ # This setting doesn't apply to RDS Custom DB instances.
15779
15690
  #
15780
15691
  #
15781
15692
  #
@@ -15783,28 +15694,28 @@ module Aws::RDS
15783
15694
  # @return [String]
15784
15695
  #
15785
15696
  # @!attribute [rw] copy_tags_to_snapshot
15786
- # A value that indicates whether to copy all tags from the DB instance
15787
- # to snapshots of the DB instance. By default, tags are not copied.
15788
- #
15789
- # **Amazon Aurora**
15697
+ # Specifies whether to copy all tags from the DB instance to snapshots
15698
+ # of the DB instance. By default, tags aren't copied.
15790
15699
  #
15791
- # Not applicable. Copying tags to snapshots is managed by the DB
15792
- # cluster. Setting this value for an Aurora DB instance has no effect
15793
- # on the DB cluster setting. For more information, see
15794
- # `ModifyDBCluster`.
15700
+ # This setting doesn't apply to Amazon Aurora DB instances. Copying
15701
+ # tags to snapshots is managed by the DB cluster. Setting this value
15702
+ # for an Aurora DB instance has no effect on the DB cluster setting.
15703
+ # For more information, see `ModifyDBCluster`.
15795
15704
  # @return [Boolean]
15796
15705
  #
15797
15706
  # @!attribute [rw] monitoring_interval
15798
15707
  # The interval, in seconds, between points when Enhanced Monitoring
15799
- # metrics are collected for the DB instance. To disable collecting
15800
- # Enhanced Monitoring metrics, specify 0, which is the default.
15708
+ # metrics are collected for the DB instance. To disable collection of
15709
+ # Enhanced Monitoring metrics, specify `0`.
15801
15710
  #
15802
15711
  # If `MonitoringRoleArn` is specified, set `MonitoringInterval` to a
15803
- # value other than 0.
15712
+ # value other than `0`.
15804
15713
  #
15805
- # This setting doesn't apply to RDS Custom.
15714
+ # This setting doesn't apply to RDS Custom DB instances.
15806
15715
  #
15807
- # Valid Values: `0, 1, 5, 10, 15, 30, 60`
15716
+ # Valid Values: `0 | 1 | 5 | 10 | 15 | 30 | 60`
15717
+ #
15718
+ # Default: `0`
15808
15719
  # @return [Integer]
15809
15720
  #
15810
15721
  # @!attribute [rw] db_port_number
@@ -15817,51 +15728,34 @@ module Aws::RDS
15817
15728
  # If you change the `DBPortNumber` value, your database restarts
15818
15729
  # regardless of the value of the `ApplyImmediately` parameter.
15819
15730
  #
15820
- # This setting doesn't apply to RDS Custom.
15821
- #
15822
- # **MySQL**
15823
- #
15824
- # Default: `3306`
15825
- #
15826
- # Valid values: `1150-65535`
15731
+ # This setting doesn't apply to RDS Custom DB instances.
15827
15732
  #
15828
- # **MariaDB**
15829
- #
15830
- # Default: `3306`
15831
- #
15832
- # Valid values: `1150-65535`
15833
- #
15834
- # **PostgreSQL**
15835
- #
15836
- # Default: `5432`
15837
- #
15838
- # Valid values: `1150-65535`
15733
+ # Valid Values: `1150-65535`
15839
15734
  #
15840
- # Type: Integer
15735
+ # Default:
15841
15736
  #
15842
- # **Oracle**
15737
+ # * Amazon Aurora - `3306`
15843
15738
  #
15844
- # Default: `1521`
15739
+ # * RDS for MariaDB - `3306`
15845
15740
  #
15846
- # Valid values: `1150-65535`
15741
+ # * RDS for Microsoft SQL Server - `1433`
15847
15742
  #
15848
- # **SQL Server**
15743
+ # * RDS for MySQL - `3306`
15849
15744
  #
15850
- # Default: `1433`
15745
+ # * RDS for Oracle - `1521`
15851
15746
  #
15852
- # Valid values: `1150-65535` except `1234`, `1434`, `3260`, `3343`,
15853
- # `3389`, `47001`, and `49152-49156`.
15747
+ # * RDS for PostgreSQL - `5432`
15854
15748
  #
15855
- # **Amazon Aurora**
15749
+ # Constraints:
15856
15750
  #
15857
- # Default: `3306`
15751
+ # * For RDS for Microsoft SQL Server, the value can't be `1234`,
15752
+ # `1434`, `3260`, `3343`, `3389`, `47001`, or `49152-49156`.
15858
15753
  #
15859
- # Valid values: `1150-65535`
15754
+ # ^
15860
15755
  # @return [Integer]
15861
15756
  #
15862
15757
  # @!attribute [rw] publicly_accessible
15863
- # A value that indicates whether the DB instance is publicly
15864
- # accessible.
15758
+ # Specifies whether the DB instance is publicly accessible.
15865
15759
  #
15866
15760
  # When the DB cluster is publicly accessible, its Domain Name System
15867
15761
  # (DNS) endpoint resolves to the private IP address from within the DB
@@ -15890,10 +15784,10 @@ module Aws::RDS
15890
15784
  # creating a monitoring role, see [To create an IAM role for Amazon
15891
15785
  # RDS Enhanced Monitoring][1] in the *Amazon RDS User Guide.*
15892
15786
  #
15893
- # If `MonitoringInterval` is set to a value other than 0, supply a
15787
+ # If `MonitoringInterval` is set to a value other than `0`, supply a
15894
15788
  # `MonitoringRoleArn` value.
15895
15789
  #
15896
- # This setting doesn't apply to RDS Custom.
15790
+ # This setting doesn't apply to RDS Custom DB instances.
15897
15791
  #
15898
15792
  #
15899
15793
  #
@@ -15904,30 +15798,30 @@ module Aws::RDS
15904
15798
  # The name of the IAM role to use when making API calls to the
15905
15799
  # Directory Service.
15906
15800
  #
15907
- # This setting doesn't apply to RDS Custom.
15801
+ # This setting doesn't apply to RDS Custom DB instances.
15908
15802
  # @return [String]
15909
15803
  #
15910
15804
  # @!attribute [rw] promotion_tier
15911
- # A value that specifies the order in which an Aurora Replica is
15912
- # promoted to the primary instance after a failure of the existing
15913
- # primary instance. For more information, see [ Fault Tolerance for an
15914
- # Aurora DB Cluster][1] in the *Amazon Aurora User Guide*.
15805
+ # The order of priority in which an Aurora Replica is promoted to the
15806
+ # primary instance after a failure of the existing primary instance.
15807
+ # For more information, see [ Fault Tolerance for an Aurora DB
15808
+ # Cluster][1] in the *Amazon Aurora User Guide*.
15915
15809
  #
15916
- # This setting doesn't apply to RDS Custom.
15810
+ # This setting doesn't apply to RDS Custom DB instances.
15917
15811
  #
15918
- # Default: 1
15812
+ # Default: `1`
15919
15813
  #
15920
- # Valid Values: 0 - 15
15814
+ # Valid Values: `0 - 15`
15921
15815
  #
15922
15816
  #
15923
15817
  #
15924
- # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Managing.Backups.html#Aurora.Managing.FaultTolerance
15818
+ # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Concepts.AuroraHighAvailability.html#Aurora.Managing.FaultTolerance
15925
15819
  # @return [Integer]
15926
15820
  #
15927
15821
  # @!attribute [rw] enable_iam_database_authentication
15928
- # A value that indicates whether to enable mapping of Amazon Web
15929
- # Services Identity and Access Management (IAM) accounts to database
15930
- # accounts. By default, mapping isn't enabled.
15822
+ # Specifies whether to enable mapping of Amazon Web Services Identity
15823
+ # and Access Management (IAM) accounts to database accounts. By
15824
+ # default, mapping isn't enabled.
15931
15825
  #
15932
15826
  # This setting doesn't apply to Amazon Aurora. Mapping Amazon Web
15933
15827
  # Services IAM accounts to database accounts is managed by the DB
@@ -15937,7 +15831,7 @@ module Aws::RDS
15937
15831
  # Database Authentication for MySQL and PostgreSQL][1] in the *Amazon
15938
15832
  # RDS User Guide.*
15939
15833
  #
15940
- # This setting doesn't apply to RDS Custom.
15834
+ # This setting doesn't apply to RDS Custom DB instances.
15941
15835
  #
15942
15836
  #
15943
15837
  #
@@ -15945,13 +15839,13 @@ module Aws::RDS
15945
15839
  # @return [Boolean]
15946
15840
  #
15947
15841
  # @!attribute [rw] enable_performance_insights
15948
- # A value that indicates whether to enable Performance Insights for
15949
- # the DB instance.
15842
+ # Specifies whether to enable Performance Insights for the DB
15843
+ # instance.
15950
15844
  #
15951
15845
  # For more information, see [Using Amazon Performance Insights][1] in
15952
15846
  # the *Amazon RDS User Guide*.
15953
15847
  #
15954
- # This setting doesn't apply to RDS Custom.
15848
+ # This setting doesn't apply to RDS Custom DB instances.
15955
15849
  #
15956
15850
  #
15957
15851
  #
@@ -15965,71 +15859,66 @@ module Aws::RDS
15965
15859
  # The Amazon Web Services KMS key identifier is the key ARN, key ID,
15966
15860
  # alias ARN, or alias name for the KMS key.
15967
15861
  #
15968
- # If you do not specify a value for `PerformanceInsightsKMSKeyId`,
15862
+ # If you don't specify a value for `PerformanceInsightsKMSKeyId`,
15969
15863
  # then Amazon RDS uses your default KMS key. There is a default KMS
15970
15864
  # key for your Amazon Web Services account. Your Amazon Web Services
15971
15865
  # account has a different default KMS key for each Amazon Web Services
15972
15866
  # Region.
15973
15867
  #
15974
- # This setting doesn't apply to RDS Custom.
15868
+ # This setting doesn't apply to RDS Custom DB instances.
15975
15869
  # @return [String]
15976
15870
  #
15977
15871
  # @!attribute [rw] performance_insights_retention_period
15978
- # The number of days to retain Performance Insights data. The default
15979
- # is 7 days. The following values are valid:
15872
+ # The number of days to retain Performance Insights data.
15980
15873
  #
15981
- # * 7
15982
- #
15983
- # * *month* * 31, where *month* is a number of months from 1-23
15984
- #
15985
- # * 731
15986
- #
15987
- # For example, the following values are valid:
15874
+ # This setting doesn't apply to RDS Custom DB instances.
15988
15875
  #
15989
- # * 93 (3 months * 31)
15876
+ # Valid Values:
15990
15877
  #
15991
- # * 341 (11 months * 31)
15878
+ # * `7`
15992
15879
  #
15993
- # * 589 (19 months * 31)
15880
+ # * *month* * 31, where *month* is a number of months from 1-23.
15881
+ # Examples: `93` (3 months * 31), `341` (11 months * 31), `589`
15882
+ # (19 months * 31)
15994
15883
  #
15995
- # * 731
15884
+ # * `731`
15996
15885
  #
15997
- # If you specify a retention period such as 94, which isn't a valid
15998
- # value, RDS issues an error.
15886
+ # Default: `7` days
15999
15887
  #
16000
- # This setting doesn't apply to RDS Custom.
15888
+ # If you specify a retention period that isn't valid, such as `94`,
15889
+ # Amazon RDS returns an error.
16001
15890
  # @return [Integer]
16002
15891
  #
16003
15892
  # @!attribute [rw] cloudwatch_logs_export_configuration
16004
- # The configuration setting for the log types to be enabled for export
16005
- # to CloudWatch Logs for a specific DB instance.
15893
+ # The log types to be enabled for export to CloudWatch Logs for a
15894
+ # specific DB instance.
16006
15895
  #
16007
15896
  # A change to the `CloudwatchLogsExportConfiguration` parameter is
16008
15897
  # always applied to the DB instance immediately. Therefore, the
16009
15898
  # `ApplyImmediately` parameter has no effect.
16010
15899
  #
16011
- # This setting doesn't apply to RDS Custom.
15900
+ # This setting doesn't apply to RDS Custom DB instances.
16012
15901
  # @return [Types::CloudwatchLogsExportConfiguration]
16013
15902
  #
16014
15903
  # @!attribute [rw] processor_features
16015
15904
  # The number of CPU cores and the number of threads per core for the
16016
15905
  # DB instance class of the DB instance.
16017
15906
  #
16018
- # This setting doesn't apply to RDS Custom.
15907
+ # This setting doesn't apply to RDS Custom DB instances.
16019
15908
  # @return [Array<Types::ProcessorFeature>]
16020
15909
  #
16021
15910
  # @!attribute [rw] use_default_processor_features
16022
- # A value that indicates whether the DB instance class of the DB
16023
- # instance uses its default processor features.
15911
+ # Specifies whether the DB instance class of the DB instance uses its
15912
+ # default processor features.
16024
15913
  #
16025
- # This setting doesn't apply to RDS Custom.
15914
+ # This setting doesn't apply to RDS Custom DB instances.
16026
15915
  # @return [Boolean]
16027
15916
  #
16028
15917
  # @!attribute [rw] deletion_protection
16029
- # A value that indicates whether the DB instance has deletion
16030
- # protection enabled. The database can't be deleted when deletion
16031
- # protection is enabled. By default, deletion protection isn't
16032
- # enabled. For more information, see [ Deleting a DB Instance][1].
15918
+ # Specifies whether the DB instance has deletion protection enabled.
15919
+ # The database can't be deleted when deletion protection is enabled.
15920
+ # By default, deletion protection isn't enabled. For more
15921
+ # information, see [ Deleting a DB Instance][1].
16033
15922
  #
16034
15923
  #
16035
15924
  #
@@ -16044,7 +15933,7 @@ module Aws::RDS
16044
15933
  # apply to it, see [ Managing capacity automatically with Amazon RDS
16045
15934
  # storage autoscaling][1] in the *Amazon RDS User Guide*.
16046
15935
  #
16047
- # This setting doesn't apply to RDS Custom.
15936
+ # This setting doesn't apply to RDS Custom DB instances.
16048
15937
  #
16049
15938
  #
16050
15939
  #
@@ -16052,8 +15941,8 @@ module Aws::RDS
16052
15941
  # @return [Integer]
16053
15942
  #
16054
15943
  # @!attribute [rw] certificate_rotation_restart
16055
- # A value that indicates whether the DB instance is restarted when you
16056
- # rotate your SSL/TLS certificate.
15944
+ # Specifies whether the DB instance is restarted when you rotate your
15945
+ # SSL/TLS certificate.
16057
15946
  #
16058
15947
  # By default, the DB instance is restarted when you rotate your
16059
15948
  # SSL/TLS certificate. The certificate is not updated until the DB
@@ -16074,7 +15963,7 @@ module Aws::RDS
16074
15963
  # Aurora DB engines, see [ Rotating Your SSL/TLS Certificate][2] in
16075
15964
  # the *Amazon Aurora User Guide*.
16076
15965
  #
16077
- # This setting doesn't apply to RDS Custom.
15966
+ # This setting doesn't apply to RDS Custom DB instances.
16078
15967
  #
16079
15968
  #
16080
15969
  #
@@ -16098,7 +15987,7 @@ module Aws::RDS
16098
15987
  # workload. For more information, see [Working with Oracle Read
16099
15988
  # Replicas for Amazon RDS][1] in the *Amazon RDS User Guide*.
16100
15989
  #
16101
- # This setting doesn't apply to RDS Custom.
15990
+ # This setting doesn't apply to RDS Custom DB instances.
16102
15991
  #
16103
15992
  #
16104
15993
  #
@@ -16106,8 +15995,8 @@ module Aws::RDS
16106
15995
  # @return [String]
16107
15996
  #
16108
15997
  # @!attribute [rw] enable_customer_owned_ip
16109
- # A value that indicates whether to enable a customer-owned IP address
16110
- # (CoIP) for an RDS on Outposts DB instance.
15998
+ # Specifies whether to enable a customer-owned IP address (CoIP) for
15999
+ # an RDS on Outposts DB instance.
16111
16000
  #
16112
16001
  # A *CoIP* provides local or external connectivity to resources in
16113
16002
  # your Outpost subnets through your on-premises network. For some use
@@ -16132,30 +16021,31 @@ module Aws::RDS
16132
16021
  # The Amazon Resource Name (ARN) of the recovery point in Amazon Web
16133
16022
  # Services Backup.
16134
16023
  #
16135
- # This setting doesn't apply to RDS Custom.
16024
+ # This setting doesn't apply to RDS Custom DB instances.
16136
16025
  # @return [String]
16137
16026
  #
16138
16027
  # @!attribute [rw] automation_mode
16139
- # The automation mode of the RDS Custom DB instance: `full` or `all
16140
- # paused`. If `full`, the DB instance automates monitoring and
16141
- # instance recovery. If `all paused`, the instance pauses automation
16142
- # for the duration set by `ResumeFullAutomationModeMinutes`.
16028
+ # The automation mode of the RDS Custom DB instance. If `full`, the DB
16029
+ # instance automates monitoring and instance recovery. If `all
16030
+ # paused`, the instance pauses automation for the duration set by
16031
+ # `ResumeFullAutomationModeMinutes`.
16143
16032
  # @return [String]
16144
16033
  #
16145
16034
  # @!attribute [rw] resume_full_automation_mode_minutes
16146
16035
  # The number of minutes to pause the automation. When the time period
16147
- # ends, RDS Custom resumes full automation. The minimum value is `60`
16148
- # (default). The maximum value is `1,440`.
16149
- # @return [Integer]
16036
+ # ends, RDS Custom resumes full automation.
16150
16037
  #
16151
- # @!attribute [rw] network_type
16152
- # The network type of the DB instance.
16038
+ # Default: `60`
16153
16039
  #
16154
- # Valid values:
16040
+ # Constraints:
16155
16041
  #
16156
- # * `IPV4`
16042
+ # * Must be at least 60.
16157
16043
  #
16158
- # * `DUAL`
16044
+ # * Must be no more than 1,440.
16045
+ # @return [Integer]
16046
+ #
16047
+ # @!attribute [rw] network_type
16048
+ # The network type of the DB instance.
16159
16049
  #
16160
16050
  # The network type is determined by the `DBSubnetGroup` specified for
16161
16051
  # the DB instance. A `DBSubnetGroup` can support only the IPv4
@@ -16164,22 +16054,25 @@ module Aws::RDS
16164
16054
  # For more information, see [ Working with a DB instance in a VPC][1]
16165
16055
  # in the *Amazon RDS User Guide.*
16166
16056
  #
16057
+ # Valid Values: `IPV4 | DUAL`
16058
+ #
16167
16059
  #
16168
16060
  #
16169
16061
  # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html
16170
16062
  # @return [String]
16171
16063
  #
16172
16064
  # @!attribute [rw] storage_throughput
16173
- # Specifies the storage throughput value for the DB instance.
16065
+ # The storage throughput value for the DB instance.
16174
16066
  #
16175
16067
  # This setting applies only to the `gp3` storage type.
16176
16068
  #
16177
- # This setting doesn't apply to RDS Custom or Amazon Aurora.
16069
+ # This setting doesn't apply to Amazon Aurora or RDS Custom DB
16070
+ # instances.
16178
16071
  # @return [Integer]
16179
16072
  #
16180
16073
  # @!attribute [rw] manage_master_user_password
16181
- # A value that indicates whether to manage the master user password
16182
- # with Amazon Web Services Secrets Manager.
16074
+ # Specifies whether to manage the master user password with Amazon Web
16075
+ # Services Secrets Manager.
16183
16076
  #
16184
16077
  # If the DB instance doesn't manage the master user password with
16185
16078
  # Amazon Web Services Secrets Manager, you can turn on this
@@ -16189,8 +16082,8 @@ module Aws::RDS
16189
16082
  # Amazon Web Services Secrets Manager, and you specify that the master
16190
16083
  # user password is not managed with Amazon Web Services Secrets
16191
16084
  # Manager, then you must specify `MasterUserPassword`. In this case,
16192
- # RDS deletes the secret and uses the new password for the master user
16193
- # specified by `MasterUserPassword`.
16085
+ # Amazon RDS deletes the secret and uses the new password for the
16086
+ # master user specified by `MasterUserPassword`.
16194
16087
  #
16195
16088
  # For more information, see [Password management with Amazon Web
16196
16089
  # Services Secrets Manager][1] in the *Amazon RDS User Guide.*
@@ -16208,8 +16101,8 @@ module Aws::RDS
16208
16101
  # @return [Boolean]
16209
16102
  #
16210
16103
  # @!attribute [rw] rotate_master_user_password
16211
- # A value that indicates whether to rotate the secret managed by
16212
- # Amazon Web Services Secrets Manager for the master user password.
16104
+ # Specifies whether to rotate the secret managed by Amazon Web
16105
+ # Services Secrets Manager for the master user password.
16213
16106
  #
16214
16107
  # This setting is valid only if the master user password is managed by
16215
16108
  # RDS in Amazon Web Services Secrets Manager for the DB cluster. The
@@ -16675,6 +16568,12 @@ module Aws::RDS
16675
16568
  #
16676
16569
  # **Oracle**
16677
16570
  #
16571
+ # * `19.0.0.0.ru-2022-01.rur-2022-01.r1` (supported for 12.2.0.1 DB
16572
+ # snapshots)
16573
+ #
16574
+ # * `19.0.0.0.ru-2022-07.rur-2022-07.r1` (supported for 12.1.0.2 DB
16575
+ # snapshots)
16576
+ #
16678
16577
  # * `12.1.0.2.v8` (supported for 12.1.0.1 DB snapshots)
16679
16578
  #
16680
16579
  # * `11.2.0.4.v12` (supported for 11.2.0.2 DB snapshots)
@@ -22399,8 +22298,8 @@ module Aws::RDS
22399
22298
  include Aws::Structure
22400
22299
  end
22401
22300
 
22402
- # Shows the scaling configuration for an Aurora DB cluster in
22403
- # `serverless` DB engine mode.
22301
+ # The scaling configuration for an Aurora DB cluster in `serverless` DB
22302
+ # engine mode.
22404
22303
  #
22405
22304
  # For more information, see [Using Amazon Aurora Serverless v1][1] in
22406
22305
  # the *Amazon Aurora User Guide*.
@@ -22497,8 +22396,7 @@ module Aws::RDS
22497
22396
  include Aws::Structure
22498
22397
  end
22499
22398
 
22500
- # Shows the scaling configuration for an Aurora Serverless v2 DB
22501
- # cluster.
22399
+ # The scaling configuration for an Aurora Serverless v2 DB cluster.
22502
22400
  #
22503
22401
  # For more information, see [Using Amazon Aurora Serverless v2][1] in
22504
22402
  # the *Amazon Aurora User Guide*.