aws-sdk-rds 1.148.0 → 1.149.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 +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-rds/client.rb +416 -240
- data/lib/aws-sdk-rds/db_cluster.rb +96 -37
- data/lib/aws-sdk-rds/db_cluster_snapshot.rb +25 -22
- data/lib/aws-sdk-rds/db_instance.rb +175 -48
- data/lib/aws-sdk-rds/db_snapshot.rb +29 -23
- data/lib/aws-sdk-rds/resource.rb +137 -48
- data/lib/aws-sdk-rds/types.rb +410 -168
- 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
|
-
# from
|
398
|
-
#
|
399
|
-
#
|
400
|
-
#
|
401
|
-
#
|
402
|
-
#
|
403
|
-
#
|
404
|
-
# values:
|
405
|
-
#
|
406
|
-
# * `KmsKeyId` - The
|
407
|
-
#
|
408
|
-
#
|
409
|
-
#
|
410
|
-
#
|
411
|
-
#
|
393
|
+
# When you are replicating a DB cluster from one Amazon Web Services
|
394
|
+
# GovCloud (US) Region to another, an URL that contains a Signature
|
395
|
+
# Version 4 signed request for the `CreateDBCluster` operation to be
|
396
|
+
# called in the source Amazon Web Services Region where the DB cluster
|
397
|
+
# is replicated from. Specify `PreSignedUrl` only when you are
|
398
|
+
# performing cross-Region replication from an encrypted DB cluster.
|
399
|
+
#
|
400
|
+
# The presigned URL must be a valid request for the `CreateDBCluster`
|
401
|
+
# API operation that can run in the source Amazon Web Services Region
|
402
|
+
# that contains the encrypted DB cluster to copy.
|
403
|
+
#
|
404
|
+
# The presigned URL request must contain the following parameter values:
|
405
|
+
#
|
406
|
+
# * `KmsKeyId` - The KMS key identifier for the KMS key to use to
|
407
|
+
# encrypt the copy of the DB cluster in the destination Amazon Web
|
408
|
+
# Services Region. This should refer to the same KMS key for both the
|
409
|
+
# `CreateDBCluster` operation that is called in the destination Amazon
|
410
|
+
# Web Services Region, and the operation contained in the presigned
|
411
|
+
# 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,9 +429,8 @@ 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
|
434
|
-
# Region.
|
432
|
+
# autogenerates a presigned URL that is a valid request for the
|
433
|
+
# operation that can run in the source Amazon Web Services Region.
|
435
434
|
#
|
436
435
|
# </note>
|
437
436
|
#
|
@@ -447,7 +446,7 @@ module Aws::RDS
|
|
447
446
|
# accounts. By default, mapping isn't enabled.
|
448
447
|
#
|
449
448
|
# For more information, see [ IAM Database Authentication][1] in the
|
450
|
-
# *Amazon Aurora User Guide
|
449
|
+
# *Amazon Aurora User Guide*.
|
451
450
|
#
|
452
451
|
# Valid for: Aurora DB clusters only
|
453
452
|
#
|
@@ -518,6 +517,9 @@ module Aws::RDS
|
|
518
517
|
# The `multimaster` engine mode only applies for DB clusters created
|
519
518
|
# with Aurora MySQL version 5.6.10a.
|
520
519
|
#
|
520
|
+
# The `serverless` engine mode only applies for Aurora Serverless v1 DB
|
521
|
+
# clusters.
|
522
|
+
#
|
521
523
|
# For Aurora PostgreSQL, the `global` engine mode isn't required, and
|
522
524
|
# both the `parallelquery` and the `multimaster` engine modes currently
|
523
525
|
# aren't supported.
|
@@ -526,22 +528,25 @@ module Aws::RDS
|
|
526
528
|
# information, see the following sections in the *Amazon Aurora User
|
527
529
|
# Guide*\:
|
528
530
|
#
|
529
|
-
# * [
|
531
|
+
# * [Limitations of Aurora Serverless v1][1]
|
532
|
+
#
|
533
|
+
# * [Requirements for Aurora Serverless v2][2]
|
530
534
|
#
|
531
|
-
# * [
|
535
|
+
# * [Limitations of Parallel Query][3]
|
532
536
|
#
|
533
|
-
# * [
|
537
|
+
# * [Limitations of Aurora Global Databases][4]
|
534
538
|
#
|
535
|
-
# * [
|
539
|
+
# * [Limitations of Multi-Master Clusters][5]
|
536
540
|
#
|
537
541
|
# Valid for: Aurora DB clusters only
|
538
542
|
#
|
539
543
|
#
|
540
544
|
#
|
541
545
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless.html#aurora-serverless.limitations
|
542
|
-
# [2]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-
|
543
|
-
# [3]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-
|
544
|
-
# [4]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-
|
546
|
+
# [2]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless-v2.requirements.html
|
547
|
+
# [3]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-mysql-parallel-query.html#aurora-mysql-parallel-query-limitations
|
548
|
+
# [4]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-global-database.html#aurora-global-database.limitations
|
549
|
+
# [5]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-multi-master.html#aurora-multi-master-limitations
|
545
550
|
# @option options [Types::ScalingConfiguration] :scaling_configuration
|
546
551
|
# For DB clusters in `serverless` DB engine mode, the scaling properties
|
547
552
|
# of the DB cluster.
|
@@ -764,8 +769,27 @@ module Aws::RDS
|
|
764
769
|
#
|
765
770
|
# Valid for: Multi-AZ DB clusters only
|
766
771
|
# @option options [Integer] :performance_insights_retention_period
|
767
|
-
# The
|
768
|
-
#
|
772
|
+
# The number of days to retain Performance Insights data. The default is
|
773
|
+
# 7 days. The following values are valid:
|
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.
|
769
793
|
#
|
770
794
|
# Valid for: Multi-AZ DB clusters only
|
771
795
|
# @option options [Types::ServerlessV2ScalingConfiguration] :serverless_v2_scaling_configuration
|
@@ -1179,14 +1203,16 @@ module Aws::RDS
|
|
1179
1203
|
# * Web and Express editions: Must be an integer from 20 to 1024.
|
1180
1204
|
# @option options [required, String] :db_instance_class
|
1181
1205
|
# The compute and memory capacity of the DB instance, for example
|
1182
|
-
# db.
|
1206
|
+
# db.m5.large. Not all DB instance classes are available in all Amazon
|
1183
1207
|
# Web Services Regions, or for all database engines. For the full list
|
1184
1208
|
# of DB instance classes, and availability for your engine, see [DB
|
1185
|
-
#
|
1209
|
+
# instance classes][1] in the *Amazon RDS User Guide* or [Aurora DB
|
1210
|
+
# instance classes][2] in the *Amazon Aurora User Guide*.
|
1186
1211
|
#
|
1187
1212
|
#
|
1188
1213
|
#
|
1189
1214
|
# [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
|
1190
1216
|
# @option options [required, String] :engine
|
1191
1217
|
# The name of the database engine to be used for this instance.
|
1192
1218
|
#
|
@@ -1281,7 +1307,9 @@ module Aws::RDS
|
|
1281
1307
|
# @option options [Array<String>] :db_security_groups
|
1282
1308
|
# A list of DB security groups to associate with this DB instance.
|
1283
1309
|
#
|
1284
|
-
#
|
1310
|
+
# This setting applies to the legacy EC2-Classic platform, which is no
|
1311
|
+
# longer used to create new DB instances. Use the `VpcSecurityGroupIds`
|
1312
|
+
# setting instead.
|
1285
1313
|
# @option options [Array<String>] :vpc_security_group_ids
|
1286
1314
|
# A list of Amazon EC2 VPC security groups to associate with this DB
|
1287
1315
|
# instance.
|
@@ -1375,7 +1403,7 @@ module Aws::RDS
|
|
1375
1403
|
#
|
1376
1404
|
# * Can't be set to 0 if the DB instance is a source to read replicas
|
1377
1405
|
#
|
1378
|
-
# * Can't be set to 0
|
1406
|
+
# * Can't be set to 0 for an RDS Custom for Oracle DB instance
|
1379
1407
|
# @option options [String] :preferred_backup_window
|
1380
1408
|
# The daily time range during which automated backups are created if
|
1381
1409
|
# automated backups are enabled, using the `BackupRetentionPeriod`
|
@@ -1454,11 +1482,16 @@ module Aws::RDS
|
|
1454
1482
|
# instance is a Multi-AZ deployment.
|
1455
1483
|
#
|
1456
1484
|
# 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.
|
1457
1490
|
# @option options [String] :engine_version
|
1458
1491
|
# The version number of the database engine to use.
|
1459
1492
|
#
|
1460
1493
|
# For a list of valid engine versions, use the
|
1461
|
-
# `DescribeDBEngineVersions`
|
1494
|
+
# `DescribeDBEngineVersions` operation.
|
1462
1495
|
#
|
1463
1496
|
# The following are the database engines and links to information about
|
1464
1497
|
# the major and minor versions that are available with Amazon RDS. Not
|
@@ -1531,6 +1564,10 @@ module Aws::RDS
|
|
1531
1564
|
# `general-public-license`
|
1532
1565
|
#
|
1533
1566
|
# This setting doesn't apply to RDS Custom.
|
1567
|
+
#
|
1568
|
+
# **Amazon Aurora**
|
1569
|
+
#
|
1570
|
+
# Not applicable.
|
1534
1571
|
# @option options [Integer] :iops
|
1535
1572
|
# The amount of Provisioned IOPS (input/output operations per second) to
|
1536
1573
|
# be initially allocated for the DB instance. For information about
|
@@ -1542,6 +1579,10 @@ module Aws::RDS
|
|
1542
1579
|
# instance. For SQL Server DB instances, must be a multiple between 1
|
1543
1580
|
# and 50 of the storage amount for the DB instance.
|
1544
1581
|
#
|
1582
|
+
# **Amazon Aurora**
|
1583
|
+
#
|
1584
|
+
# Not applicable. Storage is managed by the DB cluster.
|
1585
|
+
#
|
1545
1586
|
#
|
1546
1587
|
#
|
1547
1588
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Storage.html#USER_PIOPS
|
@@ -1555,6 +1596,10 @@ module Aws::RDS
|
|
1555
1596
|
# instance.
|
1556
1597
|
#
|
1557
1598
|
# This setting doesn't apply to RDS Custom.
|
1599
|
+
#
|
1600
|
+
# **Amazon Aurora**
|
1601
|
+
#
|
1602
|
+
# Not applicable.
|
1558
1603
|
# @option options [String] :character_set_name
|
1559
1604
|
# For supported engines, this value indicates that the DB instance
|
1560
1605
|
# should be associated with the specified `CharacterSet`.
|
@@ -1619,11 +1664,19 @@ module Aws::RDS
|
|
1619
1664
|
# parameter.
|
1620
1665
|
#
|
1621
1666
|
# 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.
|
1622
1671
|
# @option options [String] :tde_credential_arn
|
1623
1672
|
# The ARN from the key store with which to associate the instance for
|
1624
1673
|
# TDE encryption.
|
1625
1674
|
#
|
1626
1675
|
# This setting doesn't apply to RDS Custom.
|
1676
|
+
#
|
1677
|
+
# **Amazon Aurora**
|
1678
|
+
#
|
1679
|
+
# Not applicable.
|
1627
1680
|
# @option options [String] :tde_credential_password
|
1628
1681
|
# The password for the given ARN from the key store in order to access
|
1629
1682
|
# the device.
|
@@ -1677,6 +1730,10 @@ module Aws::RDS
|
|
1677
1730
|
#
|
1678
1731
|
# This setting doesn't apply to RDS Custom.
|
1679
1732
|
#
|
1733
|
+
# **Amazon Aurora**
|
1734
|
+
#
|
1735
|
+
# Not applicable. The domain is managed by the DB cluster.
|
1736
|
+
#
|
1680
1737
|
#
|
1681
1738
|
#
|
1682
1739
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/kerberos-authentication.html
|
@@ -1720,6 +1777,10 @@ module Aws::RDS
|
|
1720
1777
|
# the Directory Service.
|
1721
1778
|
#
|
1722
1779
|
# This setting doesn't apply to RDS Custom.
|
1780
|
+
#
|
1781
|
+
# **Amazon Aurora**
|
1782
|
+
#
|
1783
|
+
# Not applicable. The domain is managed by the DB cluster.
|
1723
1784
|
# @option options [Integer] :promotion_tier
|
1724
1785
|
# A value that specifies the order in which an Aurora Replica is
|
1725
1786
|
# promoted to the primary instance after a failure of the existing
|
@@ -1747,13 +1808,16 @@ module Aws::RDS
|
|
1747
1808
|
# Services Identity and Access Management (IAM) accounts to database
|
1748
1809
|
# accounts. By default, mapping isn't enabled.
|
1749
1810
|
#
|
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
|
-
#
|
1754
1811
|
# For more information, see [ IAM Database Authentication for MySQL and
|
1755
1812
|
# PostgreSQL][1] in the *Amazon RDS User Guide*.
|
1756
1813
|
#
|
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
|
+
#
|
1757
1821
|
#
|
1758
1822
|
#
|
1759
1823
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.IAMDBAuth.html
|
@@ -1781,8 +1845,27 @@ module Aws::RDS
|
|
1781
1845
|
#
|
1782
1846
|
# This setting doesn't apply to RDS Custom.
|
1783
1847
|
# @option options [Integer] :performance_insights_retention_period
|
1784
|
-
# The
|
1785
|
-
#
|
1848
|
+
# The number of days to retain Performance Insights data. The default is
|
1849
|
+
# 7 days. The following values are valid:
|
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.
|
1786
1869
|
#
|
1787
1870
|
# This setting doesn't apply to RDS Custom.
|
1788
1871
|
# @option options [Array<String>] :enable_cloudwatch_logs_exports
|
@@ -1828,6 +1911,10 @@ module Aws::RDS
|
|
1828
1911
|
# instance class of the DB instance.
|
1829
1912
|
#
|
1830
1913
|
# This setting doesn't apply to RDS Custom.
|
1914
|
+
#
|
1915
|
+
# **Amazon Aurora**
|
1916
|
+
#
|
1917
|
+
# Not applicable.
|
1831
1918
|
# @option options [Boolean] :deletion_protection
|
1832
1919
|
# A value that indicates whether the DB instance has deletion protection
|
1833
1920
|
# enabled. The database can't be deleted when deletion protection is
|
@@ -1854,6 +1941,10 @@ module Aws::RDS
|
|
1854
1941
|
#
|
1855
1942
|
# This setting doesn't apply to RDS Custom.
|
1856
1943
|
#
|
1944
|
+
# **Amazon Aurora**
|
1945
|
+
#
|
1946
|
+
# Not applicable. Storage is managed by the DB cluster.
|
1947
|
+
#
|
1857
1948
|
#
|
1858
1949
|
#
|
1859
1950
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PIOPS.StorageTypes.html#USER_PIOPS.Autoscaling
|
@@ -2856,8 +2947,7 @@ module Aws::RDS
|
|
2856
2947
|
# @param [Hash] options ({})
|
2857
2948
|
# @option options [String] :db_instance_identifier
|
2858
2949
|
# The ID of the DB instance to retrieve the list of DB snapshots for.
|
2859
|
-
# This parameter
|
2860
|
-
# `DBSnapshotIdentifier`. This parameter isn't case-sensitive.
|
2950
|
+
# This parameter isn't case-sensitive.
|
2861
2951
|
#
|
2862
2952
|
# Constraints:
|
2863
2953
|
#
|
@@ -2865,9 +2955,8 @@ module Aws::RDS
|
|
2865
2955
|
#
|
2866
2956
|
# ^
|
2867
2957
|
# @option options [String] :db_snapshot_identifier
|
2868
|
-
# A specific DB snapshot identifier to describe. This
|
2869
|
-
#
|
2870
|
-
# stored as a lowercase string.
|
2958
|
+
# A specific DB snapshot identifier to describe. This value is stored as
|
2959
|
+
# a lowercase string.
|
2871
2960
|
#
|
2872
2961
|
# Constraints:
|
2873
2962
|
#
|