aws-sdk-rds 1.118.0 → 1.122.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.rb +1 -1
- data/lib/aws-sdk-rds/client.rb +916 -654
- data/lib/aws-sdk-rds/client_api.rb +14 -0
- data/lib/aws-sdk-rds/db_cluster.rb +129 -93
- data/lib/aws-sdk-rds/db_cluster_parameter_group.rb +41 -0
- data/lib/aws-sdk-rds/db_cluster_snapshot.rb +67 -57
- data/lib/aws-sdk-rds/db_instance.rb +241 -175
- data/lib/aws-sdk-rds/db_parameter_group.rb +54 -11
- data/lib/aws-sdk-rds/db_security_group.rb +12 -10
- data/lib/aws-sdk-rds/db_snapshot.rb +95 -74
- data/lib/aws-sdk-rds/db_snapshot_attribute.rb +15 -13
- data/lib/aws-sdk-rds/event_subscription.rb +2 -2
- data/lib/aws-sdk-rds/option_group.rb +3 -3
- data/lib/aws-sdk-rds/reserved_db_instance.rb +2 -2
- data/lib/aws-sdk-rds/resource.rb +203 -114
- data/lib/aws-sdk-rds/types.rb +1008 -722
- metadata +3 -4
@@ -216,6 +216,31 @@ module Aws::RDS
|
|
216
216
|
# **Aurora PostgreSQL**
|
217
217
|
#
|
218
218
|
# Example: `aurora-postgresql9.6`
|
219
|
+
#
|
220
|
+
# To list all of the available parameter group families for a DB engine,
|
221
|
+
# use the following command:
|
222
|
+
#
|
223
|
+
# `aws rds describe-db-engine-versions --query
|
224
|
+
# "DBEngineVersions[].DBParameterGroupFamily" --engine <engine>`
|
225
|
+
#
|
226
|
+
# For example, to list all of the available parameter group families for
|
227
|
+
# the Aurora PostgreSQL DB engine, use the following command:
|
228
|
+
#
|
229
|
+
# `aws rds describe-db-engine-versions --query
|
230
|
+
# "DBEngineVersions[].DBParameterGroupFamily" --engine
|
231
|
+
# aurora-postgresql`
|
232
|
+
#
|
233
|
+
# <note markdown="1"> The output contains duplicates.
|
234
|
+
#
|
235
|
+
# </note>
|
236
|
+
#
|
237
|
+
# The following are the valid DB engine values:
|
238
|
+
#
|
239
|
+
# * `aurora` (for MySQL 5.6-compatible Aurora)
|
240
|
+
#
|
241
|
+
# * `aurora-mysql` (for MySQL 5.7-compatible Aurora)
|
242
|
+
#
|
243
|
+
# * `aurora-postgresql`
|
219
244
|
# @option options [required, String] :description
|
220
245
|
# The description for the DB cluster parameter group.
|
221
246
|
# @option options [Array<Types::Tag>] :tags
|
@@ -264,6 +289,22 @@ module Aws::RDS
|
|
264
289
|
# @param [Hash] options ({})
|
265
290
|
# @option options [required, Array<Types::Parameter>] :parameters
|
266
291
|
# A list of parameters in the DB cluster parameter group to modify.
|
292
|
+
#
|
293
|
+
# Valid Values (for the application method): `immediate |
|
294
|
+
# pending-reboot`
|
295
|
+
#
|
296
|
+
# <note markdown="1"> You can use the `immediate` value with dynamic parameters only. You
|
297
|
+
# can use the `pending-reboot` value for both dynamic and static
|
298
|
+
# parameters.
|
299
|
+
#
|
300
|
+
# When the application method is `immediate`, changes to dynamic
|
301
|
+
# parameters are applied immediately to the DB clusters associated with
|
302
|
+
# the parameter group. When the application method is `pending-reboot`,
|
303
|
+
# changes to dynamic and static parameters are applied after a reboot
|
304
|
+
# without failover to the DB clusters associated with the parameter
|
305
|
+
# group.
|
306
|
+
#
|
307
|
+
# </note>
|
267
308
|
# @return [DBClusterParameterGroup]
|
268
309
|
def modify(options = {})
|
269
310
|
options = options.merge(db_cluster_parameter_group_name: @name)
|
@@ -142,11 +142,12 @@ module Aws::RDS
|
|
142
142
|
data[:storage_encrypted]
|
143
143
|
end
|
144
144
|
|
145
|
-
# If `StorageEncrypted` is true, the
|
146
|
-
# encrypted DB cluster snapshot.
|
145
|
+
# If `StorageEncrypted` is true, the Amazon Web Services KMS key
|
146
|
+
# identifier for the encrypted DB cluster snapshot.
|
147
147
|
#
|
148
|
-
# The
|
149
|
-
# name for the
|
148
|
+
# The Amazon Web Services KMS key identifier is the key ARN, key ID,
|
149
|
+
# alias ARN, or alias name for the Amazon Web Services KMS customer
|
150
|
+
# master key (CMK).
|
150
151
|
# @return [String]
|
151
152
|
def kms_key_id
|
152
153
|
data[:kms_key_id]
|
@@ -166,8 +167,8 @@ module Aws::RDS
|
|
166
167
|
data[:source_db_cluster_snapshot_arn]
|
167
168
|
end
|
168
169
|
|
169
|
-
# True if mapping of
|
170
|
-
# to database accounts is enabled, and otherwise false.
|
170
|
+
# True if mapping of Amazon Web Services Identity and Access Management
|
171
|
+
# (IAM) accounts to database accounts is enabled, and otherwise false.
|
171
172
|
# @return [Boolean]
|
172
173
|
def iam_database_authentication_enabled
|
173
174
|
data[:iam_database_authentication_enabled]
|
@@ -376,69 +377,77 @@ module Aws::RDS
|
|
376
377
|
#
|
377
378
|
# Example: `my-cluster-snapshot2`
|
378
379
|
# @option options [String] :kms_key_id
|
379
|
-
# The
|
380
|
-
#
|
381
|
-
# name for the
|
382
|
-
#
|
383
|
-
#
|
384
|
-
# you
|
385
|
-
#
|
386
|
-
# copy
|
387
|
-
#
|
380
|
+
# The Amazon Web Services KMS key identifier for an encrypted DB cluster
|
381
|
+
# snapshot. The Amazon Web Services KMS key identifier is the key ARN,
|
382
|
+
# key ID, alias ARN, or alias name for the Amazon Web Services KMS
|
383
|
+
# customer master key (CMK).
|
384
|
+
#
|
385
|
+
# If you copy an encrypted DB cluster snapshot from your Amazon Web
|
386
|
+
# Services account, you can specify a value for `KmsKeyId` to encrypt
|
387
|
+
# the copy with a new Amazon Web Services KMS CMK. If you don't specify
|
388
|
+
# a value for `KmsKeyId`, then the copy of the DB cluster snapshot is
|
389
|
+
# encrypted with the same Amazon Web Services KMS key as the source DB
|
390
|
+
# cluster snapshot.
|
388
391
|
#
|
389
392
|
# If you copy an encrypted DB cluster snapshot that is shared from
|
390
|
-
# another
|
393
|
+
# another Amazon Web Services account, then you must specify a value for
|
394
|
+
# `KmsKeyId`.
|
391
395
|
#
|
392
|
-
# To copy an encrypted DB cluster snapshot to another
|
393
|
-
# must set `KmsKeyId` to the
|
394
|
-
#
|
395
|
-
#
|
396
|
-
#
|
397
|
-
#
|
396
|
+
# To copy an encrypted DB cluster snapshot to another Amazon Web
|
397
|
+
# Services Region, you must set `KmsKeyId` to the Amazon Web Services
|
398
|
+
# KMS key identifier you want to use to encrypt the copy of the DB
|
399
|
+
# cluster snapshot in the destination Amazon Web Services Region. Amazon
|
400
|
+
# Web Services KMS CMKs are specific to the Amazon Web Services Region
|
401
|
+
# that they are created in, and you can't use CMKs from one Amazon Web
|
402
|
+
# Services Region in another Amazon Web Services Region.
|
398
403
|
#
|
399
404
|
# If you copy an unencrypted DB cluster snapshot and specify a value for
|
400
405
|
# the `KmsKeyId` parameter, an error is returned.
|
401
406
|
# @option options [String] :pre_signed_url
|
402
407
|
# The URL that contains a Signature Version 4 signed request for the
|
403
|
-
# `CopyDBClusterSnapshot` API action in the
|
404
|
-
# source DB cluster snapshot to copy. The
|
405
|
-
# be used when copying an encrypted DB
|
406
|
-
#
|
407
|
-
#
|
408
|
+
# `CopyDBClusterSnapshot` API action in the Amazon Web Services Region
|
409
|
+
# that contains the source DB cluster snapshot to copy. The
|
410
|
+
# `PreSignedUrl` parameter must be used when copying an encrypted DB
|
411
|
+
# cluster snapshot from another Amazon Web Services Region. Don't
|
412
|
+
# specify `PreSignedUrl` when you are copying an encrypted DB cluster
|
413
|
+
# snapshot in the same Amazon Web Services Region.
|
408
414
|
#
|
409
415
|
# The pre-signed URL must be a valid request for the
|
410
416
|
# `CopyDBClusterSnapshot` API action that can be executed in the source
|
411
|
-
#
|
412
|
-
# copied. The pre-signed URL request must contain the
|
413
|
-
# parameter values:
|
417
|
+
# Amazon Web Services Region that contains the encrypted DB cluster
|
418
|
+
# snapshot to be copied. The pre-signed URL request must contain the
|
419
|
+
# following parameter values:
|
414
420
|
#
|
415
|
-
# * `KmsKeyId` - The
|
416
|
-
# (CMK) to use to encrypt the copy of the DB
|
417
|
-
#
|
418
|
-
#
|
419
|
-
#
|
421
|
+
# * `KmsKeyId` - The Amazon Web Services KMS key identifier for the
|
422
|
+
# customer master key (CMK) to use to encrypt the copy of the DB
|
423
|
+
# cluster snapshot in the destination Amazon Web Services Region. This
|
424
|
+
# is the same identifier for both the `CopyDBClusterSnapshot` action
|
425
|
+
# that is called in the destination Amazon Web Services Region, and
|
426
|
+
# the action contained in the pre-signed URL.
|
420
427
|
#
|
421
|
-
# * `DestinationRegion` - The name of the
|
422
|
-
# snapshot is to be created in.
|
428
|
+
# * `DestinationRegion` - The name of the Amazon Web Services Region
|
429
|
+
# that the DB cluster snapshot is to be created in.
|
423
430
|
#
|
424
431
|
# * `SourceDBClusterSnapshotIdentifier` - The DB cluster snapshot
|
425
432
|
# identifier for the encrypted DB cluster snapshot to be copied. This
|
426
433
|
# identifier must be in the Amazon Resource Name (ARN) format for the
|
427
|
-
# source
|
428
|
-
# cluster snapshot from the us-west-2
|
429
|
-
# `SourceDBClusterSnapshotIdentifier` looks
|
430
|
-
# example:
|
434
|
+
# source Amazon Web Services Region. For example, if you are copying
|
435
|
+
# an encrypted DB cluster snapshot from the us-west-2 Amazon Web
|
436
|
+
# Services Region, then your `SourceDBClusterSnapshotIdentifier` looks
|
437
|
+
# like the following example:
|
431
438
|
# `arn:aws:rds:us-west-2:123456789012:cluster-snapshot:aurora-cluster1-snapshot-20161115`.
|
432
439
|
#
|
433
440
|
# To learn how to generate a Signature Version 4 signed request, see [
|
434
|
-
# Authenticating Requests: Using Query Parameters (
|
435
|
-
# 4)][1] and [ Signature Version 4 Signing
|
441
|
+
# Authenticating Requests: Using Query Parameters (Amazon Web Services
|
442
|
+
# Signature Version 4)][1] and [ Signature Version 4 Signing
|
443
|
+
# Process][2].
|
436
444
|
#
|
437
|
-
# <note markdown="1"> If you are using an
|
438
|
-
# `SourceRegion` (or `--source-region` for the
|
445
|
+
# <note markdown="1"> If you are using an Amazon Web Services SDK tool or the CLI, you can
|
446
|
+
# specify `SourceRegion` (or `--source-region` for the CLI) instead of
|
439
447
|
# specifying `PreSignedUrl` manually. Specifying `SourceRegion`
|
440
448
|
# autogenerates a pre-signed URL that is a valid request for the
|
441
|
-
# operation that can be executed in the source
|
449
|
+
# operation that can be executed in the source Amazon Web Services
|
450
|
+
# Region.
|
442
451
|
#
|
443
452
|
# </note>
|
444
453
|
#
|
@@ -603,27 +612,28 @@ module Aws::RDS
|
|
603
612
|
# @option options [Array<Types::Tag>] :tags
|
604
613
|
# The tags to be assigned to the restored DB cluster.
|
605
614
|
# @option options [String] :kms_key_id
|
606
|
-
# The
|
607
|
-
# cluster from a DB snapshot or DB cluster snapshot.
|
615
|
+
# The Amazon Web Services KMS key identifier to use when restoring an
|
616
|
+
# encrypted DB cluster from a DB snapshot or DB cluster snapshot.
|
608
617
|
#
|
609
|
-
# The
|
610
|
-
#
|
611
|
-
#
|
618
|
+
# The Amazon Web Services KMS key identifier is the key ARN, key ID,
|
619
|
+
# alias ARN, or alias name for the Amazon Web Services KMS customer
|
620
|
+
# master key (CMK). To use a CMK in a different Amazon Web Services
|
621
|
+
# account, specify the key ARN or alias ARN.
|
612
622
|
#
|
613
623
|
# When you don't specify a value for the `KmsKeyId` parameter, then the
|
614
624
|
# following occurs:
|
615
625
|
#
|
616
626
|
# * If the DB snapshot or DB cluster snapshot in `SnapshotIdentifier` is
|
617
|
-
# encrypted, then the restored DB cluster is encrypted using the
|
618
|
-
# KMS CMK that was used to encrypt the DB snapshot
|
619
|
-
# snapshot.
|
627
|
+
# encrypted, then the restored DB cluster is encrypted using the
|
628
|
+
# Amazon Web Services KMS CMK that was used to encrypt the DB snapshot
|
629
|
+
# or DB cluster snapshot.
|
620
630
|
#
|
621
631
|
# * If the DB snapshot or DB cluster snapshot in `SnapshotIdentifier`
|
622
632
|
# isn't encrypted, then the restored DB cluster isn't encrypted.
|
623
633
|
# @option options [Boolean] :enable_iam_database_authentication
|
624
|
-
# A value that indicates whether to enable mapping of
|
625
|
-
# Access Management (IAM) accounts to database
|
626
|
-
# mapping is disabled.
|
634
|
+
# A value that indicates whether to enable mapping of Amazon Web
|
635
|
+
# Services Identity and Access Management (IAM) accounts to database
|
636
|
+
# accounts. By default, mapping is disabled.
|
627
637
|
#
|
628
638
|
# For more information, see [ IAM Database Authentication][1] in the
|
629
639
|
# *Amazon Aurora User Guide.*
|
@@ -50,12 +50,12 @@ module Aws::RDS
|
|
50
50
|
|
51
51
|
# Specifies the current state of this database.
|
52
52
|
#
|
53
|
-
# For information about DB instance statuses, see [DB
|
54
|
-
#
|
53
|
+
# For information about DB instance statuses, see [Viewing DB instance
|
54
|
+
# status][1] in the *Amazon RDS User Guide.*
|
55
55
|
#
|
56
56
|
#
|
57
57
|
#
|
58
|
-
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Overview.DBInstance.Status
|
58
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/accessing-monitoring.html#Overview.DBInstance.Status
|
59
59
|
# @return [String]
|
60
60
|
def db_instance_status
|
61
61
|
data[:db_instance_status]
|
@@ -340,19 +340,21 @@ module Aws::RDS
|
|
340
340
|
data[:storage_encrypted]
|
341
341
|
end
|
342
342
|
|
343
|
-
# If `StorageEncrypted` is true, the
|
344
|
-
# encrypted DB instance.
|
343
|
+
# If `StorageEncrypted` is true, the Amazon Web Services KMS key
|
344
|
+
# identifier for the encrypted DB instance.
|
345
345
|
#
|
346
|
-
# The
|
347
|
-
# name for the
|
346
|
+
# The Amazon Web Services KMS key identifier is the key ARN, key ID,
|
347
|
+
# alias ARN, or alias name for the Amazon Web Services KMS customer
|
348
|
+
# master key (CMK).
|
348
349
|
# @return [String]
|
349
350
|
def kms_key_id
|
350
351
|
data[:kms_key_id]
|
351
352
|
end
|
352
353
|
|
353
|
-
# The
|
354
|
-
# identifier is found in
|
355
|
-
#
|
354
|
+
# The Amazon Web Services Region-unique, immutable identifier for the DB
|
355
|
+
# instance. This identifier is found in Amazon Web Services CloudTrail
|
356
|
+
# log entries whenever the Amazon Web Services KMS customer master key
|
357
|
+
# (CMK) for the DB instance is accessed.
|
356
358
|
# @return [String]
|
357
359
|
def dbi_resource_id
|
358
360
|
data[:dbi_resource_id]
|
@@ -433,8 +435,8 @@ module Aws::RDS
|
|
433
435
|
data[:timezone]
|
434
436
|
end
|
435
437
|
|
436
|
-
# True if mapping of
|
437
|
-
# to database accounts is enabled, and otherwise false.
|
438
|
+
# True if mapping of Amazon Web Services Identity and Access Management
|
439
|
+
# (IAM) accounts to database accounts is enabled, and otherwise false.
|
438
440
|
#
|
439
441
|
# IAM database authentication can be enabled for the following database
|
440
442
|
# engines
|
@@ -457,11 +459,12 @@ module Aws::RDS
|
|
457
459
|
data[:performance_insights_enabled]
|
458
460
|
end
|
459
461
|
|
460
|
-
# The
|
461
|
-
# data.
|
462
|
+
# The Amazon Web Services KMS key identifier for encryption of
|
463
|
+
# Performance Insights data.
|
462
464
|
#
|
463
|
-
# The
|
464
|
-
# name for the
|
465
|
+
# The Amazon Web Services KMS key identifier is the key ARN, key ID,
|
466
|
+
# alias ARN, or alias name for the Amazon Web Services KMS customer
|
467
|
+
# master key (CMK).
|
465
468
|
# @return [String]
|
466
469
|
def performance_insights_kms_key_id
|
467
470
|
data[:performance_insights_kms_key_id]
|
@@ -508,8 +511,8 @@ module Aws::RDS
|
|
508
511
|
data[:deletion_protection]
|
509
512
|
end
|
510
513
|
|
511
|
-
# The
|
512
|
-
# DB instance.
|
514
|
+
# The Amazon Web Services Identity and Access Management (IAM) roles
|
515
|
+
# associated with the DB instance.
|
513
516
|
# @return [Array<Types::DBInstanceRole>]
|
514
517
|
def associated_roles
|
515
518
|
data[:associated_roles]
|
@@ -556,10 +559,11 @@ module Aws::RDS
|
|
556
559
|
# network.
|
557
560
|
#
|
558
561
|
# For more information about RDS on Outposts, see [Working with Amazon
|
559
|
-
# RDS on
|
562
|
+
# RDS on Amazon Web Services Outposts][1] in the *Amazon RDS User
|
563
|
+
# Guide*.
|
560
564
|
#
|
561
565
|
# For more information about CoIPs, see [Customer-owned IP addresses][2]
|
562
|
-
# in the *
|
566
|
+
# in the *Amazon Web Services Outposts User Guide*.
|
563
567
|
#
|
564
568
|
#
|
565
569
|
#
|
@@ -570,12 +574,50 @@ module Aws::RDS
|
|
570
574
|
data[:customer_owned_ip_enabled]
|
571
575
|
end
|
572
576
|
|
573
|
-
# The Amazon Resource Name (ARN) of the recovery point in
|
577
|
+
# The Amazon Resource Name (ARN) of the recovery point in Amazon Web
|
578
|
+
# Services Backup.
|
574
579
|
# @return [String]
|
575
580
|
def aws_backup_recovery_point_arn
|
576
581
|
data[:aws_backup_recovery_point_arn]
|
577
582
|
end
|
578
583
|
|
584
|
+
# The status of the database activity stream.
|
585
|
+
# @return [String]
|
586
|
+
def activity_stream_status
|
587
|
+
data[:activity_stream_status]
|
588
|
+
end
|
589
|
+
|
590
|
+
# The Amazon Web Services KMS key identifier used for encrypting
|
591
|
+
# messages in the database activity stream. The Amazon Web Services KMS
|
592
|
+
# key identifier is the key ARN, key ID, alias ARN, or alias name for
|
593
|
+
# the Amazon Web Services KMS customer master key (CMK).
|
594
|
+
# @return [String]
|
595
|
+
def activity_stream_kms_key_id
|
596
|
+
data[:activity_stream_kms_key_id]
|
597
|
+
end
|
598
|
+
|
599
|
+
# The name of the Amazon Kinesis data stream used for the database
|
600
|
+
# activity stream.
|
601
|
+
# @return [String]
|
602
|
+
def activity_stream_kinesis_stream_name
|
603
|
+
data[:activity_stream_kinesis_stream_name]
|
604
|
+
end
|
605
|
+
|
606
|
+
# The mode of the database activity stream. Database events such as a
|
607
|
+
# change or access generate an activity stream event. RDS for Oracle
|
608
|
+
# always handles these events asynchronously.
|
609
|
+
# @return [String]
|
610
|
+
def activity_stream_mode
|
611
|
+
data[:activity_stream_mode]
|
612
|
+
end
|
613
|
+
|
614
|
+
# Indicates whether engine-native audit fields are included in the
|
615
|
+
# database activity stream.
|
616
|
+
# @return [Boolean]
|
617
|
+
def activity_stream_engine_native_audit_fields_included
|
618
|
+
data[:activity_stream_engine_native_audit_fields_included]
|
619
|
+
end
|
620
|
+
|
579
621
|
# @!endgroup
|
580
622
|
|
581
623
|
# @return [Client]
|
@@ -957,10 +999,10 @@ module Aws::RDS
|
|
957
999
|
# * Web and Express editions: Must be an integer from 20 to 1024.
|
958
1000
|
# @option options [required, String] :db_instance_class
|
959
1001
|
# The compute and memory capacity of the DB instance, for example,
|
960
|
-
# `db.m4.large`. Not all DB instance classes are available in all
|
961
|
-
# Regions, or for all database engines. For the full list
|
962
|
-
# classes, and availability for your engine, see [DB
|
963
|
-
# in the *Amazon RDS User Guide.*
|
1002
|
+
# `db.m4.large`. Not all DB instance classes are available in all Amazon
|
1003
|
+
# Web Services Regions, or for all database engines. For the full list
|
1004
|
+
# of DB instance classes, and availability for your engine, see [DB
|
1005
|
+
# Instance Class][1] in the *Amazon RDS User Guide.*
|
964
1006
|
#
|
965
1007
|
#
|
966
1008
|
#
|
@@ -968,7 +1010,8 @@ module Aws::RDS
|
|
968
1010
|
# @option options [required, String] :engine
|
969
1011
|
# The name of the database engine to be used for this instance.
|
970
1012
|
#
|
971
|
-
# Not every database engine is available for every
|
1013
|
+
# Not every database engine is available for every Amazon Web Services
|
1014
|
+
# Region.
|
972
1015
|
#
|
973
1016
|
# Valid Values:
|
974
1017
|
#
|
@@ -984,11 +1027,11 @@ module Aws::RDS
|
|
984
1027
|
#
|
985
1028
|
# * `oracle-ee`
|
986
1029
|
#
|
987
|
-
# * `oracle-
|
1030
|
+
# * `oracle-ee-cdb`
|
988
1031
|
#
|
989
|
-
# * `oracle-
|
1032
|
+
# * `oracle-se2`
|
990
1033
|
#
|
991
|
-
# * `oracle-
|
1034
|
+
# * `oracle-se2-cdb`
|
992
1035
|
#
|
993
1036
|
# * `postgres`
|
994
1037
|
#
|
@@ -1109,17 +1152,18 @@ module Aws::RDS
|
|
1109
1152
|
# VPC.
|
1110
1153
|
# @option options [String] :availability_zone
|
1111
1154
|
# The Availability Zone (AZ) where the database will be created. For
|
1112
|
-
# information on
|
1113
|
-
# Availability Zones][1].
|
1155
|
+
# information on Amazon Web Services Regions and Availability Zones, see
|
1156
|
+
# [Regions and Availability Zones][1].
|
1114
1157
|
#
|
1115
1158
|
# Default: A random, system-chosen Availability Zone in the endpoint's
|
1116
|
-
#
|
1159
|
+
# Amazon Web Services Region.
|
1117
1160
|
#
|
1118
1161
|
# Example: `us-east-1d`
|
1119
1162
|
#
|
1120
1163
|
# Constraint: The `AvailabilityZone` parameter can't be specified if
|
1121
1164
|
# the DB instance is a Multi-AZ deployment. The specified Availability
|
1122
|
-
# Zone must be in the same
|
1165
|
+
# Zone must be in the same Amazon Web Services Region as the current
|
1166
|
+
# endpoint.
|
1123
1167
|
#
|
1124
1168
|
# <note markdown="1"> If you're creating a DB instance in an RDS on VMware environment,
|
1125
1169
|
# specify the identifier of the custom Availability Zone to create the
|
@@ -1146,8 +1190,8 @@ module Aws::RDS
|
|
1146
1190
|
# Format: `ddd:hh24:mi-ddd:hh24:mi`
|
1147
1191
|
#
|
1148
1192
|
# The default is a 30-minute window selected at random from an 8-hour
|
1149
|
-
# block of time for each
|
1150
|
-
# week.
|
1193
|
+
# block of time for each Amazon Web Services Region, occurring on a
|
1194
|
+
# random day of the week.
|
1151
1195
|
#
|
1152
1196
|
# Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.
|
1153
1197
|
#
|
@@ -1189,8 +1233,8 @@ module Aws::RDS
|
|
1189
1233
|
# The daily time range during which automated backups are created if
|
1190
1234
|
# automated backups are enabled, using the `BackupRetentionPeriod`
|
1191
1235
|
# parameter. The default is a 30-minute window selected at random from
|
1192
|
-
# an 8-hour block of time for each
|
1193
|
-
# [Backup window][1] in the *Amazon RDS User Guide*.
|
1236
|
+
# an 8-hour block of time for each Amazon Web Services Region. For more
|
1237
|
+
# information, see [Backup window][1] in the *Amazon RDS User Guide*.
|
1194
1238
|
#
|
1195
1239
|
# **Amazon Aurora**
|
1196
1240
|
#
|
@@ -1269,7 +1313,8 @@ module Aws::RDS
|
|
1269
1313
|
#
|
1270
1314
|
# The following are the database engines and links to information about
|
1271
1315
|
# the major and minor versions that are available with Amazon RDS. Not
|
1272
|
-
# every database engine is available for every
|
1316
|
+
# every database engine is available for every Amazon Web Services
|
1317
|
+
# Region.
|
1273
1318
|
#
|
1274
1319
|
# **Amazon Aurora**
|
1275
1320
|
#
|
@@ -1409,21 +1454,24 @@ module Aws::RDS
|
|
1409
1454
|
# Not applicable. The encryption for DB instances is managed by the DB
|
1410
1455
|
# cluster.
|
1411
1456
|
# @option options [String] :kms_key_id
|
1412
|
-
# The
|
1457
|
+
# The Amazon Web Services KMS key identifier for an encrypted DB
|
1458
|
+
# instance.
|
1413
1459
|
#
|
1414
|
-
# The
|
1415
|
-
#
|
1416
|
-
#
|
1460
|
+
# The Amazon Web Services KMS key identifier is the key ARN, key ID,
|
1461
|
+
# alias ARN, or alias name for the Amazon Web Services KMS customer
|
1462
|
+
# master key (CMK). To use a CMK in a different Amazon Web Services
|
1463
|
+
# account, specify the key ARN or alias ARN.
|
1417
1464
|
#
|
1418
1465
|
# **Amazon Aurora**
|
1419
1466
|
#
|
1420
|
-
# Not applicable. The
|
1421
|
-
# cluster. For more information, see `CreateDBCluster`.
|
1467
|
+
# Not applicable. The Amazon Web Services KMS key identifier is managed
|
1468
|
+
# by the DB cluster. For more information, see `CreateDBCluster`.
|
1422
1469
|
#
|
1423
1470
|
# If `StorageEncrypted` is enabled, and you do not specify a value for
|
1424
1471
|
# the `KmsKeyId` parameter, then Amazon RDS uses your default CMK. There
|
1425
|
-
# is a default CMK for your
|
1426
|
-
# different default CMK for each
|
1472
|
+
# is a default CMK for your Amazon Web Services account. Your Amazon Web
|
1473
|
+
# Services account has a different default CMK for each Amazon Web
|
1474
|
+
# Services Region.
|
1427
1475
|
# @option options [String] :domain
|
1428
1476
|
# The Active Directory directory ID to create the DB instance in.
|
1429
1477
|
# Currently, only MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB
|
@@ -1490,12 +1538,13 @@ module Aws::RDS
|
|
1490
1538
|
#
|
1491
1539
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_SQLServer.html#SQLServer.Concepts.General.TimeZone
|
1492
1540
|
# @option options [Boolean] :enable_iam_database_authentication
|
1493
|
-
# A value that indicates whether to enable mapping of
|
1494
|
-
# Access Management (IAM) accounts to database
|
1495
|
-
# mapping is disabled.
|
1541
|
+
# A value that indicates whether to enable mapping of Amazon Web
|
1542
|
+
# Services Identity and Access Management (IAM) accounts to database
|
1543
|
+
# accounts. By default, mapping is disabled.
|
1496
1544
|
#
|
1497
|
-
# This setting doesn't apply to Amazon Aurora. Mapping
|
1498
|
-
# to database accounts is managed by the DB
|
1545
|
+
# This setting doesn't apply to Amazon Aurora. Mapping Amazon Web
|
1546
|
+
# Services IAM accounts to database accounts is managed by the DB
|
1547
|
+
# cluster.
|
1499
1548
|
#
|
1500
1549
|
# For more information, see [ IAM Database Authentication for MySQL and
|
1501
1550
|
# PostgreSQL][1] in the *Amazon RDS User Guide.*
|
@@ -1514,16 +1563,17 @@ module Aws::RDS
|
|
1514
1563
|
#
|
1515
1564
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.html
|
1516
1565
|
# @option options [String] :performance_insights_kms_key_id
|
1517
|
-
# The
|
1518
|
-
# data.
|
1566
|
+
# The Amazon Web Services KMS key identifier for encryption of
|
1567
|
+
# Performance Insights data.
|
1519
1568
|
#
|
1520
|
-
# The
|
1521
|
-
# name for the
|
1569
|
+
# The Amazon Web Services KMS key identifier is the key ARN, key ID,
|
1570
|
+
# alias ARN, or alias name for the Amazon Web Services KMS customer
|
1571
|
+
# master key (CMK).
|
1522
1572
|
#
|
1523
1573
|
# If you do not specify a value for `PerformanceInsightsKMSKeyId`, then
|
1524
|
-
# Amazon RDS uses your default CMK. There is a default CMK for your
|
1525
|
-
# account. Your
|
1526
|
-
# Region.
|
1574
|
+
# Amazon RDS uses your default CMK. There is a default CMK for your
|
1575
|
+
# Amazon Web Services account. Your Amazon Web Services account has a
|
1576
|
+
# different default CMK for each Amazon Web Services Region.
|
1527
1577
|
# @option options [Integer] :performance_insights_retention_period
|
1528
1578
|
# The amount of time, in days, to retain Performance Insights data.
|
1529
1579
|
# Valid values are 7 or 731 (2 years).
|
@@ -1602,10 +1652,11 @@ module Aws::RDS
|
|
1602
1652
|
# from outside of its virtual private cloud (VPC) on your local network.
|
1603
1653
|
#
|
1604
1654
|
# For more information about RDS on Outposts, see [Working with Amazon
|
1605
|
-
# RDS on
|
1655
|
+
# RDS on Amazon Web Services Outposts][1] in the *Amazon RDS User
|
1656
|
+
# Guide*.
|
1606
1657
|
#
|
1607
1658
|
# For more information about CoIPs, see [Customer-owned IP addresses][2]
|
1608
|
-
# in the *
|
1659
|
+
# in the *Amazon Web Services Outposts User Guide*.
|
1609
1660
|
#
|
1610
1661
|
#
|
1611
1662
|
#
|
@@ -1675,10 +1726,10 @@ module Aws::RDS
|
|
1675
1726
|
# a lowercase string.
|
1676
1727
|
# @option options [String] :db_instance_class
|
1677
1728
|
# The compute and memory capacity of the read replica, for example,
|
1678
|
-
# `db.m4.large`. Not all DB instance classes are available in all
|
1679
|
-
# Regions, or for all database engines. For the full list
|
1680
|
-
# classes, and availability for your engine, see [DB
|
1681
|
-
# in the *Amazon RDS User Guide.*
|
1729
|
+
# `db.m4.large`. Not all DB instance classes are available in all Amazon
|
1730
|
+
# Web Services Regions, or for all database engines. For the full list
|
1731
|
+
# of DB instance classes, and availability for your engine, see [DB
|
1732
|
+
# Instance Class][1] in the *Amazon RDS User Guide.*
|
1682
1733
|
#
|
1683
1734
|
# Default: Inherits from the source DB instance.
|
1684
1735
|
#
|
@@ -1689,7 +1740,7 @@ module Aws::RDS
|
|
1689
1740
|
# The Availability Zone (AZ) where the read replica will be created.
|
1690
1741
|
#
|
1691
1742
|
# Default: A random, system-chosen Availability Zone in the endpoint's
|
1692
|
-
#
|
1743
|
+
# Amazon Web Services Region.
|
1693
1744
|
#
|
1694
1745
|
# Example: `us-east-1d`
|
1695
1746
|
# @option options [Integer] :port
|
@@ -1773,15 +1824,15 @@ module Aws::RDS
|
|
1773
1824
|
# Constraints:
|
1774
1825
|
#
|
1775
1826
|
# * Can only be specified if the source DB instance identifier specifies
|
1776
|
-
# a DB instance in another
|
1827
|
+
# a DB instance in another Amazon Web Services Region.
|
1777
1828
|
#
|
1778
1829
|
# * If supplied, must match the name of an existing DBSubnetGroup.
|
1779
1830
|
#
|
1780
|
-
# * The specified DB subnet group must be in the same
|
1781
|
-
# which the operation is running.
|
1831
|
+
# * The specified DB subnet group must be in the same Amazon Web
|
1832
|
+
# Services Region in which the operation is running.
|
1782
1833
|
#
|
1783
|
-
# * All read replicas in one
|
1784
|
-
# source DB instance must either:>
|
1834
|
+
# * All read replicas in one Amazon Web Services Region that are created
|
1835
|
+
# from the same source DB instance must either:>
|
1785
1836
|
#
|
1786
1837
|
# * Specify DB subnet groups from the same VPC. All these read
|
1787
1838
|
# replicas are created in the same VPC.
|
@@ -1830,75 +1881,84 @@ module Aws::RDS
|
|
1830
1881
|
#
|
1831
1882
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Monitoring.html#USER_Monitoring.OS.IAMRole
|
1832
1883
|
# @option options [String] :kms_key_id
|
1833
|
-
# The
|
1884
|
+
# The Amazon Web Services KMS key identifier for an encrypted read
|
1885
|
+
# replica.
|
1834
1886
|
#
|
1835
|
-
# The
|
1836
|
-
# name for the
|
1887
|
+
# The Amazon Web Services KMS key identifier is the key ARN, key ID,
|
1888
|
+
# alias ARN, or alias name for the Amazon Web Services KMS CMK.
|
1837
1889
|
#
|
1838
|
-
# If you create an encrypted read replica in the same
|
1839
|
-
# source DB instance, then do not specify a value
|
1840
|
-
# read replica in the same Region is always
|
1841
|
-
# KMS CMK as the source DB
|
1890
|
+
# If you create an encrypted read replica in the same Amazon Web
|
1891
|
+
# Services Region as the source DB instance, then do not specify a value
|
1892
|
+
# for this parameter. A read replica in the same Region is always
|
1893
|
+
# encrypted with the same Amazon Web Services KMS CMK as the source DB
|
1894
|
+
# instance.
|
1842
1895
|
#
|
1843
|
-
# If you create an encrypted read replica in a different
|
1844
|
-
# then you must specify a
|
1845
|
-
#
|
1846
|
-
#
|
1847
|
-
#
|
1896
|
+
# If you create an encrypted read replica in a different Amazon Web
|
1897
|
+
# Services Region, then you must specify a Amazon Web Services KMS key
|
1898
|
+
# identifier for the destination Amazon Web Services Region. Amazon Web
|
1899
|
+
# Services KMS CMKs are specific to the Amazon Web Services Region that
|
1900
|
+
# they are created in, and you can't use CMKs from one Amazon Web
|
1901
|
+
# Services Region in another Amazon Web Services Region.
|
1848
1902
|
#
|
1849
1903
|
# You can't create an encrypted read replica from an unencrypted DB
|
1850
1904
|
# instance.
|
1851
1905
|
# @option options [String] :pre_signed_url
|
1852
1906
|
# The URL that contains a Signature Version 4 signed request for the
|
1853
|
-
# `CreateDBInstanceReadReplica` API action in the source
|
1854
|
-
# contains the source DB instance.
|
1907
|
+
# `CreateDBInstanceReadReplica` API action in the source Amazon Web
|
1908
|
+
# Services Region that contains the source DB instance.
|
1855
1909
|
#
|
1856
1910
|
# You must specify this parameter when you create an encrypted read
|
1857
|
-
# replica from another
|
1858
|
-
# specify `PreSignedUrl` when you are creating an
|
1859
|
-
# in the same
|
1911
|
+
# replica from another Amazon Web Services Region by using the Amazon
|
1912
|
+
# RDS API. Don't specify `PreSignedUrl` when you are creating an
|
1913
|
+
# encrypted read replica in the same Amazon Web Services Region.
|
1860
1914
|
#
|
1861
1915
|
# The presigned URL must be a valid request for the
|
1862
1916
|
# `CreateDBInstanceReadReplica` API action that can be executed in the
|
1863
|
-
# source
|
1864
|
-
# presigned URL request must contain the following
|
1917
|
+
# source Amazon Web Services Region that contains the encrypted source
|
1918
|
+
# DB instance. The presigned URL request must contain the following
|
1919
|
+
# parameter values:
|
1865
1920
|
#
|
1866
|
-
# * `DestinationRegion` - The
|
1867
|
-
# is created in. This
|
1868
|
-
#
|
1869
|
-
# presigned URL.
|
1921
|
+
# * `DestinationRegion` - The Amazon Web Services Region that the
|
1922
|
+
# encrypted read replica is created in. This Amazon Web Services
|
1923
|
+
# Region is the same one where the `CreateDBInstanceReadReplica`
|
1924
|
+
# action is called that contains this presigned URL.
|
1870
1925
|
#
|
1871
1926
|
# For example, if you create an encrypted DB instance in the us-west-1
|
1872
|
-
#
|
1873
|
-
#
|
1874
|
-
# us-east-1
|
1875
|
-
#
|
1876
|
-
#
|
1877
|
-
#
|
1878
|
-
#
|
1879
|
-
#
|
1880
|
-
#
|
1881
|
-
#
|
1882
|
-
#
|
1883
|
-
#
|
1927
|
+
# Amazon Web Services Region, from a source DB instance in the
|
1928
|
+
# us-east-2 Amazon Web Services Region, then you call the
|
1929
|
+
# `CreateDBInstanceReadReplica` action in the us-east-1 Amazon Web
|
1930
|
+
# Services Region and provide a presigned URL that contains a call to
|
1931
|
+
# the `CreateDBInstanceReadReplica` action in the us-west-2 Amazon Web
|
1932
|
+
# Services Region. For this example, the `DestinationRegion` in the
|
1933
|
+
# presigned URL must be set to the us-east-1 Amazon Web Services
|
1934
|
+
# Region.
|
1935
|
+
#
|
1936
|
+
# * `KmsKeyId` - The Amazon Web Services KMS key identifier for the key
|
1937
|
+
# to use to encrypt the read replica in the destination Amazon Web
|
1938
|
+
# Services Region. This is the same identifier for both the
|
1939
|
+
# `CreateDBInstanceReadReplica` action that is called in the
|
1940
|
+
# destination Amazon Web Services Region, and the action contained in
|
1941
|
+
# the presigned URL.
|
1884
1942
|
#
|
1885
1943
|
# * `SourceDBInstanceIdentifier` - The DB instance identifier for the
|
1886
1944
|
# encrypted DB instance to be replicated. This identifier must be in
|
1887
|
-
# the Amazon Resource Name (ARN) format for the source
|
1888
|
-
# example, if you are creating an encrypted read
|
1889
|
-
# instance in the us-west-2
|
1890
|
-
# `SourceDBInstanceIdentifier` looks like the
|
1945
|
+
# the Amazon Resource Name (ARN) format for the source Amazon Web
|
1946
|
+
# Services Region. For example, if you are creating an encrypted read
|
1947
|
+
# replica from a DB instance in the us-west-2 Amazon Web Services
|
1948
|
+
# Region, then your `SourceDBInstanceIdentifier` looks like the
|
1949
|
+
# following example:
|
1891
1950
|
# `arn:aws:rds:us-west-2:123456789012:instance:mysql-instance1-20161115`.
|
1892
1951
|
#
|
1893
1952
|
# To learn how to generate a Signature Version 4 signed request, see
|
1894
|
-
# [Authenticating Requests: Using Query Parameters (
|
1895
|
-
# Version 4)][1] and [Signature Version 4 Signing Process][2].
|
1953
|
+
# [Authenticating Requests: Using Query Parameters (Amazon Web Services
|
1954
|
+
# Signature Version 4)][1] and [Signature Version 4 Signing Process][2].
|
1896
1955
|
#
|
1897
|
-
# <note markdown="1"> If you are using an
|
1898
|
-
# `SourceRegion` (or `--source-region` for the
|
1956
|
+
# <note markdown="1"> If you are using an Amazon Web Services SDK tool or the CLI, you can
|
1957
|
+
# specify `SourceRegion` (or `--source-region` for the CLI) instead of
|
1899
1958
|
# specifying `PreSignedUrl` manually. Specifying `SourceRegion`
|
1900
1959
|
# autogenerates a presigned URL that is a valid request for the
|
1901
|
-
# operation that can be executed in the source
|
1960
|
+
# operation that can be executed in the source Amazon Web Services
|
1961
|
+
# Region.
|
1902
1962
|
#
|
1903
1963
|
# `SourceRegion` isn't supported for SQL Server, because SQL Server on
|
1904
1964
|
# Amazon RDS doesn't support cross-region read replicas.
|
@@ -1910,9 +1970,9 @@ module Aws::RDS
|
|
1910
1970
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/API/sigv4-query-string-auth.html
|
1911
1971
|
# [2]: https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html
|
1912
1972
|
# @option options [Boolean] :enable_iam_database_authentication
|
1913
|
-
# A value that indicates whether to enable mapping of
|
1914
|
-
# Access Management (IAM) accounts to database
|
1915
|
-
# mapping is disabled.
|
1973
|
+
# A value that indicates whether to enable mapping of Amazon Web
|
1974
|
+
# Services Identity and Access Management (IAM) accounts to database
|
1975
|
+
# accounts. By default, mapping is disabled.
|
1916
1976
|
#
|
1917
1977
|
# For more information about IAM database authentication, see [ IAM
|
1918
1978
|
# Database Authentication for MySQL and PostgreSQL][1] in the *Amazon
|
@@ -1932,16 +1992,17 @@ module Aws::RDS
|
|
1932
1992
|
#
|
1933
1993
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.html
|
1934
1994
|
# @option options [String] :performance_insights_kms_key_id
|
1935
|
-
# The
|
1936
|
-
# data.
|
1995
|
+
# The Amazon Web Services KMS key identifier for encryption of
|
1996
|
+
# Performance Insights data.
|
1937
1997
|
#
|
1938
|
-
# The
|
1939
|
-
# name for the
|
1998
|
+
# The Amazon Web Services KMS key identifier is the key ARN, key ID,
|
1999
|
+
# alias ARN, or alias name for the Amazon Web Services KMS customer
|
2000
|
+
# master key (CMK).
|
1940
2001
|
#
|
1941
2002
|
# If you do not specify a value for `PerformanceInsightsKMSKeyId`, then
|
1942
|
-
# Amazon RDS uses your default CMK. There is a default CMK for your
|
1943
|
-
# account. Your
|
1944
|
-
# Region.
|
2003
|
+
# Amazon RDS uses your default CMK. There is a default CMK for your
|
2004
|
+
# Amazon Web Services account. Your Amazon Web Services account has a
|
2005
|
+
# different default CMK for each Amazon Web Services Region.
|
1945
2006
|
# @option options [Integer] :performance_insights_retention_period
|
1946
2007
|
# The amount of time, in days, to retain Performance Insights data.
|
1947
2008
|
# Valid values are 7 or 731 (2 years).
|
@@ -2203,10 +2264,10 @@ module Aws::RDS
|
|
2203
2264
|
# `CreateDBInstance`.
|
2204
2265
|
# @option options [String] :db_instance_class
|
2205
2266
|
# The new compute and memory capacity of the DB instance, for example,
|
2206
|
-
# `db.m4.large`. Not all DB instance classes are available in all
|
2207
|
-
# Regions, or for all database engines. For the full list
|
2208
|
-
# classes, and availability for your engine, see [DB
|
2209
|
-
# in the *Amazon RDS User Guide.*
|
2267
|
+
# `db.m4.large`. Not all DB instance classes are available in all Amazon
|
2268
|
+
# Web Services Regions, or for all database engines. For the full list
|
2269
|
+
# of DB instance classes, and availability for your engine, see [DB
|
2270
|
+
# Instance Class][1] in the *Amazon RDS User Guide.*
|
2210
2271
|
#
|
2211
2272
|
# If you modify the DB instance class, an outage occurs during the
|
2212
2273
|
# change. The change is applied during the next maintenance window,
|
@@ -2374,8 +2435,8 @@ module Aws::RDS
|
|
2374
2435
|
# `BackupRetentionPeriod` parameter. Changing this parameter doesn't
|
2375
2436
|
# result in an outage and the change is asynchronously applied as soon
|
2376
2437
|
# as possible. The default is a 30-minute window selected at random from
|
2377
|
-
# an 8-hour block of time for each
|
2378
|
-
# [Backup window][1] in the *Amazon RDS User Guide.*
|
2438
|
+
# an 8-hour block of time for each Amazon Web Services Region. For more
|
2439
|
+
# information, see [Backup window][1] in the *Amazon RDS User Guide.*
|
2379
2440
|
#
|
2380
2441
|
# **Amazon Aurora**
|
2381
2442
|
#
|
@@ -2685,12 +2746,13 @@ module Aws::RDS
|
|
2685
2746
|
#
|
2686
2747
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Managing.Backups.html#Aurora.Managing.FaultTolerance
|
2687
2748
|
# @option options [Boolean] :enable_iam_database_authentication
|
2688
|
-
# A value that indicates whether to enable mapping of
|
2689
|
-
# Access Management (IAM) accounts to database
|
2690
|
-
# mapping is disabled.
|
2749
|
+
# A value that indicates whether to enable mapping of Amazon Web
|
2750
|
+
# Services Identity and Access Management (IAM) accounts to database
|
2751
|
+
# accounts. By default, mapping is disabled.
|
2691
2752
|
#
|
2692
|
-
# This setting doesn't apply to Amazon Aurora. Mapping
|
2693
|
-
# to database accounts is managed by the DB
|
2753
|
+
# This setting doesn't apply to Amazon Aurora. Mapping Amazon Web
|
2754
|
+
# Services IAM accounts to database accounts is managed by the DB
|
2755
|
+
# cluster.
|
2694
2756
|
#
|
2695
2757
|
# For more information about IAM database authentication, see [ IAM
|
2696
2758
|
# Database Authentication for MySQL and PostgreSQL][1] in the *Amazon
|
@@ -2710,16 +2772,17 @@ module Aws::RDS
|
|
2710
2772
|
#
|
2711
2773
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.html
|
2712
2774
|
# @option options [String] :performance_insights_kms_key_id
|
2713
|
-
# The
|
2714
|
-
# data.
|
2775
|
+
# The Amazon Web Services KMS key identifier for encryption of
|
2776
|
+
# Performance Insights data.
|
2715
2777
|
#
|
2716
|
-
# The
|
2717
|
-
# name for the
|
2778
|
+
# The Amazon Web Services KMS key identifier is the key ARN, key ID,
|
2779
|
+
# alias ARN, or alias name for the Amazon Web Services KMS customer
|
2780
|
+
# master key (CMK).
|
2718
2781
|
#
|
2719
2782
|
# If you do not specify a value for `PerformanceInsightsKMSKeyId`, then
|
2720
|
-
# Amazon RDS uses your default CMK. There is a default CMK for your
|
2721
|
-
# account. Your
|
2722
|
-
# Region.
|
2783
|
+
# Amazon RDS uses your default CMK. There is a default CMK for your
|
2784
|
+
# Amazon Web Services account. Your Amazon Web Services account has a
|
2785
|
+
# different default CMK for each Amazon Web Services Region.
|
2723
2786
|
# @option options [Integer] :performance_insights_retention_period
|
2724
2787
|
# The amount of time, in days, to retain Performance Insights data.
|
2725
2788
|
# Valid values are 7 or 731 (2 years).
|
@@ -2812,17 +2875,19 @@ module Aws::RDS
|
|
2812
2875
|
# from outside of its virtual private cloud (VPC) on your local network.
|
2813
2876
|
#
|
2814
2877
|
# For more information about RDS on Outposts, see [Working with Amazon
|
2815
|
-
# RDS on
|
2878
|
+
# RDS on Amazon Web Services Outposts][1] in the *Amazon RDS User
|
2879
|
+
# Guide*.
|
2816
2880
|
#
|
2817
2881
|
# For more information about CoIPs, see [Customer-owned IP addresses][2]
|
2818
|
-
# in the *
|
2882
|
+
# in the *Amazon Web Services Outposts User Guide*.
|
2819
2883
|
#
|
2820
2884
|
#
|
2821
2885
|
#
|
2822
2886
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html
|
2823
2887
|
# [2]: https://docs.aws.amazon.com/outposts/latest/userguide/outposts-networking-components.html#ip-addressing
|
2824
2888
|
# @option options [String] :aws_backup_recovery_point_arn
|
2825
|
-
# The Amazon Resource Name (ARN) of the recovery point in
|
2889
|
+
# The Amazon Resource Name (ARN) of the recovery point in Amazon Web
|
2890
|
+
# Services Backup.
|
2826
2891
|
# @return [DBInstance]
|
2827
2892
|
def modify(options = {})
|
2828
2893
|
options = options.merge(db_instance_identifier: @id)
|
@@ -2859,9 +2924,9 @@ module Aws::RDS
|
|
2859
2924
|
# parameter.
|
2860
2925
|
#
|
2861
2926
|
# The default is a 30-minute window selected at random from an 8-hour
|
2862
|
-
# block of time for each
|
2863
|
-
# see [ Adjusting the Preferred Maintenance Window][1]
|
2864
|
-
# RDS User Guide.*
|
2927
|
+
# block of time for each Amazon Web Services Region. To see the time
|
2928
|
+
# blocks available, see [ Adjusting the Preferred Maintenance Window][1]
|
2929
|
+
# in the *Amazon RDS User Guide.*
|
2865
2930
|
#
|
2866
2931
|
# Constraints:
|
2867
2932
|
#
|
@@ -2992,9 +3057,9 @@ module Aws::RDS
|
|
2992
3057
|
# @option options [String] :db_instance_class
|
2993
3058
|
# The compute and memory capacity of the Amazon RDS DB instance, for
|
2994
3059
|
# example, `db.m4.large`. Not all DB instance classes are available in
|
2995
|
-
# all
|
2996
|
-
# instance classes, and availability for your engine,
|
2997
|
-
# Class][1] in the *Amazon RDS User Guide.*
|
3060
|
+
# all Amazon Web Services Regions, or for all database engines. For the
|
3061
|
+
# full list of DB instance classes, and availability for your engine,
|
3062
|
+
# see [DB Instance Class][1] in the *Amazon RDS User Guide.*
|
2998
3063
|
#
|
2999
3064
|
# Default: The same DBInstanceClass as the original DB instance.
|
3000
3065
|
#
|
@@ -3074,11 +3139,11 @@ module Aws::RDS
|
|
3074
3139
|
#
|
3075
3140
|
# * `oracle-ee`
|
3076
3141
|
#
|
3077
|
-
# * `oracle-
|
3142
|
+
# * `oracle-ee-cdb`
|
3078
3143
|
#
|
3079
|
-
# * `oracle-
|
3144
|
+
# * `oracle-se2`
|
3080
3145
|
#
|
3081
|
-
# * `oracle-
|
3146
|
+
# * `oracle-se2-cdb`
|
3082
3147
|
#
|
3083
3148
|
# * `postgres`
|
3084
3149
|
#
|
@@ -3153,9 +3218,9 @@ module Aws::RDS
|
|
3153
3218
|
# Specify the name of the IAM role to be used when making API calls to
|
3154
3219
|
# the Directory Service.
|
3155
3220
|
# @option options [Boolean] :enable_iam_database_authentication
|
3156
|
-
# A value that indicates whether to enable mapping of
|
3157
|
-
# Access Management (IAM) accounts to database
|
3158
|
-
# mapping is disabled.
|
3221
|
+
# A value that indicates whether to enable mapping of Amazon Web
|
3222
|
+
# Services Identity and Access Management (IAM) accounts to database
|
3223
|
+
# accounts. By default, mapping is disabled.
|
3159
3224
|
#
|
3160
3225
|
# For more information about IAM database authentication, see [ IAM
|
3161
3226
|
# Database Authentication for MySQL and PostgreSQL][1] in the *Amazon
|
@@ -3230,10 +3295,11 @@ module Aws::RDS
|
|
3230
3295
|
# from outside of its virtual private cloud (VPC) on your local network.
|
3231
3296
|
#
|
3232
3297
|
# For more information about RDS on Outposts, see [Working with Amazon
|
3233
|
-
# RDS on
|
3298
|
+
# RDS on Amazon Web Services Outposts][1] in the *Amazon RDS User
|
3299
|
+
# Guide*.
|
3234
3300
|
#
|
3235
3301
|
# For more information about CoIPs, see [Customer-owned IP addresses][2]
|
3236
|
-
# in the *
|
3302
|
+
# in the *Amazon Web Services Outposts User Guide*.
|
3237
3303
|
#
|
3238
3304
|
#
|
3239
3305
|
#
|
@@ -3562,21 +3628,21 @@ module Aws::RDS
|
|
3562
3628
|
# following values:
|
3563
3629
|
#
|
3564
3630
|
# * `automated` - Return all DB snapshots that have been automatically
|
3565
|
-
# taken by Amazon RDS for my
|
3631
|
+
# taken by Amazon RDS for my Amazon Web Services account.
|
3566
3632
|
#
|
3567
|
-
# * `manual` - Return all DB snapshots that have been taken by my
|
3568
|
-
# account.
|
3633
|
+
# * `manual` - Return all DB snapshots that have been taken by my Amazon
|
3634
|
+
# Web Services account.
|
3569
3635
|
#
|
3570
3636
|
# * `shared` - Return all manual DB snapshots that have been shared to
|
3571
|
-
# my
|
3637
|
+
# my Amazon Web Services account.
|
3572
3638
|
#
|
3573
3639
|
# * `public` - Return all DB snapshots that have been marked as public.
|
3574
3640
|
#
|
3575
|
-
# * `awsbackup` - Return the DB snapshots managed by the
|
3576
|
-
# service.
|
3641
|
+
# * `awsbackup` - Return the DB snapshots managed by the Amazon Web
|
3642
|
+
# Services Backup service.
|
3577
3643
|
#
|
3578
|
-
# For information about
|
3579
|
-
# Guide.* ][1]
|
3644
|
+
# For information about Amazon Web Services Backup, see the [ *Amazon
|
3645
|
+
# Web Services Backup Developer Guide.* ][1]
|
3580
3646
|
#
|
3581
3647
|
# The `awsbackup` type does not apply to Aurora.
|
3582
3648
|
#
|
@@ -3613,17 +3679,17 @@ module Aws::RDS
|
|
3613
3679
|
# * `engine` - Accepts names of database engines.
|
3614
3680
|
# @option options [Boolean] :include_shared
|
3615
3681
|
# A value that indicates whether to include shared manual DB cluster
|
3616
|
-
# snapshots from other
|
3617
|
-
# permission to copy or restore. By
|
3618
|
-
# included.
|
3682
|
+
# snapshots from other Amazon Web Services accounts that this Amazon Web
|
3683
|
+
# Services account has been given permission to copy or restore. By
|
3684
|
+
# default, these snapshots are not included.
|
3619
3685
|
#
|
3620
|
-
# You can give an
|
3621
|
-
# from another
|
3622
|
-
# action.
|
3686
|
+
# You can give an Amazon Web Services account permission to restore a
|
3687
|
+
# manual DB snapshot from another Amazon Web Services account by using
|
3688
|
+
# the `ModifyDBSnapshotAttribute` API action.
|
3623
3689
|
# @option options [Boolean] :include_public
|
3624
3690
|
# A value that indicates whether to include manual DB cluster snapshots
|
3625
|
-
# that are public and can be copied or restored by any
|
3626
|
-
# default, the public snapshots are not included.
|
3691
|
+
# that are public and can be copied or restored by any Amazon Web
|
3692
|
+
# Services account. By default, the public snapshots are not included.
|
3627
3693
|
#
|
3628
3694
|
# You can share a manual DB snapshot as public by using the
|
3629
3695
|
# ModifyDBSnapshotAttribute API.
|