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.
@@ -113,7 +113,7 @@ module Aws::RDS
113
113
  # see [Choosing the Regions and Availability Zones][1] in the *Amazon
114
114
  # Aurora User Guide*.
115
115
  #
116
- # Valid for: Aurora DB clusters only
116
+ # Valid for Cluster Type: Aurora DB clusters only
117
117
  #
118
118
  #
119
119
  #
@@ -121,29 +121,31 @@ module Aws::RDS
121
121
  # @option options [Integer] :backup_retention_period
122
122
  # The number of days for which automated backups are retained.
123
123
  #
124
- # Default: 1
124
+ # Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
125
+ #
126
+ # Default: `1`
125
127
  #
126
128
  # Constraints:
127
129
  #
128
- # * Must be a value from 1 to 35
130
+ # * Must be a value from 1 to 35.
129
131
  #
130
132
  # ^
131
- #
132
- # Valid for: Aurora DB clusters and Multi-AZ DB clusters
133
133
  # @option options [String] :character_set_name
134
- # A value that indicates that the DB cluster should be associated with
135
- # the specified CharacterSet.
134
+ # The name of the character set (`CharacterSet`) to associate the DB
135
+ # cluster with.
136
136
  #
137
- # Valid for: Aurora DB clusters only
137
+ # Valid for Cluster Type: Aurora DB clusters only
138
138
  # @option options [String] :database_name
139
139
  # The name for your database of up to 64 alphanumeric characters. If you
140
- # do not provide a name, Amazon RDS doesn't create a database in the DB
140
+ # don't provide a name, Amazon RDS doesn't create a database in the DB
141
141
  # cluster you are creating.
142
142
  #
143
- # Valid for: Aurora DB clusters and Multi-AZ DB clusters
143
+ # Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
144
144
  # @option options [required, String] :db_cluster_identifier
145
- # The DB cluster identifier. This parameter is stored as a lowercase
146
- # string.
145
+ # The identifier for this DB cluster. This parameter is stored as a
146
+ # lowercase string.
147
+ #
148
+ # Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
147
149
  #
148
150
  # Constraints:
149
151
  #
@@ -154,50 +156,43 @@ module Aws::RDS
154
156
  # * Can't end with a hyphen or contain two consecutive hyphens.
155
157
  #
156
158
  # Example: `my-cluster1`
157
- #
158
- # Valid for: Aurora DB clusters and Multi-AZ DB clusters
159
159
  # @option options [String] :db_cluster_parameter_group_name
160
160
  # The name of the DB cluster parameter group to associate with this DB
161
- # cluster. If you do not specify a value, then the default DB cluster
161
+ # cluster. If you don't specify a value, then the default DB cluster
162
162
  # parameter group for the specified DB engine and version is used.
163
163
  #
164
+ # Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
165
+ #
164
166
  # Constraints:
165
167
  #
166
168
  # * If supplied, must match the name of an existing DB cluster parameter
167
169
  # group.
168
170
  #
169
171
  # ^
170
- #
171
- # Valid for: Aurora DB clusters and Multi-AZ DB clusters
172
172
  # @option options [Array<String>] :vpc_security_group_ids
173
173
  # A list of EC2 VPC security groups to associate with this DB cluster.
174
174
  #
175
- # Valid for: Aurora DB clusters and Multi-AZ DB clusters
175
+ # Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
176
176
  # @option options [String] :db_subnet_group_name
177
177
  # A DB subnet group to associate with this DB cluster.
178
178
  #
179
179
  # This setting is required to create a Multi-AZ DB cluster.
180
180
  #
181
- # Constraints: Must match the name of an existing DBSubnetGroup. Must
182
- # not be default.
181
+ # Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
183
182
  #
184
- # Example: `mydbsubnetgroup`
185
- #
186
- # Valid for: Aurora DB clusters and Multi-AZ DB clusters
187
- # @option options [required, String] :engine
188
- # The name of the database engine to be used for this DB cluster.
189
- #
190
- # Valid Values:
183
+ # Constraints:
191
184
  #
192
- # * `aurora-mysql`
185
+ # * Must match the name of an existing DB subnet group.
193
186
  #
194
- # * `aurora-postgresql`
187
+ # * Must not be `default`.
195
188
  #
196
- # * `mysql`
189
+ # Example: `mydbsubnetgroup`
190
+ # @option options [required, String] :engine
191
+ # The database engine to use for this DB cluster.
197
192
  #
198
- # * `postgres`
193
+ # Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
199
194
  #
200
- # Valid for: Aurora DB clusters and Multi-AZ DB clusters
195
+ # Valid Values: `aurora-mysql | aurora-postgresql | mysql | postgres`
201
196
  # @option options [String] :engine_version
202
197
  # The version number of the database engine to use.
203
198
  #
@@ -229,27 +224,21 @@ module Aws::RDS
229
224
  # `aws rds describe-db-engine-versions --engine postgres --query
230
225
  # "DBEngineVersions[].EngineVersion"`
231
226
  #
232
- # **Aurora MySQL**
227
+ # For information about a specific engine, see the following topics:
233
228
  #
234
- # For information, see [Database engine updates for Amazon Aurora
235
- # MySQL][1] in the *Amazon Aurora User Guide*.
229
+ # * Aurora MySQL - see [Database engine updates for Amazon Aurora
230
+ # MySQL][1] in the *Amazon Aurora User Guide*.
236
231
  #
237
- # **Aurora PostgreSQL**
232
+ # * Aurora PostgreSQL - see [Amazon Aurora PostgreSQL releases and
233
+ # engine versions][2] in the *Amazon Aurora User Guide*.
238
234
  #
239
- # For information, see [Amazon Aurora PostgreSQL releases and engine
240
- # versions][2] in the *Amazon Aurora User Guide*.
235
+ # * RDS for MySQL - see [Amazon RDS for MySQL][3] in the *Amazon RDS
236
+ # User Guide*.
241
237
  #
242
- # **MySQL**
238
+ # * RDS for PostgreSQL - see [Amazon RDS for PostgreSQL][4] in the
239
+ # *Amazon RDS User Guide*.
243
240
  #
244
- # For information, see [Amazon RDS for MySQL][3] in the *Amazon RDS User
245
- # Guide*.
246
- #
247
- # **PostgreSQL**
248
- #
249
- # For information, see [Amazon RDS for PostgreSQL][4] in the *Amazon RDS
250
- # User Guide*.
251
- #
252
- # Valid for: Aurora DB clusters and Multi-AZ DB clusters
241
+ # Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
253
242
  #
254
243
  #
255
244
  #
@@ -261,22 +250,20 @@ module Aws::RDS
261
250
  # The port number on which the instances in the DB cluster accept
262
251
  # connections.
263
252
  #
264
- # **RDS for MySQL and Aurora MySQL**
265
- #
266
- # Default: `3306`
253
+ # Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
267
254
  #
268
- # Valid values: `1150-65535`
255
+ # Valid Values: `1150-65535`
269
256
  #
270
- # **RDS for PostgreSQL and Aurora PostgreSQL**
257
+ # Default:
271
258
  #
272
- # Default: `5432`
259
+ # * RDS for MySQL and Aurora MySQL - `3306`
273
260
  #
274
- # Valid values: `1150-65535`
275
- #
276
- # Valid for: Aurora DB clusters and Multi-AZ DB clusters
261
+ # * RDS for PostgreSQL and Aurora PostgreSQL - `5432`
277
262
  # @option options [String] :master_username
278
263
  # The name of the master user for the DB cluster.
279
264
  #
265
+ # Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
266
+ #
280
267
  # Constraints:
281
268
  #
282
269
  # * Must be 1 to 16 letters or numbers.
@@ -284,22 +271,21 @@ module Aws::RDS
284
271
  # * First character must be a letter.
285
272
  #
286
273
  # * Can't be a reserved word for the chosen database engine.
287
- #
288
- # Valid for: Aurora DB clusters and Multi-AZ DB clusters
289
274
  # @option options [String] :master_user_password
290
- # The password for the master database user. This password can contain
291
- # any printable ASCII character except "/", """, or "@".
275
+ # The password for the master database user.
276
+ #
277
+ # Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
292
278
  #
293
279
  # Constraints:
294
280
  #
295
281
  # * Must contain from 8 to 41 characters.
296
282
  #
297
- # * Can't be specified if `ManageMasterUserPassword` is turned on.
283
+ # * Can contain any printable ASCII character except "/", """, or
284
+ # "@".
298
285
  #
299
- # Valid for: Aurora DB clusters and Multi-AZ DB clusters
286
+ # * Can't be specified if `ManageMasterUserPassword` is turned on.
300
287
  # @option options [String] :option_group_name
301
- # A value that indicates that the DB cluster should be associated with
302
- # the specified option group.
288
+ # The option group to associate the DB cluster with.
303
289
  #
304
290
  # DB clusters are associated with a default option group that can't be
305
291
  # modified.
@@ -308,6 +294,8 @@ module Aws::RDS
308
294
  # automated backups are enabled using the `BackupRetentionPeriod`
309
295
  # parameter.
310
296
  #
297
+ # Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
298
+ #
311
299
  # The default is a 30-minute window selected at random from an 8-hour
312
300
  # block of time for each Amazon Web Services Region. To view the time
313
301
  # blocks available, see [ Backup window][1] in the *Amazon Aurora User
@@ -323,16 +311,13 @@ module Aws::RDS
323
311
  #
324
312
  # * Must be at least 30 minutes.
325
313
  #
326
- # Valid for: Aurora DB clusters and Multi-AZ DB clusters
327
- #
328
314
  #
329
315
  #
330
316
  # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Managing.Backups.html#Aurora.Managing.Backups.BackupWindow
331
317
  # @option options [String] :preferred_maintenance_window
332
- # The weekly time range during which system maintenance can occur, in
333
- # Universal Coordinated Time (UTC).
318
+ # The weekly time range during which system maintenance can occur.
334
319
  #
335
- # Format: `ddd:hh24:mi-ddd:hh24:mi`
320
+ # Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
336
321
  #
337
322
  # The default is a 30-minute window selected at random from an 8-hour
338
323
  # block of time for each Amazon Web Services Region, occurring on a
@@ -340,11 +325,15 @@ module Aws::RDS
340
325
  # Adjusting the Preferred DB Cluster Maintenance Window][1] in the
341
326
  # *Amazon Aurora User Guide*.
342
327
  #
343
- # Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.
328
+ # Constraints:
344
329
  #
345
- # Constraints: Minimum 30-minute window.
330
+ # * Must be in the format `ddd:hh24:mi-ddd:hh24:mi`.
346
331
  #
347
- # Valid for: Aurora DB clusters and Multi-AZ DB clusters
332
+ # * Days must be one of `Mon | Tue | Wed | Thu | Fri | Sat | Sun`.
333
+ #
334
+ # * Must be in Universal Coordinated Time (UTC).
335
+ #
336
+ # * Must be at least 30 minutes.
348
337
  #
349
338
  #
350
339
  #
@@ -353,15 +342,15 @@ module Aws::RDS
353
342
  # The Amazon Resource Name (ARN) of the source DB instance or DB cluster
354
343
  # if this DB cluster is created as a read replica.
355
344
  #
356
- # Valid for: Aurora DB clusters and Multi-AZ DB clusters
345
+ # Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
357
346
  # @option options [Array<Types::Tag>] :tags
358
347
  # Tags to assign to the DB cluster.
359
348
  #
360
- # Valid for: Aurora DB clusters and Multi-AZ DB clusters
349
+ # Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
361
350
  # @option options [Boolean] :storage_encrypted
362
- # A value that indicates whether the DB cluster is encrypted.
351
+ # Specifies whether the DB cluster is encrypted.
363
352
  #
364
- # Valid for: Aurora DB clusters and Multi-AZ DB clusters
353
+ # Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
365
354
  # @option options [String] :kms_key_id
366
355
  # The Amazon Web Services KMS key identifier for an encrypted DB
367
356
  # cluster.
@@ -374,24 +363,24 @@ module Aws::RDS
374
363
  # When a KMS key isn't specified in `KmsKeyId`:
375
364
  #
376
365
  # * If `ReplicationSourceIdentifier` identifies an encrypted source,
377
- # then Amazon RDS will use the KMS key used to encrypt the source.
378
- # Otherwise, Amazon RDS will use your default KMS key.
366
+ # then Amazon RDS uses the KMS key used to encrypt the source.
367
+ # Otherwise, Amazon RDS uses your default KMS key.
379
368
  #
380
369
  # * If the `StorageEncrypted` parameter is enabled and
381
- # `ReplicationSourceIdentifier` isn't specified, then Amazon RDS will
382
- # use your default KMS key.
370
+ # `ReplicationSourceIdentifier` isn't specified, then Amazon RDS uses
371
+ # your default KMS key.
383
372
  #
384
373
  # There is a default KMS key for your Amazon Web Services account. Your
385
374
  # Amazon Web Services account has a different default KMS key for each
386
375
  # Amazon Web Services Region.
387
376
  #
388
377
  # If you create a read replica of an encrypted DB cluster in another
