aws-sdk-rds 1.147.0 → 1.148.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/CHANGELOG.md +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-rds/client.rb +242 -405
- data/lib/aws-sdk-rds/db_cluster.rb +37 -96
- data/lib/aws-sdk-rds/db_cluster_snapshot.rb +22 -25
- data/lib/aws-sdk-rds/db_instance.rb +45 -173
- data/lib/aws-sdk-rds/db_snapshot.rb +23 -29
- data/lib/aws-sdk-rds/resource.rb +43 -134
- data/lib/aws-sdk-rds/types.rb +157 -395
- data/lib/aws-sdk-rds/waiters.rb +137 -0
- data/lib/aws-sdk-rds.rb +1 -1
- metadata +2 -2
data/lib/aws-sdk-rds/resource.rb
CHANGED
@@ -390,25 +390,25 @@ module Aws::RDS
|
|
390
390
|
#
|
391
391
|
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
392
392
|
# @option options [String] :pre_signed_url
|
393
|
-
#
|
394
|
-
#
|
395
|
-
#
|
396
|
-
#
|
397
|
-
#
|
398
|
-
#
|
399
|
-
#
|
400
|
-
#
|
401
|
-
#
|
402
|
-
#
|
403
|
-
#
|
404
|
-
#
|
405
|
-
#
|
406
|
-
# * `KmsKeyId` - The KMS key identifier for the KMS
|
407
|
-
# encrypt the copy of the DB cluster in the destination
|
408
|
-
# Services Region. This should refer to the same KMS key
|
409
|
-
# `CreateDBCluster`
|
410
|
-
# Web Services Region, and the
|
411
|
-
# URL.
|
393
|
+
# A URL that contains a Signature Version 4 signed request for the
|
394
|
+
# `CreateDBCluster` action to be called in the source Amazon Web
|
395
|
+
# Services Region where the DB cluster is replicated from. Specify
|
396
|
+
# `PreSignedUrl` only when you are performing cross-Region replication
|
397
|
+
# from an encrypted DB cluster.
|
398
|
+
#
|
399
|
+
# The pre-signed URL must be a valid request for the `CreateDBCluster`
|
400
|
+
# API action that can be executed in the source Amazon Web Services
|
401
|
+
# Region that contains the encrypted DB cluster to be copied.
|
402
|
+
#
|
403
|
+
# The pre-signed URL request must contain the following parameter
|
404
|
+
# values:
|
405
|
+
#
|
406
|
+
# * `KmsKeyId` - The Amazon Web Services KMS key identifier for the KMS
|
407
|
+
# key to use to encrypt the copy of the DB cluster in the destination
|
408
|
+
# Amazon Web Services Region. This should refer to the same KMS key
|
409
|
+
# for both the `CreateDBCluster` action that is called in the
|
410
|
+
# destination Amazon Web Services Region, and the action contained in
|
411
|
+
# the pre-signed URL.
|
412
412
|
#
|
413
413
|
# * `DestinationRegion` - The name of the Amazon Web Services Region
|
414
414
|
# that Aurora read replica will be created in.
|
@@ -429,8 +429,9 @@ module Aws::RDS
|
|
429
429
|
# <note markdown="1"> If you are using an Amazon Web Services SDK tool or the CLI, you can
|
430
430
|
# specify `SourceRegion` (or `--source-region` for the CLI) instead of
|
431
431
|
# specifying `PreSignedUrl` manually. Specifying `SourceRegion`
|
432
|
-
# autogenerates a
|
433
|
-
# operation that can
|
432
|
+
# autogenerates a pre-signed URL that is a valid request for the
|
433
|
+
# operation that can be executed in the source Amazon Web Services
|
434
|
+
# Region.
|
434
435
|
#
|
435
436
|
# </note>
|
436
437
|
#
|
@@ -446,7 +447,7 @@ module Aws::RDS
|
|
446
447
|
# accounts. By default, mapping isn't enabled.
|
447
448
|
#
|
448
449
|
# For more information, see [ IAM Database Authentication][1] in the
|
449
|
-
# *Amazon Aurora User Guide
|
450
|
+
# *Amazon Aurora User Guide.*.
|
450
451
|
#
|
451
452
|
# Valid for: Aurora DB clusters only
|
452
453
|
#
|
@@ -517,9 +518,6 @@ module Aws::RDS
|
|
517
518
|
# The `multimaster` engine mode only applies for DB clusters created
|
518
519
|
# with Aurora MySQL version 5.6.10a.
|
519
520
|
#
|
520
|
-
# The `serverless` engine mode only applies for Aurora Serverless v1 DB
|
521
|
-
# clusters.
|
522
|
-
#
|
523
521
|
# For Aurora PostgreSQL, the `global` engine mode isn't required, and
|
524
522
|
# both the `parallelquery` and the `multimaster` engine modes currently
|
525
523
|
# aren't supported.
|
@@ -528,25 +526,22 @@ module Aws::RDS
|
|
528
526
|
# information, see the following sections in the *Amazon Aurora User
|
529
527
|
# Guide*\:
|
530
528
|
#
|
531
|
-
# * [Limitations of Aurora Serverless v1][1]
|
532
|
-
#
|
533
|
-
# * [Requirements for Aurora Serverless v2][2]
|
529
|
+
# * [ Limitations of Aurora Serverless v1][1]
|
534
530
|
#
|
535
|
-
# * [Limitations of Parallel Query][
|
531
|
+
# * [ Limitations of Parallel Query][2]
|
536
532
|
#
|
537
|
-
# * [Limitations of Aurora Global Databases][
|
533
|
+
# * [ Limitations of Aurora Global Databases][3]
|
538
534
|
#
|
539
|
-
# * [Limitations of Multi-Master Clusters][
|
535
|
+
# * [ Limitations of Multi-Master Clusters][4]
|
540
536
|
#
|
541
537
|
# Valid for: Aurora DB clusters only
|
542
538
|
#
|
543
539
|
#
|
544
540
|
#
|
545
541
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless.html#aurora-serverless.limitations
|
546
|
-
# [2]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-
|
547
|
-
# [3]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-
|
548
|
-
# [4]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-
|
549
|
-
# [5]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-multi-master.html#aurora-multi-master-limitations
|
542
|
+
# [2]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-mysql-parallel-query.html#aurora-mysql-parallel-query-limitations
|
543
|
+
# [3]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-global-database.html#aurora-global-database.limitations
|
544
|
+
# [4]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-multi-master.html#aurora-multi-master-limitations
|
550
545
|
# @option options [Types::ScalingConfiguration] :scaling_configuration
|
551
546
|
# For DB clusters in `serverless` DB engine mode, the scaling properties
|
552
547
|
# of the DB cluster.
|
@@ -769,27 +764,8 @@ module Aws::RDS
|
|
769
764
|
#
|
770
765
|
# Valid for: Multi-AZ DB clusters only
|
771
766
|
# @option options [Integer] :performance_insights_retention_period
|
772
|
-
# The
|
773
|
-
#
|
774
|
-
#
|
775
|
-
# * 7
|
776
|
-
#
|
777
|
-
# * *month* * 31, where *month* is a number of months from 1-23
|
778
|
-
#
|
779
|
-
# * 731
|
780
|
-
#
|
781
|
-
# For example, the following values are valid:
|
782
|
-
#
|
783
|
-
# * 93 (3 months * 31)
|
784
|
-
#
|
785
|
-
# * 341 (11 months * 31)
|
786
|
-
#
|
787
|
-
# * 589 (19 months * 31)
|
788
|
-
#
|
789
|
-
# * 731
|
790
|
-
#
|
791
|
-
# If you specify a retention period such as 94, which isn't a valid
|
792
|
-
# value, RDS issues an error.
|
767
|
+
# The amount of time, in days, to retain Performance Insights data.
|
768
|
+
# Valid values are 7 or 731 (2 years).
|
793
769
|
#
|
794
770
|
# Valid for: Multi-AZ DB clusters only
|
795
771
|
# @option options [Types::ServerlessV2ScalingConfiguration] :serverless_v2_scaling_configuration
|
@@ -1203,16 +1179,14 @@ module Aws::RDS
|
|
1203
1179
|
# * Web and Express editions: Must be an integer from 20 to 1024.
|
1204
1180
|
# @option options [required, String] :db_instance_class
|
1205
1181
|
# The compute and memory capacity of the DB instance, for example
|
1206
|
-
# db.
|
1182
|
+
# db.m4.large. Not all DB instance classes are available in all Amazon
|
1207
1183
|
# Web Services Regions, or for all database engines. For the full list
|
1208
1184
|
# of DB instance classes, and availability for your engine, see [DB
|
1209
|
-
#
|
1210
|
-
# instance classes][2] in the *Amazon Aurora User Guide*.
|
1185
|
+
# Instance Class][1] in the *Amazon RDS User Guide*.
|
1211
1186
|
#
|
1212
1187
|
#
|
1213
1188
|
#
|
1214
1189
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html
|
1215
|
-
# [2]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Concepts.DBInstanceClass.html
|
1216
1190
|
# @option options [required, String] :engine
|
1217
1191
|
# The name of the database engine to be used for this instance.
|
1218
1192
|
#
|
@@ -1307,9 +1281,7 @@ module Aws::RDS
|
|
1307
1281
|
# @option options [Array<String>] :db_security_groups
|
1308
1282
|
# A list of DB security groups to associate with this DB instance.
|
1309
1283
|
#
|
1310
|
-
#
|
1311
|
-
# longer used to create new DB instances. Use the `VpcSecurityGroupIds`
|
1312
|
-
# setting instead.
|
1284
|
+
# Default: The default DB security group for the database engine.
|
1313
1285
|
# @option options [Array<String>] :vpc_security_group_ids
|
1314
1286
|
# A list of Amazon EC2 VPC security groups to associate with this DB
|
1315
1287
|
# instance.
|
@@ -1403,7 +1375,7 @@ module Aws::RDS
|
|
1403
1375
|
#
|
1404
1376
|
# * Can't be set to 0 if the DB instance is a source to read replicas
|
1405
1377
|
#
|
1406
|
-
# * Can't be set to 0 for an RDS Custom for Oracle DB instance
|
1378
|
+
# * Can't be set to 0 or 35 for an RDS Custom for Oracle DB instance
|
1407
1379
|
# @option options [String] :preferred_backup_window
|
1408
1380
|
# The daily time range during which automated backups are created if
|
1409
1381
|
# automated backups are enabled, using the `BackupRetentionPeriod`
|
@@ -1482,16 +1454,11 @@ module Aws::RDS
|
|
1482
1454
|
# instance is a Multi-AZ deployment.
|
1483
1455
|
#
|
1484
1456
|
# This setting doesn't apply to RDS Custom.
|
1485
|
-
#
|
1486
|
-
# **Amazon Aurora**
|
1487
|
-
#
|
1488
|
-
# Not applicable. DB instance Availability Zones (AZs) are managed by
|
1489
|
-
# the DB cluster.
|
1490
1457
|
# @option options [String] :engine_version
|
1491
1458
|
# The version number of the database engine to use.
|
1492
1459
|
#
|
1493
1460
|
# For a list of valid engine versions, use the
|
1494
|
-
# `DescribeDBEngineVersions`
|
1461
|
+
# `DescribeDBEngineVersions` action.
|
1495
1462
|
#
|
1496
1463
|
# The following are the database engines and links to information about
|
1497
1464
|
# the major and minor versions that are available with Amazon RDS. Not
|
@@ -1564,10 +1531,6 @@ module Aws::RDS
|
|
1564
1531
|
# `general-public-license`
|
1565
1532
|
#
|
1566
1533
|
# This setting doesn't apply to RDS Custom.
|
1567
|
-
#
|
1568
|
-
# **Amazon Aurora**
|
1569
|
-
#
|
1570
|
-
# Not applicable.
|
1571
1534
|
# @option options [Integer] :iops
|
1572
1535
|
# The amount of Provisioned IOPS (input/output operations per second) to
|
1573
1536
|
# be initially allocated for the DB instance. For information about
|
@@ -1579,10 +1542,6 @@ module Aws::RDS
|
|
1579
1542
|
# instance. For SQL Server DB instances, must be a multiple between 1
|
1580
1543
|
# and 50 of the storage amount for the DB instance.
|
1581
1544
|
#
|
1582
|
-
# **Amazon Aurora**
|
1583
|
-
#
|
1584
|
-
# Not applicable. Storage is managed by the DB cluster.
|
1585
|
-
#
|
1586
1545
|
#
|
1587
1546
|
#
|
1588
1547
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Storage.html#USER_PIOPS
|
@@ -1596,10 +1555,6 @@ module Aws::RDS
|
|
1596
1555
|
# instance.
|
1597
1556
|
#
|
1598
1557
|
# This setting doesn't apply to RDS Custom.
|
1599
|
-
#
|
1600
|
-
# **Amazon Aurora**
|
1601
|
-
#
|
1602
|
-
# Not applicable.
|
1603
1558
|
# @option options [String] :character_set_name
|
1604
1559
|
# For supported engines, this value indicates that the DB instance
|
1605
1560
|
# should be associated with the specified `CharacterSet`.
|
@@ -1664,19 +1619,11 @@ module Aws::RDS
|
|
1664
1619
|
# parameter.
|
1665
1620
|
#
|
1666
1621
|
# Default: `io1` if the `Iops` parameter is specified, otherwise `gp2`
|
1667
|
-
#
|
1668
|
-
# **Amazon Aurora**
|
1669
|
-
#
|
1670
|
-
# Not applicable. Storage is managed by the DB cluster.
|
1671
1622
|
# @option options [String] :tde_credential_arn
|
1672
1623
|
# The ARN from the key store with which to associate the instance for
|
1673
1624
|
# TDE encryption.
|
1674
1625
|
#
|
1675
1626
|
# This setting doesn't apply to RDS Custom.
|
1676
|
-
#
|
1677
|
-
# **Amazon Aurora**
|
1678
|
-
#
|
1679
|
-
# Not applicable.
|
1680
1627
|
# @option options [String] :tde_credential_password
|
1681
1628
|
# The password for the given ARN from the key store in order to access
|
1682
1629
|
# the device.
|
@@ -1730,10 +1677,6 @@ module Aws::RDS
|
|
1730
1677
|
#
|
1731
1678
|
# This setting doesn't apply to RDS Custom.
|
1732
1679
|
#
|
1733
|
-
# **Amazon Aurora**
|
1734
|
-
#
|
1735
|
-
# Not applicable. The domain is managed by the DB cluster.
|
1736
|
-
#
|
1737
1680
|
#
|
1738
1681
|
#
|
1739
1682
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/kerberos-authentication.html
|
@@ -1777,10 +1720,6 @@ module Aws::RDS
|
|
1777
1720
|
# the Directory Service.
|
1778
1721
|
#
|
1779
1722
|
# This setting doesn't apply to RDS Custom.
|
1780
|
-
#
|
1781
|
-
# **Amazon Aurora**
|
1782
|
-
#
|
1783
|
-
# Not applicable. The domain is managed by the DB cluster.
|
1784
1723
|
# @option options [Integer] :promotion_tier
|
1785
1724
|
# A value that specifies the order in which an Aurora Replica is
|
1786
1725
|
# promoted to the primary instance after a failure of the existing
|
@@ -1808,16 +1747,13 @@ module Aws::RDS
|
|
1808
1747
|
# Services Identity and Access Management (IAM) accounts to database
|
1809
1748
|
# accounts. By default, mapping isn't enabled.
|
1810
1749
|
#
|
1750
|
+
# This setting doesn't apply to RDS Custom or Amazon Aurora. In Aurora,
|
1751
|
+
# mapping Amazon Web Services IAM accounts to database accounts is
|
1752
|
+
# managed by the DB cluster.
|
1753
|
+
#
|
1811
1754
|
# For more information, see [ IAM Database Authentication for MySQL and
|
1812
1755
|
# PostgreSQL][1] in the *Amazon RDS User Guide*.
|
1813
1756
|
#
|
1814
|
-
# This setting doesn't apply to RDS Custom.
|
1815
|
-
#
|
1816
|
-
# **Amazon Aurora**
|
1817
|
-
#
|
1818
|
-
# Not applicable. Mapping Amazon Web Services IAM accounts to database
|
1819
|
-
# accounts is managed by the DB cluster.
|
1820
|
-
#
|
1821
1757
|
#
|
1822
1758
|
#
|
1823
1759
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.IAMDBAuth.html
|
@@ -1845,27 +1781,8 @@ module Aws::RDS
|
|
1845
1781
|
#
|
1846
1782
|
# This setting doesn't apply to RDS Custom.
|
1847
1783
|
# @option options [Integer] :performance_insights_retention_period
|
1848
|
-
# The
|
1849
|
-
#
|
1850
|
-
#
|
1851
|
-
# * 7
|
1852
|
-
#
|
1853
|
-
# * *month* * 31, where *month* is a number of months from 1-23
|
1854
|
-
#
|
1855
|
-
# * 731
|
1856
|
-
#
|
1857
|
-
# For example, the following values are valid:
|
1858
|
-
#
|
1859
|
-
# * 93 (3 months * 31)
|
1860
|
-
#
|
1861
|
-
# * 341 (11 months * 31)
|
1862
|
-
#
|
1863
|
-
# * 589 (19 months * 31)
|
1864
|
-
#
|
1865
|
-
# * 731
|
1866
|
-
#
|
1867
|
-
# If you specify a retention period such as 94, which isn't a valid
|
1868
|
-
# value, RDS issues an error.
|
1784
|
+
# The amount of time, in days, to retain Performance Insights data.
|
1785
|
+
# Valid values are 7 or 731 (2 years).
|
1869
1786
|
#
|
1870
1787
|
# This setting doesn't apply to RDS Custom.
|
1871
1788
|
# @option options [Array<String>] :enable_cloudwatch_logs_exports
|
@@ -1911,10 +1828,6 @@ module Aws::RDS
|
|
1911
1828
|
# instance class of the DB instance.
|
1912
1829
|
#
|
1913
1830
|
# This setting doesn't apply to RDS Custom.
|
1914
|
-
#
|
1915
|
-
# **Amazon Aurora**
|
1916
|
-
#
|
1917
|
-
# Not applicable.
|
1918
1831
|
# @option options [Boolean] :deletion_protection
|
1919
1832
|
# A value that indicates whether the DB instance has deletion protection
|
1920
1833
|
# enabled. The database can't be deleted when deletion protection is
|
@@ -1941,10 +1854,6 @@ module Aws::RDS
|
|
1941
1854
|
#
|
1942
1855
|
# This setting doesn't apply to RDS Custom.
|
1943
1856
|
#
|
1944
|
-
# **Amazon Aurora**
|
1945
|
-
#
|
1946
|
-
# Not applicable. Storage is managed by the DB cluster.
|
1947
|
-
#
|
1948
1857
|
#
|
1949
1858
|
#
|
1950
1859
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PIOPS.StorageTypes.html#USER_PIOPS.Autoscaling
|