aws-sdk-rds 1.127.0 → 1.131.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.
@@ -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 Amazon Web Services KMS customer
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 customer master key
368
- # (CMK) for the DB instance is accessed.
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 Amazon Web Services KMS customer
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 Amazon Web Services KMS customer master key (CMK).
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,54 @@ 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
+
673
+ # Specifies where automated backups and manual snapshots are stored:
674
+ # Amazon Web Services Outposts or the Amazon Web Services Region.
675
+ # @return [String]
676
+ def backup_target
677
+ data[:backup_target]
678
+ end
679
+
632
680
  # @!endgroup
633
681
 
634
682
  # @return [Client]
@@ -823,6 +871,8 @@ module Aws::RDS
823
871
  # deletion_protection: false,
824
872
  # max_allocated_storage: 1,
825
873
  # enable_customer_owned_ip: false,
874
+ # custom_iam_instance_profile: "String",
875
+ # backup_target: "String",
826
876
  # })
827
877
  # @param [Hash] options ({})
828
878
  # @option options [String] :db_name
@@ -888,6 +938,21 @@ module Aws::RDS
888
938
  #
889
939
  # ^
890
940
  #
941
+ # **Amazon RDS Custom**
942
+ #
943
+ # The Oracle System ID (SID) of the created RDS Custom DB instance. If
944
+ # you don't specify a value, the default value is `ORCL`.
945
+ #
946
+ # Default: `ORCL`
947
+ #
948
+ # Constraints:
949
+ #
950
+ # * It must contain 1 to 8 alphanumeric characters.
951
+ #
952
+ # * It must contain a letter.
953
+ #
954
+ # * It can't be a word reserved by the database engine.
955
+ #
891
956
  # **SQL Server**
892
957
  #
893
958
  # Not applicable. Must be null.
@@ -932,6 +997,16 @@ module Aws::RDS
932
997
  # amount of data in your database increases, though you are only charged
933
998
  # for the space that you use in an Aurora cluster volume.
934
999
  #
1000
+ # **Amazon RDS Custom**
1001
+ #
1002
+ # Constraints to the amount of storage for each storage type are the
1003
+ # following:
1004
+ #
1005
+ # * General Purpose (SSD) storage (gp2): Must be an integer from 40 to
1006
+ # 65536.
1007
+ #
1008
+ # * Provisioned IOPS storage (io1): Must be an integer from 40 to 65536.
1009
+ #
935
1010
  # **MySQL**
936
1011
  #
937
1012
  # Constraints to the amount of storage for each storage type are the
@@ -1033,6 +1108,8 @@ module Aws::RDS
1033
1108
  #
1034
1109
  # * `aurora-postgresql`
1035
1110
  #
1111
+ # * `custom-oracle-ee (for RDS Custom instances)`
1112
+ #
1036
1113
  # * `mariadb`
1037
1114
  #
1038
1115
  # * `mysql`
@@ -1062,59 +1139,13 @@ module Aws::RDS
1062
1139
  # Not applicable. The name for the master user is managed by the DB
1063
1140
  # cluster.
1064
1141
  #
1065
- # **MariaDB**
1066
- #
1067
- # Constraints:
1068
- #
1069
- # * Required for MariaDB.
1070
- #
1071
- # * Must be 1 to 16 letters or numbers.
1072
- #
1073
- # * Can't be a reserved word for the chosen database engine.
1074
- #
1075
- # **Microsoft SQL Server**
1076
- #
1077
- # Constraints:
1078
- #
1079
- # * Required for SQL Server.
1080
- #
1081
- # * Must be 1 to 128 letters or numbers.
1082
- #
1083
- # * The first character must be a letter.
1084
- #
1085
- # * Can't be a reserved word for the chosen database engine.
1086
- #
1087
- # **MySQL**
1088
- #
1089
- # Constraints:
1090
- #
1091
- # * Required for MySQL.
1092
- #
1093
- # * Must be 1 to 16 letters or numbers.
1094
- #
1095
- # * First character must be a letter.
1096
- #
1097
- # * Can't be a reserved word for the chosen database engine.
1098
- #
1099
- # **Oracle**
1142
+ # **Amazon RDS**
1100
1143
  #
1101
1144
  # Constraints:
1102
1145
  #
1103
- # * Required for Oracle.
1146
+ # * Required.
1104
1147
  #
1105
- # * Must be 1 to 30 letters or numbers.
1106
- #
1107
- # * First character must be a letter.
1108
- #
1109
- # * Can't be a reserved word for the chosen database engine.
1110
- #
1111
- # **PostgreSQL**
1112
- #
1113
- # Constraints:
1114
- #
1115
- # * Required for PostgreSQL.
1116
- #
1117
- # * Must be 1 to 63 letters or numbers.
1148
+ # * Must be 1 to 16 letters, numbers, or underscores.
1118
1149
  #
1119
1150
  # * First character must be a letter.
1120
1151
  #
@@ -1217,6 +1248,8 @@ module Aws::RDS
1217
1248
  # If you do not specify a value, then the default DB parameter group for
1218
1249
  # the specified DB engine and version is used.
1219
1250
  #
1251
+ # This setting doesn't apply to RDS Custom.
1252
+ #
1220
1253
  # Constraints:
1221
1254
  #
1222
1255
  # * Must be 1 to 255 letters, numbers, or hyphens.
@@ -1241,6 +1274,8 @@ module Aws::RDS
1241
1274
  # * Must be a value from 0 to 35
1242
1275
  #
1243
1276
  # * Can't be set to 0 if the DB instance is a source to read replicas
1277
+ #
1278
+ # * Can't be set to 0 or 35 for an RDS Custom DB instance
1244
1279
  # @option options [String] :preferred_backup_window
1245
1280
  # The daily time range during which automated backups are created if
1246
1281
  # automated backups are enabled, using the `BackupRetentionPeriod`
@@ -1317,6 +1352,8 @@ module Aws::RDS
1317
1352
  # A value that indicates whether the DB instance is a Multi-AZ
1318
1353
  # deployment. You can't set the `AvailabilityZone` parameter if the DB
1319
1354
  # instance is a Multi-AZ deployment.
1355
+ #
1356
+ # This setting doesn't apply to RDS Custom.
1320
1357
  # @option options [String] :engine_version
1321
1358
  # The version number of the database engine to use.
1322
1359
  #
@@ -1333,46 +1370,60 @@ module Aws::RDS
1333
1370
  # Not applicable. The version number of the database engine to be used
1334
1371
  # by the DB instance is managed by the DB cluster.
1335
1372
  #
1373
+ # **Amazon RDS Custom**
1374
+ #
1375
+ # A custom engine version (CEV) that you have previously created. This
1376
+ # setting is required for RDS Custom. The CEV name has the following
1377
+ # format: `19.customized_string `. An example identifier is
1378
+ # `19.my_cev1`. For more information, see [ Creating an RDS Custom DB
1379
+ # instance][1] in the *Amazon RDS User Guide.*.
1380
+ #
1336
1381
  # **MariaDB**
1337
1382
  #
1338
- # See [MariaDB on Amazon RDS Versions][1] in the *Amazon RDS User
1383
+ # See [MariaDB on Amazon RDS Versions][2] in the *Amazon RDS User
1339
1384
  # Guide.*
1340
1385
  #
1341
1386
  # **Microsoft SQL Server**
1342
1387
  #
1343
- # See [Microsoft SQL Server Versions on Amazon RDS][2] in the *Amazon
1388
+ # See [Microsoft SQL Server Versions on Amazon RDS][3] in the *Amazon
1344
1389
  # RDS User Guide.*
1345
1390
  #
1346
1391
  # **MySQL**
1347
1392
  #
1348
- # See [MySQL on Amazon RDS Versions][3] in the *Amazon RDS User Guide.*
1393
+ # See [MySQL on Amazon RDS Versions][4] in the *Amazon RDS User Guide.*
1349
1394
  #
1350
1395
  # **Oracle**
1351
1396
  #
1352
- # See [Oracle Database Engine Release Notes][4] in the *Amazon RDS User
1397
+ # See [Oracle Database Engine Release Notes][5] in the *Amazon RDS User
1353
1398
  # Guide.*
1354
1399
  #
1355
1400
  # **PostgreSQL**
1356
1401
  #
1357
- # See [Amazon RDS for PostgreSQL versions and extensions][5] in the
1402
+ # See [Amazon RDS for PostgreSQL versions and extensions][6] in the
1358
1403
  # *Amazon RDS User Guide.*
1359
1404
  #
1360
1405
  #
1361
1406
  #
1362
- # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_MariaDB.html#MariaDB.Concepts.VersionMgmt
1363
- # [2]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_SQLServer.html#SQLServer.Concepts.General.VersionSupport
1364
- # [3]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_MySQL.html#MySQL.Concepts.VersionMgmt
1365
- # [4]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Appendix.Oracle.PatchComposition.html
1366
- # [5]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_PostgreSQL.html#PostgreSQL.Concepts
1407
+ # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-creating.html#custom-creating.create
1408
+ # [2]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_MariaDB.html#MariaDB.Concepts.VersionMgmt
1409
+ # [3]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_SQLServer.html#SQLServer.Concepts.General.VersionSupport
1410
+ # [4]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_MySQL.html#MySQL.Concepts.VersionMgmt
1411
+ # [5]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Appendix.Oracle.PatchComposition.html
1412
+ # [6]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_PostgreSQL.html#PostgreSQL.Concepts
1367
1413
  # @option options [Boolean] :auto_minor_version_upgrade