389
- # Amazon Web Services Region, you must set `KmsKeyId` to a KMS key
378
+ # Amazon Web Services Region, make sure to set `KmsKeyId` to a KMS key
390
379
  # identifier that is valid in the destination Amazon Web Services
391
380
  # Region. This KMS key is used to encrypt the read replica in that
392
381
  # Amazon Web Services Region.
393
382
  #
394
- # Valid for: Aurora DB clusters and Multi-AZ DB clusters
383
+ # Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
395
384
  # @option options [String] :pre_signed_url
396
385
  # When you are replicating a DB cluster from one Amazon Web Services
397
386
  # GovCloud (US) Region to another, an URL that contains a Signature
@@ -437,30 +426,32 @@ module Aws::RDS
437
426
  #
438
427
  # </note>
439
428
  #
440
- # Valid for: Aurora DB clusters only
429
+ # Valid for Cluster Type: Aurora DB clusters only
441
430
  #
442
431
  #
443
432
  #
444
433
  # [1]: https://docs.aws.amazon.com/AmazonS3/latest/API/sigv4-query-string-auth.html
445
434
  # [2]: https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html
446
435
  # @option options [Boolean] :enable_iam_database_authentication
447
- # A value that indicates whether to enable mapping of Amazon Web
448
- # Services Identity and Access Management (IAM) accounts to database
449
- # accounts. By default, mapping isn't enabled.
436
+ # Specifies whether to enable mapping of Amazon Web Services Identity
437
+ # and Access Management (IAM) accounts to database accounts. By default,
438
+ # mapping isn't enabled.
450
439
  #
451
440
  # For more information, see [ IAM Database Authentication][1] in the
452
441
  # *Amazon Aurora User Guide*.
453
442
  #
454
- # Valid for: Aurora DB clusters only
443
+ # Valid for Cluster Type: Aurora DB clusters only
455
444
  #
456
445
  #
457
446
  #
458
447
  # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.IAMDBAuth.html
459
448
  # @option options [Integer] :backtrack_window
460
449
  # The target backtrack window, in seconds. To disable backtracking, set
461
- # this value to 0.
450
+ # this value to `0`.
462
451
  #
463
- # Default: 0
452
+ # Valid for Cluster Type: Aurora MySQL DB clusters only
453
+ #
454
+ # Default: `0`
464
455
  #
465
456
  # Constraints:
466
457
  #
@@ -468,28 +459,21 @@ module Aws::RDS
468
459
  # (72 hours).
469
460
  #
470
461
  # ^
471
- #
472
- # Valid for: Aurora MySQL DB clusters only
473
462
  # @option options [Array<String>] :enable_cloudwatch_logs_exports
474
463
  # The list of log types that need to be enabled for exporting to
475
- # CloudWatch Logs. The values in the list depend on the DB engine being
476
- # used.
464
+ # CloudWatch Logs.
477
465
  #
478
- # **RDS for MySQL**
466
+ # Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
479
467
  #
480
- # Possible values are `error`, `general`, and `slowquery`.
468
+ # The following values are valid for each DB engine:
481
469
  #
482
- # **RDS for PostgreSQL**
470
+ # * Aurora MySQL - `audit | error | general | slowquery`
483
471
  #
484
- # Possible values are `postgresql` and `upgrade`.
472
+ # * Aurora PostgreSQL - `postgresql`
485
473
  #
486
- # **Aurora MySQL**
474
+ # * RDS for MySQL - `error | general | slowquery`
487
475
  #
488
- # Possible values are `audit`, `error`, `general`, and `slowquery`.
489
- #
490
- # **Aurora PostgreSQL**
491
- #
492
- # Possible value is `postgresql`.
476
+ # * RDS for PostgreSQL - `postgresql | upgrade`
493
477
  #
494
478
  # For more information about exporting CloudWatch Logs for Amazon RDS,
495
479
  # see [Publishing Database Logs to Amazon CloudWatch Logs][1] in the
@@ -499,8 +483,6 @@ module Aws::RDS
499
483
  # Aurora, see [Publishing Database Logs to Amazon CloudWatch Logs][2] in
500
484
  # the *Amazon Aurora User Guide*.
501
485
  #
502
- # Valid for: Aurora DB clusters and Multi-AZ DB clusters
503
- #
504
486
  #
505
487
  #
506
488
  # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch
@@ -520,7 +502,7 @@ module Aws::RDS
520
502
  #
521
503
  # * [Requirements for Aurora Serverless v2][2]
522
504
  #
523
- # Valid for: Aurora DB clusters only
505
+ # Valid for Cluster Type: Aurora DB clusters only
524
506
  #
525
507
  #
526
508
  #
@@ -530,22 +512,21 @@ module Aws::RDS
530
512
  # For DB clusters in `serverless` DB engine mode, the scaling properties
531
513
  # of the DB cluster.
532
514
  #
533
- # Valid for: Aurora DB clusters only
515
+ # Valid for Cluster Type: Aurora DB clusters only
534
516
  # @option options [Boolean] :deletion_protection
535
- # A value that indicates whether the DB cluster has deletion protection
536
- # enabled. The database can't be deleted when deletion protection is
537
- # enabled. By default, deletion protection isn't enabled.
517
+ # Specifies whether the DB cluster has deletion protection enabled. The
518
+ # database can't be deleted when deletion protection is enabled. By
519
+ # default, deletion protection isn't enabled.
538
520
  #
539
- # Valid for: Aurora DB clusters and Multi-AZ DB clusters
521
+ # Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
540
522
  # @option options [String] :global_cluster_identifier
541
523
  # The global cluster ID of an Aurora cluster that becomes the primary
542
524
  # cluster in the new global database cluster.
543
525
  #
544
- # Valid for: Aurora DB clusters only
526
+ # Valid for Cluster Type: Aurora DB clusters only
545
527
  # @option options [Boolean] :enable_http_endpoint
546
- # A value that indicates whether to enable the HTTP endpoint for an
547
- # Aurora Serverless v1 DB cluster. By default, the HTTP endpoint is
548
- # disabled.
528
+ # Specifies whether to enable the HTTP endpoint for an Aurora Serverless
529
+ # v1 DB cluster. By default, the HTTP endpoint is disabled.
549
530
  #
550
531
  # When enabled, the HTTP endpoint provides a connectionless web service
551
532
  # API for running SQL queries on the Aurora Serverless v1 DB cluster.
@@ -555,16 +536,16 @@ module Aws::RDS
555
536
  # For more information, see [Using the Data API for Aurora Serverless
556
537
  # v1][1] in the *Amazon Aurora User Guide*.
557
538
  #
558
- # Valid for: Aurora DB clusters only
539
+ # Valid for Cluster Type: Aurora DB clusters only
559
540
  #
560
541
  #
561
542
  #
562
543
  # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/data-api.html
563
544
  # @option options [Boolean] :copy_tags_to_snapshot
564
- # A value that indicates whether to copy all tags from the DB cluster to
565
- # snapshots of the DB cluster. The default is not to copy them.
545
+ # Specifies whether to copy all tags from the DB cluster to snapshots of
546
+ # the DB cluster. The default is not to copy them.
566
547
  #
567
- # Valid for: Aurora DB clusters and Multi-AZ DB clusters
548
+ # Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
568
549
  # @option options [String] :domain
569
550
  # The Active Directory directory ID to create the DB cluster in.
570
551
  #
@@ -574,35 +555,34 @@ module Aws::RDS
574
555
  # For more information, see [Kerberos authentication][1] in the *Amazon
575
556
  # Aurora User Guide*.
576
557
  #
577
- # Valid for: Aurora DB clusters only
558
+ # Valid for Cluster Type: Aurora DB clusters only
578
559
  #
579
560
  #
580
561
  #
581
562
  # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/kerberos-authentication.html
582
563
  # @option options [String] :domain_iam_role_name
583
- # Specify the name of the IAM role to be used when making API calls to
584
- # the Directory Service.
564
+ # The name of the IAM role to use when making API calls to the Directory
565
+ # Service.
585
566
  #
586
- # Valid for: Aurora DB clusters only
567
+ # Valid for Cluster Type: Aurora DB clusters only
587
568
  # @option options [Boolean] :enable_global_write_forwarding
588
- # A value that indicates whether to enable this DB cluster to forward
589
- # write operations to the primary cluster of an Aurora global database
590
- # (GlobalCluster). By default, write operations are not allowed on
591
- # Aurora DB clusters that are secondary clusters in an Aurora global
592
- # database.
569
+ # Specifies whether to enable this DB cluster to forward write
570
+ # operations to the primary cluster of a global cluster (Aurora global
571
+ # database). By default, write operations are not allowed on Aurora DB
572
+ # clusters that are secondary clusters in an Aurora global database.
593
573
  #
594
574
  # You can set this value only on Aurora DB clusters that are members of
595
575
  # an Aurora global database. With this parameter enabled, a secondary
596
- # cluster can forward writes to the current primary cluster and the
576
+ # cluster can forward writes to the current primary cluster, and the
597
577
  # resulting changes are replicated back to this cluster. For the primary
598
578
  # DB cluster of an Aurora global database, this value is used
599
- # immediately if the primary is demoted by the FailoverGlobalCluster API
579
+ # immediately if the primary is demoted by a global cluster API
600
580
  # operation, but it does nothing until then.
601
581
  #
602
- # Valid for: Aurora DB clusters only
582
+ # Valid for Cluster Type: Aurora DB clusters only
603
583
  # @option options [String] :db_cluster_instance_class
604
584
  # The compute and memory capacity of each DB instance in the Multi-AZ DB
605
- # cluster, for example db.m6gd.xlarge. Not all DB instance classes are
585
+ # cluster, for example `db.m6gd.xlarge`. Not all DB instance classes are
606
586
  # available in all Amazon Web Services Regions, or for all database
607
587
  # engines.
608
588
  #
@@ -611,7 +591,7 @@ module Aws::RDS
611
591
  #
612
592
  # This setting is required to create a Multi-AZ DB cluster.
613
593
  #
614
- # Valid for: Multi-AZ DB clusters only
594
+ # Valid for Cluster Type: Multi-AZ DB clusters only
615
595
  #
616
596
  #
617
597
  #
@@ -620,28 +600,35 @@ module Aws::RDS
620
600
  # The amount of storage in gibibytes (GiB) to allocate to each DB
621
601
  # instance in the Multi-AZ DB cluster.
622
602
  #
623
- # This setting is required to create a Multi-AZ DB cluster.
603
+ # Valid for Cluster Type: Multi-AZ DB clusters only
624
604
  #
625
- # Valid for: Multi-AZ DB clusters only
605
+ # This setting is required to create a Multi-AZ DB cluster.
626
606
  # @option options [String] :storage_type
627
- # Specifies the storage type to be associated with the DB cluster.
607
+ # The storage type to associate with the DB cluster.
608
+ #
609
+ # For information on storage types for Aurora DB clusters, see [Storage
610
+ # configurations for Amazon Aurora DB clusters][1]. For information on
611
+ # storage types for Multi-AZ DB clusters, see [Settings for creating
612
+ # Multi-AZ DB clusters][2].
628
613
  #
629
614
  # This setting is required to create a Multi-AZ DB cluster.
630
615
  #
631
616
  # When specified for a Multi-AZ DB cluster, a value for the `Iops`
632
617
  # parameter is required.
633
618
  #
634
- # Valid values: `aurora`, `aurora-iopt1` (Aurora DB clusters); `io1`
635
- # (Multi-AZ DB clusters)
619
+ # Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
636
620
  #
637
- # Default: `aurora` (Aurora DB clusters); `io1` (Multi-AZ DB clusters)
621
+ # Valid Values:
622
+ #
623
+ # * Aurora DB clusters - `aurora | aurora-iopt1`
624
+ #
625
+ # * Multi-AZ DB clusters - `io1`
626
+ #
627
+ # Default:
638
628
  #
639
- # Valid for: Aurora DB clusters and Multi-AZ DB clusters
629
+ # * Aurora DB clusters - `aurora`
640
630
  #
641
- # For more information on storage types for Aurora DB clusters, see
642
- # [Storage configurations for Amazon Aurora DB clusters][1]. For more
643
- # information on storage types for Multi-AZ DB clusters, see [Settings
644
- # for creating Multi-AZ DB clusters][2].
631
+ # * Multi-AZ DB clusters - `io1`
645
632
  #
646
633
  #
647
634
  #
@@ -657,16 +644,20 @@ module Aws::RDS
657
644
  #
658
645
  # This setting is required to create a Multi-AZ DB cluster.
659
646
  #
660
- # Constraints: Must be a multiple between .5 and 50 of the storage
661
- # amount for the DB cluster.
647
+ # Valid for Cluster Type: Multi-AZ DB clusters only
662
648
  #
663
- # Valid for: Multi-AZ DB clusters only
649
+ # Constraints:
650
+ #
651
+ # * Must be a multiple between .5 and 50 of the storage amount for the
652
+ # DB cluster.
653
+ #
654
+ # ^
664
655
  #
665
656
  #
666
657
  #
