aws-sdk-rds 1.128.0 → 1.132.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 +2812 -633
- data/lib/aws-sdk-rds/client_api.rb +158 -0
- data/lib/aws-sdk-rds/db_cluster.rb +757 -99
- data/lib/aws-sdk-rds/db_cluster_parameter_group.rb +12 -0
- data/lib/aws-sdk-rds/db_cluster_snapshot.rb +186 -38
- data/lib/aws-sdk-rds/db_engine.rb +8 -0
- data/lib/aws-sdk-rds/db_engine_version.rb +66 -4
- data/lib/aws-sdk-rds/db_instance.rb +622 -252
- data/lib/aws-sdk-rds/db_snapshot.rb +111 -41
- data/lib/aws-sdk-rds/errors.rb +44 -0
- data/lib/aws-sdk-rds/plugins/cross_region_copying.rb +5 -1
- data/lib/aws-sdk-rds/resource.rb +542 -160
- data/lib/aws-sdk-rds/types.rb +2805 -614
- 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,50 +336,60 @@ 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.
|
263
360
|
#
|
264
361
|
# The Amazon Web Services KMS key identifier is the key ARN, key ID,
|
265
|
-
# alias ARN, or alias name for the
|
266
|
-
#
|
267
|
-
#
|
362
|
+
# alias ARN, or alias name for the KMS key. To use a KMS key in a
|
363
|
+
# different Amazon Web Services account, specify the key ARN or alias
|
364
|
+
# ARN.
|
268
365
|
#
|
269
|
-
# When a
|
366
|
+
# When a KMS key isn't specified in `KmsKeyId`\:
|
270
367
|
#
|
271
368
|
# * If `ReplicationSourceIdentifier` identifies an encrypted source,
|
272
|
-
# then Amazon RDS will use the
|
273
|
-
# Otherwise, Amazon RDS will use your default
|
369
|
+
# then Amazon RDS will use the KMS key used to encrypt the source.
|
370
|
+
# Otherwise, Amazon RDS will use your default KMS key.
|
274
371
|
#
|
275
372
|
# * If the `StorageEncrypted` parameter is enabled and
|
276
373
|
# `ReplicationSourceIdentifier` isn't specified, then Amazon RDS will
|
277
|
-
# use your default
|
374
|
+
# use your default KMS key.
|
278
375
|
#
|
279
|
-
# There is a default
|
280
|
-
# Amazon Web Services account has a different default
|
376
|
+
# There is a default KMS key for your Amazon Web Services account. Your
|
377
|
+
# Amazon Web Services account has a different default KMS key for each
|
281
378
|
# Amazon Web Services Region.
|
282
379
|
#
|
283
380
|
# If you create a read replica of an encrypted DB cluster in another
|
284
|
-
# Amazon Web Services Region, you must set `KmsKeyId` to a
|
285
|
-
#
|
286
|
-
#
|
287
|
-
#
|
381
|
+
# Amazon Web Services Region, you must set `KmsKeyId` to a KMS key
|
382
|
+
# identifier that is valid in the destination Amazon Web Services
|
383
|
+
# Region. This KMS key is used to encrypt the read replica in that
|
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
|
@@ -299,12 +398,12 @@ module Aws::RDS
|
|
299
398
|
# The pre-signed URL request must contain the following parameter
|
300
399
|
# values:
|
301
400
|
#
|
302
|
-
# * `KmsKeyId` - The Amazon Web Services KMS key identifier for the
|
303
|
-
# to use to encrypt the copy of the DB cluster in the destination
|
304
|
-
# Amazon Web Services Region. This should refer to the same
|
305
|
-
#
|
306
|
-
#
|
307
|
-
#
|
401
|
+
# * `KmsKeyId` - The Amazon Web Services KMS key identifier for the KMS
|
402
|
+
# key to use to encrypt the copy of the DB cluster in the destination
|
403
|
+
# Amazon Web Services Region. This should refer to the same KMS key
|
404
|
+
# for both the `CreateDBCluster` action that is called in the
|
405
|
+
# destination Amazon Web Services Region, and the action contained in
|
406
|
+
# the pre-signed URL.
|
308
407
|
#
|
309
408
|
# * `DestinationRegion` - The name of the Amazon Web Services Region
|
310
409
|
# that Aurora read replica will be created in.
|
@@ -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
|
@@ -626,6 +912,8 @@ module Aws::RDS
|
|
626
912
|
# deletion_protection: false,
|
627
913
|
# max_allocated_storage: 1,
|
628
914
|
# enable_customer_owned_ip: false,
|
915
|
+
# custom_iam_instance_profile: "String",
|
916
|
+
# backup_target: "String",
|
629
917
|
# })
|
630
918
|
# @param [Hash] options ({})
|
631
919
|
# @option options [String] :db_name
|
@@ -691,6 +979,21 @@ module Aws::RDS
|
|
691
979
|
#
|
692
980
|
# ^
|
693
981
|
#
|
982
|
+
# **Amazon RDS Custom**
|
983
|
+
#
|
984
|
+
# The Oracle System ID (SID) of the created RDS Custom DB instance. If
|
985
|
+
# you don't specify a value, the default value is `ORCL`.
|
986
|
+
#
|
987
|
+
# Default: `ORCL`
|
988
|
+
#
|
989
|
+
# Constraints:
|
990
|
+
#
|
991
|
+
# * It must contain 1 to 8 alphanumeric characters.
|
992
|
+
#
|
993
|
+
# * It must contain a letter.
|
994
|
+
#
|
995
|
+
# * It can't be a word reserved by the database engine.
|
996
|
+
#
|
694
997
|
# **SQL Server**
|
695
998
|
#
|
696
999
|
# Not applicable. Must be null.
|
@@ -748,6 +1051,16 @@ module Aws::RDS
|
|
748
1051
|
# amount of data in your database increases, though you are only charged
|
749
1052
|
# for the space that you use in an Aurora cluster volume.
|
750
1053
|
#
|
1054
|
+
# **Amazon RDS Custom**
|
1055
|
+
#
|
1056
|
+
# Constraints to the amount of storage for each storage type are the
|
1057
|
+
# following:
|
1058
|
+
#
|
1059
|
+
# * General Purpose (SSD) storage (gp2): Must be an integer from 40 to
|
1060
|
+
# 65536.
|
1061
|
+
#
|
1062
|
+
# * Provisioned IOPS storage (io1): Must be an integer from 40 to 65536.
|
1063
|
+
#
|
751
1064
|
# **MySQL**
|
752
1065
|
#
|
753
1066
|
# Constraints to the amount of storage for each storage type are the
|
@@ -826,8 +1139,8 @@ module Aws::RDS
|
|
826
1139
|
#
|
827
1140
|
# * Web and Express editions: Must be an integer from 20 to 1024.
|
828
1141
|
# @option options [required, String] :db_instance_class
|
829
|
-
# The compute and memory capacity of the DB instance, for example
|
830
|
-
#
|
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
|
831
1144
|
# Web Services Regions, or for all database engines. For the full list
|
832
1145
|
# of DB instance classes, and availability for your engine, see [DB
|
833
1146
|
# Instance Class][1] in the *Amazon RDS User Guide.*
|
@@ -849,6 +1162,8 @@ module Aws::RDS
|
|
849
1162
|
#
|
850
1163
|
# * `aurora-postgresql`
|
851
1164
|
#
|
1165
|
+
# * `custom-oracle-ee (for RDS Custom instances)`
|
1166
|
+
#
|
852
1167
|
# * `mariadb`
|
853
1168
|
#
|
854
1169
|
# * `mysql`
|
@@ -878,59 +1193,13 @@ module Aws::RDS
|
|
878
1193
|
# Not applicable. The name for the master user is managed by the DB
|
879
1194
|
# cluster.
|
880
1195
|
#
|
881
|
-
# **
|
882
|
-
#
|
883
|
-
# Constraints:
|
884
|
-
#
|
885
|
-
# * Required for MariaDB.
|
886
|
-
#
|
887
|
-
# * Must be 1 to 16 letters or numbers.
|
888
|
-
#
|
889
|
-
# * Can't be a reserved word for the chosen database engine.
|
890
|
-
#
|
891
|
-
# **Microsoft SQL Server**
|
892
|
-
#
|
893
|
-
# Constraints:
|
894
|
-
#
|
895
|
-
# * Required for SQL Server.
|
896
|
-
#
|
897
|
-
# * Must be 1 to 128 letters or numbers.
|
898
|
-
#
|
899
|
-
# * The first character must be a letter.
|
900
|
-
#
|
901
|
-
# * Can't be a reserved word for the chosen database engine.
|
902
|
-
#
|
903
|
-
# **MySQL**
|
904
|
-
#
|
905
|
-
# Constraints:
|
906
|
-
#
|
907
|
-
# * Required for MySQL.
|
908
|
-
#
|
909
|
-
# * Must be 1 to 16 letters or numbers.
|
910
|
-
#
|
911
|
-
# * First character must be a letter.
|
912
|
-
#
|
913
|
-
# * Can't be a reserved word for the chosen database engine.
|
914
|
-
#
|
915
|
-
# **Oracle**
|
1196
|
+
# **Amazon RDS**
|
916
1197
|
#
|
917
1198
|
# Constraints:
|
918
1199
|
#
|
919
|
-
# * Required
|
1200
|
+
# * Required.
|
920
1201
|
#
|
921
|
-
# * Must be 1 to
|
922
|
-
#
|
923
|
-
# * First character must be a letter.
|
924
|
-
#
|
925
|
-
# * Can't be a reserved word for the chosen database engine.
|
926
|
-
#
|
927
|
-
# **PostgreSQL**
|
928
|
-
#
|
929
|
-
# Constraints:
|
930
|
-
#
|
931
|
-
# * Required for PostgreSQL.
|
932
|
-
#
|
933
|
-
# * Must be 1 to 63 letters or numbers.
|
1202
|
+
# * Must be 1 to 16 letters, numbers, or underscores.
|
934
1203
|
#
|
935
1204
|
# * First character must be a letter.
|
936
1205
|
#
|
@@ -1033,6 +1302,8 @@ module Aws::RDS
|
|
1033
1302
|
# If you do not specify a value, then the default DB parameter group for
|
1034
1303
|
# the specified DB engine and version is used.
|
1035
1304
|
#
|
1305
|
+
# This setting doesn't apply to RDS Custom.
|
1306
|
+
#
|
1036
1307
|
# Constraints:
|
1037
1308
|
#
|
1038
1309
|
# * Must be 1 to 255 letters, numbers, or hyphens.
|
@@ -1057,6 +1328,8 @@ module Aws::RDS
|
|
1057
1328
|
# * Must be a value from 0 to 35
|
1058
1329
|
#
|
1059
1330
|
# * Can't be set to 0 if the DB instance is a source to read replicas
|
1331
|
+
#
|
1332
|
+
# * Can't be set to 0 or 35 for an RDS Custom DB instance
|
1060
1333
|
# @option options [String] :preferred_backup_window
|
1061
1334
|
# The daily time range during which automated backups are created if
|
1062
1335
|
# automated backups are enabled, using the `BackupRetentionPeriod`
|
@@ -1133,6 +1406,8 @@ module Aws::RDS
|
|
1133
1406
|
# A value that indicates whether the DB instance is a Multi-AZ
|
1134
1407
|
# deployment. You can't set the `AvailabilityZone` parameter if the DB
|
1135
1408
|
# instance is a Multi-AZ deployment.
|
1409
|
+
#
|
1410
|
+
# This setting doesn't apply to RDS Custom.
|
1136
1411
|
# @option options [String] :engine_version
|
1137
1412
|
# The version number of the database engine to use.
|
1138
1413
|
#
|
@@ -1149,51 +1424,66 @@ module Aws::RDS
|
|
1149
1424
|
# Not applicable. The version number of the database engine to be used
|
1150
1425
|
# by the DB instance is managed by the DB cluster.
|
1151
1426
|
#
|
1427
|
+
# **Amazon RDS Custom**
|
1428
|
+
#
|
1429
|
+
# A custom engine version (CEV) that you have previously created. This
|
1430
|
+
# setting is required for RDS Custom. The CEV name has the following
|
1431
|
+
# format: `19.customized_string `. An example identifier is
|
1432
|
+
# `19.my_cev1`. For more information, see [ Creating an RDS Custom DB
|
1433
|
+
# instance][1] in the *Amazon RDS User Guide.*.
|
1434
|
+
#
|
1152
1435
|
# **MariaDB**
|
1153
1436
|
#
|
1154
|
-
#
|
1155
|
-
# Guide.*
|
1437
|
+
# For information, see [MariaDB on Amazon RDS Versions][2] in the
|
1438
|
+
# *Amazon RDS User Guide.*
|
1156
1439
|
#
|
1157
1440
|
# **Microsoft SQL Server**
|
1158
1441
|
#
|
1159
|
-
#
|
1160
|
-
# RDS User Guide.*
|
1442
|
+
# For information, see [Microsoft SQL Server Versions on Amazon RDS][3]
|
1443
|
+
# in the *Amazon RDS User Guide.*
|
1161
1444
|
#
|
1162
1445
|
# **MySQL**
|
1163
1446
|
#
|
1164
|
-
#
|
1447
|
+
# For information, see [MySQL on Amazon RDS Versions][4] in the *Amazon
|
1448
|
+
# RDS User Guide.*
|
1165
1449
|
#
|
1166
1450
|
# **Oracle**
|
1167
1451
|
#
|
1168
|
-
#
|
1169
|
-
# Guide.*
|
1452
|
+
# For information, see [Oracle Database Engine Release Notes][5] in the
|
1453
|
+
# *Amazon RDS User Guide.*
|
1170
1454
|
#
|
1171
1455
|
# **PostgreSQL**
|
1172
1456
|
#
|
1173
|
-
#
|
1174
|
-
# *Amazon RDS User Guide.*
|
1457
|
+
# For information, see [Amazon RDS for PostgreSQL versions and
|
1458
|
+
# extensions][6] in the *Amazon RDS User Guide.*
|
1175
1459
|
#
|
1176
1460
|
#
|
1177
1461
|
#
|
1178
|
-
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/
|
1179
|
-
# [2]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/
|
1180
|
-
# [3]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/
|
1181
|
-
# [4]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/
|
1182
|
-
# [5]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/
|
1462
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-creating.html#custom-creating.create
|
1463
|
+
# [2]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_MariaDB.html#MariaDB.Concepts.VersionMgmt
|
1464
|
+
# [3]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_SQLServer.html#SQLServer.Concepts.General.VersionSupport
|
1465
|
+
# [4]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_MySQL.html#MySQL.Concepts.VersionMgmt
|
1466
|
+
# [5]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Appendix.Oracle.PatchComposition.html
|
1467
|
+
# [6]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_PostgreSQL.html#PostgreSQL.Concepts
|
1183
1468
|
# @option options [Boolean] :auto_minor_version_upgrade
|
1184
1469
|
# A value that indicates whether minor engine upgrades are applied
|
1185
1470
|
# automatically to the DB instance during the maintenance window. By
|
1186
1471
|
# default, minor engine upgrades are applied automatically.
|
1472
|
+
#
|
1473
|
+
# If you create an RDS Custom DB instance, you must set
|
1474
|
+
# `AutoMinorVersionUpgrade` to `false`.
|
1187
1475
|
# @option options [String] :license_model
|
1188
1476
|
# License model information for this DB instance.
|
1189
1477
|
#
|
1190
1478
|
# Valid values: `license-included` \| `bring-your-own-license` \|
|
1191
1479
|
# `general-public-license`
|
1480
|
+
#
|
1481
|
+
# This setting doesn't apply to RDS Custom.
|
1192
1482
|
# @option options [Integer] :iops
|
1193
1483
|
# The amount of Provisioned IOPS (input/output operations per second) to
|
1194
1484
|
# be initially allocated for the DB instance. For information about
|
1195
|
-
# valid Iops values, see [Amazon RDS Provisioned IOPS
|
1196
|
-
#
|
1485
|
+
# valid `Iops` values, see [Amazon RDS Provisioned IOPS storage to
|
1486
|
+
# improve performance][1] in the *Amazon RDS User Guide*.
|
1197
1487
|
#
|
1198
1488
|
# Constraints: For MariaDB, MySQL, Oracle, and PostgreSQL DB instances,
|
1199
1489
|
# must be a multiple between .5 and 50 of the storage amount for the DB
|
@@ -1209,11 +1499,16 @@ module Aws::RDS
|
|
1209
1499
|
#
|
1210
1500
|
# Permanent options, such as the TDE option for Oracle Advanced Security
|
1211
1501
|
# TDE, can't be removed from an option group. Also, that option group
|
1212
|
-
# can't be removed from a DB instance
|
1213
|
-
# instance
|
1502
|
+
# can't be removed from a DB instance after it is associated with a DB
|
1503
|
+
# instance.
|
1504
|
+
#
|
1505
|
+
# This setting doesn't apply to RDS Custom.
|
1214
1506
|
# @option options [String] :character_set_name
|
1215
|
-
# For supported engines, indicates that the DB instance
|
1216
|
-
# associated with the specified CharacterSet
|
1507
|
+
# For supported engines, this value indicates that the DB instance
|
1508
|
+
# should be associated with the specified `CharacterSet`.
|
1509
|
+
#
|
1510
|
+
# This setting doesn't apply to RDS Custom. However, if you need to
|
1511
|
+
# change the character set, you can change it on the database itself.
|
1217
1512
|
#
|
1218
1513
|
# **Amazon Aurora**
|
1219
1514
|
#
|
@@ -1221,15 +1516,18 @@ module Aws::RDS
|
|
1221
1516
|
# more information, see `CreateDBCluster`.
|
1222
1517
|
# @option options [String] :nchar_character_set_name
|
1223
1518
|
# The name of the NCHAR character set for the Oracle DB instance.
|
1519
|
+
#
|
1520
|
+
# This parameter doesn't apply to RDS Custom.
|
1224
1521
|
# @option options [Boolean] :publicly_accessible
|
1225
1522
|
# A value that indicates whether the DB instance is publicly accessible.
|
1226
1523
|
#
|
1227
|
-
# When the DB instance is publicly accessible, its
|
1228
|
-
# to the private IP address from within the DB
|
1229
|
-
#
|
1230
|
-
#
|
1231
|
-
#
|
1232
|
-
#
|
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.
|
1233
1531
|
#
|
1234
1532
|
# When the DB instance isn't publicly accessible, it is an internal DB
|
1235
1533
|
# instance with a DNS name that resolves to a private IP address.
|
@@ -1240,24 +1538,26 @@ module Aws::RDS
|
|
1240
1538
|
# If `DBSubnetGroupName` isn't specified, and `PubliclyAccessible`
|
1241
1539
|
# isn't specified, the following applies:
|
1242
1540
|
#
|
1243
|
-
# * If the default VPC in the target
|
1541
|
+
# * If the default VPC in the target Region doesn’t have an internet
|
1244
1542
|
# gateway attached to it, the DB instance is private.
|
1245
1543
|
#
|
1246
|
-
# * If the default VPC in the target
|
1544
|
+
# * If the default VPC in the target Region has an internet gateway
|
1247
1545
|
# attached to it, the DB instance is public.
|
1248
1546
|
#
|
1249
1547
|
# If `DBSubnetGroupName` is specified, and `PubliclyAccessible` isn't
|
1250
1548
|
# specified, the following applies:
|
1251
1549
|
#
|
1252
|
-
# * 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
|
1253
1551
|
# gateway attached to it, the DB instance is private.
|
1254
1552
|
#
|
1255
|
-
# * 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
|
1256
1554
|
# attached to it, the DB instance is public.
|
1257
1555
|
# @option options [Array<Types::Tag>] :tags
|
1258
1556
|
# Tags to assign to the DB instance.
|
1259
1557
|
# @option options [String] :db_cluster_identifier
|
1260
1558
|
# The identifier of the DB cluster that the instance will belong to.
|
1559
|
+
#
|
1560
|
+
# This setting doesn't apply to RDS Custom.
|
1261
1561
|
# @option options [String] :storage_type
|
1262
1562
|
# Specifies the storage type to be associated with the DB instance.
|
1263
1563
|
#
|
@@ -1270,13 +1570,21 @@ module Aws::RDS
|
|
1270
1570
|
# @option options [String] :tde_credential_arn
|
1271
1571
|
# The ARN from the key store with which to associate the instance for
|
1272
1572
|
# TDE encryption.
|
1573
|
+
#
|
1574
|
+
# This setting doesn't apply to RDS Custom.
|
1273
1575
|
# @option options [String] :tde_credential_password
|
1274
1576
|
# The password for the given ARN from the key store in order to access
|
1275
1577
|
# the device.
|
1578
|
+
#
|
1579
|
+
# This setting doesn't apply to RDS Custom.
|
1276
1580
|
# @option options [Boolean] :storage_encrypted
|
1277
1581
|
# A value that indicates whether the DB instance is encrypted. By
|
1278
1582
|
# default, it isn't encrypted.
|
1279
1583
|
#
|
1584
|
+
# For RDS Custom Oracle instances, either set this parameter to `true`
|
1585
|
+
# or leave it unset. If you set this parameter to `false`, RDS reports
|
1586
|
+
# an error.
|
1587
|
+
#
|
1280
1588
|
# **Amazon Aurora**
|
1281
1589
|
#
|
1282
1590
|
# Not applicable. The encryption for DB instances is managed by the DB
|
@@ -1286,9 +1594,9 @@ module Aws::RDS
|
|
1286
1594
|
# instance.
|
1287
1595
|
#
|
1288
1596
|
# The Amazon Web Services KMS key identifier is the key ARN, key ID,
|
1289
|
-
# alias ARN, or alias name for the
|
1290
|
-
#
|
1291
|
-
#
|
1597
|
+
# alias ARN, or alias name for the KMS key. To use a KMS key in a
|
1598
|
+
# different Amazon Web Services account, specify the key ARN or alias
|
1599
|
+
# ARN.
|
1292
1600
|
#
|
1293
1601
|
# **Amazon Aurora**
|
1294
1602
|
#
|
@@ -1296,10 +1604,18 @@ module Aws::RDS
|
|
1296
1604
|
# by the DB cluster. For more information, see `CreateDBCluster`.
|
1297
1605
|
#
|
1298
1606
|
# If `StorageEncrypted` is enabled, and you do not specify a value for
|
1299
|
-
# the `KmsKeyId` parameter, then Amazon RDS uses your default
|
1300
|
-
# is a default
|
1301
|
-
# Services account has a different default
|
1302
|
-
# Services Region.
|
1607
|
+
# the `KmsKeyId` parameter, then Amazon RDS uses your default KMS key.
|
1608
|
+
# There is a default KMS key for your Amazon Web Services account. Your
|
1609
|
+
# Amazon Web Services account has a different default KMS key for each
|
1610
|
+
# Amazon Web Services Region.
|
1611
|
+
#
|
1612
|
+
# **Amazon RDS Custom**
|
1613
|
+
#
|
1614
|
+
# A KMS key is required for RDS Custom Oracle instances. For most RDS
|
1615
|
+
# engines, if you leave this parameter empty while enabling
|
1616
|
+
# `StorageEncrypted`, the engine uses the default KMS key. However, RDS
|
1617
|
+
# Custom for Oracle doesn't use the default key when this parameter is
|
1618
|
+
# empty. You must explicitly specify a key.
|
1303
1619
|
# @option options [String] :domain
|
1304
1620
|
# The Active Directory directory ID to create the DB instance in.
|
1305
1621
|
# Currently, only MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB
|
@@ -1308,6 +1624,8 @@ module Aws::RDS
|
|
1308
1624
|
# For more information, see [ Kerberos Authentication][1] in the *Amazon
|
1309
1625
|
# RDS User Guide*.
|
1310
1626
|
#
|
1627
|
+
# This setting doesn't apply to RDS Custom.
|
1628
|
+
#
|
1311
1629
|
#
|
1312
1630
|
#
|
1313
1631
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/kerberos-authentication.html
|
@@ -1322,35 +1640,43 @@ module Aws::RDS
|
|
1322
1640
|
# the DB cluster setting.
|
1323
1641
|
# @option options [Integer] :monitoring_interval
|
1324
1642
|
# The interval, in seconds, between points when Enhanced Monitoring
|
1325
|
-
# metrics are collected for the DB instance. To disable
|
1643
|
+
# metrics are collected for the DB instance. To disable collection of
|
1326
1644
|
# Enhanced Monitoring metrics, specify 0. The default is 0.
|
1327
1645
|
#
|
1328
|
-
# If `MonitoringRoleArn` is specified, then you must
|
1646
|
+
# If `MonitoringRoleArn` is specified, then you must set
|
1329
1647
|
# `MonitoringInterval` to a value other than 0.
|
1330
1648
|
#
|
1649
|
+
# This setting doesn't apply to RDS Custom.
|
1650
|
+
#
|
1331
1651
|
# Valid Values: `0, 1, 5, 10, 15, 30, 60`
|
1332
1652
|
# @option options [String] :monitoring_role_arn
|
1333
1653
|
# The ARN for the IAM role that permits RDS to send enhanced monitoring
|
1334
1654
|
# metrics to Amazon CloudWatch Logs. For example,
|
1335
1655
|
# `arn:aws:iam:123456789012:role/emaccess`. For information on creating
|
1336
|
-
# a monitoring role,
|
1656
|
+
# a monitoring role, see [Setting Up and Enabling Enhanced
|
1337
1657
|
# Monitoring][1] in the *Amazon RDS User Guide*.
|
1338
1658
|
#
|
1339
1659
|
# If `MonitoringInterval` is set to a value other than 0, then you must
|
1340
1660
|
# supply a `MonitoringRoleArn` value.
|
1341
1661
|
#
|
1662
|
+
# This setting doesn't apply to RDS Custom.
|
1663
|
+
#
|
1342
1664
|
#
|
1343
1665
|
#
|
1344
1666
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Monitoring.OS.html#USER_Monitoring.OS.Enabling
|
1345
1667
|
# @option options [String] :domain_iam_role_name
|
1346
1668
|
# Specify the name of the IAM role to be used when making API calls to
|
1347
1669
|
# the Directory Service.
|
1670
|
+
#
|
1671
|
+
# This setting doesn't apply to RDS Custom.
|
1348
1672
|
# @option options [Integer] :promotion_tier
|
1349
1673
|
# A value that specifies the order in which an Aurora Replica is
|
1350
1674
|
# promoted to the primary instance after a failure of the existing
|
1351
1675
|
# primary instance. For more information, see [ Fault Tolerance for an
|
1352
1676
|
# Aurora DB Cluster][1] in the *Amazon Aurora User Guide*.
|
1353
1677
|
#
|
1678
|
+
# This setting doesn't apply to RDS Custom.
|
1679
|
+
#
|
1354
1680
|
# Default: 1
|
1355
1681
|
#
|
1356
1682
|
# Valid Values: 0 - 15
|
@@ -1368,11 +1694,11 @@ module Aws::RDS
|
|
1368
1694
|
# @option options [Boolean] :enable_iam_database_authentication
|
1369
1695
|
# A value that indicates whether to enable mapping of Amazon Web
|
1370
1696
|
# Services Identity and Access Management (IAM) accounts to database
|
1371
|
-
# accounts. By default, mapping
|
1697
|
+
# accounts. By default, mapping isn't enabled.
|
1372
1698
|
#
|
1373
|
-
# This setting doesn't apply to Amazon Aurora.
|
1374
|
-
# Services IAM accounts to database accounts is
|
1375
|
-
# cluster.
|
1699
|
+
# This setting doesn't apply to RDS Custom or Amazon Aurora. In Aurora,
|
1700
|
+
# mapping Amazon Web Services IAM accounts to database accounts is
|
1701
|
+
# managed by the DB cluster.
|
1376
1702
|
#
|
1377
1703
|
# For more information, see [ IAM Database Authentication for MySQL and
|
1378
1704
|
# PostgreSQL][1] in the *Amazon RDS User Guide.*
|
@@ -1382,10 +1708,10 @@ module Aws::RDS
|
|
1382
1708
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.IAMDBAuth.html
|
1383
1709
|
# @option options [Boolean] :enable_performance_insights
|
1384
1710
|
# A value that indicates whether to enable Performance Insights for the
|
1385
|
-
# DB instance.
|
1711
|
+
# DB instance. For more information, see [Using Amazon Performance
|
1712
|
+
# Insights][1] in the *Amazon Relational Database Service User Guide*.
|
1386
1713
|
#
|
1387
|
-
#
|
1388
|
-
# the *Amazon Relational Database Service User Guide*.
|
1714
|
+
# This setting doesn't apply to RDS Custom.
|
1389
1715
|
#
|
1390
1716
|
#
|
1391
1717
|
#
|
@@ -1395,27 +1721,33 @@ module Aws::RDS
|
|
1395
1721
|
# Performance Insights data.
|
1396
1722
|
#
|
1397
1723
|
# The Amazon Web Services KMS key identifier is the key ARN, key ID,
|
1398
|
-
# alias ARN, or alias name for the
|
1399
|
-
# master key (CMK).
|
1724
|
+
# alias ARN, or alias name for the KMS key.
|
1400
1725
|
#
|
1401
1726
|
# If you do not specify a value for `PerformanceInsightsKMSKeyId`, then
|
1402
|
-
# Amazon RDS uses your default
|
1403
|
-
# Amazon Web Services account. Your Amazon Web Services account has
|
1404
|
-
# different default
|
1727
|
+
# Amazon RDS uses your default KMS key. There is a default KMS key for
|
1728
|
+
# your Amazon Web Services account. Your Amazon Web Services account has
|
1729
|
+
# a different default KMS key for each Amazon Web Services Region.
|
1730
|
+
#
|
1731
|
+
# This setting doesn't apply to RDS Custom.
|
1405
1732
|
# @option options [Integer] :performance_insights_retention_period
|
1406
1733
|
# The amount of time, in days, to retain Performance Insights data.
|
1407
1734
|
# Valid values are 7 or 731 (2 years).
|
1735
|
+
#
|
1736
|
+
# This setting doesn't apply to RDS Custom.
|
1408
1737
|
# @option options [Array<String>] :enable_cloudwatch_logs_exports
|
1409
1738
|
# The list of log types that need to be enabled for exporting to
|
1410
|
-
# CloudWatch Logs. The values in the list depend on the DB engine
|
1411
|
-
#
|
1412
|
-
#
|
1413
|
-
# Guide*.
|
1739
|
+
# CloudWatch Logs. The values in the list depend on the DB engine. For
|
1740
|
+
# more information, see [Publishing Database Logs to Amazon CloudWatch
|
1741
|
+
# Logs][1] in the *Amazon Relational Database Service User Guide*.
|
1414
1742
|
#
|
1415
1743
|
# **Amazon Aurora**
|
1416
1744
|
#
|
1417
1745
|
# Not applicable. CloudWatch Logs exports are managed by the DB cluster.
|
1418
1746
|
#
|
1747
|
+
# **RDS Custom**
|
1748
|
+
#
|
1749
|
+
# Not applicable.
|
1750
|
+
#
|
1419
1751
|
# **MariaDB**
|
1420
1752
|
#
|
1421
1753
|
# Possible values are `audit`, `error`, `general`, and `slowquery`.
|
@@ -1443,10 +1775,12 @@ module Aws::RDS
|
|
1443
1775
|
# @option options [Array<Types::ProcessorFeature>] :processor_features
|
1444
1776
|
# The number of CPU cores and the number of threads per core for the DB
|
1445
1777
|
# instance class of the DB instance.
|
1778
|
+
#
|
1779
|
+
# This setting doesn't apply to RDS Custom.
|
1446
1780
|
# @option options [Boolean] :deletion_protection
|
1447
1781
|
# A value that indicates whether the DB instance has deletion protection
|
1448
1782
|
# enabled. The database can't be deleted when deletion protection is
|
1449
|
-
# enabled. By default, deletion protection
|
1783
|
+
# enabled. By default, deletion protection isn't enabled. For more
|
1450
1784
|
# information, see [ Deleting a DB Instance][1].
|
1451
1785
|
#
|
1452
1786
|
# **Amazon Aurora**
|
@@ -1467,6 +1801,8 @@ module Aws::RDS
|
|
1467
1801
|
# apply to it, see [ Managing capacity automatically with Amazon RDS
|
1468
1802
|
# storage autoscaling][1] in the *Amazon RDS User Guide*.
|
1469
1803
|
#
|
1804
|
+
# This setting doesn't apply to RDS Custom.
|
1805
|
+
#
|
1470
1806
|
#
|
1471
1807
|
#
|
1472
1808
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PIOPS.StorageTypes.html#USER_PIOPS.Autoscaling
|
@@ -1490,6 +1826,40 @@ module Aws::RDS
|
|
1490
1826
|
#
|
1491
1827
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html
|
1492
1828
|
# [2]: https://docs.aws.amazon.com/outposts/latest/userguide/outposts-networking-components.html#ip-addressing
|
1829
|
+
# @option options [String] :custom_iam_instance_profile
|
1830
|
+
# The instance profile associated with the underlying Amazon EC2
|
1831
|
+
# instance of an RDS Custom DB instance. The instance profile must meet
|
1832
|
+
# the following requirements:
|
1833
|
+
#
|
1834
|
+
# * The profile must exist in your account.
|
1835
|
+
#
|
1836
|
+
# * The profile must have an IAM role that Amazon EC2 has permissions to
|
1837
|
+
# assume.
|
1838
|
+
#
|
1839
|
+
# * The instance profile name and the associated IAM role name must
|
1840
|
+
# start with the prefix `AWSRDSCustom`.
|
1841
|
+
#
|
1842
|
+
# For the list of permissions required for the IAM role, see [ Configure
|
1843
|
+
# IAM and your VPC][1] in the *Amazon Relational Database Service User
|
1844
|
+
# Guide*.
|
1845
|
+
#
|
1846
|
+
# This setting is required for RDS Custom.
|
1847
|
+
#
|
1848
|
+
#
|
1849
|
+
#
|
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
|
1493
1863
|
# @return [DBInstance]
|
1494
1864
|
def create_db_instance(options = {})
|
1495
1865
|
resp = @client.create_db_instance(options)
|
@@ -2131,6 +2501,10 @@ module Aws::RDS
|
|
2131
2501
|
# If this parameter is enabled and the requested engine supports the
|
2132
2502
|
# `CharacterSetName` parameter for `CreateDBInstance`, the response
|
2133
2503
|
# includes a list of supported character sets for each engine version.
|
2504
|
+
#
|
2505
|
+
# For RDS Custom, the default is not to list supported character sets.
|
2506
|
+
# If you set `ListSupportedCharacterSets` to `true`, RDS Custom returns
|
2507
|
+
# no results.
|
2134
2508
|
# @option options [Boolean] :list_supported_timezones
|
2135
2509
|
# A value that indicates whether to list the supported time zones for
|
2136
2510
|
# each engine version.
|
@@ -2138,6 +2512,10 @@ module Aws::RDS
|
|
2138
2512
|
# If this parameter is enabled and the requested engine supports the
|
2139
2513
|
# `TimeZone` parameter for `CreateDBInstance`, the response includes a
|
2140
2514
|
# list of supported time zones for each engine version.
|
2515
|
+
#
|
2516
|
+
# For RDS Custom, the default is not to list supported time zones. If
|
2517
|
+
# you set `ListSupportedTimezones` to `true`, RDS Custom returns no
|
2518
|
+
# results.
|
2141
2519
|
# @option options [Boolean] :include_all
|
2142
2520
|
# A value that indicates whether to include engine versions that aren't
|
2143
2521
|
# available in the list. The default is to list only available engine
|
@@ -2441,6 +2819,8 @@ module Aws::RDS
|
|
2441
2819
|
# You can give an Amazon Web Services account permission to restore a
|
2442
2820
|
# manual DB snapshot from another Amazon Web Services account by using
|
2443
2821
|
# the `ModifyDBSnapshotAttribute` API action.
|
2822
|
+
#
|
2823
|
+
# This setting doesn't apply to RDS Custom.
|
2444
2824
|
# @option options [Boolean] :include_public
|
2445
2825
|
# A value that indicates whether to include manual DB cluster snapshots
|
2446
2826
|
# that are public and can be copied or restored by any Amazon Web
|
@@ -2448,6 +2828,8 @@ module Aws::RDS
|
|
2448
2828
|
#
|
2449
2829
|
# You can share a manual DB snapshot as public by using the
|
2450
2830
|
# ModifyDBSnapshotAttribute API.
|
2831
|
+
#
|
2832
|
+
# This setting doesn't apply to RDS Custom.
|
2451
2833
|
# @option options [String] :dbi_resource_id
|
2452
2834
|
# A specific DB resource ID to describe.
|
2453
2835
|
# @return [DBSnapshot::Collection]
|
@@ -2608,7 +2990,7 @@ module Aws::RDS
|
|
2608
2990
|
#
|
2609
2991
|
# events = rds.events({
|
2610
2992
|
# source_identifier: "String",
|
2611
|
-
# source_type: "db-instance", # accepts db-instance, db-parameter-group, db-security-group, db-snapshot, db-cluster, db-cluster-snapshot
|
2993
|
+
# source_type: "db-instance", # accepts db-instance, db-parameter-group, db-security-group, db-snapshot, db-cluster, db-cluster-snapshot, custom-engine-version
|
2612
2994
|
# start_time: Time.now,
|
2613
2995
|
# end_time: Time.now,
|
2614
2996
|
# duration: 1,
|