1368
1414
  # A value that indicates whether minor engine upgrades are applied
1369
1415
  # automatically to the DB instance during the maintenance window. By
1370
1416
  # default, minor engine upgrades are applied automatically.
1417
+ #
1418
+ # If you create an RDS Custom DB instance, you must set
1419
+ # `AutoMinorVersionUpgrade` to `false`.
1371
1420
  # @option options [String] :license_model
1372
1421
  # License model information for this DB instance.
1373
1422
  #
1374
1423
  # Valid values: `license-included` \| `bring-your-own-license` \|
1375
1424
  # `general-public-license`
1425
+ #
1426
+ # This setting doesn't apply to RDS Custom.
1376
1427
  # @option options [Integer] :iops
1377
1428
  # The amount of Provisioned IOPS (input/output operations per second) to
1378
1429
  # be initially allocated for the DB instance. For information about
@@ -1393,11 +1444,16 @@ module Aws::RDS
1393
1444
  #
1394
1445
  # Permanent options, such as the TDE option for Oracle Advanced Security
1395
1446
  # TDE, can't be removed from an option group. Also, that option group
1396
- # can't be removed from a DB instance once it is associated with a DB
1397
- # instance
1447
+ # can't be removed from a DB instance after it is associated with a DB
1448
+ # instance.
1449
+ #
1450
+ # This setting doesn't apply to RDS Custom.
1398
1451
  # @option options [String] :character_set_name
1399
- # For supported engines, indicates that the DB instance should be
1400
- # associated with the specified CharacterSet.
1452
+ # For supported engines, this value indicates that the DB instance
1453
+ # should be associated with the specified `CharacterSet`.
1454
+ #
1455
+ # This setting doesn't apply to RDS Custom. However, if you need to
1456
+ # change the character set, you can change it on the database itself.
1401
1457
  #
1402
1458
  # **Amazon Aurora**
1403
1459
  #
@@ -1405,6 +1461,8 @@ module Aws::RDS
1405
1461
  # more information, see `CreateDBCluster`.
1406
1462
  # @option options [String] :nchar_character_set_name
1407
1463
  # The name of the NCHAR character set for the Oracle DB instance.
1464
+ #
1465
+ # This parameter doesn't apply to RDS Custom.
1408
1466
  # @option options [Boolean] :publicly_accessible
1409
1467
  # A value that indicates whether the DB instance is publicly accessible.
1410
1468
  #
@@ -1442,6 +1500,8 @@ module Aws::RDS
1442
1500
  # Tags to assign to the DB instance.
1443
1501
  # @option options [String] :db_cluster_identifier
1444
1502
  # The identifier of the DB cluster that the instance will belong to.
1503
+ #
1504
+ # This setting doesn't apply to RDS Custom.
1445
1505
  # @option options [String] :storage_type
1446
1506
  # Specifies the storage type to be associated with the DB instance.
1447
1507
  #
@@ -1454,13 +1514,21 @@ module Aws::RDS
1454
1514
  # @option options [String] :tde_credential_arn
1455
1515
  # The ARN from the key store with which to associate the instance for
1456
1516
  # TDE encryption.
1517
+ #
1518
+ # This setting doesn't apply to RDS Custom.
1457
1519
  # @option options [String] :tde_credential_password
1458
1520
  # The password for the given ARN from the key store in order to access
1459
1521
  # the device.
1522
+ #
1523
+ # This setting doesn't apply to RDS Custom.
1460
1524
  # @option options [Boolean] :storage_encrypted
1461
1525
  # A value that indicates whether the DB instance is encrypted. By
1462
1526
  # default, it isn't encrypted.
1463
1527
  #
1528
+ # For RDS Custom Oracle instances, either set this parameter to `true`
1529
+ # or leave it unset. If you set this parameter to `false`, RDS reports
1530
+ # an error.
1531
+ #
1464
1532
  # **Amazon Aurora**
1465
1533
  #
1466
1534
  # Not applicable. The encryption for DB instances is managed by the DB
@@ -1470,9 +1538,9 @@ module Aws::RDS
1470
1538
  # instance.
1471
1539
  #
1472
1540
  # The Amazon Web Services KMS key identifier is the key ARN, key ID,
1473
- # alias ARN, or alias name for the Amazon Web Services KMS customer
1474
- # master key (CMK). To use a CMK in a different Amazon Web Services
1475
- # account, specify the key ARN or alias ARN.
1541
+ # alias ARN, or alias name for the KMS key. To use a KMS key in a
1542
+ # different Amazon Web Services account, specify the key ARN or alias
1543
+ # ARN.
1476
1544
  #
1477
1545
  # **Amazon Aurora**
1478
1546
  #
@@ -1480,10 +1548,18 @@ module Aws::RDS
1480
1548
  # by the DB cluster. For more information, see `CreateDBCluster`.
1481
1549
  #
1482
1550
  # If `StorageEncrypted` is enabled, and you do not specify a value for
1483
- # the `KmsKeyId` parameter, then Amazon RDS uses your default CMK. There
1484
- # is a default CMK for your Amazon Web Services account. Your Amazon Web
1485
- # Services account has a different default CMK for each Amazon Web
1486
- # Services Region.
1551
+ # the `KmsKeyId` parameter, then Amazon RDS uses your default KMS key.
1552
+ # There is a default KMS key for your Amazon Web Services account. Your
1553
+ # Amazon Web Services account has a different default KMS key for each
1554
+ # Amazon Web Services Region.
1555
+ #
1556
+ # **Amazon RDS Custom**
1557
+ #
1558
+ # A KMS key is required for RDS Custom Oracle instances. For most RDS
1559
+ # engines, if you leave this parameter empty while enabling
1560
+ # `StorageEncrypted`, the engine uses the default KMS key. However, RDS
1561
+ # Custom for Oracle doesn't use the default key when this parameter is
1562
+ # empty. You must explicitly specify a key.
1487
1563
  # @option options [String] :domain
1488
1564
  # The Active Directory directory ID to create the DB instance in.
1489
1565
  # Currently, only MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB
@@ -1492,6 +1568,8 @@ module Aws::RDS
1492
1568
  # For more information, see [ Kerberos Authentication][1] in the *Amazon
1493
1569
  # RDS User Guide*.
1494
1570
  #
1571
+ # This setting doesn't apply to RDS Custom.
1572
+ #
1495
1573
  #
1496
1574
  #
1497
1575
  # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/kerberos-authentication.html
@@ -1506,35 +1584,43 @@ module Aws::RDS
1506
1584
  # the DB cluster setting.
1507
1585
  # @option options [Integer] :monitoring_interval
1508
1586
  # The interval, in seconds, between points when Enhanced Monitoring
1509
- # metrics are collected for the DB instance. To disable collecting
1587
+ # metrics are collected for the DB instance. To disable collection of
1510
1588
  # Enhanced Monitoring metrics, specify 0. The default is 0.
1511
1589
  #
1512
- # If `MonitoringRoleArn` is specified, then you must also set
1590
+ # If `MonitoringRoleArn` is specified, then you must set
1513
1591
  # `MonitoringInterval` to a value other than 0.
1514
1592
  #
1593
+ # This setting doesn't apply to RDS Custom.
1594
+ #
1515
1595
  # Valid Values: `0, 1, 5, 10, 15, 30, 60`
1516
1596
  # @option options [String] :monitoring_role_arn
1517
1597
  # The ARN for the IAM role that permits RDS to send enhanced monitoring
1518
1598
  # metrics to Amazon CloudWatch Logs. For example,
1519
1599
  # `arn:aws:iam:123456789012:role/emaccess`. For information on creating
1520
- # a monitoring role, go to [Setting Up and Enabling Enhanced
1600
+ # a monitoring role, see [Setting Up and Enabling Enhanced
1521
1601
  # Monitoring][1] in the *Amazon RDS User Guide*.
1522
1602
  #
1523
1603
  # If `MonitoringInterval` is set to a value other than 0, then you must
1524
1604
  # supply a `MonitoringRoleArn` value.
1525
1605
  #
1606
+ # This setting doesn't apply to RDS Custom.
1607
+ #
1526
1608
  #
1527
1609
  #
1528
1610
  # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Monitoring.OS.html#USER_Monitoring.OS.Enabling
1529
1611
  # @option options [String] :domain_iam_role_name
1530
1612
  # Specify the name of the IAM role to be used when making API calls to
1531
1613
  # the Directory Service.
1614
+ #
1615
+ # This setting doesn't apply to RDS Custom.
1532
1616
  # @option options [Integer] :promotion_tier
1533
1617
  # A value that specifies the order in which an Aurora Replica is
1534
1618
  # promoted to the primary instance after a failure of the existing
1535
1619
  # primary instance. For more information, see [ Fault Tolerance for an
1536
1620
  # Aurora DB Cluster][1] in the *Amazon Aurora User Guide*.
1537
1621
  #
1622
+ # This setting doesn't apply to RDS Custom.
1623
+ #
1538
1624
  # Default: 1
1539
1625
  #
1540
1626
  # Valid Values: 0 - 15
@@ -1554,9 +1640,9 @@ module Aws::RDS
1554
1640
  # Services Identity and Access Management (IAM) accounts to database
1555
1641
  # accounts. By default, mapping is disabled.
1556
1642
  #
