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.
@@ -35,20 +35,19 @@ module Aws::RDS
35
35
  end
36
36
  alias :db_instance_identifier :id
37
37
 
38
- # Contains the name of the compute and memory capacity class of the DB
39
- # instance.
38
+ # The name of the compute and memory capacity class of the DB instance.
40
39
  # @return [String]
41
40
  def db_instance_class
42
41
  data[:db_instance_class]
43
42
  end
44
43
 
45
- # The name of the database engine to be used for this DB instance.
44
+ # The database engine used for this DB instance.
46
45
  # @return [String]
47
46
  def engine
48
47
  data[:engine]
49
48
  end
50
49
 
51
- # Specifies the current state of this database.
50
+ # The current state of this database.
52
51
  #
53
52
  # For information about DB instance statuses, see [Viewing DB instance
54
53
  # status][1] in the *Amazon RDS User Guide.*
@@ -67,36 +66,31 @@ module Aws::RDS
67
66
  data[:automatic_restart_time]
68
67
  end
69
68
 
70
- # Contains the master username for the DB instance.
69
+ # The master username for the DB instance.
71
70
  # @return [String]
72
71
  def master_username
73
72
  data[:master_username]
74
73
  end
75
74
 
76
- # The meaning of this parameter differs according to the database engine
77
- # you use.
78
- #
79
- # **MySQL, MariaDB, SQL Server, PostgreSQL**
80
- #
81
- # Contains the name of the initial database of this instance that was
82
- # provided at create time, if one was specified when the DB instance was
83
- # created. This same name is returned for the life of the DB instance.
75
+ # The meaning of this parameter differs depending on the database
76
+ # engine.
84
77
  #
85
- # Type: String
78
+ # * For RDS for MariaDB, Microsoft SQL Server, MySQL, and PostgreSQL -
79
+ # The name of the initial database specified for this DB instance when
80
+ # it was created, if one was provided. This same name is returned for
81
+ # the life of the DB instance.
86
82
  #
87
- # **Oracle**
88
- #
89
- # Contains the Oracle System ID (SID) of the created DB instance. Not
90
- # shown when the returned parameters do not apply to an Oracle DB
91
- # instance.
83
+ # * For RDS for Oracle - The Oracle System ID (SID) of the created DB
84
+ # instance. This value is only returned when the object returned is an
85
+ # Oracle DB instance.
92
86
  # @return [String]
93
87
  def db_name
94
88
  data[:db_name]
95
89
  end
96
90
 
97
- # Specifies the connection endpoint.
91
+ # The connection endpoint for the DB instance.
98
92
  #
99
- # <note markdown="1"> The endpoint might not be shown for instances whose status is
93
+ # <note markdown="1"> The endpoint might not be shown for instances with the status of
100
94
  # `creating`.
101
95
  #
102
96
  # </note>
@@ -105,28 +99,28 @@ module Aws::RDS
105
99
  data[:endpoint]
106
100
  end
107
101
 
108
- # Specifies the allocated storage size specified in gibibytes (GiB).
102
+ # The amount of storage in gibibytes (GiB) allocated for the DB
103
+ # instance.
109
104
  # @return [Integer]
110
105
  def allocated_storage
111
106
  data[:allocated_storage]
112
107
  end
113
108
 
114
- # Provides the date and time the DB instance was created.
109
+ # The date and time when the DB instance was created.
115
110
  # @return [Time]
116
111
  def instance_create_time
117
112
  data[:instance_create_time]
118
113
  end
119
114
 
120
- # Specifies the daily time range during which automated backups are
121
- # created if automated backups are enabled, as determined by the
115
+ # The daily time range during which automated backups are created if
116
+ # automated backups are enabled, as determined by the
122
117
  # `BackupRetentionPeriod`.
123
118
  # @return [String]
124
119
  def preferred_backup_window
125
120
  data[:preferred_backup_window]
126
121
  end
127
122
 
128
- # Specifies the number of days for which automatic DB snapshots are
129
- # retained.
123
+ # The number of days for which automatic DB snapshots are retained.
130
124
  # @return [Integer]
131
125
  def backup_retention_period
132
126
  data[:backup_retention_period]
@@ -139,96 +133,91 @@ module Aws::RDS
139
133
  data[:db_security_groups]
140
134
  end
141
135
 
142
- # Provides a list of VPC security group elements that the DB instance
136
+ # The list of Amazon EC2 VPC security groups that the DB instance
143
137
  # belongs to.
144
138
  # @return [Array<Types::VpcSecurityGroupMembership>]
145
139
  def vpc_security_groups
146
140
  data[:vpc_security_groups]
147
141
  end
148
142
 
149
- # Provides the list of DB parameter groups applied to this DB instance.
143
+ # The list of DB parameter groups applied to this DB instance.
150
144
  # @return [Array<Types::DBParameterGroupStatus>]
151
145
  def db_parameter_groups
152
146
  data[:db_parameter_groups]
153
147
  end
154
148
 
155
- # Specifies the name of the Availability Zone the DB instance is located
156
- # in.
149
+ # The name of the Availability Zone where the DB instance is located.
157
150
  # @return [String]
158
151
  def availability_zone
159
152
  data[:availability_zone]
160
153
  end
161
154
 
162
- # Specifies information on the subnet group associated with the DB
163
- # instance, including the name, description, and subnets in the subnet
164
- # group.
155
+ # Information about the subnet group associated with the DB instance,
156
+ # including the name, description, and subnets in the subnet group.
165
157
  # @return [Types::DBSubnetGroup]
166
158
  def db_subnet_group
167
159
  data[:db_subnet_group]
168
160
  end
169
161
 
170
- # Specifies the weekly time range during which system maintenance can
171
- # occur, in Universal Coordinated Time (UTC).
162
+ # The weekly time range during which system maintenance can occur, in
163
+ # Universal Coordinated Time (UTC).
172
164
  # @return [String]
173
165
  def preferred_maintenance_window
174
166
  data[:preferred_maintenance_window]
175
167
  end
176
168
 
177
- # A value that specifies that changes to the DB instance are pending.
178
- # This element is only included when changes are pending. Specific
179
- # changes are identified by subelements.
169
+ # Information about pending changes to the DB instance. This information
170
+ # is returned only when there are pending changes. Specific changes are
171
+ # identified by subelements.
180
172
  # @return [Types::PendingModifiedValues]
181
173
  def pending_modified_values
182
174
  data[:pending_modified_values]
183
175
  end
184
176
 
185
- # Specifies the latest time to which a database can be restored with
186
- # point-in-time restore.
177
+ # The latest time to which a database in this DB instance can be
178
+ # restored with point-in-time restore.
187
179
  # @return [Time]
188
180
  def latest_restorable_time
189
181
  data[:latest_restorable_time]
190
182
  end
191
183
 
192
- # Specifies if the DB instance is a Multi-AZ deployment. This setting
193
- # doesn't apply to RDS Custom.
184
+ # Indicates whether the DB instance is a Multi-AZ deployment. This
185
+ # setting doesn't apply to RDS Custom DB instances.
194
186
  # @return [Boolean]
195
187
  def multi_az
196
188
  data[:multi_az]
197
189
  end
198
190
 
199
- # Indicates the database engine version.
191
+ # The version of the database engine.
200
192
  # @return [String]
201
193
  def engine_version
202
194
  data[:engine_version]
203
195
  end
204
196
 
205
- # A value that indicates that minor version patches are applied
206
- # automatically.
197
+ # Indicates whether minor version patches are applied automatically.
207
198
  # @return [Boolean]
208
199
  def auto_minor_version_upgrade
209
200
  data[:auto_minor_version_upgrade]
210
201
  end
211
202
 
212
- # Contains the identifier of the source DB instance if this DB instance
213
- # is a read replica.
203
+ # The identifier of the source DB instance if this DB instance is a read
204
+ # replica.
214
205
  # @return [String]
215
206
  def read_replica_source_db_instance_identifier
216
207
  data[:read_replica_source_db_instance_identifier]
217
208
  end
218
209
 
219
- # Contains one or more identifiers of the read replicas associated with
220
- # this DB instance.
210
+ # The identifiers of the read replicas associated with this DB instance.
221
211
  # @return [Array<String>]
222
212
  def read_replica_db_instance_identifiers
223
213
  data[:read_replica_db_instance_identifiers]
224
214
  end
225
215
 
226
- # Contains one or more identifiers of Aurora DB clusters to which the
227
- # RDS DB instance is replicated as a read replica. For example, when you
228
- # create an Aurora read replica of an RDS for MySQL DB instance, the
229
- # Aurora MySQL DB cluster for the Aurora read replica is shown. This
230
- # output doesn't contain information about cross-Region Aurora read
231
- # replicas.
216
+ # The identifiers of Aurora DB clusters to which the RDS DB instance is
217
+ # replicated as a read replica. For example, when you create an Aurora
218
+ # read replica of an RDS for MySQL DB instance, the Aurora MySQL DB
219
+ # cluster for the Aurora read replica is shown. This output doesn't
220
+ # contain information about cross-Region Aurora read replicas.
232
221
  #
233
222
  # <note markdown="1"> Currently, each RDS DB instance can have only one Aurora read replica.
234
223
  #
@@ -254,20 +243,21 @@ module Aws::RDS
254
243
  data[:replica_mode]
255
244
  end
256
245
 
257
- # License model information for this DB instance. This setting doesn't
258
- # apply to RDS Custom.
246
+ # The license model information for this DB instance. This setting
247
+ # doesn't apply to RDS Custom DB instances.
259
248
  # @return [String]
260
249
  def license_model
261
250
  data[:license_model]
262
251
  end
263
252
 
264
- # Specifies the Provisioned IOPS (I/O operations per second) value.
253
+ # The Provisioned IOPS (I/O operations per second) value for the DB
254
+ # instance.
265
255
  # @return [Integer]
266
256
  def iops
267
257
  data[:iops]
268
258
  end
269
259
 
270
- # Provides the list of option group memberships for this DB instance.
260
+ # The list of option group memberships for this DB instance.
271
261
  # @return [Array<Types::OptionGroupMembership>]
272
262
  def option_group_memberships
273
263
  data[:option_group_memberships]
@@ -295,7 +285,7 @@ module Aws::RDS
295
285
  data[:secondary_availability_zone]
296
286
  end
297
287
 
298
- # Specifies the accessibility options for the DB instance.
288
+ # Indicates whether the DB instance is publicly accessible.
299
289
  #
300
290
  # When the DB cluster is publicly accessible, its Domain Name System
301
291
  # (DNS) endpoint resolves to the private IP address from within the DB
@@ -314,14 +304,14 @@ module Aws::RDS
314
304
  data[:publicly_accessible]
315
305
  end
316
306
 
317
- # The status of a read replica. If the instance isn't a read replica,
318
- # this is blank.
307
+ # The status of a read replica. If the DB instance isn't a read
308
+ # replica, the value is blank.
319
309
  # @return [Array<Types::DBInstanceStatusInfo>]
320
310
  def status_infos
321
311
  data[:status_infos]
322
312
  end
323
313
 
324
- # Specifies the storage type associated with the DB instance.
314
+ # The storage type associated with the DB instance.
325
315
  # @return [String]
326
316
  def storage_type
327
317
  data[:storage_type]
@@ -334,28 +324,28 @@ module Aws::RDS
334
324
  data[:tde_credential_arn]
335
325
  end
336
326
 
337
- # Specifies the port that the DB instance listens on. If the DB instance
338
- # is part of a DB cluster, this can be a different port than the DB
339
- # cluster port.
327
+ # The port that the DB instance listens on. If the DB instance is part
328
+ # of a DB cluster, this can be a different port than the DB cluster
329
+ # port.
340
330
  # @return [Integer]
341
331
  def db_instance_port
342
332
  data[:db_instance_port]
343
333
  end
344
334
 
345
- # If the DB instance is a member of a DB cluster, contains the name of
335
+ # If the DB instance is a member of a DB cluster, indicates the name of
346
336
  # the DB cluster that the DB instance is a member of.
347
337
  # @return [String]
348
338
  def db_cluster_identifier
349
339
  data[:db_cluster_identifier]
350
340
  end
351
341
 
352
- # Specifies whether the DB instance is encrypted.
342
+ # Indicates whether the DB instance is encrypted.
353
343
  # @return [Boolean]
354
344
  def storage_encrypted
355
345
  data[:storage_encrypted]
356
346
  end
357
347
 
358
- # If `StorageEncrypted` is true, the Amazon Web Services KMS key
348
+ # If `StorageEncrypted` is enabled, the Amazon Web Services KMS key
359
349
  # identifier for the encrypted DB instance.
360
350
  #
361
351
  # The Amazon Web Services KMS key identifier is the key ARN, key ID,
@@ -397,14 +387,13 @@ module Aws::RDS
397
387
  data[:domain_memberships]
398
388
  end
399
389
 
400
- # Specifies whether tags are copied from the DB instance to snapshots of
390
+ # Indicates whether tags are copied from the DB instance to snapshots of
401
391
  # the DB instance.
402
392
  #
403
- # **Amazon Aurora**
404
- #
405
- # Not applicable. Copying tags to snapshots is managed by the DB
406
- # cluster. Setting this value for an Aurora DB instance has no effect on
407
- # the DB cluster setting. For more information, see `DBCluster`.
393
+ # This setting doesn't apply to Amazon Aurora DB instances. Copying
394
+ # tags to snapshots is managed by the DB cluster. Setting this value for
395
+ # an Aurora DB instance has no effect on the DB cluster setting. For
396
+ # more information, see `DBCluster`.
408
397
  # @return [Boolean]
409
398
  def copy_tags_to_snapshot
410
399
  data[:copy_tags_to_snapshot]
@@ -432,14 +421,14 @@ module Aws::RDS
432
421
  data[:monitoring_role_arn]
433
422
  end
434
423
 
435
- # A value that specifies the order in which an Aurora Replica is
436
- # promoted to the primary instance after a failure of the existing
437
- # primary instance. For more information, see [ Fault Tolerance for an
438
- # Aurora DB Cluster][1] in the *Amazon Aurora User Guide*.
424
+ # The order of priority in which an Aurora Replica is promoted to the
425
+ # primary instance after a failure of the existing primary instance. For
426
+ # more information, see [ Fault Tolerance for an Aurora DB Cluster][1]
427
+ # in the *Amazon Aurora User Guide*.
439
428
  #
440
429
  #
441
430
  #
442
- # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Managing.Backups.html#Aurora.Managing.FaultTolerance
431
+ # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Concepts.AuroraHighAvailability.html#Aurora.Managing.FaultTolerance
443
432
  # @return [Integer]
444
433
  def promotion_tier
445
434
  data[:promotion_tier]
@@ -459,8 +448,9 @@ module Aws::RDS
459
448
  data[:timezone]
460
449
  end
461
450
 
462
- # True if mapping of Amazon Web Services Identity and Access Management
463
- # (IAM) accounts to database accounts is enabled, and otherwise false.
451
+ # Indicates whether mapping of Amazon Web Services Identity and Access
452
+ # Management (IAM) accounts to database accounts is enabled for the DB
453
+ # instance.
464
454
  #
465
455
  # For a list of engine versions that support IAM database
466
456
  # authentication, see [IAM database authentication][1] in the *Amazon
@@ -476,8 +466,7 @@ module Aws::RDS
476
466
  data[:iam_database_authentication_enabled]
477
467
  end
478
468
 
479
- # True if Performance Insights is enabled for the DB instance, and
480
- # otherwise false.
469
+ # Indicates whether Performance Insights is enabled for the DB instance.
481
470
  # @return [Boolean]
482
471
  def performance_insights_enabled
483
472
  data[:performance_insights_enabled]
@@ -493,24 +482,19 @@ module Aws::RDS
493
482
  data[:performance_insights_kms_key_id]
494
483
  end
495
484
 
496
- # The number of days to retain Performance Insights data. The default is
497
- # 7 days. The following values are valid:
498
- #
499
- # * 7
500
- #
501
- # * *month* * 31, where *month* is a number of months from 1-23
502
- #
503
- # * 731
485
+ # The number of days to retain Performance Insights data.
504
486
  #
505
- # For example, the following values are valid:
487
+ # Valid Values:
506
488
  #
507
- # * 93 (3 months * 31)
489
+ # * `7`
508
490
  #
509
- # * 341 (11 months * 31)
491
+ # * *month* * 31, where *month* is a number of months from 1-23.
492
+ # Examples: `93` (3 months * 31), `341` (11 months * 31), `589` (19
493
+ # months * 31)
510
494
  #
