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.
- checksums.yaml +4 -4
- data/CHANGELOG.md +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-rds/client.rb +1040 -1099
- data/lib/aws-sdk-rds/db_cluster.rb +425 -444
- data/lib/aws-sdk-rds/db_instance.rb +761 -847
- data/lib/aws-sdk-rds/resource.rb +600 -688
- data/lib/aws-sdk-rds/types.rb +1246 -1348
- data/lib/aws-sdk-rds.rb +1 -1
- metadata +2 -2
@@ -44,15 +44,14 @@ module Aws::RDS
|
|
44
44
|
data[:allocated_storage]
|
45
45
|
end
|
46
46
|
|
47
|
-
#
|
48
|
-
#
|
47
|
+
# The list of Availability Zones (AZs) where instances in the DB cluster
|
48
|
+
# can be created.
|
49
49
|
# @return [Array<String>]
|
50
50
|
def availability_zones
|
51
51
|
data[:availability_zones]
|
52
52
|
end
|
53
53
|
|
54
|
-
#
|
55
|
-
# retained.
|
54
|
+
# The number of days for which automatic DB snapshots are retained.
|
56
55
|
# @return [Integer]
|
57
56
|
def backup_retention_period
|
58
57
|
data[:backup_retention_period]
|
@@ -65,30 +64,28 @@ module Aws::RDS
|
|
65
64
|
data[:character_set_name]
|
66
65
|
end
|
67
66
|
|
68
|
-
#
|
69
|
-
#
|
70
|
-
#
|
67
|
+
# The name of the initial database that was specified for the DB cluster
|
68
|
+
# when it was created, if one was provided. This same name is returned
|
69
|
+
# for the life of the DB cluster.
|
71
70
|
# @return [String]
|
72
71
|
def database_name
|
73
72
|
data[:database_name]
|
74
73
|
end
|
75
74
|
|
76
|
-
#
|
77
|
-
# cluster.
|
75
|
+
# The name of the DB cluster parameter group for the DB cluster.
|
78
76
|
# @return [String]
|
79
77
|
def db_cluster_parameter_group
|
80
78
|
data[:db_cluster_parameter_group]
|
81
79
|
end
|
82
80
|
|
83
|
-
#
|
84
|
-
#
|
85
|
-
# group.
|
81
|
+
# Information about the subnet group associated with the DB cluster,
|
82
|
+
# including the name, description, and subnets in the subnet group.
|
86
83
|
# @return [String]
|
87
84
|
def db_subnet_group
|
88
85
|
data[:db_subnet_group]
|
89
86
|
end
|
90
87
|
|
91
|
-
#
|
88
|
+
# The current state of this DB cluster.
|
92
89
|
# @return [String]
|
93
90
|
def status
|
94
91
|
data[:status]
|
@@ -100,7 +97,7 @@ module Aws::RDS
|
|
100
97
|
data[:automatic_restart_time]
|
101
98
|
end
|
102
99
|
|
103
|
-
#
|
100
|
+
# The progress of the operation as a percentage.
|
104
101
|
# @return [String]
|
105
102
|
def percent_progress
|
106
103
|
data[:percent_progress]
|
@@ -113,8 +110,7 @@ module Aws::RDS
|
|
113
110
|
data[:earliest_restorable_time]
|
114
111
|
end
|
115
112
|
|
116
|
-
#
|
117
|
-
# cluster.
|
113
|
+
# The connection endpoint for the primary instance of the DB cluster.
|
118
114
|
# @return [String]
|
119
115
|
def endpoint
|
120
116
|
data[:endpoint]
|
@@ -136,73 +132,73 @@ module Aws::RDS
|
|
136
132
|
data[:reader_endpoint]
|
137
133
|
end
|
138
134
|
|
139
|
-
#
|
135
|
+
# The custom endpoints associated with the DB cluster.
|
140
136
|
# @return [Array<String>]
|
141
137
|
def custom_endpoints
|
142
138
|
data[:custom_endpoints]
|
143
139
|
end
|
144
140
|
|
145
|
-
#
|
141
|
+
# Indicates whether the DB cluster has instances in multiple
|
146
142
|
# Availability Zones.
|
147
143
|
# @return [Boolean]
|
148
144
|
def multi_az
|
149
145
|
data[:multi_az]
|
150
146
|
end
|
151
147
|
|
152
|
-
# The
|
148
|
+
# The database engine used for this DB cluster.
|
153
149
|
# @return [String]
|
154
150
|
def engine
|
155
151
|
data[:engine]
|
156
152
|
end
|
157
153
|
|
158
|
-
#
|
154
|
+
# The version of the database engine.
|
159
155
|
# @return [String]
|
160
156
|
def engine_version
|
161
157
|
data[:engine_version]
|
162
158
|
end
|
163
159
|
|
164
|
-
#
|
165
|
-
#
|
160
|
+
# The latest time to which a database can be restored with point-in-time
|
161
|
+
# restore.
|
166
162
|
# @return [Time]
|
167
163
|
def latest_restorable_time
|
168
164
|
data[:latest_restorable_time]
|
169
165
|
end
|
170
166
|
|
171
|
-
#
|
167
|
+
# The port that the database engine is listening on.
|
172
168
|
# @return [Integer]
|
173
169
|
def port
|
174
170
|
data[:port]
|
175
171
|
end
|
176
172
|
|
177
|
-
#
|
173
|
+
# The master username for the DB cluster.
|
178
174
|
# @return [String]
|
179
175
|
def master_username
|
180
176
|
data[:master_username]
|
181
177
|
end
|
182
178
|
|
183
|
-
#
|
179
|
+
# The list of option group memberships for this DB cluster.
|
184
180
|
# @return [Array<Types::DBClusterOptionGroupStatus>]
|
185
181
|
def db_cluster_option_group_memberships
|
186
182
|
data[:db_cluster_option_group_memberships]
|
187
183
|
end
|
188
184
|
|
189
|
-
#
|
190
|
-
#
|
185
|
+
# The daily time range during which automated backups are created if
|
186
|
+
# automated backups are enabled, as determined by the
|
191
187
|
# `BackupRetentionPeriod`.
|
192
188
|
# @return [String]
|
193
189
|
def preferred_backup_window
|
194
190
|
data[:preferred_backup_window]
|
195
191
|
end
|
196
192
|
|
197
|
-
#
|
198
|
-
#
|
193
|
+
# The weekly time range during which system maintenance can occur, in
|
194
|
+
# Universal Coordinated Time (UTC).
|
199
195
|
# @return [String]
|
200
196
|
def preferred_maintenance_window
|
201
197
|
data[:preferred_maintenance_window]
|
202
198
|
end
|
203
199
|
|
204
|
-
#
|
205
|
-
#
|
200
|
+
# The identifier of the source DB cluster if this DB cluster is a read
|
201
|
+
# replica.
|
206
202
|
# @return [String]
|
207
203
|
def replication_source_identifier
|
208
204
|
data[:replication_source_identifier]
|
@@ -215,26 +211,25 @@ module Aws::RDS
|
|
215
211
|
data[:read_replica_identifiers]
|
216
212
|
end
|
217
213
|
|
218
|
-
#
|
214
|
+
# The list of DB instances that make up the DB cluster.
|
219
215
|
# @return [Array<Types::DBClusterMember>]
|
220
216
|
def db_cluster_members
|
221
217
|
data[:db_cluster_members]
|
222
218
|
end
|
223
219
|
|
224
|
-
#
|
220
|
+
# The list of VPC security groups that the DB cluster belongs to.
|
225
221
|
# @return [Array<Types::VpcSecurityGroupMembership>]
|
226
222
|
def vpc_security_groups
|
227
223
|
data[:vpc_security_groups]
|
228
224
|
end
|
229
225
|
|
230
|
-
#
|
231
|
-
# zone.
|
226
|
+
# The ID that Amazon Route 53 assigns when you create a hosted zone.
|
232
227
|
# @return [String]
|
233
228
|
def hosted_zone_id
|
234
229
|
data[:hosted_zone_id]
|
235
230
|
end
|
236
231
|
|
237
|
-
#
|
232
|
+
# Indicates whether the DB cluster is encrypted.
|
238
233
|
# @return [Boolean]
|
239
234
|
def storage_encrypted
|
240
235
|
data[:storage_encrypted]
|
@@ -264,31 +259,30 @@ module Aws::RDS
|
|
264
259
|
data[:db_cluster_arn]
|
265
260
|
end
|
266
261
|
|
267
|
-
#
|
268
|
-
#
|
269
|
-
#
|
270
|
-
#
|
262
|
+
# A list of the Amazon Web Services Identity and Access Management (IAM)
|
263
|
+
# roles that are associated with the DB cluster. IAM roles that are
|
264
|
+
# associated with a DB cluster grant permission for the DB cluster to
|
265
|
+
# access other Amazon Web Services on your behalf.
|
271
266
|
# @return [Array<Types::DBClusterRole>]
|
272
267
|
def associated_roles
|
273
268
|
data[:associated_roles]
|
274
269
|
end
|
275
270
|
|
276
|
-
#
|
277
|
-
#
|
278
|
-
# enabled.
|
271
|
+
# Indicates whether the mapping of Amazon Web Services Identity and
|
272
|
+
# Access Management (IAM) accounts to database accounts is enabled.
|
279
273
|
# @return [Boolean]
|
280
274
|
def iam_database_authentication_enabled
|
281
275
|
data[:iam_database_authentication_enabled]
|
282
276
|
end
|
283
277
|
|
284
|
-
#
|
278
|
+
# The ID of the clone group with which the DB cluster is associated.
|
285
279
|
# @return [String]
|
286
280
|
def clone_group_id
|
287
281
|
data[:clone_group_id]
|
288
282
|
end
|
289
283
|
|
290
|
-
#
|
291
|
-
#
|
284
|
+
# The time when the DB cluster was created, in Universal Coordinated
|
285
|
+
# Time (UTC).
|
292
286
|
# @return [Time]
|
293
287
|
def cluster_create_time
|
294
288
|
data[:cluster_create_time]
|
@@ -300,7 +294,7 @@ module Aws::RDS
|
|
300
294
|
data[:earliest_backtrack_time]
|
301
295
|
end
|
302
296
|
|
303
|
-
# The target backtrack window, in seconds. If this value is set to 0
|
297
|
+
# The target backtrack window, in seconds. If this value is set to `0`,
|
304
298
|
# backtracking is disabled for the DB cluster. Otherwise, backtracking
|
305
299
|
# is enabled.
|
306
300
|
# @return [Integer]
|
@@ -330,7 +324,7 @@ module Aws::RDS
|
|
330
324
|
end
|
331
325
|
|
332
326
|
# The current capacity of an Aurora Serverless v1 DB cluster. The
|
333
|
-
# capacity is 0 (zero) when the cluster is paused.
|
327
|
+
# capacity is `0` (zero) when the cluster is paused.
|
334
328
|
#
|
335
329
|
# For more information about Aurora Serverless v1, see [Using Amazon
|
336
330
|
# Aurora Serverless v1][1] in the *Amazon Aurora User Guide*.
|
@@ -356,8 +350,8 @@ module Aws::RDS
|
|
356
350
|
data[:engine_mode]
|
357
351
|
end
|
358
352
|
|
359
|
-
#
|
360
|
-
#
|
353
|
+
# The scaling configuration for an Aurora DB cluster in `serverless` DB
|
354
|
+
# engine mode.
|
361
355
|
#
|
362
356
|
# For more information, see [Using Amazon Aurora Serverless v1][1] in
|
363
357
|
# the *Amazon Aurora User Guide*.
|
@@ -370,15 +364,15 @@ module Aws::RDS
|
|
370
364
|
data[:scaling_configuration_info]
|
371
365
|
end
|
372
366
|
|
373
|
-
# Indicates
|
367
|
+
# Indicates whether the DB cluster has deletion protection enabled. The
|
374
368
|
# database can't be deleted when deletion protection is enabled.
|
375
369
|
# @return [Boolean]
|
376
370
|
def deletion_protection
|
377
371
|
data[:deletion_protection]
|
378
372
|
end
|
379
373
|
|
380
|
-
#
|
381
|
-
#
|
374
|
+
# Indicates whether the HTTP endpoint for an Aurora Serverless v1 DB
|
375
|
+
# cluster is enabled.
|
382
376
|
#
|
383
377
|
# When enabled, the HTTP endpoint provides a connectionless web service
|
384
378
|
# API for running SQL queries on the Aurora Serverless v1 DB cluster.
|
@@ -428,14 +422,14 @@ module Aws::RDS
|
|
428
422
|
data[:activity_stream_kinesis_stream_name]
|
429
423
|
end
|
430
424
|
|
431
|
-
#
|
425
|
+
# Indicates whether tags are copied from the DB cluster to snapshots of
|
432
426
|
# the DB cluster.
|
433
427
|
# @return [Boolean]
|
434
428
|
def copy_tags_to_snapshot
|
435
429
|
data[:copy_tags_to_snapshot]
|
436
430
|
end
|
437
431
|
|
438
|
-
#
|
432
|
+
# Indicates whether the DB cluster is a clone of a DB cluster owned by a
|
439
433
|
# different Amazon Web Services account.
|
440
434
|
# @return [Boolean]
|
441
435
|
def cross_account_clone
|
@@ -460,27 +454,26 @@ module Aws::RDS
|
|
460
454
|
data[:tag_list]
|
461
455
|
end
|
462
456
|
|
463
|
-
#
|
464
|
-
#
|
465
|
-
# enabling it.
|
457
|
+
# The status of write forwarding for a secondary cluster in an Aurora
|
458
|
+
# global database.
|
466
459
|
# @return [String]
|
467
460
|
def global_write_forwarding_status
|
468
461
|
data[:global_write_forwarding_status]
|
469
462
|
end
|
470
463
|
|
471
|
-
# Specifies whether
|
472
|
-
#
|
473
|
-
#
|
474
|
-
#
|
475
|
-
#
|
464
|
+
# Specifies whether write forwarding is enabled for a secondary cluster
|
465
|
+
# in an Aurora global database. Because write forwarding takes time to
|
466
|
+
# enable, check the value of `GlobalWriteForwardingStatus` to confirm
|
467
|
+
# that the request has completed before using the write forwarding
|
468
|
+
# feature for this cluster.
|
476
469
|
# @return [Boolean]
|
477
470
|
def global_write_forwarding_requested
|
478
471
|
data[:global_write_forwarding_requested]
|
479
472
|
end
|
480
473
|
|
481
|
-
#
|
482
|
-
#
|
483
|
-
#
|
474
|
+
# Information about pending changes to the DB cluster. This information
|
475
|
+
# is returned only when there are pending changes. Specific changes are
|
476
|
+
# identified by subelements.
|
484
477
|
# @return [Types::ClusterPendingModifiedValues]
|
485
478
|
def pending_modified_values
|
486
479
|
data[:pending_modified_values]
|
@@ -508,20 +501,20 @@ module Aws::RDS
|
|
508
501
|
data[:iops]
|
509
502
|
end
|
510
503
|
|
511
|
-
#
|
504
|
+
# Indicates whether the DB cluster is publicly accessible.
|
512
505
|
#
|
513
|
-
# When the DB
|
506
|
+
# When the DB cluster is publicly accessible, its Domain Name System
|
514
507
|
# (DNS) endpoint resolves to the private IP address from within the DB
|
515
|
-
#
|
516
|
-
# address from outside of the DB
|
517
|
-
#
|
518
|
-
# public access
|
519
|
-
# DB
|
508
|
+
# cluster's virtual private cloud (VPC). It resolves to the public IP
|
509
|
+
# address from outside of the DB cluster's VPC. Access to the DB
|
510
|
+
# cluster is ultimately controlled by the security group it uses. That
|
511
|
+
# public access isn't permitted if the security group assigned to the
|
512
|
+
# DB cluster doesn't permit it.
|
520
513
|
#
|
521
|
-
# When the DB
|
522
|
-
#
|
514
|
+
# When the DB cluster isn't publicly accessible, it is an internal DB
|
515
|
+
# cluster with a DNS name that resolves to a private IP address.
|
523
516
|
#
|
524
|
-
# For more information, see
|
517
|
+
# For more information, see CreateDBCluster.
|
525
518
|
#
|
526
519
|
# This setting is only for non-Aurora Multi-AZ DB clusters.
|
527
520
|
# @return [Boolean]
|
@@ -529,8 +522,7 @@ module Aws::RDS
|
|
529
522
|
data[:publicly_accessible]
|
530
523
|
end
|
531
524
|
|
532
|
-
#
|
533
|
-
# automatically.
|
525
|
+
# Indicates whether minor version patches are applied automatically.
|
534
526
|
#
|
535
527
|
# This setting is only for non-Aurora Multi-AZ DB clusters.
|
536
528
|
# @return [Boolean]
|
@@ -556,8 +548,7 @@ module Aws::RDS
|
|
556
548
|
data[:monitoring_role_arn]
|
557
549
|
end
|
558
550
|
|
559
|
-
#
|
560
|
-
# otherwise false.
|
551
|
+
# Indicates whether Performance Insights is enabled for the DB cluster.
|
561
552
|
#
|
562
553
|
# This setting is only for non-Aurora Multi-AZ DB clusters.
|
563
554
|
# @return [Boolean]
|
@@ -577,33 +568,27 @@ module Aws::RDS
|
|
577
568
|
data[:performance_insights_kms_key_id]
|
578
569
|
end
|
579
570
|
|
580
|
-
# The number of days to retain Performance Insights data.
|
581
|
-
# 7 days. The following values are valid:
|
582
|
-
#
|
583
|
-
# * 7
|
584
|
-
#
|
585
|
-
# * *month* * 31, where *month* is a number of months from 1-23
|
571
|
+
# The number of days to retain Performance Insights data.
|
586
572
|
#
|
587
|
-
#
|
588
|
-
#
|
589
|
-
# For example, the following values are valid:
|
573
|
+
# This setting is only for non-Aurora Multi-AZ DB clusters.
|
590
574
|
#
|
591
|
-
#
|
575
|
+
# Valid Values:
|
592
576
|
#
|
593
|
-
# *
|
577
|
+
# * `7`
|
594
578
|
#
|
595
|
-
# *
|
579
|
+
# * *month* * 31, where *month* is a number of months from 1-23.
|
580
|
+
# Examples: `93` (3 months * 31), `341` (11 months * 31), `589` (19
|
581
|
+
# months * 31)
|
596
582
|
#
|
597
|
-
# * 731
|
583
|
+
# * `731`
|
598
584
|
#
|
599
|
-
#
|
585
|
+
# Default: `7` days
|
600
586
|
# @return [Integer]
|
601
587
|
def performance_insights_retention_period
|
602
588
|
data[:performance_insights_retention_period]
|
603
589
|
end
|
604
590
|
|
605
|
-
#
|
606
|
-
# cluster.
|
591
|
+
# The scaling configuration for an Aurora Serverless v2 DB cluster.
|
607
592
|
#
|
608
593
|
# For more information, see [Using Amazon Aurora Serverless v2][1] in
|
609
594
|
# the *Amazon Aurora User Guide*.
|
@@ -618,12 +603,6 @@ module Aws::RDS
|
|
618
603
|
|
619
604
|
# The network type of the DB instance.
|
620
605
|
#
|
621
|
-
# Valid values:
|
622
|
-
#
|
623
|
-
# * `IPV4`
|
624
|
-
#
|
625
|
-
# * `DUAL`
|
626
|
-
#
|
627
606
|
# The network type is determined by the `DBSubnetGroup` specified for
|
628
607
|
# the DB cluster. A `DBSubnetGroup` can support only the IPv4 protocol
|
629
608
|
# or the IPv4 and the IPv6 protocols (`DUAL`).
|
@@ -633,6 +612,8 @@ module Aws::RDS
|
|
633
612
|
#
|
634
613
|
# This setting is only for Aurora DB clusters.
|
635
614
|
#
|
615
|
+
# Valid Values: `IPV4 | DUAL`
|
616
|
+
#
|
636
617
|
#
|
637
618
|
#
|
638
619
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html
|
@@ -647,8 +628,8 @@ module Aws::RDS
|
|
647
628
|
data[:db_system_id]
|
648
629
|
end
|
649
630
|
|
650
|
-
#
|
651
|
-
#
|
631
|
+
# The secret managed by RDS in Amazon Web Services Secrets Manager for
|
632
|
+
# the master user password.
|
652
633
|
#
|
653
634
|
# For more information, see [Password management with Amazon Web
|
654
635
|
# Services Secrets Manager][1] in the *Amazon RDS User Guide* and
|
@@ -888,7 +869,7 @@ module Aws::RDS
|
|
888
869
|
# see [Choosing the Regions and Availability Zones][1] in the *Amazon
|
889
870
|
# Aurora User Guide*.
|
890
871
|
#
|
891
|
-
# Valid for: Aurora DB clusters only
|
872
|
+
# Valid for Cluster Type: Aurora DB clusters only
|
892
873
|
#
|
893
874
|
#
|
894
875
|
#
|
@@ -896,68 +877,63 @@ module Aws::RDS
|
|
896
877
|
# @option options [Integer] :backup_retention_period
|
897
878
|
# The number of days for which automated backups are retained.
|
898
879
|
#
|
899
|
-
#
|
880
|
+
# Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
|
881
|
+
#
|
882
|
+
# Default: `1`
|
900
883
|
#
|
901
884
|
# Constraints:
|
902
885
|
#
|
903
|
-
# * Must be a value from 1 to 35
|
886
|
+
# * Must be a value from 1 to 35.
|
904
887
|
#
|
905
888
|
# ^
|
906
|
-
#
|
907
|
-
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
908
889
|
# @option options [String] :character_set_name
|
909
|
-
#
|
910
|
-
#
|
890
|
+
# The name of the character set (`CharacterSet`) to associate the DB
|
891
|
+
# cluster with.
|
911
892
|
#
|
912
|
-
# Valid for: Aurora DB clusters only
|
893
|
+
# Valid for Cluster Type: Aurora DB clusters only
|
913
894
|
# @option options [String] :database_name
|
914
895
|
# The name for your database of up to 64 alphanumeric characters. If you
|
915
|
-
#
|
896
|
+
# don't provide a name, Amazon RDS doesn't create a database in the DB
|
916
897
|
# cluster you are creating.
|
917
898
|
#
|
918
|
-
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
899
|
+
# Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
|
919
900
|
# @option options [String] :db_cluster_parameter_group_name
|
920
901
|
# The name of the DB cluster parameter group to associate with this DB
|
921
|
-
# cluster. If you
|
902
|
+
# cluster. If you don't specify a value, then the default DB cluster
|
922
903
|
# parameter group for the specified DB engine and version is used.
|
923
904
|
#
|
905
|
+
# Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
|
906
|
+
#
|
924
907
|
# Constraints:
|
925
908
|
#
|
926
909
|
# * If supplied, must match the name of an existing DB cluster parameter
|
927
910
|
# group.
|
928
911
|
#
|
929
912
|
# ^
|
930
|
-
#
|
931
|
-
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
932
913
|
# @option options [Array<String>] :vpc_security_group_ids
|
933
914
|
# A list of EC2 VPC security groups to associate with this DB cluster.
|
934
915
|
#
|
935
|
-
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
916
|
+
# Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
|
936
917
|
# @option options [String] :db_subnet_group_name
|
937
918
|
# A DB subnet group to associate with this DB cluster.
|
938
919
|
#
|
939
920
|
# This setting is required to create a Multi-AZ DB cluster.
|
940
921
|
#
|
941
|
-
#
|
942
|
-
# not be default.
|
922
|
+
# Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
|
943
923
|
#
|
944
|
-
#
|
945
|
-
#
|
946
|
-
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
947
|
-
# @option options [required, String] :engine
|
948
|
-
# The name of the database engine to be used for this DB cluster.
|
949
|
-
#
|
950
|
-
# Valid Values:
|
924
|
+
# Constraints:
|
951
925
|
#
|
952
|
-
# *
|
926
|
+
# * Must match the name of an existing DB subnet group.
|
953
927
|
#
|
954
|
-
# * `
|
928
|
+
# * Must not be `default`.
|
955
929
|
#
|
956
|
-
#
|
930
|
+
# Example: `mydbsubnetgroup`
|
931
|
+
# @option options [required, String] :engine
|
932
|
+
# The database engine to use for this DB cluster.
|
957
933
|
#
|
958
|
-
#
|
934
|
+
# Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
|
959
935
|
#
|
960
|
-
# Valid
|
936
|
+
# Valid Values: `aurora-mysql | aurora-postgresql | mysql | postgres`
|
961
937
|
# @option options [String] :engine_version
|
962
938
|
# The version number of the database engine to use.
|
963
939
|
#
|
@@ -989,27 +965,21 @@ module Aws::RDS
|
|
989
965
|
# `aws rds describe-db-engine-versions --engine postgres --query
|
990
966
|
# "DBEngineVersions[].EngineVersion"`
|
991
967
|
#
|
992
|
-
#
|
968
|
+
# For information about a specific engine, see the following topics:
|
993
969
|
#
|
994
|
-
#
|
995
|
-
#
|
970
|
+
# * Aurora MySQL - see [Database engine updates for Amazon Aurora
|
971
|
+
# MySQL][1] in the *Amazon Aurora User Guide*.
|
996
972
|
#
|
997
|
-
#
|
973
|
+
# * Aurora PostgreSQL - see [Amazon Aurora PostgreSQL releases and
|
974
|
+
# engine versions][2] in the *Amazon Aurora User Guide*.
|
998
975
|
#
|
999
|
-
#
|
1000
|
-
#
|
976
|
+
# * RDS for MySQL - see [Amazon RDS for MySQL][3] in the *Amazon RDS
|
977
|
+
# User Guide*.
|
1001
978
|
#
|
1002
|
-
#
|
979
|
+
# * RDS for PostgreSQL - see [Amazon RDS for PostgreSQL][4] in the
|
980
|
+
# *Amazon RDS User Guide*.
|
1003
981
|
#
|
1004
|
-
#
|
1005
|
-
# Guide*.
|
1006
|
-
#
|
1007
|
-
# **PostgreSQL**
|
1008
|
-
#
|
1009
|
-
# For information, see [Amazon RDS for PostgreSQL][4] in the *Amazon RDS
|
1010
|
-
# User Guide*.
|
1011
|
-
#
|
1012
|
-
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
982
|
+
# Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
|
1013
983
|
#
|
1014
984
|
#
|
1015
985
|
#
|
@@ -1021,22 +991,20 @@ module Aws::RDS
|
|
1021
991
|
# The port number on which the instances in the DB cluster accept
|
1022
992
|
# connections.
|
1023
993
|
#
|
1024
|
-
#
|
994
|
+
# Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
|
1025
995
|
#
|
1026
|
-
#
|
996
|
+
# Valid Values: `1150-65535`
|
1027
997
|
#
|
1028
|
-
#
|
998
|
+
# Default:
|
1029
999
|
#
|
1030
|
-
#
|
1000
|
+
# * RDS for MySQL and Aurora MySQL - `3306`
|
1031
1001
|
#
|
1032
|
-
#
|
1033
|
-
#
|
1034
|
-
# Valid values: `1150-65535`
|
1035
|
-
#
|
1036
|
-
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
1002
|
+
# * RDS for PostgreSQL and Aurora PostgreSQL - `5432`
|
1037
1003
|
# @option options [String] :master_username
|
1038
1004
|
# The name of the master user for the DB cluster.
|
1039
1005
|
#
|
1006
|
+
# Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
|
1007
|
+
#
|
1040
1008
|
# Constraints:
|
1041
1009
|
#
|
1042
1010
|
# * Must be 1 to 16 letters or numbers.
|
@@ -1044,22 +1012,21 @@ module Aws::RDS
|
|
1044
1012
|
# * First character must be a letter.
|
1045
1013
|
#
|
1046
1014
|
# * Can't be a reserved word for the chosen database engine.
|
1047
|
-
#
|
1048
|
-
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
1049
1015
|
# @option options [String] :master_user_password
|
1050
|
-
# The password for the master database user.
|
1051
|
-
#
|
1016
|
+
# The password for the master database user.
|
1017
|
+
#
|
1018
|
+
# Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
|
1052
1019
|
#
|
1053
1020
|
# Constraints:
|
1054
1021
|
#
|
1055
1022
|
# * Must contain from 8 to 41 characters.
|
1056
1023
|
#
|
1057
|
-
# * Can
|
1024
|
+
# * Can contain any printable ASCII character except "/", """, or
|
1025
|
+
# "@".
|
1058
1026
|
#
|
1059
|
-
#
|
1027
|
+
# * Can't be specified if `ManageMasterUserPassword` is turned on.
|
1060
1028
|
# @option options [String] :option_group_name
|
1061
|
-
#
|
1062
|
-
# the specified option group.
|
1029
|
+
# The option group to associate the DB cluster with.
|
1063
1030
|
#
|
1064
1031
|
# DB clusters are associated with a default option group that can't be
|
1065
1032
|
# modified.
|
@@ -1068,6 +1035,8 @@ module Aws::RDS
|
|
1068
1035
|
# automated backups are enabled using the `BackupRetentionPeriod`
|
1069
1036
|
# parameter.
|
1070
1037
|
#
|
1038
|
+
# Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
|
1039
|
+
#
|
1071
1040
|
# The default is a 30-minute window selected at random from an 8-hour
|
1072
1041
|
# block of time for each Amazon Web Services Region. To view the time
|
1073
1042
|
# blocks available, see [ Backup window][1] in the *Amazon Aurora User
|
@@ -1083,16 +1052,13 @@ module Aws::RDS
|
|
1083
1052
|
#
|
1084
1053
|
# * Must be at least 30 minutes.
|
1085
1054
|
#
|
1086
|
-
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
1087
|
-
#
|
1088
1055
|
#
|
1089
1056
|
#
|
1090
1057
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Managing.Backups.html#Aurora.Managing.Backups.BackupWindow
|
1091
1058
|
# @option options [String] :preferred_maintenance_window
|
1092
|
-
# The weekly time range during which system maintenance can occur
|
1093
|
-
# Universal Coordinated Time (UTC).
|
1059
|
+
# The weekly time range during which system maintenance can occur.
|
1094
1060
|
#
|
1095
|
-
#
|
1061
|
+
# Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
|
1096
1062
|
#
|
1097
1063
|
# The default is a 30-minute window selected at random from an 8-hour
|
1098
1064
|
# block of time for each Amazon Web Services Region, occurring on a
|
@@ -1100,11 +1066,15 @@ module Aws::RDS
|
|
1100
1066
|
# Adjusting the Preferred DB Cluster Maintenance Window][1] in the
|
1101
1067
|
# *Amazon Aurora User Guide*.
|
1102
1068
|
#
|
1103
|
-
#
|
1069
|
+
# Constraints:
|
1104
1070
|
#
|
1105
|
-
#
|
1071
|
+
# * Must be in the format `ddd:hh24:mi-ddd:hh24:mi`.
|
1106
1072
|
#
|
1107
|
-
#
|
1073
|
+
# * Days must be one of `Mon | Tue | Wed | Thu | Fri | Sat | Sun`.
|
1074
|
+
#
|
1075
|
+
# * Must be in Universal Coordinated Time (UTC).
|
1076
|
+
#
|
1077
|
+
# * Must be at least 30 minutes.
|
1108
1078
|
#
|
1109
1079
|
#
|
1110
1080
|
#
|
@@ -1113,15 +1083,15 @@ module Aws::RDS
|
|
1113
1083
|
# The Amazon Resource Name (ARN) of the source DB instance or DB cluster
|
1114
1084
|
# if this DB cluster is created as a read replica.
|
1115
1085
|
#
|
1116
|
-
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
1086
|
+
# Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
|
1117
1087
|
# @option options [Array<Types::Tag>] :tags
|
1118
1088
|
# Tags to assign to the DB cluster.
|
1119
1089
|
#
|
1120
|
-
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
1090
|
+
# Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
|
1121
1091
|
# @option options [Boolean] :storage_encrypted
|
1122
|
-
#
|
1092
|
+
# Specifies whether the DB cluster is encrypted.
|
1123
1093
|
#
|
1124
|
-
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
1094
|
+
# Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
|
1125
1095
|
# @option options [String] :kms_key_id
|
1126
1096
|
# The Amazon Web Services KMS key identifier for an encrypted DB
|
1127
1097
|
# cluster.
|
@@ -1134,24 +1104,24 @@ module Aws::RDS
|
|
1134
1104
|
# When a KMS key isn't specified in `KmsKeyId`:
|
1135
1105
|
#
|
1136
1106
|
# * If `ReplicationSourceIdentifier` identifies an encrypted source,
|
1137
|
-
# then Amazon RDS
|
1138
|
-
# Otherwise, Amazon RDS
|
1107
|
+
# then Amazon RDS uses the KMS key used to encrypt the source.
|
1108
|
+
# Otherwise, Amazon RDS uses your default KMS key.
|
1139
1109
|
#
|
1140
1110
|
# * If the `StorageEncrypted` parameter is enabled and
|
1141
|
-
# `ReplicationSourceIdentifier` isn't specified, then Amazon RDS
|
1142
|
-
#
|
1111
|
+
# `ReplicationSourceIdentifier` isn't specified, then Amazon RDS uses
|
1112
|
+
# your default KMS key.
|
1143
1113
|
#
|
1144
1114
|
# There is a default KMS key for your Amazon Web Services account. Your
|
1145
1115
|
# Amazon Web Services account has a different default KMS key for each
|
1146
1116
|
# Amazon Web Services Region.
|
1147
1117
|
#
|
1148
1118
|
# If you create a read replica of an encrypted DB cluster in another
|
1149
|
-
# Amazon Web Services Region,
|
1119
|
+
# Amazon Web Services Region, make sure to set `KmsKeyId` to a KMS key
|
1150
1120
|
# identifier that is valid in the destination Amazon Web Services
|
1151
1121
|
# Region. This KMS key is used to encrypt the read replica in that
|
1152
1122
|
# Amazon Web Services Region.
|
1153
1123
|
#
|
1154
|
-
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
1124
|
+
# Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
|
1155
1125
|
# @option options [String] :pre_signed_url
|
1156
1126
|
# When you are replicating a DB cluster from one Amazon Web Services
|
1157
1127
|
# GovCloud (US) Region to another, an URL that contains a Signature
|
@@ -1197,30 +1167,32 @@ module Aws::RDS
|
|
1197
1167
|
#
|
1198
1168
|
# </note>
|
1199
1169
|
#
|
1200
|
-
# Valid for: Aurora DB clusters only
|
1170
|
+
# Valid for Cluster Type: Aurora DB clusters only
|
1201
1171
|
#
|
1202
1172
|
#
|
1203
1173
|
#
|
1204
1174
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/API/sigv4-query-string-auth.html
|
1205
1175
|
# [2]: https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html
|
1206
1176
|
# @option options [Boolean] :enable_iam_database_authentication
|
1207
|
-
#
|
1208
|
-
#
|
1209
|
-
#
|
1177
|
+
# Specifies whether to enable mapping of Amazon Web Services Identity
|
1178
|
+
# and Access Management (IAM) accounts to database accounts. By default,
|
1179
|
+
# mapping isn't enabled.
|
1210
1180
|
#
|
1211
1181
|
# For more information, see [ IAM Database Authentication][1] in the
|
1212
1182
|
# *Amazon Aurora User Guide*.
|
1213
1183
|
#
|
1214
|
-
# Valid for: Aurora DB clusters only
|
1184
|
+
# Valid for Cluster Type: Aurora DB clusters only
|
1215
1185
|
#
|
1216
1186
|
#
|
1217
1187
|
#
|
1218
1188
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.IAMDBAuth.html
|
1219
1189
|
# @option options [Integer] :backtrack_window
|
1220
1190
|
# The target backtrack window, in seconds. To disable backtracking, set
|
1221
|
-
# this value to 0
|
1191
|
+
# this value to `0`.
|
1222
1192
|
#
|
1223
|
-
#
|
1193
|
+
# Valid for Cluster Type: Aurora MySQL DB clusters only
|
1194
|
+
#
|
1195
|
+
# Default: `0`
|
1224
1196
|
#
|
1225
1197
|
# Constraints:
|
1226
1198
|
#
|
@@ -1228,28 +1200,21 @@ module Aws::RDS
|
|
1228
1200
|
# (72 hours).
|
1229
1201
|
#
|
1230
1202
|
# ^
|
1231
|
-
#
|
1232
|
-
# Valid for: Aurora MySQL DB clusters only
|
1233
1203
|
# @option options [Array<String>] :enable_cloudwatch_logs_exports
|
1234
1204
|
# The list of log types that need to be enabled for exporting to
|
1235
|
-
# CloudWatch Logs.
|
1236
|
-
# used.
|
1237
|
-
#
|
1238
|
-
# **RDS for MySQL**
|
1205
|
+
# CloudWatch Logs.
|
1239
1206
|
#
|
1240
|
-
#
|
1207
|
+
# Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
|
1241
1208
|
#
|
1242
|
-
#
|
1209
|
+
# The following values are valid for each DB engine:
|
1243
1210
|
#
|
1244
|
-
#
|
1211
|
+
# * Aurora MySQL - `audit | error | general | slowquery`
|
1245
1212
|
#
|
1246
|
-
#
|
1213
|
+
# * Aurora PostgreSQL - `postgresql`
|
1247
1214
|
#
|
1248
|
-
#
|
1249
|
-
#
|
1250
|
-
# **Aurora PostgreSQL**
|
1215
|
+
# * RDS for MySQL - `error | general | slowquery`
|
1251
1216
|
#
|
1252
|
-
#
|
1217
|
+
# * RDS for PostgreSQL - `postgresql | upgrade`
|
1253
1218
|
#
|
1254
1219
|
# For more information about exporting CloudWatch Logs for Amazon RDS,
|
1255
1220
|
# see [Publishing Database Logs to Amazon CloudWatch Logs][1] in the
|
@@ -1259,8 +1224,6 @@ module Aws::RDS
|
|
1259
1224
|
# Aurora, see [Publishing Database Logs to Amazon CloudWatch Logs][2] in
|
1260
1225
|
# the *Amazon Aurora User Guide*.
|
1261
1226
|
#
|
1262
|
-
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
1263
|
-
#
|
1264
1227
|
#
|
1265
1228
|
#
|
1266
1229
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch
|
@@ -1280,7 +1243,7 @@ module Aws::RDS
|
|
1280
1243
|
#
|
1281
1244
|
# * [Requirements for Aurora Serverless v2][2]
|
1282
1245
|
#
|
1283
|
-
# Valid for: Aurora DB clusters only
|
1246
|
+
# Valid for Cluster Type: Aurora DB clusters only
|
1284
1247
|
#
|
1285
1248
|
#
|
1286
1249
|
#
|
@@ -1290,22 +1253,21 @@ module Aws::RDS
|
|
1290
1253
|
# For DB clusters in `serverless` DB engine mode, the scaling properties
|
1291
1254
|
# of the DB cluster.
|
1292
1255
|
#
|
1293
|
-
# Valid for: Aurora DB clusters only
|
1256
|
+
# Valid for Cluster Type: Aurora DB clusters only
|
1294
1257
|
# @option options [Boolean] :deletion_protection
|
1295
|
-
#
|
1296
|
-
#
|
1297
|
-
#
|
1258
|
+
# Specifies whether the DB cluster has deletion protection enabled. The
|
1259
|
+
# database can't be deleted when deletion protection is enabled. By
|
1260
|
+
# default, deletion protection isn't enabled.
|
1298
1261
|
#
|
1299
|
-
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
1262
|
+
# Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
|
1300
1263
|
# @option options [String] :global_cluster_identifier
|
1301
1264
|
# The global cluster ID of an Aurora cluster that becomes the primary
|
1302
1265
|
# cluster in the new global database cluster.
|
1303
1266
|
#
|
1304
|
-
# Valid for: Aurora DB clusters only
|
1267
|
+
# Valid for Cluster Type: Aurora DB clusters only
|
1305
1268
|
# @option options [Boolean] :enable_http_endpoint
|
1306
|
-
#
|
1307
|
-
#
|
1308
|
-
# disabled.
|
1269
|
+
# Specifies whether to enable the HTTP endpoint for an Aurora Serverless
|
1270
|
+
# v1 DB cluster. By default, the HTTP endpoint is disabled.
|
1309
1271
|
#
|
1310
1272
|
# When enabled, the HTTP endpoint provides a connectionless web service
|
1311
1273
|
# API for running SQL queries on the Aurora Serverless v1 DB cluster.
|
@@ -1315,16 +1277,16 @@ module Aws::RDS
|
|
1315
1277
|
# For more information, see [Using the Data API for Aurora Serverless
|
1316
1278
|
# v1][1] in the *Amazon Aurora User Guide*.
|
1317
1279
|
#
|
1318
|
-
# Valid for: Aurora DB clusters only
|
1280
|
+
# Valid for Cluster Type: Aurora DB clusters only
|
1319
1281
|
#
|
1320
1282
|
#
|
1321
1283
|
#
|
1322
1284
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/data-api.html
|
1323
1285
|
# @option options [Boolean] :copy_tags_to_snapshot
|
1324
|
-
#
|
1325
|
-
#
|
1286
|
+
# Specifies whether to copy all tags from the DB cluster to snapshots of
|
1287
|
+
# the DB cluster. The default is not to copy them.
|
1326
1288
|
#
|
1327
|
-
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
1289
|
+
# Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
|
1328
1290
|
# @option options [String] :domain
|
1329
1291
|
# The Active Directory directory ID to create the DB cluster in.
|
1330
1292
|
#
|
@@ -1334,35 +1296,34 @@ module Aws::RDS
|
|
1334
1296
|
# For more information, see [Kerberos authentication][1] in the *Amazon
|
1335
1297
|
# Aurora User Guide*.
|
1336
1298
|
#
|
1337
|
-
# Valid for: Aurora DB clusters only
|
1299
|
+
# Valid for Cluster Type: Aurora DB clusters only
|
1338
1300
|
#
|
1339
1301
|
#
|
1340
1302
|
#
|
1341
1303
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/kerberos-authentication.html
|
1342
1304
|
# @option options [String] :domain_iam_role_name
|
1343
|
-
#
|
1344
|
-
#
|
1305
|
+
# The name of the IAM role to use when making API calls to the Directory
|
1306
|
+
# Service.
|
1345
1307
|
#
|
1346
|
-
# Valid for: Aurora DB clusters only
|
1308
|
+
# Valid for Cluster Type: Aurora DB clusters only
|
1347
1309
|
# @option options [Boolean] :enable_global_write_forwarding
|
1348
|
-
#
|
1349
|
-
#
|
1350
|
-
#
|
1351
|
-
#
|
1352
|
-
# database.
|
1310
|
+
# Specifies whether to enable this DB cluster to forward write
|
1311
|
+
# operations to the primary cluster of a global cluster (Aurora global
|
1312
|
+
# database). By default, write operations are not allowed on Aurora DB
|
1313
|
+
# clusters that are secondary clusters in an Aurora global database.
|
1353
1314
|
#
|
1354
1315
|
# You can set this value only on Aurora DB clusters that are members of
|
1355
1316
|
# an Aurora global database. With this parameter enabled, a secondary
|
1356
|
-
# cluster can forward writes to the current primary cluster and the
|
1317
|
+
# cluster can forward writes to the current primary cluster, and the
|
1357
1318
|
# resulting changes are replicated back to this cluster. For the primary
|
1358
1319
|
# DB cluster of an Aurora global database, this value is used
|
1359
|
-
# immediately if the primary is demoted by
|
1320
|
+
# immediately if the primary is demoted by a global cluster API
|
1360
1321
|
# operation, but it does nothing until then.
|
1361
1322
|
#
|
1362
|
-
# Valid for: Aurora DB clusters only
|
1323
|
+
# Valid for Cluster Type: Aurora DB clusters only
|
1363
1324
|
# @option options [String] :db_cluster_instance_class
|
1364
1325
|
# The compute and memory capacity of each DB instance in the Multi-AZ DB
|
1365
|
-
# cluster, for example db.m6gd.xlarge
|
1326
|
+
# cluster, for example `db.m6gd.xlarge`. Not all DB instance classes are
|
1366
1327
|
# available in all Amazon Web Services Regions, or for all database
|
1367
1328
|
# engines.
|
1368
1329
|
#
|
@@ -1371,7 +1332,7 @@ module Aws::RDS
|
|
1371
1332
|
#
|
1372
1333
|
# This setting is required to create a Multi-AZ DB cluster.
|
1373
1334
|
#
|
1374
|
-
# Valid for: Multi-AZ DB clusters only
|
1335
|
+
# Valid for Cluster Type: Multi-AZ DB clusters only
|
1375
1336
|
#
|
1376
1337
|
#
|
1377
1338
|
#
|
@@ -1380,28 +1341,35 @@ module Aws::RDS
|
|
1380
1341
|
# The amount of storage in gibibytes (GiB) to allocate to each DB
|
1381
1342
|
# instance in the Multi-AZ DB cluster.
|
1382
1343
|
#
|
1383
|
-
#
|
1344
|
+
# Valid for Cluster Type: Multi-AZ DB clusters only
|
1384
1345
|
#
|
1385
|
-
#
|
1346
|
+
# This setting is required to create a Multi-AZ DB cluster.
|
1386
1347
|
# @option options [String] :storage_type
|
1387
|
-
#
|
1348
|
+
# The storage type to associate with the DB cluster.
|
1349
|
+
#
|
1350
|
+
# For information on storage types for Aurora DB clusters, see [Storage
|
1351
|
+
# configurations for Amazon Aurora DB clusters][1]. For information on
|
1352
|
+
# storage types for Multi-AZ DB clusters, see [Settings for creating
|
1353
|
+
# Multi-AZ DB clusters][2].
|
1388
1354
|
#
|
1389
1355
|
# This setting is required to create a Multi-AZ DB cluster.
|
1390
1356
|
#
|
1391
1357
|
# When specified for a Multi-AZ DB cluster, a value for the `Iops`
|
1392
1358
|
# parameter is required.
|
1393
1359
|
#
|
1394
|
-
# Valid
|
1395
|
-
# (Multi-AZ DB clusters)
|
1360
|
+
# Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
|
1396
1361
|
#
|
1397
|
-
#
|
1362
|
+
# Valid Values:
|
1398
1363
|
#
|
1399
|
-
#
|
1364
|
+
# * Aurora DB clusters - `aurora | aurora-iopt1`
|
1365
|
+
#
|
1366
|
+
# * Multi-AZ DB clusters - `io1`
|
1367
|
+
#
|
1368
|
+
# Default:
|
1369
|
+
#
|
1370
|
+
# * Aurora DB clusters - `aurora`
|
1400
1371
|
#
|
1401
|
-
#
|
1402
|
-
# [Storage configurations for Amazon Aurora DB clusters][1]. For more
|
1403
|
-
# information on storage types for Multi-AZ DB clusters, see [Settings
|
1404
|
-
# for creating Multi-AZ DB clusters][2].
|
1372
|
+
# * Multi-AZ DB clusters - `io1`
|
1405
1373
|
#
|
1406
1374
|
#
|
1407
1375
|
#
|
@@ -1417,16 +1385,20 @@ module Aws::RDS
|
|
1417
1385
|
#
|
1418
1386
|
# This setting is required to create a Multi-AZ DB cluster.
|
1419
1387
|
#
|
1420
|
-
#
|
1421
|
-
# amount for the DB cluster.
|
1388
|
+
# Valid for Cluster Type: Multi-AZ DB clusters only
|
1422
1389
|
#
|
1423
|
-
#
|
1390
|
+
# Constraints:
|
1391
|
+
#
|
1392
|
+
# * Must be a multiple between .5 and 50 of the storage amount for the
|
1393
|
+
# DB cluster.
|
1394
|
+
#
|
1395
|
+
# ^
|
1424
1396
|
#
|
1425
1397
|
#
|
1426
1398
|
#
|
1427
1399
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Storage.html#USER_PIOPS
|
1428
1400
|
# @option options [Boolean] :publicly_accessible
|
1429
|
-
#
|
1401
|
+
# Specifies whether the DB cluster is publicly accessible.
|
1430
1402
|
#
|
1431
1403
|
# When the DB cluster is publicly accessible, its Domain Name System
|
1432
1404
|
# (DNS) endpoint resolves to the private IP address from within the DB
|
@@ -1439,6 +1411,8 @@ module Aws::RDS
|
|
1439
1411
|
# When the DB cluster isn't publicly accessible, it is an internal DB
|
1440
1412
|
# cluster with a DNS name that resolves to a private IP address.
|
1441
1413
|
#
|
1414
|
+
# Valid for Cluster Type: Multi-AZ DB clusters only
|
1415
|
+
#
|
1442
1416
|
# Default: The default behavior varies depending on whether
|
1443
1417
|
# `DBSubnetGroupName` is specified.
|
1444
1418
|
#
|
@@ -1459,25 +1433,25 @@ module Aws::RDS
|
|
1459
1433
|
#
|
1460
1434
|
# * If the subnets are part of a VPC that has an internet gateway
|
1461
1435
|
# attached to it, the DB cluster is public.
|
1462
|
-
#
|
1463
|
-
# Valid for: Multi-AZ DB clusters only
|
1464
1436
|
# @option options [Boolean] :auto_minor_version_upgrade
|
1465
|
-
#
|
1466
|
-
#
|
1467
|
-
#
|
1437
|
+
# Specifies whether minor engine upgrades are applied automatically to
|
1438
|
+
# the DB cluster during the maintenance window. By default, minor engine
|
1439
|
+
# upgrades are applied automatically.
|
1468
1440
|
#
|
1469
|
-
# Valid for: Multi-AZ DB clusters only
|
1441
|
+
# Valid for Cluster Type: Multi-AZ DB clusters only
|
1470
1442
|
# @option options [Integer] :monitoring_interval
|
1471
1443
|
# The interval, in seconds, between points when Enhanced Monitoring
|
1472
1444
|
# metrics are collected for the DB cluster. To turn off collecting
|
1473
|
-
# Enhanced Monitoring metrics, specify 0
|
1445
|
+
# Enhanced Monitoring metrics, specify `0`.
|
1474
1446
|
#
|
1475
1447
|
# If `MonitoringRoleArn` is specified, also set `MonitoringInterval` to
|
1476
|
-
# a value other than 0
|
1448
|
+
# a value other than `0`.
|
1477
1449
|
#
|
1478
|
-
# Valid
|
1450
|
+
# Valid for Cluster Type: Multi-AZ DB clusters only
|
1479
1451
|
#
|
1480
|
-
# Valid
|
1452
|
+
# Valid Values: `0 | 1 | 5 | 10 | 15 | 30 | 60`
|
1453
|
+
#
|
1454
|
+
# Default: `0`
|
1481
1455
|
# @option options [String] :monitoring_role_arn
|
1482
1456
|
# The Amazon Resource Name (ARN) for the IAM role that permits RDS to
|
1483
1457
|
# send Enhanced Monitoring metrics to Amazon CloudWatch Logs. An example
|
@@ -1485,22 +1459,21 @@ module Aws::RDS
|
|
1485
1459
|
# creating a monitoring role, see [Setting up and enabling Enhanced
|
1486
1460
|
# Monitoring][1] in the *Amazon RDS User Guide*.
|
1487
1461
|
#
|
1488
|
-
# If `MonitoringInterval` is set to a value other than 0
|
1462
|
+
# If `MonitoringInterval` is set to a value other than `0`, supply a
|
1489
1463
|
# `MonitoringRoleArn` value.
|
1490
1464
|
#
|
1491
|
-
# Valid for: Multi-AZ DB clusters only
|
1465
|
+
# Valid for Cluster Type: Multi-AZ DB clusters only
|
1492
1466
|
#
|
1493
1467
|
#
|
1494
1468
|
#
|
1495
1469
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Monitoring.OS.html#USER_Monitoring.OS.Enabling
|
1496
1470
|
# @option options [Boolean] :enable_performance_insights
|
1497
|
-
#
|
1498
|
-
# DB cluster.
|
1471
|
+
# Specifies whether to turn on Performance Insights for the DB cluster.
|
1499
1472
|
#
|
1500
1473
|
# For more information, see [ Using Amazon Performance Insights][1] in
|
1501
1474
|
# the *Amazon RDS User Guide*.
|
1502
1475
|
#
|
1503
|
-
# Valid for: Multi-AZ DB clusters only
|
1476
|
+
# Valid for Cluster Type: Multi-AZ DB clusters only
|
1504
1477
|
#
|
1505
1478
|
#
|
1506
1479
|
#
|
@@ -1517,31 +1490,26 @@ module Aws::RDS
|
|
1517
1490
|
# your Amazon Web Services account. Your Amazon Web Services account has
|
1518
1491
|
# a different default KMS key for each Amazon Web Services Region.
|
1519
1492
|
#
|
1520
|
-
# Valid for: Multi-AZ DB clusters only
|
1493
|
+
# Valid for Cluster Type: Multi-AZ DB clusters only
|
1521
1494
|
# @option options [Integer] :performance_insights_retention_period
|
1522
|
-
# The number of days to retain Performance Insights data.
|
1523
|
-
# 7 days. The following values are valid:
|
1524
|
-
#
|
1525
|
-
# * 7
|
1495
|
+
# The number of days to retain Performance Insights data.
|
1526
1496
|
#
|
1527
|
-
#
|
1497
|
+
# Valid for Cluster Type: Multi-AZ DB clusters only
|
1528
1498
|
#
|
1529
|
-
#
|
1530
|
-
#
|
1531
|
-
# For example, the following values are valid:
|
1532
|
-
#
|
1533
|
-
# * 93 (3 months * 31)
|
1499
|
+
# Valid Values:
|
1534
1500
|
#
|
1535
|
-
# *
|
1501
|
+
# * `7`
|
1536
1502
|
#
|
1537
|
-
# *
|
1503
|
+
# * *month* * 31, where *month* is a number of months from 1-23.
|
1504
|
+
# Examples: `93` (3 months * 31), `341` (11 months * 31), `589` (19
|
1505
|
+
# months * 31)
|
1538
1506
|
#
|
1539
|
-
# * 731
|
1507
|
+
# * `731`
|
1540
1508
|
#
|
1541
|
-
#
|
1542
|
-
# value, RDS issues an error.
|
1509
|
+
# Default: `7` days
|
1543
1510
|
#
|
1544
|
-
#
|
1511
|
+
# If you specify a retention period that isn't valid, such as `94`,
|
1512
|
+
# Amazon RDS issues an error.
|
1545
1513
|
# @option options [Types::ServerlessV2ScalingConfiguration] :serverless_v2_scaling_configuration
|
1546
1514
|
# Contains the scaling configuration of an Aurora Serverless v2 DB
|
1547
1515
|
# cluster.
|
@@ -1555,12 +1523,6 @@ module Aws::RDS
|
|
1555
1523
|
# @option options [String] :network_type
|
1556
1524
|
# The network type of the DB cluster.
|
1557
1525
|
#
|
1558
|
-
# Valid values:
|
1559
|
-
#
|
1560
|
-
# * `IPV4`
|
1561
|
-
#
|
1562
|
-
# * `DUAL`
|
1563
|
-
#
|
1564
1526
|
# The network type is determined by the `DBSubnetGroup` specified for
|
1565
1527
|
# the DB cluster. A `DBSubnetGroup` can support only the IPv4 protocol
|
1566
1528
|
# or the IPv4 and the IPv6 protocols (`DUAL`).
|
@@ -1568,7 +1530,9 @@ module Aws::RDS
|
|
1568
1530
|
# For more information, see [ Working with a DB instance in a VPC][1] in
|
1569
1531
|
# the *Amazon Aurora User Guide.*
|
1570
1532
|
#
|
1571
|
-
# Valid for: Aurora DB clusters only
|
1533
|
+
# Valid for Cluster Type: Aurora DB clusters only
|
1534
|
+
#
|
1535
|
+
# Valid Values: `IPV4 | DUAL`
|
1572
1536
|
#
|
1573
1537
|
#
|
1574
1538
|
#
|
@@ -1576,14 +1540,16 @@ module Aws::RDS
|
|
1576
1540
|
# @option options [String] :db_system_id
|
1577
1541
|
# Reserved for future use.
|
1578
1542
|
# @option options [Boolean] :manage_master_user_password
|
1579
|
-
#
|
1580
|
-
#
|
1543
|
+
# Specifies whether to manage the master user password with Amazon Web
|
1544
|
+
# Services Secrets Manager.
|
1581
1545
|
#
|
1582
1546
|
# For more information, see [Password management with Amazon Web
|
1583
1547
|
# Services Secrets Manager][1] in the *Amazon RDS User Guide* and
|
1584
1548
|
# [Password management with Amazon Web Services Secrets Manager][2] in
|
1585
1549
|
# the *Amazon Aurora User Guide.*
|
1586
1550
|
#
|
1551
|
+
# Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
|
1552
|
+
#
|
1587
1553
|
# Constraints:
|
1588
1554
|
#
|
1589
1555
|
# * Can't manage the master user password with Amazon Web Services
|
@@ -1591,8 +1557,6 @@ module Aws::RDS
|
|
1591
1557
|
#
|
1592
1558
|
# ^
|
1593
1559
|
#
|
1594
|
-
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
1595
|
-
#
|
1596
1560
|
#
|
1597
1561
|
#
|
1598
1562
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html
|
@@ -1620,7 +1584,7 @@ module Aws::RDS
|
|
1620
1584
|
# Amazon Web Services account has a different default KMS key for each
|
1621
1585
|
# Amazon Web Services Region.
|
1622
1586
|
#
|
1623
|
-
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
1587
|
+
# Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
|
1624
1588
|
# @option options [String] :source_region
|
1625
1589
|
# The source region of the snapshot. This is only needed when the
|
1626
1590
|
# shapshot is encrypted and in a different region.
|
@@ -1816,23 +1780,23 @@ module Aws::RDS
|
|
1816
1780
|
# The new DB cluster identifier for the DB cluster when renaming a DB
|
1817
1781
|
# cluster. This value is stored as a lowercase string.
|
1818
1782
|
#
|
1783
|
+
# Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
|
1784
|
+
#
|
1819
1785
|
# Constraints:
|
1820
1786
|
#
|
1821
|
-
# * Must contain from 1 to 63 letters, numbers, or hyphens
|
1787
|
+
# * Must contain from 1 to 63 letters, numbers, or hyphens.
|
1822
1788
|
#
|
1823
|
-
# * The first character must be a letter
|
1789
|
+
# * The first character must be a letter.
|
1824
1790
|
#
|
1825
|
-
# * Can't end with a hyphen or contain two consecutive hyphens
|
1791
|
+
# * Can't end with a hyphen or contain two consecutive hyphens.
|
1826
1792
|
#
|
1827
1793
|
# Example: `my-cluster2`
|
1828
|
-
#
|
1829
|
-
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
1830
1794
|
# @option options [Boolean] :apply_immediately
|
1831
|
-
#
|
1832
|
-
#
|
1833
|
-
#
|
1834
|
-
#
|
1835
|
-
#
|
1795
|
+
# Specifies whether the modifications in this request and any pending
|
1796
|
+
# modifications are asynchronously applied as soon as possible,
|
1797
|
+
# regardless of the `PreferredMaintenanceWindow` setting for the DB
|
1798
|
+
# cluster. If this parameter is disabled, changes to the DB cluster are
|
1799
|
+
# applied during the next maintenance window.
|
1836
1800
|
#
|
1837
1801
|
# Most modifications can be applied immediately or during the next
|
1838
1802
|
# scheduled maintenance window. Some modifications, such as turning on
|
@@ -1841,50 +1805,51 @@ module Aws::RDS
|
|
1841
1805
|
#
|
1842
1806
|
# By default, this parameter is disabled.
|
1843
1807
|
#
|
1844
|
-
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
1808
|
+
# Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
|
1845
1809
|
# @option options [Integer] :backup_retention_period
|
1846
1810
|
# The number of days for which automated backups are retained. Specify a
|
1847
|
-
# minimum value of 1
|
1811
|
+
# minimum value of `1`.
|
1812
|
+
#
|
1813
|
+
# Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
|
1848
1814
|
#
|
1849
|
-
# Default: 1
|
1815
|
+
# Default: `1`
|
1850
1816
|
#
|
1851
1817
|
# Constraints:
|
1852
1818
|
#
|
1853
|
-
# * Must be a value from 1 to 35
|
1819
|
+
# * Must be a value from 1 to 35.
|
1854
1820
|
#
|
1855
1821
|
# ^
|
1856
|
-
#
|
1857
|
-
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
1858
1822
|
# @option options [String] :db_cluster_parameter_group_name
|
1859
1823
|
# The name of the DB cluster parameter group to use for the DB cluster.
|
1860
1824
|
#
|
1861
|
-
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
1825
|
+
# Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
|
1862
1826
|
# @option options [Array<String>] :vpc_security_group_ids
|
1863
|
-
# A list of VPC security groups
|
1827
|
+
# A list of EC2 VPC security groups to associate with this DB cluster.
|
1864
1828
|
#
|
1865
|
-
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
1829
|
+
# Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
|
1866
1830
|
# @option options [Integer] :port
|
1867
1831
|
# The port number on which the DB cluster accepts connections.
|
1868
1832
|
#
|
1869
|
-
#
|
1833
|
+
# Valid for Cluster Type: Aurora DB clusters only
|
1870
1834
|
#
|
1871
|
-
#
|
1835
|
+
# Valid Values: `1150-65535`
|
1872
1836
|
#
|
1873
|
-
#
|
1837
|
+
# Default: The same port as the original DB cluster.
|
1874
1838
|
# @option options [String] :master_user_password
|
1875
|
-
# The new password for the master database user.
|
1876
|
-
#
|
1839
|
+
# The new password for the master database user.
|
1840
|
+
#
|
1841
|
+
# Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
|
1877
1842
|
#
|
1878
1843
|
# Constraints:
|
1879
1844
|
#
|
1880
1845
|
# * Must contain from 8 to 41 characters.
|
1881
1846
|
#
|
1882
|
-
# * Can
|
1847
|
+
# * Can contain any printable ASCII character except "/", """, or
|
1848
|
+
# "@".
|
1883
1849
|
#
|
1884
|
-
#
|
1850
|
+
# * Can't be specified if `ManageMasterUserPassword` is turned on.
|
1885
1851
|
# @option options [String] :option_group_name
|
1886
|
-
#
|
1887
|
-
# the specified option group.
|
1852
|
+
# The option group to associate the DB cluster with.
|
1888
1853
|
#
|
1889
1854
|
# DB clusters are associated with a default option group that can't be
|
1890
1855
|
# modified.
|
@@ -1898,6 +1863,8 @@ module Aws::RDS
|
|
1898
1863
|
# blocks available, see [ Backup window][1] in the *Amazon Aurora User
|
1899
1864
|
# Guide*.
|
1900
1865
|
#
|
1866
|
+
# Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
|
1867
|
+
#
|
1901
1868
|
# Constraints:
|
1902
1869
|
#
|
1903
1870
|
# * Must be in the format `hh24:mi-hh24:mi`.
|
@@ -1908,8 +1875,6 @@ module Aws::RDS
|
|
1908
1875
|
#
|
1909
1876
|
# * Must be at least 30 minutes.
|
1910
1877
|
#
|
1911
|
-
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
1912
|
-
#
|
1913
1878
|
#
|
1914
1879
|
#
|
1915
1880
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Managing.Backups.html#Aurora.Managing.Backups.BackupWindow
|
@@ -1917,7 +1882,7 @@ module Aws::RDS
|
|
1917
1882
|
# The weekly time range during which system maintenance can occur, in
|
1918
1883
|
# Universal Coordinated Time (UTC).
|
1919
1884
|
#
|
1920
|
-
#
|
1885
|
+
# Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
|
1921
1886
|
#
|
1922
1887
|
# The default is a 30-minute window selected at random from an 8-hour
|
1923
1888
|
# block of time for each Amazon Web Services Region, occurring on a
|
@@ -1925,33 +1890,39 @@ module Aws::RDS
|
|
1925
1890
|
# Adjusting the Preferred DB Cluster Maintenance Window][1] in the
|
1926
1891
|
# *Amazon Aurora User Guide*.
|
1927
1892
|
#
|
1928
|
-
#
|
1893
|
+
# Constraints:
|
1929
1894
|
#
|
1930
|
-
#
|
1895
|
+
# * Must be in the format `ddd:hh24:mi-ddd:hh24:mi`.
|
1931
1896
|
#
|
1932
|
-
#
|
1897
|
+
# * Days must be one of `Mon | Tue | Wed | Thu | Fri | Sat | Sun`.
|
1898
|
+
#
|
1899
|
+
# * Must be in Universal Coordinated Time (UTC).
|
1900
|
+
#
|
1901
|
+
# * Must be at least 30 minutes.
|
1933
1902
|
#
|
1934
1903
|
#
|
1935
1904
|
#
|
1936
1905
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_UpgradeDBInstance.Maintenance.html#AdjustingTheMaintenanceWindow.Aurora
|
1937
1906
|
# @option options [Boolean] :enable_iam_database_authentication
|
1938
|
-
#
|
1939
|
-
#
|
1940
|
-
#
|
1907
|
+
# Specifies whether to enable mapping of Amazon Web Services Identity
|
1908
|
+
# and Access Management (IAM) accounts to database accounts. By default,
|
1909
|
+
# mapping isn't enabled.
|
1941
1910
|
#
|
1942
1911
|
# For more information, see [ IAM Database Authentication][1] in the
|
1943
1912
|
# *Amazon Aurora User Guide*.
|
1944
1913
|
#
|
1945
|
-
# Valid for: Aurora DB clusters only
|
1914
|
+
# Valid for Cluster Type: Aurora DB clusters only
|
1946
1915
|
#
|
1947
1916
|
#
|
1948
1917
|
#
|
1949
1918
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.IAMDBAuth.html
|
1950
1919
|
# @option options [Integer] :backtrack_window
|
1951
1920
|
# The target backtrack window, in seconds. To disable backtracking, set
|
1952
|
-
# this value to 0
|
1921
|
+
# this value to `0`.
|
1953
1922
|
#
|
1954
|
-
#
|
1923
|
+
# Valid for Cluster Type: Aurora MySQL DB clusters only
|
1924
|
+
#
|
1925
|
+
# Default: `0`
|
1955
1926
|
#
|
1956
1927
|
# Constraints:
|
1957
1928
|
#
|
@@ -1959,28 +1930,21 @@ module Aws::RDS
|
|
1959
1930
|
# (72 hours).
|
1960
1931
|
#
|
1961
1932
|
# ^
|
1962
|
-
#
|
1963
|
-
# Valid for: Aurora MySQL DB clusters only
|
1964
1933
|
# @option options [Types::CloudwatchLogsExportConfiguration] :cloudwatch_logs_export_configuration
|
1965
1934
|
# The configuration setting for the log types to be enabled for export
|
1966
|
-
# to CloudWatch Logs for a specific DB cluster.
|
1967
|
-
# depend on the DB engine being used.
|
1968
|
-
#
|
1969
|
-
# **RDS for MySQL**
|
1935
|
+
# to CloudWatch Logs for a specific DB cluster.
|
1970
1936
|
#
|
1971
|
-
#
|
1937
|
+
# Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
|
1972
1938
|
#
|
1973
|
-
#
|
1939
|
+
# The following values are valid for each DB engine:
|
1974
1940
|
#
|
1975
|
-
#
|
1941
|
+
# * Aurora MySQL - `audit | error | general | slowquery`
|
1976
1942
|
#
|
1977
|
-
#
|
1943
|
+
# * Aurora PostgreSQL - `postgresql`
|
1978
1944
|
#
|
1979
|
-
#
|
1980
|
-
#
|
1981
|
-
# **Aurora PostgreSQL**
|
1945
|
+
# * RDS for MySQL - `error | general | slowquery`
|
1982
1946
|
#
|
1983
|
-
#
|
1947
|
+
# * RDS for PostgreSQL - `postgresql | upgrade`
|
1984
1948
|
#
|
1985
1949
|
# For more information about exporting CloudWatch Logs for Amazon RDS,
|
1986
1950
|
# see [ Publishing Database Logs to Amazon CloudWatch Logs][1] in the
|
@@ -1990,8 +1954,6 @@ module Aws::RDS
|
|
1990
1954
|
# Aurora, see [Publishing Database Logs to Amazon CloudWatch Logs][2] in
|
1991
1955
|
# the *Amazon Aurora User Guide*.
|
1992
1956
|
#
|
1993
|
-
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
1994
|
-
#
|
1995
1957
|
#
|
1996
1958
|
#
|
1997
1959
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch
|
@@ -2030,15 +1992,19 @@ module Aws::RDS
|
|
2030
1992
|
# `aws rds describe-db-engine-versions --engine postgres --query
|
2031
1993
|
# "DBEngineVersions[].EngineVersion"`
|
2032
1994
|
#
|
2033
|
-
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
1995
|
+
# Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
|
2034
1996
|
# @option options [Boolean] :allow_major_version_upgrade
|
2035
|
-
#
|
1997
|
+
# Specifies whether major version upgrades are allowed.
|
2036
1998
|
#
|
2037
|
-
#
|
2038
|
-
# value for the `EngineVersion` parameter that is a different major
|
2039
|
-
# version than the DB cluster's current version.
|
1999
|
+
# Valid for Cluster Type: Aurora DB clusters only
|
2040
2000
|
#
|
2041
|
-
#
|
2001
|
+
# Constraints:
|
2002
|
+
#
|
2003
|
+
# * You must allow major version upgrades when specifying a value for
|
2004
|
+
# the `EngineVersion` parameter that is a different major version than
|
2005
|
+
# the DB cluster's current version.
|
2006
|
+
#
|
2007
|
+
# ^
|
2042
2008
|
# @option options [String] :db_instance_parameter_group_name
|
2043
2009
|
# The name of the DB parameter group to apply to all instances of the DB
|
2044
2010
|
# cluster.
|
@@ -2050,6 +2016,8 @@ module Aws::RDS
|
|
2050
2016
|
#
|
2051
2017
|
# </note>
|
2052
2018
|
#
|
2019
|
+
# Valid for Cluster Type: Aurora DB clusters only
|
2020
|
+
#
|
2053
2021
|
# Default: The existing name setting
|
2054
2022
|
#
|
2055
2023
|
# Constraints:
|
@@ -2060,8 +2028,6 @@ module Aws::RDS
|
|
2060
2028
|
# * The `DBInstanceParameterGroupName` parameter is valid in combination
|
2061
2029
|
# with the `AllowMajorVersionUpgrade` parameter for a major version
|
2062
2030
|
# upgrade only.
|
2063
|
-
#
|
2064
|
-
# Valid for: Aurora DB clusters only
|
2065
2031
|
# @option options [String] :domain
|
2066
2032
|
# The Active Directory directory ID to move the DB cluster to. Specify
|
2067
2033
|
# `none` to remove the cluster from its current domain. The domain must
|
@@ -2070,31 +2036,30 @@ module Aws::RDS
|
|
2070
2036
|
# For more information, see [Kerberos Authentication][1] in the *Amazon
|
2071
2037
|
# Aurora User Guide*.
|
2072
2038
|
#
|
2073
|
-
# Valid for: Aurora DB clusters only
|
2039
|
+
# Valid for Cluster Type: Aurora DB clusters only
|
2074
2040
|
#
|
2075
2041
|
#
|
2076
2042
|
#
|
2077
2043
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/kerberos-authentication.html
|
2078
2044
|
# @option options [String] :domain_iam_role_name
|
2079
|
-
#
|
2080
|
-
#
|
2045
|
+
# The name of the IAM role to use when making API calls to the Directory
|
2046
|
+
# Service.
|
2081
2047
|
#
|
2082
|
-
# Valid for: Aurora DB clusters only
|
2048
|
+
# Valid for Cluster Type: Aurora DB clusters only
|
2083
2049
|
# @option options [Types::ScalingConfiguration] :scaling_configuration
|
2084
2050
|
# The scaling properties of the DB cluster. You can only modify scaling
|
2085
2051
|
# properties for DB clusters in `serverless` DB engine mode.
|
2086
2052
|
#
|
2087
|
-
# Valid for: Aurora DB clusters only
|
2053
|
+
# Valid for Cluster Type: Aurora DB clusters only
|
2088
2054
|
# @option options [Boolean] :deletion_protection
|
2089
|
-
#
|
2090
|
-
#
|
2091
|
-
#
|
2055
|
+
# Specifies whether the DB cluster has deletion protection enabled. The
|
2056
|
+
# database can't be deleted when deletion protection is enabled. By
|
2057
|
+
# default, deletion protection isn't enabled.
|
2092
2058
|
#
|
2093
|
-
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
2059
|
+
# Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
|
2094
2060
|
# @option options [Boolean] :enable_http_endpoint
|
2095
|
-
#
|
2096
|
-
#
|
2097
|
-
# disabled.
|
2061
|
+
# Specifies whether to enable the HTTP endpoint for an Aurora Serverless
|
2062
|
+
# v1 DB cluster. By default, the HTTP endpoint is disabled.
|
2098
2063
|
#
|
2099
2064
|
# When enabled, the HTTP endpoint provides a connectionless web service
|
2100
2065
|
# API for running SQL queries on the Aurora Serverless v1 DB cluster.
|
@@ -2104,42 +2069,41 @@ module Aws::RDS
|
|
2104
2069
|
# For more information, see [Using the Data API for Aurora Serverless
|
2105
2070
|
# v1][1] in the *Amazon Aurora User Guide*.
|
2106
2071
|
#
|
2107
|
-
# Valid for: Aurora DB clusters only
|
2072
|
+
# Valid for Cluster Type: Aurora DB clusters only
|
2108
2073
|
#
|
2109
2074
|
#
|
2110
2075
|
#
|
2111
2076
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/data-api.html
|
2112
2077
|
# @option options [Boolean] :copy_tags_to_snapshot
|
2113
|
-
#
|
2114
|
-
#
|
2078
|
+
# Specifies whether to copy all tags from the DB cluster to snapshots of
|
2079
|
+
# the DB cluster. The default is not to copy them.
|
2115
2080
|
#
|
2116
|
-
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
2081
|
+
# Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
|
2117
2082
|
# @option options [Boolean] :enable_global_write_forwarding
|
2118
|
-
#
|
2119
|
-
#
|
2120
|
-
#
|
2121
|
-
#
|
2122
|
-
# database.
|
2083
|
+
# Specifies whether to enable this DB cluster to forward write
|
2084
|
+
# operations to the primary cluster of a global cluster (Aurora global
|
2085
|
+
# database). By default, write operations are not allowed on Aurora DB
|
2086
|
+
# clusters that are secondary clusters in an Aurora global database.
|
2123
2087
|
#
|
2124
2088
|
# You can set this value only on Aurora DB clusters that are members of
|
2125
2089
|
# an Aurora global database. With this parameter enabled, a secondary
|
2126
|
-
# cluster can forward writes to the current primary cluster and the
|
2090
|
+
# cluster can forward writes to the current primary cluster, and the
|
2127
2091
|
# resulting changes are replicated back to this cluster. For the primary
|
2128
2092
|
# DB cluster of an Aurora global database, this value is used
|
2129
|
-
# immediately if the primary is demoted by
|
2093
|
+
# immediately if the primary is demoted by a global cluster API
|
2130
2094
|
# operation, but it does nothing until then.
|
2131
2095
|
#
|
2132
|
-
# Valid for: Aurora DB clusters only
|
2096
|
+
# Valid for Cluster Type: Aurora DB clusters only
|
2133
2097
|
# @option options [String] :db_cluster_instance_class
|
2134
2098
|
# The compute and memory capacity of each DB instance in the Multi-AZ DB
|
2135
|
-
# cluster, for example db.m6gd.xlarge
|
2099
|
+
# cluster, for example `db.m6gd.xlarge`. Not all DB instance classes are
|
2136
2100
|
# available in all Amazon Web Services Regions, or for all database
|
2137
2101
|
# engines.
|
2138
2102
|
#
|
2139
2103
|
# For the full list of DB instance classes and availability for your
|
2140
2104
|
# engine, see [ DB Instance Class][1] in the *Amazon RDS User Guide*.
|
2141
2105
|
#
|
2142
|
-
# Valid for: Multi-AZ DB clusters only
|
2106
|
+
# Valid for Cluster Type: Multi-AZ DB clusters only
|
2143
2107
|
#
|
2144
2108
|
#
|
2145
2109
|
#
|
@@ -2148,19 +2112,36 @@ module Aws::RDS
|
|
2148
2112
|
# The amount of storage in gibibytes (GiB) to allocate to each DB
|
2149
2113
|
# instance in the Multi-AZ DB cluster.
|
2150
2114
|
#
|
2151
|
-
# Valid for: Multi-AZ DB clusters only
|
2115
|
+
# Valid for Cluster Type: Multi-AZ DB clusters only
|
2152
2116
|
# @option options [String] :storage_type
|
2153
|
-
#
|
2117
|
+
# The storage type to associate with the DB cluster.
|
2118
|
+
#
|
2119
|
+
# For information on storage types for Aurora DB clusters, see [Storage
|
2120
|
+
# configurations for Amazon Aurora DB clusters][1]. For information on
|
2121
|
+
# storage types for Multi-AZ DB clusters, see [Settings for creating
|
2122
|
+
# Multi-AZ DB clusters][2].
|
2154
2123
|
#
|
2155
2124
|
# When specified for a Multi-AZ DB cluster, a value for the `Iops`
|
2156
2125
|
# parameter is required.
|
2157
2126
|
#
|
2158
|
-
# Valid
|
2159
|
-
# (Multi-AZ DB clusters)
|
2127
|
+
# Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
|
2160
2128
|
#
|
2161
|
-
#
|
2129
|
+
# Valid Values:
|
2162
2130
|
#
|
2163
|
-
#
|
2131
|
+
# * Aurora DB clusters - `aurora | aurora-iopt1`
|
2132
|
+
#
|
2133
|
+
# * Multi-AZ DB clusters - `io1`
|
2134
|
+
#
|
2135
|
+
# Default:
|
2136
|
+
#
|
2137
|
+
# * Aurora DB clusters - `aurora`
|
2138
|
+
#
|
2139
|
+
# * Multi-AZ DB clusters - `io1`
|
2140
|
+
#
|
2141
|
+
#
|
2142
|
+
#
|
2143
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Overview.StorageReliability.html#aurora-storage-type
|
2144
|
+
# [2]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/create-multi-az-db-cluster.html#create-multi-az-db-cluster-settings
|
2164
2145
|
# @option options [Integer] :iops
|
2165
2146
|
# The amount of Provisioned IOPS (input/output operations per second) to
|
2166
2147
|
# be initially allocated for each DB instance in the Multi-AZ DB
|
@@ -2169,31 +2150,37 @@ module Aws::RDS
|
|
2169
2150
|
# For information about valid IOPS values, see [Amazon RDS Provisioned
|
2170
2151
|
# IOPS storage][1] in the *Amazon RDS User Guide*.
|
2171
2152
|
#
|
2172
|
-
#
|
2173
|
-
# amount for the DB cluster.
|
2153
|
+
# Valid for Cluster Type: Multi-AZ DB clusters only
|
2174
2154
|
#
|
2175
|
-
#
|
2155
|
+
# Constraints:
|
2156
|
+
#
|
2157
|
+
# * Must be a multiple between .5 and 50 of the storage amount for the
|
2158
|
+
# DB cluster.
|
2159
|
+
#
|
2160
|
+
# ^
|
2176
2161
|
#
|
2177
2162
|
#
|
2178
2163
|
#
|
2179
2164
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Storage.html#USER_PIOPS
|
2180
2165
|
# @option options [Boolean] :auto_minor_version_upgrade
|
2181
|
-
#
|
2182
|
-
#
|
2183
|
-
#
|
2166
|
+
# Specifies whether minor engine upgrades are applied automatically to
|
2167
|
+
# the DB cluster during the maintenance window. By default, minor engine
|
2168
|
+
# upgrades are applied automatically.
|
2184
2169
|
#
|
2185
|
-
# Valid for: Multi-AZ DB clusters only
|
2170
|
+
# Valid for Cluster Type: Multi-AZ DB clusters only
|
2186
2171
|
# @option options [Integer] :monitoring_interval
|
2187
2172
|
# The interval, in seconds, between points when Enhanced Monitoring
|
2188
2173
|
# metrics are collected for the DB cluster. To turn off collecting
|
2189
|
-
# Enhanced Monitoring metrics, specify 0
|
2174
|
+
# Enhanced Monitoring metrics, specify `0`.
|
2190
2175
|
#
|
2191
2176
|
# If `MonitoringRoleArn` is specified, also set `MonitoringInterval` to
|
2192
|
-
# a value other than 0
|
2177
|
+
# a value other than `0`.
|
2193
2178
|
#
|
2194
|
-
# Valid
|
2179
|
+
# Valid for Cluster Type: Multi-AZ DB clusters only
|
2195
2180
|
#
|
2196
|
-
# Valid
|
2181
|
+
# Valid Values: `0 | 1 | 5 | 10 | 15 | 30 | 60`
|
2182
|
+
#
|
2183
|
+
# Default: `0`
|
2197
2184
|
# @option options [String] :monitoring_role_arn
|
2198
2185
|
# The Amazon Resource Name (ARN) for the IAM role that permits RDS to
|
2199
2186
|
# send Enhanced Monitoring metrics to Amazon CloudWatch Logs. An example
|
@@ -2201,22 +2188,21 @@ module Aws::RDS
|
|
2201
2188
|
# creating a monitoring role, see [To create an IAM role for Amazon RDS
|
2202
2189
|
# Enhanced Monitoring][1] in the *Amazon RDS User Guide.*
|
2203
2190
|
#
|
2204
|
-
# If `MonitoringInterval` is set to a value other than 0
|
2191
|
+
# If `MonitoringInterval` is set to a value other than `0`, supply a
|
2205
2192
|
# `MonitoringRoleArn` value.
|
2206
2193
|
#
|
2207
|
-
# Valid for: Multi-AZ DB clusters only
|
2194
|
+
# Valid for Cluster Type: Multi-AZ DB clusters only
|
2208
2195
|
#
|
2209
2196
|
#
|
2210
2197
|
#
|
2211
2198
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Monitoring.html#USER_Monitoring.OS.IAMRole
|
2212
2199
|
# @option options [Boolean] :enable_performance_insights
|
2213
|
-
#
|
2214
|
-
# DB cluster.
|
2200
|
+
# Specifies whether to turn on Performance Insights for the DB cluster.
|
2215
2201
|
#
|
2216
2202
|
# For more information, see [ Using Amazon Performance Insights][1] in
|
2217
2203
|
# the *Amazon RDS User Guide*.
|
2218
2204
|
#
|
2219
|
-
# Valid for: Multi-AZ DB clusters only
|
2205
|
+
# Valid for Cluster Type: Multi-AZ DB clusters only
|
2220
2206
|
#
|
2221
2207
|
#
|
2222
2208
|
#
|
@@ -2233,31 +2219,26 @@ module Aws::RDS
|
|
2233
2219
|
# your Amazon Web Services account. Your Amazon Web Services account has
|
2234
2220
|
# a different default KMS key for each Amazon Web Services Region.
|
2235
2221
|
#
|
2236
|
-
# Valid for: Multi-AZ DB clusters only
|
2222
|
+
# Valid for Cluster Type: Multi-AZ DB clusters only
|
2237
2223
|
# @option options [Integer] :performance_insights_retention_period
|
2238
|
-
# The number of days to retain Performance Insights data.
|
2239
|
-
# 7 days. The following values are valid:
|
2240
|
-
#
|
2241
|
-
# * 7
|
2242
|
-
#
|
2243
|
-
# * *month* * 31, where *month* is a number of months from 1-23
|
2224
|
+
# The number of days to retain Performance Insights data.
|
2244
2225
|
#
|
2245
|
-
#
|
2226
|
+
# Valid for Cluster Type: Multi-AZ DB clusters only
|
2246
2227
|
#
|
2247
|
-
#
|
2248
|
-
#
|
2249
|
-
# * 93 (3 months * 31)
|
2228
|
+
# Valid Values:
|
2250
2229
|
#
|
2251
|
-
# *
|
2230
|
+
# * `7`
|
2252
2231
|
#
|
2253
|
-
# *
|
2232
|
+
# * *month* * 31, where *month* is a number of months from 1-23.
|
2233
|
+
# Examples: `93` (3 months * 31), `341` (11 months * 31), `589` (19
|
2234
|
+
# months * 31)
|
2254
2235
|
#
|
2255
|
-
# * 731
|
2236
|
+
# * `731`
|
2256
2237
|
#
|
2257
|
-
#
|
2258
|
-
# value, RDS issues an error.
|
2238
|
+
# Default: `7` days
|
2259
2239
|
#
|
2260
|
-
#
|
2240
|
+
# If you specify a retention period that isn't valid, such as `94`,
|
2241
|
+
# Amazon RDS issues an error.
|
2261
2242
|
# @option options [Types::ServerlessV2ScalingConfiguration] :serverless_v2_scaling_configuration
|
2262
2243
|
# Contains the scaling configuration of an Aurora Serverless v2 DB
|
2263
2244
|
# cluster.
|
@@ -2271,12 +2252,6 @@ module Aws::RDS
|
|
2271
2252
|
# @option options [String] :network_type
|
2272
2253
|
# The network type of the DB cluster.
|
2273
2254
|
#
|
2274
|
-
# Valid values:
|
2275
|
-
#
|
2276
|
-
# * `IPV4`
|
2277
|
-
#
|
2278
|
-
# * `DUAL`
|
2279
|
-
#
|
2280
2255
|
# The network type is determined by the `DBSubnetGroup` specified for
|
2281
2256
|
# the DB cluster. A `DBSubnetGroup` can support only the IPv4 protocol
|
2282
2257
|
# or the IPv4 and the IPv6 protocols (`DUAL`).
|
@@ -2284,14 +2259,16 @@ module Aws::RDS
|
|
2284
2259
|
# For more information, see [ Working with a DB instance in a VPC][1] in
|
2285
2260
|
# the *Amazon Aurora User Guide.*
|
2286
2261
|
#
|
2287
|
-
# Valid for: Aurora DB clusters only
|
2262
|
+
# Valid for Cluster Type: Aurora DB clusters only
|
2263
|
+
#
|
2264
|
+
# Valid Values: `IPV4 | DUAL`
|
2288
2265
|
#
|
2289
2266
|
#
|
2290
2267
|
#
|
2291
2268
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html
|
2292
2269
|
# @option options [Boolean] :manage_master_user_password
|
2293
|
-
#
|
2294
|
-
#
|
2270
|
+
# Specifies whether to manage the master user password with Amazon Web
|
2271
|
+
# Services Secrets Manager.
|
2295
2272
|
#
|
2296
2273
|
# If the DB cluster doesn't manage the master user password with Amazon
|
2297
2274
|
# Web Services Secrets Manager, you can turn on this management. In this
|
@@ -2309,15 +2286,15 @@ module Aws::RDS
|
|
2309
2286
|
# [Password management with Amazon Web Services Secrets Manager][2] in
|
2310
2287
|
# the *Amazon Aurora User Guide.*
|
2311
2288
|
#
|
2312
|
-
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
2289
|
+
# Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
|
2313
2290
|
#
|
2314
2291
|
#
|
2315
2292
|
#
|
2316
2293
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html
|
2317
2294
|
# [2]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/rds-secrets-manager.html
|
2318
2295
|
# @option options [Boolean] :rotate_master_user_password
|
2319
|
-
#
|
2320
|
-
#
|
2296
|
+
# Specifies whether to rotate the secret managed by Amazon Web Services
|
2297
|
+
# Secrets Manager for the master user password.
|
2321
2298
|
#
|
2322
2299
|
# This setting is valid only if the master user password is managed by
|
2323
2300
|
# RDS in Amazon Web Services Secrets Manager for the DB cluster. The
|
@@ -2328,6 +2305,8 @@ module Aws::RDS
|
|
2328
2305
|
# [Password management with Amazon Web Services Secrets Manager][2] in
|
2329
2306
|
# the *Amazon Aurora User Guide.*
|
2330
2307
|
#
|
2308
|
+
# Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
|
2309
|
+
#
|
2331
2310
|
# Constraints:
|
2332
2311
|
#
|
2333
2312
|
# * You must apply the change immediately when rotating the master user
|
@@ -2335,8 +2314,6 @@ module Aws::RDS
|
|
2335
2314
|
#
|
2336
2315
|
# ^
|
2337
2316
|
#
|
2338
|
-
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
2339
|
-
#
|
2340
2317
|
#
|
2341
2318
|
#
|
2342
2319
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html
|
@@ -2375,7 +2352,7 @@ module Aws::RDS
|
|
2375
2352
|
# Amazon Web Services account has a different default KMS key for each
|
2376
2353
|
# Amazon Web Services Region.
|
2377
2354
|
#
|
2378
|
-
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
2355
|
+
# Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
|
2379
2356
|
# @option options [String] :engine_mode
|
2380
2357
|
# The DB engine mode of the DB cluster, either `provisioned` or
|
2381
2358
|
# `serverless`.
|
@@ -2387,20 +2364,24 @@ module Aws::RDS
|
|
2387
2364
|
#
|
2388
2365
|
# For more information, see [ CreateDBCluster][1].
|
2389
2366
|
#
|
2390
|
-
# Valid for: Aurora DB clusters only
|
2367
|
+
# Valid for Cluster Type: Aurora DB clusters only
|
2391
2368
|
#
|
2392
2369
|
#
|
2393
2370
|
#
|
2394
2371
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBCluster.html
|
2395
2372
|
# @option options [Boolean] :allow_engine_mode_change
|
2396
|
-
#
|
2397
|
-
#
|
2373
|
+
# Specifies whether engine mode changes from `serverless` to
|
2374
|
+
# `provisioned` are allowed.
|
2398
2375
|
#
|
2399
|
-
#
|
2400
|
-
# different value for the `EngineMode` parameter from the DB cluster's
|
2401
|
-
# current engine mode.
|
2376
|
+
# Valid for Cluster Type: Aurora Serverless v1 DB clusters only
|
2402
2377
|
#
|
2403
|
-
#
|
2378
|
+
# Constraints:
|
2379
|
+
#
|
2380
|
+
# * You must allow engine mode changes when specifying a different value
|
2381
|
+
# for the `EngineMode` parameter from the DB cluster's current engine
|
2382
|
+
# mode.
|
2383
|
+
#
|
2384
|
+
# ^
|
2404
2385
|
# @return [DBCluster]
|
2405
2386
|
def modify(options = {})
|
2406
2387
|
options = options.merge(db_cluster_identifier: @id)
|