1557
- # This setting doesn't apply to Amazon Aurora. Mapping Amazon Web
1558
- # Services IAM accounts to database accounts is managed by the DB
1559
- # cluster.
1643
+ # This setting doesn't apply to RDS Custom or Amazon Aurora. In Aurora,
1644
+ # mapping Amazon Web Services IAM accounts to database accounts is
1645
+ # managed by the DB cluster.
1560
1646
  #
1561
1647
  # For more information, see [ IAM Database Authentication for MySQL and
1562
1648
  # PostgreSQL][1] in the *Amazon RDS User Guide.*
@@ -1566,10 +1652,10 @@ module Aws::RDS
1566
1652
  # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.IAMDBAuth.html
1567
1653
  # @option options [Boolean] :enable_performance_insights
1568
1654
  # A value that indicates whether to enable Performance Insights for the
1569
- # DB instance.
1655
+ # DB instance. For more information, see [Using Amazon Performance
1656
+ # Insights][1] in the *Amazon Relational Database Service User Guide*.
1570
1657
  #
1571
- # For more information, see [Using Amazon Performance Insights][1] in
1572
- # the *Amazon Relational Database Service User Guide*.
1658
+ # This setting doesn't apply to RDS Custom.
1573
1659
  #
1574
1660
  #
1575
1661
  #
@@ -1579,27 +1665,33 @@ module Aws::RDS
1579
1665
  # Performance Insights data.
1580
1666
  #
1581
1667
  # The Amazon Web Services KMS key identifier is the key ARN, key ID,
1582
- # alias ARN, or alias name for the Amazon Web Services KMS customer
1583
- # master key (CMK).
1668
+ # alias ARN, or alias name for the KMS key.
1584
1669
  #
1585
1670
  # If you do not specify a value for `PerformanceInsightsKMSKeyId`, then
1586
- # Amazon RDS uses your default CMK. There is a default CMK for your
1587
- # Amazon Web Services account. Your Amazon Web Services account has a
1588
- # different default CMK for each Amazon Web Services Region.
1671
+ # Amazon RDS uses your default KMS key. There is a default KMS key for
1672
+ # your Amazon Web Services account. Your Amazon Web Services account has
1673
+ # a different default KMS key for each Amazon Web Services Region.
1674
+ #
1675
+ # This setting doesn't apply to RDS Custom.
1589
1676
  # @option options [Integer] :performance_insights_retention_period
1590
1677
  # The amount of time, in days, to retain Performance Insights data.
1591
1678
  # Valid values are 7 or 731 (2 years).
1679
+ #
1680
+ # This setting doesn't apply to RDS Custom.
1592
1681
  # @option options [Array<String>] :enable_cloudwatch_logs_exports
1593
1682
  # 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 being
1595
- # used. For more information, see [Publishing Database Logs to Amazon
1596
- # CloudWatch Logs ][1] in the *Amazon Relational Database Service User
1597
- # Guide*.
1683
+ # CloudWatch Logs. The values in the list depend on the DB engine. For
1684
+ # more information, see [Publishing Database Logs to Amazon CloudWatch
1685
+ # Logs][1] in the *Amazon Relational Database Service User Guide*.
1598
1686
  #
1599
1687
  # **Amazon Aurora**
1600
1688
  #
1601
1689
  # Not applicable. CloudWatch Logs exports are managed by the DB cluster.
1602
1690
  #
1691
+ # **RDS Custom**
1692
+ #
1693
+ # Not applicable.
1694
+ #
1603
1695
  # **MariaDB**
1604
1696
  #
1605
1697
  # Possible values are `audit`, `error`, `general`, and `slowquery`.
@@ -1627,6 +1719,8 @@ module Aws::RDS
1627
1719
  # @option options [Array<Types::ProcessorFeature>] :processor_features
1628
1720
  # The number of CPU cores and the number of threads per core for the DB
1629
1721
  # instance class of the DB instance.
1722
+ #
1723
+ # This setting doesn't apply to RDS Custom.
1630
1724
  # @option options [Boolean] :deletion_protection
1631
1725
  # A value that indicates whether the DB instance has deletion protection
1632
1726
  # enabled. The database can't be deleted when deletion protection is
@@ -1651,6 +1745,8 @@ module Aws::RDS
1651
1745
  # apply to it, see [ Managing capacity automatically with Amazon RDS
1652
1746
  # storage autoscaling][1] in the *Amazon RDS User Guide*.
1653
1747
  #
1748
+ # This setting doesn't apply to RDS Custom.
1749
+ #
1654
1750
  #
1655
1751
  #
1656
1752
  # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PIOPS.StorageTypes.html#USER_PIOPS.Autoscaling
@@ -1674,6 +1770,40 @@ module Aws::RDS
1674
1770
  #
1675
1771
  # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html
1676
1772
  # [2]: https://docs.aws.amazon.com/outposts/latest/userguide/outposts-networking-components.html#ip-addressing
1773
+ # @option options [String] :custom_iam_instance_profile
1774
+ # The instance profile associated with the underlying Amazon EC2
1775
+ # instance of an RDS Custom DB instance. The instance profile must meet
1776
+ # the following requirements:
1777
+ #
1778
+ # * The profile must exist in your account.
1779
+ #
1780
+ # * The profile must have an IAM role that Amazon EC2 has permissions to
1781
+ # assume.
1782
+ #
1783
+ # * The instance profile name and the associated IAM role name must
1784
+ # start with the prefix `AWSRDSCustom`.
1785
+ #
1786
+ # For the list of permissions required for the IAM role, see [ Configure
1787
+ # IAM and your VPC][1] in the *Amazon Relational Database Service User
1788
+ # Guide*.
1789
+ #
1790
+ # This setting is required for RDS Custom.
1791
+ #
1792
+ #
1793
+ #
1794
+ # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-setup-orcl.html#custom-setup-orcl.iam-vpc
1795
+ # @option options [String] :backup_target
1796
+ # Specifies where automated backups and manual snapshots are stored.
1797
+ #
1798
+ # Possible values are `outposts` (Amazon Web Services Outposts) and
1799
+ # `region` (Amazon Web Services Region). The default is `region`.
1800
+ #
1801
+ # For more information, see [Working with Amazon RDS on Amazon Web
1802
+ # Services Outposts][1] in the *Amazon RDS User Guide*.
1803
+ #
1804
+ #
1805
+ #
1806
+ # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html
1677
1807
  # @return [DBInstance]
1678
1808
  def create(options = {})
1679
1809
  options = options.merge(db_instance_identifier: @id)
@@ -1729,6 +1859,7 @@ module Aws::RDS
1729
1859
  # domain_iam_role_name: "String",
1730
1860
  # replica_mode: "open-read-only", # accepts open-read-only, mounted
1731
1861
  # max_allocated_storage: 1,
1862
+ # custom_iam_instance_profile: "String",
1732
1863
  # source_region: "String",
1733
1864
  # })
1734
1865
  # @param [Hash] options ({})
@@ -1770,10 +1901,14 @@ module Aws::RDS
1770
1901
  # support for the replica. Creating your read replica as a Multi-AZ DB
1771
1902
  # instance is independent of whether the source database is a Multi-AZ
1772
1903
  # DB instance.
1904
+ #
1905
+ # This setting doesn't apply to RDS Custom.
1773
1906
  # @option options [Boolean] :auto_minor_version_upgrade
1774
1907
  # A value that indicates whether minor engine upgrades are applied
1775
1908
  # automatically to the read replica during the maintenance window.
1776
1909
  #
1910
+ # This setting doesn't apply to RDS Custom.
1911
+ #
1777
1912
  # Default: Inherits from the source DB instance
1778
1913
  # @option options [Integer] :iops
1779
1914
  # The amount of Provisioned IOPS (input/output operations per second) to
@@ -1786,6 +1921,8 @@ module Aws::RDS
1786
1921
  # source instance.
1787
1922
  #
1788
1923
  # </note>
1924
+ #
1925
+ # This setting doesn't apply to RDS Custom.
1789
1926
  # @option options [String] :db_parameter_group_name
1790
1927
  # The name of the DB parameter group to associate with this DB instance.
1791
1928
  #
@@ -1794,10 +1931,8 @@ module Aws::RDS
1794
1931
  # region read replica, or the default `DBParameterGroup` for the
1795
1932
  # specified DB engine for a cross region read replica.
1796
1933
  #
1797
- # <note markdown="1"> Currently, specifying a parameter group for this operation is only
1798
- # supported for Oracle DB instances.
1799
- #
1800
- # </note>
1934
+ # Specifying a parameter group for this operation is only supported for
1935
+ # Oracle DB instances. It isn't supported for RDS Custom.
1801
1936
  #
1802
1937
  # Constraints:
1803
1938
  #
@@ -1854,7 +1989,10 @@ module Aws::RDS
1854
1989
  #
1855
1990
  # Example: `mySubnetgroup`
1856
1991
  # @option options [Array<String>] :vpc_security_group_ids
1857
- # A list of EC2 VPC security groups to associate with the read replica.
1992
+ # A list of Amazon EC2 VPC security groups to associate with the read
1993
+ # replica.
1994
+ #
1995
+ # This setting doesn't apply to RDS Custom.
1858
1996
  #
1859
1997
  # Default: The default EC2 VPC security group for the DB subnet group's
1860
1998
  # VPC.
@@ -1878,6 +2016,8 @@ module Aws::RDS
1878
2016
  # If `MonitoringRoleArn` is specified, then you must also set
1879
2017
  # `MonitoringInterval` to a value other than 0.
1880
2018
  #
2019
+ # This setting doesn't apply to RDS Custom.
2020
+ #
1881
2021
  # Valid Values: `0, 1, 5, 10, 15, 30, 60`