667
658
  # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Storage.html#USER_PIOPS
668
659
  # @option options [Boolean] :publicly_accessible
669
- # A value that indicates whether the DB cluster is publicly accessible.
660
+ # Specifies whether the DB cluster is publicly accessible.
670
661
  #
671
662
  # When the DB cluster is publicly accessible, its Domain Name System
672
663
  # (DNS) endpoint resolves to the private IP address from within the DB
@@ -679,6 +670,8 @@ module Aws::RDS
679
670
  # When the DB cluster isn't publicly accessible, it is an internal DB
680
671
  # cluster with a DNS name that resolves to a private IP address.
681
672
  #
673
+ # Valid for Cluster Type: Multi-AZ DB clusters only
674
+ #
682
675
  # Default: The default behavior varies depending on whether
683
676
  # `DBSubnetGroupName` is specified.
684
677
  #
@@ -699,25 +692,25 @@ module Aws::RDS
699
692
  #
700
693
  # * If the subnets are part of a VPC that has an internet gateway
701
694
  # attached to it, the DB cluster is public.
702
- #
703
- # Valid for: Multi-AZ DB clusters only
704
695
  # @option options [Boolean] :auto_minor_version_upgrade
705
- # A value that indicates whether minor engine upgrades are applied
706
- # automatically to the DB cluster during the maintenance window. By
707
- # default, minor engine upgrades are applied automatically.
696
+ # Specifies whether minor engine upgrades are applied automatically to
697
+ # the DB cluster during the maintenance window. By default, minor engine
698
+ # upgrades are applied automatically.
708
699
  #
709
- # Valid for: Multi-AZ DB clusters only
700
+ # Valid for Cluster Type: Multi-AZ DB clusters only
710
701
  # @option options [Integer] :monitoring_interval
711
702
  # The interval, in seconds, between points when Enhanced Monitoring
712
703
  # metrics are collected for the DB cluster. To turn off collecting
713
- # Enhanced Monitoring metrics, specify 0. The default is 0.
704
+ # Enhanced Monitoring metrics, specify `0`.
714
705
  #
715
706
  # If `MonitoringRoleArn` is specified, also set `MonitoringInterval` to
716
- # a value other than 0.
707
+ # a value other than `0`.
708
+ #
709
+ # Valid for Cluster Type: Multi-AZ DB clusters only
717
710
  #
718
- # Valid Values: `0, 1, 5, 10, 15, 30, 60`
711
+ # Valid Values: `0 | 1 | 5 | 10 | 15 | 30 | 60`
719
712
  #
720
- # Valid for: Multi-AZ DB clusters only
713
+ # Default: `0`
721
714
  # @option options [String] :monitoring_role_arn
722
715
  # The Amazon Resource Name (ARN) for the IAM role that permits RDS to
723
716
  # send Enhanced Monitoring metrics to Amazon CloudWatch Logs. An example
@@ -725,22 +718,21 @@ module Aws::RDS
725
718
  # creating a monitoring role, see [Setting up and enabling Enhanced
726
719
  # Monitoring][1] in the *Amazon RDS User Guide*.
727
720
  #
728
- # If `MonitoringInterval` is set to a value other than 0, supply a
721
+ # If `MonitoringInterval` is set to a value other than `0`, supply a
729
722
  # `MonitoringRoleArn` value.
730
723
  #
731
- # Valid for: Multi-AZ DB clusters only
724
+ # Valid for Cluster Type: Multi-AZ DB clusters only
732
725
  #
733
726
  #
734
727
  #
735
728
  # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Monitoring.OS.html#USER_Monitoring.OS.Enabling
736
729
  # @option options [Boolean] :enable_performance_insights
737
- # A value that indicates whether to turn on Performance Insights for the
738
- # DB cluster.
730
+ # Specifies whether to turn on Performance Insights for the DB cluster.
739
731
  #
740
732
  # For more information, see [ Using Amazon Performance Insights][1] in
741
733
  # the *Amazon RDS User Guide*.
742
734
  #
743
- # Valid for: Multi-AZ DB clusters only
735
+ # Valid for Cluster Type: Multi-AZ DB clusters only
744
736
  #
745
737
  #
746
738
  #
@@ -757,31 +749,26 @@ module Aws::RDS
757
749
  # your Amazon Web Services account. Your Amazon Web Services account has
758
750
  # a different default KMS key for each Amazon Web Services Region.
759
751
  #
760
- # Valid for: Multi-AZ DB clusters only
752
+ # Valid for Cluster Type: Multi-AZ DB clusters only
761
753
  # @option options [Integer] :performance_insights_retention_period
762
- # The number of days to retain Performance Insights data. The default is
763
- # 7 days. The following values are valid:
764
- #
765
- # * 7
766
- #
767
- # * *month* * 31, where *month* is a number of months from 1-23
768
- #
769
- # * 731
754
+ # The number of days to retain Performance Insights data.
770
755
  #
771
- # For example, the following values are valid:
756
+ # Valid for Cluster Type: Multi-AZ DB clusters only
772
757
  #
773
- # * 93 (3 months * 31)
758
+ # Valid Values:
774
759
  #
775
- # * 341 (11 months * 31)
760
+ # * `7`
776
761
  #
777
- # * 589 (19 months * 31)
762
+ # * *month* * 31, where *month* is a number of months from 1-23.
763
+ # Examples: `93` (3 months * 31), `341` (11 months * 31), `589` (19
764
+ # months * 31)
778
765
  #
779
- # * 731
766
+ # * `731`
780
767
  #
781
- # If you specify a retention period such as 94, which isn't a valid
782
- # value, RDS issues an error.
768
+ # Default: `7` days
783
769
  #
784
- # Valid for: Multi-AZ DB clusters only
770
+ # If you specify a retention period that isn't valid, such as `94`,
771
+ # Amazon RDS issues an error.
785
772
  # @option options [Types::ServerlessV2ScalingConfiguration] :serverless_v2_scaling_configuration
786
773
  # Contains the scaling configuration of an Aurora Serverless v2 DB
787
774
  # cluster.
@@ -795,12 +782,6 @@ module Aws::RDS
795
782
  # @option options [String] :network_type
796
783
  # The network type of the DB cluster.
797
784
  #
798
- # Valid values:
799
- #
800
- # * `IPV4`
801
- #
802
- # * `DUAL`
803
- #
804
785
  # The network type is determined by the `DBSubnetGroup` specified for
805
786
  # the DB cluster. A `DBSubnetGroup` can support only the IPv4 protocol
806
787
  # or the IPv4 and the IPv6 protocols (`DUAL`).
@@ -808,7 +789,9 @@ module Aws::RDS
808
789
  # For more information, see [ Working with a DB instance in a VPC][1] in
809
790
  # the *Amazon Aurora User Guide.*
810
791
  #
811
- # Valid for: Aurora DB clusters only
792
+ # Valid for Cluster Type: Aurora DB clusters only
793
+ #
794
+ # Valid Values: `IPV4 | DUAL`
812
795
  #
813
796
  #
814
797
  #
@@ -816,14 +799,16 @@ module Aws::RDS
816
799
  # @option options [String] :db_system_id
817
800
  # Reserved for future use.
818
801
  # @option options [Boolean] :manage_master_user_password
819
- # A value that indicates whether to manage the master user password with
820
- # Amazon Web Services Secrets Manager.
802
+ # Specifies whether to manage the master user password with Amazon Web
803
+ # Services Secrets Manager.
821
804
  #
822
805
  # For more information, see [Password management with Amazon Web
823
806
  # Services Secrets Manager][1] in the *Amazon RDS User Guide* and
824
807
  # [Password management with Amazon Web Services Secrets Manager][2] in
825
808
  # the *Amazon Aurora User Guide.*
826
809
  #
810
+ # Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
811
+ #
827
812
  # Constraints:
828
813
  #
829
814
  # * Can't manage the master user password with Amazon Web Services
@@ -831,8 +816,6 @@ module Aws::RDS
831
816
  #
832
817
  # ^
833
818
  #
834
- # Valid for: Aurora DB clusters and Multi-AZ DB clusters
835
- #
836
819
  #
837
820
  #
838
821
  # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html
@@ -860,7 +843,7 @@ module Aws::RDS
860
843
  # Amazon Web Services account has a different default KMS key for each
861
844
  # Amazon Web Services Region.
862
845
  #
863
- # Valid for: Aurora DB clusters and Multi-AZ DB clusters
846
+ # Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
864
847
  # @option options [String] :source_region
865
848
  # The source region of the snapshot. This is only needed when the
866
849
  # shapshot is encrypted and in a different region.
@@ -1038,122 +1021,111 @@ module Aws::RDS
1038
1021
  # })
1039
1022
  # @param [Hash] options ({})
1040
1023
  # @option options [String] :db_name
1041
- # The meaning of this parameter differs according to the database engine
1042
- # you use.
1024
+ # The meaning of this parameter differs depending on the database
1025
+ # engine.
1043
1026
  #
1044
- # **MySQL**
1027
+ # Amazon Aurora MySQL
1028
+ # Amazon Aurora PostgreSQL
1029
+ # Amazon RDS Custom for Oracle
1030
+ # Amazon RDS Custom for SQL Server
1031
+ # RDS for MariaDB
1032
+ # RDS for MySQL
1033
+ # RDS for Oracle
1034
+ # RDS for PostgreSQL
1035
+ # RDS for SQL Server
1045
1036
  #
1046
- # The name of the database to create when the DB instance is created. If
1047
- # this parameter isn't specified, no database is created in the DB
1048
- # instance.
1049
- #
1050
- # Constraints:
1051
- #
1052
- # * Must contain 1 to 64 letters or numbers.
1053
- #
1054
- # * Must begin with a letter. Subsequent characters can be letters,
1055
- # underscores, or digits (0-9).
1056
- #
1057
- # * Can't be a word reserved by the specified database engine
1058
- #
1059
- # **MariaDB**
1037
+ # : The name of the database to create when the primary DB instance of
1038
+ # the Aurora MySQL DB cluster is created. If you don't specify a
1039
+ # value, Amazon RDS doesn't create a database in the DB cluster.
1060
1040
  #
1061
- # The name of the database to create when the DB instance is created. If
1062
- # this parameter isn't specified, no database is created in the DB
1063
- # instance.
1041
+ # Constraints:
1064
1042
  #
1065
- # Constraints:
1043
+ # * Must contain 1 to 64 alphanumeric characters.
1066
1044
  #
1067
- # * Must contain 1 to 64 letters or numbers.
1045
+ # * Can't be a word reserved by the database engine.
1068
1046
  #
1069
- # * Must begin with a letter. Subsequent characters can be letters,
1070
- # underscores, or digits (0-9).
1047
+ # : The name of the database to create when the primary DB instance of
1048
+ # the Aurora PostgreSQL DB cluster is created.
1071
1049
  #
1072
- # * Can't be a word reserved by the specified database engine
1050
+ # Default: `postgres`
1073
1051
  #
1074
- # **PostgreSQL**
1052
+ # Constraints:
1075
1053
  #
1076
- # The name of the database to create when the DB instance is created. If
1077
- # this parameter isn't specified, a database named `postgres` is
1078
- # created in the DB instance.
1054
+ # * Must contain 1 to 63 alphanumeric characters.
1079
1055
  #
1080
- # Constraints:
1056
+ # * Must begin with a letter. Subsequent characters can be letters,
1057
+ # underscores, or digits (0 to 9).
1081
1058
  #
1082
- # * Must contain 1 to 63 letters, numbers, or underscores.
1059
+ # * Can't be a word reserved by the database engine.
1083
1060
  #
1084
- # * Must begin with a letter. Subsequent characters can be letters,
1085
- # underscores, or digits (0-9).
1061
+ # : The Oracle System ID (SID) of the created RDS Custom DB instance.
1086
1062
  #
1087
- # * Can't be a word reserved by the specified database engine
1063
+ # Default: `ORCL`
1088
1064
  #
1089
- # **Oracle**
1065
+ # Constraints:
1090
1066
  #
1091
- # The Oracle System ID (SID) of the created DB instance. If you specify
1092
- # `null`, the default value `ORCL` is used. You can't specify the
1093
- # string NULL, or any other reserved word, for `DBName`.
1067
+ # * Must contain 1 to 8 alphanumeric characters.
1094
1068
  #
1095
- # Default: `ORCL`
1069
+ # * Must contain a letter.
1096
1070
  #
1097
- # Constraints:
1071
+ # * Can't be a word reserved by the database engine.
1098
1072
  #
1099
- # * Can't be longer than 8 characters
1073
+ # : Not applicable. Must be null.
1100
1074
  #
1101
- # ^
1102
- #
1103
- # **Amazon RDS Custom for Oracle**
1075
+ # : The name of the database to create when the DB instance is created.
1076
+ # If you don't specify a value, Amazon RDS doesn't create a database
1077
+ # in the DB instance.
1104
1078
  #
1105
- # The Oracle System ID (SID) of the created RDS Custom DB instance. If
1106
- # you don't specify a value, the default value is `ORCL`.
1079
+ # Constraints:
1107
1080
  #