511
- # * 589 (19 months * 31)
495
+ # * `731`
512
496
  #
513
- # * 731
497
+ # Default: `7` days
514
498
  # @return [Integer]
515
499
  def performance_insights_retention_period
516
500
  data[:performance_insights_retention_period]
@@ -520,8 +504,8 @@ module Aws::RDS
520
504
  # CloudWatch Logs.
521
505
  #
522
506
  # Log types vary by DB engine. For information about the log types for
523
- # each DB engine, see [Amazon RDS Database Log Files][1] in the *Amazon
524
- # RDS User Guide.*
507
+ # each DB engine, see [Monitoring Amazon RDS log files][1] in the
508
+ # *Amazon RDS User Guide.*
525
509
  #
526
510
  #
527
511
  #
@@ -538,7 +522,7 @@ module Aws::RDS
538
522
  data[:processor_features]
539
523
  end
540
524
 
541
- # Indicates if the DB instance has deletion protection enabled. The
525
+ # Indicates whether the DB instance has deletion protection enabled. The
542
526
  # database can't be deleted when deletion protection is enabled. For
543
527
  # more information, see [ Deleting a DB Instance][1].
544
528
  #
@@ -557,7 +541,7 @@ module Aws::RDS
557
541
  data[:associated_roles]
558
542
  end
559
543
 
560
- # Specifies the listener connection endpoint for SQL Server Always On.
544
+ # The listener connection endpoint for SQL Server Always On.
561
545
  # @return [Types::Endpoint]
562
546
  def listener_endpoint
563
547
  data[:listener_endpoint]
@@ -588,7 +572,7 @@ module Aws::RDS
588
572
  data[:db_instance_automated_backups_replications]
589
573
  end
590
574
 
591
- # Specifies whether a customer-owned IP address (CoIP) is enabled for an
575
+ # Indicates whether a customer-owned IP address (CoIP) is enabled for an
592
576
  # RDS on Outposts DB instance.
593
577
  #
594
578
  # A <i>CoIP </i>provides local or external connectivity to resources in
@@ -697,7 +681,7 @@ module Aws::RDS
697
681
  data[:custom_iam_instance_profile]
698
682
  end
699
683
 
700
- # Specifies where automated backups and manual snapshots are stored:
684
+ # The location where automated backups and manual snapshots are stored:
701
685
  # Amazon Web Services Outposts or the Amazon Web Services Region.
702
686
  # @return [String]
703
687
  def backup_target
@@ -706,12 +690,6 @@ module Aws::RDS
706
690
 
707
691
  # The network type of the DB instance.
708
692
  #
709
- # Valid values:
710
- #
711
- # * `IPV4`
712
- #
713
- # * `DUAL`
714
- #
715
693
  # The network type is determined by the `DBSubnetGroup` specified for
716
694
  # the DB instance. A `DBSubnetGroup` can support only the IPv4 protocol
717
695
  # or the IPv4 and the IPv6 protocols (`DUAL`).
@@ -720,6 +698,8 @@ module Aws::RDS
720
698
  # the *Amazon RDS User Guide* and [ Working with a DB instance in a
721
699
  # VPC][2] in the *Amazon Aurora User Guide.*
722
700
  #
701
+ # Valid Values: `IPV4 | DUAL`
702
+ #
723
703
  #
724
704
  #
725
705
  # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html
@@ -735,7 +715,7 @@ module Aws::RDS
735
715
  data[:activity_stream_policy_status]
736
716
  end
737
717
 
738
- # Specifies the storage throughput for the DB instance.
718
+ # The storage throughput for the DB instance.
739
719
  #
740
720
  # This setting applies only to the `gp3` storage type.
741
721
  # @return [Integer]
@@ -744,15 +724,15 @@ module Aws::RDS
744
724
  end
745
725
 
746
726
  # The Oracle system ID (Oracle SID) for a container database (CDB). The
747
- # Oracle SID is also the name of the CDB. This setting is valid for RDS
748
- # Custom only.
727
+ # Oracle SID is also the name of the CDB. This setting is only valid for
728
+ # RDS Custom DB instances.
749
729
  # @return [String]
750
730
  def db_system_id
751
731
  data[:db_system_id]
752
732
  end
753
733
 
754
- # Contains the secret managed by RDS in Amazon Web Services Secrets
755
- # Manager for the master user password.
734
+ # The secret managed by RDS in Amazon Web Services Secrets Manager for
735
+ # the master user password.
756
736
  #
757
737
  # For more information, see [Password management with Amazon Web
758
738
  # Services Secrets Manager][1] in the *Amazon RDS User Guide.*
@@ -771,8 +751,8 @@ module Aws::RDS
771
751
  data[:certificate_details]
772
752
  end
773
753
 
774
- # Contains the identifier of the source DB cluster if this DB instance
775
- # is a read replica.
754
+ # The identifier of the source DB cluster if this DB instance is a read
755
+ # replica.
776
756
  # @return [String]
777
757
  def read_replica_source_db_cluster_identifier
778
758
  data[:read_replica_source_db_cluster_identifier]
@@ -986,223 +966,205 @@ module Aws::RDS
986
966
  # })
987
967
  # @param [Hash] options ({})
988
968
  # @option options [String] :db_name
989
- # The meaning of this parameter differs according to the database engine
990
- # you use.
991
- #
992
- # **MySQL**
993
- #
994
- # The name of the database to create when the DB instance is created. If
995
- # this parameter isn't specified, no database is created in the DB
996
- # instance.
997
- #
998
- # Constraints:
999
- #
1000
- # * Must contain 1 to 64 letters or numbers.
1001
- #
1002
- # * Must begin with a letter. Subsequent characters can be letters,
1003
- # underscores, or digits (0-9).
1004
- #
1005
- # * Can't be a word reserved by the specified database engine
969
+ # The meaning of this parameter differs depending on the database
970
+ # engine.
1006
971
  #
1007
- # **MariaDB**
972
+ # Amazon Aurora MySQL
973
+ # Amazon Aurora PostgreSQL
974
+ # Amazon RDS Custom for Oracle
975
+ # Amazon RDS Custom for SQL Server
976
+ # RDS for MariaDB
977
+ # RDS for MySQL
978
+ # RDS for Oracle
979
+ # RDS for PostgreSQL
980
+ # RDS for SQL Server
1008
981
  #
1009
- # The name of the database to create when the DB instance is created. If
1010
- # this parameter isn't specified, no database is created in the DB
1011
- # instance.
982
+ # : The name of the database to create when the primary DB instance of
983
+ # the Aurora MySQL DB cluster is created. If you don't specify a
984
+ # value, Amazon RDS doesn't create a database in the DB cluster.
1012
985
  #
1013
- # Constraints:
986
+ # Constraints:
1014
987
  #
1015
- # * Must contain 1 to 64 letters or numbers.
988
+ # * Must contain 1 to 64 alphanumeric characters.
1016
989
  #
1017
- # * Must begin with a letter. Subsequent characters can be letters,
1018
- # underscores, or digits (0-9).
990
+ # * Can't be a word reserved by the database engine.
1019
991
  #
1020
- # * Can't be a word reserved by the specified database engine
992
+ # : The name of the database to create when the primary DB instance of
993
+ # the Aurora PostgreSQL DB cluster is created.
1021
994
  #
1022
- # **PostgreSQL**
995
+ # Default: `postgres`
1023
996
  #
1024
- # The name of the database to create when the DB instance is created. If
1025
- # this parameter isn't specified, a database named `postgres` is
1026
- # created in the DB instance.
997
+ # Constraints:
1027
998
  #
1028
- # Constraints:
999
+ # * Must contain 1 to 63 alphanumeric characters.
1029
1000
  #
1030
- # * Must contain 1 to 63 letters, numbers, or underscores.
1001
+ # * Must begin with a letter. Subsequent characters can be letters,
1002
+ # underscores, or digits (0 to 9).
1031
1003
  #
1032
- # * Must begin with a letter. Subsequent characters can be letters,
1033
- # underscores, or digits (0-9).
1004
+ # * Can't be a word reserved by the database engine.
1034
1005
  #
1035
- # * Can't be a word reserved by the specified database engine
1006
+ # : The Oracle System ID (SID) of the created RDS Custom DB instance.
1036
1007
  #
1037
- # **Oracle**
1008
+ # Default: `ORCL`
1038
1009
  #
1039
- # The Oracle System ID (SID) of the created DB instance. If you specify
1040
- # `null`, the default value `ORCL` is used. You can't specify the
1041
- # string NULL, or any other reserved word, for `DBName`.
1010
+ # Constraints:
1042
1011
  #
1043
- # Default: `ORCL`
1012
+ # * Must contain 1 to 8 alphanumeric characters.
1044
1013
  #
1045
- # Constraints:
1014
+ # * Must contain a letter.
1046
1015
  #
1047
- # * Can't be longer than 8 characters
1016
+ # * Can't be a word reserved by the database engine.
1048
1017
  #
1049
- # ^
1018
+ # : Not applicable. Must be null.
1050
1019
  #
1051
- # **Amazon RDS Custom for Oracle**
1020
+ # : The name of the database to create when the DB instance is created.
1021
+ # If you don't specify a value, Amazon RDS doesn't create a database
1022
+ # in the DB instance.
1052
1023
  #
1053
- # The Oracle System ID (SID) of the created RDS Custom DB instance. If
1054
- # you don't specify a value, the default value is `ORCL`.
1024
+ # Constraints:
1055
1025
  #
1056
- # Default: `ORCL`
1026
+ # * Must contain 1 to 64 letters or numbers.
1057
1027
  #
1058
- # Constraints:
1028
+ # * Must begin with a letter. Subsequent characters can be letters,
1029
+ # underscores, or digits (0-9).
1059
1030
  #
1060
- # * It must contain 1 to 8 alphanumeric characters.
1031
+ # * Can't be a word reserved by the database engine.
1061
1032
  #
1062
- # * It must contain a letter.
1033
+ # : The name of the database to create when the DB instance is created.
1034
+ # If you don't specify a value, Amazon RDS doesn't create a database
1035
+ # in the DB instance.
1063
1036
  #
1064
- # * It can't be a word reserved by the database engine.
1037
+ # Constraints:
1065
1038
  #
1066
- # **Amazon RDS Custom for SQL Server**
1039
+ # * Must contain 1 to 64 letters or numbers.
1067
1040
  #
1068
- # Not applicable. Must be null.
1041
+ # * Must begin with a letter. Subsequent characters can be letters,
1042
+ # underscores, or digits (0-9).
1069
1043
  #
1070
- # **SQL Server**
1044
+ # * Can't be a word reserved by the database engine.
1071
1045
  #
1072
- # Not applicable. Must be null.
1046
+ # : The Oracle System ID (SID) of the created DB instance.
1073
1047
  #
1074
- # **Amazon Aurora MySQL**
1048
+ # Default: `ORCL`
1075
1049
  #
1076
- # The name of the database to create when the primary DB instance of the
1077
- # Aurora MySQL DB cluster is created. If this parameter isn't specified
1078
- # for an Aurora MySQL DB cluster, no database is created in the DB
1079
- # cluster.
1050
+ # Constraints:
1080
1051
  #
1081
- # Constraints:
1052
+ # * Can't be longer than 8 characters.
1082
1053
  #
1083
- # * It must contain 1 to 64 alphanumeric characters.
1054
+ # * Can't be a word reserved by the database engine, such as the
1055
+ # string `NULL`.
1084
1056
  #
1085
- # * It can't be a word reserved by the database engine.
1057
+ # : The name of the database to create when the DB instance is created.
1086
1058
  #
1087
- # **Amazon Aurora PostgreSQL**
1059
+ # Default: `postgres`
1088
1060
  #
1089
- # The name of the database to create when the primary DB instance of the
1090
- # Aurora PostgreSQL DB cluster is created. If this parameter isn't
1091
- # specified for an Aurora PostgreSQL DB cluster, a database named
1092
- # `postgres` is created in the DB cluster.
1061
+ # Constraints:
1093
1062
  #
1094
- # Constraints:
1063
+ # * Must contain 1 to 63 letters, numbers, or underscores.
1095
1064
  #
1096
- # * It must contain 1 to 63 alphanumeric characters.
1065
+ # * Must begin with a letter. Subsequent characters can be letters,
1066
+ # underscores, or digits (0-9).
1097
1067
  #
1098
- # * It must begin with a letter. Subsequent characters can be letters,
1099
- # underscores, or digits (0 to 9).
1068
+ # * Can't be a word reserved by the database engine.
1100
1069
  #
1101
- # * It can't be a word reserved by the database engine.
1070
+ # : Not applicable. Must be null.
1102
1071
  # @option options [Integer] :allocated_storage
1103
1072
  # The amount of storage in gibibytes (GiB) to allocate for the DB
1104
1073
  # instance.
1105
1074
  #
1106
- # Type: Integer
1107
- #
1108
- # **Amazon Aurora**
1109
- #
1110
- # Not applicable. Aurora cluster volumes automatically grow as the
1111
- # amount of data in your database increases, though you are only charged
1112
- # for the space that you use in an Aurora cluster volume.
1075
+ # This setting doesn't apply to Amazon Aurora DB instances. Aurora
1076
+ # cluster volumes automatically grow as the amount of data in your
1077
+ # database increases, though you are only charged for the space that you
1078
+ # use in an Aurora cluster volume.
1113
1079
  #
1114
- # **Amazon RDS Custom**
1080
+ # Amazon RDS Custom
1081
+ # RDS for MariaDB
1082
+ # RDS for MySQL
1083
+ # RDS for Oracle
1084
+ # RDS for PostgreSQL
1085
+ # RDS for SQL Server
1115
1086
  #
1116
- # Constraints to the amount of storage for each storage type are the
1117
- # following:
1087
+ # : Constraints to the amount of storage for each storage type are the
1088
+ # following:
1118
1089
  #
1119
- # * General Purpose (SSD) storage (gp2, gp3): Must be an integer from 40
1120
- # to 65536 for RDS Custom for Oracle, 16384 for RDS Custom for SQL
1121
- # Server.
1090
+ # * General Purpose (SSD) storage (gp2, gp3): Must be an integer from
1091
+ # 40 to 65536 for RDS Custom for Oracle, 16384 for RDS Custom for
1092
+ # SQL Server.
1122
1093
  #
1123
- # * Provisioned IOPS storage (io1): Must be an integer from 40 to 65536
1124
- # for RDS Custom for Oracle, 16384 for RDS Custom for SQL Server.
1094
+ # * Provisioned IOPS storage (io1): Must be an integer from 40 to
1095
+ # 65536 for RDS Custom for Oracle, 16384 for RDS Custom for SQL
1096
+ # Server.
1125
1097
  #
1126
- # **MySQL**
1098
+ # : Constraints to the amount of storage for each storage type are the
1099
+ # following:
1127
1100
  #
1128
- # Constraints to the amount of storage for each storage type are the
1129
- # following:
1101
+ # * General Purpose (SSD) storage (gp2, gp3): Must be an integer from
1102
+ # 20 to 65536.
1130
1103
  #
1131
- # * General Purpose (SSD) storage (gp2, gp3): Must be an integer from 20
1132
- # to 65536.
1104
+ # * Provisioned IOPS storage (io1): Must be an integer from 100 to
1105
+ # 65536.
1133
1106
  #
1134
- # * Provisioned IOPS storage (io1): Must be an integer from 100 to
1135
- # 65536.
1107
+ # * Magnetic storage (standard): Must be an integer from 5 to 3072.
1136
1108
  #
1137
- # * Magnetic storage (standard): Must be an integer from 5 to 3072.
1109
+ # : Constraints to the amount of storage for each storage type are the
1110
+ # following:
1138
1111
  #
1139
- # **MariaDB**
1112
+ # * General Purpose (SSD) storage (gp2, gp3): Must be an integer from
1113
+ # 20 to 65536.
1140
1114
  #
1141
- # Constraints to the amount of storage for each storage type are the
1142
- # following:
1115
+ # * Provisioned IOPS storage (io1): Must be an integer from 100 to
1116
+ # 65536.
1143
1117
  #
1144
- # * General Purpose (SSD) storage (gp2, gp3): Must be an integer from 20
1145
- # to 65536.
1118
+ # * Magnetic storage (standard): Must be an integer from 5 to 3072.
1146
1119
  #
1147
- # * Provisioned IOPS storage (io1): Must be an integer from 100 to
1148
- # 65536.
1120
+ # : Constraints to the amount of storage for each storage type are the
1121
+ # following:
1149
1122
  #