1882
2022
  # @option options [String] :monitoring_role_arn
1883
2023
  # The ARN for the IAM role that permits RDS to send enhanced monitoring
@@ -1889,6 +2029,8 @@ module Aws::RDS
1889
2029
  # If `MonitoringInterval` is set to a value other than 0, then you must
1890
2030
  # supply a `MonitoringRoleArn` value.
1891
2031
  #
2032
+ # This setting doesn't apply to RDS Custom.
2033
+ #
1892
2034
  #
1893
2035
  #
1894
2036
  # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Monitoring.html#USER_Monitoring.OS.IAMRole
@@ -1897,23 +2039,26 @@ module Aws::RDS
1897
2039
  # replica.
1898
2040
  #
1899
2041
  # The Amazon Web Services KMS key identifier is the key ARN, key ID,
1900
- # alias ARN, or alias name for the Amazon Web Services KMS CMK.
2042
+ # alias ARN, or alias name for the KMS key.
1901
2043
  #
1902
2044
  # If you create an encrypted read replica in the same Amazon Web
1903
2045
  # Services Region as the source DB instance, then do not specify a value
1904
- # for this parameter. A read replica in the same Region is always
1905
- # encrypted with the same Amazon Web Services KMS CMK as the source DB
2046
+ # for this parameter. A read replica in the same Amazon Web Services
2047
+ # Region is always encrypted with the same KMS key as the source DB
1906
2048
  # instance.
1907
2049
  #
1908
2050
  # If you create an encrypted read replica in a different Amazon Web
1909
- # Services Region, then you must specify a Amazon Web Services KMS key
1910
- # identifier for the destination Amazon Web Services Region. Amazon Web
1911
- # Services KMS CMKs are specific to the Amazon Web Services Region that
1912
- # they are created in, and you can't use CMKs from one Amazon Web
1913
- # Services Region in another Amazon Web Services Region.
2051
+ # Services Region, then you must specify a KMS key identifier for the
2052
+ # destination Amazon Web Services Region. KMS keys are specific to the
2053
+ # Amazon Web Services Region that they are created in, and you can't
2054
+ # use KMS keys from one Amazon Web Services Region in another Amazon Web
2055
+ # Services Region.
1914
2056
  #
1915
2057
  # You can't create an encrypted read replica from an unencrypted DB
1916
2058
  # instance.
2059
+ #
2060
+ # This setting doesn't apply to RDS Custom, which uses the same KMS key
2061
+ # as the primary replica.
1917
2062
  # @option options [String] :pre_signed_url
1918
2063
  # The URL that contains a Signature Version 4 signed request for the
1919
2064
  # `CreateDBInstanceReadReplica` API action in the source Amazon Web
@@ -1977,6 +2122,8 @@ module Aws::RDS
1977
2122
  #
1978
2123
  # </note>
1979
2124
  #
2125
+ # This setting doesn't apply to RDS Custom.
2126
+ #
1980
2127
  #
1981
2128
  #
1982
2129
  # [1]: https://docs.aws.amazon.com/AmazonS3/latest/API/sigv4-query-string-auth.html
@@ -1990,6 +2137,8 @@ module Aws::RDS
1990
2137
  # Database Authentication for MySQL and PostgreSQL][1] in the *Amazon
1991
2138
  # RDS User Guide.*
1992
2139
  #
2140
+ # This setting doesn't apply to RDS Custom.
2141
+ #
1993
2142
  #
1994
2143
  #
1995
2144
  # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.IAMDBAuth.html
@@ -2000,6 +2149,8 @@ module Aws::RDS
2000
2149
  # For more information, see [Using Amazon Performance Insights][1] in
2001
2150
  # the *Amazon RDS User Guide*.
2002
2151
  #
2152
+ # This setting doesn't apply to RDS Custom.
2153
+ #
2003
2154
  #
2004
2155
  #
2005
2156
  # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.html
@@ -2008,31 +2159,40 @@ module Aws::RDS
2008
2159
  # Performance Insights data.
2009
2160
  #
2010
2161
  # The Amazon Web Services KMS key identifier is the key ARN, key ID,
2011
- # alias ARN, or alias name for the Amazon Web Services KMS customer
2012
- # master key (CMK).
2162
+ # alias ARN, or alias name for the KMS key.
2013
2163
  #
2014
2164
  # If you do not specify a value for `PerformanceInsightsKMSKeyId`, then
2015
- # Amazon RDS uses your default CMK. There is a default CMK for your
2016
- # Amazon Web Services account. Your Amazon Web Services account has a
2017
- # different default CMK for each Amazon Web Services Region.
2165
+ # Amazon RDS uses your default KMS key. There is a default KMS key for
2166
+ # your Amazon Web Services account. Your Amazon Web Services account has
2167
+ # a different default KMS key for each Amazon Web Services Region.
2168
+ #
2169
+ # This setting doesn't apply to RDS Custom.
2018
2170
  # @option options [Integer] :performance_insights_retention_period
2019
2171
  # The amount of time, in days, to retain Performance Insights data.
2020
2172
  # Valid values are 7 or 731 (2 years).
2173
+ #
2174
+ # This setting doesn't apply to RDS Custom.
2021
2175
  # @option options [Array<String>] :enable_cloudwatch_logs_exports
2022
2176
  # The list of logs that the new DB instance is to export to CloudWatch
2023
2177
  # Logs. The values in the list depend on the DB engine being used. For
2024
2178
  # more information, see [Publishing Database Logs to Amazon CloudWatch
2025
2179
  # Logs ][1] in the *Amazon RDS User Guide*.
2026
2180
  #
2181
+ # This setting doesn't apply to RDS Custom.
2182
+ #
2027
2183
  #
2028
2184
  #
2029
2185
  # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch
2030
2186
  # @option options [Array<Types::ProcessorFeature>] :processor_features
2031
2187
  # The number of CPU cores and the number of threads per core for the DB
2032
2188
  # instance class of the DB instance.
2189
+ #
2190
+ # This setting doesn't apply to RDS Custom.
2033
2191
  # @option options [Boolean] :use_default_processor_features
2034
2192
  # A value that indicates whether the DB instance class of the DB
2035
2193
  # instance uses its default processor features.
2194
+ #
2195
+ # This setting doesn't apply to RDS Custom.
2036
2196
  # @option options [Boolean] :deletion_protection
2037
2197
  # A value that indicates whether the DB instance has deletion protection
2038
2198
  # enabled. The database can't be deleted when deletion protection is
@@ -2050,12 +2210,16 @@ module Aws::RDS
2050
2210
  # For more information, see [ Kerberos Authentication][1] in the *Amazon
2051
2211
  # RDS User Guide*.
2052
2212
  #
2213
+ # This setting doesn't apply to RDS Custom.
2214
+ #
2053
2215
  #
2054
2216
  #
2055
2217
  # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/kerberos-authentication.html
2056
2218
  # @option options [String] :domain_iam_role_name
2057
2219
  # Specify the name of the IAM role to be used when making API calls to
2058
2220
  # the Directory Service.
2221
+ #
2222
+ # This setting doesn't apply to RDS Custom.
2059
2223
  # @option options [String] :replica_mode
2060
2224
  # The open mode of the replica database: mounted or read-only.
2061
2225
  #
@@ -2063,17 +2227,22 @@ module Aws::RDS
2063
2227
  #
2064
2228
  # </note>
2065
2229
  #
2066
- # Mounted DB replicas are included in Oracle Enterprise Edition. The
2067
- # main use case for mounted replicas is cross-Region disaster recovery.
2068
- # The primary database doesn't use Active Data Guard to transmit
2069
- # information to the mounted replica. Because it doesn't accept user
2070
- # connections, a mounted replica can't serve a read-only workload.
2230
+ # Mounted DB replicas are included in Oracle Database Enterprise
2231
+ # Edition. The main use case for mounted replicas is cross-Region
2232
+ # disaster recovery. The primary database doesn't use Active Data Guard
2233
+ # to transmit information to the mounted replica. Because it doesn't
2234
+ # accept user connections, a mounted replica can't serve a read-only
2235
+ # workload.
2071
2236
  #
2072
2237
  # You can create a combination of mounted and read-only DB replicas for
2073
2238
  # the same primary DB instance. For more information, see [Working with
2074
2239
  # Oracle Read Replicas for Amazon RDS][1] in the *Amazon RDS User
2075
2240
  # Guide*.
2076
2241
  #
2242
+ # For RDS Custom, you must specify this parameter and set it to
2243
+ # `mounted`. The value won't be set by default. After replica creation,
2244
+ # you can manage the open mode manually.
2245
+ #
2077
2246
  #
2078
2247
  #
2079
2248
  # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/oracle-read-replicas.html
@@ -2088,6 +2257,28 @@ module Aws::RDS
2088
2257
  #
2089
2258
  #
2090
2259
  # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PIOPS.StorageTypes.html#USER_PIOPS.Autoscaling
2260
+ # @option options [String] :custom_iam_instance_profile
2261
+ # The instance profile associated with the underlying Amazon EC2
2262
+ # instance of an RDS Custom DB instance. The instance profile must meet
2263
+ # the following requirements:
2264
+ #
2265
+ # * The profile must exist in your account.
2266
+ #
2267
+ # * The profile must have an IAM role that Amazon EC2 has permissions to
2268
+ # assume.
2269
+ #
2270
+ # * The instance profile name and the associated IAM role name must
2271
+ # start with the prefix `AWSRDSCustom`.
2272
+ #
2273
+ # For the list of permissions required for the IAM role, see [ Configure
2274
+ # IAM and your VPC][1] in the *Amazon Relational Database Service User
2275
+ # Guide*.
2276
+ #
2277
+ # This setting is required for RDS Custom.
2278
+ #
2279
+ #
2280
+ #
2281
+ # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-setup-orcl.html#custom-setup-orcl.iam-vpc
2091
2282
  # @option options [String] :source_region
