aws-sdk-rds 1.7.0 → 1.8.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/lib/aws-sdk-rds.rb +1 -1
- data/lib/aws-sdk-rds/client.rb +875 -310
- data/lib/aws-sdk-rds/client_api.rb +69 -0
- data/lib/aws-sdk-rds/db_cluster.rb +66 -59
- data/lib/aws-sdk-rds/db_cluster_parameter_group.rb +8 -3
- data/lib/aws-sdk-rds/db_cluster_snapshot.rb +24 -20
- data/lib/aws-sdk-rds/db_instance.rb +182 -156
- data/lib/aws-sdk-rds/db_parameter_group.rb +12 -2
- data/lib/aws-sdk-rds/db_security_group.rb +7 -2
- data/lib/aws-sdk-rds/db_snapshot.rb +53 -35
- data/lib/aws-sdk-rds/db_subnet_group.rb +6 -1
- data/lib/aws-sdk-rds/event_subscription.rb +7 -2
- data/lib/aws-sdk-rds/option_group.rb +12 -2
- data/lib/aws-sdk-rds/reserved_db_instances_offering.rb +6 -1
- data/lib/aws-sdk-rds/resource.rb +156 -113
- data/lib/aws-sdk-rds/types.rb +918 -731
- metadata +2 -2
@@ -204,7 +204,12 @@ module Aws::RDS
|
|
204
204
|
# @option options [required, String] :description
|
205
205
|
# The description for the DB parameter group.
|
206
206
|
# @option options [Array<Types::Tag>] :tags
|
207
|
-
# A list of tags.
|
207
|
+
# A list of tags. For more information, see [Tagging Amazon RDS
|
208
|
+
# Resources][1].
|
209
|
+
#
|
210
|
+
#
|
211
|
+
#
|
212
|
+
# [1]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html
|
208
213
|
# @return [DBParameterGroup]
|
209
214
|
def create(options = {})
|
210
215
|
options = options.merge(db_parameter_group_name: @name)
|
@@ -246,7 +251,12 @@ module Aws::RDS
|
|
246
251
|
# @option options [required, String] :target_db_parameter_group_description
|
247
252
|
# A description for the copied DB parameter group.
|
248
253
|
# @option options [Array<Types::Tag>] :tags
|
249
|
-
# A list of tags.
|
254
|
+
# A list of tags. For more information, see [Tagging Amazon RDS
|
255
|
+
# Resources][1].
|
256
|
+
#
|
257
|
+
#
|
258
|
+
#
|
259
|
+
# [1]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html
|
250
260
|
# @return [DBParameterGroup]
|
251
261
|
def copy(options = {})
|
252
262
|
options = options.merge(source_db_parameter_group_identifier: @name)
|
@@ -252,7 +252,12 @@ module Aws::RDS
|
|
252
252
|
# @option options [required, String] :db_security_group_description
|
253
253
|
# The description for the DB security group.
|
254
254
|
# @option options [Array<Types::Tag>] :tags
|
255
|
-
# A list of tags.
|
255
|
+
# A list of tags. For more information, see [Tagging Amazon RDS
|
256
|
+
# Resources][1].
|
257
|
+
#
|
258
|
+
#
|
259
|
+
#
|
260
|
+
# [1]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html
|
256
261
|
# @return [DBSecurityGroup]
|
257
262
|
def create(options = {})
|
258
263
|
options = options.merge(db_security_group_name: @name)
|
@@ -287,7 +292,7 @@ module Aws::RDS
|
|
287
292
|
# @option options [String] :cidrip
|
288
293
|
# The IP range to revoke access from. Must be a valid CIDR range. If
|
289
294
|
# `CIDRIP` is specified, `EC2SecurityGroupName`, `EC2SecurityGroupId`
|
290
|
-
# and `EC2SecurityGroupOwnerId`
|
295
|
+
# and `EC2SecurityGroupOwnerId` can't be provided.
|
291
296
|
# @option options [String] :ec2_security_group_name
|
292
297
|
# The name of the EC2 security group to revoke access from. For VPC DB
|
293
298
|
# security groups, `EC2SecurityGroupId` must be provided. Otherwise,
|
@@ -168,8 +168,8 @@ module Aws::RDS
|
|
168
168
|
data[:encrypted]
|
169
169
|
end
|
170
170
|
|
171
|
-
# If `Encrypted` is true, the KMS key identifier for the encrypted
|
172
|
-
# snapshot.
|
171
|
+
# If `Encrypted` is true, the AWS KMS key identifier for the encrypted
|
172
|
+
# DB snapshot.
|
173
173
|
# @return [String]
|
174
174
|
def kms_key_id
|
175
175
|
data[:kms_key_id]
|
@@ -191,7 +191,7 @@ module Aws::RDS
|
|
191
191
|
end
|
192
192
|
|
193
193
|
# True if mapping of AWS Identity and Access Management (IAM) accounts
|
194
|
-
# to database accounts is enabled
|
194
|
+
# to database accounts is enabled, and otherwise false.
|
195
195
|
# @return [Boolean]
|
196
196
|
def iam_database_authentication_enabled
|
197
197
|
data[:iam_database_authentication_enabled]
|
@@ -341,7 +341,12 @@ module Aws::RDS
|
|
341
341
|
# })
|
342
342
|
# @param [Hash] options ({})
|
343
343
|
# @option options [Array<Types::Tag>] :tags
|
344
|
-
# A list of tags.
|
344
|
+
# A list of tags. For more information, see [Tagging Amazon RDS
|
345
|
+
# Resources][1].
|
346
|
+
#
|
347
|
+
#
|
348
|
+
#
|
349
|
+
# [1]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html
|
345
350
|
# @return [DBSnapshot]
|
346
351
|
def create(options = {})
|
347
352
|
options = options.merge(
|
@@ -408,12 +413,17 @@ module Aws::RDS
|
|
408
413
|
# If you copy an encrypted snapshot to a different AWS Region, then you
|
409
414
|
# must specify a KMS key for the destination AWS Region. KMS encryption
|
410
415
|
# keys are specific to the AWS Region that they are created in, and you
|
411
|
-
#
|
416
|
+
# can't use encryption keys from one AWS Region in another AWS Region.
|
412
417
|
# @option options [Array<Types::Tag>] :tags
|
413
|
-
# A list of tags.
|
418
|
+
# A list of tags. For more information, see [Tagging Amazon RDS
|
419
|
+
# Resources][1].
|
420
|
+
#
|
421
|
+
#
|
422
|
+
#
|
423
|
+
# [1]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html
|
414
424
|
# @option options [Boolean] :copy_tags
|
415
425
|
# True to copy all tags from the source DB snapshot to the target DB
|
416
|
-
# snapshot
|
426
|
+
# snapshot, and otherwise false. The default is false.
|
417
427
|
# @option options [String] :pre_signed_url
|
418
428
|
# The URL that contains a Signature Version 4 signed request for the
|
419
429
|
# `CopyDBSnapshot` API action in the source AWS Region that contains the
|
@@ -421,8 +431,8 @@ module Aws::RDS
|
|
421
431
|
#
|
422
432
|
# You must specify this parameter when you copy an encrypted DB snapshot
|
423
433
|
# from another AWS Region by using the Amazon RDS API. You can specify
|
424
|
-
# the source
|
425
|
-
# encrypted DB snapshot from another AWS Region by using the AWS CLI.
|
434
|
+
# the `--source-region` option instead of this parameter when you copy
|
435
|
+
# an encrypted DB snapshot from another AWS Region by using the AWS CLI.
|
426
436
|
#
|
427
437
|
# The presigned URL must be a valid request for the `CopyDBSnapshot` API
|
428
438
|
# action that can be executed in the source AWS Region that contains the
|
@@ -434,24 +444,24 @@ module Aws::RDS
|
|
434
444
|
# `CopyDBSnapshot` action is called that contains this presigned URL.
|
435
445
|
#
|
436
446
|
# For example, if you copy an encrypted DB snapshot from the us-west-2
|
437
|
-
#
|
438
|
-
# action in the us-east-1
|
439
|
-
# contains a call to the `CopyDBSnapshot` action in
|
440
|
-
#
|
441
|
-
# URL must be set to the us-east-1
|
442
|
-
#
|
443
|
-
# * `KmsKeyId` - The KMS key identifier for the key to use to
|
444
|
-
# the copy of the DB snapshot in the destination AWS Region.
|
445
|
-
# the same identifier for both the `CopyDBSnapshot` action
|
446
|
-
# called in the destination AWS Region, and the action
|
447
|
-
# the presigned URL.
|
447
|
+
# AWS Region to the us-east-1 AWS Region, then you call the
|
448
|
+
# `CopyDBSnapshot` action in the us-east-1 AWS Region and provide a
|
449
|
+
# presigned URL that contains a call to the `CopyDBSnapshot` action in
|
450
|
+
# the us-west-2 AWS Region. For this example, the `DestinationRegion`
|
451
|
+
# in the presigned URL must be set to the us-east-1 AWS Region.
|
452
|
+
#
|
453
|
+
# * `KmsKeyId` - The AWS KMS key identifier for the key to use to
|
454
|
+
# encrypt the copy of the DB snapshot in the destination AWS Region.
|
455
|
+
# This is the same identifier for both the `CopyDBSnapshot` action
|
456
|
+
# that is called in the destination AWS Region, and the action
|
457
|
+
# contained in the presigned URL.
|
448
458
|
#
|
449
459
|
# * `SourceDBSnapshotIdentifier` - The DB snapshot identifier for the
|
450
460
|
# encrypted snapshot to be copied. This identifier must be in the
|
451
461
|
# Amazon Resource Name (ARN) format for the source AWS Region. For
|
452
462
|
# example, if you are copying an encrypted DB snapshot from the
|
453
|
-
# us-west-2
|
454
|
-
# the following example:
|
463
|
+
# us-west-2 AWS Region, then your `SourceDBSnapshotIdentifier` looks
|
464
|
+
# like the following example:
|
455
465
|
# `arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20161115`.
|
456
466
|
#
|
457
467
|
# To learn how to generate a Signature Version 4 signed request, see
|
@@ -470,7 +480,8 @@ module Aws::RDS
|
|
470
480
|
# to another, and your DB instance uses a nondefault option group. If
|
471
481
|
# your source DB instance uses Transparent Data Encryption for Oracle or
|
472
482
|
# Microsoft SQL Server, you must specify this option when copying across
|
473
|
-
#
|
483
|
+
# AWS Regions. For more information, see [Option Group
|
484
|
+
# Considerations][1].
|
474
485
|
#
|
475
486
|
#
|
476
487
|
#
|
@@ -554,7 +565,7 @@ module Aws::RDS
|
|
554
565
|
# @option options [String] :db_instance_class
|
555
566
|
# The compute and memory capacity of the Amazon RDS DB instance, for
|
556
567
|
# example, `db.m4.large`. Not all DB instance classes are available in
|
557
|
-
# all
|
568
|
+
# all AWS Regions, or for all database engines. For the full list of DB
|
558
569
|
# instance classes, and availability for your engine, see [DB Instance
|
559
570
|
# Class][1] in the Amazon RDS User Guide.
|
560
571
|
#
|
@@ -570,11 +581,11 @@ module Aws::RDS
|
|
570
581
|
#
|
571
582
|
# Constraints: Value must be `1150-65535`
|
572
583
|
# @option options [String] :availability_zone
|
573
|
-
# The EC2 Availability Zone that the
|
584
|
+
# The EC2 Availability Zone that the DB instance is created in.
|
574
585
|
#
|
575
586
|
# Default: A random, system-chosen Availability Zone.
|
576
587
|
#
|
577
|
-
# Constraint: You
|
588
|
+
# Constraint: You can't specify the AvailabilityZone parameter if the
|
578
589
|
# MultiAZ parameter is set to `true`.
|
579
590
|
#
|
580
591
|
# Example: `us-east-1a`
|
@@ -588,7 +599,7 @@ module Aws::RDS
|
|
588
599
|
# @option options [Boolean] :multi_az
|
589
600
|
# Specifies if the DB instance is a Multi-AZ deployment.
|
590
601
|
#
|
591
|
-
# Constraint: You
|
602
|
+
# Constraint: You can't specify the AvailabilityZone parameter if the
|
592
603
|
# MultiAZ parameter is set to `true`.
|
593
604
|
# @option options [Boolean] :publicly_accessible
|
594
605
|
# Specifies the accessibility options for the DB instance. A value of
|
@@ -639,6 +650,8 @@ module Aws::RDS
|
|
639
650
|
#
|
640
651
|
# * `aurora`
|
641
652
|
#
|
653
|
+
# * `aurora-postgresql`
|
654
|
+
#
|
642
655
|
# * `mariadb`
|
643
656
|
#
|
644
657
|
# * `mysql`
|
@@ -681,11 +694,16 @@ module Aws::RDS
|
|
681
694
|
# The name of the option group to be used for the restored DB instance.
|
682
695
|
#
|
683
696
|
# Permanent options, such as the TDE option for Oracle Advanced Security
|
684
|
-
# TDE,
|
685
|
-
#
|
697
|
+
# TDE, can't be removed from an option group, and that option group
|
698
|
+
# can't be removed from a DB instance once it is associated with a DB
|
686
699
|
# instance
|
687
700
|
# @option options [Array<Types::Tag>] :tags
|
688
|
-
# A list of tags.
|
701
|
+
# A list of tags. For more information, see [Tagging Amazon RDS
|
702
|
+
# Resources][1].
|
703
|
+
#
|
704
|
+
#
|
705
|
+
#
|
706
|
+
# [1]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html
|
689
707
|
# @option options [String] :storage_type
|
690
708
|
# Specifies the storage type to be associated with the DB instance.
|
691
709
|
#
|
@@ -694,25 +712,25 @@ module Aws::RDS
|
|
694
712
|
# If you specify `io1`, you must also include a value for the `Iops`
|
695
713
|
# parameter.
|
696
714
|
#
|
697
|
-
# Default: `io1` if the `Iops` parameter is specified
|
715
|
+
# Default: `io1` if the `Iops` parameter is specified, otherwise
|
698
716
|
# `standard`
|
699
717
|
# @option options [String] :tde_credential_arn
|
700
|
-
# The ARN from the
|
718
|
+
# The ARN from the key store with which to associate the instance for
|
701
719
|
# TDE encryption.
|
702
720
|
# @option options [String] :tde_credential_password
|
703
|
-
# The password for the given ARN from the
|
721
|
+
# The password for the given ARN from the key store in order to access
|
704
722
|
# the device.
|
705
723
|
# @option options [String] :domain
|
706
724
|
# Specify the Active Directory Domain to restore the instance in.
|
707
725
|
# @option options [Boolean] :copy_tags_to_snapshot
|
708
726
|
# True to copy all tags from the restored DB instance to snapshots of
|
709
|
-
# the DB instance
|
727
|
+
# the DB instance, and otherwise false. The default is false.
|
710
728
|
# @option options [String] :domain_iam_role_name
|
711
729
|
# Specify the name of the IAM role to be used when making API calls to
|
712
730
|
# the Directory Service.
|
713
731
|
# @option options [Boolean] :enable_iam_database_authentication
|
714
732
|
# True to enable mapping of AWS Identity and Access Management (IAM)
|
715
|
-
# accounts to database accounts
|
733
|
+
# accounts to database accounts, and otherwise false.
|
716
734
|
#
|
717
735
|
# You can enable IAM database authentication for the following database
|
718
736
|
# engines
|
@@ -211,7 +211,12 @@ module Aws::RDS
|
|
211
211
|
# @option options [required, Array<String>] :subnet_ids
|
212
212
|
# The EC2 Subnet IDs for the DB subnet group.
|
213
213
|
# @option options [Array<Types::Tag>] :tags
|
214
|
-
# A list of tags.
|
214
|
+
# A list of tags. For more information, see [Tagging Amazon RDS
|
215
|
+
# Resources][1].
|
216
|
+
#
|
217
|
+
#
|
218
|
+
#
|
219
|
+
# [1]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html
|
215
220
|
# @return [DBSubnetGroup]
|
216
221
|
def create(options = {})
|
217
222
|
options = options.merge(db_subnet_group_name: @name)
|
@@ -304,7 +304,7 @@ module Aws::RDS
|
|
304
304
|
# The list of identifiers of the event sources for which events are
|
305
305
|
# returned. If not specified, then all sources are included in the
|
306
306
|
# response. An identifier must begin with a letter and must contain only
|
307
|
-
# ASCII letters, digits, and hyphens; it
|
307
|
+
# ASCII letters, digits, and hyphens; it can't end with a hyphen or
|
308
308
|
# contain two consecutive hyphens.
|
309
309
|
#
|
310
310
|
# Constraints:
|
@@ -326,7 +326,12 @@ module Aws::RDS
|
|
326
326
|
# A Boolean value; set to **true** to activate the subscription, set to
|
327
327
|
# **false** to create the subscription but not active it.
|
328
328
|
# @option options [Array<Types::Tag>] :tags
|
329
|
-
# A list of tags.
|
329
|
+
# A list of tags. For more information, see [Tagging Amazon RDS
|
330
|
+
# Resources][1].
|
331
|
+
#
|
332
|
+
#
|
333
|
+
#
|
334
|
+
# [1]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html
|
330
335
|
# @return [EventSubscription]
|
331
336
|
def create(options = {})
|
332
337
|
options = options.merge(subscription_name: @name)
|
@@ -236,7 +236,12 @@ module Aws::RDS
|
|
236
236
|
# @option options [required, String] :option_group_description
|
237
237
|
# The description of the option group.
|
238
238
|
# @option options [Array<Types::Tag>] :tags
|
239
|
-
# A list of tags.
|
239
|
+
# A list of tags. For more information, see [Tagging Amazon RDS
|
240
|
+
# Resources][1].
|
241
|
+
#
|
242
|
+
#
|
243
|
+
#
|
244
|
+
# [1]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html
|
240
245
|
# @return [OptionGroup]
|
241
246
|
def create(options = {})
|
242
247
|
options = options.merge(option_group_name: @name)
|
@@ -278,7 +283,12 @@ module Aws::RDS
|
|
278
283
|
# @option options [required, String] :target_option_group_description
|
279
284
|
# The description for the copied option group.
|
280
285
|
# @option options [Array<Types::Tag>] :tags
|
281
|
-
# A list of tags.
|
286
|
+
# A list of tags. For more information, see [Tagging Amazon RDS
|
287
|
+
# Resources][1].
|
288
|
+
#
|
289
|
+
#
|
290
|
+
#
|
291
|
+
# [1]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html
|
282
292
|
# @return [OptionGroup]
|
283
293
|
def copy(options = {})
|
284
294
|
options = options.merge(source_option_group_identifier: @name)
|
@@ -239,7 +239,12 @@ module Aws::RDS
|
|
239
239
|
#
|
240
240
|
# Default: `1`
|
241
241
|
# @option options [Array<Types::Tag>] :tags
|
242
|
-
# A list of tags.
|
242
|
+
# A list of tags. For more information, see [Tagging Amazon RDS
|
243
|
+
# Resources][1].
|
244
|
+
#
|
245
|
+
#
|
246
|
+
#
|
247
|
+
# [1]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html
|
243
248
|
# @return [ReservedDBInstance]
|
244
249
|
def purchase(options = {})
|
245
250
|
options = options.merge(reserved_db_instances_offering_id: @id)
|
data/lib/aws-sdk-rds/resource.rb
CHANGED
@@ -56,8 +56,8 @@ module Aws::RDS
|
|
56
56
|
# @param [Hash] options ({})
|
57
57
|
# @option options [Array<String>] :availability_zones
|
58
58
|
# A list of EC2 Availability Zones that instances in the DB cluster can
|
59
|
-
# be created in. For information on
|
60
|
-
# [Regions and Availability Zones][1].
|
59
|
+
# be created in. For information on AWS Regions and Availability Zones,
|
60
|
+
# see [Regions and Availability Zones][1].
|
61
61
|
#
|
62
62
|
#
|
63
63
|
#
|
@@ -115,7 +115,7 @@ module Aws::RDS
|
|
115
115
|
# @option options [required, String] :engine
|
116
116
|
# The name of the database engine to be used for this DB cluster.
|
117
117
|
#
|
118
|
-
# Valid Values: `aurora`
|
118
|
+
# Valid Values: `aurora`, `aurora-postgresql`
|
119
119
|
# @option options [String] :engine_version
|
120
120
|
# The version number of the database engine to use.
|
121
121
|
#
|
@@ -146,23 +146,24 @@ module Aws::RDS
|
|
146
146
|
# A value that indicates that the DB cluster should be associated with
|
147
147
|
# the specified option group.
|
148
148
|
#
|
149
|
-
# Permanent options
|
150
|
-
# group
|
149
|
+
# Permanent options can't be removed from an option group. The option
|
150
|
+
# group can't be removed from a DB cluster once it is associated with a
|
151
151
|
# DB cluster.
|
152
152
|
# @option options [String] :preferred_backup_window
|
153
153
|
# The daily time range during which automated backups are created if
|
154
154
|
# automated backups are enabled using the `BackupRetentionPeriod`
|
155
155
|
# parameter.
|
156
156
|
#
|
157
|
-
#
|
158
|
-
# time
|
159
|
-
# the Preferred Maintenance Window][1] in the *Amazon
|
157
|
+
# The default is a 30-minute window selected at random from an 8-hour
|
158
|
+
# block of time for each AWS Region. To see the time blocks available,
|
159
|
+
# see [ Adjusting the Preferred Maintenance Window][1] in the *Amazon
|
160
|
+
# RDS User Guide.*
|
160
161
|
#
|
161
162
|
# Constraints:
|
162
163
|
#
|
163
164
|
# * Must be in the format `hh24:mi-hh24:mi`.
|
164
165
|
#
|
165
|
-
# *
|
166
|
+
# * Must be in Universal Coordinated Time (UTC).
|
166
167
|
#
|
167
168
|
# * Must not conflict with the preferred maintenance window.
|
168
169
|
#
|
@@ -177,12 +178,12 @@ module Aws::RDS
|
|
177
178
|
#
|
178
179
|
# Format: `ddd:hh24:mi-ddd:hh24:mi`
|
179
180
|
#
|
180
|
-
#
|
181
|
-
# time
|
182
|
-
# time blocks available, see [ Adjusting the Preferred
|
183
|
-
# Window][1] in the *Amazon RDS User Guide.*
|
181
|
+
# The default is a 30-minute window selected at random from an 8-hour
|
182
|
+
# block of time for each AWS Region, occurring on a random day of the
|
183
|
+
# week. To see the time blocks available, see [ Adjusting the Preferred
|
184
|
+
# Maintenance Window][1] in the *Amazon RDS User Guide.*
|
184
185
|
#
|
185
|
-
# Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun
|
186
|
+
# Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.
|
186
187
|
#
|
187
188
|
# Constraints: Minimum 30-minute window.
|
188
189
|
#
|
@@ -193,11 +194,16 @@ module Aws::RDS
|
|
193
194
|
# The Amazon Resource Name (ARN) of the source DB instance or DB cluster
|
194
195
|
# if this DB cluster is created as a Read Replica.
|
195
196
|
# @option options [Array<Types::Tag>] :tags
|
196
|
-
# A list of tags.
|
197
|
+
# A list of tags. For more information, see [Tagging Amazon RDS
|
198
|
+
# Resources][1].
|
199
|
+
#
|
200
|
+
#
|
201
|
+
#
|
202
|
+
# [1]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html
|
197
203
|
# @option options [Boolean] :storage_encrypted
|
198
204
|
# Specifies whether the DB cluster is encrypted.
|
199
205
|
# @option options [String] :kms_key_id
|
200
|
-
# The KMS key identifier for an encrypted DB cluster.
|
206
|
+
# The AWS KMS key identifier for an encrypted DB cluster.
|
201
207
|
#
|
202
208
|
# The KMS key identifier is the Amazon Resource Name (ARN) for the KMS
|
203
209
|
# encryption key. If you are creating a DB cluster with the same AWS
|
@@ -237,9 +243,9 @@ module Aws::RDS
|
|
237
243
|
# The pre-signed URL request must contain the following parameter
|
238
244
|
# values:
|
239
245
|
#
|
240
|
-
# * `KmsKeyId` - The KMS key identifier for the key to use to
|
241
|
-
# the copy of the DB cluster in the destination AWS Region.
|
242
|
-
# should refer to the same KMS key for both the `CreateDBCluster`
|
246
|
+
# * `KmsKeyId` - The AWS KMS key identifier for the key to use to
|
247
|
+
# encrypt the copy of the DB cluster in the destination AWS Region.
|
248
|
+
# This should refer to the same KMS key for both the `CreateDBCluster`
|
243
249
|
# action that is called in the destination AWS Region, and the action
|
244
250
|
# contained in the pre-signed URL.
|
245
251
|
#
|
@@ -250,8 +256,8 @@ module Aws::RDS
|
|
250
256
|
# encrypted DB cluster to be copied. This identifier must be in the
|
251
257
|
# Amazon Resource Name (ARN) format for the source AWS Region. For
|
252
258
|
# example, if you are copying an encrypted DB cluster from the
|
253
|
-
# us-west-2
|
254
|
-
# like Example:
|
259
|
+
# us-west-2 AWS Region, then your `ReplicationSourceIdentifier` would
|
260
|
+
# look like Example:
|
255
261
|
# `arn:aws:rds:us-west-2:123456789012:cluster:aurora-cluster1`.
|
256
262
|
#
|
257
263
|
# To learn how to generate a Signature Version 4 signed request, see [
|
@@ -263,9 +269,8 @@ module Aws::RDS
|
|
263
269
|
# [1]: http://docs.aws.amazon.com/AmazonS3/latest/API/sigv4-query-string-auth.html
|
264
270
|
# [2]: http://docs.aws.amazon.com/general/latest/gr/signature-version-4.html
|
265
271
|
# @option options [Boolean] :enable_iam_database_authentication
|
266
|
-
#
|
267
|
-
#
|
268
|
-
# false.
|
272
|
+
# True to enable mapping of AWS Identity and Access Management (IAM)
|
273
|
+
# accounts to database accounts, and otherwise false.
|
269
274
|
#
|
270
275
|
# Default: `false`
|
271
276
|
# @option options [String] :destination_region
|
@@ -317,7 +322,12 @@ module Aws::RDS
|
|
317
322
|
# @option options [required, String] :description
|
318
323
|
# The description for the DB cluster parameter group.
|
319
324
|
# @option options [Array<Types::Tag>] :tags
|
320
|
-
# A list of tags.
|
325
|
+
# A list of tags. For more information, see [Tagging Amazon RDS
|
326
|
+
# Resources][1].
|
327
|
+
#
|
328
|
+
#
|
329
|
+
#
|
330
|
+
# [1]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html
|
321
331
|
# @return [DBClusterParameterGroup]
|
322
332
|
def create_db_cluster_parameter_group(options = {})
|
323
333
|
resp = @client.create_db_cluster_parameter_group(options)
|
@@ -468,7 +478,7 @@ module Aws::RDS
|
|
468
478
|
# Example: `mydbinstance`
|
469
479
|
# @option options [Integer] :allocated_storage
|
470
480
|
# The amount of storage (in gigabytes) to be initially allocated for the
|
471
|
-
#
|
481
|
+
# DB instance.
|
472
482
|
#
|
473
483
|
# Type: Integer
|
474
484
|
#
|
@@ -553,8 +563,8 @@ module Aws::RDS
|
|
553
563
|
# * Web and Express editions: Must be an integer from 20 to 1024.
|
554
564
|
# @option options [required, String] :db_instance_class
|
555
565
|
# The compute and memory capacity of the DB instance, for example,
|
556
|
-
# `db.m4.large`. Not all DB instance classes are available in all
|
557
|
-
#
|
566
|
+
# `db.m4.large`. Not all DB instance classes are available in all AWS
|
567
|
+
# Regions, or for all database engines. For the full list of DB instance
|
558
568
|
# classes, and availability for your engine, see [DB Instance Class][1]
|
559
569
|
# in the Amazon RDS User Guide.
|
560
570
|
#
|
@@ -570,6 +580,8 @@ module Aws::RDS
|
|
570
580
|
#
|
571
581
|
# * `aurora`
|
572
582
|
#
|
583
|
+
# * `aurora-postgresql`
|
584
|
+
#
|
573
585
|
# * `mariadb`
|
574
586
|
#
|
575
587
|
# * `mysql`
|
@@ -657,8 +669,8 @@ module Aws::RDS
|
|
657
669
|
#
|
658
670
|
# * Cannot be a reserved word for the chosen database engine.
|
659
671
|
# @option options [String] :master_user_password
|
660
|
-
# The password for the master user.
|
661
|
-
# except "/", """, or "@".
|
672
|
+
# The password for the master user. The password can include any
|
673
|
+
# printable ASCII character except "/", """, or "@".
|
662
674
|
#
|
663
675
|
# **Amazon Aurora**
|
664
676
|
#
|
@@ -699,8 +711,8 @@ module Aws::RDS
|
|
699
711
|
# Default: The default EC2 VPC security group for the DB subnet group's
|
700
712
|
# VPC.
|
701
713
|
# @option options [String] :availability_zone
|
702
|
-
# The EC2 Availability Zone that the
|
703
|
-
#
|
714
|
+
# The EC2 Availability Zone that the DB instance is created in. For
|
715
|
+
# information on AWS Regions and Availability Zones, see [Regions and
|
704
716
|
# Availability Zones][1].
|
705
717
|
#
|
706
718
|
# Default: A random, system-chosen Availability Zone in the endpoint's
|
@@ -708,7 +720,7 @@ module Aws::RDS
|
|
708
720
|
#
|
709
721
|
# Example: `us-east-1d`
|
710
722
|
#
|
711
|
-
# Constraint: The AvailabilityZone parameter
|
723
|
+
# Constraint: The AvailabilityZone parameter can't be specified if the
|
712
724
|
# MultiAZ parameter is set to `true`. The specified Availability Zone
|
713
725
|
# must be in the same AWS Region as the current endpoint.
|
714
726
|
#
|
@@ -720,25 +732,23 @@ module Aws::RDS
|
|
720
732
|
#
|
721
733
|
# If there is no DB subnet group, then it is a non-VPC DB instance.
|
722
734
|
# @option options [String] :preferred_maintenance_window
|
723
|
-
# The
|
724
|
-
# Universal Coordinated Time (UTC). For more information, see [
|
725
|
-
#
|
735
|
+
# The time range each week during which system maintenance can occur, in
|
736
|
+
# Universal Coordinated Time (UTC). For more information, see [Amazon
|
737
|
+
# RDS Maintenance Window][1].
|
726
738
|
#
|
727
739
|
# Format: `ddd:hh24:mi-ddd:hh24:mi`
|
728
740
|
#
|
729
|
-
#
|
730
|
-
# time
|
731
|
-
#
|
732
|
-
# Window][2] in the *Amazon RDS User Guide.*
|
741
|
+
# The default is a 30-minute window selected at random from an 8-hour
|
742
|
+
# block of time for each AWS Region, occurring on a random day of the
|
743
|
+
# week.
|
733
744
|
#
|
734
|
-
# Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun
|
745
|
+
# Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.
|
735
746
|
#
|
736
747
|
# Constraints: Minimum 30-minute window.
|
737
748
|
#
|
738
749
|
#
|
739
750
|
#
|
740
|
-
# [1]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBMaintenance
|
741
|
-
# [2]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/AdjustingTheMaintenanceWindow.html
|
751
|
+
# [1]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_UpgradeDBInstance.Maintenance.html#Concepts.DBMaintenance
|
742
752
|
# @option options [String] :db_parameter_group_name
|
743
753
|
# The name of the DB parameter group to associate with this DB instance.
|
744
754
|
# If this argument is omitted, the default DBParameterGroup for the
|
@@ -771,22 +781,22 @@ module Aws::RDS
|
|
771
781
|
# @option options [String] :preferred_backup_window
|
772
782
|
# The daily time range during which automated backups are created if
|
773
783
|
# automated backups are enabled, using the `BackupRetentionPeriod`
|
774
|
-
# parameter. For more information, see [
|
784
|
+
# parameter. For more information, see [The Backup Window][1].
|
775
785
|
#
|
776
786
|
# **Amazon Aurora**
|
777
787
|
#
|
778
788
|
# Not applicable. The daily time range for creating automated backups is
|
779
789
|
# managed by the DB cluster. For more information, see CreateDBCluster.
|
780
790
|
#
|
781
|
-
#
|
782
|
-
# time
|
783
|
-
# the Preferred DB Instance Maintenance Window][2].
|
791
|
+
# The default is a 30-minute window selected at random from an 8-hour
|
792
|
+
# block of time for each AWS Region. To see the time blocks available,
|
793
|
+
# see [ Adjusting the Preferred DB Instance Maintenance Window][2].
|
784
794
|
#
|
785
795
|
# Constraints:
|
786
796
|
#
|
787
797
|
# * Must be in the format `hh24:mi-hh24:mi`.
|
788
798
|
#
|
789
|
-
# *
|
799
|
+
# * Must be in Universal Coordinated Time (UTC).
|
790
800
|
#
|
791
801
|
# * Must not conflict with the preferred maintenance window.
|
792
802
|
#
|
@@ -794,7 +804,7 @@ module Aws::RDS
|
|
794
804
|
#
|
795
805
|
#
|
796
806
|
#
|
797
|
-
# [1]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/
|
807
|
+
# [1]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithAutomatedBackups.html#USER_WorkingWithAutomatedBackups.BackupWindow
|
798
808
|
# [2]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_UpgradeDBInstance.Maintenance.html#AdjustingTheMaintenanceWindow
|
799
809
|
# @option options [Integer] :port
|
800
810
|
# The port number on which the database accepts connections.
|
@@ -844,7 +854,7 @@ module Aws::RDS
|
|
844
854
|
#
|
845
855
|
# Type: Integer
|
846
856
|
# @option options [Boolean] :multi_az
|
847
|
-
# Specifies if the DB instance is a Multi-AZ deployment. You
|
857
|
+
# Specifies if the DB instance is a Multi-AZ deployment. You can't set
|
848
858
|
# the AvailabilityZone parameter if the MultiAZ parameter is set to
|
849
859
|
# true.
|
850
860
|
# @option options [String] :engine_version
|
@@ -862,59 +872,59 @@ module Aws::RDS
|
|
862
872
|
#
|
863
873
|
# **MariaDB**
|
864
874
|
#
|
865
|
-
# * `10.1.23` (supported in all AWS
|
875
|
+
# * `10.1.23` (supported in all AWS Regions)
|
866
876
|
#
|
867
|
-
# * `10.1.19` (supported in all AWS
|
877
|
+
# * `10.1.19` (supported in all AWS Regions)
|
868
878
|
#
|
869
|
-
# * `10.1.14` (supported in all
|
879
|
+
# * `10.1.14` (supported in all AWS Regions except us-east-2)
|
870
880
|
#
|
871
881
|
#
|
872
882
|
#
|
873
|
-
# * `10.0.31` (supported in all AWS
|
883
|
+
# * `10.0.31` (supported in all AWS Regions)
|
874
884
|
#
|
875
|
-
# * `10.0.28` (supported in all AWS
|
885
|
+
# * `10.0.28` (supported in all AWS Regions)
|
876
886
|
#
|
877
|
-
# * `10.0.24` (supported in all AWS
|
887
|
+
# * `10.0.24` (supported in all AWS Regions)
|
878
888
|
#
|
879
|
-
# * `10.0.17` (supported in all
|
880
|
-
# eu-west-2)
|
889
|
+
# * `10.0.17` (supported in all AWS Regions except us-east-2,
|
890
|
+
# ca-central-1, eu-west-2)
|
881
891
|
#
|
882
892
|
# **Microsoft SQL Server 2016**
|
883
893
|
#
|
884
|
-
# * `13.00.4422.0.v1` (supported for all editions, and all AWS
|
894
|
+
# * `13.00.4422.0.v1` (supported for all editions, and all AWS Regions)
|
885
895
|
#
|
886
|
-
# * `13.00.2164.0.v1` (supported for all editions, and all AWS
|
896
|
+
# * `13.00.2164.0.v1` (supported for all editions, and all AWS Regions)
|
887
897
|
#
|
888
898
|
# **Microsoft SQL Server 2014**
|
889
899
|
#
|
890
|
-
# * `12.00.5546.0.v1` (supported for all editions, and all AWS
|
900
|
+
# * `12.00.5546.0.v1` (supported for all editions, and all AWS Regions)
|
891
901
|
#
|
892
|
-
# * `12.00.5000.0.v1` (supported for all editions, and all AWS
|
902
|
+
# * `12.00.5000.0.v1` (supported for all editions, and all AWS Regions)
|
893
903
|
#
|
894
904
|
# * `12.00.4422.0.v1` (supported for all editions except Enterprise
|
895
|
-
# Edition, and all AWS
|
905
|
+
# Edition, and all AWS Regions except ca-central-1 and eu-west-2)
|
896
906
|
#
|
897
907
|
# **Microsoft SQL Server 2012**
|
898
908
|
#
|
899
|
-
# * `11.00.6594.0.v1` (supported for all editions, and all AWS
|
909
|
+
# * `11.00.6594.0.v1` (supported for all editions, and all AWS Regions)
|
900
910
|
#
|
901
|
-
# * `11.00.6020.0.v1` (supported for all editions, and all AWS
|
911
|
+
# * `11.00.6020.0.v1` (supported for all editions, and all AWS Regions)
|
902
912
|
#
|
903
|
-
# * `11.00.5058.0.v1` (supported for all editions, and all AWS
|
913
|
+
# * `11.00.5058.0.v1` (supported for all editions, and all AWS Regions
|
904
914
|
# except us-east-2, ca-central-1, and eu-west-2)
|
905
915
|
#
|
906
|
-
# * `11.00.2100.60.v1` (supported for all editions, and all AWS
|
916
|
+
# * `11.00.2100.60.v1` (supported for all editions, and all AWS Regions
|
907
917
|
# except us-east-2, ca-central-1, and eu-west-2)
|
908
918
|
#
|
909
919
|
# **Microsoft SQL Server 2008 R2**
|
910
920
|
#
|
911
|
-
# * `10.50.6529.0.v1` (supported for all editions, and all AWS
|
921
|
+
# * `10.50.6529.0.v1` (supported for all editions, and all AWS Regions
|
912
922
|
# except us-east-2, ca-central-1, and eu-west-2)
|
913
923
|
#
|
914
|
-
# * `10.50.6000.34.v1` (supported for all editions, and all AWS
|
924
|
+
# * `10.50.6000.34.v1` (supported for all editions, and all AWS Regions
|
915
925
|
# except us-east-2, ca-central-1, and eu-west-2)
|
916
926
|
#
|
917
|
-
# * `10.50.2789.0.v1` (supported for all editions, and all AWS
|
927
|
+
# * `10.50.2789.0.v1` (supported for all editions, and all AWS Regions
|
918
928
|
# except us-east-2, ca-central-1, and eu-west-2)
|
919
929
|
#
|
920
930
|
# **MySQL**
|
@@ -925,30 +935,28 @@ module Aws::RDS
|
|
925
935
|
#
|
926
936
|
# * `5.7.16` (supported in all AWS regions)
|
927
937
|
#
|
928
|
-
# * `5.7.11` (supported in all AWS regions)
|
929
|
-
#
|
930
938
|
#
|
931
939
|
#
|
932
|
-
# * `5.6.37` (supported in all AWS
|
940
|
+
# * `5.6.37` (supported in all AWS Regions)
|
933
941
|
#
|
934
|
-
# * `5.6.35` (supported in all AWS
|
942
|
+
# * `5.6.35` (supported in all AWS Regions)
|
935
943
|
#
|
936
|
-
# * `5.6.34` (supported in all AWS
|
944
|
+
# * `5.6.34` (supported in all AWS Regions)
|
937
945
|
#
|
938
|
-
# * `5.6.29` (supported in all AWS
|
946
|
+
# * `5.6.29` (supported in all AWS Regions)
|
939
947
|
#
|
940
|
-
# * `5.6.27` (supported in all
|
941
|
-
# eu-west-2)
|
948
|
+
# * `5.6.27` (supported in all AWS Regions except us-east-2,
|
949
|
+
# ca-central-1, eu-west-2)
|
942
950
|
#
|
943
951
|
#
|
944
952
|
#
|
945
|
-
# * `5.5.57` (supported in all AWS
|
953
|
+
# * `5.5.57` (supported in all AWS Regions)
|
946
954
|
#
|
947
|
-
# * `5.5.54` (supported in all AWS
|
955
|
+
# * `5.5.54` (supported in all AWS Regions)
|
948
956
|
#
|
949
|
-
# * `5.5.53` (supported in all AWS
|
957
|
+
# * `5.5.53` (supported in all AWS Regions)
|
950
958
|
#
|
951
|
-
# * `5.5.46` (supported in all AWS
|
959
|
+
# * `5.5.46` (supported in all AWS Regions)
|
952
960
|
#
|
953
961
|
# **Oracle 12c**
|
954
962
|
#
|
@@ -1026,19 +1034,25 @@ module Aws::RDS
|
|
1026
1034
|
# `general-public-license`
|
1027
1035
|
# @option options [Integer] :iops
|
1028
1036
|
# The amount of Provisioned IOPS (input/output operations per second) to
|
1029
|
-
# be initially allocated for the DB instance.
|
1037
|
+
# be initially allocated for the DB instance. For information about
|
1038
|
+
# valid Iops values, see see [Amazon RDS Provisioned IOPS Storage to
|
1039
|
+
# Improve Performance][1].
|
1030
1040
|
#
|
1031
1041
|
# Constraints: Must be a multiple between 3 and 10 of the storage amount
|
1032
1042
|
# for the DB instance. Must also be an integer multiple of 1000. For
|
1033
1043
|
# example, if the size of your DB instance is 500 GB, then your `Iops`
|
1034
1044
|
# value can be 2000, 3000, 4000, or 5000.
|
1045
|
+
#
|
1046
|
+
#
|
1047
|
+
#
|
1048
|
+
# [1]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Storage.html#USER_PIOPS
|
1035
1049
|
# @option options [String] :option_group_name
|
1036
1050
|
# Indicates that the DB instance should be associated with the specified
|
1037
1051
|
# option group.
|
1038
1052
|
#
|
1039
1053
|
# Permanent options, such as the TDE option for Oracle Advanced Security
|
1040
|
-
# TDE,
|
1041
|
-
#
|
1054
|
+
# TDE, can't be removed from an option group, and that option group
|
1055
|
+
# can't be removed from a DB instance once it is associated with a DB
|
1042
1056
|
# instance
|
1043
1057
|
# @option options [String] :character_set_name
|
1044
1058
|
# For supported engines, indicates that the DB instance should be
|
@@ -1069,7 +1083,12 @@ module Aws::RDS
|
|
1069
1083
|
# as part of the request and the PubliclyAccessible value has not been
|
1070
1084
|
# set, the DB instance is private.
|
1071
1085
|
# @option options [Array<Types::Tag>] :tags
|
1072
|
-
# A list of tags.
|
1086
|
+
# A list of tags. For more information, see [Tagging Amazon RDS
|
1087
|
+
# Resources][1].
|
1088
|
+
#
|
1089
|
+
#
|
1090
|
+
#
|
1091
|
+
# [1]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html
|
1073
1092
|
# @option options [String] :db_cluster_identifier
|
1074
1093
|
# The identifier of the DB cluster that the instance will belong to.
|
1075
1094
|
#
|
@@ -1084,13 +1103,13 @@ module Aws::RDS
|
|
1084
1103
|
# If you specify `io1`, you must also include a value for the `Iops`
|
1085
1104
|
# parameter.
|
1086
1105
|
#
|
1087
|
-
# Default: `io1` if the `Iops` parameter is specified
|
1106
|
+
# Default: `io1` if the `Iops` parameter is specified, otherwise
|
1088
1107
|
# `standard`
|
1089
1108
|
# @option options [String] :tde_credential_arn
|
1090
|
-
# The ARN from the
|
1109
|
+
# The ARN from the key store with which to associate the instance for
|
1091
1110
|
# TDE encryption.
|
1092
1111
|
# @option options [String] :tde_credential_password
|
1093
|
-
# The password for the given ARN from the
|
1112
|
+
# The password for the given ARN from the key store in order to access
|
1094
1113
|
# the device.
|
1095
1114
|
# @option options [Boolean] :storage_encrypted
|
1096
1115
|
# Specifies whether the DB instance is encrypted.
|
@@ -1102,7 +1121,7 @@ module Aws::RDS
|
|
1102
1121
|
#
|
1103
1122
|
# Default: false
|
1104
1123
|
# @option options [String] :kms_key_id
|
1105
|
-
# The KMS key identifier for an encrypted DB instance.
|
1124
|
+
# The AWS KMS key identifier for an encrypted DB instance.
|
1106
1125
|
#
|
1107
1126
|
# The KMS key identifier is the Amazon Resource Name (ARN) for the KMS
|
1108
1127
|
# encryption key. If you are creating a DB instance with the same AWS
|
@@ -1124,7 +1143,7 @@ module Aws::RDS
|
|
1124
1143
|
# Specify the Active Directory Domain to create the instance in.
|
1125
1144
|
# @option options [Boolean] :copy_tags_to_snapshot
|
1126
1145
|
# True to copy all tags from the DB instance to snapshots of the DB
|
1127
|
-
# instance
|
1146
|
+
# instance, and otherwise false. The default is false.
|
1128
1147
|
# @option options [Integer] :monitoring_interval
|
1129
1148
|
# The interval, in seconds, between points when Enhanced Monitoring
|
1130
1149
|
# metrics are collected for the DB instance. To disable collecting
|
@@ -1136,7 +1155,7 @@ module Aws::RDS
|
|
1136
1155
|
# Valid Values: `0, 1, 5, 10, 15, 30, 60`
|
1137
1156
|
# @option options [String] :monitoring_role_arn
|
1138
1157
|
# The ARN for the IAM role that permits RDS to send enhanced monitoring
|
1139
|
-
# metrics to CloudWatch Logs. For example,
|
1158
|
+
# metrics to Amazon CloudWatch Logs. For example,
|
1140
1159
|
# `arn:aws:iam:123456789012:role/emaccess`. For information on creating
|
1141
1160
|
# a monitoring role, go to [Setting Up and Enabling Enhanced
|
1142
1161
|
# Monitoring][1].
|
@@ -1172,7 +1191,7 @@ module Aws::RDS
|
|
1172
1191
|
# [1]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_SQLServer.html#SQLServer.Concepts.General.TimeZone
|
1173
1192
|
# @option options [Boolean] :enable_iam_database_authentication
|
1174
1193
|
# True to enable mapping of AWS Identity and Access Management (IAM)
|
1175
|
-
# accounts to database accounts
|
1194
|
+
# accounts to database accounts, and otherwise false.
|
1176
1195
|
#
|
1177
1196
|
# You can enable IAM database authentication for the following database
|
1178
1197
|
# engines:
|
@@ -1190,12 +1209,12 @@ module Aws::RDS
|
|
1190
1209
|
#
|
1191
1210
|
# Default: `false`
|
1192
1211
|
# @option options [Boolean] :enable_performance_insights
|
1193
|
-
# True to enable Performance Insights for the DB instance
|
1212
|
+
# True to enable Performance Insights for the DB instance, and otherwise
|
1194
1213
|
# false.
|
1195
1214
|
# @option options [String] :performance_insights_kms_key_id
|
1196
|
-
# The KMS key identifier for encryption of Performance Insights
|
1197
|
-
# The KMS key ID is the Amazon Resource Name (ARN), KMS key
|
1198
|
-
# or the KMS key alias for the KMS encryption key.
|
1215
|
+
# The AWS KMS key identifier for encryption of Performance Insights
|
1216
|
+
# data. The KMS key ID is the Amazon Resource Name (ARN), KMS key
|
1217
|
+
# identifier, or the KMS key alias for the KMS encryption key.
|
1199
1218
|
# @return [DBInstance]
|
1200
1219
|
def create_db_instance(options = {})
|
1201
1220
|
resp = @client.create_db_instance(options)
|
@@ -1242,7 +1261,12 @@ module Aws::RDS
|
|
1242
1261
|
# @option options [required, String] :description
|
1243
1262
|
# The description for the DB parameter group.
|
1244
1263
|
# @option options [Array<Types::Tag>] :tags
|
1245
|
-
# A list of tags.
|
1264
|
+
# A list of tags. For more information, see [Tagging Amazon RDS
|
1265
|
+
# Resources][1].
|
1266
|
+
#
|
1267
|
+
#
|
1268
|
+
#
|
1269
|
+
# [1]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html
|
1246
1270
|
# @return [DBParameterGroup]
|
1247
1271
|
def create_db_parameter_group(options = {})
|
1248
1272
|
resp = @client.create_db_parameter_group(options)
|
@@ -1284,7 +1308,12 @@ module Aws::RDS
|
|
1284
1308
|
# @option options [required, String] :db_security_group_description
|
1285
1309
|
# The description for the DB security group.
|
1286
1310
|
# @option options [Array<Types::Tag>] :tags
|
1287
|
-
# A list of tags.
|
1311
|
+
# A list of tags. For more information, see [Tagging Amazon RDS
|
1312
|
+
# Resources][1].
|
1313
|
+
#
|
1314
|
+
#
|
1315
|
+
#
|
1316
|
+
# [1]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html
|
1288
1317
|
# @return [DBSecurityGroup]
|
1289
1318
|
def create_db_security_group(options = {})
|
1290
1319
|
resp = @client.create_db_security_group(options)
|
@@ -1322,7 +1351,12 @@ module Aws::RDS
|
|
1322
1351
|
# @option options [required, Array<String>] :subnet_ids
|
1323
1352
|
# The EC2 Subnet IDs for the DB subnet group.
|
1324
1353
|
# @option options [Array<Types::Tag>] :tags
|
1325
|
-
# A list of tags.
|
1354
|
+
# A list of tags. For more information, see [Tagging Amazon RDS
|
1355
|
+
# Resources][1].
|
1356
|
+
#
|
1357
|
+
#
|
1358
|
+
#
|
1359
|
+
# [1]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html
|
1326
1360
|
# @return [DBSubnetGroup]
|
1327
1361
|
def create_db_subnet_group(options = {})
|
1328
1362
|
resp = @client.create_db_subnet_group(options)
|
@@ -1379,7 +1413,7 @@ module Aws::RDS
|
|
1379
1413
|
# The list of identifiers of the event sources for which events are
|
1380
1414
|
# returned. If not specified, then all sources are included in the
|
1381
1415
|
# response. An identifier must begin with a letter and must contain only
|
1382
|
-
# ASCII letters, digits, and hyphens; it
|
1416
|
+
# ASCII letters, digits, and hyphens; it can't end with a hyphen or
|
1383
1417
|
# contain two consecutive hyphens.
|
1384
1418
|
#
|
1385
1419
|
# Constraints:
|
@@ -1401,7 +1435,12 @@ module Aws::RDS
|
|
1401
1435
|
# A Boolean value; set to **true** to activate the subscription, set to
|
1402
1436
|
# **false** to create the subscription but not active it.
|
1403
1437
|
# @option options [Array<Types::Tag>] :tags
|
1404
|
-
# A list of tags.
|
1438
|
+
# A list of tags. For more information, see [Tagging Amazon RDS
|
1439
|
+
# Resources][1].
|
1440
|
+
#
|
1441
|
+
#
|
1442
|
+
#
|
1443
|
+
# [1]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html
|
1405
1444
|
# @return [EventSubscription]
|
1406
1445
|
def create_event_subscription(options = {})
|
1407
1446
|
resp = @client.create_event_subscription(options)
|
@@ -1448,7 +1487,12 @@ module Aws::RDS
|
|
1448
1487
|
# @option options [required, String] :option_group_description
|
1449
1488
|
# The description of the option group.
|
1450
1489
|
# @option options [Array<Types::Tag>] :tags
|
1451
|
-
# A list of tags.
|
1490
|
+
# A list of tags. For more information, see [Tagging Amazon RDS
|
1491
|
+
# Resources][1].
|
1492
|
+
#
|
1493
|
+
#
|
1494
|
+
#
|
1495
|
+
# [1]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html
|
1452
1496
|
# @return [OptionGroup]
|
1453
1497
|
def create_option_group(options = {})
|
1454
1498
|
resp = @client.create_option_group(options)
|
@@ -1810,7 +1854,7 @@ module Aws::RDS
|
|
1810
1854
|
#
|
1811
1855
|
# * `db-cluster-id` - Accepts DB cluster identifiers and DB cluster
|
1812
1856
|
# Amazon Resource Names (ARNs). The results list will only include
|
1813
|
-
# information about the DB instances associated with the DB
|
1857
|
+
# information about the DB instances associated with the DB clusters
|
1814
1858
|
# identified by these ARNs.
|
1815
1859
|
#
|
1816
1860
|
# * `db-instance-id` - Accepts DB instance identifiers and DB instance
|
@@ -1957,7 +2001,7 @@ module Aws::RDS
|
|
1957
2001
|
# @param [Hash] options ({})
|
1958
2002
|
# @option options [String] :db_instance_identifier
|
1959
2003
|
# The ID of the DB instance to retrieve the list of DB snapshots for.
|
1960
|
-
# This parameter
|
2004
|
+
# This parameter can't be used in conjunction with
|
1961
2005
|
# `DBSnapshotIdentifier`. This parameter is not case-sensitive.
|
1962
2006
|
#
|
1963
2007
|
# Constraints:
|
@@ -1966,7 +2010,7 @@ module Aws::RDS
|
|
1966
2010
|
#
|
1967
2011
|
# ^
|
1968
2012
|
# @option options [String] :db_snapshot_identifier
|
1969
|
-
# A specific DB snapshot identifier to describe. This parameter
|
2013
|
+
# A specific DB snapshot identifier to describe. This parameter can't
|
1970
2014
|
# be used in conjunction with `DBInstanceIdentifier`. This value is
|
1971
2015
|
# stored as a lowercase string.
|
1972
2016
|
#
|
@@ -2006,18 +2050,17 @@ module Aws::RDS
|
|
2006
2050
|
# @option options [Array<Types::Filter>] :filters
|
2007
2051
|
# This parameter is not currently supported.
|
2008
2052
|
# @option options [Boolean] :include_shared
|
2009
|
-
#
|
2010
|
-
#
|
2011
|
-
#
|
2012
|
-
# `false`.
|
2053
|
+
# True to include shared manual DB snapshots from other AWS accounts
|
2054
|
+
# that this AWS account has been given permission to copy or restore,
|
2055
|
+
# and otherwise false. The default is `false`.
|
2013
2056
|
#
|
2014
2057
|
# You can give an AWS account permission to restore a manual DB snapshot
|
2015
2058
|
# from another AWS account by using the ModifyDBSnapshotAttribute API
|
2016
2059
|
# action.
|
2017
2060
|
# @option options [Boolean] :include_public
|
2018
|
-
#
|
2019
|
-
#
|
2020
|
-
#
|
2061
|
+
# True to include manual DB snapshots that are public and can be copied
|
2062
|
+
# or restored by any AWS account, and otherwise false. The default is
|
2063
|
+
# false.
|
2021
2064
|
#
|
2022
2065
|
# You can share a manual DB snapshot as public by using the
|
2023
2066
|
# ModifyDBSnapshotAttribute API.
|