aws-sdk-rds 1.130.0 → 1.134.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 +20 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-rds/client.rb +1519 -359
- data/lib/aws-sdk-rds/client_api.rb +65 -0
- data/lib/aws-sdk-rds/db_cluster.rb +727 -65
- data/lib/aws-sdk-rds/db_cluster_parameter_group.rb +12 -0
- data/lib/aws-sdk-rds/db_cluster_snapshot.rb +166 -14
- data/lib/aws-sdk-rds/db_instance.rb +113 -118
- data/lib/aws-sdk-rds/db_snapshot.rb +33 -11
- data/lib/aws-sdk-rds/resource.rb +361 -106
- data/lib/aws-sdk-rds/types.rb +1731 -313
- data/lib/aws-sdk-rds.rb +1 -1
- metadata +4 -4
data/lib/aws-sdk-rds/resource.rb
CHANGED
@@ -83,14 +83,29 @@ module Aws::RDS
|
|
83
83
|
# domain: "String",
|
84
84
|
# domain_iam_role_name: "String",
|
85
85
|
# enable_global_write_forwarding: false,
|
86
|
+
# db_cluster_instance_class: "String",
|
87
|
+
# allocated_storage: 1,
|
88
|
+
# storage_type: "String",
|
89
|
+
# iops: 1,
|
90
|
+
# publicly_accessible: false,
|
91
|
+
# auto_minor_version_upgrade: false,
|
92
|
+
# monitoring_interval: 1,
|
93
|
+
# monitoring_role_arn: "String",
|
94
|
+
# enable_performance_insights: false,
|
95
|
+
# performance_insights_kms_key_id: "String",
|
96
|
+
# performance_insights_retention_period: 1,
|
86
97
|
# source_region: "String",
|
87
98
|
# })
|
88
99
|
# @param [Hash] options ({})
|
89
100
|
# @option options [Array<String>] :availability_zones
|
90
|
-
# A list of Availability Zones (AZs) where instances in the DB
|
91
|
-
# can be created.
|
92
|
-
#
|
93
|
-
#
|
101
|
+
# A list of Availability Zones (AZs) where DB instances in the DB
|
102
|
+
# cluster can be created.
|
103
|
+
#
|
104
|
+
# For information on Amazon Web Services Regions and Availability Zones,
|
105
|
+
# see [Choosing the Regions and Availability Zones][1] in the *Amazon
|
106
|
+
# Aurora User Guide*.
|
107
|
+
#
|
108
|
+
# Valid for: Aurora DB clusters only
|
94
109
|
#
|
95
110
|
#
|
96
111
|
#
|
@@ -105,13 +120,19 @@ module Aws::RDS
|
|
105
120
|
# * Must be a value from 1 to 35
|
106
121
|
#
|
107
122
|
# ^
|
123
|
+
#
|
124
|
+
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
108
125
|
# @option options [String] :character_set_name
|
109
126
|
# A value that indicates that the DB cluster should be associated with
|
110
127
|
# the specified CharacterSet.
|
128
|
+
#
|
129
|
+
# Valid for: Aurora DB clusters only
|
111
130
|
# @option options [String] :database_name
|
112
131
|
# The name for your database of up to 64 alphanumeric characters. If you
|
113
132
|
# do not provide a name, Amazon RDS doesn't create a database in the DB
|
114
133
|
# cluster you are creating.
|
134
|
+
#
|
135
|
+
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
115
136
|
# @option options [required, String] :db_cluster_identifier
|
116
137
|
# The DB cluster identifier. This parameter is stored as a lowercase
|
117
138
|
# string.
|
@@ -125,6 +146,8 @@ module Aws::RDS
|
|
125
146
|
# * Can't end with a hyphen or contain two consecutive hyphens.
|
126
147
|
#
|
127
148
|
# Example: `my-cluster1`
|
149
|
+
#
|
150
|
+
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
128
151
|
# @option options [String] :db_cluster_parameter_group_name
|
129
152
|
# The name of the DB cluster parameter group to associate with this DB
|
130
153
|
# cluster. If you do not specify a value, then the default DB cluster
|
@@ -136,56 +159,117 @@ module Aws::RDS
|
|
136
159
|
# group.
|
137
160
|
#
|
138
161
|
# ^
|
162
|
+
#
|
163
|
+
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
139
164
|
# @option options [Array<String>] :vpc_security_group_ids
|
140
165
|
# A list of EC2 VPC security groups to associate with this DB cluster.
|
166
|
+
#
|
167
|
+
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
141
168
|
# @option options [String] :db_subnet_group_name
|
142
169
|
# A DB subnet group to associate with this DB cluster.
|
143
170
|
#
|
171
|
+
# This setting is required to create a Multi-AZ DB cluster.
|
172
|
+
#
|
144
173
|
# Constraints: Must match the name of an existing DBSubnetGroup. Must
|
145
174
|
# not be default.
|
146
175
|
#
|
147
176
|
# Example: `mySubnetgroup`
|
177
|
+
#
|
178
|
+
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
148
179
|
# @option options [required, String] :engine
|
149
180
|
# The name of the database engine to be used for this DB cluster.
|
150
181
|
#
|
151
|
-
# Valid Values:
|
152
|
-
#
|
153
|
-
# `aurora-
|
182
|
+
# Valid Values:
|
183
|
+
#
|
184
|
+
# * `aurora` (for MySQL 5.6-compatible Aurora)
|
185
|
+
#
|
186
|
+
# * `aurora-mysql` (for MySQL 5.7-compatible Aurora)
|
187
|
+
#
|
188
|
+
# * `aurora-postgresql`
|
189
|
+
#
|
190
|
+
# * `mysql`
|
191
|
+
#
|
192
|
+
# * `postgres`
|
193
|
+
#
|
194
|
+
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
154
195
|
# @option options [String] :engine_version
|
155
196
|
# The version number of the database engine to use.
|
156
197
|
#
|
157
|
-
# To list all of the available engine versions for
|
158
|
-
#
|
198
|
+
# To list all of the available engine versions for MySQL 5.6-compatible
|
199
|
+
# Aurora, use the following command:
|
159
200
|
#
|
160
201
|
# `aws rds describe-db-engine-versions --engine aurora --query
|
161
202
|
# "DBEngineVersions[].EngineVersion"`
|
162
203
|
#
|
163
|
-
# To list all of the available engine versions for
|
164
|
-
#
|
204
|
+
# To list all of the available engine versions for MySQL 5.7-compatible
|
205
|
+
# Aurora, use the following command:
|
165
206
|
#
|
166
207
|
# `aws rds describe-db-engine-versions --engine aurora-mysql --query
|
167
208
|
# "DBEngineVersions[].EngineVersion"`
|
168
209
|
#
|
169
|
-
# To list all of the available engine versions for
|
210
|
+
# To list all of the available engine versions for Aurora PostgreSQL,
|
170
211
|
# use the following command:
|
171
212
|
#
|
172
213
|
# `aws rds describe-db-engine-versions --engine aurora-postgresql
|
173
214
|
# --query "DBEngineVersions[].EngineVersion"`
|
174
215
|
#
|
216
|
+
# To list all of the available engine versions for RDS for MySQL, use
|
217
|
+
# the following command:
|
218
|
+
#
|
219
|
+
# `aws rds describe-db-engine-versions --engine mysql --query
|
220
|
+
# "DBEngineVersions[].EngineVersion"`
|
221
|
+
#
|
222
|
+
# To list all of the available engine versions for RDS for PostgreSQL,
|
223
|
+
# use the following command:
|
224
|
+
#
|
225
|
+
# `aws rds describe-db-engine-versions --engine postgres --query
|
226
|
+
# "DBEngineVersions[].EngineVersion"`
|
227
|
+
#
|
175
228
|
# **Aurora MySQL**
|
176
229
|
#
|
177
|
-
#
|
178
|
-
#
|
230
|
+
# For information, see [MySQL on Amazon RDS Versions][1] in the *Amazon
|
231
|
+
# Aurora User Guide.*
|
179
232
|
#
|
180
233
|
# **Aurora PostgreSQL**
|
181
234
|
#
|
182
|
-
#
|
235
|
+
# For information, see [Amazon Aurora PostgreSQL releases and engine
|
236
|
+
# versions][2] in the *Amazon Aurora User Guide.*
|
237
|
+
#
|
238
|
+
# **MySQL**
|
239
|
+
#
|
240
|
+
# For information, see [MySQL on Amazon RDS Versions][3] in the *Amazon
|
241
|
+
# RDS User Guide.*
|
242
|
+
#
|
243
|
+
# **PostgreSQL**
|
244
|
+
#
|
245
|
+
# For information, see [Amazon RDS for PostgreSQL versions and
|
246
|
+
# extensions][4] in the *Amazon RDS User Guide.*
|
247
|
+
#
|
248
|
+
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
249
|
+
#
|
250
|
+
#
|
251
|
+
#
|
252
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraMySQL.Updates.html
|
253
|
+
# [2]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraPostgreSQL.Updates.20180305.html
|
254
|
+
# [3]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_MySQL.html#MySQL.Concepts.VersionMgmt
|
255
|
+
# [4]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_PostgreSQL.html#PostgreSQL.Concepts
|
183
256
|
# @option options [Integer] :port
|
184
257
|
# The port number on which the instances in the DB cluster accept
|
185
258
|
# connections.
|
186
259
|
#
|
187
|
-
#
|
188
|
-
#
|
260
|
+
# **RDS for MySQL and Aurora MySQL**
|
261
|
+
#
|
262
|
+
# Default: `3306`
|
263
|
+
#
|
264
|
+
# Valid values: `1150-65535`
|
265
|
+
#
|
266
|
+
# **RDS for PostgreSQL and Aurora PostgreSQL**
|
267
|
+
#
|
268
|
+
# Default: `5432`
|
269
|
+
#
|
270
|
+
# Valid values: `1150-65535`
|
271
|
+
#
|
272
|
+
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
189
273
|
# @option options [String] :master_username
|
190
274
|
# The name of the master user for the DB cluster.
|
191
275
|
#
|
@@ -196,18 +280,21 @@ module Aws::RDS
|
|
196
280
|
# * First character must be a letter.
|
197
281
|
#
|
198
282
|
# * Can't be a reserved word for the chosen database engine.
|
283
|
+
#
|
284
|
+
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
199
285
|
# @option options [String] :master_user_password
|
200
286
|
# The password for the master database user. This password can contain
|
201
287
|
# any printable ASCII character except "/", """, or "@".
|
202
288
|
#
|
203
289
|
# Constraints: Must contain from 8 to 41 characters.
|
290
|
+
#
|
291
|
+
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
204
292
|
# @option options [String] :option_group_name
|
205
293
|
# A value that indicates that the DB cluster should be associated with
|
206
294
|
# the specified option group.
|
207
295
|
#
|
208
|
-
#
|
209
|
-
#
|
210
|
-
# DB cluster.
|
296
|
+
# DB clusters are associated with a default option group that can't be
|
297
|
+
# modified.
|
211
298
|
# @option options [String] :preferred_backup_window
|
212
299
|
# The daily time range during which automated backups are created if
|
213
300
|
# automated backups are enabled using the `BackupRetentionPeriod`
|
@@ -228,6 +315,8 @@ module Aws::RDS
|
|
228
315
|
#
|
229
316
|
# * Must be at least 30 minutes.
|
230
317
|
#
|
318
|
+
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
319
|
+
#
|
231
320
|
#
|
232
321
|
#
|
233
322
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Managing.Backups.html#Aurora.Managing.Backups.BackupWindow
|
@@ -247,16 +336,24 @@ module Aws::RDS
|
|
247
336
|
#
|
248
337
|
# Constraints: Minimum 30-minute window.
|
249
338
|
#
|
339
|
+
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
340
|
+
#
|
250
341
|
#
|
251
342
|
#
|
252
343
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_UpgradeDBInstance.Maintenance.html#AdjustingTheMaintenanceWindow.Aurora
|
253
344
|
# @option options [String] :replication_source_identifier
|
254
345
|
# The Amazon Resource Name (ARN) of the source DB instance or DB cluster
|
255
346
|
# if this DB cluster is created as a read replica.
|
347
|
+
#
|
348
|
+
# Valid for: Aurora DB clusters only
|
256
349
|
# @option options [Array<Types::Tag>] :tags
|
257
350
|
# Tags to assign to the DB cluster.
|
351
|
+
#
|
352
|
+
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
258
353
|
# @option options [Boolean] :storage_encrypted
|
259
354
|
# A value that indicates whether the DB cluster is encrypted.
|
355
|
+
#
|
356
|
+
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
260
357
|
# @option options [String] :kms_key_id
|
261
358
|
# The Amazon Web Services KMS key identifier for an encrypted DB
|
262
359
|
# cluster.
|
@@ -285,12 +382,14 @@ module Aws::RDS
|
|
285
382
|
# identifier that is valid in the destination Amazon Web Services
|
286
383
|
# Region. This KMS key is used to encrypt the read replica in that
|
287
384
|
# Amazon Web Services Region.
|
385
|
+
#
|
386
|
+
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
288
387
|
# @option options [String] :pre_signed_url
|
289
388
|
# A URL that contains a Signature Version 4 signed request for the
|
290
389
|
# `CreateDBCluster` action to be called in the source Amazon Web
|
291
|
-
# Services Region where the DB cluster is replicated from.
|
292
|
-
#
|
293
|
-
#
|
390
|
+
# Services Region where the DB cluster is replicated from. Specify
|
391
|
+
# `PreSignedUrl` only when you are performing cross-Region replication
|
392
|
+
# from an encrypted DB cluster.
|
294
393
|
#
|
295
394
|
# The pre-signed URL must be a valid request for the `CreateDBCluster`
|
296
395
|
# API action that can be executed in the source Amazon Web Services
|
@@ -331,6 +430,8 @@ module Aws::RDS
|
|
331
430
|
#
|
332
431
|
# </note>
|
333
432
|
#
|
433
|
+
# Valid for: Aurora DB clusters only
|
434
|
+
#
|
334
435
|
#
|
335
436
|
#
|
336
437
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/API/sigv4-query-string-auth.html
|
@@ -338,11 +439,13 @@ module Aws::RDS
|
|
338
439
|
# @option options [Boolean] :enable_iam_database_authentication
|
339
440
|
# A value that indicates whether to enable mapping of Amazon Web
|
340
441
|
# Services Identity and Access Management (IAM) accounts to database
|
341
|
-
# accounts. By default, mapping
|
442
|
+
# accounts. By default, mapping isn't enabled.
|
342
443
|
#
|
343
444
|
# For more information, see [ IAM Database Authentication][1] in the
|
344
445
|
# *Amazon Aurora User Guide.*
|
345
446
|
#
|
447
|
+
# Valid for: Aurora DB clusters only
|
448
|
+
#
|
346
449
|
#
|
347
450
|
#
|
348
451
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.IAMDBAuth.html
|
@@ -350,10 +453,6 @@ module Aws::RDS
|
|
350
453
|
# The target backtrack window, in seconds. To disable backtracking, set
|
351
454
|
# this value to 0.
|
352
455
|
#
|
353
|
-
# <note markdown="1"> Currently, Backtrack is only supported for Aurora MySQL DB clusters.
|
354
|
-
#
|
355
|
-
# </note>
|
356
|
-
#
|
357
456
|
# Default: 0
|
358
457
|
#
|
359
458
|
# Constraints:
|
@@ -362,6 +461,8 @@ module Aws::RDS
|
|
362
461
|
# (72 hours).
|
363
462
|
#
|
364
463
|
# ^
|
464
|
+
#
|
465
|
+
# Valid for: Aurora MySQL DB clusters only
|
365
466
|
# @option options [Array<String>] :enable_cloudwatch_logs_exports
|
366
467
|
# The list of log types that need to be enabled for exporting to
|
367
468
|
# CloudWatch Logs. The values in the list depend on the DB engine being
|
@@ -376,6 +477,8 @@ module Aws::RDS
|
|
376
477
|
#
|
377
478
|
# Possible value is `postgresql`.
|
378
479
|
#
|
480
|
+
# Valid for: Aurora DB clusters only
|
481
|
+
#
|
379
482
|
#
|
380
483
|
#
|
381
484
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch
|
@@ -410,6 +513,8 @@ module Aws::RDS
|
|
410
513
|
#
|
411
514
|
# * [ Limitations of Multi-Master Clusters][4]
|
412
515
|
#
|
516
|
+
# Valid for: Aurora DB clusters only
|
517
|
+
#
|
413
518
|
#
|
414
519
|
#
|
415
520
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless.html#aurora-serverless.limitations
|
@@ -419,13 +524,19 @@ module Aws::RDS
|
|
419
524
|
# @option options [Types::ScalingConfiguration] :scaling_configuration
|
420
525
|
# For DB clusters in `serverless` DB engine mode, the scaling properties
|
421
526
|
# of the DB cluster.
|
527
|
+
#
|
528
|
+
# Valid for: Aurora DB clusters only
|
422
529
|
# @option options [Boolean] :deletion_protection
|
423
530
|
# A value that indicates whether the DB cluster has deletion protection
|
424
531
|
# enabled. The database can't be deleted when deletion protection is
|
425
|
-
# enabled. By default, deletion protection
|
532
|
+
# enabled. By default, deletion protection isn't enabled.
|
533
|
+
#
|
534
|
+
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
426
535
|
# @option options [String] :global_cluster_identifier
|
427
536
|
# The global cluster ID of an Aurora cluster that becomes the primary
|
428
537
|
# cluster in the new global database cluster.
|
538
|
+
#
|
539
|
+
# Valid for: Aurora DB clusters only
|
429
540
|
# @option options [Boolean] :enable_http_endpoint
|
430
541
|
# A value that indicates whether to enable the HTTP endpoint for an
|
431
542
|
# Aurora Serverless DB cluster. By default, the HTTP endpoint is
|
@@ -439,26 +550,35 @@ module Aws::RDS
|
|
439
550
|
# For more information, see [Using the Data API for Aurora
|
440
551
|
# Serverless][1] in the *Amazon Aurora User Guide*.
|
441
552
|
#
|
553
|
+
# Valid for: Aurora DB clusters only
|
554
|
+
#
|
442
555
|
#
|
443
556
|
#
|
444
557
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/data-api.html
|
445
558
|
# @option options [Boolean] :copy_tags_to_snapshot
|
446
559
|
# A value that indicates whether to copy all tags from the DB cluster to
|
447
560
|
# snapshots of the DB cluster. The default is not to copy them.
|
561
|
+
#
|
562
|
+
# Valid for: Aurora DB clusters only
|
448
563
|
# @option options [String] :domain
|
449
564
|
# The Active Directory directory ID to create the DB cluster in.
|
450
565
|
#
|
451
566
|
# For Amazon Aurora DB clusters, Amazon RDS can use Kerberos
|
452
|
-
#
|
453
|
-
#
|
567
|
+
# authentication to authenticate users that connect to the DB cluster.
|
568
|
+
#
|
569
|
+
# For more information, see [Kerberos authentication][1] in the *Amazon
|
454
570
|
# Aurora User Guide*.
|
455
571
|
#
|
572
|
+
# Valid for: Aurora DB clusters only
|
573
|
+
#
|
456
574
|
#
|
457
575
|
#
|
458
576
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/kerberos-authentication.html
|
459
577
|
# @option options [String] :domain_iam_role_name
|
460
578
|
# Specify the name of the IAM role to be used when making API calls to
|
461
579
|
# the Directory Service.
|
580
|
+
#
|
581
|
+
# Valid for: Aurora DB clusters only
|
462
582
|
# @option options [Boolean] :enable_global_write_forwarding
|
463
583
|
# A value that indicates whether to enable this DB cluster to forward
|
464
584
|
# write operations to the primary cluster of an Aurora global database
|
@@ -473,6 +593,160 @@ module Aws::RDS
|
|
473
593
|
# DB cluster of an Aurora global database, this value is used
|
474
594
|
# immediately if the primary is demoted by the FailoverGlobalCluster API
|
475
595
|
# operation, but it does nothing until then.
|
596
|
+
#
|
597
|
+
# Valid for: Aurora DB clusters only
|
598
|
+
# @option options [String] :db_cluster_instance_class
|
599
|
+
# The compute and memory capacity of each DB instance in the Multi-AZ DB
|
600
|
+
# cluster, for example db.m6g.xlarge. Not all DB instance classes are
|
601
|
+
# available in all Amazon Web Services Regions, or for all database
|
602
|
+
# engines.
|
603
|
+
#
|
604
|
+
# For the full list of DB instance classes and availability for your
|
605
|
+
# engine, see [DB instance class][1] in the *Amazon RDS User Guide.*
|
606
|
+
#
|
607
|
+
# This setting is required to create a Multi-AZ DB cluster.
|
608
|
+
#
|
609
|
+
# Valid for: Multi-AZ DB clusters only
|
610
|
+
#
|
611
|
+
#
|
612
|
+
#
|
613
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html
|
614
|
+
# @option options [Integer] :allocated_storage
|
615
|
+
# The amount of storage in gibibytes (GiB) to allocate to each DB
|
616
|
+
# instance in the Multi-AZ DB cluster.
|
617
|
+
#
|
618
|
+
# This setting is required to create a Multi-AZ DB cluster.
|
619
|
+
#
|
620
|
+
# Valid for: Multi-AZ DB clusters only
|
621
|
+
# @option options [String] :storage_type
|
622
|
+
# Specifies the storage type to be associated with the DB cluster.
|
623
|
+
#
|
624
|
+
# This setting is required to create a Multi-AZ DB cluster.
|
625
|
+
#
|
626
|
+
# Valid values: `standard | gp2 | io1`
|
627
|
+
#
|
628
|
+
# If you specify `io1`, also include a value for the `Iops` parameter.
|
629
|
+
#
|
630
|
+
# Default: `io1` if the `Iops` parameter is specified, otherwise `gp2`
|
631
|
+
#
|
632
|
+
# Valid for: Multi-AZ DB clusters only
|
633
|
+
# @option options [Integer] :iops
|
634
|
+
# The amount of Provisioned IOPS (input/output operations per second) to
|
635
|
+
# be initially allocated for each DB instance in the Multi-AZ DB
|
636
|
+
# cluster.
|
637
|
+
#
|
638
|
+
# For information about valid `Iops` values, see [Amazon RDS Provisioned
|
639
|
+
# IOPS storage to improve performance][1] in the *Amazon RDS User
|
640
|
+
# Guide*.
|
641
|
+
#
|
642
|
+
# This setting is required to create a Multi-AZ DB cluster.
|
643
|
+
#
|
644
|
+
# Constraints: Must be a multiple between .5 and 50 of the storage
|
645
|
+
# amount for the DB cluster.
|
646
|
+
#
|
647
|
+
# Valid for: Multi-AZ DB clusters only
|
648
|
+
#
|
649
|
+
#
|
650
|
+
#
|
651
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Storage.html#USER_PIOPS
|
652
|
+
# @option options [Boolean] :publicly_accessible
|
653
|
+
# A value that indicates whether the DB cluster is publicly accessible.
|
654
|
+
#
|
655
|
+
# When the DB cluster is publicly accessible, its Domain Name System
|
656
|
+
# (DNS) endpoint resolves to the private IP address from within the DB
|
657
|
+
# cluster's virtual private cloud (VPC). It resolves to the public IP
|
658
|
+
# address from outside of the DB cluster's VPC. Access to the DB
|
659
|
+
# cluster is ultimately controlled by the security group it uses. That
|
660
|
+
# public access isn't permitted if the security group assigned to the
|
661
|
+
# DB cluster doesn't permit it.
|
662
|
+
#
|
663
|
+
# When the DB cluster isn't publicly accessible, it is an internal DB
|
664
|
+
# cluster with a DNS name that resolves to a private IP address.
|
665
|
+
#
|
666
|
+
# Default: The default behavior varies depending on whether
|
667
|
+
# `DBSubnetGroupName` is specified.
|
668
|
+
#
|
669
|
+
# If `DBSubnetGroupName` isn't specified, and `PubliclyAccessible`
|
670
|
+
# isn't specified, the following applies:
|
671
|
+
#
|
672
|
+
# * If the default VPC in the target Region doesn’t have an internet
|
673
|
+
# gateway attached to it, the DB cluster is private.
|
674
|
+
#
|
675
|
+
# * If the default VPC in the target Region has an internet gateway
|
676
|
+
# attached to it, the DB cluster is public.
|
677
|
+
#
|
678
|
+
# If `DBSubnetGroupName` is specified, and `PubliclyAccessible` isn't
|
679
|
+
# specified, the following applies:
|
680
|
+
#
|
681
|
+
# * If the subnets are part of a VPC that doesn’t have an internet
|
682
|
+
# gateway attached to it, the DB cluster is private.
|
683
|
+
#
|
684
|
+
# * If the subnets are part of a VPC that has an internet gateway
|
685
|
+
# attached to it, the DB cluster is public.
|
686
|
+
#
|
687
|
+
# Valid for: Multi-AZ DB clusters only
|
688
|
+
# @option options [Boolean] :auto_minor_version_upgrade
|
689
|
+
# A value that indicates whether minor engine upgrades are applied
|
690
|
+
# automatically to the DB cluster during the maintenance window. By
|
691
|
+
# default, minor engine upgrades are applied automatically.
|
692
|
+
#
|
693
|
+
# Valid for: Multi-AZ DB clusters only
|
694
|
+
# @option options [Integer] :monitoring_interval
|
695
|
+
# The interval, in seconds, between points when Enhanced Monitoring
|
696
|
+
# metrics are collected for the DB cluster. To turn off collecting
|
697
|
+
# Enhanced Monitoring metrics, specify 0. The default is 0.
|
698
|
+
#
|
699
|
+
# If `MonitoringRoleArn` is specified, also set `MonitoringInterval` to
|
700
|
+
# a value other than 0.
|
701
|
+
#
|
702
|
+
# Valid Values: `0, 1, 5, 10, 15, 30, 60`
|
703
|
+
#
|
704
|
+
# Valid for: Multi-AZ DB clusters only
|
705
|
+
# @option options [String] :monitoring_role_arn
|
706
|
+
# The Amazon Resource Name (ARN) for the IAM role that permits RDS to
|
707
|
+
# send Enhanced Monitoring metrics to Amazon CloudWatch Logs. An example
|
708
|
+
# is `arn:aws:iam:123456789012:role/emaccess`. For information on
|
709
|
+
# creating a monitoring role, see [Setting up and enabling Enhanced
|
710
|
+
# Monitoring][1] in the *Amazon RDS User Guide*.
|
711
|
+
#
|
712
|
+
# If `MonitoringInterval` is set to a value other than 0, supply a
|
713
|
+
# `MonitoringRoleArn` value.
|
714
|
+
#
|
715
|
+
# Valid for: Multi-AZ DB clusters only
|
716
|
+
#
|
717
|
+
#
|
718
|
+
#
|
719
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Monitoring.OS.html#USER_Monitoring.OS.Enabling
|
720
|
+
# @option options [Boolean] :enable_performance_insights
|
721
|
+
# A value that indicates whether to turn on Performance Insights for the
|
722
|
+
# DB cluster.
|
723
|
+
#
|
724
|
+
# For more information, see [ Using Amazon Performance Insights][1] in
|
725
|
+
# the *Amazon RDS User Guide*.
|
726
|
+
#
|
727
|
+
# Valid for: Multi-AZ DB clusters only
|
728
|
+
#
|
729
|
+
#
|
730
|
+
#
|
731
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.html
|
732
|
+
# @option options [String] :performance_insights_kms_key_id
|
733
|
+
# The Amazon Web Services KMS key identifier for encryption of
|
734
|
+
# Performance Insights data.
|
735
|
+
#
|
736
|
+
# The Amazon Web Services KMS key identifier is the key ARN, key ID,
|
737
|
+
# alias ARN, or alias name for the KMS key.
|
738
|
+
#
|
739
|
+
# If you don't specify a value for `PerformanceInsightsKMSKeyId`, then
|
740
|
+
# Amazon RDS uses your default KMS key. There is a default KMS key for
|
741
|
+
# your Amazon Web Services account. Your Amazon Web Services account has
|
742
|
+
# a different default KMS key for each Amazon Web Services Region.
|
743
|
+
#
|
744
|
+
# Valid for: Multi-AZ DB clusters only
|
745
|
+
# @option options [Integer] :performance_insights_retention_period
|
746
|
+
# The amount of time, in days, to retain Performance Insights data.
|
747
|
+
# Valid values are 7 or 731 (2 years).
|
748
|
+
#
|
749
|
+
# Valid for: Multi-AZ DB clusters only
|
476
750
|
# @option options [String] :source_region
|
477
751
|
# The source region of the snapshot. This is only needed when the
|
478
752
|
# shapshot is encrypted and in a different region.
|
@@ -505,7 +779,7 @@ module Aws::RDS
|
|
505
779
|
#
|
506
780
|
# Constraints:
|
507
781
|
#
|
508
|
-
# * Must match the name of an existing DB cluster parameter group.
|
782
|
+
# * Must not match the name of an existing DB cluster parameter group.
|
509
783
|
#
|
510
784
|
# ^
|
511
785
|
#
|
@@ -527,6 +801,14 @@ module Aws::RDS
|
|
527
801
|
#
|
528
802
|
# Example: `aurora-postgresql9.6`
|
529
803
|
#
|
804
|
+
# **RDS for MySQL**
|
805
|
+
#
|
806
|
+
# Example: `mysql8.0`
|
807
|
+
#
|
808
|
+
# **RDS for PostgreSQL**
|
809
|
+
#
|
810
|
+
# Example: `postgres12`
|
811
|
+
#
|
530
812
|
# To list all of the available parameter group families for a DB engine,
|
531
813
|
# use the following command:
|
532
814
|
#
|
@@ -551,6 +833,10 @@ module Aws::RDS
|
|
551
833
|
# * `aurora-mysql` (for MySQL 5.7-compatible Aurora)
|
552
834
|
#
|
553
835
|
# * `aurora-postgresql`
|
836
|
+
#
|
837
|
+
# * `mysql`
|
838
|
+
#
|
839
|
+
# * `postgres`
|
554
840
|
# @option options [required, String] :description
|
555
841
|
# The description for the DB cluster parameter group.
|
556
842
|
# @option options [Array<Types::Tag>] :tags
|
@@ -627,6 +913,7 @@ module Aws::RDS
|
|
627
913
|
# max_allocated_storage: 1,
|
628
914
|
# enable_customer_owned_ip: false,
|
629
915
|
# custom_iam_instance_profile: "String",
|
916
|
+
# backup_target: "String",
|
630
917
|
# })
|
631
918
|
# @param [Hash] options ({})
|
632
919
|
# @option options [String] :db_name
|
@@ -852,8 +1139,8 @@ module Aws::RDS
|
|
852
1139
|
#
|
853
1140
|
# * Web and Express editions: Must be an integer from 20 to 1024.
|
854
1141
|
# @option options [required, String] :db_instance_class
|
855
|
-
# The compute and memory capacity of the DB instance, for example
|
856
|
-
#
|
1142
|
+
# The compute and memory capacity of the DB instance, for example
|
1143
|
+
# db.m4.large. Not all DB instance classes are available in all Amazon
|
857
1144
|
# Web Services Regions, or for all database engines. For the full list
|
858
1145
|
# of DB instance classes, and availability for your engine, see [DB
|
859
1146
|
# Instance Class][1] in the *Amazon RDS User Guide.*
|
@@ -906,59 +1193,13 @@ module Aws::RDS
|
|
906
1193
|
# Not applicable. The name for the master user is managed by the DB
|
907
1194
|
# cluster.
|
908
1195
|
#
|
909
|
-
# **
|
910
|
-
#
|
911
|
-
# Constraints:
|
912
|
-
#
|
913
|
-
# * Required for MariaDB.
|
914
|
-
#
|
915
|
-
# * Must be 1 to 16 letters or numbers.
|
916
|
-
#
|
917
|
-
# * Can't be a reserved word for the chosen database engine.
|
918
|
-
#
|
919
|
-
# **Microsoft SQL Server**
|
1196
|
+
# **Amazon RDS**
|
920
1197
|
#
|
921
1198
|
# Constraints:
|
922
1199
|
#
|
923
|
-
# * Required
|
924
|
-
#
|
925
|
-
# * Must be 1 to 128 letters or numbers.
|
926
|
-
#
|
927
|
-
# * The first character must be a letter.
|
928
|
-
#
|
929
|
-
# * Can't be a reserved word for the chosen database engine.
|
930
|
-
#
|
931
|
-
# **MySQL**
|
1200
|
+
# * Required.
|
932
1201
|
#
|
933
|
-
#
|
934
|
-
#
|
935
|
-
# * Required for MySQL.
|
936
|
-
#
|
937
|
-
# * Must be 1 to 16 letters or numbers.
|
938
|
-
#
|
939
|
-
# * First character must be a letter.
|
940
|
-
#
|
941
|
-
# * Can't be a reserved word for the chosen database engine.
|
942
|
-
#
|
943
|
-
# **Oracle**
|
944
|
-
#
|
945
|
-
# Constraints:
|
946
|
-
#
|
947
|
-
# * Required for Oracle.
|
948
|
-
#
|
949
|
-
# * Must be 1 to 30 letters or numbers.
|
950
|
-
#
|
951
|
-
# * First character must be a letter.
|
952
|
-
#
|
953
|
-
# * Can't be a reserved word for the chosen database engine.
|
954
|
-
#
|
955
|
-
# **PostgreSQL**
|
956
|
-
#
|
957
|
-
# Constraints:
|
958
|
-
#
|
959
|
-
# * Required for PostgreSQL.
|
960
|
-
#
|
961
|
-
# * Must be 1 to 63 letters or numbers.
|
1202
|
+
# * Must be 1 to 16 letters, numbers, or underscores.
|
962
1203
|
#
|
963
1204
|
# * First character must be a letter.
|
964
1205
|
#
|
@@ -1193,27 +1434,28 @@ module Aws::RDS
|
|
1193
1434
|
#
|
1194
1435
|
# **MariaDB**
|
1195
1436
|
#
|
1196
|
-
#
|
1197
|
-
# Guide.*
|
1437
|
+
# For information, see [MariaDB on Amazon RDS Versions][2] in the
|
1438
|
+
# *Amazon RDS User Guide.*
|
1198
1439
|
#
|
1199
1440
|
# **Microsoft SQL Server**
|
1200
1441
|
#
|
1201
|
-
#
|
1202
|
-
# RDS User Guide.*
|
1442
|
+
# For information, see [Microsoft SQL Server Versions on Amazon RDS][3]
|
1443
|
+
# in the *Amazon RDS User Guide.*
|
1203
1444
|
#
|
1204
1445
|
# **MySQL**
|
1205
1446
|
#
|
1206
|
-
#
|
1447
|
+
# For information, see [MySQL on Amazon RDS Versions][4] in the *Amazon
|
1448
|
+
# RDS User Guide.*
|
1207
1449
|
#
|
1208
1450
|
# **Oracle**
|
1209
1451
|
#
|
1210
|
-
#
|
1211
|
-
# Guide.*
|
1452
|
+
# For information, see [Oracle Database Engine Release Notes][5] in the
|
1453
|
+
# *Amazon RDS User Guide.*
|
1212
1454
|
#
|
1213
1455
|
# **PostgreSQL**
|
1214
1456
|
#
|
1215
|
-
#
|
1216
|
-
# *Amazon RDS User Guide.*
|
1457
|
+
# For information, see [Amazon RDS for PostgreSQL versions and
|
1458
|
+
# extensions][6] in the *Amazon RDS User Guide.*
|
1217
1459
|
#
|
1218
1460
|
#
|
1219
1461
|
#
|
@@ -1240,8 +1482,8 @@ module Aws::RDS
|
|
1240
1482
|
# @option options [Integer] :iops
|
1241
1483
|
# The amount of Provisioned IOPS (input/output operations per second) to
|
1242
1484
|
# be initially allocated for the DB instance. For information about
|
1243
|
-
# valid Iops values, see [Amazon RDS Provisioned IOPS
|
1244
|
-
#
|
1485
|
+
# valid `Iops` values, see [Amazon RDS Provisioned IOPS storage to
|
1486
|
+
# improve performance][1] in the *Amazon RDS User Guide*.
|
1245
1487
|
#
|
1246
1488
|
# Constraints: For MariaDB, MySQL, Oracle, and PostgreSQL DB instances,
|
1247
1489
|
# must be a multiple between .5 and 50 of the storage amount for the DB
|
@@ -1279,12 +1521,13 @@ module Aws::RDS
|
|
1279
1521
|
# @option options [Boolean] :publicly_accessible
|
1280
1522
|
# A value that indicates whether the DB instance is publicly accessible.
|
1281
1523
|
#
|
1282
|
-
# When the DB instance is publicly accessible, its
|
1283
|
-
# to the private IP address from within the DB
|
1284
|
-
#
|
1285
|
-
#
|
1286
|
-
#
|
1287
|
-
#
|
1524
|
+
# When the DB instance is publicly accessible, its Domain Name System
|
1525
|
+
# (DNS) endpoint resolves to the private IP address from within the DB
|
1526
|
+
# instance's virtual private cloud (VPC). It resolves to the public IP
|
1527
|
+
# address from outside of the DB instance's VPC. Access to the DB
|
1528
|
+
# instance is ultimately controlled by the security group it uses. That
|
1529
|
+
# public access is not permitted if the security group assigned to the
|
1530
|
+
# DB instance doesn't permit it.
|
1288
1531
|
#
|
1289
1532
|
# When the DB instance isn't publicly accessible, it is an internal DB
|
1290
1533
|
# instance with a DNS name that resolves to a private IP address.
|
@@ -1295,19 +1538,19 @@ module Aws::RDS
|
|
1295
1538
|
# If `DBSubnetGroupName` isn't specified, and `PubliclyAccessible`
|
1296
1539
|
# isn't specified, the following applies:
|
1297
1540
|
#
|
1298
|
-
# * If the default VPC in the target
|
1541
|
+
# * If the default VPC in the target Region doesn’t have an internet
|
1299
1542
|
# gateway attached to it, the DB instance is private.
|
1300
1543
|
#
|
1301
|
-
# * If the default VPC in the target
|
1544
|
+
# * If the default VPC in the target Region has an internet gateway
|
1302
1545
|
# attached to it, the DB instance is public.
|
1303
1546
|
#
|
1304
1547
|
# If `DBSubnetGroupName` is specified, and `PubliclyAccessible` isn't
|
1305
1548
|
# specified, the following applies:
|
1306
1549
|
#
|
1307
|
-
# * If the subnets are part of a VPC that doesn’t have an
|
1550
|
+
# * If the subnets are part of a VPC that doesn’t have an internet
|
1308
1551
|
# gateway attached to it, the DB instance is private.
|
1309
1552
|
#
|
1310
|
-
# * If the subnets are part of a VPC that has an
|
1553
|
+
# * If the subnets are part of a VPC that has an internet gateway
|
1311
1554
|
# attached to it, the DB instance is public.
|
1312
1555
|
# @option options [Array<Types::Tag>] :tags
|
1313
1556
|
# Tags to assign to the DB instance.
|
@@ -1451,7 +1694,7 @@ module Aws::RDS
|
|
1451
1694
|
# @option options [Boolean] :enable_iam_database_authentication
|
1452
1695
|
# A value that indicates whether to enable mapping of Amazon Web
|
1453
1696
|
# Services Identity and Access Management (IAM) accounts to database
|
1454
|
-
# accounts. By default, mapping
|
1697
|
+
# accounts. By default, mapping isn't enabled.
|
1455
1698
|
#
|
1456
1699
|
# This setting doesn't apply to RDS Custom or Amazon Aurora. In Aurora,
|
1457
1700
|
# mapping Amazon Web Services IAM accounts to database accounts is
|
@@ -1537,7 +1780,7 @@ module Aws::RDS
|
|
1537
1780
|
# @option options [Boolean] :deletion_protection
|
1538
1781
|
# A value that indicates whether the DB instance has deletion protection
|
1539
1782
|
# enabled. The database can't be deleted when deletion protection is
|
1540
|
-
# enabled. By default, deletion protection
|
1783
|
+
# enabled. By default, deletion protection isn't enabled. For more
|
1541
1784
|
# information, see [ Deleting a DB Instance][1].
|
1542
1785
|
#
|
1543
1786
|
# **Amazon Aurora**
|
@@ -1605,6 +1848,18 @@ module Aws::RDS
|
|
1605
1848
|
#
|
1606
1849
|
#
|
1607
1850
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-setup-orcl.html#custom-setup-orcl.iam-vpc
|
1851
|
+
# @option options [String] :backup_target
|
1852
|
+
# Specifies where automated backups and manual snapshots are stored.
|
1853
|
+
#
|
1854
|
+
# Possible values are `outposts` (Amazon Web Services Outposts) and
|
1855
|
+
# `region` (Amazon Web Services Region). The default is `region`.
|
1856
|
+
#
|
1857
|
+
# For more information, see [Working with Amazon RDS on Amazon Web
|
1858
|
+
# Services Outposts][1] in the *Amazon RDS User Guide*.
|
1859
|
+
#
|
1860
|
+
#
|
1861
|
+
#
|
1862
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html
|
1608
1863
|
# @return [DBInstance]
|
1609
1864
|
def create_db_instance(options = {})
|
1610
1865
|
resp = @client.create_db_instance(options)
|