2092
2283
  # The source region of the snapshot. This is only needed when the
2093
2284
  # shapshot is encrypted and in a different region.
@@ -2157,30 +2348,36 @@ module Aws::RDS
2157
2348
  # @param [Hash] options ({})
2158
2349
  # @option options [Boolean] :skip_final_snapshot
2159
2350
  # A value that indicates whether to skip the creation of a final DB
2160
- # snapshot before the DB instance is deleted. If skip is specified, no
2161
- # DB snapshot is created. If skip isn't specified, a DB snapshot is
2162
- # created before the DB instance is deleted. By default, skip isn't
2163
- # specified, and the DB snapshot is created.
2351
+ # snapshot before deleting the instance. If you enable this parameter,
2352
+ # RDS doesn't create a DB snapshot. If you don't enable this
2353
+ # parameter, RDS creates a DB snapshot before the DB instance is
2354
+ # deleted. By default, skip isn't enabled, and the DB snapshot is
2355
+ # created.
2164
2356
  #
2165
- # When a DB instance is in a failure state and has a status of
2166
- # 'failed', 'incompatible-restore', or 'incompatible-network', it
2167
- # can only be deleted when skip is specified.
2357
+ # <note markdown="1"> If you don't enable this parameter, you must specify the
2358
+ # `FinalDBSnapshotIdentifier` parameter.
2168
2359
  #
2169
- # Specify skip when deleting a read replica.
2360
+ # </note>
2170
2361
  #
2171
- # <note markdown="1"> The FinalDBSnapshotIdentifier parameter must be specified if skip
2172
- # isn't specified.
2362
+ # When a DB instance is in a failure state and has a status of `failed`,
2363
+ # `incompatible-restore`, or `incompatible-network`, RDS can delete the
2364
+ # instance only if you enable this parameter.
2173
2365
  #
2174
- # </note>
2366
+ # If you delete a read replica or an RDS Custom instance, you must
2367
+ # enable this setting.
2368
+ #
2369
+ # This setting is required for RDS Custom.
2175
2370
  # @option options [String] :final_db_snapshot_identifier
2176
2371
  # The `DBSnapshotIdentifier` of the new `DBSnapshot` created when the
2177
2372
  # `SkipFinalSnapshot` parameter is disabled.
2178
2373
  #
2179
- # <note markdown="1"> Specifying this parameter and also specifying to skip final DB
2180
- # snapshot creation in SkipFinalShapshot results in an error.
2374
+ # <note markdown="1"> If you enable this parameter and also enable SkipFinalShapshot, the
2375
+ # command results in an error.
2181
2376
  #
2182
2377
  # </note>
2183
2378
  #
2379
+ # This setting doesn't apply to RDS Custom.
2380
+ #
2184
2381
  # Constraints:
2185
2382
  #
2186
2383
  # * Must be 1 to 255 letters or numbers.
@@ -2261,6 +2458,8 @@ module Aws::RDS
2261
2458
  # replica_mode: "open-read-only", # accepts open-read-only, mounted
2262
2459
  # enable_customer_owned_ip: false,
2263
2460
  # aws_backup_recovery_point_arn: "AwsBackupRecoveryPointArn",
2461
+ # automation_mode: "full", # accepts full, all-paused
2462
+ # resume_full_automation_mode_minutes: 1,
2264
2463
  # })
2265
2464
  # @param [Hash] options ({})
2266
2465
  # @option options [Integer] :allocated_storage
@@ -2279,12 +2478,14 @@ module Aws::RDS
2279
2478
  # `db.m4.large`. Not all DB instance classes are available in all Amazon
2280
2479
  # Web Services Regions, or for all database engines. For the full list
2281
2480
  # of DB instance classes, and availability for your engine, see [DB
2282
- # Instance Class][1] in the *Amazon RDS User Guide.*
2481
+ # Instance Class][1] in the *Amazon RDS User Guide*.
2283
2482
  #
2284
2483
  # If you modify the DB instance class, an outage occurs during the
2285
2484
  # change. The change is applied during the next maintenance window,
2286
2485
  # unless `ApplyImmediately` is enabled for this request.
2287
2486
  #
2487
+ # This setting doesn't apply to RDS Custom.
2488
+ #
2288
2489
  # Default: Uses existing setting
2289
2490
  #
2290
2491
  #
@@ -2295,12 +2496,14 @@ module Aws::RDS
2295
2496
  # parameter to move your DB instance to a different VPC. If your DB
2296
2497
  # instance isn't in a VPC, you can also use this parameter to move your
2297
2498
  # 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.*
2499
+ # instance in a VPC][1] in the *Amazon RDS User Guide*.
2299
2500
  #
2300
2501
  # Changing the subnet group causes an outage during the change. The
2301
2502
  # change is applied during the next maintenance window, unless you
2302
2503
  # enable `ApplyImmediately`.
2303
2504
  #
2505
+ # This parameter doesn't apply to RDS Custom.
2506
+ #
2304
2507
  # Constraints: If supplied, must match the name of an existing
2305
2508
  # DBSubnetGroup.
2306
2509
  #
@@ -2314,14 +2517,18 @@ module Aws::RDS
2314
2517
  # Changing this setting doesn't result in an outage and the change is
2315
2518
  # asynchronously applied as soon as possible.
2316
2519
  #
2520
+ # This setting doesn't apply to RDS Custom.
2521
+ #
2317
2522
  # Constraints:
2318
2523
  #
2319
2524
  # * If supplied, must match existing DBSecurityGroups.
2320
2525
  #
2321
2526
  # ^
2322
2527
  # @option options [Array<String>] :vpc_security_group_ids
2323
- # A list of EC2 VPC security groups to authorize on this DB instance.
2324
- # This change is asynchronously applied as soon as possible.
2528
+ # A list of Amazon EC2 VPC security groups to authorize on this DB
2529
+ # instance. This change is asynchronously applied as soon as possible.
2530
+ #
2531
+ # This setting doesn't apply to RDS Custom.
2325
2532
  #
2326
2533
  # **Amazon Aurora**
2327
2534
  #
@@ -2361,6 +2568,8 @@ module Aws::RDS
2361
2568
  # element exists in the `PendingModifiedValues` element of the operation
2362
2569
  # response.
2363
2570
  #
2571
+ # This setting doesn't apply to RDS Custom.
2572
+ #
2364
2573
  # **Amazon Aurora**
2365
2574
  #
2366
2575
  # Not applicable. The password for the master user is managed by the DB
@@ -2396,17 +2605,22 @@ module Aws::RDS
2396
2605
  # </note>
2397
2606
  # @option options [String] :db_parameter_group_name
2398
2607
  # The name of the DB parameter group to apply to the DB instance.
2608
+ #
2399
2609
  # Changing this setting doesn't result in an outage. The parameter
2400
2610
  # group name itself is changed immediately, but the actual parameter
2401
2611
  # 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 isn't applied during the next maintenance
2404
- # window.
2612
+ # failover. In this case, the DB instance isn't rebooted automatically,
2613
+ # and the parameter changes aren't applied during the next maintenance
2614
+ # window. However, if you modify dynamic parameters in the newly
2615
+ # associated DB parameter group, these changes are applied immediately
2616
+ # without a reboot.
2617
+ #
2618
+ # This setting doesn't apply to RDS Custom.
2405
2619
  #
2406
2620
  # Default: Uses existing setting
2407
2621
  #
2408
2622
  # Constraints: The DB parameter group must be in the same DB parameter
2409
- # group family as this DB instance.
2623
+ # group family as the DB instance.
2410
2624
  # @option options [Integer] :backup_retention_period
2411
2625
  # The number of days to retain automated backups. Setting this parameter
2412
2626
  # to a positive number enables backups. Setting this parameter to 0
@@ -2432,15 +2646,15 @@ module Aws::RDS
2432
2646
  #
2433
2647
  # Constraints:
2434
2648
  #
2435
- # * Must be a value from 0 to 35
2436
- #
2437
- # * Can be specified for a MySQL read replica only if the source is
2438
- # running MySQL 5.6 or later
2649
+ # * It must be a value from 0 to 35. It can't be set to 0 if the DB
2650
+ # instance is a source to read replicas. It can't be set to 0 or 35
2651
+ # for an RDS Custom DB instance.
2439
2652
  #
2440
- # * Can be specified for a PostgreSQL read replica only if the source is
2441
- # running PostgreSQL 9.3.5
2653
+ # * It can be specified for a MySQL read replica only if the source is
2654
+ # running MySQL 5.6 or later.
2442
2655
  #
2443
- # * Can't be set to 0 if the DB instance is a source to read replicas
2656
+ # * It can be specified for a PostgreSQL read replica only if the source
2657
+ # is running PostgreSQL 9.3.5.
2444
2658
  # @option options [String] :preferred_backup_window
2445
2659
  # The daily time range during which automated backups are created if
2446
2660
  # automated backups are enabled, as determined by the
@@ -2496,9 +2710,11 @@ module Aws::RDS
2496
2710
  # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_UpgradeDBInstance.Maintenance.html#Concepts.DBMaintenance