1150
- # * Magnetic storage (standard): Must be an integer from 5 to 3072.
1123
+ # * General Purpose (SSD) storage (gp2, gp3): Must be an integer from
1124
+ # 20 to 65536.
1151
1125
  #
1152
- # **PostgreSQL**
1126
+ # * Provisioned IOPS storage (io1): Must be an integer from 100 to
1127
+ # 65536.
1153
1128
  #
1154
- # Constraints to the amount of storage for each storage type are the
1155
- # following:
1129
+ # * Magnetic storage (standard): Must be an integer from 10 to 3072.
1156
1130
  #
1157
- # * General Purpose (SSD) storage (gp2, gp3): Must be an integer from 20
1158
- # to 65536.
1131
+ # : Constraints to the amount of storage for each storage type are the
1132
+ # following:
1159
1133
  #
1160
- # * Provisioned IOPS storage (io1): Must be an integer from 100 to
1161
- # 65536.
1134
+ # * General Purpose (SSD) storage (gp2, gp3): Must be an integer from
1135
+ # 20 to 65536.
1162
1136
  #
1163
- # * Magnetic storage (standard): Must be an integer from 5 to 3072.
1137
+ # * Provisioned IOPS storage (io1): Must be an integer from 100 to
1138
+ # 65536.
1164
1139
  #
1165
- # **Oracle**
1140
+ # * Magnetic storage (standard): Must be an integer from 5 to 3072.
1166
1141
  #
1167
- # Constraints to the amount of storage for each storage type are the
1168
- # following:
1142
+ # : Constraints to the amount of storage for each storage type are the
1143
+ # following:
1169
1144
  #
1170
- # * General Purpose (SSD) storage (gp2, gp3): Must be an integer from 20
1171
- # to 65536.
1145
+ # * General Purpose (SSD) storage (gp2, gp3):
1172
1146
  #
1173
- # * Provisioned IOPS storage (io1): Must be an integer from 100 to
1174
- # 65536.
1147
+ # * Enterprise and Standard editions: Must be an integer from 20 to
1148
+ # 16384.
1175
1149
  #
1176
- # * Magnetic storage (standard): Must be an integer from 10 to 3072.
1150
+ # * Web and Express editions: Must be an integer from 20 to 16384.
1177
1151
  #
1178
- # **SQL Server**
1179
- #
1180
- # Constraints to the amount of storage for each storage type are the
1181
- # following:
1182
- #
1183
- # * General Purpose (SSD) storage (gp2, gp3):
1184
- #
1185
- # * Enterprise and Standard editions: Must be an integer from 20 to
1186
- # 16384.
1187
- #
1188
- # * Web and Express editions: Must be an integer from 20 to 16384.
1189
- #
1190
- # * Provisioned IOPS storage (io1):
1152
+ # * Provisioned IOPS storage (io1):
1191
1153
  #
1192
- # * Enterprise and Standard editions: Must be an integer from 100 to
1193
- # 16384.
1154
+ # * Enterprise and Standard editions: Must be an integer from 100 to
1155
+ # 16384.
1194
1156
  #
1195
- # * Web and Express editions: Must be an integer from 100 to 16384.
1157
+ # * Web and Express editions: Must be an integer from 100 to 16384.
1196
1158
  #
1197
- # * Magnetic storage (standard):
1159
+ # * Magnetic storage (standard):
1198
1160
  #
1199
- # * Enterprise and Standard editions: Must be an integer from 20 to
1200
- # 1024.
1161
+ # * Enterprise and Standard editions: Must be an integer from 20 to
1162
+ # 1024.
1201
1163
  #
1202
- # * Web and Express editions: Must be an integer from 20 to 1024.
1164
+ # * Web and Express editions: Must be an integer from 20 to 1024.
1203
1165
  # @option options [required, String] :db_instance_class
1204
1166
  # The compute and memory capacity of the DB instance, for example
1205
- # db.m5.large. Not all DB instance classes are available in all Amazon
1167
+ # `db.m5.large`. Not all DB instance classes are available in all Amazon
1206
1168
  # Web Services Regions, or for all database engines. For the full list
1207
1169
  # of DB instance classes, and availability for your engine, see [DB
1208
1170
  # instance classes][1] in the *Amazon RDS User Guide* or [Aurora DB
@@ -1213,9 +1175,9 @@ module Aws::RDS
1213
1175
  # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html
1214
1176
  # [2]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Concepts.DBInstanceClass.html
1215
1177
  # @option options [required, String] :engine
1216
- # The name of the database engine to be used for this instance.
1178
+ # The database engine to use for this DB instance.
1217
1179
  #
1218
- # Not every database engine is available for every Amazon Web Services
1180
+ # Not every database engine is available in every Amazon Web Services
1219
1181
  # Region.
1220
1182
  #
1221
1183
  # Valid Values:
@@ -1224,15 +1186,15 @@ module Aws::RDS
1224
1186
  #
1225
1187
  # * `aurora-postgresql` (for Aurora PostgreSQL DB instances)
1226
1188
  #
1227
- # * `custom-oracle-ee (for RDS Custom for Oracle DB instances)`
1189
+ # * `custom-oracle-ee` (for RDS Custom for Oracle DB instances)
1228
1190
  #
1229
- # * `custom-oracle-ee-cdb (for RDS Custom for Oracle DB instances)`
1191
+ # * `custom-oracle-ee-cdb` (for RDS Custom for Oracle DB instances)
1230
1192
  #
1231
- # * `custom-sqlserver-ee (for RDS Custom for SQL Server DB instances)`
1193
+ # * `custom-sqlserver-ee` (for RDS Custom for SQL Server DB instances)
1232
1194
  #
1233
- # * `custom-sqlserver-se (for RDS Custom for SQL Server DB instances)`
1195
+ # * `custom-sqlserver-se` (for RDS Custom for SQL Server DB instances)
1234
1196
  #
1235
- # * `custom-sqlserver-web (for RDS Custom for SQL Server DB instances)`
1197
+ # * `custom-sqlserver-web` (for RDS Custom for SQL Server DB instances)
1236
1198
  #
1237
1199
  # * `mariadb`
1238
1200
  #
@@ -1258,53 +1220,43 @@ module Aws::RDS
1258
1220
  # @option options [String] :master_username
1259
1221
  # The name for the master user.
1260
1222
  #
1261
- # **Amazon Aurora**
1223
+ # This setting doesn't apply to Amazon Aurora DB instances. The name
1224
+ # for the master user is managed by the DB cluster.
1262
1225
  #
1263
- # Not applicable. The name for the master user is managed by the DB
1264
- # cluster.
1265
- #
1266
- # **Amazon RDS**
1226
+ # This setting is required for RDS DB instances.
1267
1227
  #
1268
1228
  # Constraints:
1269
1229
  #
1270
- # * Required.
1271
- #
1272
1230
  # * Must be 1 to 16 letters, numbers, or underscores.
1273
1231
  #
1274
1232
  # * First character must be a letter.
1275
1233
  #
1276
1234
  # * Can't be a reserved word for the chosen database engine.
1277
1235
  # @option options [String] :master_user_password
1278
- # The password for the master user. The password can include any
1279
- # printable ASCII character except "/", """, or "@".
1280
- #
1281
- # **Amazon Aurora**
1282
- #
1283
- # Not applicable. The password for the master user is managed by the DB
1284
- # cluster.
1236
+ # The password for the master user.
1285
1237
  #
1286
- # Constraints: Can't be specified if `ManageMasterUserPassword` is
1287
- # turned on.
1238
+ # This setting doesn't apply to Amazon Aurora DB instances. The
1239
+ # password for the master user is managed by the DB cluster.
1288
1240
  #
1289
- # **MariaDB**
1290
- #
1291
- # Constraints: Must contain from 8 to 41 characters.
1241
+ # Constraints:
1292
1242
  #
1293
- # **Microsoft SQL Server**
1243
+ # * Can't be specified if `ManageMasterUserPassword` is turned on.
1294
1244
  #
1295
- # Constraints: Must contain from 8 to 128 characters.
1245
+ # * Can include any printable ASCII character except "/", """, or
1246
+ # "@".
1296
1247
  #
1297
- # **MySQL**
1248
+ # Length Constraints:
1298
1249
  #
1299
- # Constraints: Must contain from 8 to 41 characters.
1250
+ # * RDS for MariaDB - Must contain from 8 to 41 characters.
1300
1251
  #
1301
- # **Oracle**
1252
+ # * RDS for Microsoft SQL Server - Must contain from 8 to 128
1253
+ # characters.
1302
1254
  #
1303
- # Constraints: Must contain from 8 to 30 characters.
1255
+ # * RDS for MySQL - Must contain from 8 to 41 characters.
1304
1256
  #
1305
- # **PostgreSQL**
1257
+ # * RDS for Oracle - Must contain from 8 to 30 characters.
1306
1258
  #
1307
- # Constraints: Must contain from 8 to 128 characters.
1259
+ # * RDS for PostgreSQL - Must contain from 8 to 128 characters.
1308
1260
  # @option options [Array<String>] :db_security_groups
1309
1261
  # A list of DB security groups to associate with this DB instance.
1310
1262
  #
@@ -1315,10 +1267,9 @@ module Aws::RDS
1315
1267
  # A list of Amazon EC2 VPC security groups to associate with this DB
1316
1268
  # instance.
1317
1269
  #
1318
- # **Amazon Aurora**
1319
- #
1320
- # Not applicable. The associated list of EC2 VPC security groups is
1321
- # managed by the DB cluster.
1270
+ # This setting doesn't apply to Amazon Aurora DB instances. The
1271
+ # associated list of EC2 VPC security groups is managed by the DB
1272
+ # cluster.
1322
1273
  #
1323
1274
  # Default: The default EC2 VPC security group for the DB subnet group's
1324
1275
  # VPC.
@@ -1327,22 +1278,23 @@ module Aws::RDS
1327
1278
  # information on Amazon Web Services Regions and Availability Zones, see
1328
1279
  # [Regions and Availability Zones][1].
1329
1280
  #
1330
- # **Amazon Aurora**
1331
- #
1332
- # Each Aurora DB cluster hosts copies of its storage in three separate
1333
- # Availability Zones. Specify one of these Availability Zones. Aurora
1334
- # automatically chooses an appropriate Availability Zone if you don't
1335
- # specify one.
1281
+ # For Amazon Aurora, each Aurora DB cluster hosts copies of its storage
1282
+ # in three separate Availability Zones. Specify one of these
1283
+ # Availability Zones. Aurora automatically chooses an appropriate
1284
+ # Availability Zone if you don't specify one.
1336
1285
  #
1337
1286
  # Default: A random, system-chosen Availability Zone in the endpoint's
1338
1287
  # Amazon Web Services Region.
1339
1288
  #
1340
- # Example: `us-east-1d`
1289
+ # Constraints:
1290
+ #
1291
+ # * The `AvailabilityZone` parameter can't be specified if the DB
1292
+ # instance is a Multi-AZ deployment.
1341
1293
  #
1342
- # Constraint: The `AvailabilityZone` parameter can't be specified if
1343
- # the DB instance is a Multi-AZ deployment. The specified Availability
1344
- # Zone must be in the same Amazon Web Services Region as the current
1345
- # endpoint.
1294
+ # * The specified Availability Zone must be in the same Amazon Web
1295
+ # Services Region as the current endpoint.
1296
+ #
1297
+ # Example: `us-east-1d`
1346
1298
  #
1347
1299
  #
1348
1300
  #
@@ -1350,61 +1302,68 @@ module Aws::RDS
1350
1302
  # @option options [String] :db_subnet_group_name
1351
1303
  # A DB subnet group to associate with this DB instance.
1352
1304
  #
1353
- # Constraints: Must match the name of an existing DBSubnetGroup. Must
1354
- # not be default.
1305
+ # Constraints:
1306
+ #
1307
+ # * Must match the name of an existing DB subnet group.
1308
+ #
1309
+ # * Must not be `default`.
1355
1310
  #
1356
1311
  # Example: `mydbsubnetgroup`
1357
1312
  # @option options [String] :preferred_maintenance_window
1358
- # The time range each week during which system maintenance can occur, in
1359
- # Universal Coordinated Time (UTC). For more information, see [Amazon
1360
- # RDS Maintenance Window][1].
1361
- #
1362
- # Format: `ddd:hh24:mi-ddd:hh24:mi`
1313
+ # The time range each week during which system maintenance can occur.
1314
+ # For more information, see [Amazon RDS Maintenance Window][1] in the
1315
+ # *Amazon RDS User Guide.*
1363
1316
  #
1364
1317
  # The default is a 30-minute window selected at random from an 8-hour
1365
1318
  # block of time for each Amazon Web Services Region, occurring on a
1366
1319
  # random day of the week.
1367
1320
  #
1368
- # Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.
1321
+ # Constraints:
1322
+ #
1323
+ # * Must be in the format `ddd:hh24:mi-ddd:hh24:mi`.
1324
+ #
1325
+ # * The day values must be `mon | tue | wed | thu | fri | sat | sun`.
1326
+ #
1327
+ # * Must be in Universal Coordinated Time (UTC).
1328
+ #
1329
+ # * Must not conflict with the preferred backup window.
1369
1330
  #
1370
- # Constraints: Minimum 30-minute window.
1331
+ # * Must be at least 30 minutes.
1371
1332
  #
1372
1333
  #
1373
1334
  #
1374
1335
  # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_UpgradeDBInstance.Maintenance.html#Concepts.DBMaintenance
1375
1336
  # @option options [String] :db_parameter_group_name
1376
1337
  # The name of the DB parameter group to associate with this DB instance.
1377
- # If you do not specify a value, then the default DB parameter group for
1378
- # the specified DB engine and version is used.
1338
+ # If you don't specify a value, then Amazon RDS uses the default DB
1339
+ # parameter group for the specified DB engine and version.
1379
1340
  #
1380
- # This setting doesn't apply to RDS Custom.
1341
+ # This setting doesn't apply to RDS Custom DB instances.
1381
1342
  #
1382
1343
  # Constraints:
1383
1344
  #
1384
- # * It must be 1 to 255 letters, numbers, or hyphens.
1345
+ # * Must be 1 to 255 letters, numbers, or hyphens.
1385
1346
  #
1386
1347
  # * The first character must be a letter.
1387
1348
  #
1388
- # * It can't end with a hyphen or contain two consecutive hyphens.
1349
+ # * Can't end with a hyphen or contain two consecutive hyphens.
1389
1350
  # @option options [Integer] :backup_retention_period
1390
1351
  # The number of days for which automated backups are retained. Setting
1391
1352
  # this parameter to a positive number enables backups. Setting this
1392
- # parameter to 0 disables automated backups.
1393
- #
1394
- # **Amazon Aurora**
1353
+ # parameter to `0` disables automated backups.
1395
1354
  #
1396
- # Not applicable. The retention period for automated backups is managed
1397
- # by the DB cluster.
1355
+ # This setting doesn't apply to Amazon Aurora DB instances. The
1356
+ # retention period for automated backups is managed by the DB cluster.
1398
1357
  #
1399
- # Default: 1
1358
+ # Default: `1`
1400
1359
  #
1401
1360
  # Constraints:
1402
1361
  #
1403
- # * Must be a value from 0 to 35
1362
+ # * Must be a value from 0 to 35.
1404
1363
  #
1405
- # * Can't be set to 0 if the DB instance is a source to read replicas
1364
+ # * Can't be set to 0 if the DB instance is a source to read replicas.
1406
1365
  #
1407
- # * Can't be set to 0 for an RDS Custom for Oracle DB instance
1366
+ # * Can't be set to 0 for an RDS Custom for Oracle DB instance.
1408
1367
  # @option options [String] :preferred_backup_window
1409
1368
  # The daily time range during which automated backups are created if
1410
1369
  # automated backups are enabled, using the `BackupRetentionPeriod`
@@ -1412,10 +1371,9 @@ module Aws::RDS
1412
1371
  # an 8-hour block of time for each Amazon Web Services Region. For more
1413
1372
  # information, see [Backup window][1] in the *Amazon RDS User Guide*.
1414
1373
  #
1415
- # **Amazon Aurora**
1416
- #
1417
- # Not applicable. The daily time range for creating automated backups is
1418
- # managed by the DB cluster.
1374
+ # This setting doesn't apply to Amazon Aurora DB instances. The daily
1375
+ # time range for creating automated backups is managed by the DB
1376
+ # cluster.
1419
1377
  #
1420
1378
  # Constraints:
1421
1379
  #
@@ -1433,64 +1391,47 @@ module Aws::RDS
1433
1391
  # @option options [Integer] :port
1434
1392
  # The port number on which the database accepts connections.