1108
- # Default: `ORCL`
1081
+ # * Must contain 1 to 64 letters or numbers.
1109
1082
  #
1110
- # Constraints:
1083
+ # * Must begin with a letter. Subsequent characters can be letters,
1084
+ # underscores, or digits (0-9).
1111
1085
  #
1112
- # * It must contain 1 to 8 alphanumeric characters.
1086
+ # * Can't be a word reserved by the database engine.
1113
1087
  #
1114
- # * It must contain a letter.
1088
+ # : The name of the database to create when the DB instance is created.
1089
+ # If you don't specify a value, Amazon RDS doesn't create a database
1090
+ # in the DB instance.
1115
1091
  #
1116
- # * It can't be a word reserved by the database engine.
1092
+ # Constraints:
1117
1093
  #
1118
- # **Amazon RDS Custom for SQL Server**
1094
+ # * Must contain 1 to 64 letters or numbers.
1119
1095
  #
1120
- # Not applicable. Must be null.
1096
+ # * Must begin with a letter. Subsequent characters can be letters,
1097
+ # underscores, or digits (0-9).
1121
1098
  #
1122
- # **SQL Server**
1099
+ # * Can't be a word reserved by the database engine.
1123
1100
  #
1124
- # Not applicable. Must be null.
1101
+ # : The Oracle System ID (SID) of the created DB instance.
1125
1102
  #
1126
- # **Amazon Aurora MySQL**
1103
+ # Default: `ORCL`
1127
1104
  #
1128
- # The name of the database to create when the primary DB instance of the
1129
- # Aurora MySQL DB cluster is created. If this parameter isn't specified
1130
- # for an Aurora MySQL DB cluster, no database is created in the DB
1131
- # cluster.
1105
+ # Constraints:
1132
1106
  #
1133
- # Constraints:
1107
+ # * Can't be longer than 8 characters.
1134
1108
  #
1135
- # * It must contain 1 to 64 alphanumeric characters.
1109
+ # * Can't be a word reserved by the database engine, such as the
1110
+ # string `NULL`.
1136
1111
  #
1137
- # * It can't be a word reserved by the database engine.
1112
+ # : The name of the database to create when the DB instance is created.
1138
1113
  #
1139
- # **Amazon Aurora PostgreSQL**
1114
+ # Default: `postgres`
1140
1115
  #
1141
- # The name of the database to create when the primary DB instance of the
1142
- # Aurora PostgreSQL DB cluster is created. If this parameter isn't
1143
- # specified for an Aurora PostgreSQL DB cluster, a database named
1144
- # `postgres` is created in the DB cluster.
1116
+ # Constraints:
1145
1117
  #
1146
- # Constraints:
1118
+ # * Must contain 1 to 63 letters, numbers, or underscores.
1147
1119
  #
1148
- # * It must contain 1 to 63 alphanumeric characters.
1120
+ # * Must begin with a letter. Subsequent characters can be letters,
1121
+ # underscores, or digits (0-9).
1149
1122
  #
1150
- # * It must begin with a letter. Subsequent characters can be letters,
1151
- # underscores, or digits (0 to 9).
1123
+ # * Can't be a word reserved by the database engine.
1152
1124
  #
1153
- # * It can't be a word reserved by the database engine.
1125
+ # : Not applicable. Must be null.
1154
1126
  # @option options [required, String] :db_instance_identifier
1155
- # The DB instance identifier. This parameter is stored as a lowercase
1156
- # string.
1127
+ # The identifier for this DB instance. This parameter is stored as a
1128
+ # lowercase string.
1157
1129
  #
1158
1130
  # Constraints:
1159
1131
  #
@@ -1168,106 +1140,99 @@ module Aws::RDS
1168
1140
  # The amount of storage in gibibytes (GiB) to allocate for the DB
1169
1141
  # instance.
1170
1142
  #
1171
- # Type: Integer
1172
- #
1173
- # **Amazon Aurora**
1174
- #
1175
- # Not applicable. Aurora cluster volumes automatically grow as the
1176
- # amount of data in your database increases, though you are only charged
1177
- # for the space that you use in an Aurora cluster volume.
1178
- #
1179
- # **Amazon RDS Custom**
1143
+ # This setting doesn't apply to Amazon Aurora DB instances. Aurora
1144
+ # cluster volumes automatically grow as the amount of data in your
1145
+ # database increases, though you are only charged for the space that you
1146
+ # use in an Aurora cluster volume.
1180
1147
  #
1181
- # Constraints to the amount of storage for each storage type are the
1182
- # following:
1148
+ # Amazon RDS Custom
1149
+ # RDS for MariaDB
1150
+ # RDS for MySQL
1151
+ # RDS for Oracle
1152
+ # RDS for PostgreSQL
1153
+ # RDS for SQL Server
1183
1154
  #
1184
- # * General Purpose (SSD) storage (gp2, gp3): Must be an integer from 40
1185
- # to 65536 for RDS Custom for Oracle, 16384 for RDS Custom for SQL
1186
- # Server.
1155
+ # : Constraints to the amount of storage for each storage type are the
1156
+ # following:
1187
1157
  #
1188
- # * Provisioned IOPS storage (io1): Must be an integer from 40 to 65536
1189
- # for RDS Custom for Oracle, 16384 for RDS Custom for SQL Server.
1158
+ # * General Purpose (SSD) storage (gp2, gp3): Must be an integer from
1159
+ # 40 to 65536 for RDS Custom for Oracle, 16384 for RDS Custom for
1160
+ # SQL Server.
1190
1161
  #
1191
- # **MySQL**
1162
+ # * Provisioned IOPS storage (io1): Must be an integer from 40 to
1163
+ # 65536 for RDS Custom for Oracle, 16384 for RDS Custom for SQL
1164
+ # Server.
1192
1165
  #
1193
- # Constraints to the amount of storage for each storage type are the
1194
- # following:
1166
+ # : Constraints to the amount of storage for each storage type are the
1167
+ # following:
1195
1168
  #
1196
- # * General Purpose (SSD) storage (gp2, gp3): Must be an integer from 20
1197
- # to 65536.
1169
+ # * General Purpose (SSD) storage (gp2, gp3): Must be an integer from
1170
+ # 20 to 65536.
1198
1171
  #
1199
- # * Provisioned IOPS storage (io1): Must be an integer from 100 to
1200
- # 65536.
1172
+ # * Provisioned IOPS storage (io1): Must be an integer from 100 to
1173
+ # 65536.
1201
1174
  #
1202
- # * Magnetic storage (standard): Must be an integer from 5 to 3072.
1175
+ # * Magnetic storage (standard): Must be an integer from 5 to 3072.
1203
1176
  #
1204
- # **MariaDB**
1177
+ # : Constraints to the amount of storage for each storage type are the
1178
+ # following:
1205
1179
  #
1206
- # Constraints to the amount of storage for each storage type are the
1207
- # following:
1180
+ # * General Purpose (SSD) storage (gp2, gp3): Must be an integer from
1181
+ # 20 to 65536.
1208
1182
  #
1209
- # * General Purpose (SSD) storage (gp2, gp3): Must be an integer from 20
1210
- # to 65536.
1183
+ # * Provisioned IOPS storage (io1): Must be an integer from 100 to
1184
+ # 65536.
1211
1185
  #
1212
- # * Provisioned IOPS storage (io1): Must be an integer from 100 to
1213
- # 65536.
1186
+ # * Magnetic storage (standard): Must be an integer from 5 to 3072.
1214
1187
  #
1215
- # * Magnetic storage (standard): Must be an integer from 5 to 3072.
1188
+ # : Constraints to the amount of storage for each storage type are the
1189
+ # following:
1216
1190
  #
1217
- # **PostgreSQL**
1191
+ # * General Purpose (SSD) storage (gp2, gp3): Must be an integer from
1192
+ # 20 to 65536.
1218
1193
  #
1219
- # Constraints to the amount of storage for each storage type are the
1220
- # following:
1194
+ # * Provisioned IOPS storage (io1): Must be an integer from 100 to
1195
+ # 65536.
1221
1196
  #
1222
- # * General Purpose (SSD) storage (gp2, gp3): Must be an integer from 20
1223
- # to 65536.
1197
+ # * Magnetic storage (standard): Must be an integer from 10 to 3072.
1224
1198
  #
1225
- # * Provisioned IOPS storage (io1): Must be an integer from 100 to
1226
- # 65536.
1199
+ # : Constraints to the amount of storage for each storage type are the
1200
+ # following:
1227
1201
  #
1228
- # * Magnetic storage (standard): Must be an integer from 5 to 3072.
1202
+ # * General Purpose (SSD) storage (gp2, gp3): Must be an integer from
1203
+ # 20 to 65536.
1229
1204
  #
1230
- # **Oracle**
1205
+ # * Provisioned IOPS storage (io1): Must be an integer from 100 to
1206
+ # 65536.
1231
1207
  #
1232
- # Constraints to the amount of storage for each storage type are the
1233
- # following:
1208
+ # * Magnetic storage (standard): Must be an integer from 5 to 3072.
1234
1209
  #
1235
- # * General Purpose (SSD) storage (gp2, gp3): Must be an integer from 20
1236
- # to 65536.
1210
+ # : Constraints to the amount of storage for each storage type are the
1211
+ # following:
1237
1212
  #
1238
- # * Provisioned IOPS storage (io1): Must be an integer from 100 to
1239
- # 65536.
1213
+ # * General Purpose (SSD) storage (gp2, gp3):
1240
1214
  #
1241
- # * Magnetic storage (standard): Must be an integer from 10 to 3072.
1215
+ # * Enterprise and Standard editions: Must be an integer from 20 to
1216
+ # 16384.
1242
1217
  #
1243
- # **SQL Server**
1218
+ # * Web and Express editions: Must be an integer from 20 to 16384.
1244
1219
  #
1245
- # Constraints to the amount of storage for each storage type are the
1246
- # following:
1220
+ # * Provisioned IOPS storage (io1):
1247
1221
  #
1248
- # * General Purpose (SSD) storage (gp2, gp3):
1222
+ # * Enterprise and Standard editions: Must be an integer from 100 to
1223
+ # 16384.
1249
1224
  #
1250
- # * Enterprise and Standard editions: Must be an integer from 20 to
1251
- # 16384.
1225
+ # * Web and Express editions: Must be an integer from 100 to 16384.
1252
1226
  #
1253
- # * Web and Express editions: Must be an integer from 20 to 16384.
1227
+ # * Magnetic storage (standard):
1254
1228
  #
1255
- # * Provisioned IOPS storage (io1):
1229
+ # * Enterprise and Standard editions: Must be an integer from 20 to
1230
+ # 1024.
1256
1231
  #
1257
- # * Enterprise and Standard editions: Must be an integer from 100 to
1258
- # 16384.
1259
- #
1260
- # * Web and Express editions: Must be an integer from 100 to 16384.
1261
- #
1262
- # * Magnetic storage (standard):
1263
- #
1264
- # * Enterprise and Standard editions: Must be an integer from 20 to
1265
- # 1024.
1266
- #
1267
- # * Web and Express editions: Must be an integer from 20 to 1024.
1232
+ # * Web and Express editions: Must be an integer from 20 to 1024.
1268
1233
  # @option options [required, String] :db_instance_class
1269
1234
  # The compute and memory capacity of the DB instance, for example
1270
- # db.m5.large. Not all DB instance classes are available in all Amazon
1235
+ # `db.m5.large`. Not all DB instance classes are available in all Amazon
1271
1236
  # Web Services Regions, or for all database engines. For the full list
1272
1237
  # of DB instance classes, and availability for your engine, see [DB
1273
1238
  # instance classes][1] in the *Amazon RDS User Guide* or [Aurora DB
@@ -1278,9 +1243,9 @@ module Aws::RDS
1278
1243
  # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html
1279
1244
  # [2]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Concepts.DBInstanceClass.html
1280
1245
  # @option options [required, String] :engine
1281
- # The name of the database engine to be used for this instance.
1246
+ # The database engine to use for this DB instance.
1282
1247
  #
1283
- # Not every database engine is available for every Amazon Web Services
1248
+ # Not every database engine is available in every Amazon Web Services
1284
1249
  # Region.
1285
1250
  #
1286
1251
  # Valid Values:
@@ -1289,15 +1254,15 @@ module Aws::RDS
1289
1254
  #
1290
1255
  # * `aurora-postgresql` (for Aurora PostgreSQL DB instances)
1291
1256
  #
1292
- # * `custom-oracle-ee (for RDS Custom for Oracle DB instances)`
1257
+ # * `custom-oracle-ee` (for RDS Custom for Oracle DB instances)
1293
1258
  #
1294
- # * `custom-oracle-ee-cdb (for RDS Custom for Oracle DB instances)`
1259
+ # * `custom-oracle-ee-cdb` (for RDS Custom for Oracle DB instances)
1295
1260
  #
1296
- # * `custom-sqlserver-ee (for RDS Custom for SQL Server DB instances)`
1261
+ # * `custom-sqlserver-ee` (for RDS Custom for SQL Server DB instances)
1297
1262
  #