2497
2711
  # @option options [Boolean] :multi_az
2498
2712
  # A value that indicates whether the DB instance is a Multi-AZ
2499
- # deployment. Changing this parameter doesn't result in an outage and
2500
- # the change is applied during the next maintenance window unless the
2713
+ # deployment. Changing this parameter doesn't result in an outage. The
2714
+ # change is applied during the next maintenance window unless the
2501
2715
  # `ApplyImmediately` parameter is enabled for this request.
2716
+ #
2717
+ # This setting doesn't apply to RDS Custom.
2502
2718
  # @option options [String] :engine_version
2503
2719
  # The version number of the database engine to upgrade to. Changing this
2504
2720
  # parameter results in an outage and the change is applied during the
@@ -2514,25 +2730,40 @@ module Aws::RDS
2514
2730
  # instance to the default minor version if the current minor version is
2515
2731
  # lower. For information about valid engine versions, see
2516
2732
  # `CreateDBInstance`, or call `DescribeDBEngineVersions`.
2733
+ #
2734
+ # In RDS Custom, this parameter is supported for read replicas only if
2735
+ # they are in the `PATCH_DB_FAILURE` lifecycle.
2517
2736
  # @option options [Boolean] :allow_major_version_upgrade
2518
2737
  # A value that indicates whether major version upgrades are allowed.
2519
2738
  # Changing this parameter doesn't result in an outage and the change is
2520
2739
  # asynchronously applied as soon as possible.
2521
2740
  #
2741
+ # This setting doesn't apply to RDS Custom.
2742
+ #
2522
2743
  # Constraints: Major version upgrades must be allowed when specifying a
2523
2744
  # value for the EngineVersion parameter that is a different major
2524
2745
  # version than the DB instance's current version.
2525
2746
  # @option options [Boolean] :auto_minor_version_upgrade
2526
2747
  # A value that indicates whether minor version upgrades are applied
2527
- # automatically to the DB instance during the maintenance window.
2528
- # Changing this parameter doesn't result in an outage except in the
2529
- # following case and the change is asynchronously applied as soon as
2530
- # possible. An outage results if this parameter is enabled during the
2531
- # maintenance window, and a newer minor version is available, and RDS
2532
- # has enabled auto patching for that engine version.
2748
+ # automatically to the DB instance during the maintenance window. An
2749
+ # outage occurs when all the following conditions are met:
2750
+ #
2751
+ # * The automatic upgrade is enabled for the maintenance window.
2752
+ #
2753
+ # * A newer minor version is available.
2754
+ #
2755
+ # * RDS has enabled automatic patching for the engine version.
2756
+ #
2757
+ # If any of the preceding conditions isn't met, RDS applies the change
2758
+ # as soon as possible and doesn't cause an outage.
2759
+ #
2760
+ # For an RDS Custom DB instance, set `AutoMinorVersionUpgrade` to
2761
+ # `false`. Otherwise, the operation returns an error.
2533
2762
  # @option options [String] :license_model
2534
2763
  # The license model for the DB instance.
2535
2764
  #
2765
+ # This setting doesn't apply to RDS Custom.
2766
+ #
2536
2767
  # Valid values: `license-included` \| `bring-your-own-license` \|
2537
2768
  # `general-public-license`
2538
2769
  # @option options [Integer] :iops
@@ -2569,18 +2800,23 @@ module Aws::RDS
2569
2800
  # Default: Uses existing setting
2570
2801
  # @option options [String] :option_group_name
2571
2802
  # A value that indicates the DB instance should be associated with the
2572
- # specified option group. Changing this parameter doesn't result in an
2573
- # outage except in the following case and the change is applied during
2574
- # the next maintenance window unless the `ApplyImmediately` parameter is
2575
- # enabled for this request. If the parameter change results in an option
2576
- # group that enables OEM, this change can cause a brief (sub-second)
2577
- # period during which new connections are rejected but existing
2578
- # connections are not interrupted.
2803
+ # specified option group.
2804
+ #
2805
+ # Changing this parameter doesn't result in an outage, with one
2806
+ # exception. If the parameter change results in an option group that
2807
+ # enables OEM, it can cause a brief period, lasting less than a second,
2808
+ # during which new connections are rejected but existing connections
2809
+ # aren't interrupted.
2810
+ #
2811
+ # The change is applied during the next maintenance window unless the
2812
+ # `ApplyImmediately` parameter is enabled for this request.
2579
2813
  #
2580
2814
  # Permanent options, such as the TDE option for Oracle Advanced Security
2581
2815
  # TDE, can't be removed from an option group, and that option group
2582
- # can't be removed from a DB instance once it is associated with a DB
2583
- # instance
2816
+ # can't be removed from a DB instance after it is associated with a DB
2817
+ # instance.
2818
+ #
2819
+ # This setting doesn't apply to RDS Custom.
2584
2820
  # @option options [String] :new_db_instance_identifier
2585
2821
  # The new DB instance identifier for the DB instance when renaming a DB
2586
2822
  # instance. When you change the DB instance identifier, an instance
@@ -2588,6 +2824,8 @@ module Aws::RDS
2588
2824
  # occur during the next maintenance window if you disable Apply
2589
2825
  # Immediately. This value is stored as a lowercase string.
2590
2826
  #
2827
+ # This setting doesn't apply to RDS Custom.
2828
+ #
2591
2829
  # Constraints:
2592
2830
  #
2593
2831
  # * Must contain from 1 to 63 letters, numbers, or hyphens.
@@ -2624,22 +2862,29 @@ module Aws::RDS
2624
2862
  # @option options [String] :tde_credential_arn
2625
2863
  # The ARN from the key store with which to associate the instance for
2626
2864
  # TDE encryption.
2865
+ #
2866
+ # This setting doesn't apply to RDS Custom.
2627
2867
  # @option options [String] :tde_credential_password
2628
2868
  # The password for the given ARN from the key store in order to access
2629
2869
  # the device.
2870
+ #
2871
+ # This setting doesn't apply to RDS Custom.
2630
2872
  # @option options [String] :ca_certificate_identifier
2631
- # Indicates the certificate that needs to be associated with the
2632
- # instance.
2873
+ # Specifies the certificate to associate with the DB instance.
2874
+ #
2875
+ # This setting doesn't apply to RDS Custom.
2633
2876
  # @option options [String] :domain
2634
2877
  # The Active Directory directory ID to move the DB instance to. Specify
2635
- # `none` to remove the instance from its current domain. The domain must
2636
- # be created prior to this operation. Currently, only MySQL, Microsoft
2637
- # SQL Server, Oracle, and PostgreSQL DB instances can be created in an
2878
+ # `none` to remove the instance from its current domain. You must create
2879
+ # the domain before this operation. Currently, you can create only
2880
+ # MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances in an
2638
2881
  # Active Directory Domain.
2639
2882
  #
2640
2883
  # For more information, see [ Kerberos Authentication][1] in the *Amazon
2641
2884
  # RDS User Guide*.
2642
2885
  #
2886
+ # This setting doesn't apply to RDS Custom.
2887
+ #
2643
2888
  #
2644
2889
  #
2645
2890
  # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/kerberos-authentication.html
@@ -2655,10 +2900,12 @@ module Aws::RDS
2655
2900
  # @option options [Integer] :monitoring_interval
2656
2901
  # The interval, in seconds, between points when Enhanced Monitoring
2657
2902
  # metrics are collected for the DB instance. To disable collecting
2658
- # Enhanced Monitoring metrics, specify 0. The default is 0.
2903
+ # Enhanced Monitoring metrics, specify 0, which is the default.
2659
2904
  #
2660
- # If `MonitoringRoleArn` is specified, then you must also set
2661
- # `MonitoringInterval` to a value other than 0.
2905
+ # If `MonitoringRoleArn` is specified, set `MonitoringInterval` to a
2906
+ # value other than 0.
2907
+ #
2908
+ # This setting doesn't apply to RDS Custom.
2662
2909
  #
2663
2910
  # Valid Values: `0, 1, 5, 10, 15, 30, 60`
2664
2911
  # @option options [Integer] :db_port_number
@@ -2668,9 +2915,11 @@ module Aws::RDS
2668
2915
  # port values specified for options in the option group for the DB
2669
2916
  # instance.
2670
2917
  #
2671
- # Your database will restart when you change the `DBPortNumber` value
2918
+ # If you change the `DBPortNumber` value, your database restarts
2672
2919
  # regardless of the value of the `ApplyImmediately` parameter.
2673
2920
  #
2921
+ # This setting doesn't apply to RDS Custom.
2922
+ #
2674
2923
  # **MySQL**
2675
2924
  #
2676
2925
  # Default: `3306`
@@ -2728,15 +2977,19 @@ module Aws::RDS
2728
2977
  #
2729
2978
  # Changes to the `PubliclyAccessible` parameter are applied immediately
2730
2979
  # regardless of the value of the `ApplyImmediately` parameter.
2980
+ #
2981
+ # This setting doesn't apply to RDS Custom.
2731
2982
  # @option options [String] :monitoring_role_arn
2732
2983
  # The ARN for the IAM role that permits RDS to send enhanced monitoring
2733
2984
  # metrics to Amazon CloudWatch Logs. For example,
2734
2985
  # `arn:aws:iam:123456789012:role/emaccess`. For information on creating