1435
1393
  #
1436
- # **MySQL**
1437
- #
1438
- # Default: `3306`
1394
+ # This setting doesn't apply to Aurora DB instances. The port number is
1395
+ # managed by the cluster.
1439
1396
  #
1440
- # Valid values: `1150-65535`
1441
- #
1442
- # Type: Integer
1443
- #
1444
- # **MariaDB**
1445
- #
1446
- # Default: `3306`
1447
- #
1448
- # Valid values: `1150-65535`
1449
- #
1450
- # Type: Integer
1451
- #
1452
- # **PostgreSQL**
1453
- #
1454
- # Default: `5432`
1455
- #
1456
- # Valid values: `1150-65535`
1457
- #
1458
- # Type: Integer
1459
- #
1460
- # **Oracle**
1397
+ # Valid Values: `1150-65535`
1461
1398
  #
1462
- # Default: `1521`
1399
+ # Default:
1463
1400
  #
1464
- # Valid values: `1150-65535`
1401
+ # * RDS for MariaDB - `3306`
1465
1402
  #
1466
- # **SQL Server**
1403
+ # * RDS for Microsoft SQL Server - `1433`
1467
1404
  #
1468
- # Default: `1433`
1405
+ # * RDS for MySQL - `3306`
1469
1406
  #
1470
- # Valid values: `1150-65535` except `1234`, `1434`, `3260`, `3343`,
1471
- # `3389`, `47001`, and `49152-49156`.
1407
+ # * RDS for Oracle - `1521`
1472
1408
  #
1473
- # **Amazon Aurora**
1409
+ # * RDS for PostgreSQL - `5432`
1474
1410
  #
1475
- # Default: `3306`
1411
+ # Constraints:
1476
1412
  #
1477
- # Valid values: `1150-65535`
1413
+ # * For RDS for Microsoft SQL Server, the value can't be `1234`,
1414
+ # `1434`, `3260`, `3343`, `3389`, `47001`, or `49152-49156`.
1478
1415
  #
1479
- # Type: Integer
1416
+ # ^
1480
1417
  # @option options [Boolean] :multi_az
1481
- # A value that indicates whether the DB instance is a Multi-AZ
1482
- # deployment. You can't set the `AvailabilityZone` parameter if the DB
1483
- # instance is a Multi-AZ deployment.
1418
+ # Specifies whether the DB instance is a Multi-AZ deployment. You can't
1419
+ # set the `AvailabilityZone` parameter if the DB instance is a Multi-AZ
1420
+ # deployment.
1484
1421
  #
1485
- # This setting doesn't apply to RDS Custom.
1422
+ # This setting doesn't apply to the following DB instances:
1486
1423
  #
1487
- # **Amazon Aurora**
1424
+ # * Amazon Aurora (DB instance Availability Zones (AZs) are managed by
1425
+ # the DB cluster.)
1488
1426
  #
1489
- # Not applicable. DB instance Availability Zones (AZs) are managed by
1490
- # the DB cluster.
1427
+ # * RDS Custom
1491
1428
  # @option options [String] :engine_version
1492
1429
  # The version number of the database engine to use.
1493
1430
  #
1431
+ # This setting doesn't apply to Amazon Aurora DB instances. The version
1432
+ # number of the database engine the DB instance uses is managed by the
1433
+ # DB cluster.
1434
+ #
1494
1435
  # For a list of valid engine versions, use the
1495
1436
  # `DescribeDBEngineVersions` operation.
1496
1437
  #
@@ -1499,48 +1440,37 @@ module Aws::RDS
1499
1440
  # every database engine is available for every Amazon Web Services
1500
1441
  # Region.
1501
1442
  #
1502
- # **Amazon Aurora**
1503
- #
1504
- # Not applicable. The version number of the database engine to be used
1505
- # by the DB instance is managed by the DB cluster.
1506
- #
1507
- # **Amazon RDS Custom for Oracle**
1508
- #
1509
- # A custom engine version (CEV) that you have previously created. This
1510
- # setting is required for RDS Custom for Oracle. The CEV name has the
1511
- # following format: 19.*customized\_string*. A valid CEV name is
1512
- # `19.my_cev1`. For more information, see [ Creating an RDS Custom for
1513
- # Oracle DB instance][1] in the *Amazon RDS User Guide*.
1514
- #
1515
- # **Amazon RDS Custom for SQL Server**
1516
- #
1517
- # See [RDS Custom for SQL Server general requirements][2] in the *Amazon
1518
- # RDS User Guide*.
1519
- #
1520
- # **MariaDB**
1521
- #
1522
- # For information, see [MariaDB on Amazon RDS Versions][3] in the
1523
- # *Amazon RDS User Guide*.
1524
- #
1525
- # **Microsoft SQL Server**
1443
+ # Amazon RDS Custom for Oracle
1444
+ # Amazon RDS Custom for SQL Server
1445
+ # RDS for MariaDB
1446
+ # RDS for Microsoft SQL Server
1447
+ # RDS for MySQL
1448
+ # RDS for Oracle
1449
+ # RDS for PostgreSQL
1526
1450
  #
1527
- # For information, see [Microsoft SQL Server Versions on Amazon RDS][4]
1528
- # in the *Amazon RDS User Guide*.
1451
+ # : A custom engine version (CEV) that you have previously created. This
1452
+ # setting is required for RDS Custom for Oracle. The CEV name has the
1453
+ # following format: 19.*customized\_string*. A valid CEV name is
1454
+ # `19.my_cev1`. For more information, see [ Creating an RDS Custom for
1455
+ # Oracle DB instance][1] in the *Amazon RDS User Guide*.
1529
1456
  #
1530
- # **MySQL**
1457
+ # : See [RDS Custom for SQL Server general requirements][2] in the
1458
+ # *Amazon RDS User Guide*.
1531
1459
  #
1532
- # For information, see [MySQL on Amazon RDS Versions][5] in the *Amazon
1533
- # RDS User Guide*.
1460
+ # : For information, see [MariaDB on Amazon RDS versions][3] in the
1461
+ # *Amazon RDS User Guide*.
1534
1462
  #
1535
- # **Oracle**
1463
+ # : For information, see [Microsoft SQL Server versions on Amazon
1464
+ # RDS][4] in the *Amazon RDS User Guide*.
1536
1465
  #
1537
- # For information, see [Oracle Database Engine Release Notes][6] in the
1538
- # *Amazon RDS User Guide*.
1466
+ # : For information, see [MySQL on Amazon RDS versions][5] in the
1467
+ # *Amazon RDS User Guide*.
1539
1468
  #
1540
- # **PostgreSQL**
1469
+ # : For information, see [Oracle Database Engine release notes][6] in
1470
+ # the *Amazon RDS User Guide*.
1541
1471
  #
1542
- # For information, see [Amazon RDS for PostgreSQL versions and
1543
- # extensions][7] in the *Amazon RDS User Guide*.
1472
+ # : For information, see [Amazon RDS for PostgreSQL versions and
1473
+ # extensions][7] in the *Amazon RDS User Guide*.
1544
1474
  #
1545
1475
  #
1546
1476
  #
@@ -1552,72 +1482,77 @@ module Aws::RDS
1552
1482
  # [6]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Appendix.Oracle.PatchComposition.html
1553
1483
  # [7]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_PostgreSQL.html#PostgreSQL.Concepts
1554
1484
  # @option options [Boolean] :auto_minor_version_upgrade
1555
- # A value that indicates whether minor engine upgrades are applied
1556
- # automatically to the DB instance during the maintenance window. By
1557
- # default, minor engine upgrades are applied automatically.
1485
+ # Specifies whether minor engine upgrades are applied automatically to
1486
+ # the DB instance during the maintenance window. By default, minor
1487
+ # engine upgrades are applied automatically.
1558
1488
  #
1559
1489
  # If you create an RDS Custom DB instance, you must set
1560
1490
  # `AutoMinorVersionUpgrade` to `false`.
1561
1491
  # @option options [String] :license_model
1562
- # License model information for this DB instance.
1492
+ # The license model information for this DB instance.
1563
1493
  #
1564
- # Valid values: `license-included` \| `bring-your-own-license` \|
1565
- # `general-public-license`
1494
+ # This setting doesn't apply to Amazon Aurora or RDS Custom DB
1495
+ # instances.
1566
1496
  #
1567
- # This setting doesn't apply to RDS Custom.
1497
+ # Valid Values:
1498
+ #
1499
+ # * RDS for MariaDB - `general-public-license`
1500
+ #
1501
+ # * RDS for Microsoft SQL Server - `license-included`
1502
+ #
1503
+ # * RDS for MySQL - `general-public-license`
1568
1504
  #
1569
- # **Amazon Aurora**
1505
+ # * RDS for Oracle - `bring-your-own-license | license-included`
1570
1506
  #
1571
- # Not applicable.
1507
+ # * RDS for PostgreSQL - `postgresql-license`
1572
1508
  # @option options [Integer] :iops
1573
1509
  # The amount of Provisioned IOPS (input/output operations per second) to
1574
- # be initially allocated for the DB instance. For information about
1575
- # valid IOPS values, see [Amazon RDS DB instance storage][1] in the
1576
- # *Amazon RDS User Guide*.
1510
+ # initially allocate for the DB instance. For information about valid
1511
+ # IOPS values, see [Amazon RDS DB instance storage][1] in the *Amazon
1512
+ # RDS User Guide*.
1513
+ #
1514
+ # This setting doesn't apply to Amazon Aurora DB instances. Storage is
1515
+ # managed by the DB cluster.
1577
1516
  #
1578
- # Constraints: For MariaDB, MySQL, Oracle, and PostgreSQL DB instances,
1579
- # must be a multiple between .5 and 50 of the storage amount for the DB
1580
- # instance. For SQL Server DB instances, must be a multiple between 1
1581
- # and 50 of the storage amount for the DB instance.
1517
+ # Constraints:
1582
1518
  #
1583
- # **Amazon Aurora**
1519
+ # * For RDS for MariaDB, MySQL, Oracle, and PostgreSQL - Must be a
1520
+ # multiple between .5 and 50 of the storage amount for the DB
1521
+ # instance.
1584
1522
  #
1585
- # Not applicable. Storage is managed by the DB cluster.
1523
+ # * For RDS for SQL Server - Must be a multiple between 1 and 50 of the
1524
+ # storage amount for the DB instance.
1586
1525
  #
1587
1526
  #
1588
1527
  #
1589
1528
  # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Storage.html
1590
1529
  # @option options [String] :option_group_name
1591
- # A value that indicates that the DB instance should be associated with
1592
- # the specified option group.
1530
+ # The option group to associate the DB instance with.
1593
1531
  #
1594
1532
  # Permanent options, such as the TDE option for Oracle Advanced Security
1595
1533
  # TDE, can't be removed from an option group. Also, that option group
1596
1534
  # can't be removed from a DB instance after it is associated with a DB
1597
1535
  # instance.
1598
1536
  #
1599
- # This setting doesn't apply to RDS Custom.
1600
- #
1601
- # **Amazon Aurora**
1602
- #
1603
- # Not applicable.
1537
+ # This setting doesn't apply to Amazon Aurora or RDS Custom DB
1538
+ # instances.
1604
1539
  # @option options [String] :character_set_name
1605
- # For supported engines, this value indicates that the DB instance
1606
- # should be associated with the specified `CharacterSet`.
1540
+ # For supported engines, the character set (`CharacterSet`) to associate
1541
+ # the DB instance with.
1607
1542
  #
1608
- # This setting doesn't apply to RDS Custom. However, if you need to
1609
- # change the character set, you can change it on the database itself.
1543
+ # This setting doesn't apply to the following DB instances:
1610
1544
  #
1611
- # **Amazon Aurora**
1545
+ # * Amazon Aurora - The character set is managed by the DB cluster. For
1546
+ # more information, see `CreateDBCluster`.
1612
1547
  #
1613
- # Not applicable. The character set is managed by the DB cluster. For
1614
- # more information, see `CreateDBCluster`.
1548
+ # * RDS Custom - However, if you need to change the character set, you
1549
+ # can change it on the database itself.
1615
1550
  # @option options [String] :nchar_character_set_name
1616
1551
  # The name of the NCHAR character set for the Oracle DB instance.
1617
1552
  #
1618
- # This parameter doesn't apply to RDS Custom.
1553
+ # This setting doesn't apply to RDS Custom DB instances.
1619
1554
  # @option options [Boolean] :publicly_accessible
1620
- # A value that indicates whether the DB instance is publicly accessible.
1555
+ # Specifies whether the DB instance is publicly accessible.
1621
1556
  #
1622
1557
  # When the DB instance is publicly accessible, its Domain Name System
1623
1558
  # (DNS) endpoint resolves to the private IP address from within the DB
@@ -1653,47 +1588,42 @@ module Aws::RDS
1653
1588
  # @option options [Array<Types::Tag>] :tags
1654
1589
  # Tags to assign to the DB instance.
1655
1590
  # @option options [String] :db_cluster_identifier
1656
- # The identifier of the DB cluster that the instance will belong to.
1591
+ # The identifier of the DB cluster that this DB instance will belong to.
1657
1592
  #
1658
- # This setting doesn't apply to RDS Custom.
1593
+ # This setting doesn't apply to RDS Custom DB instances.
1659
1594
  # @option options [String] :storage_type
1660
- # Specifies the storage type to be associated with the DB instance.
1661
- #
1662
- # Valid values: `gp2 | gp3 | io1 | standard`
1595
+ # The storage type to associate with the DB instance.
1663
1596
  #
1664
1597
  # If you specify `io1` or `gp3`, you must also include a value for the
1665
1598
  # `Iops` parameter.
1666
1599
  #
1667
- # Default: `io1` if the `Iops` parameter is specified, otherwise `gp2`
1600
+ # This setting doesn't apply to Amazon Aurora DB instances. Storage is
1601
+ # managed by the DB cluster.
1668
1602
  #
1669
- # **Amazon Aurora**
1603
+ # Valid Values: `gp2 | gp3 | io1 | standard`
1670
1604
  #
1671
- # Not applicable. Storage is managed by the DB cluster.
1605
+ # Default: `io1`, if the `Iops` parameter is specified. Otherwise,
1606
+ # `gp2`.
1672
1607
  # @option options [String] :tde_credential_arn
1673
1608
  # The ARN from the key store with which to associate the instance for
1674
1609
  # TDE encryption.
1675
1610
  #
1676
- # This setting doesn't apply to RDS Custom.
1677
- #
1678
- # **Amazon Aurora**
1679
- #
1680
- # Not applicable.
1611
+ # This setting doesn't apply to Amazon Aurora or RDS Custom DB
1612
+ # instances.
1681
1613
  # @option options [String] :tde_credential_password
1682
1614
  # The password for the given ARN from the key store in order to access
1683
1615
  # the device.
1684
1616
  #
1685
- # This setting doesn't apply to RDS Custom.
1617
+ # This setting doesn't apply to RDS Custom DB instances.
1686
1618
  # @option options [Boolean] :storage_encrypted
1687
- # A value that indicates whether the DB instance is encrypted. By
1688
- # default, it isn't encrypted.
1619
+ # Specifes whether the DB instance is encrypted. By default, it isn't
1620
+ # encrypted.
1689
1621
  #
1690
- # For RDS Custom instances, either set this parameter to `true` or leave
1691
- # it unset. If you set this parameter to `false`, RDS reports an error.
1622
+ # For RDS Custom DB instances, either enable this setting or leave it
1623
+ # unset. Otherwise, Amazon RDS reports an error.
1692
1624
  #
1693
- # **Amazon Aurora**
1694
- #
1695
- # Not applicable. The encryption for DB instances is managed by the DB
1696
- # cluster.
1625
+ # This setting doesn't apply to Amazon Aurora DB instances. The
1626
+ # encryption for DB instances is managed by the DB cluster.
1697
1627
  # @option options [String] :kms_key_id
1698
1628
  # The Amazon Web Services KMS key identifier for an encrypted DB
1699
1629
  # instance.
@@ -1703,10 +1633,9 @@ module Aws::RDS
1703
1633
  # different Amazon Web Services account, specify the key ARN or alias
1704
1634
  # ARN.
1705
1635
  #
1706
- # **Amazon Aurora**
1707
- #
1708
- # Not applicable. The Amazon Web Services KMS key identifier is managed
1709
- # by the DB cluster. For more information, see `CreateDBCluster`.
1636
+ # This setting doesn't apply to Amazon Aurora DB instances. The Amazon
1637
+ # Web Services KMS key identifier is managed by the DB cluster. For more
1638
+ # information, see `CreateDBCluster`.
1710
1639
  #
