aws-sdk-rds 1.134.0 → 1.138.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 +20 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-rds/client.rb +221 -137
- data/lib/aws-sdk-rds/db_cluster.rb +16 -16
- data/lib/aws-sdk-rds/db_cluster_parameter_group.rb +3 -2
- data/lib/aws-sdk-rds/db_cluster_snapshot.rb +13 -7
- data/lib/aws-sdk-rds/db_instance.rb +66 -43
- data/lib/aws-sdk-rds/db_parameter_group.rb +21 -10
- data/lib/aws-sdk-rds/db_snapshot.rb +17 -5
- data/lib/aws-sdk-rds/event_subscription.rb +20 -9
- data/lib/aws-sdk-rds/resource.rb +102 -55
- data/lib/aws-sdk-rds/types.rb +218 -130
- data/lib/aws-sdk-rds.rb +1 -1
- metadata +4 -4
@@ -494,7 +494,7 @@ module Aws::RDS
|
|
494
494
|
data[:db_cluster_instance_class]
|
495
495
|
end
|
496
496
|
|
497
|
-
# The storage type associated with DB
|
497
|
+
# The storage type associated with the DB cluster.
|
498
498
|
#
|
499
499
|
# This setting is only for non-Aurora Multi-AZ DB clusters.
|
500
500
|
# @return [String]
|
@@ -844,7 +844,7 @@ module Aws::RDS
|
|
844
844
|
# Constraints: Must match the name of an existing DBSubnetGroup. Must
|
845
845
|
# not be default.
|
846
846
|
#
|
847
|
-
# Example: `
|
847
|
+
# Example: `mydbsubnetgroup`
|
848
848
|
#
|
849
849
|
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
850
850
|
# @option options [required, String] :engine
|
@@ -854,7 +854,8 @@ module Aws::RDS
|
|
854
854
|
#
|
855
855
|
# * `aurora` (for MySQL 5.6-compatible Aurora)
|
856
856
|
#
|
857
|
-
# * `aurora-mysql` (for MySQL 5.7-compatible
|
857
|
+
# * `aurora-mysql` (for MySQL 5.7-compatible and MySQL 8.0-compatible
|
858
|
+
# Aurora)
|
858
859
|
#
|
859
860
|
# * `aurora-postgresql`
|
860
861
|
#
|
@@ -873,7 +874,7 @@ module Aws::RDS
|
|
873
874
|
# "DBEngineVersions[].EngineVersion"`
|
874
875
|
#
|
875
876
|
# To list all of the available engine versions for MySQL 5.7-compatible
|
876
|
-
# Aurora, use the following command:
|
877
|
+
# and MySQL 8.0-compatible Aurora, use the following command:
|
877
878
|
#
|
878
879
|
# `aws rds describe-db-engine-versions --engine aurora-mysql --query
|
879
880
|
# "DBEngineVersions[].EngineVersion"`
|
@@ -1294,11 +1295,11 @@ module Aws::RDS
|
|
1294
1295
|
#
|
1295
1296
|
# This setting is required to create a Multi-AZ DB cluster.
|
1296
1297
|
#
|
1297
|
-
# Valid values: `
|
1298
|
+
# Valid values: `io1`
|
1298
1299
|
#
|
1299
|
-
#
|
1300
|
+
# When specified, a value for the `Iops` parameter is required.
|
1300
1301
|
#
|
1301
|
-
# Default: `io1`
|
1302
|
+
# Default: `io1`
|
1302
1303
|
#
|
1303
1304
|
# Valid for: Multi-AZ DB clusters only
|
1304
1305
|
# @option options [Integer] :iops
|
@@ -1758,7 +1759,7 @@ module Aws::RDS
|
|
1758
1759
|
# "DBEngineVersions[].EngineVersion"`
|
1759
1760
|
#
|
1760
1761
|
# To list all of the available engine versions for MySQL 5.7-compatible
|
1761
|
-
# Aurora, use the following command:
|
1762
|
+
# and MySQL 8.0-compatible Aurora, use the following command:
|
1762
1763
|
#
|
1763
1764
|
# `aws rds describe-db-engine-versions --engine aurora-mysql --query
|
1764
1765
|
# "DBEngineVersions[].EngineVersion"`
|
@@ -1904,12 +1905,11 @@ module Aws::RDS
|
|
1904
1905
|
# @option options [String] :storage_type
|
1905
1906
|
# Specifies the storage type to be associated with the DB cluster.
|
1906
1907
|
#
|
1907
|
-
# Valid values: `
|
1908
|
+
# Valid values: `io1`
|
1908
1909
|
#
|
1909
|
-
#
|
1910
|
-
# parameter.
|
1910
|
+
# When specified, a value for the `Iops` parameter is required.
|
1911
1911
|
#
|
1912
|
-
# Default: `io1`
|
1912
|
+
# Default: `io1`
|
1913
1913
|
#
|
1914
1914
|
# Valid for: Multi-AZ DB clusters only
|
1915
1915
|
# @option options [Integer] :iops
|
@@ -2117,7 +2117,7 @@ module Aws::RDS
|
|
2117
2117
|
# Constraints: If supplied, must match the name of an existing
|
2118
2118
|
# DBSubnetGroup.
|
2119
2119
|
#
|
2120
|
-
# Example: `
|
2120
|
+
# Example: `mydbsubnetgroup`
|
2121
2121
|
#
|
2122
2122
|
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
2123
2123
|
# @option options [String] :option_group_name
|
@@ -2284,11 +2284,11 @@ module Aws::RDS
|
|
2284
2284
|
# Specifies the storage type to be associated with the each DB instance
|
2285
2285
|
# in the Multi-AZ DB cluster.
|
2286
2286
|
#
|
2287
|
-
# Valid values: `
|
2287
|
+
# Valid values: `io1`
|
2288
2288
|
#
|
2289
|
-
#
|
2289
|
+
# When specified, a value for the `Iops` parameter is required.
|
2290
2290
|
#
|
2291
|
-
# Default: `io1`
|
2291
|
+
# Default: `io1`
|
2292
2292
|
#
|
2293
2293
|
# Valid for: Multi-AZ DB clusters only
|
2294
2294
|
# @option options [Boolean] :publicly_accessible
|
@@ -211,7 +211,7 @@ module Aws::RDS
|
|
211
211
|
#
|
212
212
|
# **Aurora MySQL**
|
213
213
|
#
|
214
|
-
# Example: `aurora5.6`, `aurora-mysql5.7`
|
214
|
+
# Example: `aurora5.6`, `aurora-mysql5.7`, `aurora-mysql8.0`
|
215
215
|
#
|
216
216
|
# **Aurora PostgreSQL**
|
217
217
|
#
|
@@ -246,7 +246,8 @@ module Aws::RDS
|
|
246
246
|
#
|
247
247
|
# * `aurora` (for MySQL 5.6-compatible Aurora)
|
248
248
|
#
|
249
|
-
# * `aurora-mysql` (for MySQL 5.7-compatible
|
249
|
+
# * `aurora-mysql` (for MySQL 5.7-compatible and MySQL 8.0-compatible
|
250
|
+
# Aurora)
|
250
251
|
#
|
251
252
|
# * `aurora-postgresql`
|
252
253
|
#
|
@@ -78,7 +78,14 @@ module Aws::RDS
|
|
78
78
|
data[:allocated_storage]
|
79
79
|
end
|
80
80
|
|
81
|
-
# Specifies the status of this DB cluster snapshot.
|
81
|
+
# Specifies the status of this DB cluster snapshot. Valid statuses are
|
82
|
+
# the following:
|
83
|
+
#
|
84
|
+
# * `available`
|
85
|
+
#
|
86
|
+
# * `copying`
|
87
|
+
#
|
88
|
+
# * `creating`
|
82
89
|
# @return [String]
|
83
90
|
def status
|
84
91
|
data[:status]
|
@@ -574,7 +581,7 @@ module Aws::RDS
|
|
574
581
|
# "DBEngineVersions[].EngineVersion"`
|
575
582
|
#
|
576
583
|
# To list all of the available engine versions for MySQL 5.7-compatible
|
577
|
-
# Aurora, use the following command:
|
584
|
+
# and MySQL 8.0-compatible Aurora, use the following command:
|
578
585
|
#
|
579
586
|
# `aws rds describe-db-engine-versions --engine aurora-mysql --query
|
580
587
|
# "DBEngineVersions[].EngineVersion"`
|
@@ -638,7 +645,7 @@ module Aws::RDS
|
|
638
645
|
# Constraints: If supplied, must match the name of an existing DB subnet
|
639
646
|
# group.
|
640
647
|
#
|
641
|
-
# Example: `
|
648
|
+
# Example: `mydbsubnetgroup`
|
642
649
|
#
|
643
650
|
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
644
651
|
# @option options [String] :database_name
|
@@ -804,12 +811,11 @@ module Aws::RDS
|
|
804
811
|
# Specifies the storage type to be associated with the each DB instance
|
805
812
|
# in the Multi-AZ DB cluster.
|
806
813
|
#
|
807
|
-
# Valid values: `
|
814
|
+
# Valid values: `io1`
|
808
815
|
#
|
809
|
-
#
|
810
|
-
# parameter.
|
816
|
+
# When specified, a value for the `Iops` parameter is required.
|
811
817
|
#
|
812
|
-
# Default: `io1`
|
818
|
+
# Default: `io1`
|
813
819
|
#
|
814
820
|
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
815
821
|
# @option options [Integer] :iops
|
@@ -940,7 +940,7 @@ module Aws::RDS
|
|
940
940
|
#
|
941
941
|
# ^
|
942
942
|
#
|
943
|
-
# **Amazon RDS Custom**
|
943
|
+
# **Amazon RDS Custom for Oracle**
|
944
944
|
#
|
945
945
|
# The Oracle System ID (SID) of the created RDS Custom DB instance. If
|
946
946
|
# you don't specify a value, the default value is `ORCL`.
|
@@ -955,6 +955,10 @@ module Aws::RDS
|
|
955
955
|
#
|
956
956
|
# * It can't be a word reserved by the database engine.
|
957
957
|
#
|
958
|
+
# **Amazon RDS Custom for SQL Server**
|
959
|
+
#
|
960
|
+
# Not applicable. Must be null.
|
961
|
+
#
|
958
962
|
# **SQL Server**
|
959
963
|
#
|
960
964
|
# Not applicable. Must be null.
|
@@ -1005,9 +1009,11 @@ module Aws::RDS
|
|
1005
1009
|
# following:
|
1006
1010
|
#
|
1007
1011
|
# * General Purpose (SSD) storage (gp2): Must be an integer from 40 to
|
1008
|
-
# 65536
|
1012
|
+
# 65536 for RDS Custom for Oracle, 16384 for RDS Custom for SQL
|
1013
|
+
# Server.
|
1009
1014
|
#
|
1010
|
-
# * Provisioned IOPS storage (io1): Must be an integer from 40 to 65536
|
1015
|
+
# * Provisioned IOPS storage (io1): Must be an integer from 40 to 65536
|
1016
|
+
# for RDS Custom for Oracle, 16384 for RDS Custom for SQL Server.
|
1011
1017
|
#
|
1012
1018
|
# **MySQL**
|
1013
1019
|
#
|
@@ -1068,21 +1074,21 @@ module Aws::RDS
|
|
1068
1074
|
#
|
1069
1075
|
# * General Purpose (SSD) storage (gp2):
|
1070
1076
|
#
|
1071
|
-
# * Enterprise and Standard editions: Must be an integer from
|
1077
|
+
# * Enterprise and Standard editions: Must be an integer from 20 to
|
1072
1078
|
# 16384.
|
1073
1079
|
#
|
1074
1080
|
# * Web and Express editions: Must be an integer from 20 to 16384.
|
1075
1081
|
#
|
1076
1082
|
# * Provisioned IOPS storage (io1):
|
1077
1083
|
#
|
1078
|
-
# * Enterprise and Standard editions: Must be an integer from
|
1084
|
+
# * Enterprise and Standard editions: Must be an integer from 100 to
|
1079
1085
|
# 16384.
|
1080
1086
|
#
|
1081
1087
|
# * Web and Express editions: Must be an integer from 100 to 16384.
|
1082
1088
|
#
|
1083
1089
|
# * Magnetic storage (standard):
|
1084
1090
|
#
|
1085
|
-
# * Enterprise and Standard editions: Must be an integer from
|
1091
|
+
# * Enterprise and Standard editions: Must be an integer from 20 to
|
1086
1092
|
# 1024.
|
1087
1093
|
#
|
1088
1094
|
# * Web and Express editions: Must be an integer from 20 to 1024.
|
@@ -1106,11 +1112,18 @@ module Aws::RDS
|
|
1106
1112
|
#
|
1107
1113
|
# * `aurora` (for MySQL 5.6-compatible Aurora)
|
1108
1114
|
#
|
1109
|
-
# * `aurora-mysql` (for MySQL 5.7-compatible
|
1115
|
+
# * `aurora-mysql` (for MySQL 5.7-compatible and MySQL 8.0-compatible
|
1116
|
+
# Aurora)
|
1110
1117
|
#
|
1111
1118
|
# * `aurora-postgresql`
|
1112
1119
|
#
|
1113
|
-
# * `custom-oracle-ee (for RDS Custom instances)`
|
1120
|
+
# * `custom-oracle-ee (for RDS Custom for Oracle instances)`
|
1121
|
+
#
|
1122
|
+
# * `custom-sqlserver-ee (for RDS Custom for SQL Server instances)`
|
1123
|
+
#
|
1124
|
+
# * `custom-sqlserver-se (for RDS Custom for SQL Server instances)`
|
1125
|
+
#
|
1126
|
+
# * `custom-sqlserver-web (for RDS Custom for SQL Server instances)`
|
1114
1127
|
#
|
1115
1128
|
# * `mariadb`
|
1116
1129
|
#
|
@@ -1200,6 +1213,10 @@ module Aws::RDS
|
|
1200
1213
|
# information on Amazon Web Services Regions and Availability Zones, see
|
1201
1214
|
# [Regions and Availability Zones][1].
|
1202
1215
|
#
|
1216
|
+
# **Amazon Aurora**
|
1217
|
+
#
|
1218
|
+
# Not applicable. Availability Zones are managed by the DB cluster.
|
1219
|
+
#
|
1203
1220
|
# Default: A random, system-chosen Availability Zone in the endpoint's
|
1204
1221
|
# Amazon Web Services Region.
|
1205
1222
|
#
|
@@ -1226,7 +1243,10 @@ module Aws::RDS
|
|
1226
1243
|
# @option options [String] :db_subnet_group_name
|
1227
1244
|
# A DB subnet group to associate with this DB instance.
|
1228
1245
|
#
|
1229
|
-
#
|
1246
|
+
# Constraints: Must match the name of an existing DBSubnetGroup. Must
|
1247
|
+
# not be default.
|
1248
|
+
#
|
1249
|
+
# Example: `mydbsubnetgroup`
|
1230
1250
|
# @option options [String] :preferred_maintenance_window
|
1231
1251
|
# The time range each week during which system maintenance can occur, in
|
1232
1252
|
# Universal Coordinated Time (UTC). For more information, see [Amazon
|
@@ -1277,7 +1297,7 @@ module Aws::RDS
|
|
1277
1297
|
#
|
1278
1298
|
# * Can't be set to 0 if the DB instance is a source to read replicas
|
1279
1299
|
#
|
1280
|
-
# * Can't be set to 0 or 35 for an RDS Custom DB instance
|
1300
|
+
# * Can't be set to 0 or 35 for an RDS Custom for Oracle DB instance
|
1281
1301
|
# @option options [String] :preferred_backup_window
|
1282
1302
|
# The daily time range during which automated backups are created if
|
1283
1303
|
# automated backups are enabled, using the `BackupRetentionPeriod`
|
@@ -1372,47 +1392,53 @@ module Aws::RDS
|
|
1372
1392
|
# Not applicable. The version number of the database engine to be used
|
1373
1393
|
# by the DB instance is managed by the DB cluster.
|
1374
1394
|
#
|
1375
|
-
# **Amazon RDS Custom**
|
1395
|
+
# **Amazon RDS Custom for Oracle**
|
1376
1396
|
#
|
1377
1397
|
# A custom engine version (CEV) that you have previously created. This
|
1378
|
-
# setting is required for RDS Custom. The CEV name has the
|
1379
|
-
# format: `19.customized_string `. An example identifier is
|
1380
|
-
# `19.my_cev1`. For more information, see [ Creating an RDS Custom
|
1381
|
-
# instance][1] in the *Amazon RDS User Guide.*.
|
1398
|
+
# setting is required for RDS Custom for Oracle. The CEV name has the
|
1399
|
+
# following format: `19.customized_string `. An example identifier is
|
1400
|
+
# `19.my_cev1`. For more information, see [ Creating an RDS Custom for
|
1401
|
+
# Oracle DB instance][1] in the *Amazon RDS User Guide.*.
|
1402
|
+
#
|
1403
|
+
# **Amazon RDS Custom for SQL Server**
|
1404
|
+
#
|
1405
|
+
# See [RDS Custom for SQL Server general requirements][2] in the *Amazon
|
1406
|
+
# RDS User Guide.*
|
1382
1407
|
#
|
1383
1408
|
# **MariaDB**
|
1384
1409
|
#
|
1385
|
-
# For information, see [MariaDB on Amazon RDS Versions][
|
1410
|
+
# For information, see [MariaDB on Amazon RDS Versions][3] in the
|
1386
1411
|
# *Amazon RDS User Guide.*
|
1387
1412
|
#
|
1388
1413
|
# **Microsoft SQL Server**
|
1389
1414
|
#
|
1390
|
-
# For information, see [Microsoft SQL Server Versions on Amazon RDS][
|
1415
|
+
# For information, see [Microsoft SQL Server Versions on Amazon RDS][4]
|
1391
1416
|
# in the *Amazon RDS User Guide.*
|
1392
1417
|
#
|
1393
1418
|
# **MySQL**
|
1394
1419
|
#
|
1395
|
-
# For information, see [MySQL on Amazon RDS Versions][
|
1420
|
+
# For information, see [MySQL on Amazon RDS Versions][5] in the *Amazon
|
1396
1421
|
# RDS User Guide.*
|
1397
1422
|
#
|
1398
1423
|
# **Oracle**
|
1399
1424
|
#
|
1400
|
-
# For information, see [Oracle Database Engine Release Notes][
|
1425
|
+
# For information, see [Oracle Database Engine Release Notes][6] in the
|
1401
1426
|
# *Amazon RDS User Guide.*
|
1402
1427
|
#
|
1403
1428
|
# **PostgreSQL**
|
1404
1429
|
#
|
1405
1430
|
# For information, see [Amazon RDS for PostgreSQL versions and
|
1406
|
-
# extensions][
|
1431
|
+
# extensions][7] in the *Amazon RDS User Guide.*
|
1407
1432
|
#
|
1408
1433
|
#
|
1409
1434
|
#
|
1410
1435
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-creating.html#custom-creating.create
|
1411
|
-
# [2]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/
|
1412
|
-
# [3]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/
|
1413
|
-
# [4]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/
|
1414
|
-
# [5]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/
|
1415
|
-
# [6]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/
|
1436
|
+
# [2]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-reqs-limits.html#custom-reqs-limits.reqsMS
|
1437
|
+
# [3]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_MariaDB.html#MariaDB.Concepts.VersionMgmt
|
1438
|
+
# [4]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_SQLServer.html#SQLServer.Concepts.General.VersionSupport
|
1439
|
+
# [5]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_MySQL.html#MySQL.Concepts.VersionMgmt
|
1440
|
+
# [6]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Appendix.Oracle.PatchComposition.html
|
1441
|
+
# [7]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_PostgreSQL.html#PostgreSQL.Concepts
|
1416
1442
|
# @option options [Boolean] :auto_minor_version_upgrade
|
1417
1443
|
# A value that indicates whether minor engine upgrades are applied
|
1418
1444
|
# automatically to the DB instance during the maintenance window. By
|
@@ -1529,9 +1555,8 @@ module Aws::RDS
|
|
1529
1555
|
# A value that indicates whether the DB instance is encrypted. By
|
1530
1556
|
# default, it isn't encrypted.
|
1531
1557
|
#
|
1532
|
-
# For RDS Custom
|
1533
|
-
#
|
1534
|
-
# an error.
|
1558
|
+
# For RDS Custom instances, either set this parameter to `true` or leave
|
1559
|
+
# it unset. If you set this parameter to `false`, RDS reports an error.
|
1535
1560
|
#
|
1536
1561
|
# **Amazon Aurora**
|
1537
1562
|
#
|
@@ -1559,11 +1584,11 @@ module Aws::RDS
|
|
1559
1584
|
#
|
1560
1585
|
# **Amazon RDS Custom**
|
1561
1586
|
#
|
1562
|
-
# A KMS key is required for RDS Custom
|
1563
|
-
#
|
1564
|
-
#
|
1565
|
-
#
|
1566
|
-
#
|
1587
|
+
# A KMS key is required for RDS Custom instances. For most RDS engines,
|
1588
|
+
# if you leave this parameter empty while enabling `StorageEncrypted`,
|
1589
|
+
# the engine uses the default KMS key. However, RDS Custom doesn't use
|
1590
|
+
# the default key when this parameter is empty. You must explicitly
|
1591
|
+
# specify a key.
|
1567
1592
|
# @option options [String] :domain
|
1568
1593
|
# The Active Directory directory ID to create the DB instance in.
|
1569
1594
|
# Currently, only MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB
|
@@ -1992,7 +2017,7 @@ module Aws::RDS
|
|
1992
2017
|
# * Not specify a DB subnet group. All these read replicas are created
|
1993
2018
|
# outside of any VPC.
|
1994
2019
|
#
|
1995
|
-
# Example: `
|
2020
|
+
# Example: `mydbsubnetgroup`
|
1996
2021
|
# @option options [Array<String>] :vpc_security_group_ids
|
1997
2022
|
# A list of Amazon EC2 VPC security groups to associate with the read
|
1998
2023
|
# replica.
|
@@ -2489,7 +2514,7 @@ module Aws::RDS
|
|
2489
2514
|
# change. The change is applied during the next maintenance window,
|
2490
2515
|
# unless `ApplyImmediately` is enabled for this request.
|
2491
2516
|
#
|
2492
|
-
# This setting doesn't apply to RDS Custom.
|
2517
|
+
# This setting doesn't apply to RDS Custom for Oracle.
|
2493
2518
|
#
|
2494
2519
|
# Default: Uses existing setting
|
2495
2520
|
#
|
@@ -2512,7 +2537,7 @@ module Aws::RDS
|
|
2512
2537
|
# Constraints: If supplied, must match the name of an existing
|
2513
2538
|
# DBSubnetGroup.
|
2514
2539
|
#
|
2515
|
-
# Example: `
|
2540
|
+
# Example: `mydbsubnetgroup`
|
2516
2541
|
#
|
2517
2542
|
#
|
2518
2543
|
#
|
@@ -2556,7 +2581,7 @@ module Aws::RDS
|
|
2556
2581
|
# during the next maintenance window. Some parameter changes can cause
|
2557
2582
|
# an outage and are applied on the next call to RebootDBInstance, or the
|
2558
2583
|
# next failure reboot. Review the table of parameters in [Modifying a DB
|
2559
|
-
# Instance][1] in the *Amazon RDS User Guide
|
2584
|
+
# Instance][1] in the *Amazon RDS User Guide* to see the impact of
|
2560
2585
|
# enabling or disabling `ApplyImmediately` for each modified parameter
|
2561
2586
|
# and to determine when the changes are applied.
|
2562
2587
|
#
|
@@ -2653,7 +2678,7 @@ module Aws::RDS
|
|
2653
2678
|
#
|
2654
2679
|
# * It must be a value from 0 to 35. It can't be set to 0 if the DB
|
2655
2680
|
# instance is a source to read replicas. It can't be set to 0 or 35
|
2656
|
-
# for an RDS Custom DB instance.
|
2681
|
+
# for an RDS Custom for Oracle DB instance.
|
2657
2682
|
#
|
2658
2683
|
# * It can be specified for a MySQL read replica only if the source is
|
2659
2684
|
# running MySQL 5.6 or later.
|
@@ -2736,8 +2761,8 @@ module Aws::RDS
|
|
2736
2761
|
# lower. For information about valid engine versions, see
|
2737
2762
|
# `CreateDBInstance`, or call `DescribeDBEngineVersions`.
|
2738
2763
|
#
|
2739
|
-
# In RDS Custom, this parameter is supported for read
|
2740
|
-
# they are in the `PATCH_DB_FAILURE` lifecycle.
|
2764
|
+
# In RDS Custom for Oracle, this parameter is supported for read
|
2765
|
+
# replicas only if they are in the `PATCH_DB_FAILURE` lifecycle.
|
2741
2766
|
# @option options [Boolean] :allow_major_version_upgrade
|
2742
2767
|
# A value that indicates whether major version upgrades are allowed.
|
2743
2768
|
# Changing this parameter doesn't result in an outage and the change is
|
@@ -2983,8 +3008,6 @@ module Aws::RDS
|
|
2983
3008
|
#
|
2984
3009
|
# Changes to the `PubliclyAccessible` parameter are applied immediately
|
2985
3010
|
# regardless of the value of the `ApplyImmediately` parameter.
|
2986
|
-
#
|
2987
|
-
# This setting doesn't apply to RDS Custom.
|
2988
3011
|
# @option options [String] :monitoring_role_arn
|
2989
3012
|
# The ARN for the IAM role that permits RDS to send enhanced monitoring
|
2990
3013
|
# metrics to Amazon CloudWatch Logs. For example,
|
@@ -3394,7 +3417,7 @@ module Aws::RDS
|
|
3394
3417
|
# Constraints: If supplied, must match the name of an existing
|
3395
3418
|
# DBSubnetGroup.
|
3396
3419
|
#
|
3397
|
-
# Example: `
|
3420
|
+
# Example: `mydbsubnetgroup`
|
3398
3421
|
# @option options [Boolean] :multi_az
|
3399
3422
|
# A value that indicates whether the DB instance is a Multi-AZ
|
3400
3423
|
# deployment.
|
@@ -228,7 +228,8 @@ module Aws::RDS
|
|
228
228
|
#
|
229
229
|
# * `aurora` (for MySQL 5.6-compatible Aurora)
|
230
230
|
#
|
231
|
-
# * `aurora-mysql` (for MySQL 5.7-compatible
|
231
|
+
# * `aurora-mysql` (for MySQL 5.7-compatible and MySQL 8.0-compatible
|
232
|
+
# Aurora)
|
232
233
|
#
|
233
234
|
# * `aurora-postgresql`
|
234
235
|
#
|
@@ -349,25 +350,35 @@ module Aws::RDS
|
|
349
350
|
# @option options [required, Array<Types::Parameter>] :parameters
|
350
351
|
# An array of parameter names, values, and the application methods for
|
351
352
|
# the parameter update. At least one parameter name, value, and
|
352
|
-
# application method
|
353
|
-
#
|
354
|
-
# request.
|
353
|
+
# application method must be supplied; later arguments are optional. A
|
354
|
+
# maximum of 20 parameters can be modified in a single request.
|
355
355
|
#
|
356
356
|
# Valid Values (for the application method): `immediate |
|
357
357
|
# pending-reboot`
|
358
358
|
#
|
359
|
-
#
|
359
|
+
# You can use the `immediate` value with dynamic parameters only. You
|
360
360
|
# can use the `pending-reboot` value for both dynamic and static
|
361
361
|
# parameters.
|
362
362
|
#
|
363
|
-
#
|
363
|
+
# When the application method is `immediate`, changes to dynamic
|
364
364
|
# parameters are applied immediately to the DB instances associated with
|
365
|
-
# the parameter group.
|
366
|
-
#
|
367
|
-
#
|
368
|
-
#
|
365
|
+
# the parameter group.
|
366
|
+
#
|
367
|
+
# When the application method is `pending-reboot`, changes to dynamic
|
368
|
+
# and static parameters are applied after a reboot without failover to
|
369
|
+
# the DB instances associated with the parameter group.
|
370
|
+
#
|
371
|
+
# <note markdown="1"> You can't use `pending-reboot` with dynamic parameters on RDS for SQL
|
372
|
+
# Server DB instances. Use `immediate`.
|
369
373
|
#
|
370
374
|
# </note>
|
375
|
+
#
|
376
|
+
# For more information on modifying DB parameters, see [Working with DB
|
377
|
+
# parameter groups][1] in the *Amazon RDS User Guide*.
|
378
|
+
#
|
379
|
+
#
|
380
|
+
#
|
381
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithParamGroups.html
|
371
382
|
# @return [DBParameterGroup]
|
372
383
|
def modify(options = {})
|
373
384
|
options = options.merge(db_parameter_group_name: @name)
|
@@ -679,7 +679,7 @@ module Aws::RDS
|
|
679
679
|
# Constraints: If supplied, must match the name of an existing
|
680
680
|
# DBSubnetGroup.
|
681
681
|
#
|
682
|
-
# Example: `
|
682
|
+
# Example: `mydbsubnetgroup`
|
683
683
|
# @option options [Boolean] :multi_az
|
684
684
|
# A value that indicates whether the DB instance is a Multi-AZ
|
685
685
|
# deployment.
|
@@ -831,8 +831,21 @@ module Aws::RDS
|
|
831
831
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/kerberos-authentication.html
|
832
832
|
# @option options [Boolean] :copy_tags_to_snapshot
|
833
833
|
# A value that indicates whether to copy all tags from the restored DB
|
834
|
-
# instance to snapshots of the DB instance.
|
835
|
-
#
|
834
|
+
# instance to snapshots of the DB instance.
|
835
|
+
#
|
836
|
+
# In most cases, tags aren't copied by default. However, when you
|
837
|
+
# restore a DB instance from a DB snapshot, RDS checks whether you
|
838
|
+
# specify new tags. If yes, the new tags are added to the restored DB
|
839
|
+
# instance. If there are no new tags, RDS looks for the tags from the
|
840
|
+
# source DB instance for the DB snapshot, and then adds those tags to
|
841
|
+
# the restored DB instance.
|
842
|
+
#
|
843
|
+
# For more information, see [ Copying tags to DB instance snapshots][1]
|
844
|
+
# in the *Amazon RDS User Guide*.
|
845
|
+
#
|
846
|
+
#
|
847
|
+
#
|
848
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html#USER_Tagging.CopyTags
|
836
849
|
# @option options [String] :domain_iam_role_name
|
837
850
|
# Specify the name of the IAM role to be used when making API calls to
|
838
851
|
# the Directory Service.
|
@@ -935,8 +948,7 @@ module Aws::RDS
|
|
935
948
|
# start with the prefix `AWSRDSCustom`.
|
936
949
|
#
|
937
950
|
# For the list of permissions required for the IAM role, see [ Configure
|
938
|
-
# IAM and your VPC][1] in the *Amazon
|
939
|
-
# Guide*.
|
951
|
+
# IAM and your VPC][1] in the *Amazon RDS User Guide*.
|
940
952
|
#
|
941
953
|
# This setting is required for RDS Custom.
|
942
954
|
#
|
@@ -264,6 +264,9 @@ module Aws::RDS
|
|
264
264
|
#
|
265
265
|
# * If the source type is a DB cluster snapshot, a
|
266
266
|
# `DBClusterSnapshotIdentifier` value must be supplied.
|
267
|
+
#
|
268
|
+
# * If the source type is an RDS Proxy, a `DBProxyName` value must be
|
269
|
+
# supplied.
|
267
270
|
# @return [EventSubscription]
|
268
271
|
def add_subscriber(options = {})
|
269
272
|
options = options.merge(subscription_name: @name)
|
@@ -298,20 +301,24 @@ module Aws::RDS
|
|
298
301
|
# @option options [String] :source_type
|
299
302
|
# The type of source that is generating the events. For example, if you
|
300
303
|
# want to be notified of events generated by a DB instance, you set this
|
301
|
-
# parameter to `db-instance`.
|
302
|
-
# are returned.
|
304
|
+
# parameter to `db-instance`. For RDS Proxy events, specify `db-proxy`.
|
305
|
+
# If this value isn't specified, all events are returned.
|
303
306
|
#
|
304
307
|
# Valid values: `db-instance` \| `db-cluster` \| `db-parameter-group` \|
|
305
|
-
# `db-security-group` \| `db-snapshot` \| `db-cluster-snapshot`
|
308
|
+
# `db-security-group` \| `db-snapshot` \| `db-cluster-snapshot` \|
|
309
|
+
# `db-proxy`
|
306
310
|
# @option options [Array<String>] :event_categories
|
307
311
|
# A list of event categories for a particular source type (`SourceType`)
|
308
312
|
# that you want to subscribe to. You can see a list of the categories
|
309
|
-
# for a given source type in
|
310
|
-
#
|
313
|
+
# for a given source type in the "Amazon RDS event categories and event
|
314
|
+
# messages" section of the [ *Amazon RDS User Guide* ][1] or the [
|
315
|
+
# *Amazon Aurora User Guide* ][2]. You can also see this list by using
|
316
|
+
# the `DescribeEventCategories` operation.
|
311
317
|
#
|
312
318
|
#
|
313
319
|
#
|
314
|
-
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Events.html
|
320
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Events.Messages.html
|
321
|
+
# [2]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_Events.Messages.html
|
315
322
|
# @option options [Array<String>] :source_ids
|
316
323
|
# The list of identifiers of the event sources for which events are
|
317
324
|
# returned. If not specified, then all sources are included in the
|
@@ -340,6 +347,9 @@ module Aws::RDS
|
|
340
347
|
#
|
341
348
|
# * If the source type is a DB cluster snapshot, a
|
342
349
|
# `DBClusterSnapshotIdentifier` value must be supplied.
|
350
|
+
#
|
351
|
+
# * If the source type is an RDS Proxy, a `DBProxyName` value must be
|
352
|
+
# supplied.
|
343
353
|
# @option options [Boolean] :enabled
|
344
354
|
# A value that indicates whether to activate the subscription. If the
|
345
355
|
# event notification subscription isn't activated, the subscription is
|
@@ -393,11 +403,12 @@ module Aws::RDS
|
|
393
403
|
# @option options [String] :source_type
|
394
404
|
# The type of source that is generating the events. For example, if you
|
395
405
|
# want to be notified of events generated by a DB instance, you would
|
396
|
-
# set this parameter to db-instance.
|
397
|
-
# events are returned.
|
406
|
+
# set this parameter to db-instance. For RDS Proxy events, specify
|
407
|
+
# `db-proxy`. If this value isn't specified, all events are returned.
|
398
408
|
#
|
399
409
|
# Valid values: `db-instance` \| `db-cluster` \| `db-parameter-group` \|
|
400
|
-
# `db-security-group` \| `db-snapshot` \| `db-cluster-snapshot`
|
410
|
+
# `db-security-group` \| `db-snapshot` \| `db-cluster-snapshot` \|
|
411
|
+
# `db-proxy`
|
401
412
|
# @option options [Array<String>] :event_categories
|
402
413
|
# A list of event categories for a source type (`SourceType`) that you
|
403
414
|
# want to subscribe to. You can see a list of the categories for a given
|