aws-sdk-rds 1.128.0 → 1.132.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +20 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-rds/client.rb +2812 -633
- data/lib/aws-sdk-rds/client_api.rb +158 -0
- data/lib/aws-sdk-rds/db_cluster.rb +757 -99
- data/lib/aws-sdk-rds/db_cluster_parameter_group.rb +12 -0
- data/lib/aws-sdk-rds/db_cluster_snapshot.rb +186 -38
- 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 +622 -252
- data/lib/aws-sdk-rds/db_snapshot.rb +111 -41
- data/lib/aws-sdk-rds/errors.rb +44 -0
- data/lib/aws-sdk-rds/plugins/cross_region_copying.rb +5 -1
- data/lib/aws-sdk-rds/resource.rb +542 -160
- data/lib/aws-sdk-rds/types.rb +2805 -614
- data/lib/aws-sdk-rds.rb +1 -1
- metadata +4 -4
@@ -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]
|
@@ -224,9 +225,10 @@ module Aws::RDS
|
|
224
225
|
|
225
226
|
# Contains one or more identifiers of Aurora DB clusters to which the
|
226
227
|
# RDS DB instance is replicated as a read replica. For example, when you
|
227
|
-
# create an Aurora read replica of an RDS MySQL DB instance, the
|
228
|
-
# MySQL DB cluster for the Aurora read replica is shown. This
|
229
|
-
#
|
228
|
+
# create an Aurora read replica of an RDS for MySQL DB instance, the
|
229
|
+
# Aurora MySQL DB cluster for the Aurora read replica is shown. This
|
230
|
+
# output doesn't contain information about cross-Region Aurora read
|
231
|
+
# replicas.
|
230
232
|
#
|
231
233
|
# <note markdown="1"> Currently, each RDS DB instance can have only one Aurora read replica.
|
232
234
|
#
|
@@ -252,7 +254,8 @@ module Aws::RDS
|
|
252
254
|
data[:replica_mode]
|
253
255
|
end
|
254
256
|
|
255
|
-
# License model information for this DB instance.
|
257
|
+
# License model information for this DB instance. This setting doesn't
|
258
|
+
# apply to RDS Custom.
|
256
259
|
# @return [String]
|
257
260
|
def license_model
|
258
261
|
data[:license_model]
|
@@ -294,12 +297,13 @@ module Aws::RDS
|
|
294
297
|
|
295
298
|
# Specifies the accessibility options for the DB instance.
|
296
299
|
#
|
297
|
-
# When the DB
|
298
|
-
# to the private IP address from within the DB
|
299
|
-
#
|
300
|
-
#
|
301
|
-
#
|
302
|
-
#
|
300
|
+
# When the DB cluster is publicly accessible, its Domain Name System
|
301
|
+
# (DNS) endpoint resolves to the private IP address from within the DB
|
302
|
+
# cluster's virtual private cloud (VPC). It resolves to the public IP
|
303
|
+
# address from outside of the DB cluster's VPC. Access to the DB
|
304
|
+
# cluster is ultimately controlled by the security group it uses. That
|
305
|
+
# public access isn't permitted if the security group assigned to the
|
306
|
+
# DB cluster doesn't permit it.
|
303
307
|
#
|
304
308
|
# When the DB instance isn't publicly accessible, it is an internal DB
|
305
309
|
# instance with a DNS name that resolves to a private IP address.
|
@@ -355,8 +359,7 @@ module Aws::RDS
|
|
355
359
|
# identifier for the encrypted DB instance.
|
356
360
|
#
|
357
361
|
# 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).
|
362
|
+
# alias ARN, or alias name for the KMS key.
|
360
363
|
# @return [String]
|
361
364
|
def kms_key_id
|
362
365
|
data[:kms_key_id]
|
@@ -364,8 +367,8 @@ module Aws::RDS
|
|
364
367
|
|
365
368
|
# The Amazon Web Services Region-unique, immutable identifier for the DB
|
366
369
|
# instance. This identifier is found in Amazon Web Services CloudTrail
|
367
|
-
# log entries whenever the Amazon Web Services KMS
|
368
|
-
#
|
370
|
+
# log entries whenever the Amazon Web Services KMS key for the DB
|
371
|
+
# instance is accessed.
|
369
372
|
# @return [String]
|
370
373
|
def dbi_resource_id
|
371
374
|
data[:dbi_resource_id]
|
@@ -474,8 +477,7 @@ module Aws::RDS
|
|
474
477
|
# Performance Insights data.
|
475
478
|
#
|
476
479
|
# 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).
|
480
|
+
# alias ARN, or alias name for the KMS key.
|
479
481
|
# @return [String]
|
480
482
|
def performance_insights_kms_key_id
|
481
483
|
data[:performance_insights_kms_key_id]
|
@@ -601,7 +603,7 @@ module Aws::RDS
|
|
601
603
|
# The Amazon Web Services KMS key identifier used for encrypting
|
602
604
|
# messages in the database activity stream. The Amazon Web Services KMS
|
603
605
|
# key identifier is the key ARN, key ID, alias ARN, or alias name for
|
604
|
-
# the
|
606
|
+
# the KMS key.
|
605
607
|
# @return [String]
|
606
608
|
def activity_stream_kms_key_id
|
607
609
|
data[:activity_stream_kms_key_id]
|
@@ -629,6 +631,54 @@ module Aws::RDS
|
|
629
631
|
data[:activity_stream_engine_native_audit_fields_included]
|
630
632
|
end
|
631
633
|
|
634
|
+
# The automation mode of the RDS Custom DB instance: `full` or `all
|
635
|
+
# paused`. If `full`, the DB instance automates monitoring and instance
|
636
|
+
# recovery. If `all paused`, the instance pauses automation for the
|
637
|
+
# duration set by `--resume-full-automation-mode-minutes`.
|
638
|
+
# @return [String]
|
639
|
+
def automation_mode
|
640
|
+
data[:automation_mode]
|
641
|
+
end
|
642
|
+
|
643
|
+
# The number of minutes to pause the automation. When the time period
|
644
|
+
# ends, RDS Custom resumes full automation. The minimum value is 60
|
645
|
+
# (default). The maximum value is 1,440.
|
646
|
+
# @return [Time]
|
647
|
+
def resume_full_automation_mode_time
|
648
|
+
data[:resume_full_automation_mode_time]
|
649
|
+
end
|
650
|
+
|
651
|
+
# The instance profile associated with the underlying Amazon EC2
|
652
|
+
# instance of an RDS Custom DB instance. The instance profile must meet
|
653
|
+
# the following requirements:
|
654
|
+
#
|
655
|
+
# * The profile must exist in your account.
|
656
|
+
#
|
657
|
+
# * The profile must have an IAM role that Amazon EC2 has permissions to
|
658
|
+
# assume.
|
659
|
+
#
|
660
|
+
# * The instance profile name and the associated IAM role name must
|
661
|
+
# start with the prefix `AWSRDSCustom`.
|
662
|
+
#
|
663
|
+
# For the list of permissions required for the IAM role, see [ Configure
|
664
|
+
# IAM and your VPC][1] in the *Amazon Relational Database Service User
|
665
|
+
# Guide*.
|
666
|
+
#
|
667
|
+
#
|
668
|
+
#
|
669
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-setup-orcl.html#custom-setup-orcl.iam-vpc
|
670
|
+
# @return [String]
|
671
|
+
def custom_iam_instance_profile
|
672
|
+
data[:custom_iam_instance_profile]
|
673
|
+
end
|
674
|
+
|
675
|
+
# Specifies where automated backups and manual snapshots are stored:
|
676
|
+
# Amazon Web Services Outposts or the Amazon Web Services Region.
|
677
|
+
# @return [String]
|
678
|
+
def backup_target
|
679
|
+
data[:backup_target]
|
680
|
+
end
|
681
|
+
|
632
682
|
# @!endgroup
|
633
683
|
|
634
684
|
# @return [Client]
|
@@ -823,6 +873,8 @@ module Aws::RDS
|
|
823
873
|
# deletion_protection: false,
|
824
874
|
# max_allocated_storage: 1,
|
825
875
|
# enable_customer_owned_ip: false,
|
876
|
+
# custom_iam_instance_profile: "String",
|
877
|
+
# backup_target: "String",
|
826
878
|
# })
|
827
879
|
# @param [Hash] options ({})
|
828
880
|
# @option options [String] :db_name
|
@@ -888,6 +940,21 @@ module Aws::RDS
|
|
888
940
|
#
|
889
941
|
# ^
|
890
942
|
#
|
943
|
+
# **Amazon RDS Custom**
|
944
|
+
#
|
945
|
+
# The Oracle System ID (SID) of the created RDS Custom DB instance. If
|
946
|
+
# you don't specify a value, the default value is `ORCL`.
|
947
|
+
#
|
948
|
+
# Default: `ORCL`
|
949
|
+
#
|
950
|
+
# Constraints:
|
951
|
+
#
|
952
|
+
# * It must contain 1 to 8 alphanumeric characters.
|
953
|
+
#
|
954
|
+
# * It must contain a letter.
|
955
|
+
#
|
956
|
+
# * It can't be a word reserved by the database engine.
|
957
|
+
#
|
891
958
|
# **SQL Server**
|
892
959
|
#
|
893
960
|
# Not applicable. Must be null.
|
@@ -932,6 +999,16 @@ module Aws::RDS
|
|
932
999
|
# amount of data in your database increases, though you are only charged
|
933
1000
|
# for the space that you use in an Aurora cluster volume.
|
934
1001
|
#
|
1002
|
+
# **Amazon RDS Custom**
|
1003
|
+
#
|
1004
|
+
# Constraints to the amount of storage for each storage type are the
|
1005
|
+
# following:
|
1006
|
+
#
|
1007
|
+
# * General Purpose (SSD) storage (gp2): Must be an integer from 40 to
|
1008
|
+
# 65536.
|
1009
|
+
#
|
1010
|
+
# * Provisioned IOPS storage (io1): Must be an integer from 40 to 65536.
|
1011
|
+
#
|
935
1012
|
# **MySQL**
|
936
1013
|
#
|
937
1014
|
# Constraints to the amount of storage for each storage type are the
|
@@ -1010,8 +1087,8 @@ module Aws::RDS
|
|
1010
1087
|
#
|
1011
1088
|
# * Web and Express editions: Must be an integer from 20 to 1024.
|
1012
1089
|
# @option options [required, String] :db_instance_class
|
1013
|
-
# The compute and memory capacity of the DB instance, for example
|
1014
|
-
#
|
1090
|
+
# The compute and memory capacity of the DB instance, for example
|
1091
|
+
# db.m4.large. Not all DB instance classes are available in all Amazon
|
1015
1092
|
# Web Services Regions, or for all database engines. For the full list
|
1016
1093
|
# of DB instance classes, and availability for your engine, see [DB
|
1017
1094
|
# Instance Class][1] in the *Amazon RDS User Guide.*
|
@@ -1033,6 +1110,8 @@ module Aws::RDS
|
|
1033
1110
|
#
|
1034
1111
|
# * `aurora-postgresql`
|
1035
1112
|
#
|
1113
|
+
# * `custom-oracle-ee (for RDS Custom instances)`
|
1114
|
+
#
|
1036
1115
|
# * `mariadb`
|
1037
1116
|
#
|
1038
1117
|
# * `mysql`
|
@@ -1062,59 +1141,13 @@ module Aws::RDS
|
|
1062
1141
|
# Not applicable. The name for the master user is managed by the DB
|
1063
1142
|
# cluster.
|
1064
1143
|
#
|
1065
|
-
# **
|
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**
|
1100
|
-
#
|
1101
|
-
# Constraints:
|
1102
|
-
#
|
1103
|
-
# * Required for Oracle.
|
1104
|
-
#
|
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**
|
1144
|
+
# **Amazon RDS**
|
1112
1145
|
#
|
1113
1146
|
# Constraints:
|
1114
1147
|
#
|
1115
|
-
# * Required
|
1148
|
+
# * Required.
|
1116
1149
|
#
|
1117
|
-
# * Must be 1 to
|
1150
|
+
# * Must be 1 to 16 letters, numbers, or underscores.
|
1118
1151
|
#
|
1119
1152
|
# * First character must be a letter.
|
1120
1153
|
#
|
@@ -1217,6 +1250,8 @@ module Aws::RDS
|
|
1217
1250
|
# If you do not specify a value, then the default DB parameter group for
|
1218
1251
|
# the specified DB engine and version is used.
|
1219
1252
|
#
|
1253
|
+
# This setting doesn't apply to RDS Custom.
|
1254
|
+
#
|
1220
1255
|
# Constraints:
|
1221
1256
|
#
|
1222
1257
|
# * Must be 1 to 255 letters, numbers, or hyphens.
|
@@ -1241,6 +1276,8 @@ module Aws::RDS
|
|
1241
1276
|
# * Must be a value from 0 to 35
|
1242
1277
|
#
|
1243
1278
|
# * Can't be set to 0 if the DB instance is a source to read replicas
|
1279
|
+
#
|
1280
|
+
# * Can't be set to 0 or 35 for an RDS Custom DB instance
|
1244
1281
|
# @option options [String] :preferred_backup_window
|
1245
1282
|
# The daily time range during which automated backups are created if
|
1246
1283
|
# automated backups are enabled, using the `BackupRetentionPeriod`
|
@@ -1317,6 +1354,8 @@ module Aws::RDS
|
|
1317
1354
|
# A value that indicates whether the DB instance is a Multi-AZ
|
1318
1355
|
# deployment. You can't set the `AvailabilityZone` parameter if the DB
|
1319
1356
|
# instance is a Multi-AZ deployment.
|
1357
|
+
#
|
1358
|
+
# This setting doesn't apply to RDS Custom.
|
1320
1359
|
# @option options [String] :engine_version
|
1321
1360
|
# The version number of the database engine to use.
|
1322
1361
|
#
|
@@ -1333,51 +1372,66 @@ module Aws::RDS
|
|
1333
1372
|
# Not applicable. The version number of the database engine to be used
|
1334
1373
|
# by the DB instance is managed by the DB cluster.
|
1335
1374
|
#
|
1375
|
+
# **Amazon RDS Custom**
|
1376
|
+
#
|
1377
|
+
# A custom engine version (CEV) that you have previously created. This
|
1378
|
+
# setting is required for RDS Custom. The CEV name has the following
|
1379
|
+
# format: `19.customized_string `. An example identifier is
|
1380
|
+
# `19.my_cev1`. For more information, see [ Creating an RDS Custom DB
|
1381
|
+
# instance][1] in the *Amazon RDS User Guide.*.
|
1382
|
+
#
|
1336
1383
|
# **MariaDB**
|
1337
1384
|
#
|
1338
|
-
#
|
1339
|
-
# Guide.*
|
1385
|
+
# For information, see [MariaDB on Amazon RDS Versions][2] in the
|
1386
|
+
# *Amazon RDS User Guide.*
|
1340
1387
|
#
|
1341
1388
|
# **Microsoft SQL Server**
|
1342
1389
|
#
|
1343
|
-
#
|
1344
|
-
# RDS User Guide.*
|
1390
|
+
# For information, see [Microsoft SQL Server Versions on Amazon RDS][3]
|
1391
|
+
# in the *Amazon RDS User Guide.*
|
1345
1392
|
#
|
1346
1393
|
# **MySQL**
|
1347
1394
|
#
|
1348
|
-
#
|
1395
|
+
# For information, see [MySQL on Amazon RDS Versions][4] in the *Amazon
|
1396
|
+
# RDS User Guide.*
|
1349
1397
|
#
|
1350
1398
|
# **Oracle**
|
1351
1399
|
#
|
1352
|
-
#
|
1353
|
-
# Guide.*
|
1400
|
+
# For information, see [Oracle Database Engine Release Notes][5] in the
|
1401
|
+
# *Amazon RDS User Guide.*
|
1354
1402
|
#
|
1355
1403
|
# **PostgreSQL**
|
1356
1404
|
#
|
1357
|
-
#
|
1358
|
-
# *Amazon RDS User Guide.*
|
1405
|
+
# For information, see [Amazon RDS for PostgreSQL versions and
|
1406
|
+
# extensions][6] in the *Amazon RDS User Guide.*
|
1359
1407
|
#
|
1360
1408
|
#
|
1361
1409
|
#
|
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/
|
1410
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-creating.html#custom-creating.create
|
1411
|
+
# [2]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_MariaDB.html#MariaDB.Concepts.VersionMgmt
|
1412
|
+
# [3]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_SQLServer.html#SQLServer.Concepts.General.VersionSupport
|
1413
|
+
# [4]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_MySQL.html#MySQL.Concepts.VersionMgmt
|
1414
|
+
# [5]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Appendix.Oracle.PatchComposition.html
|
1415
|
+
# [6]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_PostgreSQL.html#PostgreSQL.Concepts
|
1367
1416
|
# @option options [Boolean] :auto_minor_version_upgrade
|
1368
1417
|
# A value that indicates whether minor engine upgrades are applied
|
1369
1418
|
# automatically to the DB instance during the maintenance window. By
|
1370
1419
|
# default, minor engine upgrades are applied automatically.
|
1420
|
+
#
|
1421
|
+
# If you create an RDS Custom DB instance, you must set
|
1422
|
+
# `AutoMinorVersionUpgrade` to `false`.
|
1371
1423
|
# @option options [String] :license_model
|
1372
1424
|
# License model information for this DB instance.
|
1373
1425
|
#
|
1374
1426
|
# Valid values: `license-included` \| `bring-your-own-license` \|
|
1375
1427
|
# `general-public-license`
|
1428
|
+
#
|
1429
|
+
# This setting doesn't apply to RDS Custom.
|
1376
1430
|
# @option options [Integer] :iops
|
1377
1431
|
# The amount of Provisioned IOPS (input/output operations per second) to
|
1378
1432
|
# be initially allocated for the DB instance. For information about
|
1379
|
-
# valid Iops values, see [Amazon RDS Provisioned IOPS
|
1380
|
-
#
|
1433
|
+
# valid `Iops` values, see [Amazon RDS Provisioned IOPS storage to
|
1434
|
+
# improve performance][1] in the *Amazon RDS User Guide*.
|
1381
1435
|
#
|
1382
1436
|
# Constraints: For MariaDB, MySQL, Oracle, and PostgreSQL DB instances,
|
1383
1437
|
# must be a multiple between .5 and 50 of the storage amount for the DB
|
@@ -1393,11 +1447,16 @@ module Aws::RDS
|
|
1393
1447
|
#
|
1394
1448
|
# Permanent options, such as the TDE option for Oracle Advanced Security
|
1395
1449
|
# TDE, can't be removed from an option group. Also, that option group
|
1396
|
-
# can't be removed from a DB instance
|
1397
|
-
# instance
|
1450
|
+
# can't be removed from a DB instance after it is associated with a DB
|
1451
|
+
# instance.
|
1452
|
+
#
|
1453
|
+
# This setting doesn't apply to RDS Custom.
|
1398
1454
|
# @option options [String] :character_set_name
|
1399
|
-
# For supported engines, indicates that the DB instance
|
1400
|
-
# associated with the specified CharacterSet
|
1455
|
+
# For supported engines, this value indicates that the DB instance
|
1456
|
+
# should be associated with the specified `CharacterSet`.
|
1457
|
+
#
|
1458
|
+
# This setting doesn't apply to RDS Custom. However, if you need to
|
1459
|
+
# change the character set, you can change it on the database itself.
|
1401
1460
|
#
|
1402
1461
|
# **Amazon Aurora**
|
1403
1462
|
#
|
@@ -1405,15 +1464,18 @@ module Aws::RDS
|
|
1405
1464
|
# more information, see `CreateDBCluster`.
|
1406
1465
|
# @option options [String] :nchar_character_set_name
|
1407
1466
|
# The name of the NCHAR character set for the Oracle DB instance.
|
1467
|
+
#
|
1468
|
+
# This parameter doesn't apply to RDS Custom.
|
1408
1469
|
# @option options [Boolean] :publicly_accessible
|
1409
1470
|
# A value that indicates whether the DB instance is publicly accessible.
|
1410
1471
|
#
|
1411
|
-
# When the DB instance is publicly accessible, its
|
1412
|
-
# to the private IP address from within the DB
|
1413
|
-
#
|
1414
|
-
#
|
1415
|
-
#
|
1416
|
-
#
|
1472
|
+
# When the DB instance is publicly accessible, its Domain Name System
|
1473
|
+
# (DNS) endpoint resolves to the private IP address from within the DB
|
1474
|
+
# instance's virtual private cloud (VPC). It resolves to the public IP
|
1475
|
+
# address from outside of the DB instance's VPC. Access to the DB
|
1476
|
+
# instance is ultimately controlled by the security group it uses. That
|
1477
|
+
# public access is not permitted if the security group assigned to the
|
1478
|
+
# DB instance doesn't permit it.
|
1417
1479
|
#
|
1418
1480
|
# When the DB instance isn't publicly accessible, it is an internal DB
|
1419
1481
|
# instance with a DNS name that resolves to a private IP address.
|
@@ -1424,24 +1486,26 @@ module Aws::RDS
|
|
1424
1486
|
# If `DBSubnetGroupName` isn't specified, and `PubliclyAccessible`
|
1425
1487
|
# isn't specified, the following applies:
|
1426
1488
|
#
|
1427
|
-
# * If the default VPC in the target
|
1489
|
+
# * If the default VPC in the target Region doesn’t have an internet
|
1428
1490
|
# gateway attached to it, the DB instance is private.
|
1429
1491
|
#
|
1430
|
-
# * If the default VPC in the target
|
1492
|
+
# * If the default VPC in the target Region has an internet gateway
|
1431
1493
|
# attached to it, the DB instance is public.
|
1432
1494
|
#
|
1433
1495
|
# If `DBSubnetGroupName` is specified, and `PubliclyAccessible` isn't
|
1434
1496
|
# specified, the following applies:
|
1435
1497
|
#
|
1436
|
-
# * If the subnets are part of a VPC that doesn’t have an
|
1498
|
+
# * If the subnets are part of a VPC that doesn’t have an internet
|
1437
1499
|
# gateway attached to it, the DB instance is private.
|
1438
1500
|
#
|
1439
|
-
# * If the subnets are part of a VPC that has an
|
1501
|
+
# * If the subnets are part of a VPC that has an internet gateway
|
1440
1502
|
# attached to it, the DB instance is public.
|
1441
1503
|
# @option options [Array<Types::Tag>] :tags
|
1442
1504
|
# Tags to assign to the DB instance.
|
1443
1505
|
# @option options [String] :db_cluster_identifier
|
1444
1506
|
# The identifier of the DB cluster that the instance will belong to.
|
1507
|
+
#
|
1508
|
+
# This setting doesn't apply to RDS Custom.
|
1445
1509
|
# @option options [String] :storage_type
|
1446
1510
|
# Specifies the storage type to be associated with the DB instance.
|
1447
1511
|
#
|
@@ -1454,13 +1518,21 @@ module Aws::RDS
|
|
1454
1518
|
# @option options [String] :tde_credential_arn
|
1455
1519
|
# The ARN from the key store with which to associate the instance for
|
1456
1520
|
# TDE encryption.
|
1521
|
+
#
|
1522
|
+
# This setting doesn't apply to RDS Custom.
|
1457
1523
|
# @option options [String] :tde_credential_password
|
1458
1524
|
# The password for the given ARN from the key store in order to access
|
1459
1525
|
# the device.
|
1526
|
+
#
|
1527
|
+
# This setting doesn't apply to RDS Custom.
|
1460
1528
|
# @option options [Boolean] :storage_encrypted
|
1461
1529
|
# A value that indicates whether the DB instance is encrypted. By
|
1462
1530
|
# default, it isn't encrypted.
|
1463
1531
|
#
|
1532
|
+
# For RDS Custom Oracle instances, either set this parameter to `true`
|
1533
|
+
# or leave it unset. If you set this parameter to `false`, RDS reports
|
1534
|
+
# an error.
|
1535
|
+
#
|
1464
1536
|
# **Amazon Aurora**
|
1465
1537
|
#
|
1466
1538
|
# Not applicable. The encryption for DB instances is managed by the DB
|
@@ -1470,9 +1542,9 @@ module Aws::RDS
|
|
1470
1542
|
# instance.
|
1471
1543
|
#
|
1472
1544
|
# The Amazon Web Services KMS key identifier is the key ARN, key ID,
|
1473
|
-
# alias ARN, or alias name for the
|
1474
|
-
#
|
1475
|
-
#
|
1545
|
+
# alias ARN, or alias name for the KMS key. To use a KMS key in a
|
1546
|
+
# different Amazon Web Services account, specify the key ARN or alias
|
1547
|
+
# ARN.
|
1476
1548
|
#
|
1477
1549
|
# **Amazon Aurora**
|
1478
1550
|
#
|
@@ -1480,10 +1552,18 @@ module Aws::RDS
|
|
1480
1552
|
# by the DB cluster. For more information, see `CreateDBCluster`.
|
1481
1553
|
#
|
1482
1554
|
# 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.
|
1555
|
+
# the `KmsKeyId` parameter, then Amazon RDS uses your default KMS key.
|
1556
|
+
# There is a default KMS key for your Amazon Web Services account. Your
|
1557
|
+
# Amazon Web Services account has a different default KMS key for each
|
1558
|
+
# Amazon Web Services Region.
|
1559
|
+
#
|
1560
|
+
# **Amazon RDS Custom**
|
1561
|
+
#
|
1562
|
+
# A KMS key is required for RDS Custom Oracle instances. For most RDS
|
1563
|
+
# engines, if you leave this parameter empty while enabling
|
1564
|
+
# `StorageEncrypted`, the engine uses the default KMS key. However, RDS
|
1565
|
+
# Custom for Oracle doesn't use the default key when this parameter is
|
1566
|
+
# empty. You must explicitly specify a key.
|
1487
1567
|
# @option options [String] :domain
|
1488
1568
|
# The Active Directory directory ID to create the DB instance in.
|
1489
1569
|
# Currently, only MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB
|
@@ -1492,6 +1572,8 @@ module Aws::RDS
|
|
1492
1572
|
# For more information, see [ Kerberos Authentication][1] in the *Amazon
|
1493
1573
|
# RDS User Guide*.
|
1494
1574
|
#
|
1575
|
+
# This setting doesn't apply to RDS Custom.
|
1576
|
+
#
|
1495
1577
|
#
|
1496
1578
|
#
|
1497
1579
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/kerberos-authentication.html
|
@@ -1506,35 +1588,43 @@ module Aws::RDS
|
|
1506
1588
|
# the DB cluster setting.
|
1507
1589
|
# @option options [Integer] :monitoring_interval
|
1508
1590
|
# The interval, in seconds, between points when Enhanced Monitoring
|
1509
|
-
# metrics are collected for the DB instance. To disable
|
1591
|
+
# metrics are collected for the DB instance. To disable collection of
|
1510
1592
|
# Enhanced Monitoring metrics, specify 0. The default is 0.
|
1511
1593
|
#
|
1512
|
-
# If `MonitoringRoleArn` is specified, then you must
|
1594
|
+
# If `MonitoringRoleArn` is specified, then you must set
|
1513
1595
|
# `MonitoringInterval` to a value other than 0.
|
1514
1596
|
#
|
1597
|
+
# This setting doesn't apply to RDS Custom.
|
1598
|
+
#
|
1515
1599
|
# Valid Values: `0, 1, 5, 10, 15, 30, 60`
|
1516
1600
|
# @option options [String] :monitoring_role_arn
|
1517
1601
|
# The ARN for the IAM role that permits RDS to send enhanced monitoring
|
1518
1602
|
# metrics to Amazon CloudWatch Logs. For example,
|
1519
1603
|
# `arn:aws:iam:123456789012:role/emaccess`. For information on creating
|
1520
|
-
# a monitoring role,
|
1604
|
+
# a monitoring role, see [Setting Up and Enabling Enhanced
|
1521
1605
|
# Monitoring][1] in the *Amazon RDS User Guide*.
|
1522
1606
|
#
|
1523
1607
|
# If `MonitoringInterval` is set to a value other than 0, then you must
|
1524
1608
|
# supply a `MonitoringRoleArn` value.
|
1525
1609
|
#
|
1610
|
+
# This setting doesn't apply to RDS Custom.
|
1611
|
+
#
|
1526
1612
|
#
|
1527
1613
|
#
|
1528
1614
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Monitoring.OS.html#USER_Monitoring.OS.Enabling
|
1529
1615
|
# @option options [String] :domain_iam_role_name
|
1530
1616
|
# Specify the name of the IAM role to be used when making API calls to
|
1531
1617
|
# the Directory Service.
|
1618
|
+
#
|
1619
|
+
# This setting doesn't apply to RDS Custom.
|
1532
1620
|
# @option options [Integer] :promotion_tier
|
1533
1621
|
# A value that specifies the order in which an Aurora Replica is
|
1534
1622
|
# promoted to the primary instance after a failure of the existing
|
1535
1623
|
# primary instance. For more information, see [ Fault Tolerance for an
|
1536
1624
|
# Aurora DB Cluster][1] in the *Amazon Aurora User Guide*.
|
1537
1625
|
#
|
1626
|
+
# This setting doesn't apply to RDS Custom.
|
1627
|
+
#
|
1538
1628
|
# Default: 1
|
1539
1629
|
#
|
1540
1630
|
# Valid Values: 0 - 15
|
@@ -1552,11 +1642,11 @@ module Aws::RDS
|
|
1552
1642
|
# @option options [Boolean] :enable_iam_database_authentication
|
1553
1643
|
# A value that indicates whether to enable mapping of Amazon Web
|
1554
1644
|
# Services Identity and Access Management (IAM) accounts to database
|
1555
|
-
# accounts. By default, mapping
|
1645
|
+
# accounts. By default, mapping isn't enabled.
|
1556
1646
|
#
|
1557
|
-
# This setting doesn't apply to Amazon Aurora.
|
1558
|
-
# Services IAM accounts to database accounts is
|
1559
|
-
# cluster.
|
1647
|
+
# This setting doesn't apply to RDS Custom or Amazon Aurora. In Aurora,
|
1648
|
+
# mapping Amazon Web Services IAM accounts to database accounts is
|
1649
|
+
# managed by the DB cluster.
|
1560
1650
|
#
|
1561
1651
|
# For more information, see [ IAM Database Authentication for MySQL and
|
1562
1652
|
# PostgreSQL][1] in the *Amazon RDS User Guide.*
|
@@ -1566,10 +1656,10 @@ module Aws::RDS
|
|
1566
1656
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.IAMDBAuth.html
|
1567
1657
|
# @option options [Boolean] :enable_performance_insights
|
1568
1658
|
# A value that indicates whether to enable Performance Insights for the
|
1569
|
-
# DB instance.
|
1659
|
+
# DB instance. For more information, see [Using Amazon Performance
|
1660
|
+
# Insights][1] in the *Amazon Relational Database Service User Guide*.
|
1570
1661
|
#
|
1571
|
-
#
|
1572
|
-
# the *Amazon Relational Database Service User Guide*.
|
1662
|
+
# This setting doesn't apply to RDS Custom.
|
1573
1663
|
#
|
1574
1664
|
#
|
1575
1665
|
#
|
@@ -1579,27 +1669,33 @@ module Aws::RDS
|
|
1579
1669
|
# Performance Insights data.
|
1580
1670
|
#
|
1581
1671
|
# 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).
|
1672
|
+
# alias ARN, or alias name for the KMS key.
|
1584
1673
|
#
|
1585
1674
|
# 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
|
1675
|
+
# Amazon RDS uses your default KMS key. There is a default KMS key for
|
1676
|
+
# your Amazon Web Services account. Your Amazon Web Services account has
|
1677
|
+
# a different default KMS key for each Amazon Web Services Region.
|
1678
|
+
#
|
1679
|
+
# This setting doesn't apply to RDS Custom.
|
1589
1680
|
# @option options [Integer] :performance_insights_retention_period
|
1590
1681
|
# The amount of time, in days, to retain Performance Insights data.
|
1591
1682
|
# Valid values are 7 or 731 (2 years).
|
1683
|
+
#
|
1684
|
+
# This setting doesn't apply to RDS Custom.
|
1592
1685
|
# @option options [Array<String>] :enable_cloudwatch_logs_exports
|
1593
1686
|
# 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*.
|
1687
|
+
# CloudWatch Logs. The values in the list depend on the DB engine. For
|
1688
|
+
# more information, see [Publishing Database Logs to Amazon CloudWatch
|
1689
|
+
# Logs][1] in the *Amazon Relational Database Service User Guide*.
|
1598
1690
|
#
|
1599
1691
|
# **Amazon Aurora**
|
1600
1692
|
#
|
1601
1693
|
# Not applicable. CloudWatch Logs exports are managed by the DB cluster.
|
1602
1694
|
#
|
1695
|
+
# **RDS Custom**
|
1696
|
+
#
|
1697
|
+
# Not applicable.
|
1698
|
+
#
|
1603
1699
|
# **MariaDB**
|
1604
1700
|
#
|
1605
1701
|
# Possible values are `audit`, `error`, `general`, and `slowquery`.
|
@@ -1627,10 +1723,12 @@ module Aws::RDS
|
|
1627
1723
|
# @option options [Array<Types::ProcessorFeature>] :processor_features
|
1628
1724
|
# The number of CPU cores and the number of threads per core for the DB
|
1629
1725
|
# instance class of the DB instance.
|
1726
|
+
#
|
1727
|
+
# This setting doesn't apply to RDS Custom.
|
1630
1728
|
# @option options [Boolean] :deletion_protection
|
1631
1729
|
# A value that indicates whether the DB instance has deletion protection
|
1632
1730
|
# enabled. The database can't be deleted when deletion protection is
|
1633
|
-
# enabled. By default, deletion protection
|
1731
|
+
# enabled. By default, deletion protection isn't enabled. For more
|
1634
1732
|
# information, see [ Deleting a DB Instance][1].
|
1635
1733
|
#
|
1636
1734
|
# **Amazon Aurora**
|
@@ -1651,6 +1749,8 @@ module Aws::RDS
|
|
1651
1749
|
# apply to it, see [ Managing capacity automatically with Amazon RDS
|
1652
1750
|
# storage autoscaling][1] in the *Amazon RDS User Guide*.
|
1653
1751
|
#
|
1752
|
+
# This setting doesn't apply to RDS Custom.
|
1753
|
+
#
|
1654
1754
|
#
|
1655
1755
|
#
|
1656
1756
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PIOPS.StorageTypes.html#USER_PIOPS.Autoscaling
|
@@ -1674,6 +1774,40 @@ module Aws::RDS
|
|
1674
1774
|
#
|
1675
1775
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html
|
1676
1776
|
# [2]: https://docs.aws.amazon.com/outposts/latest/userguide/outposts-networking-components.html#ip-addressing
|
1777
|
+
# @option options [String] :custom_iam_instance_profile
|
1778
|
+
# The instance profile associated with the underlying Amazon EC2
|
1779
|
+
# instance of an RDS Custom DB instance. The instance profile must meet
|
1780
|
+
# the following requirements:
|
1781
|
+
#
|
1782
|
+
# * The profile must exist in your account.
|
1783
|
+
#
|
1784
|
+
# * The profile must have an IAM role that Amazon EC2 has permissions to
|
1785
|
+
# assume.
|
1786
|
+
#
|
1787
|
+
# * The instance profile name and the associated IAM role name must
|
1788
|
+
# start with the prefix `AWSRDSCustom`.
|
1789
|
+
#
|
1790
|
+
# For the list of permissions required for the IAM role, see [ Configure
|
1791
|
+
# IAM and your VPC][1] in the *Amazon Relational Database Service User
|
1792
|
+
# Guide*.
|
1793
|
+
#
|
1794
|
+
# This setting is required for RDS Custom.
|
1795
|
+
#
|
1796
|
+
#
|
1797
|
+
#
|
1798
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-setup-orcl.html#custom-setup-orcl.iam-vpc
|
1799
|
+
# @option options [String] :backup_target
|
1800
|
+
# Specifies where automated backups and manual snapshots are stored.
|
1801
|
+
#
|
1802
|
+
# Possible values are `outposts` (Amazon Web Services Outposts) and
|
1803
|
+
# `region` (Amazon Web Services Region). The default is `region`.
|
1804
|
+
#
|
1805
|
+
# For more information, see [Working with Amazon RDS on Amazon Web
|
1806
|
+
# Services Outposts][1] in the *Amazon RDS User Guide*.
|
1807
|
+
#
|
1808
|
+
#
|
1809
|
+
#
|
1810
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html
|
1677
1811
|
# @return [DBInstance]
|
1678
1812
|
def create(options = {})
|
1679
1813
|
options = options.merge(db_instance_identifier: @id)
|
@@ -1729,6 +1863,7 @@ module Aws::RDS
|
|
1729
1863
|
# domain_iam_role_name: "String",
|
1730
1864
|
# replica_mode: "open-read-only", # accepts open-read-only, mounted
|
1731
1865
|
# max_allocated_storage: 1,
|
1866
|
+
# custom_iam_instance_profile: "String",
|
1732
1867
|
# source_region: "String",
|
1733
1868
|
# })
|
1734
1869
|
# @param [Hash] options ({})
|
@@ -1737,8 +1872,8 @@ module Aws::RDS
|
|
1737
1872
|
# unique key that identifies a DB instance. This parameter is stored as
|
1738
1873
|
# a lowercase string.
|
1739
1874
|
# @option options [String] :db_instance_class
|
1740
|
-
# The compute and memory capacity of the read replica, for example
|
1741
|
-
#
|
1875
|
+
# The compute and memory capacity of the read replica, for example
|
1876
|
+
# db.m4.large. Not all DB instance classes are available in all Amazon
|
1742
1877
|
# Web Services Regions, or for all database engines. For the full list
|
1743
1878
|
# of DB instance classes, and availability for your engine, see [DB
|
1744
1879
|
# Instance Class][1] in the *Amazon RDS User Guide.*
|
@@ -1770,10 +1905,14 @@ module Aws::RDS
|
|
1770
1905
|
# support for the replica. Creating your read replica as a Multi-AZ DB
|
1771
1906
|
# instance is independent of whether the source database is a Multi-AZ
|
1772
1907
|
# DB instance.
|
1908
|
+
#
|
1909
|
+
# This setting doesn't apply to RDS Custom.
|
1773
1910
|
# @option options [Boolean] :auto_minor_version_upgrade
|
1774
1911
|
# A value that indicates whether minor engine upgrades are applied
|
1775
1912
|
# automatically to the read replica during the maintenance window.
|
1776
1913
|
#
|
1914
|
+
# This setting doesn't apply to RDS Custom.
|
1915
|
+
#
|
1777
1916
|
# Default: Inherits from the source DB instance
|
1778
1917
|
# @option options [Integer] :iops
|
1779
1918
|
# The amount of Provisioned IOPS (input/output operations per second) to
|
@@ -1786,18 +1925,18 @@ module Aws::RDS
|
|
1786
1925
|
# source instance.
|
1787
1926
|
#
|
1788
1927
|
# </note>
|
1928
|
+
#
|
1929
|
+
# This setting doesn't apply to RDS Custom.
|
1789
1930
|
# @option options [String] :db_parameter_group_name
|
1790
1931
|
# The name of the DB parameter group to associate with this DB instance.
|
1791
1932
|
#
|
1792
1933
|
# If you do not specify a value for `DBParameterGroupName`, then Amazon
|
1793
1934
|
# RDS uses the `DBParameterGroup` of source DB instance for a same
|
1794
|
-
#
|
1795
|
-
# specified DB engine for a cross
|
1935
|
+
# Region read replica, or the default `DBParameterGroup` for the
|
1936
|
+
# specified DB engine for a cross-Region read replica.
|
1796
1937
|
#
|
1797
|
-
#
|
1798
|
-
#
|
1799
|
-
#
|
1800
|
-
# </note>
|
1938
|
+
# Specifying a parameter group for this operation is only supported for
|
1939
|
+
# Oracle DB instances. It isn't supported for RDS Custom.
|
1801
1940
|
#
|
1802
1941
|
# Constraints:
|
1803
1942
|
#
|
@@ -1809,12 +1948,13 @@ module Aws::RDS
|
|
1809
1948
|
# @option options [Boolean] :publicly_accessible
|
1810
1949
|
# A value that indicates whether the DB instance is publicly accessible.
|
1811
1950
|
#
|
1812
|
-
# When the DB
|
1813
|
-
# to the private IP address from within the DB
|
1814
|
-
#
|
1815
|
-
#
|
1816
|
-
#
|
1817
|
-
#
|
1951
|
+
# When the DB cluster is publicly accessible, its Domain Name System
|
1952
|
+
# (DNS) endpoint resolves to the private IP address from within the DB
|
1953
|
+
# cluster's virtual private cloud (VPC). It resolves to the public IP
|
1954
|
+
# address from outside of the DB cluster's VPC. Access to the DB
|
1955
|
+
# cluster is ultimately controlled by the security group it uses. That
|
1956
|
+
# public access isn't permitted if the security group assigned to the
|
1957
|
+
# DB cluster doesn't permit it.
|
1818
1958
|
#
|
1819
1959
|
# When the DB instance isn't publicly accessible, it is an internal DB
|
1820
1960
|
# instance with a DNS name that resolves to a private IP address.
|
@@ -1854,7 +1994,10 @@ module Aws::RDS
|
|
1854
1994
|
#
|
1855
1995
|
# Example: `mySubnetgroup`
|
1856
1996
|
# @option options [Array<String>] :vpc_security_group_ids
|
1857
|
-
# A list of EC2 VPC security groups to associate with the read
|
1997
|
+
# A list of Amazon EC2 VPC security groups to associate with the read
|
1998
|
+
# replica.
|
1999
|
+
#
|
2000
|
+
# This setting doesn't apply to RDS Custom.
|
1858
2001
|
#
|
1859
2002
|
# Default: The default EC2 VPC security group for the DB subnet group's
|
1860
2003
|
# VPC.
|
@@ -1878,6 +2021,8 @@ module Aws::RDS
|
|
1878
2021
|
# If `MonitoringRoleArn` is specified, then you must also set
|
1879
2022
|
# `MonitoringInterval` to a value other than 0.
|
1880
2023
|
#
|
2024
|
+
# This setting doesn't apply to RDS Custom.
|
2025
|
+
#
|
1881
2026
|
# Valid Values: `0, 1, 5, 10, 15, 30, 60`
|
1882
2027
|
# @option options [String] :monitoring_role_arn
|
1883
2028
|
# The ARN for the IAM role that permits RDS to send enhanced monitoring
|
@@ -1889,6 +2034,8 @@ module Aws::RDS
|
|
1889
2034
|
# If `MonitoringInterval` is set to a value other than 0, then you must
|
1890
2035
|
# supply a `MonitoringRoleArn` value.
|
1891
2036
|
#
|
2037
|
+
# This setting doesn't apply to RDS Custom.
|
2038
|
+
#
|
1892
2039
|
#
|
1893
2040
|
#
|
1894
2041
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Monitoring.html#USER_Monitoring.OS.IAMRole
|
@@ -1897,23 +2044,26 @@ module Aws::RDS
|
|
1897
2044
|
# replica.
|
1898
2045
|
#
|
1899
2046
|
# The Amazon Web Services KMS key identifier is the key ARN, key ID,
|
1900
|
-
# alias ARN, or alias name for the
|
2047
|
+
# alias ARN, or alias name for the KMS key.
|
1901
2048
|
#
|
1902
2049
|
# If you create an encrypted read replica in the same Amazon Web
|
1903
2050
|
# 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
|
2051
|
+
# for this parameter. A read replica in the same Amazon Web Services
|
2052
|
+
# Region is always encrypted with the same KMS key as the source DB
|
1906
2053
|
# instance.
|
1907
2054
|
#
|
1908
2055
|
# 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
|
2056
|
+
# Services Region, then you must specify a KMS key identifier for the
|
2057
|
+
# destination Amazon Web Services Region. KMS keys are specific to the
|
2058
|
+
# Amazon Web Services Region that they are created in, and you can't
|
2059
|
+
# use KMS keys from one Amazon Web Services Region in another Amazon Web
|
2060
|
+
# Services Region.
|
1914
2061
|
#
|
1915
2062
|
# You can't create an encrypted read replica from an unencrypted DB
|
1916
2063
|
# instance.
|
2064
|
+
#
|
2065
|
+
# This setting doesn't apply to RDS Custom, which uses the same KMS key
|
2066
|
+
# as the primary replica.
|
1917
2067
|
# @option options [String] :pre_signed_url
|
1918
2068
|
# The URL that contains a Signature Version 4 signed request for the
|
1919
2069
|
# `CreateDBInstanceReadReplica` API action in the source Amazon Web
|
@@ -1973,10 +2123,12 @@ module Aws::RDS
|
|
1973
2123
|
# Region.
|
1974
2124
|
#
|
1975
2125
|
# `SourceRegion` isn't supported for SQL Server, because SQL Server on
|
1976
|
-
# Amazon RDS doesn't support cross-
|
2126
|
+
# Amazon RDS doesn't support cross-Region read replicas.
|
1977
2127
|
#
|
1978
2128
|
# </note>
|
1979
2129
|
#
|
2130
|
+
# This setting doesn't apply to RDS Custom.
|
2131
|
+
#
|
1980
2132
|
#
|
1981
2133
|
#
|
1982
2134
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/API/sigv4-query-string-auth.html
|
@@ -1984,12 +2136,14 @@ module Aws::RDS
|
|
1984
2136
|
# @option options [Boolean] :enable_iam_database_authentication
|
1985
2137
|
# A value that indicates whether to enable mapping of Amazon Web
|
1986
2138
|
# Services Identity and Access Management (IAM) accounts to database
|
1987
|
-
# accounts. By default, mapping
|
2139
|
+
# accounts. By default, mapping isn't enabled.
|
1988
2140
|
#
|
1989
2141
|
# For more information about IAM database authentication, see [ IAM
|
1990
2142
|
# Database Authentication for MySQL and PostgreSQL][1] in the *Amazon
|
1991
2143
|
# RDS User Guide.*
|
1992
2144
|
#
|
2145
|
+
# This setting doesn't apply to RDS Custom.
|
2146
|
+
#
|
1993
2147
|
#
|
1994
2148
|
#
|
1995
2149
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.IAMDBAuth.html
|
@@ -2000,6 +2154,8 @@ module Aws::RDS
|
|
2000
2154
|
# For more information, see [Using Amazon Performance Insights][1] in
|
2001
2155
|
# the *Amazon RDS User Guide*.
|
2002
2156
|
#
|
2157
|
+
# This setting doesn't apply to RDS Custom.
|
2158
|
+
#
|
2003
2159
|
#
|
2004
2160
|
#
|
2005
2161
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.html
|
@@ -2008,35 +2164,44 @@ module Aws::RDS
|
|
2008
2164
|
# Performance Insights data.
|
2009
2165
|
#
|
2010
2166
|
# 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).
|
2167
|
+
# alias ARN, or alias name for the KMS key.
|
2013
2168
|
#
|
2014
2169
|
# 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
|
2170
|
+
# Amazon RDS uses your default KMS key. There is a default KMS key for
|
2171
|
+
# your Amazon Web Services account. Your Amazon Web Services account has
|
2172
|
+
# a different default KMS key for each Amazon Web Services Region.
|
2173
|
+
#
|
2174
|
+
# This setting doesn't apply to RDS Custom.
|
2018
2175
|
# @option options [Integer] :performance_insights_retention_period
|
2019
2176
|
# The amount of time, in days, to retain Performance Insights data.
|
2020
2177
|
# Valid values are 7 or 731 (2 years).
|
2178
|
+
#
|
2179
|
+
# This setting doesn't apply to RDS Custom.
|
2021
2180
|
# @option options [Array<String>] :enable_cloudwatch_logs_exports
|
2022
2181
|
# The list of logs that the new DB instance is to export to CloudWatch
|
2023
2182
|
# Logs. The values in the list depend on the DB engine being used. For
|
2024
2183
|
# more information, see [Publishing Database Logs to Amazon CloudWatch
|
2025
2184
|
# Logs ][1] in the *Amazon RDS User Guide*.
|
2026
2185
|
#
|
2186
|
+
# This setting doesn't apply to RDS Custom.
|
2187
|
+
#
|
2027
2188
|
#
|
2028
2189
|
#
|
2029
2190
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch
|
2030
2191
|
# @option options [Array<Types::ProcessorFeature>] :processor_features
|
2031
2192
|
# The number of CPU cores and the number of threads per core for the DB
|
2032
2193
|
# instance class of the DB instance.
|
2194
|
+
#
|
2195
|
+
# This setting doesn't apply to RDS Custom.
|
2033
2196
|
# @option options [Boolean] :use_default_processor_features
|
2034
2197
|
# A value that indicates whether the DB instance class of the DB
|
2035
2198
|
# instance uses its default processor features.
|
2199
|
+
#
|
2200
|
+
# This setting doesn't apply to RDS Custom.
|
2036
2201
|
# @option options [Boolean] :deletion_protection
|
2037
2202
|
# A value that indicates whether the DB instance has deletion protection
|
2038
2203
|
# enabled. The database can't be deleted when deletion protection is
|
2039
|
-
# enabled. By default, deletion protection
|
2204
|
+
# enabled. By default, deletion protection isn't enabled. For more
|
2040
2205
|
# information, see [ Deleting a DB Instance][1].
|
2041
2206
|
#
|
2042
2207
|
#
|
@@ -2050,12 +2215,16 @@ module Aws::RDS
|
|
2050
2215
|
# For more information, see [ Kerberos Authentication][1] in the *Amazon
|
2051
2216
|
# RDS User Guide*.
|
2052
2217
|
#
|
2218
|
+
# This setting doesn't apply to RDS Custom.
|
2219
|
+
#
|
2053
2220
|
#
|
2054
2221
|
#
|
2055
2222
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/kerberos-authentication.html
|
2056
2223
|
# @option options [String] :domain_iam_role_name
|
2057
2224
|
# Specify the name of the IAM role to be used when making API calls to
|
2058
2225
|
# the Directory Service.
|
2226
|
+
#
|
2227
|
+
# This setting doesn't apply to RDS Custom.
|
2059
2228
|
# @option options [String] :replica_mode
|
2060
2229
|
# The open mode of the replica database: mounted or read-only.
|
2061
2230
|
#
|
@@ -2063,17 +2232,22 @@ module Aws::RDS
|
|
2063
2232
|
#
|
2064
2233
|
# </note>
|
2065
2234
|
#
|
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
|
2235
|
+
# Mounted DB replicas are included in Oracle Database Enterprise
|
2236
|
+
# Edition. The main use case for mounted replicas is cross-Region
|
2237
|
+
# disaster recovery. The primary database doesn't use Active Data Guard
|
2238
|
+
# to transmit information to the mounted replica. Because it doesn't
|
2239
|
+
# accept user connections, a mounted replica can't serve a read-only
|
2240
|
+
# workload.
|
2071
2241
|
#
|
2072
2242
|
# You can create a combination of mounted and read-only DB replicas for
|
2073
2243
|
# the same primary DB instance. For more information, see [Working with
|
2074
2244
|
# Oracle Read Replicas for Amazon RDS][1] in the *Amazon RDS User
|
2075
2245
|
# Guide*.
|
2076
2246
|
#
|
2247
|
+
# For RDS Custom, you must specify this parameter and set it to
|
2248
|
+
# `mounted`. The value won't be set by default. After replica creation,
|
2249
|
+
# you can manage the open mode manually.
|
2250
|
+
#
|
2077
2251
|
#
|
2078
2252
|
#
|
2079
2253
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/oracle-read-replicas.html
|
@@ -2088,6 +2262,28 @@ module Aws::RDS
|
|
2088
2262
|
#
|
2089
2263
|
#
|
2090
2264
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PIOPS.StorageTypes.html#USER_PIOPS.Autoscaling
|
2265
|
+
# @option options [String] :custom_iam_instance_profile
|
2266
|
+
# The instance profile associated with the underlying Amazon EC2
|
2267
|
+
# instance of an RDS Custom DB instance. The instance profile must meet
|
2268
|
+
# the following requirements:
|
2269
|
+
#
|
2270
|
+
# * The profile must exist in your account.
|
2271
|
+
#
|
2272
|
+
# * The profile must have an IAM role that Amazon EC2 has permissions to
|
2273
|
+
# assume.
|
2274
|
+
#
|
2275
|
+
# * The instance profile name and the associated IAM role name must
|
2276
|
+
# start with the prefix `AWSRDSCustom`.
|
2277
|
+
#
|
2278
|
+
# For the list of permissions required for the IAM role, see [ Configure
|
2279
|
+
# IAM and your VPC][1] in the *Amazon Relational Database Service User
|
2280
|
+
# Guide*.
|
2281
|
+
#
|
2282
|
+
# This setting is required for RDS Custom.
|
2283
|
+
#
|
2284
|
+
#
|
2285
|
+
#
|
2286
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-setup-orcl.html#custom-setup-orcl.iam-vpc
|
2091
2287
|
# @option options [String] :source_region
|
2092
2288
|
# The source region of the snapshot. This is only needed when the
|
2093
2289
|
# shapshot is encrypted and in a different region.
|
@@ -2157,30 +2353,36 @@ module Aws::RDS
|
|
2157
2353
|
# @param [Hash] options ({})
|
2158
2354
|
# @option options [Boolean] :skip_final_snapshot
|
2159
2355
|
# A value that indicates whether to skip the creation of a final DB
|
2160
|
-
# snapshot before the
|
2161
|
-
# DB snapshot
|
2162
|
-
#
|
2163
|
-
#
|
2356
|
+
# snapshot before deleting the instance. If you enable this parameter,
|
2357
|
+
# RDS doesn't create a DB snapshot. If you don't enable this
|
2358
|
+
# parameter, RDS creates a DB snapshot before the DB instance is
|
2359
|
+
# deleted. By default, skip isn't enabled, and the DB snapshot is
|
2360
|
+
# created.
|
2164
2361
|
#
|
2165
|
-
#
|
2166
|
-
#
|
2167
|
-
# can only be deleted when skip is specified.
|
2362
|
+
# <note markdown="1"> If you don't enable this parameter, you must specify the
|
2363
|
+
# `FinalDBSnapshotIdentifier` parameter.
|
2168
2364
|
#
|
2169
|
-
#
|
2365
|
+
# </note>
|
2170
2366
|
#
|
2171
|
-
#
|
2172
|
-
#
|
2367
|
+
# When a DB instance is in a failure state and has a status of `failed`,
|
2368
|
+
# `incompatible-restore`, or `incompatible-network`, RDS can delete the
|
2369
|
+
# instance only if you enable this parameter.
|
2173
2370
|
#
|
2174
|
-
#
|
2371
|
+
# If you delete a read replica or an RDS Custom instance, you must
|
2372
|
+
# enable this setting.
|
2373
|
+
#
|
2374
|
+
# This setting is required for RDS Custom.
|
2175
2375
|
# @option options [String] :final_db_snapshot_identifier
|
2176
2376
|
# The `DBSnapshotIdentifier` of the new `DBSnapshot` created when the
|
2177
2377
|
# `SkipFinalSnapshot` parameter is disabled.
|
2178
2378
|
#
|
2179
|
-
# <note markdown="1">
|
2180
|
-
#
|
2379
|
+
# <note markdown="1"> If you enable this parameter and also enable SkipFinalShapshot, the
|
2380
|
+
# command results in an error.
|
2181
2381
|
#
|
2182
2382
|
# </note>
|
2183
2383
|
#
|
2384
|
+
# This setting doesn't apply to RDS Custom.
|
2385
|
+
#
|
2184
2386
|
# Constraints:
|
2185
2387
|
#
|
2186
2388
|
# * Must be 1 to 255 letters or numbers.
|
@@ -2261,6 +2463,8 @@ module Aws::RDS
|
|
2261
2463
|
# replica_mode: "open-read-only", # accepts open-read-only, mounted
|
2262
2464
|
# enable_customer_owned_ip: false,
|
2263
2465
|
# aws_backup_recovery_point_arn: "AwsBackupRecoveryPointArn",
|
2466
|
+
# automation_mode: "full", # accepts full, all-paused
|
2467
|
+
# resume_full_automation_mode_minutes: 1,
|
2264
2468
|
# })
|
2265
2469
|
# @param [Hash] options ({})
|
2266
2470
|
# @option options [Integer] :allocated_storage
|
@@ -2275,16 +2479,18 @@ module Aws::RDS
|
|
2275
2479
|
# For the valid values for allocated storage for each engine, see
|
2276
2480
|
# `CreateDBInstance`.
|
2277
2481
|
# @option options [String] :db_instance_class
|
2278
|
-
# The new compute and memory capacity of the DB instance, for example
|
2279
|
-
#
|
2482
|
+
# The new compute and memory capacity of the DB instance, for example
|
2483
|
+
# db.m4.large. Not all DB instance classes are available in all Amazon
|
2280
2484
|
# Web Services Regions, or for all database engines. For the full list
|
2281
2485
|
# of DB instance classes, and availability for your engine, see [DB
|
2282
|
-
# Instance Class][1] in the *Amazon RDS User Guide
|
2486
|
+
# Instance Class][1] in the *Amazon RDS User Guide*.
|
2283
2487
|
#
|
2284
2488
|
# If you modify the DB instance class, an outage occurs during the
|
2285
2489
|
# change. The change is applied during the next maintenance window,
|
2286
2490
|
# unless `ApplyImmediately` is enabled for this request.
|
2287
2491
|
#
|
2492
|
+
# This setting doesn't apply to RDS Custom.
|
2493
|
+
#
|
2288
2494
|
# Default: Uses existing setting
|
2289
2495
|
#
|
2290
2496
|
#
|
@@ -2295,12 +2501,14 @@ module Aws::RDS
|
|
2295
2501
|
# parameter to move your DB instance to a different VPC. If your DB
|
2296
2502
|
# instance isn't in a VPC, you can also use this parameter to move your
|
2297
2503
|
# 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
|
2504
|
+
# instance in a VPC][1] in the *Amazon RDS User Guide*.
|
2299
2505
|
#
|
2300
2506
|
# Changing the subnet group causes an outage during the change. The
|
2301
2507
|
# change is applied during the next maintenance window, unless you
|
2302
2508
|
# enable `ApplyImmediately`.
|
2303
2509
|
#
|
2510
|
+
# This parameter doesn't apply to RDS Custom.
|
2511
|
+
#
|
2304
2512
|
# Constraints: If supplied, must match the name of an existing
|
2305
2513
|
# DBSubnetGroup.
|
2306
2514
|
#
|
@@ -2314,14 +2522,18 @@ module Aws::RDS
|
|
2314
2522
|
# Changing this setting doesn't result in an outage and the change is
|
2315
2523
|
# asynchronously applied as soon as possible.
|
2316
2524
|
#
|
2525
|
+
# This setting doesn't apply to RDS Custom.
|
2526
|
+
#
|
2317
2527
|
# Constraints:
|
2318
2528
|
#
|
2319
2529
|
# * If supplied, must match existing DBSecurityGroups.
|
2320
2530
|
#
|
2321
2531
|
# ^
|
2322
2532
|
# @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.
|
2533
|
+
# A list of Amazon EC2 VPC security groups to authorize on this DB
|
2534
|
+
# instance. This change is asynchronously applied as soon as possible.
|
2535
|
+
#
|
2536
|
+
# This setting doesn't apply to RDS Custom.
|
2325
2537
|
#
|
2326
2538
|
# **Amazon Aurora**
|
2327
2539
|
#
|
@@ -2361,6 +2573,8 @@ module Aws::RDS
|
|
2361
2573
|
# element exists in the `PendingModifiedValues` element of the operation
|
2362
2574
|
# response.
|
2363
2575
|
#
|
2576
|
+
# This setting doesn't apply to RDS Custom.
|
2577
|
+
#
|
2364
2578
|
# **Amazon Aurora**
|
2365
2579
|
#
|
2366
2580
|
# Not applicable. The password for the master user is managed by the DB
|
@@ -2396,17 +2610,22 @@ module Aws::RDS
|
|
2396
2610
|
# </note>
|
2397
2611
|
# @option options [String] :db_parameter_group_name
|
2398
2612
|
# The name of the DB parameter group to apply to the DB instance.
|
2613
|
+
#
|
2399
2614
|
# Changing this setting doesn't result in an outage. The parameter
|
2400
2615
|
# group name itself is changed immediately, but the actual parameter
|
2401
2616
|
# 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.
|
2617
|
+
# failover. In this case, the DB instance isn't rebooted automatically,
|
2618
|
+
# and the parameter changes aren't applied during the next maintenance
|
2619
|
+
# window. However, if you modify dynamic parameters in the newly
|
2620
|
+
# associated DB parameter group, these changes are applied immediately
|
2621
|
+
# without a reboot.
|
2622
|
+
#
|
2623
|
+
# This setting doesn't apply to RDS Custom.
|
2405
2624
|
#
|
2406
2625
|
# Default: Uses existing setting
|
2407
2626
|
#
|
2408
2627
|
# Constraints: The DB parameter group must be in the same DB parameter
|
2409
|
-
# group family as
|
2628
|
+
# group family as the DB instance.
|
2410
2629
|
# @option options [Integer] :backup_retention_period
|
2411
2630
|
# The number of days to retain automated backups. Setting this parameter
|
2412
2631
|
# to a positive number enables backups. Setting this parameter to 0
|
@@ -2432,15 +2651,15 @@ module Aws::RDS
|
|
2432
2651
|
#
|
2433
2652
|
# Constraints:
|
2434
2653
|
#
|
2435
|
-
# *
|
2654
|
+
# * It must be a value from 0 to 35. It can't be set to 0 if the DB
|
2655
|
+
# instance is a source to read replicas. It can't be set to 0 or 35
|
2656
|
+
# for an RDS Custom DB instance.
|
2436
2657
|
#
|
2437
|
-
# *
|
2438
|
-
# running MySQL 5.6 or later
|
2658
|
+
# * It can be specified for a MySQL read replica only if the source is
|
2659
|
+
# running MySQL 5.6 or later.
|
2439
2660
|
#
|
2440
|
-
# *
|
2441
|
-
# running PostgreSQL 9.3.5
|
2442
|
-
#
|
2443
|
-
# * Can't be set to 0 if the DB instance is a source to read replicas
|
2661
|
+
# * It can be specified for a PostgreSQL read replica only if the source
|
2662
|
+
# is running PostgreSQL 9.3.5.
|
2444
2663
|
# @option options [String] :preferred_backup_window
|
2445
2664
|
# The daily time range during which automated backups are created if
|
2446
2665
|
# automated backups are enabled, as determined by the
|
@@ -2496,9 +2715,11 @@ module Aws::RDS
|
|
2496
2715
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_UpgradeDBInstance.Maintenance.html#Concepts.DBMaintenance
|
2497
2716
|
# @option options [Boolean] :multi_az
|
2498
2717
|
# A value that indicates whether the DB instance is a Multi-AZ
|
2499
|
-
# deployment. Changing this parameter doesn't result in an outage
|
2500
|
-
#
|
2718
|
+
# deployment. Changing this parameter doesn't result in an outage. The
|
2719
|
+
# change is applied during the next maintenance window unless the
|
2501
2720
|
# `ApplyImmediately` parameter is enabled for this request.
|
2721
|
+
#
|
2722
|
+
# This setting doesn't apply to RDS Custom.
|
2502
2723
|
# @option options [String] :engine_version
|
2503
2724
|
# The version number of the database engine to upgrade to. Changing this
|
2504
2725
|
# parameter results in an outage and the change is applied during the
|
@@ -2514,25 +2735,40 @@ module Aws::RDS
|
|
2514
2735
|
# instance to the default minor version if the current minor version is
|
2515
2736
|
# lower. For information about valid engine versions, see
|
2516
2737
|
# `CreateDBInstance`, or call `DescribeDBEngineVersions`.
|
2738
|
+
#
|
2739
|
+
# In RDS Custom, this parameter is supported for read replicas only if
|
2740
|
+
# they are in the `PATCH_DB_FAILURE` lifecycle.
|
2517
2741
|
# @option options [Boolean] :allow_major_version_upgrade
|
2518
2742
|
# A value that indicates whether major version upgrades are allowed.
|
2519
2743
|
# Changing this parameter doesn't result in an outage and the change is
|
2520
2744
|
# asynchronously applied as soon as possible.
|
2521
2745
|
#
|
2746
|
+
# This setting doesn't apply to RDS Custom.
|
2747
|
+
#
|
2522
2748
|
# Constraints: Major version upgrades must be allowed when specifying a
|
2523
2749
|
# value for the EngineVersion parameter that is a different major
|
2524
2750
|
# version than the DB instance's current version.
|
2525
2751
|
# @option options [Boolean] :auto_minor_version_upgrade
|
2526
2752
|
# 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
|
-
#
|
2753
|
+
# automatically to the DB instance during the maintenance window. An
|
2754
|
+
# outage occurs when all the following conditions are met:
|
2755
|
+
#
|
2756
|
+
# * The automatic upgrade is enabled for the maintenance window.
|
2757
|
+
#
|
2758
|
+
# * A newer minor version is available.
|
2759
|
+
#
|
2760
|
+
# * RDS has enabled automatic patching for the engine version.
|
2761
|
+
#
|
2762
|
+
# If any of the preceding conditions isn't met, RDS applies the change
|
2763
|
+
# as soon as possible and doesn't cause an outage.
|
2764
|
+
#
|
2765
|
+
# For an RDS Custom DB instance, set `AutoMinorVersionUpgrade` to
|
2766
|
+
# `false`. Otherwise, the operation returns an error.
|
2533
2767
|
# @option options [String] :license_model
|
2534
2768
|
# The license model for the DB instance.
|
2535
2769
|
#
|
2770
|
+
# This setting doesn't apply to RDS Custom.
|
2771
|
+
#
|
2536
2772
|
# Valid values: `license-included` \| `bring-your-own-license` \|
|
2537
2773
|
# `general-public-license`
|
2538
2774
|
# @option options [Integer] :iops
|
@@ -2569,18 +2805,23 @@ module Aws::RDS
|
|
2569
2805
|
# Default: Uses existing setting
|
2570
2806
|
# @option options [String] :option_group_name
|
2571
2807
|
# A value that indicates the DB instance should be associated with the
|
2572
|
-
# specified option group.
|
2573
|
-
#
|
2574
|
-
#
|
2575
|
-
#
|
2576
|
-
#
|
2577
|
-
#
|
2578
|
-
#
|
2808
|
+
# specified option group.
|
2809
|
+
#
|
2810
|
+
# Changing this parameter doesn't result in an outage, with one
|
2811
|
+
# exception. If the parameter change results in an option group that
|
2812
|
+
# enables OEM, it can cause a brief period, lasting less than a second,
|
2813
|
+
# during which new connections are rejected but existing connections
|
2814
|
+
# aren't interrupted.
|
2815
|
+
#
|
2816
|
+
# The change is applied during the next maintenance window unless the
|
2817
|
+
# `ApplyImmediately` parameter is enabled for this request.
|
2579
2818
|
#
|
2580
2819
|
# Permanent options, such as the TDE option for Oracle Advanced Security
|
2581
2820
|
# TDE, can't be removed from an option group, and that option group
|
2582
|
-
# can't be removed from a DB instance
|
2583
|
-
# instance
|
2821
|
+
# can't be removed from a DB instance after it is associated with a DB
|
2822
|
+
# instance.
|
2823
|
+
#
|
2824
|
+
# This setting doesn't apply to RDS Custom.
|
2584
2825
|
# @option options [String] :new_db_instance_identifier
|
2585
2826
|
# The new DB instance identifier for the DB instance when renaming a DB
|
2586
2827
|
# instance. When you change the DB instance identifier, an instance
|
@@ -2588,6 +2829,8 @@ module Aws::RDS
|
|
2588
2829
|
# occur during the next maintenance window if you disable Apply
|
2589
2830
|
# Immediately. This value is stored as a lowercase string.
|
2590
2831
|
#
|
2832
|
+
# This setting doesn't apply to RDS Custom.
|
2833
|
+
#
|
2591
2834
|
# Constraints:
|
2592
2835
|
#
|
2593
2836
|
# * Must contain from 1 to 63 letters, numbers, or hyphens.
|
@@ -2624,22 +2867,29 @@ module Aws::RDS
|
|
2624
2867
|
# @option options [String] :tde_credential_arn
|
2625
2868
|
# The ARN from the key store with which to associate the instance for
|
2626
2869
|
# TDE encryption.
|
2870
|
+
#
|
2871
|
+
# This setting doesn't apply to RDS Custom.
|
2627
2872
|
# @option options [String] :tde_credential_password
|
2628
2873
|
# The password for the given ARN from the key store in order to access
|
2629
2874
|
# the device.
|
2875
|
+
#
|
2876
|
+
# This setting doesn't apply to RDS Custom.
|
2630
2877
|
# @option options [String] :ca_certificate_identifier
|
2631
|
-
#
|
2632
|
-
#
|
2878
|
+
# Specifies the certificate to associate with the DB instance.
|
2879
|
+
#
|
2880
|
+
# This setting doesn't apply to RDS Custom.
|
2633
2881
|
# @option options [String] :domain
|
2634
2882
|
# 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
|
2883
|
+
# `none` to remove the instance from its current domain. You must create
|
2884
|
+
# the domain before this operation. Currently, you can create only
|
2885
|
+
# MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances in an
|
2638
2886
|
# Active Directory Domain.
|
2639
2887
|
#
|
2640
2888
|
# For more information, see [ Kerberos Authentication][1] in the *Amazon
|
2641
2889
|
# RDS User Guide*.
|
2642
2890
|
#
|
2891
|
+
# This setting doesn't apply to RDS Custom.
|
2892
|
+
#
|
2643
2893
|
#
|
2644
2894
|
#
|
2645
2895
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/kerberos-authentication.html
|
@@ -2655,10 +2905,12 @@ module Aws::RDS
|
|
2655
2905
|
# @option options [Integer] :monitoring_interval
|
2656
2906
|
# The interval, in seconds, between points when Enhanced Monitoring
|
2657
2907
|
# metrics are collected for the DB instance. To disable collecting
|
2658
|
-
# Enhanced Monitoring metrics, specify 0
|
2908
|
+
# Enhanced Monitoring metrics, specify 0, which is the default.
|
2659
2909
|
#
|
2660
|
-
# If `MonitoringRoleArn` is specified,
|
2661
|
-
#
|
2910
|
+
# If `MonitoringRoleArn` is specified, set `MonitoringInterval` to a
|
2911
|
+
# value other than 0.
|
2912
|
+
#
|
2913
|
+
# This setting doesn't apply to RDS Custom.
|
2662
2914
|
#
|
2663
2915
|
# Valid Values: `0, 1, 5, 10, 15, 30, 60`
|
2664
2916
|
# @option options [Integer] :db_port_number
|
@@ -2668,9 +2920,11 @@ module Aws::RDS
|
|
2668
2920
|
# port values specified for options in the option group for the DB
|
2669
2921
|
# instance.
|
2670
2922
|
#
|
2671
|
-
#
|
2923
|
+
# If you change the `DBPortNumber` value, your database restarts
|
2672
2924
|
# regardless of the value of the `ApplyImmediately` parameter.
|
2673
2925
|
#
|
2926
|
+
# This setting doesn't apply to RDS Custom.
|
2927
|
+
#
|
2674
2928
|
# **MySQL**
|
2675
2929
|
#
|
2676
2930
|
# Default: `3306`
|
@@ -2712,12 +2966,13 @@ module Aws::RDS
|
|
2712
2966
|
# @option options [Boolean] :publicly_accessible
|
2713
2967
|
# A value that indicates whether the DB instance is publicly accessible.
|
2714
2968
|
#
|
2715
|
-
# When the DB
|
2716
|
-
# to the private IP address from within the DB
|
2717
|
-
#
|
2718
|
-
#
|
2719
|
-
#
|
2720
|
-
#
|
2969
|
+
# When the DB cluster is publicly accessible, its Domain Name System
|
2970
|
+
# (DNS) endpoint resolves to the private IP address from within the DB
|
2971
|
+
# cluster's virtual private cloud (VPC). It resolves to the public IP
|
2972
|
+
# address from outside of the DB cluster's VPC. Access to the DB
|
2973
|
+
# cluster is ultimately controlled by the security group it uses. That
|
2974
|
+
# public access isn't permitted if the security group assigned to the
|
2975
|
+
# DB cluster doesn't permit it.
|
2721
2976
|
#
|
2722
2977
|
# When the DB instance isn't publicly accessible, it is an internal DB
|
2723
2978
|
# instance with a DNS name that resolves to a private IP address.
|
@@ -2728,15 +2983,19 @@ module Aws::RDS
|
|
2728
2983
|
#
|
2729
2984
|
# Changes to the `PubliclyAccessible` parameter are applied immediately
|
2730
2985
|
# regardless of the value of the `ApplyImmediately` parameter.
|
2986
|
+
#
|
2987
|
+
# This setting doesn't apply to RDS Custom.
|
2731
2988
|
# @option options [String] :monitoring_role_arn
|
2732
2989
|
# The ARN for the IAM role that permits RDS to send enhanced monitoring
|
2733
2990
|
# metrics to Amazon CloudWatch Logs. For example,
|
2734
2991
|
# `arn:aws:iam:123456789012:role/emaccess`. For information on creating
|
2735
|
-
# a monitoring role,
|
2736
|
-
#
|
2992
|
+
# a monitoring role, see [To create an IAM role for Amazon RDS Enhanced
|
2993
|
+
# Monitoring][1] in the *Amazon RDS User Guide.*
|
2737
2994
|
#
|
2738
|
-
# If `MonitoringInterval` is set to a value other than 0,
|
2739
|
-
#
|
2995
|
+
# If `MonitoringInterval` is set to a value other than 0, supply a
|
2996
|
+
# `MonitoringRoleArn` value.
|
2997
|
+
#
|
2998
|
+
# This setting doesn't apply to RDS Custom.
|
2740
2999
|
#
|
2741
3000
|
#
|
2742
3001
|
#
|
@@ -2744,12 +3003,16 @@ module Aws::RDS
|
|
2744
3003
|
# @option options [String] :domain_iam_role_name
|
2745
3004
|
# The name of the IAM role to use when making API calls to the Directory
|
2746
3005
|
# Service.
|
3006
|
+
#
|
3007
|
+
# This setting doesn't apply to RDS Custom.
|
2747
3008
|
# @option options [Integer] :promotion_tier
|
2748
3009
|
# A value that specifies the order in which an Aurora Replica is
|
2749
3010
|
# promoted to the primary instance after a failure of the existing
|
2750
3011
|
# primary instance. For more information, see [ Fault Tolerance for an
|
2751
3012
|
# Aurora DB Cluster][1] in the *Amazon Aurora User Guide*.
|
2752
3013
|
#
|
3014
|
+
# This setting doesn't apply to RDS Custom.
|
3015
|
+
#
|
2753
3016
|
# Default: 1
|
2754
3017
|
#
|
2755
3018
|
# Valid Values: 0 - 15
|
@@ -2760,7 +3023,7 @@ module Aws::RDS
|
|
2760
3023
|
# @option options [Boolean] :enable_iam_database_authentication
|
2761
3024
|
# A value that indicates whether to enable mapping of Amazon Web
|
2762
3025
|
# Services Identity and Access Management (IAM) accounts to database
|
2763
|
-
# accounts. By default, mapping
|
3026
|
+
# accounts. By default, mapping isn't enabled.
|
2764
3027
|
#
|
2765
3028
|
# This setting doesn't apply to Amazon Aurora. Mapping Amazon Web
|
2766
3029
|
# Services IAM accounts to database accounts is managed by the DB
|
@@ -2770,6 +3033,8 @@ module Aws::RDS
|
|
2770
3033
|
# Database Authentication for MySQL and PostgreSQL][1] in the *Amazon
|
2771
3034
|
# RDS User Guide.*
|
2772
3035
|
#
|
3036
|
+
# This setting doesn't apply to RDS Custom.
|
3037
|
+
#
|
2773
3038
|
#
|
2774
3039
|
#
|
2775
3040
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.IAMDBAuth.html
|
@@ -2780,6 +3045,8 @@ module Aws::RDS
|
|
2780
3045
|
# For more information, see [Using Amazon Performance Insights][1] in
|
2781
3046
|
# the *Amazon Relational Database Service User Guide*.
|
2782
3047
|
#
|
3048
|
+
# This setting doesn't apply to RDS Custom.
|
3049
|
+
#
|
2783
3050
|
#
|
2784
3051
|
#
|
2785
3052
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.html
|
@@ -2788,16 +3055,19 @@ module Aws::RDS
|
|
2788
3055
|
# Performance Insights data.
|
2789
3056
|
#
|
2790
3057
|
# 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).
|
3058
|
+
# alias ARN, or alias name for the KMS key.
|
2793
3059
|
#
|
2794
3060
|
# 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
|
3061
|
+
# Amazon RDS uses your default KMS key. There is a default KMS key for
|
3062
|
+
# your Amazon Web Services account. Your Amazon Web Services account has
|
3063
|
+
# a different default KMS key for each Amazon Web Services Region.
|
3064
|
+
#
|
3065
|
+
# This setting doesn't apply to RDS Custom.
|
2798
3066
|
# @option options [Integer] :performance_insights_retention_period
|
2799
3067
|
# The amount of time, in days, to retain Performance Insights data.
|
2800
3068
|
# Valid values are 7 or 731 (2 years).
|
3069
|
+
#
|
3070
|
+
# This setting doesn't apply to RDS Custom.
|
2801
3071
|
# @option options [Types::CloudwatchLogsExportConfiguration] :cloudwatch_logs_export_configuration
|
2802
3072
|
# The configuration setting for the log types to be enabled for export
|
2803
3073
|
# to CloudWatch Logs for a specific DB instance.
|
@@ -2805,16 +3075,22 @@ module Aws::RDS
|
|
2805
3075
|
# A change to the `CloudwatchLogsExportConfiguration` parameter is
|
2806
3076
|
# always applied to the DB instance immediately. Therefore, the
|
2807
3077
|
# `ApplyImmediately` parameter has no effect.
|
3078
|
+
#
|
3079
|
+
# This setting doesn't apply to RDS Custom.
|
2808
3080
|
# @option options [Array<Types::ProcessorFeature>] :processor_features
|
2809
3081
|
# The number of CPU cores and the number of threads per core for the DB
|
2810
3082
|
# instance class of the DB instance.
|
3083
|
+
#
|
3084
|
+
# This setting doesn't apply to RDS Custom.
|
2811
3085
|
# @option options [Boolean] :use_default_processor_features
|
2812
3086
|
# A value that indicates whether the DB instance class of the DB
|
2813
3087
|
# instance uses its default processor features.
|
3088
|
+
#
|
3089
|
+
# This setting doesn't apply to RDS Custom.
|
2814
3090
|
# @option options [Boolean] :deletion_protection
|
2815
3091
|
# A value that indicates whether the DB instance has deletion protection
|
2816
3092
|
# enabled. The database can't be deleted when deletion protection is
|
2817
|
-
# enabled. By default, deletion protection
|
3093
|
+
# enabled. By default, deletion protection isn't enabled. For more
|
2818
3094
|
# information, see [ Deleting a DB Instance][1].
|
2819
3095
|
#
|
2820
3096
|
#
|
@@ -2828,6 +3104,8 @@ module Aws::RDS
|
|
2828
3104
|
# apply to it, see [ Managing capacity automatically with Amazon RDS
|
2829
3105
|
# storage autoscaling][1] in the *Amazon RDS User Guide*.
|
2830
3106
|
#
|
3107
|
+
# This setting doesn't apply to RDS Custom.
|
3108
|
+
#
|
2831
3109
|
#
|
2832
3110
|
#
|
2833
3111
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PIOPS.StorageTypes.html#USER_PIOPS.Autoscaling
|
@@ -2854,6 +3132,8 @@ module Aws::RDS
|
|
2854
3132
|
# Aurora DB engines, see [ Rotating Your SSL/TLS Certificate][2] in
|
2855
3133
|
# the *Amazon Aurora User Guide.*
|
2856
3134
|
#
|
3135
|
+
# This setting doesn't apply to RDS Custom.
|
3136
|
+
#
|
2857
3137
|
#
|
2858
3138
|
#
|
2859
3139
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.SSL-certificate-rotation.html
|
@@ -2874,6 +3154,8 @@ module Aws::RDS
|
|
2874
3154
|
# more information, see [Working with Oracle Read Replicas for Amazon
|
2875
3155
|
# RDS][1] in the *Amazon RDS User Guide*.
|
2876
3156
|
#
|
3157
|
+
# This setting doesn't apply to RDS Custom.
|
3158
|
+
#
|
2877
3159
|
#
|
2878
3160
|
#
|
2879
3161
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/oracle-read-replicas.html
|
@@ -2900,6 +3182,17 @@ module Aws::RDS
|
|
2900
3182
|
# @option options [String] :aws_backup_recovery_point_arn
|
2901
3183
|
# The Amazon Resource Name (ARN) of the recovery point in Amazon Web
|
2902
3184
|
# Services Backup.
|
3185
|
+
#
|
3186
|
+
# This setting doesn't apply to RDS Custom.
|
3187
|
+
# @option options [String] :automation_mode
|
3188
|
+
# The automation mode of the RDS Custom DB instance: `full` or `all
|
3189
|
+
# paused`. If `full`, the DB instance automates monitoring and instance
|
3190
|
+
# recovery. If `all paused`, the instance pauses automation for the
|
3191
|
+
# duration set by `ResumeFullAutomationModeMinutes`.
|
3192
|
+
# @option options [Integer] :resume_full_automation_mode_minutes
|
3193
|
+
# The number of minutes to pause the automation. When the time period
|
3194
|
+
# ends, RDS Custom resumes full automation. The minimum value is `60`
|
3195
|
+
# (default). The maximum value is `1,440`.
|
2903
3196
|
# @return [DBInstance]
|
2904
3197
|
def modify(options = {})
|
2905
3198
|
options = options.merge(db_instance_identifier: @id)
|
@@ -3033,6 +3326,8 @@ module Aws::RDS
|
|
3033
3326
|
# max_allocated_storage: 1,
|
3034
3327
|
# source_db_instance_automated_backups_arn: "String",
|
3035
3328
|
# enable_customer_owned_ip: false,
|
3329
|
+
# custom_iam_instance_profile: "String",
|
3330
|
+
# backup_target: "String",
|
3036
3331
|
# })
|
3037
3332
|
# @param [Hash] options ({})
|
3038
3333
|
# @option options [required, String] :target_db_instance_identifier
|
@@ -3068,10 +3363,10 @@ module Aws::RDS
|
|
3068
3363
|
# provided.
|
3069
3364
|
# @option options [String] :db_instance_class
|
3070
3365
|
# The compute and memory capacity of the Amazon RDS DB instance, for
|
3071
|
-
# example
|
3072
|
-
#
|
3073
|
-
#
|
3074
|
-
#
|
3366
|
+
# example db.m4.large. Not all DB instance classes are available in all
|
3367
|
+
# Amazon Web Services Regions, or for all database engines. For the full
|
3368
|
+
# list of DB instance classes, and availability for your engine, see [DB
|
3369
|
+
# Instance Class][1] in the *Amazon RDS User Guide.*
|
3075
3370
|
#
|
3076
3371
|
# Default: The same DBInstanceClass as the original DB instance.
|
3077
3372
|
#
|
@@ -3104,17 +3399,20 @@ module Aws::RDS
|
|
3104
3399
|
# A value that indicates whether the DB instance is a Multi-AZ
|
3105
3400
|
# deployment.
|
3106
3401
|
#
|
3402
|
+
# This setting doesn't apply to RDS Custom.
|
3403
|
+
#
|
3107
3404
|
# Constraint: You can't specify the `AvailabilityZone` parameter if the
|
3108
3405
|
# DB instance is a Multi-AZ deployment.
|
3109
3406
|
# @option options [Boolean] :publicly_accessible
|
3110
3407
|
# A value that indicates whether the DB instance is publicly accessible.
|
3111
3408
|
#
|
3112
|
-
# When the DB
|
3113
|
-
# to the private IP address from within the DB
|
3114
|
-
#
|
3115
|
-
#
|
3116
|
-
#
|
3117
|
-
#
|
3409
|
+
# When the DB cluster is publicly accessible, its Domain Name System
|
3410
|
+
# (DNS) endpoint resolves to the private IP address from within the DB
|
3411
|
+
# cluster's virtual private cloud (VPC). It resolves to the public IP
|
3412
|
+
# address from outside of the DB cluster's VPC. Access to the DB
|
3413
|
+
# cluster is ultimately controlled by the security group it uses. That
|
3414
|
+
# public access isn't permitted if the security group assigned to the
|
3415
|
+
# DB cluster doesn't permit it.
|
3118
3416
|
#
|
3119
3417
|
# When the DB instance isn't publicly accessible, it is an internal DB
|
3120
3418
|
# instance with a DNS name that resolves to a private IP address.
|
@@ -3123,9 +3421,13 @@ module Aws::RDS
|
|
3123
3421
|
# @option options [Boolean] :auto_minor_version_upgrade
|
3124
3422
|
# A value that indicates whether minor version upgrades are applied
|
3125
3423
|
# automatically to the DB instance during the maintenance window.
|
3424
|
+
#
|
3425
|
+
# This setting doesn't apply to RDS Custom.
|
3126
3426
|
# @option options [String] :license_model
|
3127
3427
|
# License model information for the restored DB instance.
|
3128
3428
|
#
|
3429
|
+
# This setting doesn't apply to RDS Custom.
|
3430
|
+
#
|
3129
3431
|
# Default: Same as source.
|
3130
3432
|
#
|
3131
3433
|
# Valid values: `license-included` \| `bring-your-own-license` \|
|
@@ -3133,12 +3435,15 @@ module Aws::RDS
|
|
3133
3435
|
# @option options [String] :db_name
|
3134
3436
|
# The database name for the restored DB instance.
|
3135
3437
|
#
|
3136
|
-
# <note markdown="1"> This parameter isn't
|
3438
|
+
# <note markdown="1"> This parameter isn't supported for the MySQL or MariaDB engines. It
|
3439
|
+
# also doesn't apply to RDS Custom.
|
3137
3440
|
#
|
3138
3441
|
# </note>
|
3139
3442
|
# @option options [String] :engine
|
3140
3443
|
# The database engine to use for the new instance.
|
3141
3444
|
#
|
3445
|
+
# This setting doesn't apply to RDS Custom.
|
3446
|
+
#
|
3142
3447
|
# Default: The same as source
|
3143
3448
|
#
|
3144
3449
|
# Constraint: Must be compatible with the engine of the source
|
@@ -3181,8 +3486,10 @@ module Aws::RDS
|
|
3181
3486
|
#
|
3182
3487
|
# Permanent options, such as the TDE option for Oracle Advanced Security
|
3183
3488
|
# TDE, can't be removed from an option group, and that option group
|
3184
|
-
# can't be removed from a DB instance
|
3489
|
+
# can't be removed from a DB instance after it is associated with a DB
|
3185
3490
|
# instance
|
3491
|
+
#
|
3492
|
+
# This setting doesn't apply to RDS Custom.
|
3186
3493
|
# @option options [Boolean] :copy_tags_to_snapshot
|
3187
3494
|
# A value that indicates whether to copy all tags from the restored DB
|
3188
3495
|
# instance to snapshots of the DB instance. By default, tags are not
|
@@ -3206,9 +3513,13 @@ module Aws::RDS
|
|
3206
3513
|
# @option options [String] :tde_credential_arn
|
3207
3514
|
# The ARN from the key store with which to associate the instance for
|
3208
3515
|
# TDE encryption.
|
3516
|
+
#
|
3517
|
+
# This setting doesn't apply to RDS Custom.
|
3209
3518
|
# @option options [String] :tde_credential_password
|
3210
3519
|
# The password for the given ARN from the key store in order to access
|
3211
3520
|
# the device.
|
3521
|
+
#
|
3522
|
+
# This setting doesn't apply to RDS Custom.
|
3212
3523
|
# @option options [Array<String>] :vpc_security_group_ids
|
3213
3524
|
# A list of EC2 VPC security groups to associate with this DB instance.
|
3214
3525
|
#
|
@@ -3216,9 +3527,11 @@ module Aws::RDS
|
|
3216
3527
|
# VPC.
|
3217
3528
|
# @option options [String] :domain
|
3218
3529
|
# Specify the Active Directory directory ID to restore the DB instance
|
3219
|
-
# in.
|
3220
|
-
# only MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB
|
3221
|
-
#
|
3530
|
+
# in. Create the domain before running this command. Currently, you can
|
3531
|
+
# create only the MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB
|
3532
|
+
# instances in an Active Directory Domain.
|
3533
|
+
#
|
3534
|
+
# This setting doesn't apply to RDS Custom.
|
3222
3535
|
#
|
3223
3536
|
# For more information, see [ Kerberos Authentication][1] in the *Amazon
|
3224
3537
|
# RDS User Guide*.
|
@@ -3229,10 +3542,14 @@ module Aws::RDS
|
|
3229
3542
|
# @option options [String] :domain_iam_role_name
|
3230
3543
|
# Specify the name of the IAM role to be used when making API calls to
|
3231
3544
|
# the Directory Service.
|
3545
|
+
#
|
3546
|
+
# This setting doesn't apply to RDS Custom.
|
3232
3547
|
# @option options [Boolean] :enable_iam_database_authentication
|
3233
3548
|
# A value that indicates whether to enable mapping of Amazon Web
|
3234
3549
|
# Services Identity and Access Management (IAM) accounts to database
|
3235
|
-
# accounts. By default, mapping
|
3550
|
+
# accounts. By default, mapping isn't enabled.
|
3551
|
+
#
|
3552
|
+
# This setting doesn't apply to RDS Custom.
|
3236
3553
|
#
|
3237
3554
|
# For more information about IAM database authentication, see [ IAM
|
3238
3555
|
# Database Authentication for MySQL and PostgreSQL][1] in the *Amazon
|
@@ -3247,21 +3564,29 @@ module Aws::RDS
|
|
3247
3564
|
# used. For more information, see [Publishing Database Logs to Amazon
|
3248
3565
|
# CloudWatch Logs][1] in the *Amazon RDS User Guide*.
|
3249
3566
|
#
|
3567
|
+
# This setting doesn't apply to RDS Custom.
|
3568
|
+
#
|
3250
3569
|
#
|
3251
3570
|
#
|
3252
3571
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch
|
3253
3572
|
# @option options [Array<Types::ProcessorFeature>] :processor_features
|
3254
3573
|
# The number of CPU cores and the number of threads per core for the DB
|
3255
3574
|
# instance class of the DB instance.
|
3575
|
+
#
|
3576
|
+
# This setting doesn't apply to RDS Custom.
|
3256
3577
|
# @option options [Boolean] :use_default_processor_features
|
3257
3578
|
# A value that indicates whether the DB instance class of the DB
|
3258
3579
|
# instance uses its default processor features.
|
3580
|
+
#
|
3581
|
+
# This setting doesn't apply to RDS Custom.
|
3259
3582
|
# @option options [String] :db_parameter_group_name
|
3260
3583
|
# The name of the DB parameter group to associate with this DB instance.
|
3261
3584
|
#
|
3262
3585
|
# If you do not specify a value for `DBParameterGroupName`, then the
|
3263
3586
|
# default `DBParameterGroup` for the specified DB engine is used.
|
3264
3587
|
#
|
3588
|
+
# This setting doesn't apply to RDS Custom.
|
3589
|
+
#
|
3265
3590
|
# Constraints:
|
3266
3591
|
#
|
3267
3592
|
# * If supplied, must match the name of an existing DBParameterGroup.
|
@@ -3274,7 +3599,7 @@ module Aws::RDS
|
|
3274
3599
|
# @option options [Boolean] :deletion_protection
|
3275
3600
|
# A value that indicates whether the DB instance has deletion protection
|
3276
3601
|
# enabled. The database can't be deleted when deletion protection is
|
3277
|
-
# enabled. By default, deletion protection
|
3602
|
+
# enabled. By default, deletion protection isn't enabled. For more
|
3278
3603
|
# information, see [ Deleting a DB Instance][1].
|
3279
3604
|
#
|
3280
3605
|
#
|
@@ -3290,6 +3615,8 @@ module Aws::RDS
|
|
3290
3615
|
# apply to it, see [ Managing capacity automatically with Amazon RDS
|
3291
3616
|
# storage autoscaling][1] in the *Amazon RDS User Guide*.
|
3292
3617
|
#
|
3618
|
+
# This setting doesn't apply to RDS Custom.
|
3619
|
+
#
|
3293
3620
|
#
|
3294
3621
|
#
|
3295
3622
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PIOPS.StorageTypes.html#USER_PIOPS.Autoscaling
|
@@ -3297,6 +3624,8 @@ module Aws::RDS
|
|
3297
3624
|
# The Amazon Resource Name (ARN) of the replicated automated backups
|
3298
3625
|
# from which to restore, for example,
|
3299
3626
|
# `arn:aws:rds:useast-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE`.
|
3627
|
+
#
|
3628
|
+
# This setting doesn't apply to RDS Custom.
|
3300
3629
|
# @option options [Boolean] :enable_customer_owned_ip
|
3301
3630
|
# A value that indicates whether to enable a customer-owned IP address
|
3302
3631
|
# (CoIP) for an RDS on Outposts DB instance.
|
@@ -3306,6 +3635,8 @@ module Aws::RDS
|
|
3306
3635
|
# a CoIP can provide lower latency for connections to the DB instance
|
3307
3636
|
# from outside of its virtual private cloud (VPC) on your local network.
|
3308
3637
|
#
|
3638
|
+
# This setting doesn't apply to RDS Custom.
|
3639
|
+
#
|
3309
3640
|
# For more information about RDS on Outposts, see [Working with Amazon
|
3310
3641
|
# RDS on Amazon Web Services Outposts][1] in the *Amazon RDS User
|
3311
3642
|
# Guide*.
|
@@ -3317,6 +3648,41 @@ module Aws::RDS
|
|
3317
3648
|
#
|
3318
3649
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html
|
3319
3650
|
# [2]: https://docs.aws.amazon.com/outposts/latest/userguide/outposts-networking-components.html#ip-addressing
|
3651
|
+
# @option options [String] :custom_iam_instance_profile
|
3652
|
+
# The instance profile associated with the underlying Amazon EC2
|
3653
|
+
# instance of an RDS Custom DB instance. The instance profile must meet
|
3654
|
+
# the following requirements:
|
3655
|
+
#
|
3656
|
+
# * The profile must exist in your account.
|
3657
|
+
#
|
3658
|
+
# * The profile must have an IAM role that Amazon EC2 has permissions to
|
3659
|
+
# assume.
|
3660
|
+
#
|
3661
|
+
# * The instance profile name and the associated IAM role name must
|
3662
|
+
# start with the prefix `AWSRDSCustom`.
|
3663
|
+
#
|
3664
|
+
# For the list of permissions required for the IAM role, see [ Configure
|
3665
|
+
# IAM and your VPC][1] in the *Amazon Relational Database Service User
|
3666
|
+
# Guide*.
|
3667
|
+
#
|
3668
|
+
# This setting is required for RDS Custom.
|
3669
|
+
#
|
3670
|
+
#
|
3671
|
+
#
|
3672
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-setup-orcl.html#custom-setup-orcl.iam-vpc
|
3673
|
+
# @option options [String] :backup_target
|
3674
|
+
# Specifies where automated backups and manual snapshots are stored for
|
3675
|
+
# the restored DB instance.
|
3676
|
+
#
|
3677
|
+
# Possible values are `outposts` (Amazon Web Services Outposts) and
|
3678
|
+
# `region` (Amazon Web Services Region). The default is `region`.
|
3679
|
+
#
|
3680
|
+
# For more information, see [Working with Amazon RDS on Amazon Web
|
3681
|
+
# Services Outposts][1] in the *Amazon RDS User Guide*.
|
3682
|
+
#
|
3683
|
+
#
|
3684
|
+
#
|
3685
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html
|
3320
3686
|
# @return [DBInstance]
|
3321
3687
|
def restore(options = {})
|
3322
3688
|
options = options.merge(source_db_instance_identifier: @id)
|
@@ -3698,6 +4064,8 @@ module Aws::RDS
|
|
3698
4064
|
# You can give an Amazon Web Services account permission to restore a
|
3699
4065
|
# manual DB snapshot from another Amazon Web Services account by using
|
3700
4066
|
# the `ModifyDBSnapshotAttribute` API action.
|
4067
|
+
#
|
4068
|
+
# This setting doesn't apply to RDS Custom.
|
3701
4069
|
# @option options [Boolean] :include_public
|
3702
4070
|
# A value that indicates whether to include manual DB cluster snapshots
|
3703
4071
|
# that are public and can be copied or restored by any Amazon Web
|
@@ -3705,6 +4073,8 @@ module Aws::RDS
|
|
3705
4073
|
#
|
3706
4074
|
# You can share a manual DB snapshot as public by using the
|
3707
4075
|
# ModifyDBSnapshotAttribute API.
|
4076
|
+
#
|
4077
|
+
# This setting doesn't apply to RDS Custom.
|
3708
4078
|
# @option options [String] :dbi_resource_id
|
3709
4079
|
# A specific DB resource ID to describe.
|
3710
4080
|
# @return [DBSnapshot::Collection]
|