aws-sdk-rds 1.128.0 → 1.129.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 +1279 -258
- data/lib/aws-sdk-rds/client_api.rb +93 -0
- data/lib/aws-sdk-rds/db_cluster.rb +30 -34
- data/lib/aws-sdk-rds/db_cluster_snapshot.rb +20 -24
- data/lib/aws-sdk-rds/db_engine.rb +8 -0
- data/lib/aws-sdk-rds/db_engine_version.rb +66 -4
- data/lib/aws-sdk-rds/db_instance.rb +514 -139
- data/lib/aws-sdk-rds/db_snapshot.rb +78 -30
- data/lib/aws-sdk-rds/errors.rb +44 -0
- data/lib/aws-sdk-rds/resource.rb +186 -59
- data/lib/aws-sdk-rds/types.rb +1058 -285
- data/lib/aws-sdk-rds.rb +1 -1
- metadata +2 -2
@@ -189,7 +189,8 @@ module Aws::RDS
|
|
189
189
|
data[:latest_restorable_time]
|
190
190
|
end
|
191
191
|
|
192
|
-
# Specifies if the DB instance is a Multi-AZ deployment.
|
192
|
+
# Specifies if the DB instance is a Multi-AZ deployment. This setting
|
193
|
+
# doesn't apply to RDS Custom.
|
193
194
|
# @return [Boolean]
|
194
195
|
def multi_az
|
195
196
|
data[:multi_az]
|
@@ -252,7 +253,8 @@ module Aws::RDS
|
|
252
253
|
data[:replica_mode]
|
253
254
|
end
|
254
255
|
|
255
|
-
# License model information for this DB instance.
|
256
|
+
# License model information for this DB instance. This setting doesn't
|
257
|
+
# apply to RDS Custom.
|
256
258
|
# @return [String]
|
257
259
|
def license_model
|
258
260
|
data[:license_model]
|
@@ -355,8 +357,7 @@ module Aws::RDS
|
|
355
357
|
# identifier for the encrypted DB instance.
|
356
358
|
#
|
357
359
|
# The Amazon Web Services KMS key identifier is the key ARN, key ID,
|
358
|
-
# alias ARN, or alias name for the
|
359
|
-
# master key (CMK).
|
360
|
+
# alias ARN, or alias name for the KMS key.
|
360
361
|
# @return [String]
|
361
362
|
def kms_key_id
|
362
363
|
data[:kms_key_id]
|
@@ -364,8 +365,8 @@ module Aws::RDS
|
|
364
365
|
|
365
366
|
# The Amazon Web Services Region-unique, immutable identifier for the DB
|
366
367
|
# instance. This identifier is found in Amazon Web Services CloudTrail
|
367
|
-
# log entries whenever the Amazon Web Services KMS
|
368
|
-
#
|
368
|
+
# log entries whenever the Amazon Web Services KMS key for the DB
|
369
|
+
# instance is accessed.
|
369
370
|
# @return [String]
|
370
371
|
def dbi_resource_id
|
371
372
|
data[:dbi_resource_id]
|
@@ -474,8 +475,7 @@ module Aws::RDS
|
|
474
475
|
# Performance Insights data.
|
475
476
|
#
|
476
477
|
# The Amazon Web Services KMS key identifier is the key ARN, key ID,
|
477
|
-
# alias ARN, or alias name for the
|
478
|
-
# master key (CMK).
|
478
|
+
# alias ARN, or alias name for the KMS key.
|
479
479
|
# @return [String]
|
480
480
|
def performance_insights_kms_key_id
|
481
481
|
data[:performance_insights_kms_key_id]
|
@@ -601,7 +601,7 @@ module Aws::RDS
|
|
601
601
|
# The Amazon Web Services KMS key identifier used for encrypting
|
602
602
|
# messages in the database activity stream. The Amazon Web Services KMS
|
603
603
|
# key identifier is the key ARN, key ID, alias ARN, or alias name for
|
604
|
-
# the
|
604
|
+
# the KMS key.
|
605
605
|
# @return [String]
|
606
606
|
def activity_stream_kms_key_id
|
607
607
|
data[:activity_stream_kms_key_id]
|
@@ -629,6 +629,47 @@ module Aws::RDS
|
|
629
629
|
data[:activity_stream_engine_native_audit_fields_included]
|
630
630
|
end
|
631
631
|
|
632
|
+
# The automation mode of the RDS Custom DB instance: `full` or `all
|
633
|
+
# paused`. If `full`, the DB instance automates monitoring and instance
|
634
|
+
# recovery. If `all paused`, the instance pauses automation for the
|
635
|
+
# duration set by `--resume-full-automation-mode-minutes`.
|
636
|
+
# @return [String]
|
637
|
+
def automation_mode
|
638
|
+
data[:automation_mode]
|
639
|
+
end
|
640
|
+
|
641
|
+
# The number of minutes to pause the automation. When the time period
|
642
|
+
# ends, RDS Custom resumes full automation. The minimum value is 60
|
643
|
+
# (default). The maximum value is 1,440.
|
644
|
+
# @return [Time]
|
645
|
+
def resume_full_automation_mode_time
|
646
|
+
data[:resume_full_automation_mode_time]
|
647
|
+
end
|
648
|
+
|
649
|
+
# The instance profile associated with the underlying Amazon EC2
|
650
|
+
# instance of an RDS Custom DB instance. The instance profile must meet
|
651
|
+
# the following requirements:
|
652
|
+
#
|
653
|
+
# * The profile must exist in your account.
|
654
|
+
#
|
655
|
+
# * The profile must have an IAM role that Amazon EC2 has permissions to
|
656
|
+
# assume.
|
657
|
+
#
|
658
|
+
# * The instance profile name and the associated IAM role name must
|
659
|
+
# start with the prefix `AWSRDSCustom`.
|
660
|
+
#
|
661
|
+
# For the list of permissions required for the IAM role, see [ Configure
|
662
|
+
# IAM and your VPC][1] in the *Amazon Relational Database Service User
|
663
|
+
# Guide*.
|
664
|
+
#
|
665
|
+
#
|
666
|
+
#
|
667
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-setup-orcl.html#custom-setup-orcl.iam-vpc
|
668
|
+
# @return [String]
|
669
|
+
def custom_iam_instance_profile
|
670
|
+
data[:custom_iam_instance_profile]
|
671
|
+
end
|
672
|
+
|
632
673
|
# @!endgroup
|
633
674
|
|
634
675
|
# @return [Client]
|
@@ -823,6 +864,7 @@ module Aws::RDS
|
|
823
864
|
# deletion_protection: false,
|
824
865
|
# max_allocated_storage: 1,
|
825
866
|
# enable_customer_owned_ip: false,
|
867
|
+
# custom_iam_instance_profile: "String",
|
826
868
|
# })
|
827
869
|
# @param [Hash] options ({})
|
828
870
|
# @option options [String] :db_name
|
@@ -888,6 +930,21 @@ module Aws::RDS
|
|
888
930
|
#
|
889
931
|
# ^
|
890
932
|
#
|
933
|
+
# **Amazon RDS Custom**
|
934
|
+
#
|
935
|
+
# The Oracle System ID (SID) of the created RDS Custom DB instance. If
|
936
|
+
# you don't specify a value, the default value is `ORCL`.
|
937
|
+
#
|
938
|
+
# Default: `ORCL`
|
939
|
+
#
|
940
|
+
# Constraints:
|
941
|
+
#
|
942
|
+
# * It must contain 1 to 8 alphanumeric characters.
|
943
|
+
#
|
944
|
+
# * It must contain a letter.
|
945
|
+
#
|
946
|
+
# * It can't be a word reserved by the database engine.
|
947
|
+
#
|
891
948
|
# **SQL Server**
|
892
949
|
#
|
893
950
|
# Not applicable. Must be null.
|
@@ -932,6 +989,16 @@ module Aws::RDS
|
|
932
989
|
# amount of data in your database increases, though you are only charged
|
933
990
|
# for the space that you use in an Aurora cluster volume.
|
934
991
|
#
|
992
|
+
# **Amazon RDS Custom**
|
993
|
+
#
|
994
|
+
# Constraints to the amount of storage for each storage type are the
|
995
|
+
# following:
|
996
|
+
#
|
997
|
+
# * General Purpose (SSD) storage (gp2): Must be an integer from 40 to
|
998
|
+
# 65536.
|
999
|
+
#
|
1000
|
+
# * Provisioned IOPS storage (io1): Must be an integer from 40 to 65536.
|
1001
|
+
#
|
935
1002
|
# **MySQL**
|
936
1003
|
#
|
937
1004
|
# Constraints to the amount of storage for each storage type are the
|
@@ -1033,6 +1100,8 @@ module Aws::RDS
|
|
1033
1100
|
#
|
1034
1101
|
# * `aurora-postgresql`
|
1035
1102
|
#
|
1103
|
+
# * `custom-oracle-ee (for RDS Custom instances)`
|
1104
|
+
#
|
1036
1105
|
# * `mariadb`
|
1037
1106
|
#
|
1038
1107
|
# * `mysql`
|
@@ -1217,6 +1286,8 @@ module Aws::RDS
|
|
1217
1286
|
# If you do not specify a value, then the default DB parameter group for
|
1218
1287
|
# the specified DB engine and version is used.
|
1219
1288
|
#
|
1289
|
+
# This setting doesn't apply to RDS Custom.
|
1290
|
+
#
|
1220
1291
|
# Constraints:
|
1221
1292
|
#
|
1222
1293
|
# * Must be 1 to 255 letters, numbers, or hyphens.
|
@@ -1241,6 +1312,8 @@ module Aws::RDS
|
|
1241
1312
|
# * Must be a value from 0 to 35
|
1242
1313
|
#
|
1243
1314
|
# * Can't be set to 0 if the DB instance is a source to read replicas
|
1315
|
+
#
|
1316
|
+
# * Can't be set to 0 or 35 for an RDS Custom DB instance
|
1244
1317
|
# @option options [String] :preferred_backup_window
|
1245
1318
|
# The daily time range during which automated backups are created if
|
1246
1319
|
# automated backups are enabled, using the `BackupRetentionPeriod`
|
@@ -1317,6 +1390,8 @@ module Aws::RDS
|
|
1317
1390
|
# A value that indicates whether the DB instance is a Multi-AZ
|
1318
1391
|
# deployment. You can't set the `AvailabilityZone` parameter if the DB
|
1319
1392
|
# instance is a Multi-AZ deployment.
|
1393
|
+
#
|
1394
|
+
# This setting doesn't apply to RDS Custom.
|
1320
1395
|
# @option options [String] :engine_version
|
1321
1396
|
# The version number of the database engine to use.
|
1322
1397
|
#
|
@@ -1333,46 +1408,60 @@ module Aws::RDS
|
|
1333
1408
|
# Not applicable. The version number of the database engine to be used
|
1334
1409
|
# by the DB instance is managed by the DB cluster.
|
1335
1410
|
#
|
1411
|
+
# **Amazon RDS Custom**
|
1412
|
+
#
|
1413
|
+
# A custom engine version (CEV) that you have previously created. This
|
1414
|
+
# setting is required for RDS Custom. The CEV name has the following
|
1415
|
+
# format: `19.customized_string `. An example identifier is
|
1416
|
+
# `19.my_cev1`. For more information, see [ Creating an RDS Custom DB
|
1417
|
+
# instance][1] in the *Amazon RDS User Guide.*.
|
1418
|
+
#
|
1336
1419
|
# **MariaDB**
|
1337
1420
|
#
|
1338
|
-
# See [MariaDB on Amazon RDS Versions][
|
1421
|
+
# See [MariaDB on Amazon RDS Versions][2] in the *Amazon RDS User
|
1339
1422
|
# Guide.*
|
1340
1423
|
#
|
1341
1424
|
# **Microsoft SQL Server**
|
1342
1425
|
#
|
1343
|
-
# See [Microsoft SQL Server Versions on Amazon RDS][
|
1426
|
+
# See [Microsoft SQL Server Versions on Amazon RDS][3] in the *Amazon
|
1344
1427
|
# RDS User Guide.*
|
1345
1428
|
#
|
1346
1429
|
# **MySQL**
|
1347
1430
|
#
|
1348
|
-
# See [MySQL on Amazon RDS Versions][
|
1431
|
+
# See [MySQL on Amazon RDS Versions][4] in the *Amazon RDS User Guide.*
|
1349
1432
|
#
|
1350
1433
|
# **Oracle**
|
1351
1434
|
#
|
1352
|
-
# See [Oracle Database Engine Release Notes][
|
1435
|
+
# See [Oracle Database Engine Release Notes][5] in the *Amazon RDS User
|
1353
1436
|
# Guide.*
|
1354
1437
|
#
|
1355
1438
|
# **PostgreSQL**
|
1356
1439
|
#
|
1357
|
-
# See [Amazon RDS for PostgreSQL versions and extensions][
|
1440
|
+
# See [Amazon RDS for PostgreSQL versions and extensions][6] in the
|
1358
1441
|
# *Amazon RDS User Guide.*
|
1359
1442
|
#
|
1360
1443
|
#
|
1361
1444
|
#
|
1362
|
-
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/
|
1363
|
-
# [2]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/
|
1364
|
-
# [3]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/
|
1365
|
-
# [4]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/
|
1366
|
-
# [5]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/
|
1445
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-creating.html#custom-creating.create
|
1446
|
+
# [2]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_MariaDB.html#MariaDB.Concepts.VersionMgmt
|
1447
|
+
# [3]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_SQLServer.html#SQLServer.Concepts.General.VersionSupport
|
1448
|
+
# [4]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_MySQL.html#MySQL.Concepts.VersionMgmt
|
1449
|
+
# [5]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Appendix.Oracle.PatchComposition.html
|
1450
|
+
# [6]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_PostgreSQL.html#PostgreSQL.Concepts
|
1367
1451
|
# @option options [Boolean] :auto_minor_version_upgrade
|
1368
1452
|
# A value that indicates whether minor engine upgrades are applied
|
1369
1453
|
# automatically to the DB instance during the maintenance window. By
|
1370
1454
|
# default, minor engine upgrades are applied automatically.
|
1455
|
+
#
|
1456
|
+
# If you create an RDS Custom DB instance, you must set
|
1457
|
+
# `AutoMinorVersionUpgrade` to `false`.
|
1371
1458
|
# @option options [String] :license_model
|
1372
1459
|
# License model information for this DB instance.
|
1373
1460
|
#
|
1374
1461
|
# Valid values: `license-included` \| `bring-your-own-license` \|
|
1375
1462
|
# `general-public-license`
|
1463
|
+
#
|
1464
|
+
# This setting doesn't apply to RDS Custom.
|
1376
1465
|
# @option options [Integer] :iops
|
1377
1466
|
# The amount of Provisioned IOPS (input/output operations per second) to
|
1378
1467
|
# be initially allocated for the DB instance. For information about
|
@@ -1393,11 +1482,16 @@ module Aws::RDS
|
|
1393
1482
|
#
|
1394
1483
|
# Permanent options, such as the TDE option for Oracle Advanced Security
|
1395
1484
|
# TDE, can't be removed from an option group. Also, that option group
|
1396
|
-
# can't be removed from a DB instance
|
1397
|
-
# instance
|
1485
|
+
# can't be removed from a DB instance after it is associated with a DB
|
1486
|
+
# instance.
|
1487
|
+
#
|
1488
|
+
# This setting doesn't apply to RDS Custom.
|
1398
1489
|
# @option options [String] :character_set_name
|
1399
|
-
# For supported engines, indicates that the DB instance
|
1400
|
-
# associated with the specified CharacterSet
|
1490
|
+
# For supported engines, this value indicates that the DB instance
|
1491
|
+
# should be associated with the specified `CharacterSet`.
|
1492
|
+
#
|
1493
|
+
# This setting doesn't apply to RDS Custom. However, if you need to
|
1494
|
+
# change the character set, you can change it on the database itself.
|
1401
1495
|
#
|
1402
1496
|
# **Amazon Aurora**
|
1403
1497
|
#
|
@@ -1405,6 +1499,8 @@ module Aws::RDS
|
|
1405
1499
|
# more information, see `CreateDBCluster`.
|
1406
1500
|
# @option options [String] :nchar_character_set_name
|
1407
1501
|
# The name of the NCHAR character set for the Oracle DB instance.
|
1502
|
+
#
|
1503
|
+
# This parameter doesn't apply to RDS Custom.
|
1408
1504
|
# @option options [Boolean] :publicly_accessible
|
1409
1505
|
# A value that indicates whether the DB instance is publicly accessible.
|
1410
1506
|
#
|
@@ -1442,6 +1538,8 @@ module Aws::RDS
|
|
1442
1538
|
# Tags to assign to the DB instance.
|
1443
1539
|
# @option options [String] :db_cluster_identifier
|
1444
1540
|
# The identifier of the DB cluster that the instance will belong to.
|
1541
|
+
#
|
1542
|
+
# This setting doesn't apply to RDS Custom.
|
1445
1543
|
# @option options [String] :storage_type
|
1446
1544
|
# Specifies the storage type to be associated with the DB instance.
|
1447
1545
|
#
|
@@ -1454,13 +1552,21 @@ module Aws::RDS
|
|
1454
1552
|
# @option options [String] :tde_credential_arn
|
1455
1553
|
# The ARN from the key store with which to associate the instance for
|
1456
1554
|
# TDE encryption.
|
1555
|
+
#
|
1556
|
+
# This setting doesn't apply to RDS Custom.
|
1457
1557
|
# @option options [String] :tde_credential_password
|
1458
1558
|
# The password for the given ARN from the key store in order to access
|
1459
1559
|
# the device.
|
1560
|
+
#
|
1561
|
+
# This setting doesn't apply to RDS Custom.
|
1460
1562
|
# @option options [Boolean] :storage_encrypted
|
1461
1563
|
# A value that indicates whether the DB instance is encrypted. By
|
1462
1564
|
# default, it isn't encrypted.
|
1463
1565
|
#
|
1566
|
+
# For RDS Custom Oracle instances, either set this parameter to `true`
|
1567
|
+
# or leave it unset. If you set this parameter to `false`, RDS reports
|
1568
|
+
# an error.
|
1569
|
+
#
|
1464
1570
|
# **Amazon Aurora**
|
1465
1571
|
#
|
1466
1572
|
# Not applicable. The encryption for DB instances is managed by the DB
|
@@ -1470,9 +1576,9 @@ module Aws::RDS
|
|
1470
1576
|
# instance.
|
1471
1577
|
#
|
1472
1578
|
# The Amazon Web Services KMS key identifier is the key ARN, key ID,
|
1473
|
-
# alias ARN, or alias name for the
|
1474
|
-
#
|
1475
|
-
#
|
1579
|
+
# alias ARN, or alias name for the KMS key. To use a KMS key in a
|
1580
|
+
# different Amazon Web Services account, specify the key ARN or alias
|
1581
|
+
# ARN.
|
1476
1582
|
#
|
1477
1583
|
# **Amazon Aurora**
|
1478
1584
|
#
|
@@ -1480,10 +1586,18 @@ module Aws::RDS
|
|
1480
1586
|
# by the DB cluster. For more information, see `CreateDBCluster`.
|
1481
1587
|
#
|
1482
1588
|
# If `StorageEncrypted` is enabled, and you do not specify a value for
|
1483
|
-
# the `KmsKeyId` parameter, then Amazon RDS uses your default
|
1484
|
-
# is a default
|
1485
|
-
# Services account has a different default
|
1486
|
-
# Services Region.
|
1589
|
+
# the `KmsKeyId` parameter, then Amazon RDS uses your default KMS key.
|
1590
|
+
# There is a default KMS key for your Amazon Web Services account. Your
|
1591
|
+
# Amazon Web Services account has a different default KMS key for each
|
1592
|
+
# Amazon Web Services Region.
|
1593
|
+
#
|
1594
|
+
# **Amazon RDS Custom**
|
1595
|
+
#
|
1596
|
+
# A KMS key is required for RDS Custom Oracle instances. For most RDS
|
1597
|
+
# engines, if you leave this parameter empty while enabling
|
1598
|
+
# `StorageEncrypted`, the engine uses the default KMS key. However, RDS
|
1599
|
+
# Custom for Oracle doesn't use the default key when this parameter is
|
1600
|
+
# empty. You must explicitly specify a key.
|
1487
1601
|
# @option options [String] :domain
|
1488
1602
|
# The Active Directory directory ID to create the DB instance in.
|
1489
1603
|
# Currently, only MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB
|
@@ -1492,6 +1606,8 @@ module Aws::RDS
|
|
1492
1606
|
# For more information, see [ Kerberos Authentication][1] in the *Amazon
|
1493
1607
|
# RDS User Guide*.
|
1494
1608
|
#
|
1609
|
+
# This setting doesn't apply to RDS Custom.
|
1610
|
+
#
|
1495
1611
|
#
|
1496
1612
|
#
|
1497
1613
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/kerberos-authentication.html
|
@@ -1506,35 +1622,43 @@ module Aws::RDS
|
|
1506
1622
|
# the DB cluster setting.
|
1507
1623
|
# @option options [Integer] :monitoring_interval
|
1508
1624
|
# The interval, in seconds, between points when Enhanced Monitoring
|
1509
|
-
# metrics are collected for the DB instance. To disable
|
1625
|
+
# metrics are collected for the DB instance. To disable collection of
|
1510
1626
|
# Enhanced Monitoring metrics, specify 0. The default is 0.
|
1511
1627
|
#
|
1512
|
-
# If `MonitoringRoleArn` is specified, then you must
|
1628
|
+
# If `MonitoringRoleArn` is specified, then you must set
|
1513
1629
|
# `MonitoringInterval` to a value other than 0.
|
1514
1630
|
#
|
1631
|
+
# This setting doesn't apply to RDS Custom.
|
1632
|
+
#
|
1515
1633
|
# Valid Values: `0, 1, 5, 10, 15, 30, 60`
|
1516
1634
|
# @option options [String] :monitoring_role_arn
|
1517
1635
|
# The ARN for the IAM role that permits RDS to send enhanced monitoring
|
1518
1636
|
# metrics to Amazon CloudWatch Logs. For example,
|
1519
1637
|
# `arn:aws:iam:123456789012:role/emaccess`. For information on creating
|
1520
|
-
# a monitoring role,
|
1638
|
+
# a monitoring role, see [Setting Up and Enabling Enhanced
|
1521
1639
|
# Monitoring][1] in the *Amazon RDS User Guide*.
|
1522
1640
|
#
|
1523
1641
|
# If `MonitoringInterval` is set to a value other than 0, then you must
|
1524
1642
|
# supply a `MonitoringRoleArn` value.
|
1525
1643
|
#
|
1644
|
+
# This setting doesn't apply to RDS Custom.
|
1645
|
+
#
|
1526
1646
|
#
|
1527
1647
|
#
|
1528
1648
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Monitoring.OS.html#USER_Monitoring.OS.Enabling
|
1529
1649
|
# @option options [String] :domain_iam_role_name
|
1530
1650
|
# Specify the name of the IAM role to be used when making API calls to
|
1531
1651
|
# the Directory Service.
|
1652
|
+
#
|
1653
|
+
# This setting doesn't apply to RDS Custom.
|
1532
1654
|
# @option options [Integer] :promotion_tier
|
1533
1655
|
# A value that specifies the order in which an Aurora Replica is
|
1534
1656
|
# promoted to the primary instance after a failure of the existing
|
1535
1657
|
# primary instance. For more information, see [ Fault Tolerance for an
|
1536
1658
|
# Aurora DB Cluster][1] in the *Amazon Aurora User Guide*.
|
1537
1659
|
#
|
1660
|
+
# This setting doesn't apply to RDS Custom.
|
1661
|
+
#
|
1538
1662
|
# Default: 1
|
1539
1663
|
#
|
1540
1664
|
# Valid Values: 0 - 15
|
@@ -1554,9 +1678,9 @@ module Aws::RDS
|
|
1554
1678
|
# Services Identity and Access Management (IAM) accounts to database
|
1555
1679
|
# accounts. By default, mapping is disabled.
|
1556
1680
|
#
|
1557
|
-
# This setting doesn't apply to Amazon Aurora.
|
1558
|
-
# Services IAM accounts to database accounts is
|
1559
|
-
# cluster.
|
1681
|
+
# This setting doesn't apply to RDS Custom or Amazon Aurora. In Aurora,
|
1682
|
+
# mapping Amazon Web Services IAM accounts to database accounts is
|
1683
|
+
# managed by the DB cluster.
|
1560
1684
|
#
|
1561
1685
|
# For more information, see [ IAM Database Authentication for MySQL and
|
1562
1686
|
# PostgreSQL][1] in the *Amazon RDS User Guide.*
|
@@ -1566,10 +1690,10 @@ module Aws::RDS
|
|
1566
1690
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.IAMDBAuth.html
|
1567
1691
|
# @option options [Boolean] :enable_performance_insights
|
1568
1692
|
# A value that indicates whether to enable Performance Insights for the
|
1569
|
-
# DB instance.
|
1693
|
+
# DB instance. For more information, see [Using Amazon Performance
|
1694
|
+
# Insights][1] in the *Amazon Relational Database Service User Guide*.
|
1570
1695
|
#
|
1571
|
-
#
|
1572
|
-
# the *Amazon Relational Database Service User Guide*.
|
1696
|
+
# This setting doesn't apply to RDS Custom.
|
1573
1697
|
#
|
1574
1698
|
#
|
1575
1699
|
#
|
@@ -1579,27 +1703,33 @@ module Aws::RDS
|
|
1579
1703
|
# Performance Insights data.
|
1580
1704
|
#
|
1581
1705
|
# The Amazon Web Services KMS key identifier is the key ARN, key ID,
|
1582
|
-
# alias ARN, or alias name for the
|
1583
|
-
# master key (CMK).
|
1706
|
+
# alias ARN, or alias name for the KMS key.
|
1584
1707
|
#
|
1585
1708
|
# If you do not specify a value for `PerformanceInsightsKMSKeyId`, then
|
1586
|
-
# Amazon RDS uses your default
|
1587
|
-
# Amazon Web Services account. Your Amazon Web Services account has
|
1588
|
-
# different default
|
1709
|
+
# Amazon RDS uses your default KMS key. There is a default KMS key for
|
1710
|
+
# your Amazon Web Services account. Your Amazon Web Services account has
|
1711
|
+
# a different default KMS key for each Amazon Web Services Region.
|
1712
|
+
#
|
1713
|
+
# This setting doesn't apply to RDS Custom.
|
1589
1714
|
# @option options [Integer] :performance_insights_retention_period
|
1590
1715
|
# The amount of time, in days, to retain Performance Insights data.
|
1591
1716
|
# Valid values are 7 or 731 (2 years).
|
1717
|
+
#
|
1718
|
+
# This setting doesn't apply to RDS Custom.
|
1592
1719
|
# @option options [Array<String>] :enable_cloudwatch_logs_exports
|
1593
1720
|
# The list of log types that need to be enabled for exporting to
|
1594
|
-
# CloudWatch Logs. The values in the list depend on the DB engine
|
1595
|
-
#
|
1596
|
-
#
|
1597
|
-
# Guide*.
|
1721
|
+
# CloudWatch Logs. The values in the list depend on the DB engine. For
|
1722
|
+
# more information, see [Publishing Database Logs to Amazon CloudWatch
|
1723
|
+
# Logs][1] in the *Amazon Relational Database Service User Guide*.
|
1598
1724
|
#
|
1599
1725
|
# **Amazon Aurora**
|
1600
1726
|
#
|
1601
1727
|
# Not applicable. CloudWatch Logs exports are managed by the DB cluster.
|
1602
1728
|
#
|
1729
|
+
# **RDS Custom**
|
1730
|
+
#
|
1731
|
+
# Not applicable.
|
1732
|
+
#
|
1603
1733
|
# **MariaDB**
|
1604
1734
|
#
|
1605
1735
|
# Possible values are `audit`, `error`, `general`, and `slowquery`.
|
@@ -1627,6 +1757,8 @@ module Aws::RDS
|
|
1627
1757
|
# @option options [Array<Types::ProcessorFeature>] :processor_features
|
1628
1758
|
# The number of CPU cores and the number of threads per core for the DB
|
1629
1759
|
# instance class of the DB instance.
|
1760
|
+
#
|
1761
|
+
# This setting doesn't apply to RDS Custom.
|
1630
1762
|
# @option options [Boolean] :deletion_protection
|
1631
1763
|
# A value that indicates whether the DB instance has deletion protection
|
1632
1764
|
# enabled. The database can't be deleted when deletion protection is
|
@@ -1651,6 +1783,8 @@ module Aws::RDS
|
|
1651
1783
|
# apply to it, see [ Managing capacity automatically with Amazon RDS
|
1652
1784
|
# storage autoscaling][1] in the *Amazon RDS User Guide*.
|
1653
1785
|
#
|
1786
|
+
# This setting doesn't apply to RDS Custom.
|
1787
|
+
#
|
1654
1788
|
#
|
1655
1789
|
#
|
1656
1790
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PIOPS.StorageTypes.html#USER_PIOPS.Autoscaling
|
@@ -1674,6 +1808,28 @@ module Aws::RDS
|
|
1674
1808
|
#
|
1675
1809
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html
|
1676
1810
|
# [2]: https://docs.aws.amazon.com/outposts/latest/userguide/outposts-networking-components.html#ip-addressing
|
1811
|
+
# @option options [String] :custom_iam_instance_profile
|
1812
|
+
# The instance profile associated with the underlying Amazon EC2
|
1813
|
+
# instance of an RDS Custom DB instance. The instance profile must meet
|
1814
|
+
# the following requirements:
|
1815
|
+
#
|
1816
|
+
# * The profile must exist in your account.
|
1817
|
+
#
|
1818
|
+
# * The profile must have an IAM role that Amazon EC2 has permissions to
|
1819
|
+
# assume.
|
1820
|
+
#
|
1821
|
+
# * The instance profile name and the associated IAM role name must
|
1822
|
+
# start with the prefix `AWSRDSCustom`.
|
1823
|
+
#
|
1824
|
+
# For the list of permissions required for the IAM role, see [ Configure
|
1825
|
+
# IAM and your VPC][1] in the *Amazon Relational Database Service User
|
1826
|
+
# Guide*.
|
1827
|
+
#
|
1828
|
+
# This setting is required for RDS Custom.
|
1829
|
+
#
|
1830
|
+
#
|
1831
|
+
#
|
1832
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-setup-orcl.html#custom-setup-orcl.iam-vpc
|
1677
1833
|
# @return [DBInstance]
|
1678
1834
|
def create(options = {})
|
1679
1835
|
options = options.merge(db_instance_identifier: @id)
|
@@ -1729,6 +1885,7 @@ module Aws::RDS
|
|
1729
1885
|
# domain_iam_role_name: "String",
|
1730
1886
|
# replica_mode: "open-read-only", # accepts open-read-only, mounted
|
1731
1887
|
# max_allocated_storage: 1,
|
1888
|
+
# custom_iam_instance_profile: "String",
|
1732
1889
|
# source_region: "String",
|
1733
1890
|
# })
|
1734
1891
|
# @param [Hash] options ({})
|
@@ -1770,10 +1927,14 @@ module Aws::RDS
|
|
1770
1927
|
# support for the replica. Creating your read replica as a Multi-AZ DB
|
1771
1928
|
# instance is independent of whether the source database is a Multi-AZ
|
1772
1929
|
# DB instance.
|
1930
|
+
#
|
1931
|
+
# This setting doesn't apply to RDS Custom.
|
1773
1932
|
# @option options [Boolean] :auto_minor_version_upgrade
|
1774
1933
|
# A value that indicates whether minor engine upgrades are applied
|
1775
1934
|
# automatically to the read replica during the maintenance window.
|
1776
1935
|
#
|
1936
|
+
# This setting doesn't apply to RDS Custom.
|
1937
|
+
#
|
1777
1938
|
# Default: Inherits from the source DB instance
|
1778
1939
|
# @option options [Integer] :iops
|
1779
1940
|
# The amount of Provisioned IOPS (input/output operations per second) to
|
@@ -1786,6 +1947,8 @@ module Aws::RDS
|
|
1786
1947
|
# source instance.
|
1787
1948
|
#
|
1788
1949
|
# </note>
|
1950
|
+
#
|
1951
|
+
# This setting doesn't apply to RDS Custom.
|
1789
1952
|
# @option options [String] :db_parameter_group_name
|
1790
1953
|
# The name of the DB parameter group to associate with this DB instance.
|
1791
1954
|
#
|
@@ -1794,10 +1957,8 @@ module Aws::RDS
|
|
1794
1957
|
# region read replica, or the default `DBParameterGroup` for the
|
1795
1958
|
# specified DB engine for a cross region read replica.
|
1796
1959
|
#
|
1797
|
-
#
|
1798
|
-
#
|
1799
|
-
#
|
1800
|
-
# </note>
|
1960
|
+
# Specifying a parameter group for this operation is only supported for
|
1961
|
+
# Oracle DB instances. It isn't supported for RDS Custom.
|
1801
1962
|
#
|
1802
1963
|
# Constraints:
|
1803
1964
|
#
|
@@ -1854,7 +2015,10 @@ module Aws::RDS
|
|
1854
2015
|
#
|
1855
2016
|
# Example: `mySubnetgroup`
|
1856
2017
|
# @option options [Array<String>] :vpc_security_group_ids
|
1857
|
-
# A list of EC2 VPC security groups to associate with the read
|
2018
|
+
# A list of Amazon EC2 VPC security groups to associate with the read
|
2019
|
+
# replica.
|
2020
|
+
#
|
2021
|
+
# This setting doesn't apply to RDS Custom.
|
1858
2022
|
#
|
1859
2023
|
# Default: The default EC2 VPC security group for the DB subnet group's
|
1860
2024
|
# VPC.
|
@@ -1878,6 +2042,8 @@ module Aws::RDS
|
|
1878
2042
|
# If `MonitoringRoleArn` is specified, then you must also set
|
1879
2043
|
# `MonitoringInterval` to a value other than 0.
|
1880
2044
|
#
|
2045
|
+
# This setting doesn't apply to RDS Custom.
|
2046
|
+
#
|
1881
2047
|
# Valid Values: `0, 1, 5, 10, 15, 30, 60`
|
1882
2048
|
# @option options [String] :monitoring_role_arn
|
1883
2049
|
# The ARN for the IAM role that permits RDS to send enhanced monitoring
|
@@ -1889,6 +2055,8 @@ module Aws::RDS
|
|
1889
2055
|
# If `MonitoringInterval` is set to a value other than 0, then you must
|
1890
2056
|
# supply a `MonitoringRoleArn` value.
|
1891
2057
|
#
|
2058
|
+
# This setting doesn't apply to RDS Custom.
|
2059
|
+
#
|
1892
2060
|
#
|
1893
2061
|
#
|
1894
2062
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Monitoring.html#USER_Monitoring.OS.IAMRole
|
@@ -1897,23 +2065,26 @@ module Aws::RDS
|
|
1897
2065
|
# replica.
|
1898
2066
|
#
|
1899
2067
|
# The Amazon Web Services KMS key identifier is the key ARN, key ID,
|
1900
|
-
# alias ARN, or alias name for the
|
2068
|
+
# alias ARN, or alias name for the KMS key.
|
1901
2069
|
#
|
1902
2070
|
# If you create an encrypted read replica in the same Amazon Web
|
1903
2071
|
# Services Region as the source DB instance, then do not specify a value
|
1904
|
-
# for this parameter. A read replica in the same
|
1905
|
-
# encrypted with the same
|
2072
|
+
# for this parameter. A read replica in the same Amazon Web Services
|
2073
|
+
# Region is always encrypted with the same KMS key as the source DB
|
1906
2074
|
# instance.
|
1907
2075
|
#
|
1908
2076
|
# If you create an encrypted read replica in a different Amazon Web
|
1909
|
-
# Services Region, then you must specify a
|
1910
|
-
#
|
1911
|
-
#
|
1912
|
-
#
|
1913
|
-
# Services Region
|
2077
|
+
# Services Region, then you must specify a KMS key identifier for the
|
2078
|
+
# destination Amazon Web Services Region. KMS keys are specific to the
|
2079
|
+
# Amazon Web Services Region that they are created in, and you can't
|
2080
|
+
# use KMS keys from one Amazon Web Services Region in another Amazon Web
|
2081
|
+
# Services Region.
|
1914
2082
|
#
|
1915
2083
|
# You can't create an encrypted read replica from an unencrypted DB
|
1916
2084
|
# instance.
|
2085
|
+
#
|
2086
|
+
# This setting doesn't apply to RDS Custom, which uses the same KMS key
|
2087
|
+
# as the primary replica.
|
1917
2088
|
# @option options [String] :pre_signed_url
|
1918
2089
|
# The URL that contains a Signature Version 4 signed request for the
|
1919
2090
|
# `CreateDBInstanceReadReplica` API action in the source Amazon Web
|
@@ -1977,6 +2148,8 @@ module Aws::RDS
|
|
1977
2148
|
#
|
1978
2149
|
# </note>
|
1979
2150
|
#
|
2151
|
+
# This setting doesn't apply to RDS Custom.
|
2152
|
+
#
|
1980
2153
|
#
|
1981
2154
|
#
|
1982
2155
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/API/sigv4-query-string-auth.html
|
@@ -1990,6 +2163,8 @@ module Aws::RDS
|
|
1990
2163
|
# Database Authentication for MySQL and PostgreSQL][1] in the *Amazon
|
1991
2164
|
# RDS User Guide.*
|
1992
2165
|
#
|
2166
|
+
# This setting doesn't apply to RDS Custom.
|
2167
|
+
#
|
1993
2168
|
#
|
1994
2169
|
#
|
1995
2170
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.IAMDBAuth.html
|
@@ -2000,6 +2175,8 @@ module Aws::RDS
|
|
2000
2175
|
# For more information, see [Using Amazon Performance Insights][1] in
|
2001
2176
|
# the *Amazon RDS User Guide*.
|
2002
2177
|
#
|
2178
|
+
# This setting doesn't apply to RDS Custom.
|
2179
|
+
#
|
2003
2180
|
#
|
2004
2181
|
#
|
2005
2182
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.html
|
@@ -2008,31 +2185,40 @@ module Aws::RDS
|
|
2008
2185
|
# Performance Insights data.
|
2009
2186
|
#
|
2010
2187
|
# The Amazon Web Services KMS key identifier is the key ARN, key ID,
|
2011
|
-
# alias ARN, or alias name for the
|
2012
|
-
# master key (CMK).
|
2188
|
+
# alias ARN, or alias name for the KMS key.
|
2013
2189
|
#
|
2014
2190
|
# If you do not specify a value for `PerformanceInsightsKMSKeyId`, then
|
2015
|
-
# Amazon RDS uses your default
|
2016
|
-
# Amazon Web Services account. Your Amazon Web Services account has
|
2017
|
-
# different default
|
2191
|
+
# Amazon RDS uses your default KMS key. There is a default KMS key for
|
2192
|
+
# your Amazon Web Services account. Your Amazon Web Services account has
|
2193
|
+
# a different default KMS key for each Amazon Web Services Region.
|
2194
|
+
#
|
2195
|
+
# This setting doesn't apply to RDS Custom.
|
2018
2196
|
# @option options [Integer] :performance_insights_retention_period
|
2019
2197
|
# The amount of time, in days, to retain Performance Insights data.
|
2020
2198
|
# Valid values are 7 or 731 (2 years).
|
2199
|
+
#
|
2200
|
+
# This setting doesn't apply to RDS Custom.
|
2021
2201
|
# @option options [Array<String>] :enable_cloudwatch_logs_exports
|
2022
2202
|
# The list of logs that the new DB instance is to export to CloudWatch
|
2023
2203
|
# Logs. The values in the list depend on the DB engine being used. For
|
2024
2204
|
# more information, see [Publishing Database Logs to Amazon CloudWatch
|
2025
2205
|
# Logs ][1] in the *Amazon RDS User Guide*.
|
2026
2206
|
#
|
2207
|
+
# This setting doesn't apply to RDS Custom.
|
2208
|
+
#
|
2027
2209
|
#
|
2028
2210
|
#
|
2029
2211
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch
|
2030
2212
|
# @option options [Array<Types::ProcessorFeature>] :processor_features
|
2031
2213
|
# The number of CPU cores and the number of threads per core for the DB
|
2032
2214
|
# instance class of the DB instance.
|
2215
|
+
#
|
2216
|
+
# This setting doesn't apply to RDS Custom.
|
2033
2217
|
# @option options [Boolean] :use_default_processor_features
|
2034
2218
|
# A value that indicates whether the DB instance class of the DB
|
2035
2219
|
# instance uses its default processor features.
|
2220
|
+
#
|
2221
|
+
# This setting doesn't apply to RDS Custom.
|
2036
2222
|
# @option options [Boolean] :deletion_protection
|
2037
2223
|
# A value that indicates whether the DB instance has deletion protection
|
2038
2224
|
# enabled. The database can't be deleted when deletion protection is
|
@@ -2050,12 +2236,16 @@ module Aws::RDS
|
|
2050
2236
|
# For more information, see [ Kerberos Authentication][1] in the *Amazon
|
2051
2237
|
# RDS User Guide*.
|
2052
2238
|
#
|
2239
|
+
# This setting doesn't apply to RDS Custom.
|
2240
|
+
#
|
2053
2241
|
#
|
2054
2242
|
#
|
2055
2243
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/kerberos-authentication.html
|
2056
2244
|
# @option options [String] :domain_iam_role_name
|
2057
2245
|
# Specify the name of the IAM role to be used when making API calls to
|
2058
2246
|
# the Directory Service.
|
2247
|
+
#
|
2248
|
+
# This setting doesn't apply to RDS Custom.
|
2059
2249
|
# @option options [String] :replica_mode
|
2060
2250
|
# The open mode of the replica database: mounted or read-only.
|
2061
2251
|
#
|
@@ -2063,17 +2253,22 @@ module Aws::RDS
|
|
2063
2253
|
#
|
2064
2254
|
# </note>
|
2065
2255
|
#
|
2066
|
-
# Mounted DB replicas are included in Oracle Enterprise
|
2067
|
-
# main use case for mounted replicas is cross-Region
|
2068
|
-
# The primary database doesn't use Active Data Guard
|
2069
|
-
# information to the mounted replica. Because it doesn't
|
2070
|
-
# connections, a mounted replica can't serve a read-only
|
2256
|
+
# Mounted DB replicas are included in Oracle Database Enterprise
|
2257
|
+
# Edition. The main use case for mounted replicas is cross-Region
|
2258
|
+
# disaster recovery. The primary database doesn't use Active Data Guard
|
2259
|
+
# to transmit information to the mounted replica. Because it doesn't
|
2260
|
+
# accept user connections, a mounted replica can't serve a read-only
|
2261
|
+
# workload.
|
2071
2262
|
#
|
2072
2263
|
# You can create a combination of mounted and read-only DB replicas for
|
2073
2264
|
# the same primary DB instance. For more information, see [Working with
|
2074
2265
|
# Oracle Read Replicas for Amazon RDS][1] in the *Amazon RDS User
|
2075
2266
|
# Guide*.
|
2076
2267
|
#
|
2268
|
+
# For RDS Custom, you must specify this parameter and set it to
|
2269
|
+
# `mounted`. The value won't be set by default. After replica creation,
|
2270
|
+
# you can manage the open mode manually.
|
2271
|
+
#
|
2077
2272
|
#
|
2078
2273
|
#
|
2079
2274
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/oracle-read-replicas.html
|
@@ -2088,6 +2283,28 @@ module Aws::RDS
|
|
2088
2283
|
#
|
2089
2284
|
#
|
2090
2285
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PIOPS.StorageTypes.html#USER_PIOPS.Autoscaling
|
2286
|
+
# @option options [String] :custom_iam_instance_profile
|
2287
|
+
# The instance profile associated with the underlying Amazon EC2
|
2288
|
+
# instance of an RDS Custom DB instance. The instance profile must meet
|
2289
|
+
# the following requirements:
|
2290
|
+
#
|
2291
|
+
# * The profile must exist in your account.
|
2292
|
+
#
|
2293
|
+
# * The profile must have an IAM role that Amazon EC2 has permissions to
|
2294
|
+
# assume.
|
2295
|
+
#
|
2296
|
+
# * The instance profile name and the associated IAM role name must
|
2297
|
+
# start with the prefix `AWSRDSCustom`.
|
2298
|
+
#
|
2299
|
+
# For the list of permissions required for the IAM role, see [ Configure
|
2300
|
+
# IAM and your VPC][1] in the *Amazon Relational Database Service User
|
2301
|
+
# Guide*.
|
2302
|
+
#
|
2303
|
+
# This setting is required for RDS Custom.
|
2304
|
+
#
|
2305
|
+
#
|
2306
|
+
#
|
2307
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-setup-orcl.html#custom-setup-orcl.iam-vpc
|
2091
2308
|
# @option options [String] :source_region
|
2092
2309
|
# The source region of the snapshot. This is only needed when the
|
2093
2310
|
# shapshot is encrypted and in a different region.
|
@@ -2157,30 +2374,36 @@ module Aws::RDS
|
|
2157
2374
|
# @param [Hash] options ({})
|
2158
2375
|
# @option options [Boolean] :skip_final_snapshot
|
2159
2376
|
# A value that indicates whether to skip the creation of a final DB
|
2160
|
-
# snapshot before the
|
2161
|
-
# DB snapshot
|
2162
|
-
#
|
2163
|
-
#
|
2377
|
+
# snapshot before deleting the instance. If you enable this parameter,
|
2378
|
+
# RDS doesn't create a DB snapshot. If you don't enable this
|
2379
|
+
# parameter, RDS creates a DB snapshot before the DB instance is
|
2380
|
+
# deleted. By default, skip isn't enabled, and the DB snapshot is
|
2381
|
+
# created.
|
2164
2382
|
#
|
2165
|
-
#
|
2166
|
-
#
|
2167
|
-
# can only be deleted when skip is specified.
|
2383
|
+
# <note markdown="1"> If you don't enable this parameter, you must specify the
|
2384
|
+
# `FinalDBSnapshotIdentifier` parameter.
|
2168
2385
|
#
|
2169
|
-
#
|
2386
|
+
# </note>
|
2170
2387
|
#
|
2171
|
-
#
|
2172
|
-
#
|
2388
|
+
# When a DB instance is in a failure state and has a status of `failed`,
|
2389
|
+
# `incompatible-restore`, or `incompatible-network`, RDS can delete the
|
2390
|
+
# instance only if you enable this parameter.
|
2173
2391
|
#
|
2174
|
-
#
|
2392
|
+
# If you delete a read replica or an RDS Custom instance, you must
|
2393
|
+
# enable this setting.
|
2394
|
+
#
|
2395
|
+
# This setting is required for RDS Custom.
|
2175
2396
|
# @option options [String] :final_db_snapshot_identifier
|
2176
2397
|
# The `DBSnapshotIdentifier` of the new `DBSnapshot` created when the
|
2177
2398
|
# `SkipFinalSnapshot` parameter is disabled.
|
2178
2399
|
#
|
2179
|
-
# <note markdown="1">
|
2180
|
-
#
|
2400
|
+
# <note markdown="1"> If you enable this parameter and also enable SkipFinalShapshot, the
|
2401
|
+
# command results in an error.
|
2181
2402
|
#
|
2182
2403
|
# </note>
|
2183
2404
|
#
|
2405
|
+
# This setting doesn't apply to RDS Custom.
|
2406
|
+
#
|
2184
2407
|
# Constraints:
|
2185
2408
|
#
|
2186
2409
|
# * Must be 1 to 255 letters or numbers.
|
@@ -2261,6 +2484,8 @@ module Aws::RDS
|
|
2261
2484
|
# replica_mode: "open-read-only", # accepts open-read-only, mounted
|
2262
2485
|
# enable_customer_owned_ip: false,
|
2263
2486
|
# aws_backup_recovery_point_arn: "AwsBackupRecoveryPointArn",
|
2487
|
+
# automation_mode: "full", # accepts full, all-paused
|
2488
|
+
# resume_full_automation_mode_minutes: 1,
|
2264
2489
|
# })
|
2265
2490
|
# @param [Hash] options ({})
|
2266
2491
|
# @option options [Integer] :allocated_storage
|
@@ -2279,12 +2504,14 @@ module Aws::RDS
|
|
2279
2504
|
# `db.m4.large`. Not all DB instance classes are available in all Amazon
|
2280
2505
|
# Web Services Regions, or for all database engines. For the full list
|
2281
2506
|
# of DB instance classes, and availability for your engine, see [DB
|
2282
|
-
# Instance Class][1] in the *Amazon RDS User Guide
|
2507
|
+
# Instance Class][1] in the *Amazon RDS User Guide*.
|
2283
2508
|
#
|
2284
2509
|
# If you modify the DB instance class, an outage occurs during the
|
2285
2510
|
# change. The change is applied during the next maintenance window,
|
2286
2511
|
# unless `ApplyImmediately` is enabled for this request.
|
2287
2512
|
#
|
2513
|
+
# This setting doesn't apply to RDS Custom.
|
2514
|
+
#
|
2288
2515
|
# Default: Uses existing setting
|
2289
2516
|
#
|
2290
2517
|
#
|
@@ -2295,12 +2522,14 @@ module Aws::RDS
|
|
2295
2522
|
# parameter to move your DB instance to a different VPC. If your DB
|
2296
2523
|
# instance isn't in a VPC, you can also use this parameter to move your
|
2297
2524
|
# DB instance into a VPC. For more information, see [Working with a DB
|
2298
|
-
# instance in a VPC][1] in the *Amazon RDS User Guide
|
2525
|
+
# instance in a VPC][1] in the *Amazon RDS User Guide*.
|
2299
2526
|
#
|
2300
2527
|
# Changing the subnet group causes an outage during the change. The
|
2301
2528
|
# change is applied during the next maintenance window, unless you
|
2302
2529
|
# enable `ApplyImmediately`.
|
2303
2530
|
#
|
2531
|
+
# This parameter doesn't apply to RDS Custom.
|
2532
|
+
#
|
2304
2533
|
# Constraints: If supplied, must match the name of an existing
|
2305
2534
|
# DBSubnetGroup.
|
2306
2535
|
#
|
@@ -2314,14 +2543,18 @@ module Aws::RDS
|
|
2314
2543
|
# Changing this setting doesn't result in an outage and the change is
|
2315
2544
|
# asynchronously applied as soon as possible.
|
2316
2545
|
#
|
2546
|
+
# This setting doesn't apply to RDS Custom.
|
2547
|
+
#
|
2317
2548
|
# Constraints:
|
2318
2549
|
#
|
2319
2550
|
# * If supplied, must match existing DBSecurityGroups.
|
2320
2551
|
#
|
2321
2552
|
# ^
|
2322
2553
|
# @option options [Array<String>] :vpc_security_group_ids
|
2323
|
-
# A list of EC2 VPC security groups to authorize on this DB
|
2324
|
-
# This change is asynchronously applied as soon as possible.
|
2554
|
+
# A list of Amazon EC2 VPC security groups to authorize on this DB
|
2555
|
+
# instance. This change is asynchronously applied as soon as possible.
|
2556
|
+
#
|
2557
|
+
# This setting doesn't apply to RDS Custom.
|
2325
2558
|
#
|
2326
2559
|
# **Amazon Aurora**
|
2327
2560
|
#
|
@@ -2361,6 +2594,8 @@ module Aws::RDS
|
|
2361
2594
|
# element exists in the `PendingModifiedValues` element of the operation
|
2362
2595
|
# response.
|
2363
2596
|
#
|
2597
|
+
# This setting doesn't apply to RDS Custom.
|
2598
|
+
#
|
2364
2599
|
# **Amazon Aurora**
|
2365
2600
|
#
|
2366
2601
|
# Not applicable. The password for the master user is managed by the DB
|
@@ -2396,17 +2631,22 @@ module Aws::RDS
|
|
2396
2631
|
# </note>
|
2397
2632
|
# @option options [String] :db_parameter_group_name
|
2398
2633
|
# The name of the DB parameter group to apply to the DB instance.
|
2634
|
+
#
|
2399
2635
|
# Changing this setting doesn't result in an outage. The parameter
|
2400
2636
|
# group name itself is changed immediately, but the actual parameter
|
2401
2637
|
# changes are not applied until you reboot the instance without
|
2402
|
-
# failover. In this case, the DB instance isn't rebooted automatically
|
2403
|
-
# and the parameter changes
|
2404
|
-
# window.
|
2638
|
+
# failover. In this case, the DB instance isn't rebooted automatically,
|
2639
|
+
# and the parameter changes aren't applied during the next maintenance
|
2640
|
+
# window. However, if you modify dynamic parameters in the newly
|
2641
|
+
# associated DB parameter group, these changes are applied immediately
|
2642
|
+
# without a reboot.
|
2643
|
+
#
|
2644
|
+
# This setting doesn't apply to RDS Custom.
|
2405
2645
|
#
|
2406
2646
|
# Default: Uses existing setting
|
2407
2647
|
#
|
2408
2648
|
# Constraints: The DB parameter group must be in the same DB parameter
|
2409
|
-
# group family as
|
2649
|
+
# group family as the DB instance.
|
2410
2650
|
# @option options [Integer] :backup_retention_period
|
2411
2651
|
# The number of days to retain automated backups. Setting this parameter
|
2412
2652
|
# to a positive number enables backups. Setting this parameter to 0
|
@@ -2432,15 +2672,15 @@ module Aws::RDS
|
|
2432
2672
|
#
|
2433
2673
|
# Constraints:
|
2434
2674
|
#
|
2435
|
-
# *
|
2436
|
-
#
|
2437
|
-
#
|
2438
|
-
# running MySQL 5.6 or later
|
2675
|
+
# * It must be a value from 0 to 35. It can't be set to 0 if the DB
|
2676
|
+
# instance is a source to read replicas. It can't be set to 0 or 35
|
2677
|
+
# for an RDS Custom DB instance.
|
2439
2678
|
#
|
2440
|
-
# *
|
2441
|
-
# running
|
2679
|
+
# * It can be specified for a MySQL read replica only if the source is
|
2680
|
+
# running MySQL 5.6 or later.
|
2442
2681
|
#
|
2443
|
-
# *
|
2682
|
+
# * It can be specified for a PostgreSQL read replica only if the source
|
2683
|
+
# is running PostgreSQL 9.3.5.
|
2444
2684
|
# @option options [String] :preferred_backup_window
|
2445
2685
|
# The daily time range during which automated backups are created if
|
2446
2686
|
# automated backups are enabled, as determined by the
|
@@ -2496,9 +2736,11 @@ module Aws::RDS
|
|
2496
2736
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_UpgradeDBInstance.Maintenance.html#Concepts.DBMaintenance
|
2497
2737
|
# @option options [Boolean] :multi_az
|
2498
2738
|
# A value that indicates whether the DB instance is a Multi-AZ
|
2499
|
-
# deployment. Changing this parameter doesn't result in an outage
|
2500
|
-
#
|
2739
|
+
# deployment. Changing this parameter doesn't result in an outage. The
|
2740
|
+
# change is applied during the next maintenance window unless the
|
2501
2741
|
# `ApplyImmediately` parameter is enabled for this request.
|
2742
|
+
#
|
2743
|
+
# This setting doesn't apply to RDS Custom.
|
2502
2744
|
# @option options [String] :engine_version
|
2503
2745
|
# The version number of the database engine to upgrade to. Changing this
|
2504
2746
|
# parameter results in an outage and the change is applied during the
|
@@ -2514,25 +2756,40 @@ module Aws::RDS
|
|
2514
2756
|
# instance to the default minor version if the current minor version is
|
2515
2757
|
# lower. For information about valid engine versions, see
|
2516
2758
|
# `CreateDBInstance`, or call `DescribeDBEngineVersions`.
|
2759
|
+
#
|
2760
|
+
# In RDS Custom, this parameter is supported for read replicas only if
|
2761
|
+
# they are in the `PATCH_DB_FAILURE` lifecycle.
|
2517
2762
|
# @option options [Boolean] :allow_major_version_upgrade
|
2518
2763
|
# A value that indicates whether major version upgrades are allowed.
|
2519
2764
|
# Changing this parameter doesn't result in an outage and the change is
|
2520
2765
|
# asynchronously applied as soon as possible.
|
2521
2766
|
#
|
2767
|
+
# This setting doesn't apply to RDS Custom.
|
2768
|
+
#
|
2522
2769
|
# Constraints: Major version upgrades must be allowed when specifying a
|
2523
2770
|
# value for the EngineVersion parameter that is a different major
|
2524
2771
|
# version than the DB instance's current version.
|
2525
2772
|
# @option options [Boolean] :auto_minor_version_upgrade
|
2526
2773
|
# A value that indicates whether minor version upgrades are applied
|
2527
|
-
# automatically to the DB instance during the maintenance window.
|
2528
|
-
#
|
2529
|
-
#
|
2530
|
-
#
|
2531
|
-
#
|
2532
|
-
#
|
2774
|
+
# automatically to the DB instance during the maintenance window. An
|
2775
|
+
# outage occurs when all the following conditions are met:
|
2776
|
+
#
|
2777
|
+
# * The automatic upgrade is enabled for the maintenance window.
|
2778
|
+
#
|
2779
|
+
# * A newer minor version is available.
|
2780
|
+
#
|
2781
|
+
# * RDS has enabled automatic patching for the engine version.
|
2782
|
+
#
|
2783
|
+
# If any of the preceding conditions isn't met, RDS applies the change
|
2784
|
+
# as soon as possible and doesn't cause an outage.
|
2785
|
+
#
|
2786
|
+
# For an RDS Custom DB instance, set `AutoMinorVersionUpgrade` to
|
2787
|
+
# `false`. Otherwise, the operation returns an error.
|
2533
2788
|
# @option options [String] :license_model
|
2534
2789
|
# The license model for the DB instance.
|
2535
2790
|
#
|
2791
|
+
# This setting doesn't apply to RDS Custom.
|
2792
|
+
#
|
2536
2793
|
# Valid values: `license-included` \| `bring-your-own-license` \|
|
2537
2794
|
# `general-public-license`
|
2538
2795
|
# @option options [Integer] :iops
|
@@ -2569,18 +2826,23 @@ module Aws::RDS
|
|
2569
2826
|
# Default: Uses existing setting
|
2570
2827
|
# @option options [String] :option_group_name
|
2571
2828
|
# A value that indicates the DB instance should be associated with the
|
2572
|
-
# specified option group.
|
2573
|
-
#
|
2574
|
-
#
|
2575
|
-
#
|
2576
|
-
#
|
2577
|
-
#
|
2578
|
-
#
|
2829
|
+
# specified option group.
|
2830
|
+
#
|
2831
|
+
# Changing this parameter doesn't result in an outage, with one
|
2832
|
+
# exception. If the parameter change results in an option group that
|
2833
|
+
# enables OEM, it can cause a brief period, lasting less than a second,
|
2834
|
+
# during which new connections are rejected but existing connections
|
2835
|
+
# aren't interrupted.
|
2836
|
+
#
|
2837
|
+
# The change is applied during the next maintenance window unless the
|
2838
|
+
# `ApplyImmediately` parameter is enabled for this request.
|
2579
2839
|
#
|
2580
2840
|
# Permanent options, such as the TDE option for Oracle Advanced Security
|
2581
2841
|
# TDE, can't be removed from an option group, and that option group
|
2582
|
-
# can't be removed from a DB instance
|
2583
|
-
# instance
|
2842
|
+
# can't be removed from a DB instance after it is associated with a DB
|
2843
|
+
# instance.
|
2844
|
+
#
|
2845
|
+
# This setting doesn't apply to RDS Custom.
|
2584
2846
|
# @option options [String] :new_db_instance_identifier
|
2585
2847
|
# The new DB instance identifier for the DB instance when renaming a DB
|
2586
2848
|
# instance. When you change the DB instance identifier, an instance
|
@@ -2588,6 +2850,8 @@ module Aws::RDS
|
|
2588
2850
|
# occur during the next maintenance window if you disable Apply
|
2589
2851
|
# Immediately. This value is stored as a lowercase string.
|
2590
2852
|
#
|
2853
|
+
# This setting doesn't apply to RDS Custom.
|
2854
|
+
#
|
2591
2855
|
# Constraints:
|
2592
2856
|
#
|
2593
2857
|
# * Must contain from 1 to 63 letters, numbers, or hyphens.
|
@@ -2624,22 +2888,29 @@ module Aws::RDS
|
|
2624
2888
|
# @option options [String] :tde_credential_arn
|
2625
2889
|
# The ARN from the key store with which to associate the instance for
|
2626
2890
|
# TDE encryption.
|
2891
|
+
#
|
2892
|
+
# This setting doesn't apply to RDS Custom.
|
2627
2893
|
# @option options [String] :tde_credential_password
|
2628
2894
|
# The password for the given ARN from the key store in order to access
|
2629
2895
|
# the device.
|
2896
|
+
#
|
2897
|
+
# This setting doesn't apply to RDS Custom.
|
2630
2898
|
# @option options [String] :ca_certificate_identifier
|
2631
|
-
#
|
2632
|
-
#
|
2899
|
+
# Specifies the certificate to associate with the DB instance.
|
2900
|
+
#
|
2901
|
+
# This setting doesn't apply to RDS Custom.
|
2633
2902
|
# @option options [String] :domain
|
2634
2903
|
# The Active Directory directory ID to move the DB instance to. Specify
|
2635
|
-
# `none` to remove the instance from its current domain.
|
2636
|
-
#
|
2637
|
-
# SQL Server, Oracle, and PostgreSQL DB instances
|
2904
|
+
# `none` to remove the instance from its current domain. You must create
|
2905
|
+
# the domain before this operation. Currently, you can create only
|
2906
|
+
# MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances in an
|
2638
2907
|
# Active Directory Domain.
|
2639
2908
|
#
|
2640
2909
|
# For more information, see [ Kerberos Authentication][1] in the *Amazon
|
2641
2910
|
# RDS User Guide*.
|
2642
2911
|
#
|
2912
|
+
# This setting doesn't apply to RDS Custom.
|
2913
|
+
#
|
2643
2914
|
#
|
2644
2915
|
#
|
2645
2916
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/kerberos-authentication.html
|
@@ -2655,10 +2926,12 @@ module Aws::RDS
|
|
2655
2926
|
# @option options [Integer] :monitoring_interval
|
2656
2927
|
# The interval, in seconds, between points when Enhanced Monitoring
|
2657
2928
|
# metrics are collected for the DB instance. To disable collecting
|
2658
|
-
# Enhanced Monitoring metrics, specify 0
|
2929
|
+
# Enhanced Monitoring metrics, specify 0, which is the default.
|
2659
2930
|
#
|
2660
|
-
# If `MonitoringRoleArn` is specified,
|
2661
|
-
#
|
2931
|
+
# If `MonitoringRoleArn` is specified, set `MonitoringInterval` to a
|
2932
|
+
# value other than 0.
|
2933
|
+
#
|
2934
|
+
# This setting doesn't apply to RDS Custom.
|
2662
2935
|
#
|
2663
2936
|
# Valid Values: `0, 1, 5, 10, 15, 30, 60`
|
2664
2937
|
# @option options [Integer] :db_port_number
|
@@ -2668,9 +2941,11 @@ module Aws::RDS
|
|
2668
2941
|
# port values specified for options in the option group for the DB
|
2669
2942
|
# instance.
|
2670
2943
|
#
|
2671
|
-
#
|
2944
|
+
# If you change the `DBPortNumber` value, your database restarts
|
2672
2945
|
# regardless of the value of the `ApplyImmediately` parameter.
|
2673
2946
|
#
|
2947
|
+
# This setting doesn't apply to RDS Custom.
|
2948
|
+
#
|
2674
2949
|
# **MySQL**
|
2675
2950
|
#
|
2676
2951
|
# Default: `3306`
|
@@ -2728,15 +3003,19 @@ module Aws::RDS
|
|
2728
3003
|
#
|
2729
3004
|
# Changes to the `PubliclyAccessible` parameter are applied immediately
|
2730
3005
|
# regardless of the value of the `ApplyImmediately` parameter.
|
3006
|
+
#
|
3007
|
+
# This setting doesn't apply to RDS Custom.
|
2731
3008
|
# @option options [String] :monitoring_role_arn
|
2732
3009
|
# The ARN for the IAM role that permits RDS to send enhanced monitoring
|
2733
3010
|
# metrics to Amazon CloudWatch Logs. For example,
|
2734
3011
|
# `arn:aws:iam:123456789012:role/emaccess`. For information on creating
|
2735
|
-
# a monitoring role,
|
2736
|
-
#
|
3012
|
+
# a monitoring role, see [To create an IAM role for Amazon RDS Enhanced
|
3013
|
+
# Monitoring][1] in the *Amazon RDS User Guide.*
|
2737
3014
|
#
|
2738
|
-
# If `MonitoringInterval` is set to a value other than 0,
|
2739
|
-
#
|
3015
|
+
# If `MonitoringInterval` is set to a value other than 0, supply a
|
3016
|
+
# `MonitoringRoleArn` value.
|
3017
|
+
#
|
3018
|
+
# This setting doesn't apply to RDS Custom.
|
2740
3019
|
#
|
2741
3020
|
#
|
2742
3021
|
#
|
@@ -2744,12 +3023,16 @@ module Aws::RDS
|
|
2744
3023
|
# @option options [String] :domain_iam_role_name
|
2745
3024
|
# The name of the IAM role to use when making API calls to the Directory
|
2746
3025
|
# Service.
|
3026
|
+
#
|
3027
|
+
# This setting doesn't apply to RDS Custom.
|
2747
3028
|
# @option options [Integer] :promotion_tier
|
2748
3029
|
# A value that specifies the order in which an Aurora Replica is
|
2749
3030
|
# promoted to the primary instance after a failure of the existing
|
2750
3031
|
# primary instance. For more information, see [ Fault Tolerance for an
|
2751
3032
|
# Aurora DB Cluster][1] in the *Amazon Aurora User Guide*.
|
2752
3033
|
#
|
3034
|
+
# This setting doesn't apply to RDS Custom.
|
3035
|
+
#
|
2753
3036
|
# Default: 1
|
2754
3037
|
#
|
2755
3038
|
# Valid Values: 0 - 15
|
@@ -2770,6 +3053,8 @@ module Aws::RDS
|
|
2770
3053
|
# Database Authentication for MySQL and PostgreSQL][1] in the *Amazon
|
2771
3054
|
# RDS User Guide.*
|
2772
3055
|
#
|
3056
|
+
# This setting doesn't apply to RDS Custom.
|
3057
|
+
#
|
2773
3058
|
#
|
2774
3059
|
#
|
2775
3060
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.IAMDBAuth.html
|
@@ -2780,6 +3065,8 @@ module Aws::RDS
|
|
2780
3065
|
# For more information, see [Using Amazon Performance Insights][1] in
|
2781
3066
|
# the *Amazon Relational Database Service User Guide*.
|
2782
3067
|
#
|
3068
|
+
# This setting doesn't apply to RDS Custom.
|
3069
|
+
#
|
2783
3070
|
#
|
2784
3071
|
#
|
2785
3072
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.html
|
@@ -2788,16 +3075,19 @@ module Aws::RDS
|
|
2788
3075
|
# Performance Insights data.
|
2789
3076
|
#
|
2790
3077
|
# The Amazon Web Services KMS key identifier is the key ARN, key ID,
|
2791
|
-
# alias ARN, or alias name for the
|
2792
|
-
# master key (CMK).
|
3078
|
+
# alias ARN, or alias name for the KMS key.
|
2793
3079
|
#
|
2794
3080
|
# If you do not specify a value for `PerformanceInsightsKMSKeyId`, then
|
2795
|
-
# Amazon RDS uses your default
|
2796
|
-
# Amazon Web Services account. Your Amazon Web Services account has
|
2797
|
-
# different default
|
3081
|
+
# Amazon RDS uses your default KMS key. There is a default KMS key for
|
3082
|
+
# your Amazon Web Services account. Your Amazon Web Services account has
|
3083
|
+
# a different default KMS key for each Amazon Web Services Region.
|
3084
|
+
#
|
3085
|
+
# This setting doesn't apply to RDS Custom.
|
2798
3086
|
# @option options [Integer] :performance_insights_retention_period
|
2799
3087
|
# The amount of time, in days, to retain Performance Insights data.
|
2800
3088
|
# Valid values are 7 or 731 (2 years).
|
3089
|
+
#
|
3090
|
+
# This setting doesn't apply to RDS Custom.
|
2801
3091
|
# @option options [Types::CloudwatchLogsExportConfiguration] :cloudwatch_logs_export_configuration
|
2802
3092
|
# The configuration setting for the log types to be enabled for export
|
2803
3093
|
# to CloudWatch Logs for a specific DB instance.
|
@@ -2805,12 +3095,18 @@ module Aws::RDS
|
|
2805
3095
|
# A change to the `CloudwatchLogsExportConfiguration` parameter is
|
2806
3096
|
# always applied to the DB instance immediately. Therefore, the
|
2807
3097
|
# `ApplyImmediately` parameter has no effect.
|
3098
|
+
#
|
3099
|
+
# This setting doesn't apply to RDS Custom.
|
2808
3100
|
# @option options [Array<Types::ProcessorFeature>] :processor_features
|
2809
3101
|
# The number of CPU cores and the number of threads per core for the DB
|
2810
3102
|
# instance class of the DB instance.
|
3103
|
+
#
|
3104
|
+
# This setting doesn't apply to RDS Custom.
|
2811
3105
|
# @option options [Boolean] :use_default_processor_features
|
2812
3106
|
# A value that indicates whether the DB instance class of the DB
|
2813
3107
|
# instance uses its default processor features.
|
3108
|
+
#
|
3109
|
+
# This setting doesn't apply to RDS Custom.
|
2814
3110
|
# @option options [Boolean] :deletion_protection
|
2815
3111
|
# A value that indicates whether the DB instance has deletion protection
|
2816
3112
|
# enabled. The database can't be deleted when deletion protection is
|
@@ -2828,6 +3124,8 @@ module Aws::RDS
|
|
2828
3124
|
# apply to it, see [ Managing capacity automatically with Amazon RDS
|
2829
3125
|
# storage autoscaling][1] in the *Amazon RDS User Guide*.
|
2830
3126
|
#
|
3127
|
+
# This setting doesn't apply to RDS Custom.
|
3128
|
+
#
|
2831
3129
|
#
|
2832
3130
|
#
|
2833
3131
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PIOPS.StorageTypes.html#USER_PIOPS.Autoscaling
|
@@ -2854,6 +3152,8 @@ module Aws::RDS
|
|
2854
3152
|
# Aurora DB engines, see [ Rotating Your SSL/TLS Certificate][2] in
|
2855
3153
|
# the *Amazon Aurora User Guide.*
|
2856
3154
|
#
|
3155
|
+
# This setting doesn't apply to RDS Custom.
|
3156
|
+
#
|
2857
3157
|
#
|
2858
3158
|
#
|
2859
3159
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.SSL-certificate-rotation.html
|
@@ -2874,6 +3174,8 @@ module Aws::RDS
|
|
2874
3174
|
# more information, see [Working with Oracle Read Replicas for Amazon
|
2875
3175
|
# RDS][1] in the *Amazon RDS User Guide*.
|
2876
3176
|
#
|
3177
|
+
# This setting doesn't apply to RDS Custom.
|
3178
|
+
#
|
2877
3179
|
#
|
2878
3180
|
#
|
2879
3181
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/oracle-read-replicas.html
|
@@ -2900,6 +3202,17 @@ module Aws::RDS
|
|
2900
3202
|
# @option options [String] :aws_backup_recovery_point_arn
|
2901
3203
|
# The Amazon Resource Name (ARN) of the recovery point in Amazon Web
|
2902
3204
|
# Services Backup.
|
3205
|
+
#
|
3206
|
+
# This setting doesn't apply to RDS Custom.
|
3207
|
+
# @option options [String] :automation_mode
|
3208
|
+
# The automation mode of the RDS Custom DB instance: `full` or `all
|
3209
|
+
# paused`. If `full`, the DB instance automates monitoring and instance
|
3210
|
+
# recovery. If `all paused`, the instance pauses automation for the
|
3211
|
+
# duration set by `ResumeFullAutomationModeMinutes`.
|
3212
|
+
# @option options [Integer] :resume_full_automation_mode_minutes
|
3213
|
+
# The number of minutes to pause the automation. When the time period
|
3214
|
+
# ends, RDS Custom resumes full automation. The minimum value is `60`
|
3215
|
+
# (default). The maximum value is `1,440`.
|
2903
3216
|
# @return [DBInstance]
|
2904
3217
|
def modify(options = {})
|
2905
3218
|
options = options.merge(db_instance_identifier: @id)
|
@@ -3033,6 +3346,7 @@ module Aws::RDS
|
|
3033
3346
|
# max_allocated_storage: 1,
|
3034
3347
|
# source_db_instance_automated_backups_arn: "String",
|
3035
3348
|
# enable_customer_owned_ip: false,
|
3349
|
+
# custom_iam_instance_profile: "String",
|
3036
3350
|
# })
|
3037
3351
|
# @param [Hash] options ({})
|
3038
3352
|
# @option options [required, String] :target_db_instance_identifier
|
@@ -3104,6 +3418,8 @@ module Aws::RDS
|
|
3104
3418
|
# A value that indicates whether the DB instance is a Multi-AZ
|
3105
3419
|
# deployment.
|
3106
3420
|
#
|
3421
|
+
# This setting doesn't apply to RDS Custom.
|
3422
|
+
#
|
3107
3423
|
# Constraint: You can't specify the `AvailabilityZone` parameter if the
|
3108
3424
|
# DB instance is a Multi-AZ deployment.
|
3109
3425
|
# @option options [Boolean] :publicly_accessible
|
@@ -3123,9 +3439,13 @@ module Aws::RDS
|
|
3123
3439
|
# @option options [Boolean] :auto_minor_version_upgrade
|
3124
3440
|
# A value that indicates whether minor version upgrades are applied
|
3125
3441
|
# automatically to the DB instance during the maintenance window.
|
3442
|
+
#
|
3443
|
+
# This setting doesn't apply to RDS Custom.
|
3126
3444
|
# @option options [String] :license_model
|
3127
3445
|
# License model information for the restored DB instance.
|
3128
3446
|
#
|
3447
|
+
# This setting doesn't apply to RDS Custom.
|
3448
|
+
#
|
3129
3449
|
# Default: Same as source.
|
3130
3450
|
#
|
3131
3451
|
# Valid values: `license-included` \| `bring-your-own-license` \|
|
@@ -3133,12 +3453,15 @@ module Aws::RDS
|
|
3133
3453
|
# @option options [String] :db_name
|
3134
3454
|
# The database name for the restored DB instance.
|
3135
3455
|
#
|
3136
|
-
# <note markdown="1"> This parameter isn't
|
3456
|
+
# <note markdown="1"> This parameter isn't supported for the MySQL or MariaDB engines. It
|
3457
|
+
# also doesn't apply to RDS Custom.
|
3137
3458
|
#
|
3138
3459
|
# </note>
|
3139
3460
|
# @option options [String] :engine
|
3140
3461
|
# The database engine to use for the new instance.
|
3141
3462
|
#
|
3463
|
+
# This setting doesn't apply to RDS Custom.
|
3464
|
+
#
|
3142
3465
|
# Default: The same as source
|
3143
3466
|
#
|
3144
3467
|
# Constraint: Must be compatible with the engine of the source
|
@@ -3181,8 +3504,10 @@ module Aws::RDS
|
|
3181
3504
|
#
|
3182
3505
|
# Permanent options, such as the TDE option for Oracle Advanced Security
|
3183
3506
|
# TDE, can't be removed from an option group, and that option group
|
3184
|
-
# can't be removed from a DB instance
|
3507
|
+
# can't be removed from a DB instance after it is associated with a DB
|
3185
3508
|
# instance
|
3509
|
+
#
|
3510
|
+
# This setting doesn't apply to RDS Custom.
|
3186
3511
|
# @option options [Boolean] :copy_tags_to_snapshot
|
3187
3512
|
# A value that indicates whether to copy all tags from the restored DB
|
3188
3513
|
# instance to snapshots of the DB instance. By default, tags are not
|
@@ -3206,9 +3531,13 @@ module Aws::RDS
|
|
3206
3531
|
# @option options [String] :tde_credential_arn
|
3207
3532
|
# The ARN from the key store with which to associate the instance for
|
3208
3533
|
# TDE encryption.
|
3534
|
+
#
|
3535
|
+
# This setting doesn't apply to RDS Custom.
|
3209
3536
|
# @option options [String] :tde_credential_password
|
3210
3537
|
# The password for the given ARN from the key store in order to access
|
3211
3538
|
# the device.
|
3539
|
+
#
|
3540
|
+
# This setting doesn't apply to RDS Custom.
|
3212
3541
|
# @option options [Array<String>] :vpc_security_group_ids
|
3213
3542
|
# A list of EC2 VPC security groups to associate with this DB instance.
|
3214
3543
|
#
|
@@ -3216,9 +3545,11 @@ module Aws::RDS
|
|
3216
3545
|
# VPC.
|
3217
3546
|
# @option options [String] :domain
|
3218
3547
|
# Specify the Active Directory directory ID to restore the DB instance
|
3219
|
-
# in.
|
3220
|
-
# only MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB
|
3221
|
-
#
|
3548
|
+
# in. Create the domain before running this command. Currently, you can
|
3549
|
+
# create only the MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB
|
3550
|
+
# instances in an Active Directory Domain.
|
3551
|
+
#
|
3552
|
+
# This setting doesn't apply to RDS Custom.
|
3222
3553
|
#
|
3223
3554
|
# For more information, see [ Kerberos Authentication][1] in the *Amazon
|
3224
3555
|
# RDS User Guide*.
|
@@ -3229,11 +3560,15 @@ module Aws::RDS
|
|
3229
3560
|
# @option options [String] :domain_iam_role_name
|
3230
3561
|
# Specify the name of the IAM role to be used when making API calls to
|
3231
3562
|
# the Directory Service.
|
3563
|
+
#
|
3564
|
+
# This setting doesn't apply to RDS Custom.
|
3232
3565
|
# @option options [Boolean] :enable_iam_database_authentication
|
3233
3566
|
# A value that indicates whether to enable mapping of Amazon Web
|
3234
3567
|
# Services Identity and Access Management (IAM) accounts to database
|
3235
3568
|
# accounts. By default, mapping is disabled.
|
3236
3569
|
#
|
3570
|
+
# This setting doesn't apply to RDS Custom.
|
3571
|
+
#
|
3237
3572
|
# For more information about IAM database authentication, see [ IAM
|
3238
3573
|
# Database Authentication for MySQL and PostgreSQL][1] in the *Amazon
|
3239
3574
|
# RDS User Guide.*
|
@@ -3247,21 +3582,29 @@ module Aws::RDS
|
|
3247
3582
|
# used. For more information, see [Publishing Database Logs to Amazon
|
3248
3583
|
# CloudWatch Logs][1] in the *Amazon RDS User Guide*.
|
3249
3584
|
#
|
3585
|
+
# This setting doesn't apply to RDS Custom.
|
3586
|
+
#
|
3250
3587
|
#
|
3251
3588
|
#
|
3252
3589
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch
|
3253
3590
|
# @option options [Array<Types::ProcessorFeature>] :processor_features
|
3254
3591
|
# The number of CPU cores and the number of threads per core for the DB
|
3255
3592
|
# instance class of the DB instance.
|
3593
|
+
#
|
3594
|
+
# This setting doesn't apply to RDS Custom.
|
3256
3595
|
# @option options [Boolean] :use_default_processor_features
|
3257
3596
|
# A value that indicates whether the DB instance class of the DB
|
3258
3597
|
# instance uses its default processor features.
|
3598
|
+
#
|
3599
|
+
# This setting doesn't apply to RDS Custom.
|
3259
3600
|
# @option options [String] :db_parameter_group_name
|
3260
3601
|
# The name of the DB parameter group to associate with this DB instance.
|
3261
3602
|
#
|
3262
3603
|
# If you do not specify a value for `DBParameterGroupName`, then the
|
3263
3604
|
# default `DBParameterGroup` for the specified DB engine is used.
|
3264
3605
|
#
|
3606
|
+
# This setting doesn't apply to RDS Custom.
|
3607
|
+
#
|
3265
3608
|
# Constraints:
|
3266
3609
|
#
|
3267
3610
|
# * If supplied, must match the name of an existing DBParameterGroup.
|
@@ -3290,6 +3633,8 @@ module Aws::RDS
|
|
3290
3633
|
# apply to it, see [ Managing capacity automatically with Amazon RDS
|
3291
3634
|
# storage autoscaling][1] in the *Amazon RDS User Guide*.
|
3292
3635
|
#
|
3636
|
+
# This setting doesn't apply to RDS Custom.
|
3637
|
+
#
|
3293
3638
|
#
|
3294
3639
|
#
|
3295
3640
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PIOPS.StorageTypes.html#USER_PIOPS.Autoscaling
|
@@ -3297,6 +3642,8 @@ module Aws::RDS
|
|
3297
3642
|
# The Amazon Resource Name (ARN) of the replicated automated backups
|
3298
3643
|
# from which to restore, for example,
|
3299
3644
|
# `arn:aws:rds:useast-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE`.
|
3645
|
+
#
|
3646
|
+
# This setting doesn't apply to RDS Custom.
|
3300
3647
|
# @option options [Boolean] :enable_customer_owned_ip
|
3301
3648
|
# A value that indicates whether to enable a customer-owned IP address
|
3302
3649
|
# (CoIP) for an RDS on Outposts DB instance.
|
@@ -3306,6 +3653,8 @@ module Aws::RDS
|
|
3306
3653
|
# a CoIP can provide lower latency for connections to the DB instance
|
3307
3654
|
# from outside of its virtual private cloud (VPC) on your local network.
|
3308
3655
|
#
|
3656
|
+
# This setting doesn't apply to RDS Custom.
|
3657
|
+
#
|
3309
3658
|
# For more information about RDS on Outposts, see [Working with Amazon
|
3310
3659
|
# RDS on Amazon Web Services Outposts][1] in the *Amazon RDS User
|
3311
3660
|
# Guide*.
|
@@ -3317,6 +3666,28 @@ module Aws::RDS
|
|
3317
3666
|
#
|
3318
3667
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html
|
3319
3668
|
# [2]: https://docs.aws.amazon.com/outposts/latest/userguide/outposts-networking-components.html#ip-addressing
|
3669
|
+
# @option options [String] :custom_iam_instance_profile
|
3670
|
+
# The instance profile associated with the underlying Amazon EC2
|
3671
|
+
# instance of an RDS Custom DB instance. The instance profile must meet
|
3672
|
+
# the following requirements:
|
3673
|
+
#
|
3674
|
+
# * The profile must exist in your account.
|
3675
|
+
#
|
3676
|
+
# * The profile must have an IAM role that Amazon EC2 has permissions to
|
3677
|
+
# assume.
|
3678
|
+
#
|
3679
|
+
# * The instance profile name and the associated IAM role name must
|
3680
|
+
# start with the prefix `AWSRDSCustom`.
|
3681
|
+
#
|
3682
|
+
# For the list of permissions required for the IAM role, see [ Configure
|
3683
|
+
# IAM and your VPC][1] in the *Amazon Relational Database Service User
|
3684
|
+
# Guide*.
|
3685
|
+
#
|
3686
|
+
# This setting is required for RDS Custom.
|
3687
|
+
#
|
3688
|
+
#
|
3689
|
+
#
|
3690
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-setup-orcl.html#custom-setup-orcl.iam-vpc
|
3320
3691
|
# @return [DBInstance]
|
3321
3692
|
def restore(options = {})
|
3322
3693
|
options = options.merge(source_db_instance_identifier: @id)
|
@@ -3698,6 +4069,8 @@ module Aws::RDS
|
|
3698
4069
|
# You can give an Amazon Web Services account permission to restore a
|
3699
4070
|
# manual DB snapshot from another Amazon Web Services account by using
|
3700
4071
|
# the `ModifyDBSnapshotAttribute` API action.
|
4072
|
+
#
|
4073
|
+
# This setting doesn't apply to RDS Custom.
|
3701
4074
|
# @option options [Boolean] :include_public
|
3702
4075
|
# A value that indicates whether to include manual DB cluster snapshots
|
3703
4076
|
# that are public and can be copied or restored by any Amazon Web
|
@@ -3705,6 +4078,8 @@ module Aws::RDS
|
|
3705
4078
|
#
|
3706
4079
|
# You can share a manual DB snapshot as public by using the
|
3707
4080
|
# ModifyDBSnapshotAttribute API.
|
4081
|
+
#
|
4082
|
+
# This setting doesn't apply to RDS Custom.
|
3708
4083
|
# @option options [String] :dbi_resource_id
|
3709
4084
|
# A specific DB resource ID to describe.
|
3710
4085
|
# @return [DBSnapshot::Collection]
|