1711
1640
  # If `StorageEncrypted` is enabled, and you do not specify a value for
1712
1641
  # the `KmsKeyId` parameter, then Amazon RDS uses your default KMS key.
@@ -1714,50 +1643,48 @@ module Aws::RDS
1714
1643
  # Amazon Web Services account has a different default KMS key for each
1715
1644
  # Amazon Web Services Region.
1716
1645
  #
1717
- # **Amazon RDS Custom**
1718
- #
1719
- # A KMS key is required for RDS Custom instances. For most RDS engines,
1720
- # if you leave this parameter empty while enabling `StorageEncrypted`,
1721
- # the engine uses the default KMS key. However, RDS Custom doesn't use
1722
- # the default key when this parameter is empty. You must explicitly
1723
- # specify a key.
1646
+ # For Amazon RDS Custom, a KMS key is required for DB instances. For
1647
+ # most RDS engines, if you leave this parameter empty while enabling
1648
+ # `StorageEncrypted`, the engine uses the default KMS key. However, RDS
1649
+ # Custom doesn't use the default key when this parameter is empty. You
1650
+ # must explicitly specify a key.
1724
1651
  # @option options [String] :domain
1725
1652
  # The Active Directory directory ID to create the DB instance in.
1726
- # Currently, only MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB
1653
+ # Currently, only Microsoft SQL Server, MySQL, Oracle, and PostgreSQL DB
1727
1654
  # instances can be created in an Active Directory Domain.
1728
1655
  #
1729
1656
  # For more information, see [ Kerberos Authentication][1] in the *Amazon
1730
1657
  # RDS User Guide*.
1731
1658
  #
1732
- # This setting doesn't apply to RDS Custom.
1659
+ # This setting doesn't apply to the following DB instances:
1733
1660
  #
1734
- # **Amazon Aurora**
1661
+ # * Amazon Aurora (The domain is managed by the DB cluster.)
1735
1662
  #
1736
- # Not applicable. The domain is managed by the DB cluster.
1663
+ # * RDS Custom
1737
1664
  #
1738
1665
  #
1739
1666
  #
1740
1667
  # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/kerberos-authentication.html
1741
1668
  # @option options [Boolean] :copy_tags_to_snapshot
1742
- # A value that indicates whether to copy tags from the DB instance to
1743
- # snapshots of the DB instance. By default, tags are not copied.
1669
+ # Spcifies whether to copy tags from the DB instance to snapshots of the
1670
+ # DB instance. By default, tags are not copied.
1744
1671
  #
1745
- # **Amazon Aurora**
1746
- #
1747
- # Not applicable. Copying tags to snapshots is managed by the DB
1748
- # cluster. Setting this value for an Aurora DB instance has no effect on
1749
- # the DB cluster setting.
1672
+ # This setting doesn't apply to Amazon Aurora DB instances. Copying
1673
+ # tags to snapshots is managed by the DB cluster. Setting this value for
1674
+ # an Aurora DB instance has no effect on the DB cluster setting.
1750
1675
  # @option options [Integer] :monitoring_interval
1751
1676
  # The interval, in seconds, between points when Enhanced Monitoring
1752
1677
  # metrics are collected for the DB instance. To disable collection of
1753
- # Enhanced Monitoring metrics, specify 0. The default is 0.
1678
+ # Enhanced Monitoring metrics, specify `0`.
1754
1679
  #
1755
1680
  # If `MonitoringRoleArn` is specified, then you must set
1756
- # `MonitoringInterval` to a value other than 0.
1681
+ # `MonitoringInterval` to a value other than `0`.
1757
1682
  #
1758
- # This setting doesn't apply to RDS Custom.
1683
+ # This setting doesn't apply to RDS Custom DB instances.
1759
1684
  #
1760
- # Valid Values: `0, 1, 5, 10, 15, 30, 60`
1685
+ # Valid Values: `0 | 1 | 5 | 10 | 15 | 30 | 60`
1686
+ #
1687
+ # Default: `0`
1761
1688
  # @option options [String] :monitoring_role_arn
1762
1689
  # The ARN for the IAM role that permits RDS to send enhanced monitoring
1763
1690
  # metrics to Amazon CloudWatch Logs. For example,
@@ -1765,38 +1692,38 @@ module Aws::RDS
1765
1692
  # a monitoring role, see [Setting Up and Enabling Enhanced
1766
1693
  # Monitoring][1] in the *Amazon RDS User Guide*.
1767
1694
  #
1768
- # If `MonitoringInterval` is set to a value other than 0, then you must
1769
- # supply a `MonitoringRoleArn` value.
1695
+ # If `MonitoringInterval` is set to a value other than `0`, then you
1696
+ # must supply a `MonitoringRoleArn` value.
1770
1697
  #
1771
- # This setting doesn't apply to RDS Custom.
1698
+ # This setting doesn't apply to RDS Custom DB instances.
1772
1699
  #
1773
1700
  #
1774
1701
  #
1775
1702
  # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Monitoring.OS.html#USER_Monitoring.OS.Enabling
1776
1703
  # @option options [String] :domain_iam_role_name
1777
- # Specify the name of the IAM role to be used when making API calls to
1778
- # the Directory Service.
1704
+ # The name of the IAM role to use when making API calls to the Directory
1705
+ # Service.
1779
1706
  #
1780
- # This setting doesn't apply to RDS Custom.
1707
+ # This setting doesn't apply to the following DB instances:
1781
1708
  #
1782
- # **Amazon Aurora**
1709
+ # * Amazon Aurora (The domain is managed by the DB cluster.)
1783
1710
  #
1784
- # Not applicable. The domain is managed by the DB cluster.
1711
+ # * RDS Custom
1785
1712
  # @option options [Integer] :promotion_tier
1786
- # A value that specifies the order in which an Aurora Replica is
1787
- # promoted to the primary instance after a failure of the existing
1788
- # primary instance. For more information, see [ Fault Tolerance for an
1789
- # Aurora DB Cluster][1] in the *Amazon Aurora User Guide*.
1713
+ # The order of priority in which an Aurora Replica is promoted to the
1714
+ # primary instance after a failure of the existing primary instance. For
1715
+ # more information, see [ Fault Tolerance for an Aurora DB Cluster][1]
1716
+ # in the *Amazon Aurora User Guide*.
1790
1717
  #
1791
- # This setting doesn't apply to RDS Custom.
1718
+ # This setting doesn't apply to RDS Custom DB instances.
1792
1719
  #
1793
- # Default: 1
1720
+ # Default: `1`
1794
1721
  #
1795
- # Valid Values: 0 - 15
1722
+ # Valid Values: `0 - 15`
1796
1723
  #
1797
1724
  #
1798
1725
  #
1799
- # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Managing.Backups.html#Aurora.Managing.FaultTolerance
1726
+ # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Concepts.AuroraHighAvailability.html#Aurora.Managing.FaultTolerance
1800
1727
  # @option options [String] :timezone
1801
1728
  # The time zone of the DB instance. The time zone parameter is currently
1802
1729
  # supported only by [Microsoft SQL Server][1].
@@ -1805,29 +1732,29 @@ module Aws::RDS
1805
1732
  #
1806
1733
  # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_SQLServer.html#SQLServer.Concepts.General.TimeZone
1807
1734
  # @option options [Boolean] :enable_iam_database_authentication
1808
- # A value that indicates whether to enable mapping of Amazon Web
1809
- # Services Identity and Access Management (IAM) accounts to database
1810
- # accounts. By default, mapping isn't enabled.
1735
+ # Specifies whether to enable mapping of Amazon Web Services Identity
1736
+ # and Access Management (IAM) accounts to database accounts. By default,
1737
+ # mapping isn't enabled.
1811
1738
  #
1812
1739
  # For more information, see [ IAM Database Authentication for MySQL and
1813
1740
  # PostgreSQL][1] in the *Amazon RDS User Guide*.
1814
1741
  #
1815
- # This setting doesn't apply to RDS Custom.
1742
+ # This setting doesn't apply to the following DB instances:
1816
1743
  #
1817
- # **Amazon Aurora**
1744
+ # * Amazon Aurora (Mapping Amazon Web Services IAM accounts to database
1745
+ # accounts is managed by the DB cluster.)
1818
1746
  #
1819
- # Not applicable. Mapping Amazon Web Services IAM accounts to database
1820
- # accounts is managed by the DB cluster.
1747
+ # * RDS Custom
1821
1748
  #
1822
1749
  #
1823
1750
  #
1824
1751
  # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.IAMDBAuth.html
1825
1752
  # @option options [Boolean] :enable_performance_insights
1826
- # A value that indicates whether to enable Performance Insights for the
1827
- # DB instance. For more information, see [Using Amazon Performance
1828
- # Insights][1] in the *Amazon RDS User Guide*.
1753
+ # Specifies whether to enable Performance Insights for the DB instance.
1754
+ # For more information, see [Using Amazon Performance Insights][1] in
1755
+ # the *Amazon RDS User Guide*.
1829
1756
  #
1830
- # This setting doesn't apply to RDS Custom.
1757
+ # This setting doesn't apply to RDS Custom DB instances.
1831
1758
  #
1832
1759
  #
1833
1760
  #
@@ -1839,70 +1766,54 @@ module Aws::RDS
1839
1766
  # The Amazon Web Services KMS key identifier is the key ARN, key ID,
1840
1767
  # alias ARN, or alias name for the KMS key.
1841
1768
  #
1842
- # If you do not specify a value for `PerformanceInsightsKMSKeyId`, then
1769
+ # If you don't specify a value for `PerformanceInsightsKMSKeyId`, then
1843
1770
  # Amazon RDS uses your default KMS key. There is a default KMS key for
1844
1771
  # your Amazon Web Services account. Your Amazon Web Services account has
1845
1772
  # a different default KMS key for each Amazon Web Services Region.
1846
1773
  #
1847
- # This setting doesn't apply to RDS Custom.
1774
+ # This setting doesn't apply to RDS Custom DB instances.
1848
1775
  # @option options [Integer] :performance_insights_retention_period
1849
- # The number of days to retain Performance Insights data. The default is
1850
- # 7 days. The following values are valid:
1851
- #
1852
- # * 7
1776
+ # The number of days to retain Performance Insights data.
1853
1777
  #
1854
- # * *month* * 31, where *month* is a number of months from 1-23
1855
- #
1856
- # * 731
1778
+ # This setting doesn't apply to RDS Custom DB instances.
1857
1779
  #
1858
- # For example, the following values are valid:
1859
- #
1860
- # * 93 (3 months * 31)
1780
+ # Valid Values:
1861
1781
  #
1862
- # * 341 (11 months * 31)
1782
+ # * `7`
1863
1783
  #
1864
- # * 589 (19 months * 31)
1784
+ # * *month* * 31, where *month* is a number of months from 1-23.
1785
+ # Examples: `93` (3 months * 31), `341` (11 months * 31), `589` (19
1786
+ # months * 31)
1865
1787
  #
1866
- # * 731
1788
+ # * `731`
1867
1789
  #
1868
- # If you specify a retention period such as 94, which isn't a valid
1869
- # value, RDS issues an error.
1790
+ # Default: `7` days
1870
1791
  #
1871
- # This setting doesn't apply to RDS Custom.
1792
+ # If you specify a retention period that isn't valid, such as `94`,
1793
+ # Amazon RDS returns an error.
1872
1794
  # @option options [Array<String>] :enable_cloudwatch_logs_exports
1873
1795
  # The list of log types that need to be enabled for exporting to
1874
- # CloudWatch Logs. The values in the list depend on the DB engine. For
1875
- # more information, see [ Publishing Database Logs to Amazon CloudWatch
1876
- # Logs][1] in the *Amazon RDS User Guide*.
1877
- #
1878
- # **Amazon Aurora**
1879
- #
1880
- # Not applicable. CloudWatch Logs exports are managed by the DB cluster.
1881
- #
1882
- # **RDS Custom**
1883
- #
1884
- # Not applicable.
1885
- #
1886
- # **MariaDB**
1796
+ # CloudWatch Logs. For more information, see [ Publishing Database Logs
1797
+ # to Amazon CloudWatch Logs][1] in the *Amazon RDS User Guide*.
1887
1798
  #
1888
- # Possible values are `audit`, `error`, `general`, and `slowquery`.
1799
+ # This setting doesn't apply to the following DB instances:
1889
1800
  #
1890
- # **Microsoft SQL Server**
1801
+ # * Amazon Aurora (CloudWatch Logs exports are managed by the DB
1802
+ # cluster.)
1891
1803
  #
1892
- # Possible values are `agent` and `error`.
1804
+ # * RDS Custom
1893
1805
  #
1894
- # **MySQL**
1806
+ # The following values are valid for each DB engine:
1895
1807
  #
1896
- # Possible values are `audit`, `error`, `general`, and `slowquery`.
1808
+ # * RDS for MariaDB - `audit | error | general | slowquery`
1897
1809
  #
1898
- # **Oracle**
1810
+ # * RDS for Microsoft SQL Server - `agent | error`
1899
1811
  #
1900
- # Possible values are `alert`, `audit`, `listener`, `trace`, and
1901
- # `oemagent`.
1812
+ # * RDS for MySQL - `audit | error | general | slowquery`
1902
1813
  #
1903
- # **PostgreSQL**
1814
+ # * RDS for Oracle - `alert | audit | listener | trace | oemagent`
1904
1815
  #
1905
- # Possible values are `postgresql` and `upgrade`.
1816
+ # * RDS for PostgreSQL - `postgresql | upgrade`
1906
1817
  #
1907
1818
  #
1908
1819
  #
@@ -1911,23 +1822,19 @@ module Aws::RDS
1911
1822
  # The number of CPU cores and the number of threads per core for the DB
1912
1823
  # instance class of the DB instance.
1913
1824
  #
1914
- # This setting doesn't apply to RDS Custom.
1915
- #
1916
- # **Amazon Aurora**
1917
- #
1918
- # Not applicable.
1825
+ # This setting doesn't apply to Amazon Aurora or RDS Custom DB
1826
+ # instances.
1919
1827
  # @option options [Boolean] :deletion_protection
1920
- # A value that indicates whether the DB instance has deletion protection
1921
- # enabled. The database can't be deleted when deletion protection is
1922
- # enabled. By default, deletion protection isn't enabled. For more
1923
- # information, see [ Deleting a DB Instance][1].
1924
- #
1925
- # **Amazon Aurora**
1926
- #
1927
- # Not applicable. You can enable or disable deletion protection for the
1928
- # DB cluster. For more information, see `CreateDBCluster`. DB instances
1929
- # in a DB cluster can be deleted even when deletion protection is
1930
- # enabled for the DB cluster.
1828
+ # Specifies whether the DB instance has deletion protection enabled. The
1829
+ # database can't be deleted when deletion protection is enabled. By
1830
+ # default, deletion protection isn't enabled. For more information, see
1831
+ # [ Deleting a DB Instance][1].
1832
+ #
1833
+ # This setting doesn't apply to Amazon Aurora DB instances. You can
1834
+ # enable or disable deletion protection for the DB cluster. For more
1835
+ # information, see `CreateDBCluster`. DB instances in a DB cluster can
1836
+ # be deleted even when deletion protection is enabled for the DB
1837
+ # cluster.
1931
1838
  #
1932
1839
  #
1933
1840
  #
@@ -1940,18 +1847,18 @@ module Aws::RDS
1940
1847
  # apply to it, see [ Managing capacity automatically with Amazon RDS
1941
1848
  # storage autoscaling][1] in the *Amazon RDS User Guide*.
1942
1849
  #
1943
- # This setting doesn't apply to RDS Custom.
1850
+ # This setting doesn't apply to the following DB instances:
1944
1851
  #
1945
- # **Amazon Aurora**
1852
+ # * Amazon Aurora (Storage is managed by the DB cluster.)
1946
1853
  #
1947
- # Not applicable. Storage is managed by the DB cluster.
1854
+ # * RDS Custom
1948
1855
  #
1949
1856
  #
1950
1857
  #
1951
1858
  # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PIOPS.StorageTypes.html#USER_PIOPS.Autoscaling
1952
1859
  # @option options [Boolean] :enable_customer_owned_ip
1953
- # A value that indicates whether to enable a customer-owned IP address
1954
- # (CoIP) for an RDS on Outposts DB instance.
1860
+ # Specifies whether to enable a customer-owned IP address (CoIP) for an
1861
+ # RDS on Outposts DB instance.
1955
1862
  #
1956
1863
  # A *CoIP* provides local or external connectivity to resources in your