1298
- # * `custom-sqlserver-se (for RDS Custom for SQL Server DB instances)`
1263
+ # * `custom-sqlserver-se` (for RDS Custom for SQL Server DB instances)
1299
1264
  #
1300
- # * `custom-sqlserver-web (for RDS Custom for SQL Server DB instances)`
1265
+ # * `custom-sqlserver-web` (for RDS Custom for SQL Server DB instances)
1301
1266
  #
1302
1267
  # * `mariadb`
1303
1268
  #
@@ -1323,53 +1288,43 @@ module Aws::RDS
1323
1288
  # @option options [String] :master_username
1324
1289
  # The name for the master user.
1325
1290
  #
1326
- # **Amazon Aurora**
1291
+ # This setting doesn't apply to Amazon Aurora DB instances. The name
1292
+ # for the master user is managed by the DB cluster.
1327
1293
  #
1328
- # Not applicable. The name for the master user is managed by the DB
1329
- # cluster.
1330
- #
1331
- # **Amazon RDS**
1294
+ # This setting is required for RDS DB instances.
1332
1295
  #
1333
1296
  # Constraints:
1334
1297
  #
1335
- # * Required.
1336
- #
1337
1298
  # * Must be 1 to 16 letters, numbers, or underscores.
1338
1299
  #
1339
1300
  # * First character must be a letter.
1340
1301
  #
1341
1302
  # * Can't be a reserved word for the chosen database engine.
1342
1303
  # @option options [String] :master_user_password
1343
- # The password for the master user. The password can include any
1344
- # printable ASCII character except "/", """, or "@".
1304
+ # The password for the master user.
1345
1305
  #
1346
- # **Amazon Aurora**
1306
+ # This setting doesn't apply to Amazon Aurora DB instances. The
1307
+ # password for the master user is managed by the DB cluster.
1347
1308
  #
1348
- # Not applicable. The password for the master user is managed by the DB
1349
- # cluster.
1350
- #
1351
- # Constraints: Can't be specified if `ManageMasterUserPassword` is
1352
- # turned on.
1353
- #
1354
- # **MariaDB**
1355
- #
1356
- # Constraints: Must contain from 8 to 41 characters.
1309
+ # Constraints:
1357
1310
  #
1358
- # **Microsoft SQL Server**
1311
+ # * Can't be specified if `ManageMasterUserPassword` is turned on.
1359
1312
  #
1360
- # Constraints: Must contain from 8 to 128 characters.
1313
+ # * Can include any printable ASCII character except "/", """, or
1314
+ # "@".
1361
1315
  #
1362
- # **MySQL**
1316
+ # Length Constraints:
1363
1317
  #
1364
- # Constraints: Must contain from 8 to 41 characters.
1318
+ # * RDS for MariaDB - Must contain from 8 to 41 characters.
1365
1319
  #
1366
- # **Oracle**
1320
+ # * RDS for Microsoft SQL Server - Must contain from 8 to 128
1321
+ # characters.
1367
1322
  #
1368
- # Constraints: Must contain from 8 to 30 characters.
1323
+ # * RDS for MySQL - Must contain from 8 to 41 characters.
1369
1324
  #
1370
- # **PostgreSQL**
1325
+ # * RDS for Oracle - Must contain from 8 to 30 characters.
1371
1326
  #
1372
- # Constraints: Must contain from 8 to 128 characters.
1327
+ # * RDS for PostgreSQL - Must contain from 8 to 128 characters.
1373
1328
  # @option options [Array<String>] :db_security_groups
1374
1329
  # A list of DB security groups to associate with this DB instance.
1375
1330
  #
@@ -1380,10 +1335,9 @@ module Aws::RDS
1380
1335
  # A list of Amazon EC2 VPC security groups to associate with this DB
1381
1336
  # instance.
1382
1337
  #
1383
- # **Amazon Aurora**
1384
- #
1385
- # Not applicable. The associated list of EC2 VPC security groups is
1386
- # managed by the DB cluster.
1338
+ # This setting doesn't apply to Amazon Aurora DB instances. The
1339
+ # associated list of EC2 VPC security groups is managed by the DB
1340
+ # cluster.
1387
1341
  #
1388
1342
  # Default: The default EC2 VPC security group for the DB subnet group's
1389
1343
  # VPC.
@@ -1392,22 +1346,23 @@ module Aws::RDS
1392
1346
  # information on Amazon Web Services Regions and Availability Zones, see
1393
1347
  # [Regions and Availability Zones][1].
1394
1348
  #
1395
- # **Amazon Aurora**
1396
- #
1397
- # Each Aurora DB cluster hosts copies of its storage in three separate
1398
- # Availability Zones. Specify one of these Availability Zones. Aurora
1399
- # automatically chooses an appropriate Availability Zone if you don't
1400
- # specify one.
1349
+ # For Amazon Aurora, each Aurora DB cluster hosts copies of its storage
1350
+ # in three separate Availability Zones. Specify one of these
1351
+ # Availability Zones. Aurora automatically chooses an appropriate
1352
+ # Availability Zone if you don't specify one.
1401
1353
  #
1402
1354
  # Default: A random, system-chosen Availability Zone in the endpoint's
1403
1355
  # Amazon Web Services Region.
1404
1356
  #
1405
- # Example: `us-east-1d`
1357
+ # Constraints:
1358
+ #
1359
+ # * The `AvailabilityZone` parameter can't be specified if the DB
1360
+ # instance is a Multi-AZ deployment.
1361
+ #
1362
+ # * The specified Availability Zone must be in the same Amazon Web
1363
+ # Services Region as the current endpoint.
1406
1364
  #
1407
- # Constraint: The `AvailabilityZone` parameter can't be specified if
1408
- # the DB instance is a Multi-AZ deployment. The specified Availability
1409
- # Zone must be in the same Amazon Web Services Region as the current
1410
- # endpoint.
1365
+ # Example: `us-east-1d`
1411
1366
  #
1412
1367
  #
1413
1368
  #
@@ -1415,61 +1370,68 @@ module Aws::RDS
1415
1370
  # @option options [String] :db_subnet_group_name
1416
1371
  # A DB subnet group to associate with this DB instance.
1417
1372
  #
1418
- # Constraints: Must match the name of an existing DBSubnetGroup. Must
1419
- # not be default.
1373
+ # Constraints:
1374
+ #
1375
+ # * Must match the name of an existing DB subnet group.
1376
+ #
1377
+ # * Must not be `default`.
1420
1378
  #
1421
1379
  # Example: `mydbsubnetgroup`
1422
1380
  # @option options [String] :preferred_maintenance_window
1423
- # The time range each week during which system maintenance can occur, in
1424
- # Universal Coordinated Time (UTC). For more information, see [Amazon
1425
- # RDS Maintenance Window][1].
1426
- #
1427
- # Format: `ddd:hh24:mi-ddd:hh24:mi`
1381
+ # The time range each week during which system maintenance can occur.
1382
+ # For more information, see [Amazon RDS Maintenance Window][1] in the
1383
+ # *Amazon RDS User Guide.*
1428
1384
  #
1429
1385
  # The default is a 30-minute window selected at random from an 8-hour
1430
1386
  # block of time for each Amazon Web Services Region, occurring on a
1431
1387
  # random day of the week.
1432
1388
  #
1433
- # Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.
1389
+ # Constraints:
1390
+ #
1391
+ # * Must be in the format `ddd:hh24:mi-ddd:hh24:mi`.
1434
1392
  #
1435
- # Constraints: Minimum 30-minute window.
1393
+ # * The day values must be `mon | tue | wed | thu | fri | sat | sun`.
1394
+ #
1395
+ # * Must be in Universal Coordinated Time (UTC).
1396
+ #
1397
+ # * Must not conflict with the preferred backup window.
1398
+ #
1399
+ # * Must be at least 30 minutes.
1436
1400
  #
1437
1401
  #
1438
1402
  #
1439
1403
  # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_UpgradeDBInstance.Maintenance.html#Concepts.DBMaintenance
1440
1404
  # @option options [String] :db_parameter_group_name
1441
1405
  # The name of the DB parameter group to associate with this DB instance.
1442
- # If you do not specify a value, then the default DB parameter group for
1443
- # the specified DB engine and version is used.
1406
+ # If you don't specify a value, then Amazon RDS uses the default DB
1407
+ # parameter group for the specified DB engine and version.
1444
1408
  #
1445
- # This setting doesn't apply to RDS Custom.
1409
+ # This setting doesn't apply to RDS Custom DB instances.
1446
1410
  #
1447
1411
  # Constraints:
1448
1412
  #
1449
- # * It must be 1 to 255 letters, numbers, or hyphens.
1413
+ # * Must be 1 to 255 letters, numbers, or hyphens.
1450
1414
  #
1451
1415
  # * The first character must be a letter.
1452
1416
  #
1453
- # * It can't end with a hyphen or contain two consecutive hyphens.
1417
+ # * Can't end with a hyphen or contain two consecutive hyphens.
1454
1418
  # @option options [Integer] :backup_retention_period
1455
1419
  # The number of days for which automated backups are retained. Setting
1456
1420
  # this parameter to a positive number enables backups. Setting this
1457
- # parameter to 0 disables automated backups.
1421
+ # parameter to `0` disables automated backups.
1458
1422
  #
1459
- # **Amazon Aurora**
1423
+ # This setting doesn't apply to Amazon Aurora DB instances. The
1424
+ # retention period for automated backups is managed by the DB cluster.
1460
1425
  #
1461
- # Not applicable. The retention period for automated backups is managed
1462
- # by the DB cluster.
1463
- #
1464
- # Default: 1
1426
+ # Default: `1`
1465
1427
  #
1466
1428
  # Constraints:
1467
1429
  #
1468
- # * Must be a value from 0 to 35
1430
+ # * Must be a value from 0 to 35.
1469
1431
  #
1470
- # * Can't be set to 0 if the DB instance is a source to read replicas
1432
+ # * Can't be set to 0 if the DB instance is a source to read replicas.
1471
1433
  #
1472
- # * Can't be set to 0 for an RDS Custom for Oracle DB instance
1434
+ # * Can't be set to 0 for an RDS Custom for Oracle DB instance.
1473
1435
  # @option options [String] :preferred_backup_window
1474
1436
  # The daily time range during which automated backups are created if
1475
1437
  # automated backups are enabled, using the `BackupRetentionPeriod`
@@ -1477,10 +1439,9 @@ module Aws::RDS
1477
1439
  # an 8-hour block of time for each Amazon Web Services Region. For more
1478
1440
  # information, see [Backup window][1] in the *Amazon RDS User Guide*.
1479
1441
  #
1480
- # **Amazon Aurora**
1481
- #
1482
- # Not applicable. The daily time range for creating automated backups is
1483
- # managed by the DB cluster.
1442
+ # This setting doesn't apply to Amazon Aurora DB instances. The daily
1443
+ # time range for creating automated backups is managed by the DB
1444
+ # cluster.
1484
1445
  #
1485
1446
  # Constraints:
1486
1447
  #
@@ -1498,64 +1459,47 @@ module Aws::RDS
1498
1459
  # @option options [Integer] :port
1499
1460
  # The port number on which the database accepts connections.
1500
1461
  #
1501
- # **MySQL**
1502
- #
1503
- # Default: `3306`
1504
- #
1505
- # Valid values: `1150-65535`
1506
- #
1507
- # Type: Integer
1508
- #
1509
- # **MariaDB**
1510
- #
1511
- # Default: `3306`
1512
- #
1513
- # Valid values: `1150-65535`
1514
- #
1515
- # Type: Integer
1516
- #
1517
- # **PostgreSQL**
1518
- #
1519
- # Default: `5432`
1520
- #
1521
- # Valid values: `1150-65535`
1522
- #
1523
- # Type: Integer
1462
+ # This setting doesn't apply to Aurora DB instances. The port number is
1463
+ # managed by the cluster.
1524
1464
  #
1525
- # **Oracle**
1465
+ # Valid Values: `1150-65535`
1526
1466
  #
1527
- # Default: `1521`
1467
+ # Default:
1528
1468
  #
1529
- # Valid values: `1150-65535`
1469
+ # * RDS for MariaDB - `3306`
1530
1470
  #
1531
- # **SQL Server**
1471
+ # * RDS for Microsoft SQL Server - `1433`
1532
1472
  #
1533
- # Default: `1433`
1473
+ # * RDS for MySQL - `3306`
1534
1474
  #
1535
- # Valid values: `1150-65535` except `1234`, `1434`, `3260`, `3343`,
1536
- # `3389`, `47001`, and `49152-49156`.
1475
+ # * RDS for Oracle - `1521`
1537
1476
  #
1538
- # **Amazon Aurora**
1477
+ # * RDS for PostgreSQL - `5432`
1539
1478
  #
1540
- # Default: `3306`
1479
+ # Constraints:
1541
1480
  #