2735
- # a monitoring role, go to [To create an IAM role for Amazon RDS
2736
- # Enhanced Monitoring][1] in the *Amazon RDS User Guide.*
2986
+ # a monitoring role, see [To create an IAM role for Amazon RDS Enhanced
2987
+ # Monitoring][1] in the *Amazon RDS User Guide.*
2737
2988
  #
2738
- # If `MonitoringInterval` is set to a value other than 0, then you must
2739
- # supply a `MonitoringRoleArn` value.
2989
+ # If `MonitoringInterval` is set to a value other than 0, supply a
2990
+ # `MonitoringRoleArn` value.
2991
+ #
2992
+ # This setting doesn't apply to RDS Custom.
2740
2993
  #
2741
2994
  #
2742
2995
  #
@@ -2744,12 +2997,16 @@ module Aws::RDS
2744
2997
  # @option options [String] :domain_iam_role_name
2745
2998
  # The name of the IAM role to use when making API calls to the Directory
2746
2999
  # Service.
3000
+ #
3001
+ # This setting doesn't apply to RDS Custom.
2747
3002
  # @option options [Integer] :promotion_tier
2748
3003
  # A value that specifies the order in which an Aurora Replica is
2749
3004
  # promoted to the primary instance after a failure of the existing
2750
3005
  # primary instance. For more information, see [ Fault Tolerance for an
2751
3006
  # Aurora DB Cluster][1] in the *Amazon Aurora User Guide*.
2752
3007
  #
3008
+ # This setting doesn't apply to RDS Custom.
3009
+ #
2753
3010
  # Default: 1
2754
3011
  #
2755
3012
  # Valid Values: 0 - 15
@@ -2770,6 +3027,8 @@ module Aws::RDS
2770
3027
  # Database Authentication for MySQL and PostgreSQL][1] in the *Amazon
2771
3028
  # RDS User Guide.*
2772
3029
  #
3030
+ # This setting doesn't apply to RDS Custom.
3031
+ #
2773
3032
  #
2774
3033
  #
2775
3034
  # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.IAMDBAuth.html
@@ -2780,6 +3039,8 @@ module Aws::RDS
2780
3039
  # For more information, see [Using Amazon Performance Insights][1] in
2781
3040
  # the *Amazon Relational Database Service User Guide*.
2782
3041
  #
3042
+ # This setting doesn't apply to RDS Custom.
3043
+ #
2783
3044
  #
2784
3045
  #
2785
3046
  # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.html
@@ -2788,16 +3049,19 @@ module Aws::RDS
2788
3049
  # Performance Insights data.
2789
3050
  #
2790
3051
  # The Amazon Web Services KMS key identifier is the key ARN, key ID,
2791
- # alias ARN, or alias name for the Amazon Web Services KMS customer
2792
- # master key (CMK).
3052
+ # alias ARN, or alias name for the KMS key.
2793
3053
  #
2794
3054
  # If you do not specify a value for `PerformanceInsightsKMSKeyId`, then
2795
- # Amazon RDS uses your default CMK. There is a default CMK for your
2796
- # Amazon Web Services account. Your Amazon Web Services account has a
2797
- # different default CMK for each Amazon Web Services Region.
3055
+ # Amazon RDS uses your default KMS key. There is a default KMS key for
3056
+ # your Amazon Web Services account. Your Amazon Web Services account has
3057
+ # a different default KMS key for each Amazon Web Services Region.
3058
+ #
3059
+ # This setting doesn't apply to RDS Custom.
2798
3060
  # @option options [Integer] :performance_insights_retention_period
2799
3061
  # The amount of time, in days, to retain Performance Insights data.
2800
3062
  # Valid values are 7 or 731 (2 years).
3063
+ #
3064
+ # This setting doesn't apply to RDS Custom.
2801
3065
  # @option options [Types::CloudwatchLogsExportConfiguration] :cloudwatch_logs_export_configuration
2802
3066
  # The configuration setting for the log types to be enabled for export
2803
3067
  # to CloudWatch Logs for a specific DB instance.
@@ -2805,12 +3069,18 @@ module Aws::RDS
2805
3069
  # A change to the `CloudwatchLogsExportConfiguration` parameter is
2806
3070
  # always applied to the DB instance immediately. Therefore, the
2807
3071
  # `ApplyImmediately` parameter has no effect.
3072
+ #
3073
+ # This setting doesn't apply to RDS Custom.
2808
3074
  # @option options [Array<Types::ProcessorFeature>] :processor_features
2809
3075
  # The number of CPU cores and the number of threads per core for the DB
2810
3076
  # instance class of the DB instance.
3077
+ #
3078
+ # This setting doesn't apply to RDS Custom.
2811
3079
  # @option options [Boolean] :use_default_processor_features
2812
3080
  # A value that indicates whether the DB instance class of the DB
2813
3081
  # instance uses its default processor features.
3082
+ #
3083
+ # This setting doesn't apply to RDS Custom.
2814
3084
  # @option options [Boolean] :deletion_protection
2815
3085
  # A value that indicates whether the DB instance has deletion protection
2816
3086
  # enabled. The database can't be deleted when deletion protection is
@@ -2828,6 +3098,8 @@ module Aws::RDS
2828
3098
  # apply to it, see [ Managing capacity automatically with Amazon RDS
2829
3099
  # storage autoscaling][1] in the *Amazon RDS User Guide*.
2830
3100
  #
3101
+ # This setting doesn't apply to RDS Custom.
3102
+ #
2831
3103
  #
2832
3104
  #
2833
3105
  # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PIOPS.StorageTypes.html#USER_PIOPS.Autoscaling
@@ -2854,6 +3126,8 @@ module Aws::RDS
2854
3126
  # Aurora DB engines, see [ Rotating Your SSL/TLS Certificate][2] in
2855
3127
  # the *Amazon Aurora User Guide.*
2856
3128
  #
3129
+ # This setting doesn't apply to RDS Custom.
3130
+ #
2857
3131
  #
2858
3132
  #
2859
3133
  # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.SSL-certificate-rotation.html
@@ -2874,6 +3148,8 @@ module Aws::RDS
2874
3148
  # more information, see [Working with Oracle Read Replicas for Amazon
2875
3149
  # RDS][1] in the *Amazon RDS User Guide*.
2876
3150
  #
3151
+ # This setting doesn't apply to RDS Custom.
3152
+ #
2877
3153
  #
2878
3154
  #
2879
3155
  # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/oracle-read-replicas.html
@@ -2900,6 +3176,17 @@ module Aws::RDS
2900
3176
  # @option options [String] :aws_backup_recovery_point_arn
2901
3177
  # The Amazon Resource Name (ARN) of the recovery point in Amazon Web
2902
3178
  # Services Backup.
3179
+ #
3180
+ # This setting doesn't apply to RDS Custom.
3181
+ # @option options [String] :automation_mode
3182
+ # The automation mode of the RDS Custom DB instance: `full` or `all
3183
+ # paused`. If `full`, the DB instance automates monitoring and instance
3184
+ # recovery. If `all paused`, the instance pauses automation for the
3185
+ # duration set by `ResumeFullAutomationModeMinutes`.
3186
+ # @option options [Integer] :resume_full_automation_mode_minutes
3187
+ # The number of minutes to pause the automation. When the time period
3188
+ # ends, RDS Custom resumes full automation. The minimum value is `60`
3189
+ # (default). The maximum value is `1,440`.
2903
3190
  # @return [DBInstance]
2904
3191
  def modify(options = {})
2905
3192
  options = options.merge(db_instance_identifier: @id)
@@ -3033,6 +3320,8 @@ module Aws::RDS
3033
3320
  # max_allocated_storage: 1,
3034
3321
  # source_db_instance_automated_backups_arn: "String",
3035
3322
  # enable_customer_owned_ip: false,
3323
+ # custom_iam_instance_profile: "String",
3324
+ # backup_target: "String",
3036
3325
  # })
3037
3326
  # @param [Hash] options ({})
3038
3327
  # @option options [required, String] :target_db_instance_identifier
@@ -3104,6 +3393,8 @@ module Aws::RDS
3104
3393
  # A value that indicates whether the DB instance is a Multi-AZ
3105
3394
  # deployment.
3106
3395
  #
3396
+ # This setting doesn't apply to RDS Custom.
3397
+ #
3107
3398
  # Constraint: You can't specify the `AvailabilityZone` parameter if the
3108
3399
  # DB instance is a Multi-AZ deployment.
3109
3400
  # @option options [Boolean] :publicly_accessible
@@ -3123,9 +3414,13 @@ module Aws::RDS
3123
3414
  # @option options [Boolean] :auto_minor_version_upgrade
3124
3415
  # A value that indicates whether minor version upgrades are applied
3125
3416
  # automatically to the DB instance during the maintenance window.
3417
+ #
3418
+ # This setting doesn't apply to RDS Custom.
3126
3419
  # @option options [String] :license_model
3127
3420
  # License model information for the restored DB instance.
3128
3421
  #
3422
+ # This setting doesn't apply to RDS Custom.
3423
+ #
3129
3424
  # Default: Same as source.
3130
3425
  #
3131
3426
  # Valid values: `license-included` \| `bring-your-own-license` \|
@@ -3133,12 +3428,15 @@ module Aws::RDS
3133
3428
  # @option options [String] :db_name
3134
3429
  # The database name for the restored DB instance.
3135
3430
  #
3136
- # <note markdown="1"> This parameter isn't used for the MySQL or MariaDB engines.
3431
+ # <note markdown="1"> This parameter isn't supported for the MySQL or MariaDB engines. It
3432
+ # also doesn't apply to RDS Custom.
3137
3433
  #