1957
1864
  # Outpost subnets through your on-premises network. For some use cases,
@@ -1971,8 +1878,11 @@ module Aws::RDS
1971
1878
  # [2]: https://docs.aws.amazon.com/outposts/latest/userguide/routing.html#ip-addressing
1972
1879
  # @option options [String] :custom_iam_instance_profile
1973
1880
  # The instance profile associated with the underlying Amazon EC2
1974
- # instance of an RDS Custom DB instance. The instance profile must meet
1975
- # the following requirements:
1881
+ # instance of an RDS Custom DB instance.
1882
+ #
1883
+ # This setting is required for RDS Custom.
1884
+ #
1885
+ # Constraints:
1976
1886
  #
1977
1887
  # * The profile must exist in your account.
1978
1888
  #
@@ -1985,16 +1895,19 @@ module Aws::RDS
1985
1895
  # For the list of permissions required for the IAM role, see [ Configure
1986
1896
  # IAM and your VPC][1] in the *Amazon RDS User Guide*.
1987
1897
  #
1988
- # This setting is required for RDS Custom.
1989
- #
1990
1898
  #
1991
1899
  #
1992
1900
  # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-setup-orcl.html#custom-setup-orcl.iam-vpc
1993
1901
  # @option options [String] :backup_target
1994
- # Specifies where automated backups and manual snapshots are stored.
1902
+ # The location for storing automated backups and manual snapshots.
1995
1903
  #
1996
- # Possible values are `outposts` (Amazon Web Services Outposts) and
1997
- # `region` (Amazon Web Services Region). The default is `region`.
1904
+ # Valie Values:
1905
+ #
1906
+ # * `outposts` (Amazon Web Services Outposts)
1907
+ #
1908
+ # * `region` (Amazon Web Services Region)
1909
+ #
1910
+ # Default: `region`
1998
1911
  #
1999
1912
  # For more information, see [Working with Amazon RDS on Amazon Web
2000
1913
  # Services Outposts][1] in the *Amazon RDS User Guide*.
@@ -2005,12 +1918,6 @@ module Aws::RDS
2005
1918
  # @option options [String] :network_type
2006
1919
  # The network type of the DB instance.
2007
1920
  #
2008
- # Valid values:
2009
- #
2010
- # * `IPV4`
2011
- #
2012
- # * `DUAL`
2013
- #
2014
1921
  # The network type is determined by the `DBSubnetGroup` specified for
2015
1922
  # the DB instance. A `DBSubnetGroup` can support only the IPv4 protocol
2016
1923
  # or the IPv4 and the IPv6 protocols (`DUAL`).
@@ -2018,18 +1925,21 @@ module Aws::RDS
2018
1925
  # For more information, see [ Working with a DB instance in a VPC][1] in
2019
1926
  # the *Amazon RDS User Guide.*
2020
1927
  #
1928
+ # Valid Values: `IPV4 | DUAL`
1929
+ #
2021
1930
  #
2022
1931
  #
2023
1932
  # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html
2024
1933
  # @option options [Integer] :storage_throughput
2025
- # Specifies the storage throughput value for the DB instance.
1934
+ # The storage throughput value for the DB instance.
2026
1935
  #
2027
1936
  # This setting applies only to the `gp3` storage type.
2028
1937
  #
2029
- # This setting doesn't apply to RDS Custom or Amazon Aurora.
1938
+ # This setting doesn't apply to Amazon Aurora or RDS Custom DB
1939
+ # instances.
2030
1940
  # @option options [Boolean] :manage_master_user_password
2031
- # A value that indicates whether to manage the master user password with
2032
- # Amazon Web Services Secrets Manager.
1941
+ # Specifies whether to manage the master user password with Amazon Web
1942
+ # Services Secrets Manager.
2033
1943
  #
2034
1944
  # For more information, see [Password management with Amazon Web
2035
1945
  # Services Secrets Manager][1] in the *Amazon RDS User Guide.*
@@ -2067,10 +1977,10 @@ module Aws::RDS
2067
1977
  # Amazon Web Services account has a different default KMS key for each
2068
1978
  # Amazon Web Services Region.
2069
1979
  # @option options [String] :ca_certificate_identifier
2070
- # Specifies the CA certificate identifier to use for the DB instances
2071
- # server certificate.
1980
+ # The CA certificate identifier to use for the DB instance's server
1981
+ # certificate.
2072
1982
  #
2073
- # This setting doesn't apply to RDS Custom.
1983
+ # This setting doesn't apply to RDS Custom DB instances.
2074
1984
  #
2075
1985
  # For more information, see [Using SSL/TLS to encrypt a connection to a
2076
1986
  # DB instance][1] in the *Amazon RDS User Guide* and [ Using SSL/TLS to
@@ -2856,16 +2766,17 @@ module Aws::RDS
2856
2766
  # The new amount of storage in gibibytes (GiB) to allocate for the DB
2857
2767
  # instance.
2858
2768
  #
2859
- # For MariaDB, MySQL, Oracle, and PostgreSQL, the value supplied must be
2860
- # at least 10% greater than the current value. Values that are not at
2861
- # least 10% greater than the existing value are rounded up so that they
2862
- # are 10% greater than the current value.
2769
+ # For RDS for MariaDB, RDS for MySQL, RDS for Oracle, and RDS for
2770
+ # PostgreSQL, the value supplied must be at least 10% greater than the
2771
+ # current value. Values that are not at least 10% greater than the
2772
+ # existing value are rounded up so that they are 10% greater than the
2773
+ # current value.
2863
2774
  #
2864
2775
  # For the valid values for allocated storage for each engine, see
2865
2776
  # `CreateDBInstance`.
2866
2777
  # @option options [String] :db_instance_class
2867
2778
  # The new compute and memory capacity of the DB instance, for example
2868
- # db.m4.large. Not all DB instance classes are available in all Amazon
2779
+ # `db.m4.large`. Not all DB instance classes are available in all Amazon
2869
2780
  # Web Services Regions, or for all database engines. For the full list
2870
2781
  # of DB instance classes, and availability for your engine, see [DB
2871
2782
  # Instance Class][1] in the *Amazon RDS User Guide* or [Aurora DB
@@ -2896,10 +2807,13 @@ module Aws::RDS
2896
2807
  # change is applied during the next maintenance window, unless you
2897
2808
  # enable `ApplyImmediately`.
2898
2809
  #
2899
- # This parameter doesn't apply to RDS Custom.
2810
+ # This parameter doesn't apply to RDS Custom DB instances.
2900
2811
  #
2901
- # Constraints: If supplied, must match the name of an existing
2902
- # DBSubnetGroup.
2812
+ # Constraints:
2813
+ #
2814
+ # * If supplied, must match existing DB subnet group.
2815
+ #
2816
+ # ^
2903
2817
  #
2904
2818
  # Example: `mydbsubnetgroup`
2905
2819
  #
@@ -2911,35 +2825,35 @@ module Aws::RDS
2911
2825
  # Changing this setting doesn't result in an outage and the change is
2912
2826
  # asynchronously applied as soon as possible.
2913
2827
  #
2914
- # This setting doesn't apply to RDS Custom.
2828
+ # This setting doesn't apply to RDS Custom DB instances.
2915
2829
  #
2916
2830
  # Constraints:
2917
2831
  #
2918
- # * If supplied, must match existing DBSecurityGroups.
2832
+ # * If supplied, must match existing DB security groups.
2919
2833
  #
2920
2834
  # ^
2921
2835
  # @option options [Array<String>] :vpc_security_group_ids
2922
- # A list of Amazon EC2 VPC security groups to authorize on this DB
2836
+ # A list of Amazon EC2 VPC security groups to associate with this DB
2923
2837
  # instance. This change is asynchronously applied as soon as possible.
2924
2838
  #
2925
- # This setting doesn't apply to RDS Custom.
2839
+ # This setting doesn't apply to the following DB instances:
2926
2840
  #
2927
- # **Amazon Aurora**
2841
+ # * Amazon Aurora (The associated list of EC2 VPC security groups is
2842
+ # managed by the DB cluster. For more information, see
2843
+ # `ModifyDBCluster`.)
2928
2844
  #
2929
- # Not applicable. The associated list of EC2 VPC security groups is
2930
- # managed by the DB cluster. For more information, see
2931
- # `ModifyDBCluster`.
2845
+ # * RDS Custom
2932
2846
  #
2933
2847
  # Constraints:
2934
2848
  #
2935
- # * If supplied, must match existing VpcSecurityGroupIds.
2849
+ # * If supplied, must match existing VPC security group IDs.
2936
2850
  #
2937
2851
  # ^
2938
2852
  # @option options [Boolean] :apply_immediately
2939
- # A value that indicates whether the modifications in this request and
2940
- # any pending modifications are asynchronously applied as soon as
2941
- # possible, regardless of the `PreferredMaintenanceWindow` setting for
2942
- # the DB instance. By default, this parameter is disabled.
2853
+ # Specifies whether the modifications in this request and any pending
2854
+ # modifications are asynchronously applied as soon as possible,
2855
+ # regardless of the `PreferredMaintenanceWindow` setting for the DB
2856
+ # instance. By default, this parameter is disabled.
2943
2857
  #
2944
2858
  # If this parameter is disabled, changes to the DB instance are applied
2945
2859
  # during the next maintenance window. Some parameter changes can cause
@@ -2953,8 +2867,7 @@ module Aws::RDS
2953
2867
  #
2954
2868
  # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Overview.DBInstance.Modifying.html
2955
2869
  # @option options [String] :master_user_password
2956
- # The new password for the master user. The password can include any
2957
- # printable ASCII character except "/", """, or "@".
2870
+ # The new password for the master user.
2958
2871
  #
2959
2872
  # Changing this parameter doesn't result in an outage and the change is
2960
2873
  # asynchronously applied as soon as possible. Between the time of the
@@ -2962,44 +2875,41 @@ module Aws::RDS
2962
2875
  # element exists in the `PendingModifiedValues` element of the operation
2963
2876
  # response.
2964
2877
  #
2965
- # This setting doesn't apply to RDS Custom.
2966
- #
2967
- # **Amazon Aurora**
2968
- #
2969
- # Not applicable. The password for the master user is managed by the DB
2970
- # cluster. For more information, see `ModifyDBCluster`.
2878
+ # <note markdown="1"> Amazon RDS API operations never return the password, so this action
2879
+ # provides a way to regain access to a primary instance user if the
2880
+ # password is lost. This includes restoring privileges that might have
2881
+ # been accidentally revoked.
2971
2882
  #
2972
- # Default: Uses existing setting
2883
+ # </note>
2973
2884
  #
2974
- # Constraints: Can't be specified if `ManageMasterUserPassword` is
2975
- # turned on.
2885
+ # This setting doesn't apply to the following DB instances:
2976
2886
  #
2977
- # **MariaDB**
2887
+ # * Amazon Aurora (The password for the master user is managed by the DB
2888
+ # cluster. For more information, see `ModifyDBCluster`.)
2978
2889
  #
2979
- # Constraints: Must contain from 8 to 41 characters.
2890
+ # * RDS Custom
2980
2891
  #
2981
- # **Microsoft SQL Server**
2892
+ # Default: Uses existing setting
2982
2893
  #
2983
- # Constraints: Must contain from 8 to 128 characters.
2894
+ # Constraints:
2984
2895
  #
2985
- # **MySQL**
2896
+ # * Can't be specified if `ManageMasterUserPassword` is turned on.
2986
2897
  #
2987
- # Constraints: Must contain from 8 to 41 characters.
2898
+ # * Can include any printable ASCII character except "/", """, or
2899
+ # "@".
2988
2900
  #
2989
- # **Oracle**
2901
+ # Length Constraints:
2990
2902
  #
2991
- # Constraints: Must contain from 8 to 30 characters.
2903
+ # * RDS for MariaDB - Must contain from 8 to 41 characters.
2992
2904
  #
2993
- # **PostgreSQL**
2905
+ # * RDS for Microsoft SQL Server - Must contain from 8 to 128
2906
+ # characters.
2994
2907
  #
2995
- # Constraints: Must contain from 8 to 128 characters.
2908
+ # * RDS for MySQL - Must contain from 8 to 41 characters.
2996
2909
  #
2997
- # <note markdown="1"> Amazon RDS API operations never return the password, so this action
2998
- # provides a way to regain access to a primary instance user if the
2999
- # password is lost. This includes restoring privileges that might have
3000
- # been accidentally revoked.
2910
+ # * RDS for Oracle - Must contain from 8 to 30 characters.
3001
2911
  #
3002
- # </note>
2912
+ # * RDS for PostgreSQL - Must contain from 8 to 128 characters.
3003
2913
  # @option options [String] :db_parameter_group_name
3004
2914
  # The name of the DB parameter group to apply to the DB instance.
3005
2915
  #
@@ -3012,12 +2922,15 @@ module Aws::RDS
3012
2922
  # associated DB parameter group, these changes are applied immediately
3013
2923
  # without a reboot.
3014
2924
  #
3015
- # This setting doesn't apply to RDS Custom.
2925
+ # This setting doesn't apply to RDS Custom DB instances.
3016
2926
  #
3017
2927
  # Default: Uses existing setting
3018
2928
  #
3019
- # Constraints: The DB parameter group must be in the same DB parameter
3020
- # group family as the DB instance.
2929
+ # Constraints:
2930
+ #
2931
+ # * Must be in the same DB parameter group family as the DB instance.
2932
+ #
2933
+ # ^
3021
2934
  # @option options [Integer] :backup_retention_period
3022
2935
  # The number of days to retain automated backups. Setting this parameter
3023
2936
  # to a positive number enables backups. Setting this parameter to 0
@@ -3034,24 +2947,19 @@ module Aws::RDS
3034
2947
  # change the parameter from one non-zero value to another non-zero
3035
2948
  # value, the change is asynchronously applied as soon as possible.
3036
2949
  #
3037
- # **Amazon Aurora**
3038
- #
3039
- # Not applicable. The retention period for automated backups is managed
3040
- # by the DB cluster. For more information, see `ModifyDBCluster`.
2950
+ # This setting doesn't apply to Amazon Aurora DB instances. The
2951
+ # retention period for automated backups is managed by the DB cluster.
2952
+ # For more information, see `ModifyDBCluster`.
3041
2953
  #
3042
2954
  # Default: Uses existing setting
3043
2955
  #
3044
2956
  # Constraints:
3045
2957
  #
3046
- # * It must be a value from 0 to 35. It can't be set to 0 if the DB
3047
- # instance is a source to read replicas. It can't be set to 0 for an
3048
- # RDS Custom for Oracle DB instance.
2958
+ # * Must be a value from 0 to 35.
3049
2959
  #
3050
- # * It can be specified for a MySQL read replica only if the source is
3051
- # running MySQL 5.6 or later.
2960
+ # * Can't be set to 0 if the DB instance is a source to read replicas.
3052
2961
  #
3053
- # * It can be specified for a PostgreSQL read replica only if the source
3054
- # is running PostgreSQL 9.3.5.
2962
+ # * Can't be set to 0 for an RDS Custom for Oracle DB instance.
3055
2963
  # @option options [String] :preferred_backup_window
3056
2964
  # The daily time range during which automated backups are created if
3057
2965
  # automated backups are enabled, as determined by the
@@ -3059,59 +2967,63 @@ module Aws::RDS
3059
2967
  # result in an outage and the change is asynchronously applied as soon
3060
2968
  # as possible. The default is a 30-minute window selected at random from
3061
2969
  # an 8-hour block of time for each Amazon Web Services Region. For more
3062
- # information, see [Backup window][1] in the *Amazon RDS User Guide.*
3063
- #
3064
- # **Amazon Aurora**
2970
+ # information, see [Backup window][1] in the *Amazon RDS User Guide*.
3065
2971
  #
3066
- # Not applicable. The daily time range for creating automated backups is
3067
- # managed by the DB cluster. For more information, see
3068
- # `ModifyDBCluster`.
2972
+ # This setting doesn't apply to Amazon Aurora DB instances. The daily
2973
+ # time range for creating automated backups is managed by the DB
2974
+ # cluster. For more information, see `ModifyDBCluster`.
3069
2975
  #
3070
2976
  # Constraints:
3071
2977
  #
3072
- # * Must be in the format hh24:mi-hh24:mi
2978
+ # * Must be in the format `hh24:mi-hh24:mi`.
3073
2979
  #
3074
- # * Must be in Universal Time Coordinated (UTC)
2980
+ # * Must be in Universal Coordinated Time (UTC).
3075
2981
  #