1542
- # Valid values: `1150-65535`
1481
+ # * For RDS for Microsoft SQL Server, the value can't be `1234`,
1482
+ # `1434`, `3260`, `3343`, `3389`, `47001`, or `49152-49156`.
1543
1483
  #
1544
- # Type: Integer
1484
+ # ^
1545
1485
  # @option options [Boolean] :multi_az
1546
- # A value that indicates whether the DB instance is a Multi-AZ
1547
- # deployment. You can't set the `AvailabilityZone` parameter if the DB
1548
- # instance is a Multi-AZ deployment.
1486
+ # Specifies whether the DB instance is a Multi-AZ deployment. You can't
1487
+ # set the `AvailabilityZone` parameter if the DB instance is a Multi-AZ
1488
+ # deployment.
1549
1489
  #
1550
- # This setting doesn't apply to RDS Custom.
1490
+ # This setting doesn't apply to the following DB instances:
1551
1491
  #
1552
- # **Amazon Aurora**
1492
+ # * Amazon Aurora (DB instance Availability Zones (AZs) are managed by
1493
+ # the DB cluster.)
1553
1494
  #
1554
- # Not applicable. DB instance Availability Zones (AZs) are managed by
1555
- # the DB cluster.
1495
+ # * RDS Custom
1556
1496
  # @option options [String] :engine_version
1557
1497
  # The version number of the database engine to use.
1558
1498
  #
1499
+ # This setting doesn't apply to Amazon Aurora DB instances. The version
1500
+ # number of the database engine the DB instance uses is managed by the
1501
+ # DB cluster.
1502
+ #
1559
1503
  # For a list of valid engine versions, use the
1560
1504
  # `DescribeDBEngineVersions` operation.
1561
1505
  #
@@ -1564,48 +1508,37 @@ module Aws::RDS
1564
1508
  # every database engine is available for every Amazon Web Services
1565
1509
  # Region.
1566
1510
  #
1567
- # **Amazon Aurora**
1568
- #
1569
- # Not applicable. The version number of the database engine to be used
1570
- # by the DB instance is managed by the DB cluster.
1511
+ # Amazon RDS Custom for Oracle
1512
+ # Amazon RDS Custom for SQL Server
1513
+ # RDS for MariaDB
1514
+ # RDS for Microsoft SQL Server
1515
+ # RDS for MySQL
1516
+ # RDS for Oracle
1517
+ # RDS for PostgreSQL
1571
1518
  #
1572
- # **Amazon RDS Custom for Oracle**
1519
+ # : A custom engine version (CEV) that you have previously created. This
1520
+ # setting is required for RDS Custom for Oracle. The CEV name has the
1521
+ # following format: 19.*customized\_string*. A valid CEV name is
1522
+ # `19.my_cev1`. For more information, see [ Creating an RDS Custom for
1523
+ # Oracle DB instance][1] in the *Amazon RDS User Guide*.
1573
1524
  #
1574
- # A custom engine version (CEV) that you have previously created. This
1575
- # setting is required for RDS Custom for Oracle. The CEV name has the
1576
- # following format: 19.*customized\_string*. A valid CEV name is
1577
- # `19.my_cev1`. For more information, see [ Creating an RDS Custom for
1578
- # Oracle DB instance][1] in the *Amazon RDS User Guide*.
1525
+ # : See [RDS Custom for SQL Server general requirements][2] in the
1526
+ # *Amazon RDS User Guide*.
1579
1527
  #
1580
- # **Amazon RDS Custom for SQL Server**
1528
+ # : For information, see [MariaDB on Amazon RDS versions][3] in the
1529
+ # *Amazon RDS User Guide*.
1581
1530
  #
1582
- # See [RDS Custom for SQL Server general requirements][2] in the *Amazon
1583
- # RDS User Guide*.
1531
+ # : For information, see [Microsoft SQL Server versions on Amazon
1532
+ # RDS][4] in the *Amazon RDS User Guide*.
1584
1533
  #
1585
- # **MariaDB**
1534
+ # : For information, see [MySQL on Amazon RDS versions][5] in the
1535
+ # *Amazon RDS User Guide*.
1586
1536
  #
1587
- # For information, see [MariaDB on Amazon RDS Versions][3] in the
1588
- # *Amazon RDS User Guide*.
1537
+ # : For information, see [Oracle Database Engine release notes][6] in
1538
+ # the *Amazon RDS User Guide*.
1589
1539
  #
1590
- # **Microsoft SQL Server**
1591
- #
1592
- # For information, see [Microsoft SQL Server Versions on Amazon RDS][4]
1593
- # in the *Amazon RDS User Guide*.
1594
- #
1595
- # **MySQL**
1596
- #
1597
- # For information, see [MySQL on Amazon RDS Versions][5] in the *Amazon
1598
- # RDS User Guide*.
1599
- #
1600
- # **Oracle**
1601
- #
1602
- # For information, see [Oracle Database Engine Release Notes][6] in the
1603
- # *Amazon RDS User Guide*.
1604
- #
1605
- # **PostgreSQL**
1606
- #
1607
- # For information, see [Amazon RDS for PostgreSQL versions and
1608
- # extensions][7] in the *Amazon RDS User Guide*.
1540
+ # : For information, see [Amazon RDS for PostgreSQL versions and
1541
+ # extensions][7] in the *Amazon RDS User Guide*.
1609
1542
  #
1610
1543
  #
1611
1544
  #
@@ -1617,72 +1550,77 @@ module Aws::RDS
1617
1550
  # [6]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Appendix.Oracle.PatchComposition.html
1618
1551
  # [7]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_PostgreSQL.html#PostgreSQL.Concepts
1619
1552
  # @option options [Boolean] :auto_minor_version_upgrade
1620
- # A value that indicates whether minor engine upgrades are applied
1621
- # automatically to the DB instance during the maintenance window. By
1622
- # default, minor engine upgrades are applied automatically.
1553
+ # Specifies whether minor engine upgrades are applied automatically to
1554
+ # the DB instance during the maintenance window. By default, minor
1555
+ # engine upgrades are applied automatically.
1623
1556
  #
1624
1557
  # If you create an RDS Custom DB instance, you must set
1625
1558
  # `AutoMinorVersionUpgrade` to `false`.
1626
1559
  # @option options [String] :license_model
1627
- # License model information for this DB instance.
1560
+ # The license model information for this DB instance.
1628
1561
  #
1629
- # Valid values: `license-included` \| `bring-your-own-license` \|
1630
- # `general-public-license`
1562
+ # This setting doesn't apply to Amazon Aurora or RDS Custom DB
1563
+ # instances.
1631
1564
  #
1632
- # This setting doesn't apply to RDS Custom.
1565
+ # Valid Values:
1566
+ #
1567
+ # * RDS for MariaDB - `general-public-license`
1568
+ #
1569
+ # * RDS for Microsoft SQL Server - `license-included`
1570
+ #
1571
+ # * RDS for MySQL - `general-public-license`
1633
1572
  #
1634
- # **Amazon Aurora**
1573
+ # * RDS for Oracle - `bring-your-own-license | license-included`
1635
1574
  #
1636
- # Not applicable.
1575
+ # * RDS for PostgreSQL - `postgresql-license`
1637
1576
  # @option options [Integer] :iops
1638
1577
  # The amount of Provisioned IOPS (input/output operations per second) to
1639
- # be initially allocated for the DB instance. For information about
1640
- # valid IOPS values, see [Amazon RDS DB instance storage][1] in the
1641
- # *Amazon RDS User Guide*.
1578
+ # initially allocate for the DB instance. For information about valid
1579
+ # IOPS values, see [Amazon RDS DB instance storage][1] in the *Amazon
1580
+ # RDS User Guide*.
1642
1581
  #
1643
- # Constraints: For MariaDB, MySQL, Oracle, and PostgreSQL DB instances,
1644
- # must be a multiple between .5 and 50 of the storage amount for the DB
1645
- # instance. For SQL Server DB instances, must be a multiple between 1
1646
- # and 50 of the storage amount for the DB instance.
1582
+ # This setting doesn't apply to Amazon Aurora DB instances. Storage is
1583
+ # managed by the DB cluster.
1647
1584
  #
1648
- # **Amazon Aurora**
1585
+ # Constraints:
1649
1586
  #
1650
- # Not applicable. Storage is managed by the DB cluster.
1587
+ # * For RDS for MariaDB, MySQL, Oracle, and PostgreSQL - Must be a
1588
+ # multiple between .5 and 50 of the storage amount for the DB
1589
+ # instance.
1590
+ #
1591
+ # * For RDS for SQL Server - Must be a multiple between 1 and 50 of the
1592
+ # storage amount for the DB instance.
1651
1593
  #
1652
1594
  #
1653
1595
  #
1654
1596
  # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Storage.html
1655
1597
  # @option options [String] :option_group_name
1656
- # A value that indicates that the DB instance should be associated with
1657
- # the specified option group.
1598
+ # The option group to associate the DB instance with.
1658
1599
  #
1659
1600
  # Permanent options, such as the TDE option for Oracle Advanced Security
1660
1601
  # TDE, can't be removed from an option group. Also, that option group
1661
1602
  # can't be removed from a DB instance after it is associated with a DB
1662
1603
  # instance.
1663
1604
  #
1664
- # This setting doesn't apply to RDS Custom.
1665
- #
1666
- # **Amazon Aurora**
1667
- #
1668
- # Not applicable.
1605
+ # This setting doesn't apply to Amazon Aurora or RDS Custom DB
1606
+ # instances.
1669
1607
  # @option options [String] :character_set_name
1670
- # For supported engines, this value indicates that the DB instance
1671
- # should be associated with the specified `CharacterSet`.
1608
+ # For supported engines, the character set (`CharacterSet`) to associate
1609
+ # the DB instance with.
1672
1610
  #
1673
- # This setting doesn't apply to RDS Custom. However, if you need to
1674
- # change the character set, you can change it on the database itself.
1611
+ # This setting doesn't apply to the following DB instances:
1675
1612
  #
1676
- # **Amazon Aurora**
1613
+ # * Amazon Aurora - The character set is managed by the DB cluster. For
1614
+ # more information, see `CreateDBCluster`.
1677
1615
  #
1678
- # Not applicable. The character set is managed by the DB cluster. For
1679
- # more information, see `CreateDBCluster`.
1616
+ # * RDS Custom - However, if you need to change the character set, you
1617
+ # can change it on the database itself.
1680
1618
  # @option options [String] :nchar_character_set_name
1681
1619
  # The name of the NCHAR character set for the Oracle DB instance.
1682
1620
  #
1683
- # This parameter doesn't apply to RDS Custom.
1621
+ # This setting doesn't apply to RDS Custom DB instances.
1684
1622
  # @option options [Boolean] :publicly_accessible
1685
- # A value that indicates whether the DB instance is publicly accessible.
1623
+ # Specifies whether the DB instance is publicly accessible.
1686
1624
  #
1687
1625
  # When the DB instance is publicly accessible, its Domain Name System
1688
1626
  # (DNS) endpoint resolves to the private IP address from within the DB
@@ -1718,47 +1656,42 @@ module Aws::RDS
1718
1656
  # @option options [Array<Types::Tag>] :tags
1719
1657
  # Tags to assign to the DB instance.
1720
1658
  # @option options [String] :db_cluster_identifier
1721
- # The identifier of the DB cluster that the instance will belong to.
1659
+ # The identifier of the DB cluster that this DB instance will belong to.
1722
1660
  #
1723
- # This setting doesn't apply to RDS Custom.
1661
+ # This setting doesn't apply to RDS Custom DB instances.
1724
1662
  # @option options [String] :storage_type
1725
- # Specifies the storage type to be associated with the DB instance.
1726
- #
1727
- # Valid values: `gp2 | gp3 | io1 | standard`
1663
+ # The storage type to associate with the DB instance.
1728
1664
  #
1729
1665
  # If you specify `io1` or `gp3`, you must also include a value for the
1730
1666
  # `Iops` parameter.
1731
1667
  #
1732
- # Default: `io1` if the `Iops` parameter is specified, otherwise `gp2`
1668
+ # This setting doesn't apply to Amazon Aurora DB instances. Storage is
1669
+ # managed by the DB cluster.
1733
1670
  #
1734
- # **Amazon Aurora**
1671
+ # Valid Values: `gp2 | gp3 | io1 | standard`
1735
1672
  #
1736
- # Not applicable. Storage is managed by the DB cluster.
1673
+ # Default: `io1`, if the `Iops` parameter is specified. Otherwise,
1674
+ # `gp2`.
1737
1675
  # @option options [String] :tde_credential_arn
1738
1676
  # The ARN from the key store with which to associate the instance for
1739
1677
  # TDE encryption.
1740
1678
  #
1741
- # This setting doesn't apply to RDS Custom.
1742
- #
1743
- # **Amazon Aurora**
1744
- #
1745
- # Not applicable.
1679
+ # This setting doesn't apply to Amazon Aurora or RDS Custom DB
1680
+ # instances.
1746
1681
  # @option options [String] :tde_credential_password
1747
1682
  # The password for the given ARN from the key store in order to access
1748
1683
  # the device.