3138
3434
  # </note>
3139
3435
  # @option options [String] :engine
3140
3436
  # The database engine to use for the new instance.
3141
3437
  #
3438
+ # This setting doesn't apply to RDS Custom.
3439
+ #
3142
3440
  # Default: The same as source
3143
3441
  #
3144
3442
  # Constraint: Must be compatible with the engine of the source
@@ -3181,8 +3479,10 @@ module Aws::RDS
3181
3479
  #
3182
3480
  # Permanent options, such as the TDE option for Oracle Advanced Security
3183
3481
  # TDE, can't be removed from an option group, and that option group
3184
- # can't be removed from a DB instance once it is associated with a DB
3482
+ # can't be removed from a DB instance after it is associated with a DB
3185
3483
  # instance
3484
+ #
3485
+ # This setting doesn't apply to RDS Custom.
3186
3486
  # @option options [Boolean] :copy_tags_to_snapshot
3187
3487
  # A value that indicates whether to copy all tags from the restored DB
3188
3488
  # instance to snapshots of the DB instance. By default, tags are not
@@ -3206,9 +3506,13 @@ module Aws::RDS
3206
3506
  # @option options [String] :tde_credential_arn
3207
3507
  # The ARN from the key store with which to associate the instance for
3208
3508
  # TDE encryption.
3509
+ #
3510
+ # This setting doesn't apply to RDS Custom.
3209
3511
  # @option options [String] :tde_credential_password
3210
3512
  # The password for the given ARN from the key store in order to access
3211
3513
  # the device.
3514
+ #
3515
+ # This setting doesn't apply to RDS Custom.
3212
3516
  # @option options [Array<String>] :vpc_security_group_ids
3213
3517
  # A list of EC2 VPC security groups to associate with this DB instance.
3214
3518
  #
@@ -3216,9 +3520,11 @@ module Aws::RDS
3216
3520
  # VPC.
3217
3521
  # @option options [String] :domain
3218
3522
  # Specify the Active Directory directory ID to restore the DB instance
3219
- # in. The domain must be created prior to this operation. Currently,
3220
- # only MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances
3221
- # can be created in an Active Directory Domain.
3523
+ # in. Create the domain before running this command. Currently, you can
3524
+ # create only the MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB
3525
+ # instances in an Active Directory Domain.
3526
+ #
3527
+ # This setting doesn't apply to RDS Custom.
3222
3528
  #
3223
3529
  # For more information, see [ Kerberos Authentication][1] in the *Amazon
3224
3530
  # RDS User Guide*.
@@ -3229,11 +3535,15 @@ module Aws::RDS
3229
3535
  # @option options [String] :domain_iam_role_name
3230
3536
  # Specify the name of the IAM role to be used when making API calls to
3231
3537
  # the Directory Service.
3538
+ #
3539
+ # This setting doesn't apply to RDS Custom.
3232
3540
  # @option options [Boolean] :enable_iam_database_authentication
3233
3541
  # A value that indicates whether to enable mapping of Amazon Web
3234
3542
  # Services Identity and Access Management (IAM) accounts to database
3235
3543
  # accounts. By default, mapping is disabled.
3236
3544
  #
3545
+ # This setting doesn't apply to RDS Custom.
3546
+ #
3237
3547
  # For more information about IAM database authentication, see [ IAM
3238
3548
  # Database Authentication for MySQL and PostgreSQL][1] in the *Amazon
3239
3549
  # RDS User Guide.*
@@ -3247,21 +3557,29 @@ module Aws::RDS
3247
3557
  # used. For more information, see [Publishing Database Logs to Amazon
3248
3558
  # CloudWatch Logs][1] in the *Amazon RDS User Guide*.
3249
3559
  #
3560
+ # This setting doesn't apply to RDS Custom.
3561
+ #
3250
3562
  #
3251
3563
  #
3252
3564
  # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch
3253
3565
  # @option options [Array<Types::ProcessorFeature>] :processor_features
3254
3566
  # The number of CPU cores and the number of threads per core for the DB
3255
3567
  # instance class of the DB instance.
3568
+ #
3569
+ # This setting doesn't apply to RDS Custom.
3256
3570
  # @option options [Boolean] :use_default_processor_features
3257
3571
  # A value that indicates whether the DB instance class of the DB
3258
3572
  # instance uses its default processor features.
3573
+ #
3574
+ # This setting doesn't apply to RDS Custom.
3259
3575
  # @option options [String] :db_parameter_group_name
3260
3576
  # The name of the DB parameter group to associate with this DB instance.
3261
3577
  #
3262
3578
  # If you do not specify a value for `DBParameterGroupName`, then the
3263
3579
  # default `DBParameterGroup` for the specified DB engine is used.
3264
3580
  #
3581
+ # This setting doesn't apply to RDS Custom.
3582
+ #
3265
3583
  # Constraints:
3266
3584
  #
3267
3585
  # * If supplied, must match the name of an existing DBParameterGroup.
@@ -3290,6 +3608,8 @@ module Aws::RDS
3290
3608
  # apply to it, see [ Managing capacity automatically with Amazon RDS
3291
3609
  # storage autoscaling][1] in the *Amazon RDS User Guide*.
3292
3610
  #
3611
+ # This setting doesn't apply to RDS Custom.
3612
+ #
3293
3613
  #
3294
3614
  #
3295
3615
  # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PIOPS.StorageTypes.html#USER_PIOPS.Autoscaling
@@ -3297,6 +3617,8 @@ module Aws::RDS
3297
3617
  # The Amazon Resource Name (ARN) of the replicated automated backups
3298
3618
  # from which to restore, for example,
3299
3619
  # `arn:aws:rds:useast-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE`.
3620
+ #
3621
+ # This setting doesn't apply to RDS Custom.
3300
3622
  # @option options [Boolean] :enable_customer_owned_ip
3301
3623
  # A value that indicates whether to enable a customer-owned IP address
3302
3624
  # (CoIP) for an RDS on Outposts DB instance.
@@ -3306,6 +3628,8 @@ module Aws::RDS
3306
3628
  # a CoIP can provide lower latency for connections to the DB instance
3307
3629
  # from outside of its virtual private cloud (VPC) on your local network.
3308
3630
  #
3631
+ # This setting doesn't apply to RDS Custom.
3632
+ #
3309
3633
  # For more information about RDS on Outposts, see [Working with Amazon
3310
3634
  # RDS on Amazon Web Services Outposts][1] in the *Amazon RDS User
3311
3635
  # Guide*.
@@ -3317,6 +3641,41 @@ module Aws::RDS
3317
3641
  #
3318
3642
  # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html
3319
3643
  # [2]: https://docs.aws.amazon.com/outposts/latest/userguide/outposts-networking-components.html#ip-addressing
3644
+ # @option options [String] :custom_iam_instance_profile
3645
+ # The instance profile associated with the underlying Amazon EC2
3646
+ # instance of an RDS Custom DB instance. The instance profile must meet
3647
+ # the following requirements:
3648
+ #
3649
+ # * The profile must exist in your account.
3650
+ #
3651
+ # * The profile must have an IAM role that Amazon EC2 has permissions to
3652
+ # assume.
3653
+ #
3654
+ # * The instance profile name and the associated IAM role name must
3655
+ # start with the prefix `AWSRDSCustom`.
3656
+ #
3657
+ # For the list of permissions required for the IAM role, see [ Configure
3658
+ # IAM and your VPC][1] in the *Amazon Relational Database Service User
3659
+ # Guide*.
3660
+ #
3661
+ # This setting is required for RDS Custom.
3662
+ #
3663
+ #
3664
+ #
3665
+ # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-setup-orcl.html#custom-setup-orcl.iam-vpc
3666
+ # @option options [String] :backup_target
3667
+ # Specifies where automated backups and manual snapshots are stored for
3668
+ # the restored DB instance.
3669
+ #
3670
+ # Possible values are `outposts` (Amazon Web Services Outposts) and
3671
+ # `region` (Amazon Web Services Region). The default is `region`.
3672
+ #
3673
+ # For more information, see [Working with Amazon RDS on Amazon Web
3674
+ # Services Outposts][1] in the *Amazon RDS User Guide*.
3675
+ #
3676
+ #
3677
+ #
3678
+ # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html
3320
3679
  # @return [DBInstance]
3321
3680
  def restore(options = {})
3322
3681
  options = options.merge(source_db_instance_identifier: @id)
@@ -3698,6 +4057,8 @@ module Aws::RDS
3698
4057
  # You can give an Amazon Web Services account permission to restore a
3699
4058
  # manual DB snapshot from another Amazon Web Services account by using
3700
4059
  # the `ModifyDBSnapshotAttribute` API action.
4060
+ #
4061
+ # This setting doesn't apply to RDS Custom.
3701
4062
  # @option options [Boolean] :include_public
3702
4063
  # A value that indicates whether to include manual DB cluster snapshots
3703
4064
  # that are public and can be copied or restored by any Amazon Web
@@ -3705,6 +4066,8 @@ module Aws::RDS
3705
4066
  #
3706
4067
  # You can share a manual DB snapshot as public by using the
3707
4068
  # ModifyDBSnapshotAttribute API.
4069
+ #
4070
+ # This setting doesn't apply to RDS Custom.
3708
4071
  # @option options [String] :dbi_resource_id
3709
4072
  # A specific DB resource ID to describe.
3710
4073
  # @return [DBSnapshot::Collection]