3076
- # * Must not conflict with the preferred maintenance window
2982
+ # * Must not conflict with the preferred maintenance window.
3077
2983
  #
3078
- # * Must be at least 30 minutes
2984
+ # * Must be at least 30 minutes.
3079
2985
  #
3080
2986
  #
3081
2987
  #
3082
2988
  # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithAutomatedBackups.html#USER_WorkingWithAutomatedBackups.BackupWindow
3083
2989
  # @option options [String] :preferred_maintenance_window
3084
- # The weekly time range (in UTC) during which system maintenance can
3085
- # occur, which might result in an outage. Changing this parameter
3086
- # doesn't result in an outage, except in the following situation, and
3087
- # the change is asynchronously applied as soon as possible. If there are
3088
- # pending actions that cause a reboot, and the maintenance window is
3089
- # changed to include the current time, then changing this parameter will
3090
- # cause a reboot of the DB instance. If moving this window to the
3091
- # current time, there must be at least 30 minutes between the current
3092
- # time and end of the window to ensure pending changes are applied.
2990
+ # The weekly time range during which system maintenance can occur, which
2991
+ # might result in an outage. Changing this parameter doesn't result in
2992
+ # an outage, except in the following situation, and the change is
2993
+ # asynchronously applied as soon as possible. If there are pending
2994
+ # actions that cause a reboot, and the maintenance window is changed to
2995
+ # include the current time, then changing this parameter causes a reboot
2996
+ # of the DB instance. If you change this window to the current time,
2997
+ # there must be at least 30 minutes between the current time and end of
2998
+ # the window to ensure pending changes are applied.
3093
2999
  #
3094
3000
  # For more information, see [Amazon RDS Maintenance Window][1] in the
3095
3001
  # *Amazon RDS User Guide.*
3096
3002
  #
3097
3003
  # Default: Uses existing setting
3098
3004
  #
3099
- # Format: ddd:hh24:mi-ddd:hh24:mi
3005
+ # Constraints:
3006
+ #
3007
+ # * Must be in the format `ddd:hh24:mi-ddd:hh24:mi`.
3008
+ #
3009
+ # * The day values must be `mon | tue | wed | thu | fri | sat | sun`.
3100
3010
  #
3101
- # Valid Days: Mon \| Tue \| Wed \| Thu \| Fri \| Sat \| Sun
3011
+ # * Must be in Universal Coordinated Time (UTC).
3012
+ #
3013
+ # * Must not conflict with the preferred backup window.
3102
3014
  #
3103
- # Constraints: Must be at least 30 minutes
3015
+ # * Must be at least 30 minutes.
3104
3016
  #
3105
3017
  #
3106
3018
  #
3107
3019
  # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_UpgradeDBInstance.Maintenance.html#Concepts.DBMaintenance
3108
3020
  # @option options [Boolean] :multi_az
3109
- # A value that indicates whether the DB instance is a Multi-AZ
3110
- # deployment. Changing this parameter doesn't result in an outage. The
3111
- # change is applied during the next maintenance window unless the
3112
- # `ApplyImmediately` parameter is enabled for this request.
3021
+ # Specifies whether the DB instance is a Multi-AZ deployment. Changing
3022
+ # this parameter doesn't result in an outage. The change is applied
3023
+ # during the next maintenance window unless the `ApplyImmediately`
3024
+ # parameter is enabled for this request.
3113
3025
  #
3114
- # This setting doesn't apply to RDS Custom.
3026
+ # This setting doesn't apply to RDS Custom DB instances.
3115
3027
  # @option options [String] :engine_version
3116
3028
  # The version number of the database engine to upgrade to. Changing this
3117
3029
  # parameter results in an outage and the change is applied during the
@@ -3123,31 +3035,35 @@ module Aws::RDS
3123
3035
  # family for the new engine version must be specified. The new DB
3124
3036
  # parameter group can be the default for that DB parameter group family.
3125
3037
  #
3126
- # If you specify only a major version, Amazon RDS will update the DB
3038
+ # If you specify only a major version, Amazon RDS updates the DB
3127
3039
  # instance to the default minor version if the current minor version is
3128
3040
  # lower. For information about valid engine versions, see
3129
3041
  # `CreateDBInstance`, or call `DescribeDBEngineVersions`.
3130
3042
  #
3131
3043
  # If the instance that you're modifying is acting as a read replica,
3132
- # the engine version that you specify must be the same or later than the
3133
- # version that the source DB instance or cluster is running.
3044
+ # the engine version that you specify must be the same or higher than
3045
+ # the version that the source DB instance or cluster is running.
3134
3046
  #
3135
3047
  # In RDS Custom for Oracle, this parameter is supported for read
3136
3048
  # replicas only if they are in the `PATCH_DB_FAILURE` lifecycle.
3137
3049
  # @option options [Boolean] :allow_major_version_upgrade
3138
- # A value that indicates whether major version upgrades are allowed.
3139
- # Changing this parameter doesn't result in an outage and the change is
3050
+ # Specifies whether major version upgrades are allowed. Changing this
3051
+ # parameter doesn't result in an outage and the change is
3140
3052
  # asynchronously applied as soon as possible.
3141
3053
  #
3142
- # This setting doesn't apply to RDS Custom.
3054
+ # This setting doesn't apply to RDS Custom DB instances.
3055
+ #
3056
+ # Constraints:
3057
+ #
3058
+ # * Major version upgrades must be allowed when specifying a value for
3059
+ # the `EngineVersion` parameter that's a different major version than
3060
+ # the DB instance's current version.
3143
3061
  #
3144
- # Constraints: Major version upgrades must be allowed when specifying a
3145
- # value for the EngineVersion parameter that is a different major
3146
- # version than the DB instance's current version.
3062
+ # ^
3147
3063
  # @option options [Boolean] :auto_minor_version_upgrade
3148
- # A value that indicates whether minor version upgrades are applied
3149
- # automatically to the DB instance during the maintenance window. An
3150
- # outage occurs when all the following conditions are met:
3064
+ # Specifies whether minor version upgrades are applied automatically to
3065
+ # the DB instance during the maintenance window. An outage occurs when
3066
+ # all the following conditions are met:
3151
3067
  #
3152
3068
  # * The automatic upgrade is enabled for the maintenance window.
3153
3069
  #
@@ -3155,18 +3071,28 @@ module Aws::RDS
3155
3071
  #
3156
3072
  # * RDS has enabled automatic patching for the engine version.
3157
3073
  #
3158
- # If any of the preceding conditions isn't met, RDS applies the change
3159
- # as soon as possible and doesn't cause an outage.
3074
+ # If any of the preceding conditions isn't met, Amazon RDS applies the
3075
+ # change as soon as possible and doesn't cause an outage.
3160
3076
  #
3161
- # For an RDS Custom DB instance, set `AutoMinorVersionUpgrade` to
3162
- # `false`. Otherwise, the operation returns an error.
3077
+ # For an RDS Custom DB instance, don't enable this setting. Otherwise,
3078
+ # the operation returns an error.
3163
3079
  # @option options [String] :license_model
3164
3080
  # The license model for the DB instance.
3165
3081
  #
3166
- # This setting doesn't apply to RDS Custom.
3082
+ # This setting doesn't apply to Amazon Aurora or RDS Custom DB
3083
+ # instances.
3167
3084
  #
3168
- # Valid values: `license-included` \| `bring-your-own-license` \|
3169
- # `general-public-license`
3085
+ # Valid Values:
3086
+ #
3087
+ # * RDS for MariaDB - `general-public-license`
3088
+ #
3089
+ # * RDS for Microsoft SQL Server - `license-included`
3090
+ #
3091
+ # * RDS for MySQL - `general-public-license`
3092
+ #
3093
+ # * RDS for Oracle - `bring-your-own-license | license-included`
3094
+ #
3095
+ # * RDS for PostgreSQL - `postgresql-license`
3170
3096
  # @option options [Integer] :iops
3171
3097
  # The new Provisioned IOPS (I/O operations per second) value for the RDS
3172
3098
  # instance.
@@ -3193,15 +3119,19 @@ module Aws::RDS
3193
3119
  # rebooting the instance, deleting the instance, creating a read replica
3194
3120
  # for the instance, and creating a DB snapshot of the instance.
3195
3121
  #
3196
- # Constraints: For MariaDB, MySQL, Oracle, and PostgreSQL, the value
3197
- # supplied must be at least 10% greater than the current value. Values
3198
- # that are not at least 10% greater than the existing value are rounded
3199
- # up so that they are 10% greater than the current value.
3122
+ # Constraints:
3123
+ #
3124
+ # * For RDS for MariaDB, RDS for MySQL, RDS for Oracle, and RDS for
3125
+ # PostgreSQL - The value supplied must be at least 10% greater than
3126
+ # the current value. Values that are not at least 10% greater than the
3127
+ # existing value are rounded up so that they are 10% greater than the
3128
+ # current value.
3129
+ #
3130
+ # ^
3200
3131
  #
3201
3132
  # Default: Uses existing setting
3202
3133
  # @option options [String] :option_group_name
3203
- # A value that indicates the DB instance should be associated with the
3204
- # specified option group.
3134
+ # The option group to associate the DB instance with.
3205
3135
  #
3206
3136
  # Changing this parameter doesn't result in an outage, with one
3207
3137
  # exception. If the parameter change results in an option group that
@@ -3217,15 +3147,15 @@ module Aws::RDS
3217
3147
  # can't be removed from a DB instance after it is associated with a DB
3218
3148
  # instance.
3219
3149
  #
3220
- # This setting doesn't apply to RDS Custom.
3150
+ # This setting doesn't apply to RDS Custom DB instances.
3221
3151
  # @option options [String] :new_db_instance_identifier
3222
- # The new DB instance identifier for the DB instance when renaming a DB
3223
- # instance. When you change the DB instance identifier, an instance
3224
- # reboot occurs immediately if you enable `ApplyImmediately`, or will
3225
- # occur during the next maintenance window if you disable Apply
3226
- # Immediately. This value is stored as a lowercase string.
3152
+ # The new identifier for the DB instance when renaming a DB instance.
3153
+ # When you change the DB instance identifier, an instance reboot occurs
3154
+ # immediately if you enable `ApplyImmediately`, or will occur during the
3155
+ # next maintenance window if you disable `ApplyImmediately`. This value
3156
+ # is stored as a lowercase string.
3227
3157
  #
3228
- # This setting doesn't apply to RDS Custom.
3158
+ # This setting doesn't apply to RDS Custom DB instances.
3229
3159
  #
3230
3160
  # Constraints:
3231
3161
  #
@@ -3237,7 +3167,7 @@ module Aws::RDS
3237
3167
  #
3238
3168
  # Example: `mydbinstance`
3239
3169
  # @option options [String] :storage_type
3240
- # Specifies the storage type to be associated with the DB instance.
3170
+ # The storage type to associate with the DB instance.
3241
3171
  #
3242
3172
  # If you specify Provisioned IOPS (`io1`), you must also include a value
3243
3173
  # for the `Iops` parameter.
@@ -3257,24 +3187,25 @@ module Aws::RDS
3257
3187
  # rebooting the instance, deleting the instance, creating a read replica
3258
3188
  # for the instance, and creating a DB snapshot of the instance.
3259
3189
  #
3260
- # Valid values: `gp2 | gp3 | io1 | standard`
3190
+ # Valid Values: `gp2 | gp3 | io1 | standard`
3261
3191
  #
3262
- # Default: `io1` if the `Iops` parameter is specified, otherwise `gp2`
3192
+ # Default: `io1`, if the `Iops` parameter is specified. Otherwise,
3193
+ # `gp2`.
3263
3194
  # @option options [String] :tde_credential_arn
3264
3195
  # The ARN from the key store with which to associate the instance for
3265
3196
  # TDE encryption.
3266
3197
  #
3267
- # This setting doesn't apply to RDS Custom.
3198
+ # This setting doesn't apply to RDS Custom DB instances.
3268
3199
  # @option options [String] :tde_credential_password
3269
3200
  # The password for the given ARN from the key store in order to access
3270
3201
  # the device.
3271
3202
  #
3272
- # This setting doesn't apply to RDS Custom.
3203
+ # This setting doesn't apply to RDS Custom DB instances.
3273
3204
  # @option options [String] :ca_certificate_identifier
3274
- # Specifies the CA certificate identifier to use for the DB instance’s
3275
- # server certificate.
3205
+ # The CA certificate identifier to use for the DB instance6's server
3206
+ # certificate.
3276
3207
  #
3277
- # This setting doesn't apply to RDS Custom.
3208
+ # This setting doesn't apply to RDS Custom DB instances.
3278
3209
  #
3279
3210
  # For more information, see [Using SSL/TLS to encrypt a connection to a
3280
3211
  # DB instance][1] in the *Amazon RDS User Guide* and [ Using SSL/TLS to
@@ -3295,31 +3226,32 @@ module Aws::RDS
3295
3226
  # For more information, see [ Kerberos Authentication][1] in the *Amazon
3296
3227
  # RDS User Guide*.
3297
3228
  #
3298
- # This setting doesn't apply to RDS Custom.
3229
+ # This setting doesn't apply to RDS Custom DB instances.
3299
3230
  #
3300
3231
  #
3301
3232
  #
3302
3233
  # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/kerberos-authentication.html
3303
3234
  # @option options [Boolean] :copy_tags_to_snapshot
3304
- # A value that indicates whether to copy all tags from the DB instance
3305
- # to snapshots of the DB instance. By default, tags are not copied.
3306
- #
3307
- # **Amazon Aurora**
3235
+ # Specifies whether to copy all tags from the DB instance to snapshots
3236
+ # of the DB instance. By default, tags aren't copied.
3308
3237
  #
3309
- # Not applicable. Copying tags to snapshots is managed by the DB
3310
- # cluster. Setting this value for an Aurora DB instance has no effect on
3311
- # the DB cluster setting. For more information, see `ModifyDBCluster`.
3238
+ # This setting doesn't apply to Amazon Aurora DB instances. Copying
3239
+ # tags to snapshots is managed by the DB cluster. Setting this value for
3240
+ # an Aurora DB instance has no effect on the DB cluster setting. For
3241
+ # more information, see `ModifyDBCluster`.
3312
3242
  # @option options [Integer] :monitoring_interval
3313
3243
  # The interval, in seconds, between points when Enhanced Monitoring
3314
- # metrics are collected for the DB instance. To disable collecting
3315
- # Enhanced Monitoring metrics, specify 0, which is the default.
3244
+ # metrics are collected for the DB instance. To disable collection of
3245
+ # Enhanced Monitoring metrics, specify `0`.
3316
3246
  #
3317
3247
  # If `MonitoringRoleArn` is specified, set `MonitoringInterval` to a
3318
- # value other than 0.
3248
+ # value other than `0`.
3319
3249
  #
3320
- # This setting doesn't apply to RDS Custom.
3250
+ # This setting doesn't apply to RDS Custom DB instances.
3321
3251
  #
3322
- # Valid Values: `0, 1, 5, 10, 15, 30, 60`
3252
+ # Valid Values: `0 | 1 | 5 | 10 | 15 | 30 | 60`
3253
+ #
3254
+ # Default: `0`
3323
3255
  # @option options [Integer] :db_port_number
3324
3256
  # The port number on which the database accepts connections.
3325
3257
  #
@@ -3330,48 +3262,32 @@ module Aws::RDS
3330
3262
  # If you change the `DBPortNumber` value, your database restarts
3331
3263
  # regardless of the value of the `ApplyImmediately` parameter.
3332
3264
  #
3333
- # This setting doesn't apply to RDS Custom.
3334
- #
3335
- # **MySQL**
3336
- #
3337
- # Default: `3306`
3338
- #
3339
- # Valid values: `1150-65535`
3340
- #
3341
- # **MariaDB**
3265
+ # This setting doesn't apply to RDS Custom DB instances.
3342
3266
  #
3343
- # Default: `3306`
3344
- #
3345
- # Valid values: `1150-65535`
3346
- #
3347
- # **PostgreSQL**
3348
- #
3349
- # Default: `5432`
3350
- #
3351
- # Valid values: `1150-65535`
3267
+ # Valid Values: `1150-65535`
3352
3268
  #
3353
- # Type: Integer
3269
+ # Default:
3354
3270
  #
3355
- # **Oracle**
3271
+ # * Amazon Aurora - `3306`
3356
3272
  #
3357
- # Default: `1521`
3273
+ # * RDS for MariaDB - `3306`
3358
3274
  #
3359
- # Valid values: `1150-65535`
3275
+ # * RDS for Microsoft SQL Server - `1433`
3360
3276
  #