1749
1684
  #
1750
- # This setting doesn't apply to RDS Custom.
1685
+ # This setting doesn't apply to RDS Custom DB instances.
1751
1686
  # @option options [Boolean] :storage_encrypted
1752
- # A value that indicates whether the DB instance is encrypted. By
1753
- # default, it isn't encrypted.
1687
+ # Specifes whether the DB instance is encrypted. By default, it isn't
1688
+ # encrypted.
1754
1689
  #
1755
- # For RDS Custom instances, either set this parameter to `true` or leave
1756
- # it unset. If you set this parameter to `false`, RDS reports an error.
1690
+ # For RDS Custom DB instances, either enable this setting or leave it
1691
+ # unset. Otherwise, Amazon RDS reports an error.
1757
1692
  #
1758
- # **Amazon Aurora**
1759
- #
1760
- # Not applicable. The encryption for DB instances is managed by the DB
1761
- # cluster.
1693
+ # This setting doesn't apply to Amazon Aurora DB instances. The
1694
+ # encryption for DB instances is managed by the DB cluster.
1762
1695
  # @option options [String] :kms_key_id
1763
1696
  # The Amazon Web Services KMS key identifier for an encrypted DB
1764
1697
  # instance.
@@ -1768,10 +1701,9 @@ module Aws::RDS
1768
1701
  # different Amazon Web Services account, specify the key ARN or alias
1769
1702
  # ARN.
1770
1703
  #
1771
- # **Amazon Aurora**
1772
- #
1773
- # Not applicable. The Amazon Web Services KMS key identifier is managed
1774
- # by the DB cluster. For more information, see `CreateDBCluster`.
1704
+ # This setting doesn't apply to Amazon Aurora DB instances. The Amazon
1705
+ # Web Services KMS key identifier is managed by the DB cluster. For more
1706
+ # information, see `CreateDBCluster`.
1775
1707
  #
1776
1708
  # If `StorageEncrypted` is enabled, and you do not specify a value for
1777
1709
  # the `KmsKeyId` parameter, then Amazon RDS uses your default KMS key.
@@ -1779,50 +1711,48 @@ module Aws::RDS
1779
1711
  # Amazon Web Services account has a different default KMS key for each
1780
1712
  # Amazon Web Services Region.
1781
1713
  #
1782
- # **Amazon RDS Custom**
1783
- #
1784
- # A KMS key is required for RDS Custom instances. For most RDS engines,
1785
- # if you leave this parameter empty while enabling `StorageEncrypted`,
1786
- # the engine uses the default KMS key. However, RDS Custom doesn't use
1787
- # the default key when this parameter is empty. You must explicitly
1788
- # specify a key.
1714
+ # For Amazon RDS Custom, a KMS key is required for DB instances. For
1715
+ # most RDS engines, if you leave this parameter empty while enabling
1716
+ # `StorageEncrypted`, the engine uses the default KMS key. However, RDS
1717
+ # Custom doesn't use the default key when this parameter is empty. You
1718
+ # must explicitly specify a key.
1789
1719
  # @option options [String] :domain
1790
1720
  # The Active Directory directory ID to create the DB instance in.
1791
- # Currently, only MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB
1721
+ # Currently, only Microsoft SQL Server, MySQL, Oracle, and PostgreSQL DB
1792
1722
  # instances can be created in an Active Directory Domain.
1793
1723
  #
1794
1724
  # For more information, see [ Kerberos Authentication][1] in the *Amazon
1795
1725
  # RDS User Guide*.
1796
1726
  #
1797
- # This setting doesn't apply to RDS Custom.
1727
+ # This setting doesn't apply to the following DB instances:
1798
1728
  #
1799
- # **Amazon Aurora**
1729
+ # * Amazon Aurora (The domain is managed by the DB cluster.)
1800
1730
  #
1801
- # Not applicable. The domain is managed by the DB cluster.
1731
+ # * RDS Custom
1802
1732
  #
1803
1733
  #
1804
1734
  #
1805
1735
  # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/kerberos-authentication.html
1806
1736
  # @option options [Boolean] :copy_tags_to_snapshot
1807
- # A value that indicates whether to copy tags from the DB instance to
1808
- # snapshots of the DB instance. By default, tags are not copied.
1809
- #
1810
- # **Amazon Aurora**
1737
+ # Spcifies whether to copy tags from the DB instance to snapshots of the
1738
+ # DB instance. By default, tags are not copied.
1811
1739
  #
1812
- # Not applicable. Copying tags to snapshots is managed by the DB
1813
- # cluster. Setting this value for an Aurora DB instance has no effect on
1814
- # the DB cluster setting.
1740
+ # This setting doesn't apply to Amazon Aurora DB instances. Copying
1741
+ # tags to snapshots is managed by the DB cluster. Setting this value for
1742
+ # an Aurora DB instance has no effect on the DB cluster setting.
1815
1743
  # @option options [Integer] :monitoring_interval
1816
1744
  # The interval, in seconds, between points when Enhanced Monitoring
1817
1745
  # metrics are collected for the DB instance. To disable collection of
1818
- # Enhanced Monitoring metrics, specify 0. The default is 0.
1746
+ # Enhanced Monitoring metrics, specify `0`.
1819
1747
  #
1820
1748
  # If `MonitoringRoleArn` is specified, then you must set
1821
- # `MonitoringInterval` to a value other than 0.
1749
+ # `MonitoringInterval` to a value other than `0`.
1822
1750
  #
1823
- # This setting doesn't apply to RDS Custom.
1751
+ # This setting doesn't apply to RDS Custom DB instances.
1824
1752
  #
1825
- # Valid Values: `0, 1, 5, 10, 15, 30, 60`
1753
+ # Valid Values: `0 | 1 | 5 | 10 | 15 | 30 | 60`
1754
+ #
1755
+ # Default: `0`
1826
1756
  # @option options [String] :monitoring_role_arn
1827
1757
  # The ARN for the IAM role that permits RDS to send enhanced monitoring
1828
1758
  # metrics to Amazon CloudWatch Logs. For example,
@@ -1830,38 +1760,38 @@ module Aws::RDS
1830
1760
  # a monitoring role, see [Setting Up and Enabling Enhanced
1831
1761
  # Monitoring][1] in the *Amazon RDS User Guide*.
1832
1762
  #
1833
- # If `MonitoringInterval` is set to a value other than 0, then you must
1834
- # supply a `MonitoringRoleArn` value.
1763
+ # If `MonitoringInterval` is set to a value other than `0`, then you
1764
+ # must supply a `MonitoringRoleArn` value.
1835
1765
  #
1836
- # This setting doesn't apply to RDS Custom.
1766
+ # This setting doesn't apply to RDS Custom DB instances.
1837
1767
  #
1838
1768
  #
1839
1769
  #
1840
1770
  # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Monitoring.OS.html#USER_Monitoring.OS.Enabling
1841
1771
  # @option options [String] :domain_iam_role_name
1842
- # Specify the name of the IAM role to be used when making API calls to
1843
- # the Directory Service.
1772
+ # The name of the IAM role to use when making API calls to the Directory
1773
+ # Service.
1844
1774
  #
1845
- # This setting doesn't apply to RDS Custom.
1775
+ # This setting doesn't apply to the following DB instances:
1846
1776
  #
1847
- # **Amazon Aurora**
1777
+ # * Amazon Aurora (The domain is managed by the DB cluster.)
1848
1778
  #
1849
- # Not applicable. The domain is managed by the DB cluster.
1779
+ # * RDS Custom
1850
1780
  # @option options [Integer] :promotion_tier
1851
- # A value that specifies the order in which an Aurora Replica is
1852
- # promoted to the primary instance after a failure of the existing
1853
- # primary instance. For more information, see [ Fault Tolerance for an
1854
- # Aurora DB Cluster][1] in the *Amazon Aurora User Guide*.
1781
+ # The order of priority in which an Aurora Replica is promoted to the
1782
+ # primary instance after a failure of the existing primary instance. For
1783
+ # more information, see [ Fault Tolerance for an Aurora DB Cluster][1]
1784
+ # in the *Amazon Aurora User Guide*.
1855
1785
  #
1856
- # This setting doesn't apply to RDS Custom.
1786
+ # This setting doesn't apply to RDS Custom DB instances.
1857
1787
  #
1858
- # Default: 1
1788
+ # Default: `1`
1859
1789
  #
1860
- # Valid Values: 0 - 15
1790
+ # Valid Values: `0 - 15`
1861
1791
  #
1862
1792
  #
1863
1793
  #
1864
- # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Managing.Backups.html#Aurora.Managing.FaultTolerance
1794
+ # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Concepts.AuroraHighAvailability.html#Aurora.Managing.FaultTolerance
1865
1795
  # @option options [String] :timezone
1866
1796
  # The time zone of the DB instance. The time zone parameter is currently
1867
1797
  # supported only by [Microsoft SQL Server][1].
@@ -1870,29 +1800,29 @@ module Aws::RDS
1870
1800
  #
1871
1801
  # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_SQLServer.html#SQLServer.Concepts.General.TimeZone
1872
1802
  # @option options [Boolean] :enable_iam_database_authentication
1873
- # A value that indicates whether to enable mapping of Amazon Web
1874
- # Services Identity and Access Management (IAM) accounts to database
1875
- # accounts. By default, mapping isn't enabled.
1803
+ # Specifies whether to enable mapping of Amazon Web Services Identity
1804
+ # and Access Management (IAM) accounts to database accounts. By default,
1805
+ # mapping isn't enabled.
1876
1806
  #
1877
1807
  # For more information, see [ IAM Database Authentication for MySQL and
1878
1808
  # PostgreSQL][1] in the *Amazon RDS User Guide*.
1879
1809
  #
1880
- # This setting doesn't apply to RDS Custom.
1810
+ # This setting doesn't apply to the following DB instances:
1881
1811
  #
1882
- # **Amazon Aurora**
1812
+ # * Amazon Aurora (Mapping Amazon Web Services IAM accounts to database
1813
+ # accounts is managed by the DB cluster.)
1883
1814
  #
1884
- # Not applicable. Mapping Amazon Web Services IAM accounts to database
1885
- # accounts is managed by the DB cluster.
1815
+ # * RDS Custom
1886
1816
  #
1887
1817
  #
1888
1818
  #
1889
1819
  # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.IAMDBAuth.html
1890
1820
  # @option options [Boolean] :enable_performance_insights
1891
- # A value that indicates whether to enable Performance Insights for the
1892
- # DB instance. For more information, see [Using Amazon Performance
1893
- # Insights][1] in the *Amazon RDS User Guide*.
1821
+ # Specifies whether to enable Performance Insights for the DB instance.
1822
+ # For more information, see [Using Amazon Performance Insights][1] in
1823
+ # the *Amazon RDS User Guide*.
1894
1824
  #
1895
- # This setting doesn't apply to RDS Custom.
1825
+ # This setting doesn't apply to RDS Custom DB instances.
1896
1826
  #
1897
1827
  #
1898
1828
  #
@@ -1904,70 +1834,54 @@ module Aws::RDS
1904
1834
  # The Amazon Web Services KMS key identifier is the key ARN, key ID,
1905
1835
  # alias ARN, or alias name for the KMS key.
1906
1836
  #
1907
- # If you do not specify a value for `PerformanceInsightsKMSKeyId`, then
1837
+ # If you don't specify a value for `PerformanceInsightsKMSKeyId`, then
1908
1838
  # Amazon RDS uses your default KMS key. There is a default KMS key for
1909
1839
  # your Amazon Web Services account. Your Amazon Web Services account has
1910
1840
  # a different default KMS key for each Amazon Web Services Region.
1911
1841
  #
1912
- # This setting doesn't apply to RDS Custom.
1842
+ # This setting doesn't apply to RDS Custom DB instances.
1913
1843
  # @option options [Integer] :performance_insights_retention_period
1914
- # The number of days to retain Performance Insights data. The default is
1915
- # 7 days. The following values are valid:
1916
- #
1917
- # * 7
1918
- #
1919
- # * *month* * 31, where *month* is a number of months from 1-23
1844
+ # The number of days to retain Performance Insights data.
1920
1845
  #
1921
- # * 731
1846
+ # This setting doesn't apply to RDS Custom DB instances.
1922
1847
  #
1923
- # For example, the following values are valid:
1924
- #
1925
- # * 93 (3 months * 31)
1848
+ # Valid Values:
1926
1849
  #
1927
- # * 341 (11 months * 31)
1850
+ # * `7`
1928
1851
  #
1929
- # * 589 (19 months * 31)
1852
+ # * *month* * 31, where *month* is a number of months from 1-23.
1853
+ # Examples: `93` (3 months * 31), `341` (11 months * 31), `589` (19
1854
+ # months * 31)
1930
1855
  #
1931
- # * 731
1856
+ # * `731`
1932
1857
  #
1933
- # If you specify a retention period such as 94, which isn't a valid
1934
- # value, RDS issues an error.
1858
+ # Default: `7` days
1935
1859
  #
