aws-sdk-rds 1.103.0 → 1.108.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 +596 -196
- data/lib/aws-sdk-rds/client_api.rb +76 -5
- data/lib/aws-sdk-rds/db_cluster.rb +68 -43
- data/lib/aws-sdk-rds/db_cluster_snapshot.rb +40 -22
- data/lib/aws-sdk-rds/db_engine_version.rb +0 -6
- data/lib/aws-sdk-rds/db_instance.rb +86 -72
- data/lib/aws-sdk-rds/db_snapshot.rb +36 -18
- data/lib/aws-sdk-rds/plugins/cross_region_copying.rb +11 -12
- data/lib/aws-sdk-rds/resource.rb +49 -66
- data/lib/aws-sdk-rds/types.rb +525 -261
- metadata +2 -2
@@ -136,6 +136,9 @@ module Aws::RDS
|
|
136
136
|
|
137
137
|
# If `StorageEncrypted` is true, the AWS KMS key identifier for the
|
138
138
|
# encrypted DB cluster snapshot.
|
139
|
+
#
|
140
|
+
# The AWS KMS key identifier is the key ARN, key ID, alias ARN, or alias
|
141
|
+
# name for the AWS KMS customer master key (CMK).
|
139
142
|
# @return [String]
|
140
143
|
def kms_key_id
|
141
144
|
data[:kms_key_id]
|
@@ -162,6 +165,17 @@ module Aws::RDS
|
|
162
165
|
data[:iam_database_authentication_enabled]
|
163
166
|
end
|
164
167
|
|
168
|
+
# A list of tags. For more information, see [Tagging Amazon RDS
|
169
|
+
# Resources][1] in the *Amazon RDS User Guide.*
|
170
|
+
#
|
171
|
+
#
|
172
|
+
#
|
173
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html
|
174
|
+
# @return [Array<Types::Tag>]
|
175
|
+
def tag_list
|
176
|
+
data[:tag_list]
|
177
|
+
end
|
178
|
+
|
165
179
|
# @!endgroup
|
166
180
|
|
167
181
|
# @return [Client]
|
@@ -354,25 +368,25 @@ module Aws::RDS
|
|
354
368
|
#
|
355
369
|
# Example: `my-cluster-snapshot2`
|
356
370
|
# @option options [String] :kms_key_id
|
357
|
-
# The AWS KMS key
|
358
|
-
#
|
359
|
-
#
|
371
|
+
# The AWS KMS key identifier for an encrypted DB cluster snapshot. The
|
372
|
+
# AWS KMS key identifier is the key ARN, key ID, alias ARN, or alias
|
373
|
+
# name for the AWS KMS customer master key (CMK).
|
360
374
|
#
|
361
375
|
# If you copy an encrypted DB cluster snapshot from your AWS account,
|
362
376
|
# you can specify a value for `KmsKeyId` to encrypt the copy with a new
|
363
|
-
# KMS
|
364
|
-
#
|
377
|
+
# AWS KMS CMK. If you don't specify a value for `KmsKeyId`, then the
|
378
|
+
# copy of the DB cluster snapshot is encrypted with the same AWS KMS key
|
365
379
|
# as the source DB cluster snapshot.
|
366
380
|
#
|
367
381
|
# If you copy an encrypted DB cluster snapshot that is shared from
|
368
382
|
# another AWS account, then you must specify a value for `KmsKeyId`.
|
369
383
|
#
|
370
384
|
# To copy an encrypted DB cluster snapshot to another AWS Region, you
|
371
|
-
# must set `KmsKeyId` to the KMS key
|
372
|
-
# copy of the DB cluster snapshot in the destination AWS
|
373
|
-
#
|
374
|
-
# in, and you can't use
|
375
|
-
#
|
385
|
+
# must set `KmsKeyId` to the AWS KMS key identifier you want to use to
|
386
|
+
# encrypt the copy of the DB cluster snapshot in the destination AWS
|
387
|
+
# Region. AWS KMS CMKs are specific to the AWS Region that they are
|
388
|
+
# created in, and you can't use CMKs from one AWS Region in another AWS
|
389
|
+
# Region.
|
376
390
|
#
|
377
391
|
# If you copy an unencrypted DB cluster snapshot and specify a value for
|
378
392
|
# the `KmsKeyId` parameter, an error is returned.
|
@@ -390,9 +404,9 @@ module Aws::RDS
|
|
390
404
|
# copied. The pre-signed URL request must contain the following
|
391
405
|
# parameter values:
|
392
406
|
#
|
393
|
-
# * `KmsKeyId` - The AWS KMS key identifier for the
|
394
|
-
# encrypt the copy of the DB cluster snapshot in the
|
395
|
-
# Region. This is the same identifier for both the
|
407
|
+
# * `KmsKeyId` - The AWS KMS key identifier for the customer master key
|
408
|
+
# (CMK) to use to encrypt the copy of the DB cluster snapshot in the
|
409
|
+
# destination AWS Region. This is the same identifier for both the
|
396
410
|
# `CopyDBClusterSnapshot` action that is called in the destination AWS
|
397
411
|
# Region, and the action contained in the pre-signed URL.
|
398
412
|
#
|
@@ -435,7 +449,6 @@ module Aws::RDS
|
|
435
449
|
#
|
436
450
|
#
|
437
451
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html
|
438
|
-
# @option options [String] :destination_region
|
439
452
|
# @option options [String] :source_region
|
440
453
|
# The source region of the snapshot. This is only needed when the
|
441
454
|
# shapshot is encrypted and in a different region.
|
@@ -585,18 +598,17 @@ module Aws::RDS
|
|
585
598
|
# The AWS KMS key identifier to use when restoring an encrypted DB
|
586
599
|
# cluster from a DB snapshot or DB cluster snapshot.
|
587
600
|
#
|
588
|
-
# The KMS key identifier is the
|
589
|
-
#
|
590
|
-
# account
|
591
|
-
# cluster, then you can use the KMS key alias instead of the ARN for the
|
592
|
-
# KMS encryption key.
|
601
|
+
# The AWS KMS key identifier is the key ARN, key ID, alias ARN, or alias
|
602
|
+
# name for the AWS KMS customer master key (CMK). To use a CMK in a
|
603
|
+
# different AWS account, specify the key ARN or alias ARN.
|
593
604
|
#
|
594
|
-
#
|
605
|
+
# When you don't specify a value for the `KmsKeyId` parameter, then the
|
595
606
|
# following occurs:
|
596
607
|
#
|
597
608
|
# * If the DB snapshot or DB cluster snapshot in `SnapshotIdentifier` is
|
598
|
-
# encrypted, then the restored DB cluster is encrypted using the
|
599
|
-
#
|
609
|
+
# encrypted, then the restored DB cluster is encrypted using the AWS
|
610
|
+
# KMS CMK that was used to encrypt the DB snapshot or DB cluster
|
611
|
+
# snapshot.
|
600
612
|
#
|
601
613
|
# * If the DB snapshot or DB cluster snapshot in `SnapshotIdentifier`
|
602
614
|
# isn't encrypted, then the restored DB cluster isn't encrypted.
|
@@ -639,6 +651,12 @@ module Aws::RDS
|
|
639
651
|
# @option options [String] :engine_mode
|
640
652
|
# The DB engine mode of the DB cluster, either `provisioned`,
|
641
653
|
# `serverless`, `parallelquery`, `global`, or `multimaster`.
|
654
|
+
#
|
655
|
+
# For more information, see [ CreateDBCluster][1].
|
656
|
+
#
|
657
|
+
#
|
658
|
+
#
|
659
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBCluster.html
|
642
660
|
# @option options [Types::ScalingConfiguration] :scaling_configuration
|
643
661
|
# For DB clusters in `serverless` DB engine mode, the scaling properties
|
644
662
|
# of the DB cluster.
|
@@ -119,12 +119,6 @@ module Aws::RDS
|
|
119
119
|
end
|
120
120
|
|
121
121
|
# A list of the supported DB engine modes.
|
122
|
-
#
|
123
|
-
# <note markdown="1"> `global` engine mode only applies for global database clusters created
|
124
|
-
# with Aurora MySQL version 5.6.10a. For higher Aurora MySQL versions,
|
125
|
-
# the clusters in a global database use `provisioned` engine mode.
|
126
|
-
#
|
127
|
-
# </note>
|
128
122
|
# @return [Array<String>]
|
129
123
|
def supported_engine_modes
|
130
124
|
data[:supported_engine_modes]
|
@@ -341,6 +341,9 @@ module Aws::RDS
|
|
341
341
|
|
342
342
|
# If `StorageEncrypted` is true, the AWS KMS key identifier for the
|
343
343
|
# encrypted DB instance.
|
344
|
+
#
|
345
|
+
# The AWS KMS key identifier is the key ARN, key ID, alias ARN, or alias
|
346
|
+
# name for the AWS KMS customer master key (CMK).
|
344
347
|
# @return [String]
|
345
348
|
def kms_key_id
|
346
349
|
data[:kms_key_id]
|
@@ -348,7 +351,7 @@ module Aws::RDS
|
|
348
351
|
|
349
352
|
# The AWS Region-unique, immutable identifier for the DB instance. This
|
350
353
|
# identifier is found in AWS CloudTrail log entries whenever the AWS KMS
|
351
|
-
# key for the DB instance is accessed.
|
354
|
+
# customer master key (CMK) for the DB instance is accessed.
|
352
355
|
# @return [String]
|
353
356
|
def dbi_resource_id
|
354
357
|
data[:dbi_resource_id]
|
@@ -454,8 +457,10 @@ module Aws::RDS
|
|
454
457
|
end
|
455
458
|
|
456
459
|
# The AWS KMS key identifier for encryption of Performance Insights
|
457
|
-
# data.
|
458
|
-
#
|
460
|
+
# data.
|
461
|
+
#
|
462
|
+
# The AWS KMS key identifier is the key ARN, key ID, alias ARN, or alias
|
463
|
+
# name for the AWS KMS customer master key (CMK).
|
459
464
|
# @return [String]
|
460
465
|
def performance_insights_kms_key_id
|
461
466
|
data[:performance_insights_kms_key_id]
|
@@ -522,6 +527,24 @@ module Aws::RDS
|
|
522
527
|
data[:max_allocated_storage]
|
523
528
|
end
|
524
529
|
|
530
|
+
# A list of tags. For more information, see [Tagging Amazon RDS
|
531
|
+
# Resources][1] in the *Amazon RDS User Guide.*
|
532
|
+
#
|
533
|
+
#
|
534
|
+
#
|
535
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html
|
536
|
+
# @return [Array<Types::Tag>]
|
537
|
+
def tag_list
|
538
|
+
data[:tag_list]
|
539
|
+
end
|
540
|
+
|
541
|
+
# The list of replicated automated backups associated with the DB
|
542
|
+
# instance.
|
543
|
+
# @return [Array<Types::DBInstanceAutomatedBackupsReplication>]
|
544
|
+
def db_instance_automated_backups_replications
|
545
|
+
data[:db_instance_automated_backups_replications]
|
546
|
+
end
|
547
|
+
|
525
548
|
# @!endgroup
|
526
549
|
|
527
550
|
# @return [Client]
|
@@ -754,8 +777,8 @@ module Aws::RDS
|
|
754
777
|
# **PostgreSQL**
|
755
778
|
#
|
756
779
|
# The name of the database to create when the DB instance is created. If
|
757
|
-
# this parameter isn't specified,
|
758
|
-
#
|
780
|
+
# this parameter isn't specified, no database is created in the DB
|
781
|
+
# instance.
|
759
782
|
#
|
760
783
|
# Constraints:
|
761
784
|
#
|
@@ -1344,22 +1367,19 @@ module Aws::RDS
|
|
1344
1367
|
# @option options [String] :kms_key_id
|
1345
1368
|
# The AWS KMS key identifier for an encrypted DB instance.
|
1346
1369
|
#
|
1347
|
-
# The KMS key identifier is the
|
1348
|
-
#
|
1349
|
-
# account
|
1350
|
-
# instance, then you can use the KMS key alias instead of the ARN for
|
1351
|
-
# the KM encryption key.
|
1370
|
+
# The AWS KMS key identifier is the key ARN, key ID, alias ARN, or alias
|
1371
|
+
# name for the AWS KMS customer master key (CMK). To use a CMK in a
|
1372
|
+
# different AWS account, specify the key ARN or alias ARN.
|
1352
1373
|
#
|
1353
1374
|
# **Amazon Aurora**
|
1354
1375
|
#
|
1355
|
-
# Not applicable. The KMS key identifier is managed by the DB
|
1356
|
-
# For more information, see `CreateDBCluster`.
|
1376
|
+
# Not applicable. The AWS KMS key identifier is managed by the DB
|
1377
|
+
# cluster. For more information, see `CreateDBCluster`.
|
1357
1378
|
#
|
1358
1379
|
# If `StorageEncrypted` is enabled, and you do not specify a value for
|
1359
|
-
# the `KmsKeyId` parameter, then Amazon RDS
|
1360
|
-
#
|
1361
|
-
#
|
1362
|
-
# for each AWS Region.
|
1380
|
+
# the `KmsKeyId` parameter, then Amazon RDS uses your default CMK. There
|
1381
|
+
# is a default CMK for your AWS account. Your AWS account has a
|
1382
|
+
# different default CMK for each AWS Region.
|
1363
1383
|
# @option options [String] :domain
|
1364
1384
|
# The Active Directory directory ID to create the DB instance in.
|
1365
1385
|
# Currently, only MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB
|
@@ -1430,29 +1450,8 @@ module Aws::RDS
|
|
1430
1450
|
# Access Management (IAM) accounts to database accounts. By default,
|
1431
1451
|
# mapping is disabled.
|
1432
1452
|
#
|
1433
|
-
#
|
1434
|
-
#
|
1435
|
-
#
|
1436
|
-
# **Amazon Aurora**
|
1437
|
-
#
|
1438
|
-
# Not applicable. Mapping AWS IAM accounts to database accounts is
|
1439
|
-
# managed by the DB cluster.
|
1440
|
-
#
|
1441
|
-
# **MySQL**
|
1442
|
-
#
|
1443
|
-
# * For MySQL 5.6, minor version 5.6.34 or higher
|
1444
|
-
#
|
1445
|
-
# * For MySQL 5.7, minor version 5.7.16 or higher
|
1446
|
-
#
|
1447
|
-
# * For MySQL 8.0, minor version 8.0.16 or higher
|
1448
|
-
#
|
1449
|
-
# **PostgreSQL**
|
1450
|
-
#
|
1451
|
-
# * For PostgreSQL 9.5, minor version 9.5.15 or higher
|
1452
|
-
#
|
1453
|
-
# * For PostgreSQL 9.6, minor version 9.6.11 or higher
|
1454
|
-
#
|
1455
|
-
# * PostgreSQL 10.6, 10.7, and 10.9
|
1453
|
+
# This setting doesn't apply to Amazon Aurora. Mapping AWS IAM accounts
|
1454
|
+
# to database accounts is managed by the DB cluster.
|
1456
1455
|
#
|
1457
1456
|
# For more information, see [ IAM Database Authentication for MySQL and
|
1458
1457
|
# PostgreSQL][1] in the *Amazon RDS User Guide.*
|
@@ -1472,13 +1471,15 @@ module Aws::RDS
|
|
1472
1471
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.html
|
1473
1472
|
# @option options [String] :performance_insights_kms_key_id
|
1474
1473
|
# The AWS KMS key identifier for encryption of Performance Insights
|
1475
|
-
# data.
|
1476
|
-
#
|
1474
|
+
# data.
|
1475
|
+
#
|
1476
|
+
# The AWS KMS key identifier is the key ARN, key ID, alias ARN, or alias
|
1477
|
+
# name for the AWS KMS customer master key (CMK).
|
1477
1478
|
#
|
1478
1479
|
# If you do not specify a value for `PerformanceInsightsKMSKeyId`, then
|
1479
|
-
# Amazon RDS uses your default
|
1480
|
-
#
|
1481
|
-
#
|
1480
|
+
# Amazon RDS uses your default CMK. There is a default CMK for your AWS
|
1481
|
+
# account. Your AWS account has a different default CMK for each AWS
|
1482
|
+
# Region.
|
1482
1483
|
# @option options [Integer] :performance_insights_retention_period
|
1483
1484
|
# The amount of time, in days, to retain Performance Insights data.
|
1484
1485
|
# Valid values are 7 or 731 (2 years).
|
@@ -1592,6 +1593,7 @@ module Aws::RDS
|
|
1592
1593
|
# domain: "String",
|
1593
1594
|
# domain_iam_role_name: "String",
|
1594
1595
|
# replica_mode: "open-read-only", # accepts open-read-only, mounted
|
1596
|
+
# max_allocated_storage: 1,
|
1595
1597
|
# source_region: "String",
|
1596
1598
|
# })
|
1597
1599
|
# @param [Hash] options ({})
|
@@ -1756,20 +1758,21 @@ module Aws::RDS
|
|
1756
1758
|
#
|
1757
1759
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Monitoring.html#USER_Monitoring.OS.IAMRole
|
1758
1760
|
# @option options [String] :kms_key_id
|
1759
|
-
# The AWS KMS key
|
1760
|
-
#
|
1761
|
-
#
|
1761
|
+
# The AWS KMS key identifier for an encrypted read replica.
|
1762
|
+
#
|
1763
|
+
# The AWS KMS key identifier is the key ARN, key ID, alias ARN, or alias
|
1764
|
+
# name for the AWS KMS CMK.
|
1762
1765
|
#
|
1763
1766
|
# If you create an encrypted read replica in the same AWS Region as the
|
1764
|
-
# source DB instance, then
|
1765
|
-
#
|
1766
|
-
# source DB instance.
|
1767
|
+
# source DB instance, then do not specify a value for this parameter. A
|
1768
|
+
# read replica in the same Region is always encrypted with the same AWS
|
1769
|
+
# KMS CMK as the source DB instance.
|
1767
1770
|
#
|
1768
1771
|
# If you create an encrypted read replica in a different AWS Region,
|
1769
|
-
# then you must specify a KMS key for the destination AWS
|
1770
|
-
#
|
1771
|
-
# in, and you can't use
|
1772
|
-
#
|
1772
|
+
# then you must specify a AWS KMS key identifier for the destination AWS
|
1773
|
+
# Region. AWS KMS CMKs are specific to the AWS Region that they are
|
1774
|
+
# created in, and you can't use CMKs from one AWS Region in another AWS
|
1775
|
+
# Region.
|
1773
1776
|
#
|
1774
1777
|
# You can't create an encrypted read replica from an unencrypted DB
|
1775
1778
|
# instance.
|
@@ -1837,8 +1840,7 @@ module Aws::RDS
|
|
1837
1840
|
# @option options [Boolean] :enable_iam_database_authentication
|
1838
1841
|
# A value that indicates whether to enable mapping of AWS Identity and
|
1839
1842
|
# Access Management (IAM) accounts to database accounts. By default,
|
1840
|
-
# mapping is disabled.
|
1841
|
-
# see CreateDBInstance.
|
1843
|
+
# mapping is disabled.
|
1842
1844
|
#
|
1843
1845
|
# For more information about IAM database authentication, see [ IAM
|
1844
1846
|
# Database Authentication for MySQL and PostgreSQL][1] in the *Amazon
|
@@ -1859,13 +1861,15 @@ module Aws::RDS
|
|
1859
1861
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.html
|
1860
1862
|
# @option options [String] :performance_insights_kms_key_id
|
1861
1863
|
# The AWS KMS key identifier for encryption of Performance Insights
|
1862
|
-
# data.
|
1863
|
-
#
|
1864
|
+
# data.
|
1865
|
+
#
|
1866
|
+
# The AWS KMS key identifier is the key ARN, key ID, alias ARN, or alias
|
1867
|
+
# name for the AWS KMS customer master key (CMK).
|
1864
1868
|
#
|
1865
1869
|
# If you do not specify a value for `PerformanceInsightsKMSKeyId`, then
|
1866
|
-
# Amazon RDS uses your default
|
1867
|
-
#
|
1868
|
-
#
|
1870
|
+
# Amazon RDS uses your default CMK. There is a default CMK for your AWS
|
1871
|
+
# account. Your AWS account has a different default CMK for each AWS
|
1872
|
+
# Region.
|
1869
1873
|
# @option options [Integer] :performance_insights_retention_period
|
1870
1874
|
# The amount of time, in days, to retain Performance Insights data.
|
1871
1875
|
# Valid values are 7 or 731 (2 years).
|
@@ -1928,7 +1932,9 @@ module Aws::RDS
|
|
1928
1932
|
#
|
1929
1933
|
#
|
1930
1934
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/oracle-read-replicas.html
|
1931
|
-
# @option options [
|
1935
|
+
# @option options [Integer] :max_allocated_storage
|
1936
|
+
# The upper limit to which Amazon RDS can automatically scale the
|
1937
|
+
# storage of the DB instance.
|
1932
1938
|
# @option options [String] :source_region
|
1933
1939
|
# The source region of the snapshot. This is only needed when the
|
1934
1940
|
# shapshot is encrypted and in a different region.
|
@@ -2325,7 +2331,7 @@ module Aws::RDS
|
|
2325
2331
|
# The version number of the database engine to upgrade to. Changing this
|
2326
2332
|
# parameter results in an outage and the change is applied during the
|
2327
2333
|
# next maintenance window unless the `ApplyImmediately` parameter is
|
2328
|
-
#
|
2334
|
+
# enabled for this request.
|
2329
2335
|
#
|
2330
2336
|
# For major version upgrades, if a nondefault DB parameter group is
|
2331
2337
|
# currently in use, a new DB parameter group in the DB parameter group
|
@@ -2580,8 +2586,10 @@ module Aws::RDS
|
|
2580
2586
|
# @option options [Boolean] :enable_iam_database_authentication
|
2581
2587
|
# A value that indicates whether to enable mapping of AWS Identity and
|
2582
2588
|
# Access Management (IAM) accounts to database accounts. By default,
|
2583
|
-
# mapping is disabled.
|
2584
|
-
#
|
2589
|
+
# mapping is disabled.
|
2590
|
+
#
|
2591
|
+
# This setting doesn't apply to Amazon Aurora. Mapping AWS IAM accounts
|
2592
|
+
# to database accounts is managed by the DB cluster.
|
2585
2593
|
#
|
2586
2594
|
# For more information about IAM database authentication, see [ IAM
|
2587
2595
|
# Database Authentication for MySQL and PostgreSQL][1] in the *Amazon
|
@@ -2602,13 +2610,15 @@ module Aws::RDS
|
|
2602
2610
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.html
|
2603
2611
|
# @option options [String] :performance_insights_kms_key_id
|
2604
2612
|
# The AWS KMS key identifier for encryption of Performance Insights
|
2605
|
-
# data.
|
2606
|
-
#
|
2613
|
+
# data.
|
2614
|
+
#
|
2615
|
+
# The AWS KMS key identifier is the key ARN, key ID, alias ARN, or alias
|
2616
|
+
# name for the AWS KMS customer master key (CMK).
|
2607
2617
|
#
|
2608
2618
|
# If you do not specify a value for `PerformanceInsightsKMSKeyId`, then
|
2609
|
-
# Amazon RDS uses your default
|
2610
|
-
#
|
2611
|
-
#
|
2619
|
+
# Amazon RDS uses your default CMK. There is a default CMK for your AWS
|
2620
|
+
# account. Your AWS account has a different default CMK for each AWS
|
2621
|
+
# Region.
|
2612
2622
|
# @option options [Integer] :performance_insights_retention_period
|
2613
2623
|
# The amount of time, in days, to retain Performance Insights data.
|
2614
2624
|
# Valid values are 7 or 731 (2 years).
|
@@ -2814,6 +2824,7 @@ module Aws::RDS
|
|
2814
2824
|
# deletion_protection: false,
|
2815
2825
|
# source_dbi_resource_id: "String",
|
2816
2826
|
# max_allocated_storage: 1,
|
2827
|
+
# source_db_instance_automated_backups_arn: "String",
|
2817
2828
|
# })
|
2818
2829
|
# @param [Hash] options ({})
|
2819
2830
|
# @option options [required, String] :target_db_instance_identifier
|
@@ -3013,8 +3024,7 @@ module Aws::RDS
|
|
3013
3024
|
# @option options [Boolean] :enable_iam_database_authentication
|
3014
3025
|
# A value that indicates whether to enable mapping of AWS Identity and
|
3015
3026
|
# Access Management (IAM) accounts to database accounts. By default,
|
3016
|
-
# mapping is disabled.
|
3017
|
-
# see CreateDBInstance.
|
3027
|
+
# mapping is disabled.
|
3018
3028
|
#
|
3019
3029
|
# For more information about IAM database authentication, see [ IAM
|
3020
3030
|
# Database Authentication for MySQL and PostgreSQL][1] in the *Amazon
|
@@ -3067,6 +3077,10 @@ module Aws::RDS
|
|
3067
3077
|
# @option options [Integer] :max_allocated_storage
|
3068
3078
|
# The upper limit to which Amazon RDS can automatically scale the
|
3069
3079
|
# storage of the DB instance.
|
3080
|
+
# @option options [String] :source_db_instance_automated_backups_arn
|
3081
|
+
# The Amazon Resource Name (ARN) of the replicated automated backups
|
3082
|
+
# from which to restore, for example,
|
3083
|
+
# `arn:aws:rds:useast-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE`.
|
3070
3084
|
# @return [DBInstance]
|
3071
3085
|
def restore(options = {})
|
3072
3086
|
options = options.merge(source_db_instance_identifier: @id)
|
@@ -44,7 +44,7 @@ module Aws::RDS
|
|
44
44
|
end
|
45
45
|
alias :db_snapshot_identifier :snapshot_id
|
46
46
|
|
47
|
-
# Specifies when the snapshot was taken in
|
47
|
+
# Specifies when the snapshot was taken in Coordinated Universal Time
|
48
48
|
# (UTC).
|
49
49
|
# @return [Time]
|
50
50
|
def snapshot_create_time
|
@@ -174,6 +174,9 @@ module Aws::RDS
|
|
174
174
|
|
175
175
|
# If `Encrypted` is true, the AWS KMS key identifier for the encrypted
|
176
176
|
# DB snapshot.
|
177
|
+
#
|
178
|
+
# The AWS KMS key identifier is the key ARN, key ID, alias ARN, or alias
|
179
|
+
# name for the AWS KMS customer master key (CMK).
|
177
180
|
# @return [String]
|
178
181
|
def kms_key_id
|
179
182
|
data[:kms_key_id]
|
@@ -215,6 +218,17 @@ module Aws::RDS
|
|
215
218
|
data[:dbi_resource_id]
|
216
219
|
end
|
217
220
|
|
221
|
+
# A list of tags. For more information, see [Tagging Amazon RDS
|
222
|
+
# Resources][1] in the *Amazon RDS User Guide.*
|
223
|
+
#
|
224
|
+
#
|
225
|
+
#
|
226
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html
|
227
|
+
# @return [Array<Types::Tag>]
|
228
|
+
def tag_list
|
229
|
+
data[:tag_list]
|
230
|
+
end
|
231
|
+
|
218
232
|
# @!endgroup
|
219
233
|
|
220
234
|
# @return [Client]
|
@@ -396,6 +410,7 @@ module Aws::RDS
|
|
396
410
|
# copy_tags: false,
|
397
411
|
# pre_signed_url: "String",
|
398
412
|
# option_group_name: "String",
|
413
|
+
# target_custom_availability_zone: "String",
|
399
414
|
# source_region: "String",
|
400
415
|
# })
|
401
416
|
# @param [Hash] options ({})
|
@@ -414,14 +429,14 @@ module Aws::RDS
|
|
414
429
|
#
|
415
430
|
# Example: `my-db-snapshot`
|
416
431
|
# @option options [String] :kms_key_id
|
417
|
-
# The AWS KMS key
|
418
|
-
#
|
419
|
-
#
|
432
|
+
# The AWS KMS key identifier for an encrypted DB snapshot. The AWS KMS
|
433
|
+
# key identifier is the key ARN, key ID, alias ARN, or alias name for
|
434
|
+
# the AWS KMS customer master key (CMK).
|
420
435
|
#
|
421
436
|
# If you copy an encrypted DB snapshot from your AWS account, you can
|
422
|
-
# specify a value for this parameter to encrypt the copy with a new
|
423
|
-
#
|
424
|
-
#
|
437
|
+
# specify a value for this parameter to encrypt the copy with a new AWS
|
438
|
+
# KMS CMK. If you don't specify a value for this parameter, then the
|
439
|
+
# copy of the DB snapshot is encrypted with the same AWS KMS key as the
|
425
440
|
# source DB snapshot.
|
426
441
|
#
|
427
442
|
# If you copy an encrypted DB snapshot that is shared from another AWS
|
@@ -431,9 +446,9 @@ module Aws::RDS
|
|
431
446
|
# the copy is encrypted.
|
432
447
|
#
|
433
448
|
# If you copy an encrypted snapshot to a different AWS Region, then you
|
434
|
-
# must specify a KMS key for the destination AWS Region.
|
435
|
-
#
|
436
|
-
# can't use
|
449
|
+
# must specify a AWS KMS key identifier for the destination AWS Region.
|
450
|
+
# AWS KMS CMKs are specific to the AWS Region that they are created in,
|
451
|
+
# and you can't use CMKs from one AWS Region in another AWS Region.
|
437
452
|
# @option options [Array<Types::Tag>] :tags
|
438
453
|
# A list of tags. For more information, see [Tagging Amazon RDS
|
439
454
|
# Resources][1] in the *Amazon RDS User Guide.*
|
@@ -470,11 +485,11 @@ module Aws::RDS
|
|
470
485
|
# the us-west-2 AWS Region. For this example, the `DestinationRegion`
|
471
486
|
# in the presigned URL must be set to the us-east-1 AWS Region.
|
472
487
|
#
|
473
|
-
# * `KmsKeyId` - The AWS KMS key identifier for the
|
474
|
-
# encrypt the copy of the DB snapshot in the
|
475
|
-
# This is the same identifier for both the
|
476
|
-
# that is called in the destination AWS
|
477
|
-
# contained in the presigned URL.
|
488
|
+
# * `KmsKeyId` - The AWS KMS key identifier for the customer master key
|
489
|
+
# (CMK) to use to encrypt the copy of the DB snapshot in the
|
490
|
+
# destination AWS Region. This is the same identifier for both the
|
491
|
+
# `CopyDBSnapshot` action that is called in the destination AWS
|
492
|
+
# Region, and the action contained in the presigned URL.
|
478
493
|
#
|
479
494
|
# * `SourceDBSnapshotIdentifier` - The DB snapshot identifier for the
|
480
495
|
# encrypted snapshot to be copied. This identifier must be in the
|
@@ -514,7 +529,11 @@ module Aws::RDS
|
|
514
529
|
#
|
515
530
|
#
|
516
531
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_CopySnapshot.html#USER_CopySnapshot.Options
|
517
|
-
# @option options [String] :
|
532
|
+
# @option options [String] :target_custom_availability_zone
|
533
|
+
# The external custom Availability Zone (CAZ) identifier for the target
|
534
|
+
# CAZ.
|
535
|
+
#
|
536
|
+
# Example: `rds-caz-aiqhTgQv`.
|
518
537
|
# @option options [String] :source_region
|
519
538
|
# The source region of the snapshot. This is only needed when the
|
520
539
|
# shapshot is encrypted and in a different region.
|
@@ -778,8 +797,7 @@ module Aws::RDS
|
|
778
797
|
# @option options [Boolean] :enable_iam_database_authentication
|
779
798
|
# A value that indicates whether to enable mapping of AWS Identity and
|
780
799
|
# Access Management (IAM) accounts to database accounts. By default,
|
781
|
-
# mapping is disabled.
|
782
|
-
# see CreateDBInstance.
|
800
|
+
# mapping is disabled.
|
783
801
|
#
|
784
802
|
# For more information about IAM database authentication, see [ IAM
|
785
803
|
# Database Authentication for MySQL and PostgreSQL][1] in the *Amazon
|