3361
- # **SQL Server**
3277
+ # * RDS for MySQL - `3306`
3362
3278
  #
3363
- # Default: `1433`
3279
+ # * RDS for Oracle - `1521`
3364
3280
  #
3365
- # Valid values: `1150-65535` except `1234`, `1434`, `3260`, `3343`,
3366
- # `3389`, `47001`, and `49152-49156`.
3281
+ # * RDS for PostgreSQL - `5432`
3367
3282
  #
3368
- # **Amazon Aurora**
3283
+ # Constraints:
3369
3284
  #
3370
- # Default: `3306`
3285
+ # * For RDS for Microsoft SQL Server, the value can't be `1234`,
3286
+ # `1434`, `3260`, `3343`, `3389`, `47001`, or `49152-49156`.
3371
3287
  #
3372
- # Valid values: `1150-65535`
3288
+ # ^
3373
3289
  # @option options [Boolean] :publicly_accessible
3374
- # A value that indicates whether the DB instance is publicly accessible.
3290
+ # Specifies whether the DB instance is publicly accessible.
3375
3291
  #
3376
3292
  # When the DB cluster is publicly accessible, its Domain Name System
3377
3293
  # (DNS) endpoint resolves to the private IP address from within the DB
@@ -3397,10 +3313,10 @@ module Aws::RDS
3397
3313
  # a monitoring role, see [To create an IAM role for Amazon RDS Enhanced
3398
3314
  # Monitoring][1] in the *Amazon RDS User Guide.*
3399
3315
  #
3400
- # If `MonitoringInterval` is set to a value other than 0, supply a
3316
+ # If `MonitoringInterval` is set to a value other than `0`, supply a
3401
3317
  # `MonitoringRoleArn` value.
3402
3318
  #
3403
- # This setting doesn't apply to RDS Custom.
3319
+ # This setting doesn't apply to RDS Custom DB instances.
3404
3320
  #
3405
3321
  #
3406
3322
  #
@@ -3409,26 +3325,26 @@ module Aws::RDS
3409
3325
  # The name of the IAM role to use when making API calls to the Directory
3410
3326
  # Service.
3411
3327
  #
3412
- # This setting doesn't apply to RDS Custom.
3328
+ # This setting doesn't apply to RDS Custom DB instances.
3413
3329
  # @option options [Integer] :promotion_tier
3414
- # A value that specifies the order in which an Aurora Replica is
3415
- # promoted to the primary instance after a failure of the existing
3416
- # primary instance. For more information, see [ Fault Tolerance for an
3417
- # Aurora DB Cluster][1] in the *Amazon Aurora User Guide*.
3330
+ # The order of priority in which an Aurora Replica is promoted to the
3331
+ # primary instance after a failure of the existing primary instance. For
3332
+ # more information, see [ Fault Tolerance for an Aurora DB Cluster][1]
3333
+ # in the *Amazon Aurora User Guide*.
3418
3334
  #
3419
- # This setting doesn't apply to RDS Custom.
3335
+ # This setting doesn't apply to RDS Custom DB instances.
3420
3336
  #
3421
- # Default: 1
3337
+ # Default: `1`
3422
3338
  #
3423
- # Valid Values: 0 - 15
3339
+ # Valid Values: `0 - 15`
3424
3340
  #
3425
3341
  #
3426
3342
  #
3427
- # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Managing.Backups.html#Aurora.Managing.FaultTolerance
3343
+ # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Concepts.AuroraHighAvailability.html#Aurora.Managing.FaultTolerance
3428
3344
  # @option options [Boolean] :enable_iam_database_authentication
3429
- # A value that indicates whether to enable mapping of Amazon Web
3430
- # Services Identity and Access Management (IAM) accounts to database
3431
- # accounts. By default, mapping isn't enabled.
3345
+ # Specifies whether to enable mapping of Amazon Web Services Identity
3346
+ # and Access Management (IAM) accounts to database accounts. By default,
3347
+ # mapping isn't enabled.
3432
3348
  #
3433
3349
  # This setting doesn't apply to Amazon Aurora. Mapping Amazon Web
3434
3350
  # Services IAM accounts to database accounts is managed by the DB
@@ -3438,19 +3354,18 @@ module Aws::RDS
3438
3354
  # Database Authentication for MySQL and PostgreSQL][1] in the *Amazon
3439
3355
  # RDS User Guide.*
3440
3356
  #
3441
- # This setting doesn't apply to RDS Custom.
3357
+ # This setting doesn't apply to RDS Custom DB instances.
3442
3358
  #
3443
3359
  #
3444
3360
  #
3445
3361
  # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.IAMDBAuth.html
3446
3362
  # @option options [Boolean] :enable_performance_insights
3447
- # A value that indicates whether to enable Performance Insights for the
3448
- # DB instance.
3363
+ # Specifies whether to enable Performance Insights for the DB instance.
3449
3364
  #
3450
3365
  # For more information, see [Using Amazon Performance Insights][1] in
3451
3366
  # the *Amazon RDS User Guide*.
3452
3367
  #
3453
- # This setting doesn't apply to RDS Custom.
3368
+ # This setting doesn't apply to RDS Custom DB instances.
3454
3369
  #
3455
3370
  #
3456
3371
  #
@@ -3462,60 +3377,55 @@ module Aws::RDS
3462
3377
  # The Amazon Web Services KMS key identifier is the key ARN, key ID,
3463
3378
  # alias ARN, or alias name for the KMS key.
3464
3379
  #
3465
- # If you do not specify a value for `PerformanceInsightsKMSKeyId`, then
3380
+ # If you don't specify a value for `PerformanceInsightsKMSKeyId`, then
3466
3381
  # Amazon RDS uses your default KMS key. There is a default KMS key for
3467
3382
  # your Amazon Web Services account. Your Amazon Web Services account has
3468
3383
  # a different default KMS key for each Amazon Web Services Region.
3469
3384
  #
3470
- # This setting doesn't apply to RDS Custom.
3385
+ # This setting doesn't apply to RDS Custom DB instances.
3471
3386
  # @option options [Integer] :performance_insights_retention_period
3472
- # The number of days to retain Performance Insights data. The default is
3473
- # 7 days. The following values are valid:
3474
- #
3475
- # * 7
3476
- #
3477
- # * *month* * 31, where *month* is a number of months from 1-23
3387
+ # The number of days to retain Performance Insights data.
3478
3388
  #
3479
- # * 731
3480
- #
3481
- # For example, the following values are valid:
3389
+ # This setting doesn't apply to RDS Custom DB instances.
3482
3390
  #
3483
- # * 93 (3 months * 31)
3391
+ # Valid Values:
3484
3392
  #
3485
- # * 341 (11 months * 31)
3393
+ # * `7`
3486
3394
  #
3487
- # * 589 (19 months * 31)
3395
+ # * *month* * 31, where *month* is a number of months from 1-23.
3396
+ # Examples: `93` (3 months * 31), `341` (11 months * 31), `589` (19
3397
+ # months * 31)
3488
3398
  #
3489
- # * 731
3399
+ # * `731`
3490
3400
  #
3491
- # If you specify a retention period such as 94, which isn't a valid
3492
- # value, RDS issues an error.
3401
+ # Default: `7` days
3493
3402
  #
3494
- # This setting doesn't apply to RDS Custom.
3403
+ # If you specify a retention period that isn't valid, such as `94`,
3404
+ # Amazon RDS returns an error.
3495
3405
  # @option options [Types::CloudwatchLogsExportConfiguration] :cloudwatch_logs_export_configuration
3496
- # The configuration setting for the log types to be enabled for export
3497
- # to CloudWatch Logs for a specific DB instance.
3406
+ # The log types to be enabled for export to CloudWatch Logs for a
3407
+ # specific DB instance.
3498
3408
  #
3499
3409
  # A change to the `CloudwatchLogsExportConfiguration` parameter is
3500
3410
  # always applied to the DB instance immediately. Therefore, the
3501
3411
  # `ApplyImmediately` parameter has no effect.
3502
3412
  #
3503
- # This setting doesn't apply to RDS Custom.
3413
+ # This setting doesn't apply to RDS Custom DB instances.
3504
3414
  # @option options [Array<Types::ProcessorFeature>] :processor_features
3505
3415
  # The number of CPU cores and the number of threads per core for the DB
3506
3416
  # instance class of the DB instance.
3507
3417
  #
3508
- # This setting doesn't apply to RDS Custom.
3418
+ # This setting doesn't apply to RDS Custom DB instances.
3509
3419
  # @option options [Boolean] :use_default_processor_features
3510
- # A value that indicates whether the DB instance class of the DB
3511
- # instance uses its default processor features.
3420
+ # Specifies whether the DB instance class of the DB instance uses its
3421
+ # default processor features.
3512
3422
  #
3513
- # This setting doesn't apply to RDS Custom.
3423
+ # This setting doesn't apply to RDS Custom DB instances.
3514
3424
  # @option options [Boolean] :deletion_protection
3515
- # A value that indicates whether the DB instance has deletion protection
3516
- # enabled. The database can't be deleted when deletion protection is
3517
- # enabled. By default, deletion protection isn't enabled. For more
3518
- # information, see [ Deleting a DB Instance][1].
3425
+ # Specifies whether the DB instance has deletion protection enabled. The
3426
+ # database can't be deleted when deletion protection is enabled. By
3427
+ # default, deletion protection isn't enabled. For more information, see
3428
+ # [ Deleting a DB Instance][1].
3519
3429
  #
3520
3430
  #
3521
3431
  #
@@ -3528,14 +3438,14 @@ module Aws::RDS
3528
3438
  # apply to it, see [ Managing capacity automatically with Amazon RDS
3529
3439
  # storage autoscaling][1] in the *Amazon RDS User Guide*.
3530
3440
  #
3531
- # This setting doesn't apply to RDS Custom.
3441
+ # This setting doesn't apply to RDS Custom DB instances.
3532
3442
  #
3533
3443
  #
3534
3444
  #
3535
3445
  # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PIOPS.StorageTypes.html#USER_PIOPS.Autoscaling
3536
3446
  # @option options [Boolean] :certificate_rotation_restart
3537
- # A value that indicates whether the DB instance is restarted when you
3538
- # rotate your SSL/TLS certificate.
3447
+ # Specifies whether the DB instance is restarted when you rotate your
3448
+ # SSL/TLS certificate.
3539
3449
  #
3540
3450
  # By default, the DB instance is restarted when you rotate your SSL/TLS
3541
3451
  # certificate. The certificate is not updated until the DB instance is
@@ -3556,7 +3466,7 @@ module Aws::RDS
3556
3466
  # Aurora DB engines, see [ Rotating Your SSL/TLS Certificate][2] in
3557
3467
  # the *Amazon Aurora User Guide*.
3558
3468
  #
3559
- # This setting doesn't apply to RDS Custom.
3469
+ # This setting doesn't apply to RDS Custom DB instances.
3560
3470
  #
3561
3471
  #
3562
3472
  #
@@ -3578,14 +3488,14 @@ module Aws::RDS
3578
3488
  # more information, see [Working with Oracle Read Replicas for Amazon
3579
3489
  # RDS][1] in the *Amazon RDS User Guide*.
3580
3490
  #
3581
- # This setting doesn't apply to RDS Custom.
3491
+ # This setting doesn't apply to RDS Custom DB instances.
3582
3492
  #
3583
3493
  #
3584
3494
  #
3585
3495
  # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/oracle-read-replicas.html
3586
3496
  # @option options [Boolean] :enable_customer_owned_ip
3587
- # A value that indicates whether to enable a customer-owned IP address
3588
- # (CoIP) for an RDS on Outposts DB instance.
3497
+ # Specifies whether to enable a customer-owned IP address (CoIP) for an
3498
+ # RDS on Outposts DB instance.
3589
3499
  #
3590
3500
  # A *CoIP* provides local or external connectivity to resources in your
3591
3501
  # Outpost subnets through your on-premises network. For some use cases,
@@ -3607,24 +3517,25 @@ module Aws::RDS
3607
3517
  # The Amazon Resource Name (ARN) of the recovery point in Amazon Web
3608
3518
  # Services Backup.
3609
3519
  #
3610
- # This setting doesn't apply to RDS Custom.
3520
+ # This setting doesn't apply to RDS Custom DB instances.
3611
3521
  # @option options [String] :automation_mode
3612
- # The automation mode of the RDS Custom DB instance: `full` or `all
3613
- # paused`. If `full`, the DB instance automates monitoring and instance
3614
- # recovery. If `all paused`, the instance pauses automation for the
3615
- # duration set by `ResumeFullAutomationModeMinutes`.
3522
+ # The automation mode of the RDS Custom DB instance. If `full`, the DB
3523
+ # instance automates monitoring and instance recovery. If `all paused`,
3524
+ # the instance pauses automation for the duration set by
3525
+ # `ResumeFullAutomationModeMinutes`.
3616
3526
  # @option options [Integer] :resume_full_automation_mode_minutes
3617
3527
  # The number of minutes to pause the automation. When the time period
3618
- # ends, RDS Custom resumes full automation. The minimum value is `60`
3619
- # (default). The maximum value is `1,440`.
3620
- # @option options [String] :network_type
3621
- # The network type of the DB instance.
3528
+ # ends, RDS Custom resumes full automation.
3622
3529
  #
3623
- # Valid values:
3530
+ # Default: `60`
3624
3531
  #
3625
- # * `IPV4`
3532
+ # Constraints:
3626
3533
  #
3627
- # * `DUAL`
3534
+ # * Must be at least 60.
3535
+ #
3536
+ # * Must be no more than 1,440.
3537
+ # @option options [String] :network_type
3538
+ # The network type of the DB instance.
3628
3539
  #
3629
3540
  # The network type is determined by the `DBSubnetGroup` specified for
3630
3541
  # the DB instance. A `DBSubnetGroup` can support only the IPv4 protocol
@@ -3633,18 +3544,21 @@ module Aws::RDS
3633
3544
  # For more information, see [ Working with a DB instance in a VPC][1] in
3634
3545
  # the *Amazon RDS User Guide.*
3635
3546
  #
3547
+ # Valid Values: `IPV4 | DUAL`
3548
+ #
3636
3549
  #
3637
3550
  #
3638
3551
  # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html
3639
3552
  # @option options [Integer] :storage_throughput
3640
- # Specifies the storage throughput value for the DB instance.
3553
+ # The storage throughput value for the DB instance.
3641
3554
  #
3642
3555
  # This setting applies only to the `gp3` storage type.
3643
3556
  #
3644
- # This setting doesn't apply to RDS Custom or Amazon Aurora.
3557
+ # This setting doesn't apply to Amazon Aurora or RDS Custom DB
3558
+ # instances.
3645
3559
  # @option options [Boolean] :manage_master_user_password
3646
- # A value that indicates whether to manage the master user password with
3647
- # Amazon Web Services Secrets Manager.
3560
+ # Specifies whether to manage the master user password with Amazon Web
3561
+ # Services Secrets Manager.
3648
3562
  #
3649
3563
  # If the DB instance doesn't manage the master user password with
3650
3564
  # Amazon Web Services Secrets Manager, you can turn on this management.
@@ -3653,9 +3567,9 @@ module Aws::RDS
3653
3567
  # If the DB instance already manages the master user password with
3654
3568
  # Amazon Web Services Secrets Manager, and you specify that the master
3655
3569
  # user password is not managed with Amazon Web Services Secrets Manager,
3656
- # then you must specify `MasterUserPassword`. In this case, RDS deletes
3657
- # the secret and uses the new password for the master user specified by
3658
- # `MasterUserPassword`.
3570
+ # then you must specify `MasterUserPassword`. In this case, Amazon RDS
3571
+ # deletes the secret and uses the new password for the master user
3572
+ # specified by `MasterUserPassword`.
3659
3573
  #
3660
3574
  # For more information, see [Password management with Amazon Web
3661
3575
  # Services Secrets Manager][1] in the *Amazon RDS User Guide.*
@@ -3671,8 +3585,8 @@ module Aws::RDS
3671
3585
  #
3672
3586
  # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html
3673
3587
  # @option options [Boolean] :rotate_master_user_password
3674
- # A value that indicates whether to rotate the secret managed by Amazon
3675
- # Web Services Secrets Manager for the master user password.
3588
+ # Specifies whether to rotate the secret managed by Amazon Web Services
3589
+ # Secrets Manager for the master user password.
3676
3590
  #
3677
3591
  # This setting is valid only if the master user password is managed by
3678
3592
  # RDS in Amazon Web Services Secrets Manager for the DB cluster. The