1936
- # This setting doesn't apply to RDS Custom.
1860
+ # If you specify a retention period that isn't valid, such as `94`,
1861
+ # Amazon RDS returns an error.
1937
1862
  # @option options [Array<String>] :enable_cloudwatch_logs_exports
1938
1863
  # The list of log types that need to be enabled for exporting to
1939
- # CloudWatch Logs. The values in the list depend on the DB engine. For
1940
- # more information, see [ Publishing Database Logs to Amazon CloudWatch
1941
- # Logs][1] in the *Amazon RDS User Guide*.
1864
+ # CloudWatch Logs. For more information, see [ Publishing Database Logs
1865
+ # to Amazon CloudWatch Logs][1] in the *Amazon RDS User Guide*.
1942
1866
  #
1943
- # **Amazon Aurora**
1867
+ # This setting doesn't apply to the following DB instances:
1944
1868
  #
1945
- # Not applicable. CloudWatch Logs exports are managed by the DB cluster.
1869
+ # * Amazon Aurora (CloudWatch Logs exports are managed by the DB
1870
+ # cluster.)
1946
1871
  #
1947
- # **RDS Custom**
1872
+ # * RDS Custom
1948
1873
  #
1949
- # Not applicable.
1874
+ # The following values are valid for each DB engine:
1950
1875
  #
1951
- # **MariaDB**
1876
+ # * RDS for MariaDB - `audit | error | general | slowquery`
1952
1877
  #
1953
- # Possible values are `audit`, `error`, `general`, and `slowquery`.
1878
+ # * RDS for Microsoft SQL Server - `agent | error`
1954
1879
  #
1955
- # **Microsoft SQL Server**
1880
+ # * RDS for MySQL - `audit | error | general | slowquery`
1956
1881
  #
1957
- # Possible values are `agent` and `error`.
1882
+ # * RDS for Oracle - `alert | audit | listener | trace | oemagent`
1958
1883
  #
1959
- # **MySQL**
1960
- #
1961
- # Possible values are `audit`, `error`, `general`, and `slowquery`.
1962
- #
1963
- # **Oracle**
1964
- #
1965
- # Possible values are `alert`, `audit`, `listener`, `trace`, and
1966
- # `oemagent`.
1967
- #
1968
- # **PostgreSQL**
1969
- #
1970
- # Possible values are `postgresql` and `upgrade`.
1884
+ # * RDS for PostgreSQL - `postgresql | upgrade`
1971
1885
  #
1972
1886
  #
1973
1887
  #
@@ -1976,23 +1890,19 @@ module Aws::RDS
1976
1890
  # The number of CPU cores and the number of threads per core for the DB
1977
1891
  # instance class of the DB instance.
1978
1892
  #
1979
- # This setting doesn't apply to RDS Custom.
1980
- #
1981
- # **Amazon Aurora**
1982
- #
1983
- # Not applicable.
1893
+ # This setting doesn't apply to Amazon Aurora or RDS Custom DB
1894
+ # instances.
1984
1895
  # @option options [Boolean] :deletion_protection
1985
- # A value that indicates whether the DB instance has deletion protection
1986
- # enabled. The database can't be deleted when deletion protection is
1987
- # enabled. By default, deletion protection isn't enabled. For more
1988
- # information, see [ Deleting a DB Instance][1].
1989
- #
1990
- # **Amazon Aurora**
1991
- #
1992
- # Not applicable. You can enable or disable deletion protection for the
1993
- # DB cluster. For more information, see `CreateDBCluster`. DB instances
1994
- # in a DB cluster can be deleted even when deletion protection is
1995
- # enabled for the DB cluster.
1896
+ # Specifies whether the DB instance has deletion protection enabled. The
1897
+ # database can't be deleted when deletion protection is enabled. By
1898
+ # default, deletion protection isn't enabled. For more information, see
1899
+ # [ Deleting a DB Instance][1].
1900
+ #
1901
+ # This setting doesn't apply to Amazon Aurora DB instances. You can
1902
+ # enable or disable deletion protection for the DB cluster. For more
1903
+ # information, see `CreateDBCluster`. DB instances in a DB cluster can
1904
+ # be deleted even when deletion protection is enabled for the DB
1905
+ # cluster.
1996
1906
  #
1997
1907
  #
1998
1908
  #
@@ -2005,18 +1915,18 @@ module Aws::RDS
2005
1915
  # apply to it, see [ Managing capacity automatically with Amazon RDS
2006
1916
  # storage autoscaling][1] in the *Amazon RDS User Guide*.
2007
1917
  #
2008
- # This setting doesn't apply to RDS Custom.
1918
+ # This setting doesn't apply to the following DB instances:
2009
1919
  #
2010
- # **Amazon Aurora**
1920
+ # * Amazon Aurora (Storage is managed by the DB cluster.)
2011
1921
  #
2012
- # Not applicable. Storage is managed by the DB cluster.
1922
+ # * RDS Custom
2013
1923
  #
2014
1924
  #
2015
1925
  #
2016
1926
  # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PIOPS.StorageTypes.html#USER_PIOPS.Autoscaling
2017
1927
  # @option options [Boolean] :enable_customer_owned_ip
2018
- # A value that indicates whether to enable a customer-owned IP address
2019
- # (CoIP) for an RDS on Outposts DB instance.
1928
+ # Specifies whether to enable a customer-owned IP address (CoIP) for an
1929
+ # RDS on Outposts DB instance.
2020
1930
  #
2021
1931
  # A *CoIP* provides local or external connectivity to resources in your
2022
1932
  # Outpost subnets through your on-premises network. For some use cases,
@@ -2036,8 +1946,11 @@ module Aws::RDS
2036
1946
  # [2]: https://docs.aws.amazon.com/outposts/latest/userguide/routing.html#ip-addressing
2037
1947
  # @option options [String] :custom_iam_instance_profile
2038
1948
  # The instance profile associated with the underlying Amazon EC2
2039
- # instance of an RDS Custom DB instance. The instance profile must meet
2040
- # the following requirements:
1949
+ # instance of an RDS Custom DB instance.
1950
+ #
1951
+ # This setting is required for RDS Custom.
1952
+ #
1953
+ # Constraints:
2041
1954
  #
2042
1955
  # * The profile must exist in your account.
2043
1956
  #
@@ -2050,16 +1963,19 @@ module Aws::RDS
2050
1963
  # For the list of permissions required for the IAM role, see [ Configure
2051
1964
  # IAM and your VPC][1] in the *Amazon RDS User Guide*.
2052
1965
  #
2053
- # This setting is required for RDS Custom.
2054
- #
2055
1966
  #
2056
1967
  #
2057
1968
  # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-setup-orcl.html#custom-setup-orcl.iam-vpc
2058
1969
  # @option options [String] :backup_target
2059
- # Specifies where automated backups and manual snapshots are stored.
1970
+ # The location for storing automated backups and manual snapshots.
1971
+ #
1972
+ # Valie Values:
2060
1973
  #
2061
- # Possible values are `outposts` (Amazon Web Services Outposts) and
2062
- # `region` (Amazon Web Services Region). The default is `region`.
1974
+ # * `outposts` (Amazon Web Services Outposts)
1975
+ #
1976
+ # * `region` (Amazon Web Services Region)
1977
+ #
1978
+ # Default: `region`
2063
1979
  #
2064
1980
  # For more information, see [Working with Amazon RDS on Amazon Web
2065
1981
  # Services Outposts][1] in the *Amazon RDS User Guide*.
@@ -2070,12 +1986,6 @@ module Aws::RDS
2070
1986
  # @option options [String] :network_type
2071
1987
  # The network type of the DB instance.
2072
1988
  #
2073
- # Valid values:
2074
- #
2075
- # * `IPV4`
2076
- #
2077
- # * `DUAL`
2078
- #
2079
1989
  # The network type is determined by the `DBSubnetGroup` specified for
2080
1990
  # the DB instance. A `DBSubnetGroup` can support only the IPv4 protocol
2081
1991
  # or the IPv4 and the IPv6 protocols (`DUAL`).
@@ -2083,18 +1993,21 @@ module Aws::RDS
2083
1993
  # For more information, see [ Working with a DB instance in a VPC][1] in
2084
1994
  # the *Amazon RDS User Guide.*
2085
1995
  #
1996
+ # Valid Values: `IPV4 | DUAL`
1997
+ #
2086
1998
  #
2087
1999
  #
2088
2000
  # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html
2089
2001
  # @option options [Integer] :storage_throughput
2090
- # Specifies the storage throughput value for the DB instance.
2002
+ # The storage throughput value for the DB instance.
2091
2003
  #
2092
2004
  # This setting applies only to the `gp3` storage type.
2093
2005
  #
2094
- # This setting doesn't apply to RDS Custom or Amazon Aurora.
2006
+ # This setting doesn't apply to Amazon Aurora or RDS Custom DB
2007
+ # instances.
2095
2008
  # @option options [Boolean] :manage_master_user_password
2096
- # A value that indicates whether to manage the master user password with
2097
- # Amazon Web Services Secrets Manager.
2009
+ # Specifies whether to manage the master user password with Amazon Web
2010
+ # Services Secrets Manager.
2098
2011
  #
2099
2012
  # For more information, see [Password management with Amazon Web
2100
2013
  # Services Secrets Manager][1] in the *Amazon RDS User Guide.*
@@ -2132,10 +2045,10 @@ module Aws::RDS
2132
2045
  # Amazon Web Services account has a different default KMS key for each
2133
2046
  # Amazon Web Services Region.
2134
2047
  # @option options [String] :ca_certificate_identifier
2135
- # Specifies the CA certificate identifier to use for the DB instances
2136
- # server certificate.
2048
+ # The CA certificate identifier to use for the DB instance's server
2049
+ # certificate.
2137
2050
  #
2138
- # This setting doesn't apply to RDS Custom.
2051
+ # This setting doesn't apply to RDS Custom DB instances.
2139
2052
  #
2140
2053
  # For more information, see [Using SSL/TLS to encrypt a connection to a
2141
2054
  # DB instance][1] in the *Amazon RDS User Guide* and [ Using SSL/TLS to
@@ -2672,18 +2585,18 @@ module Aws::RDS
2672
2585
  # @option options [String] :db_cluster_identifier
2673
2586
  # The user-supplied DB cluster identifier or the Amazon Resource Name
2674
2587
  # (ARN) of the DB cluster. If this parameter is specified, information
2675
- # from only the specific DB cluster is returned. This parameter isn't
2588
+ # for only the specific DB cluster is returned. This parameter isn't
2676
2589
  # case-sensitive.
2677
2590
  #
2678
2591
  # Constraints:
2679
2592
  #
2680
- # * If supplied, must match an existing DBClusterIdentifier.
2593
+ # * If supplied, must match an existing DB cluster identifier.
2681
2594
  #
2682
2595
  # ^
2683
2596
  # @option options [Array<Types::Filter>] :filters
2684
2597
  # A filter that specifies one or more DB clusters to describe.
2685
2598
  #
2686
- # Supported filters:
2599
+ # Supported Filters:
2687
2600
  #
2688
2601
  # * `clone-group-id` - Accepts clone group identifiers. The results list
2689
2602
  # only includes information about the DB clusters associated with
@@ -2704,9 +2617,8 @@ module Aws::RDS
2704
2617
  # * `engine` - Accepts engine names. The results list only includes
2705
2618
  # information about the DB clusters for these engines.
2706
2619
  # @option options [Boolean] :include_shared
2707
- # Optional Boolean parameter that specifies whether the output includes
2708
- # information about clusters shared from other Amazon Web Services
2709
- # accounts.
2620
+ # Specifies whether the output includes information about clusters
2621
+ # shared from other Amazon Web Services accounts.
2710
2622
  # @return [DBCluster::Collection]
2711
2623
  def db_clusters(options = {})
2712
2624
  batches = Enumerator.new do |y|
@@ -2928,13 +2840,13 @@ module Aws::RDS
2928
2840
  #
2929
2841
  # Constraints:
2930
2842
  #
2931
- # * If supplied, must match the identifier of an existing DBInstance.
2843
+ # * If supplied, must match the identifier of an existing DB instance.
2932
2844
  #
2933
2845
  # ^
2934
2846
  # @option options [Array<Types::Filter>] :filters
2935
2847
  # A filter that specifies one or more DB instances to describe.
2936
2848
  #
2937
- # Supported filters:
2849
+ # Supported Filters:
2938
2850
  #
2939
2851
  # * `db-cluster-id` - Accepts DB cluster identifiers and DB cluster
2940
2852
  # Amazon Resource Names (ARNs). The results list only includes
@@ -2946,7 +2858,7 @@ module Aws::RDS
2946
2858
  # information about the DB instances identified by these ARNs.
2947
2859
  #
2948
2860
  # * `dbi-resource-id` - Accepts DB instance resource identifiers. The
2949
- # results list will only include information about the DB instances
2861
+ # results list only includes information about the DB instances
2950
2862
  # identified by these DB instance resource identifiers.
2951
2863
  #
2952
2864
  # * `domain` - Accepts Active Directory directory IDs. The results list