aws-sdk-rds 1.51.0 → 1.52.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/lib/aws-sdk-rds.rb +1 -1
- data/lib/aws-sdk-rds/client.rb +506 -511
- data/lib/aws-sdk-rds/db_cluster.rb +85 -90
- data/lib/aws-sdk-rds/db_cluster_parameter_group.rb +6 -11
- data/lib/aws-sdk-rds/db_cluster_snapshot.rb +16 -15
- data/lib/aws-sdk-rds/db_engine.rb +10 -4
- data/lib/aws-sdk-rds/db_instance.rb +247 -234
- data/lib/aws-sdk-rds/db_parameter_group.rb +4 -10
- data/lib/aws-sdk-rds/db_security_group.rb +3 -8
- data/lib/aws-sdk-rds/db_snapshot.rb +30 -29
- data/lib/aws-sdk-rds/db_subnet_group.rb +2 -7
- data/lib/aws-sdk-rds/event_subscription.rb +4 -3
- data/lib/aws-sdk-rds/option_group.rb +4 -9
- data/lib/aws-sdk-rds/pending_maintenance_action.rb +1 -1
- data/lib/aws-sdk-rds/resource.rb +113 -136
- data/lib/aws-sdk-rds/types.rb +771 -704
- metadata +4 -4
@@ -111,8 +111,8 @@ module Aws::RDS
|
|
111
111
|
data[:backup_retention_period]
|
112
112
|
end
|
113
113
|
|
114
|
-
#
|
115
|
-
#
|
114
|
+
# A list of DB security group elements containing `DBSecurityGroup.Name`
|
115
|
+
# and `DBSecurityGroup.Status` subelements.
|
116
116
|
# @return [Array<Types::DBSecurityGroupMembership>]
|
117
117
|
def db_security_groups
|
118
118
|
data[:db_security_groups]
|
@@ -332,7 +332,7 @@ module Aws::RDS
|
|
332
332
|
#
|
333
333
|
# Not applicable. Copying tags to snapshots is managed by the DB
|
334
334
|
# cluster. Setting this value for an Aurora DB instance has no effect on
|
335
|
-
# the DB cluster setting. For more information, see DBCluster
|
335
|
+
# the DB cluster setting. For more information, see `DBCluster`.
|
336
336
|
# @return [Boolean]
|
337
337
|
def copy_tags_to_snapshot
|
338
338
|
data[:copy_tags_to_snapshot]
|
@@ -449,8 +449,8 @@ module Aws::RDS
|
|
449
449
|
end
|
450
450
|
|
451
451
|
# Indicates if the DB instance has deletion protection enabled. The
|
452
|
-
# database can't be deleted when
|
453
|
-
# information, see [ Deleting a DB Instance][1].
|
452
|
+
# database can't be deleted when deletion protection is enabled. For
|
453
|
+
# more information, see [ Deleting a DB Instance][1].
|
454
454
|
#
|
455
455
|
#
|
456
456
|
#
|
@@ -668,8 +668,6 @@ module Aws::RDS
|
|
668
668
|
# The meaning of this parameter differs according to the database engine
|
669
669
|
# you use.
|
670
670
|
#
|
671
|
-
# Type: String
|
672
|
-
#
|
673
671
|
# **MySQL**
|
674
672
|
#
|
675
673
|
# The name of the database to create when the DB instance is created. If
|
@@ -876,7 +874,7 @@ module Aws::RDS
|
|
876
874
|
# **Amazon Aurora**
|
877
875
|
#
|
878
876
|
# Not applicable. The name for the master user is managed by the DB
|
879
|
-
# cluster.
|
877
|
+
# cluster.
|
880
878
|
#
|
881
879
|
# **MariaDB**
|
882
880
|
#
|
@@ -942,7 +940,7 @@ module Aws::RDS
|
|
942
940
|
# **Amazon Aurora**
|
943
941
|
#
|
944
942
|
# Not applicable. The password for the master user is managed by the DB
|
945
|
-
# cluster.
|
943
|
+
# cluster.
|
946
944
|
#
|
947
945
|
# **MariaDB**
|
948
946
|
#
|
@@ -974,12 +972,12 @@ module Aws::RDS
|
|
974
972
|
# **Amazon Aurora**
|
975
973
|
#
|
976
974
|
# Not applicable. The associated list of EC2 VPC security groups is
|
977
|
-
# managed by the DB cluster.
|
975
|
+
# managed by the DB cluster.
|
978
976
|
#
|
979
977
|
# Default: The default EC2 VPC security group for the DB subnet group's
|
980
978
|
# VPC.
|
981
979
|
# @option options [String] :availability_zone
|
982
|
-
# The
|
980
|
+
# The Availability Zone (AZ) where the database will be created. For
|
983
981
|
# information on AWS Regions and Availability Zones, see [Regions and
|
984
982
|
# Availability Zones][1].
|
985
983
|
#
|
@@ -988,9 +986,9 @@ module Aws::RDS
|
|
988
986
|
#
|
989
987
|
# Example: `us-east-1d`
|
990
988
|
#
|
991
|
-
# Constraint: The AvailabilityZone parameter can't be specified if
|
992
|
-
#
|
993
|
-
# must be in the same AWS Region as the current endpoint.
|
989
|
+
# Constraint: The `AvailabilityZone` parameter can't be specified if
|
990
|
+
# the DB instance is a Multi-AZ deployment. The specified Availability
|
991
|
+
# Zone must be in the same AWS Region as the current endpoint.
|
994
992
|
#
|
995
993
|
#
|
996
994
|
#
|
@@ -1037,7 +1035,7 @@ module Aws::RDS
|
|
1037
1035
|
# **Amazon Aurora**
|
1038
1036
|
#
|
1039
1037
|
# Not applicable. The retention period for automated backups is managed
|
1040
|
-
# by the DB cluster.
|
1038
|
+
# by the DB cluster.
|
1041
1039
|
#
|
1042
1040
|
# Default: 1
|
1043
1041
|
#
|
@@ -1055,7 +1053,7 @@ module Aws::RDS
|
|
1055
1053
|
# **Amazon Aurora**
|
1056
1054
|
#
|
1057
1055
|
# Not applicable. The daily time range for creating automated backups is
|
1058
|
-
# managed by the DB cluster.
|
1056
|
+
# managed by the DB cluster.
|
1059
1057
|
#
|
1060
1058
|
# The default is a 30-minute window selected at random from an 8-hour
|
1061
1059
|
# block of time for each AWS Region. To see the time blocks available,
|
@@ -1124,13 +1122,14 @@ module Aws::RDS
|
|
1124
1122
|
#
|
1125
1123
|
# Type: Integer
|
1126
1124
|
# @option options [Boolean] :multi_az
|
1127
|
-
# A value that
|
1128
|
-
# deployment. You can't set the AvailabilityZone parameter if the
|
1129
|
-
#
|
1125
|
+
# A value that indicates whether the DB instance is a Multi-AZ
|
1126
|
+
# deployment. You can't set the `AvailabilityZone` parameter if the DB
|
1127
|
+
# instance is a Multi-AZ deployment.
|
1130
1128
|
# @option options [String] :engine_version
|
1131
1129
|
# The version number of the database engine to use.
|
1132
1130
|
#
|
1133
|
-
# For a list of valid engine versions,
|
1131
|
+
# For a list of valid engine versions, use the
|
1132
|
+
# `DescribeDBEngineVersions` action.
|
1134
1133
|
#
|
1135
1134
|
# The following are the database engines and links to information about
|
1136
1135
|
# the major and minor versions that are available with Amazon RDS. Not
|
@@ -1139,8 +1138,7 @@ module Aws::RDS
|
|
1139
1138
|
# **Amazon Aurora**
|
1140
1139
|
#
|
1141
1140
|
# Not applicable. The version number of the database engine to be used
|
1142
|
-
# by the DB instance is managed by the DB cluster.
|
1143
|
-
# see CreateDBCluster.
|
1141
|
+
# by the DB instance is managed by the DB cluster.
|
1144
1142
|
#
|
1145
1143
|
# **MariaDB**
|
1146
1144
|
#
|
@@ -1174,10 +1172,9 @@ module Aws::RDS
|
|
1174
1172
|
# [4]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Appendix.Oracle.PatchComposition.html
|
1175
1173
|
# [5]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_PostgreSQL.html#PostgreSQL.Concepts.General.DBVersions
|
1176
1174
|
# @option options [Boolean] :auto_minor_version_upgrade
|
1177
|
-
#
|
1178
|
-
# DB instance during the maintenance window.
|
1179
|
-
#
|
1180
|
-
# Default: `true`
|
1175
|
+
# A value that indicates whether minor engine upgrades are applied
|
1176
|
+
# automatically to the DB instance during the maintenance window. By
|
1177
|
+
# default, minor engine upgrades are applied automatically.
|
1181
1178
|
# @option options [String] :license_model
|
1182
1179
|
# License model information for this DB instance.
|
1183
1180
|
#
|
@@ -1210,13 +1207,14 @@ module Aws::RDS
|
|
1210
1207
|
# **Amazon Aurora**
|
1211
1208
|
#
|
1212
1209
|
# Not applicable. The character set is managed by the DB cluster. For
|
1213
|
-
# more information, see CreateDBCluster
|
1210
|
+
# more information, see `CreateDBCluster`.
|
1214
1211
|
# @option options [Boolean] :publicly_accessible
|
1215
|
-
#
|
1216
|
-
#
|
1217
|
-
# DNS name, which resolves to a
|
1218
|
-
#
|
1219
|
-
# private IP
|
1212
|
+
# A value that indicates whether the DB instance is publicly accessible.
|
1213
|
+
# When the DB instance is publicly accessible, it is an Internet-facing
|
1214
|
+
# instance with a publicly resolvable DNS name, which resolves to a
|
1215
|
+
# public IP address. When the DB instance is not publicly accessible, it
|
1216
|
+
# is an internal instance with a DNS name that resolves to a private IP
|
1217
|
+
# address.
|
1220
1218
|
#
|
1221
1219
|
# Default: The default behavior varies depending on whether
|
1222
1220
|
# `DBSubnetGroupName` is specified.
|
@@ -1239,18 +1237,9 @@ module Aws::RDS
|
|
1239
1237
|
# * If the subnets are part of a VPC that has an Internet gateway
|
1240
1238
|
# attached to it, the DB instance is public.
|
1241
1239
|
# @option options [Array<Types::Tag>] :tags
|
1242
|
-
#
|
1243
|
-
# Resources][1] in the *Amazon RDS User Guide.*
|
1244
|
-
#
|
1245
|
-
#
|
1246
|
-
#
|
1247
|
-
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html
|
1240
|
+
# Tags to assign to the DB instance.
|
1248
1241
|
# @option options [String] :db_cluster_identifier
|
1249
1242
|
# The identifier of the DB cluster that the instance will belong to.
|
1250
|
-
#
|
1251
|
-
# For information on creating a DB cluster, see CreateDBCluster.
|
1252
|
-
#
|
1253
|
-
# Type: String
|
1254
1243
|
# @option options [String] :storage_type
|
1255
1244
|
# Specifies the storage type to be associated with the DB instance.
|
1256
1245
|
#
|
@@ -1259,8 +1248,7 @@ module Aws::RDS
|
|
1259
1248
|
# If you specify `io1`, you must also include a value for the `Iops`
|
1260
1249
|
# parameter.
|
1261
1250
|
#
|
1262
|
-
# Default: `io1` if the `Iops` parameter is specified, otherwise
|
1263
|
-
# `standard`
|
1251
|
+
# Default: `io1` if the `Iops` parameter is specified, otherwise `gp2`
|
1264
1252
|
# @option options [String] :tde_credential_arn
|
1265
1253
|
# The ARN from the key store with which to associate the instance for
|
1266
1254
|
# TDE encryption.
|
@@ -1268,14 +1256,13 @@ module Aws::RDS
|
|
1268
1256
|
# The password for the given ARN from the key store in order to access
|
1269
1257
|
# the device.
|
1270
1258
|
# @option options [Boolean] :storage_encrypted
|
1271
|
-
#
|
1259
|
+
# A value that indicates whether the DB instance is encrypted. By
|
1260
|
+
# default, it is not encrypted.
|
1272
1261
|
#
|
1273
1262
|
# **Amazon Aurora**
|
1274
1263
|
#
|
1275
1264
|
# Not applicable. The encryption for DB instances is managed by the DB
|
1276
|
-
# cluster.
|
1277
|
-
#
|
1278
|
-
# Default: false
|
1265
|
+
# cluster.
|
1279
1266
|
# @option options [String] :kms_key_id
|
1280
1267
|
# The AWS KMS key identifier for an encrypted DB instance.
|
1281
1268
|
#
|
@@ -1288,24 +1275,34 @@ module Aws::RDS
|
|
1288
1275
|
# **Amazon Aurora**
|
1289
1276
|
#
|
1290
1277
|
# Not applicable. The KMS key identifier is managed by the DB cluster.
|
1291
|
-
# For more information, see CreateDBCluster
|
1278
|
+
# For more information, see `CreateDBCluster`.
|
1292
1279
|
#
|
1293
|
-
# If
|
1294
|
-
#
|
1295
|
-
#
|
1296
|
-
#
|
1297
|
-
#
|
1280
|
+
# If `StorageEncrypted` is enabled, and you do not specify a value for
|
1281
|
+
# the `KmsKeyId` parameter, then Amazon RDS will use your default
|
1282
|
+
# encryption key. AWS KMS creates the default encryption key for your
|
1283
|
+
# AWS account. Your AWS account has a different default encryption key
|
1284
|
+
# for each AWS Region.
|
1298
1285
|
# @option options [String] :domain
|
1299
|
-
#
|
1286
|
+
# For an Amazon RDS DB instance that's running Microsoft SQL Server,
|
1287
|
+
# this parameter specifies the Active Directory directory ID to create
|
1288
|
+
# the instance in. Amazon RDS uses Windows Authentication to
|
1289
|
+
# authenticate users that connect to the DB instance. For more
|
1290
|
+
# information, see [Using Windows Authentication with an Amazon RDS DB
|
1291
|
+
# Instance Running Microsoft SQL Server][1] in the *Amazon RDS User
|
1292
|
+
# Guide*.
|
1293
|
+
#
|
1294
|
+
#
|
1295
|
+
#
|
1296
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/DeveloperGuide/USER_SQLServerWinAuth.html
|
1300
1297
|
# @option options [Boolean] :copy_tags_to_snapshot
|
1301
|
-
#
|
1302
|
-
#
|
1298
|
+
# A value that indicates whether to copy tags from the DB instance to
|
1299
|
+
# snapshots of the DB instance. By default, tags are not copied.
|
1303
1300
|
#
|
1304
1301
|
# **Amazon Aurora**
|
1305
1302
|
#
|
1306
1303
|
# Not applicable. Copying tags to snapshots is managed by the DB
|
1307
1304
|
# cluster. Setting this value for an Aurora DB instance has no effect on
|
1308
|
-
# the DB cluster setting.
|
1305
|
+
# the DB cluster setting.
|
1309
1306
|
# @option options [Integer] :monitoring_interval
|
1310
1307
|
# The interval, in seconds, between points when Enhanced Monitoring
|
1311
1308
|
# metrics are collected for the DB instance. To disable collecting
|
@@ -1352,8 +1349,9 @@ module Aws::RDS
|
|
1352
1349
|
#
|
1353
1350
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_SQLServer.html#SQLServer.Concepts.General.TimeZone
|
1354
1351
|
# @option options [Boolean] :enable_iam_database_authentication
|
1355
|
-
#
|
1356
|
-
# accounts to database accounts
|
1352
|
+
# A value that indicates whether to enable mapping of AWS Identity and
|
1353
|
+
# Access Management (IAM) accounts to database accounts. By default,
|
1354
|
+
# mapping is disabled.
|
1357
1355
|
#
|
1358
1356
|
# You can enable IAM database authentication for the following database
|
1359
1357
|
# engines:
|
@@ -1361,18 +1359,16 @@ module Aws::RDS
|
|
1361
1359
|
# **Amazon Aurora**
|
1362
1360
|
#
|
1363
1361
|
# Not applicable. Mapping AWS IAM accounts to database accounts is
|
1364
|
-
# managed by the DB cluster.
|
1362
|
+
# managed by the DB cluster.
|
1365
1363
|
#
|
1366
1364
|
# **MySQL**
|
1367
1365
|
#
|
1368
1366
|
# * For MySQL 5.6, minor version 5.6.34 or higher
|
1369
1367
|
#
|
1370
1368
|
# * For MySQL 5.7, minor version 5.7.16 or higher
|
1371
|
-
#
|
1372
|
-
# Default: `false`
|
1373
1369
|
# @option options [Boolean] :enable_performance_insights
|
1374
|
-
#
|
1375
|
-
#
|
1370
|
+
# A value that indicates whether to enable Performance Insights for the
|
1371
|
+
# DB instance.
|
1376
1372
|
#
|
1377
1373
|
# For more information, see [Using Amazon Performance Insights][1] in
|
1378
1374
|
# the *Amazon Relational Database Service User Guide*.
|
@@ -1384,6 +1380,11 @@ module Aws::RDS
|
|
1384
1380
|
# The AWS KMS key identifier for encryption of Performance Insights
|
1385
1381
|
# data. The KMS key ID is the Amazon Resource Name (ARN), KMS key
|
1386
1382
|
# identifier, or the KMS key alias for the KMS encryption key.
|
1383
|
+
#
|
1384
|
+
# If you do not specify a value for `PerformanceInsightsKMSKeyId`, then
|
1385
|
+
# Amazon RDS uses your default encryption key. AWS KMS creates the
|
1386
|
+
# default encryption key for your AWS account. Your AWS account has a
|
1387
|
+
# different default encryption key for each AWS Region.
|
1387
1388
|
# @option options [Integer] :performance_insights_retention_period
|
1388
1389
|
# The amount of time, in days, to retain Performance Insights data.
|
1389
1390
|
# Valid values are 7 or 731 (2 years).
|
@@ -1401,10 +1402,10 @@ module Aws::RDS
|
|
1401
1402
|
# The number of CPU cores and the number of threads per core for the DB
|
1402
1403
|
# instance class of the DB instance.
|
1403
1404
|
# @option options [Boolean] :deletion_protection
|
1404
|
-
#
|
1405
|
-
# The database can't be deleted when
|
1406
|
-
# default is
|
1407
|
-
# Instance][1].
|
1405
|
+
# A value that indicates whether the DB instance has deletion protection
|
1406
|
+
# enabled. The database can't be deleted when deletion protection is
|
1407
|
+
# enabled. By default, deletion protection is disabled. For more
|
1408
|
+
# information, see [ Deleting a DB Instance][1].
|
1408
1409
|
#
|
1409
1410
|
#
|
1410
1411
|
#
|
@@ -1479,7 +1480,7 @@ module Aws::RDS
|
|
1479
1480
|
#
|
1480
1481
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html
|
1481
1482
|
# @option options [String] :availability_zone
|
1482
|
-
# The
|
1483
|
+
# The Availability Zone (AZ) where the Read Replica will be created.
|
1483
1484
|
#
|
1484
1485
|
# Default: A random, system-chosen Availability Zone in the endpoint's
|
1485
1486
|
# AWS Region.
|
@@ -1492,7 +1493,8 @@ module Aws::RDS
|
|
1492
1493
|
#
|
1493
1494
|
# Valid Values: `1150-65535`
|
1494
1495
|
# @option options [Boolean] :multi_az
|
1495
|
-
#
|
1496
|
+
# A value that indicates whether the Read Replica is in a Multi-AZ
|
1497
|
+
# deployment.
|
1496
1498
|
#
|
1497
1499
|
# You can create a Read Replica as a Multi-AZ DB instance. RDS creates a
|
1498
1500
|
# standby of your replica in another Availability Zone for failover
|
@@ -1500,8 +1502,8 @@ module Aws::RDS
|
|
1500
1502
|
# instance is independent of whether the source database is a Multi-AZ
|
1501
1503
|
# DB instance.
|
1502
1504
|
# @option options [Boolean] :auto_minor_version_upgrade
|
1503
|
-
#
|
1504
|
-
# Read Replica during the maintenance window.
|
1505
|
+
# A value that indicates whether minor engine upgrades are applied
|
1506
|
+
# automatically to the Read Replica during the maintenance window.
|
1505
1507
|
#
|
1506
1508
|
# Default: Inherits from the source DB instance
|
1507
1509
|
# @option options [Integer] :iops
|
@@ -1511,11 +1513,12 @@ module Aws::RDS
|
|
1511
1513
|
# The option group the DB instance is associated with. If omitted, the
|
1512
1514
|
# option group associated with the source instance is used.
|
1513
1515
|
# @option options [Boolean] :publicly_accessible
|
1514
|
-
#
|
1515
|
-
#
|
1516
|
-
# DNS name, which resolves to a
|
1517
|
-
#
|
1518
|
-
#
|
1516
|
+
# A value that indicates whether the DB instance is publicly accessible.
|
1517
|
+
# When the DB instance is publicly accessible, it is an Internet-facing
|
1518
|
+
# instance with a publicly resolvable DNS name, which resolves to a
|
1519
|
+
# public IP address. When the DB instance is not publicly accessible, it
|
1520
|
+
# is an internal instance with a DNS name that resolves to a private IP
|
1521
|
+
# address. For more information, see CreateDBInstance.
|
1519
1522
|
# @option options [Array<Types::Tag>] :tags
|
1520
1523
|
# A list of tags. For more information, see [Tagging Amazon RDS
|
1521
1524
|
# Resources][1] in the *Amazon RDS User Guide.*
|
@@ -1562,11 +1565,10 @@ module Aws::RDS
|
|
1562
1565
|
# If you specify `io1`, you must also include a value for the `Iops`
|
1563
1566
|
# parameter.
|
1564
1567
|
#
|
1565
|
-
# Default: `io1` if the `Iops` parameter is specified, otherwise
|
1566
|
-
# `standard`
|
1568
|
+
# Default: `io1` if the `Iops` parameter is specified, otherwise `gp2`
|
1567
1569
|
# @option options [Boolean] :copy_tags_to_snapshot
|
1568
|
-
#
|
1569
|
-
#
|
1570
|
+
# A value that indicates whether to copy all tags from the Read Replica
|
1571
|
+
# to snapshots of the Read Replica. By default, tags are not copied.
|
1570
1572
|
# @option options [Integer] :monitoring_interval
|
1571
1573
|
# The interval, in seconds, between points when Enhanced Monitoring
|
1572
1574
|
# metrics are collected for the Read Replica. To disable collecting
|
@@ -1659,8 +1661,9 @@ module Aws::RDS
|
|
1659
1661
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/API/sigv4-query-string-auth.html
|
1660
1662
|
# [2]: https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html
|
1661
1663
|
# @option options [Boolean] :enable_iam_database_authentication
|
1662
|
-
#
|
1663
|
-
# accounts to database accounts
|
1664
|
+
# A value that indicates whether to enable mapping of AWS Identity and
|
1665
|
+
# Access Management (IAM) accounts to database accounts. By default,
|
1666
|
+
# mapping is disabled.
|
1664
1667
|
#
|
1665
1668
|
# You can enable IAM database authentication for the following database
|
1666
1669
|
# engines
|
@@ -1670,11 +1673,9 @@ module Aws::RDS
|
|
1670
1673
|
# * For MySQL 5.7, minor version 5.7.16 or higher
|
1671
1674
|
#
|
1672
1675
|
# * Aurora MySQL 5.6 or higher
|
1673
|
-
#
|
1674
|
-
# Default: `false`
|
1675
1676
|
# @option options [Boolean] :enable_performance_insights
|
1676
|
-
#
|
1677
|
-
#
|
1677
|
+
# A value that indicates whether to enable Performance Insights for the
|
1678
|
+
# Read Replica.
|
1678
1679
|
#
|
1679
1680
|
# For more information, see [Using Amazon Performance Insights][1] in
|
1680
1681
|
# the *Amazon RDS User Guide*.
|
@@ -1686,6 +1687,11 @@ module Aws::RDS
|
|
1686
1687
|
# The AWS KMS key identifier for encryption of Performance Insights
|
1687
1688
|
# data. The KMS key ID is the Amazon Resource Name (ARN), KMS key
|
1688
1689
|
# identifier, or the KMS key alias for the KMS encryption key.
|
1690
|
+
#
|
1691
|
+
# If you do not specify a value for `PerformanceInsightsKMSKeyId`, then
|
1692
|
+
# Amazon RDS uses your default encryption key. AWS KMS creates the
|
1693
|
+
# default encryption key for your AWS account. Your AWS account has a
|
1694
|
+
# different default encryption key for each AWS Region.
|
1689
1695
|
# @option options [Integer] :performance_insights_retention_period
|
1690
1696
|
# The amount of time, in days, to retain Performance Insights data.
|
1691
1697
|
# Valid values are 7 or 731 (2 years).
|
@@ -1702,13 +1708,13 @@ module Aws::RDS
|
|
1702
1708
|
# The number of CPU cores and the number of threads per core for the DB
|
1703
1709
|
# instance class of the DB instance.
|
1704
1710
|
# @option options [Boolean] :use_default_processor_features
|
1705
|
-
# A value that
|
1706
|
-
# uses its default processor features.
|
1711
|
+
# A value that indicates whether the DB instance class of the DB
|
1712
|
+
# instance uses its default processor features.
|
1707
1713
|
# @option options [Boolean] :deletion_protection
|
1708
|
-
#
|
1709
|
-
# The database can't be deleted when
|
1710
|
-
# default is
|
1711
|
-
# Instance][1].
|
1714
|
+
# A value that indicates whether the DB instance has deletion protection
|
1715
|
+
# enabled. The database can't be deleted when deletion protection is
|
1716
|
+
# enabled. By default, deletion protection is disabled. For more
|
1717
|
+
# information, see [ Deleting a DB Instance][1].
|
1712
1718
|
#
|
1713
1719
|
#
|
1714
1720
|
#
|
@@ -1782,29 +1788,28 @@ module Aws::RDS
|
|
1782
1788
|
# })
|
1783
1789
|
# @param [Hash] options ({})
|
1784
1790
|
# @option options [Boolean] :skip_final_snapshot
|
1785
|
-
# A value that indicates whether
|
1786
|
-
# the DB instance is deleted. If
|
1787
|
-
# created. If
|
1788
|
-
# DB instance is deleted.
|
1791
|
+
# A value that indicates whether to skip the creation of a final DB
|
1792
|
+
# snapshot before the DB instance is deleted. If skip is specified, no
|
1793
|
+
# DB snapshot is created. If skip is not specified, a DB snapshot is
|
1794
|
+
# created before the DB instance is deleted. By default, skip is not
|
1795
|
+
# specified, and the DB snapshot is created.
|
1789
1796
|
#
|
1790
|
-
#
|
1791
|
-
#
|
1792
|
-
#
|
1797
|
+
# Note that when a DB instance is in a failure state and has a status of
|
1798
|
+
# 'failed', 'incompatible-restore', or 'incompatible-network', it
|
1799
|
+
# can only be deleted when skip is specified.
|
1793
1800
|
#
|
1794
|
-
# Specify
|
1801
|
+
# Specify skip when deleting a Read Replica.
|
1795
1802
|
#
|
1796
|
-
# <note markdown="1"> The
|
1797
|
-
#
|
1803
|
+
# <note markdown="1"> The FinalDBSnapshotIdentifier parameter must be specified if skip is
|
1804
|
+
# not specified.
|
1798
1805
|
#
|
1799
1806
|
# </note>
|
1800
|
-
#
|
1801
|
-
# Default: `false`
|
1802
1807
|
# @option options [String] :final_db_snapshot_identifier
|
1803
|
-
# The `DBSnapshotIdentifier` of the new
|
1804
|
-
# `SkipFinalSnapshot` is
|
1808
|
+
# The `DBSnapshotIdentifier` of the new `DBSnapshot` created when the
|
1809
|
+
# `SkipFinalSnapshot` parameter is disabled.
|
1805
1810
|
#
|
1806
|
-
# <note markdown="1"> Specifying this parameter and also
|
1807
|
-
#
|
1811
|
+
# <note markdown="1"> Specifying this parameter and also specifying to skip final DB
|
1812
|
+
# snapshot creation in SkipFinalShapshot results in an error.
|
1808
1813
|
#
|
1809
1814
|
# </note>
|
1810
1815
|
#
|
@@ -1820,7 +1825,8 @@ module Aws::RDS
|
|
1820
1825
|
# @option options [Boolean] :delete_automated_backups
|
1821
1826
|
# A value that indicates whether to remove automated backups immediately
|
1822
1827
|
# after the DB instance is deleted. This parameter isn't
|
1823
|
-
# case-sensitive.
|
1828
|
+
# case-sensitive. The default is to remove automated backups immediately
|
1829
|
+
# after the DB instance is deleted.
|
1824
1830
|
# @return [DBInstance]
|
1825
1831
|
def delete(options = {})
|
1826
1832
|
options = options.merge(db_instance_identifier: @id)
|
@@ -1894,7 +1900,7 @@ module Aws::RDS
|
|
1894
1900
|
# are 10% greater than the current value.
|
1895
1901
|
#
|
1896
1902
|
# For the valid values for allocated storage for each engine, see
|
1897
|
-
# CreateDBInstance
|
1903
|
+
# `CreateDBInstance`.
|
1898
1904
|
# @option options [String] :db_instance_class
|
1899
1905
|
# The new compute and memory capacity of the DB instance, for example,
|
1900
1906
|
# `db.m4.large`. Not all DB instance classes are available in all AWS
|
@@ -1904,7 +1910,7 @@ module Aws::RDS
|
|
1904
1910
|
#
|
1905
1911
|
# If you modify the DB instance class, an outage occurs during the
|
1906
1912
|
# change. The change is applied during the next maintenance window,
|
1907
|
-
# unless `ApplyImmediately` is
|
1913
|
+
# unless `ApplyImmediately` is enabled for this request.
|
1908
1914
|
#
|
1909
1915
|
# Default: Uses existing setting
|
1910
1916
|
#
|
@@ -1920,7 +1926,7 @@ module Aws::RDS
|
|
1920
1926
|
#
|
1921
1927
|
# Changing the subnet group causes an outage during the change. The
|
1922
1928
|
# change is applied during the next maintenance window, unless you
|
1923
|
-
#
|
1929
|
+
# enable `ApplyImmediately`.
|
1924
1930
|
#
|
1925
1931
|
# Constraints: If supplied, must match the name of an existing
|
1926
1932
|
# DBSubnetGroup.
|
@@ -1947,7 +1953,8 @@ module Aws::RDS
|
|
1947
1953
|
# **Amazon Aurora**
|
1948
1954
|
#
|
1949
1955
|
# Not applicable. The associated list of EC2 VPC security groups is
|
1950
|
-
# managed by the DB cluster. For more information, see
|
1956
|
+
# managed by the DB cluster. For more information, see
|
1957
|
+
# `ModifyDBCluster`.
|
1951
1958
|
#
|
1952
1959
|
# Constraints:
|
1953
1960
|
#
|
@@ -1955,21 +1962,18 @@ module Aws::RDS
|
|
1955
1962
|
#
|
1956
1963
|
# ^
|
1957
1964
|
# @option options [Boolean] :apply_immediately
|
1958
|
-
#
|
1959
|
-
# modifications are asynchronously applied as soon as
|
1960
|
-
# regardless of the `PreferredMaintenanceWindow` setting for
|
1961
|
-
# instance.
|
1962
|
-
#
|
1963
|
-
# If this parameter is set to `false`, changes to the DB instance are
|
1964
|
-
# applied during the next maintenance window. Some parameter changes can
|
1965
|
-
# cause an outage and are applied on the next call to RebootDBInstance,
|
1966
|
-
# or the next failure reboot. Review the table of parameters in
|
1967
|
-
# [Modifying a DB Instance and Using the Apply Immediately Parameter][1]
|
1968
|
-
# in the *Amazon RDS User Guide.* to see the impact that setting
|
1969
|
-
# `ApplyImmediately` to `true` or `false` has for each modified
|
1970
|
-
# parameter and to determine when the changes are applied.
|
1965
|
+
# A value that indicates whether the modifications in this request and
|
1966
|
+
# any pending modifications are asynchronously applied as soon as
|
1967
|
+
# possible, regardless of the `PreferredMaintenanceWindow` setting for
|
1968
|
+
# the DB instance. By default, this parameter is disabled.
|
1971
1969
|
#
|
1972
|
-
#
|
1970
|
+
# If this parameter is disabled, changes to the DB instance are applied
|
1971
|
+
# during the next maintenance window. Some parameter changes can cause
|
1972
|
+
# an outage and are applied on the next call to RebootDBInstance, or the
|
1973
|
+
# next failure reboot. Review the table of parameters in [Modifying a DB
|
1974
|
+
# Instance][1] in the *Amazon RDS User Guide.* to see the impact of
|
1975
|
+
# enabling or disabling `ApplyImmediately` for each modified parameter
|
1976
|
+
# and to determine when the changes are applied.
|
1973
1977
|
#
|
1974
1978
|
#
|
1975
1979
|
#
|
@@ -1987,7 +1991,7 @@ module Aws::RDS
|
|
1987
1991
|
# **Amazon Aurora**
|
1988
1992
|
#
|
1989
1993
|
# Not applicable. The password for the master user is managed by the DB
|
1990
|
-
# cluster. For more information, see ModifyDBCluster
|
1994
|
+
# cluster. For more information, see `ModifyDBCluster`.
|
1991
1995
|
#
|
1992
1996
|
# Default: Uses existing setting
|
1993
1997
|
#
|
@@ -2022,7 +2026,7 @@ module Aws::RDS
|
|
2022
2026
|
# Changing this setting doesn't result in an outage. The parameter
|
2023
2027
|
# group name itself is changed immediately, but the actual parameter
|
2024
2028
|
# changes are not applied until you reboot the instance without
|
2025
|
-
# failover. The
|
2029
|
+
# failover. The DB instance will NOT be rebooted automatically and the
|
2026
2030
|
# parameter changes will NOT be applied during the next maintenance
|
2027
2031
|
# window.
|
2028
2032
|
#
|
@@ -2038,14 +2042,14 @@ module Aws::RDS
|
|
2038
2042
|
# Changing this parameter can result in an outage if you change from 0
|
2039
2043
|
# to a non-zero value or from a non-zero value to 0. These changes are
|
2040
2044
|
# applied during the next maintenance window unless the
|
2041
|
-
# `ApplyImmediately` parameter is
|
2045
|
+
# `ApplyImmediately` parameter is enabled for this request. If you
|
2042
2046
|
# change the parameter from one non-zero value to another non-zero
|
2043
2047
|
# value, the change is asynchronously applied as soon as possible.
|
2044
2048
|
#
|
2045
2049
|
# **Amazon Aurora**
|
2046
2050
|
#
|
2047
2051
|
# Not applicable. The retention period for automated backups is managed
|
2048
|
-
# by the DB cluster. For more information, see ModifyDBCluster
|
2052
|
+
# by the DB cluster. For more information, see `ModifyDBCluster`.
|
2049
2053
|
#
|
2050
2054
|
# Default: Uses existing setting
|
2051
2055
|
#
|
@@ -2070,7 +2074,8 @@ module Aws::RDS
|
|
2070
2074
|
# **Amazon Aurora**
|
2071
2075
|
#
|
2072
2076
|
# Not applicable. The daily time range for creating automated backups is
|
2073
|
-
# managed by the DB cluster. For more information, see
|
2077
|
+
# managed by the DB cluster. For more information, see
|
2078
|
+
# `ModifyDBCluster`.
|
2074
2079
|
#
|
2075
2080
|
# Constraints:
|
2076
2081
|
#
|
@@ -2100,39 +2105,39 @@ module Aws::RDS
|
|
2100
2105
|
#
|
2101
2106
|
# Constraints: Must be at least 30 minutes
|
2102
2107
|
# @option options [Boolean] :multi_az
|
2103
|
-
#
|
2104
|
-
# parameter doesn't result in an outage and
|
2105
|
-
# during the next maintenance window unless the
|
2106
|
-
# parameter is
|
2108
|
+
# A value that indicates whether the DB instance is a Multi-AZ
|
2109
|
+
# deployment. Changing this parameter doesn't result in an outage and
|
2110
|
+
# the change is applied during the next maintenance window unless the
|
2111
|
+
# `ApplyImmediately` parameter is enabled for this request.
|
2107
2112
|
# @option options [String] :engine_version
|
2108
2113
|
# The version number of the database engine to upgrade to. Changing this
|
2109
2114
|
# parameter results in an outage and the change is applied during the
|
2110
|
-
# next maintenance window unless the `ApplyImmediately` parameter is
|
2111
|
-
#
|
2115
|
+
# next maintenance window unless the `ApplyImmediately` parameter is
|
2116
|
+
# eanbled for this request.
|
2112
2117
|
#
|
2113
2118
|
# For major version upgrades, if a nondefault DB parameter group is
|
2114
2119
|
# currently in use, a new DB parameter group in the DB parameter group
|
2115
2120
|
# family for the new engine version must be specified. The new DB
|
2116
2121
|
# parameter group can be the default for that DB parameter group family.
|
2117
2122
|
#
|
2118
|
-
# For information about valid engine versions, see CreateDBInstance
|
2119
|
-
# call DescribeDBEngineVersions
|
2123
|
+
# For information about valid engine versions, see `CreateDBInstance`,
|
2124
|
+
# or call `DescribeDBEngineVersions`.
|
2120
2125
|
# @option options [Boolean] :allow_major_version_upgrade
|
2121
|
-
#
|
2122
|
-
# parameter doesn't result in an outage and the change is
|
2126
|
+
# A value that indicates whether major version upgrades are allowed.
|
2127
|
+
# Changing this parameter doesn't result in an outage and the change is
|
2123
2128
|
# asynchronously applied as soon as possible.
|
2124
2129
|
#
|
2125
|
-
# Constraints:
|
2130
|
+
# Constraints: Major version upgrades must be allowed when specifying a
|
2126
2131
|
# value for the EngineVersion parameter that is a different major
|
2127
2132
|
# version than the DB instance's current version.
|
2128
2133
|
# @option options [Boolean] :auto_minor_version_upgrade
|
2129
|
-
#
|
2130
|
-
# DB instance during the maintenance window.
|
2131
|
-
# doesn't result in an outage except in the
|
2132
|
-
# change is asynchronously applied as soon as
|
2133
|
-
#
|
2134
|
-
# window, and a newer minor version is available, and RDS
|
2135
|
-
# auto patching for that engine version.
|
2134
|
+
# A value that indicates whether minor version upgrades are applied
|
2135
|
+
# automatically to the DB instance during the maintenance window.
|
2136
|
+
# Changing this parameter doesn't result in an outage except in the
|
2137
|
+
# following case and the change is asynchronously applied as soon as
|
2138
|
+
# possible. An outage results if this parameter is enabled during the
|
2139
|
+
# maintenance window, and a newer minor version is available, and RDS
|
2140
|
+
# has enabled auto patching for that engine version.
|
2136
2141
|
# @option options [String] :license_model
|
2137
2142
|
# The license model for the DB instance.
|
2138
2143
|
#
|
@@ -2144,10 +2149,10 @@ module Aws::RDS
|
|
2144
2149
|
#
|
2145
2150
|
# Changing this setting doesn't result in an outage and the change is
|
2146
2151
|
# applied during the next maintenance window unless the
|
2147
|
-
# `ApplyImmediately` parameter is
|
2148
|
-
#
|
2149
|
-
#
|
2150
|
-
#
|
2152
|
+
# `ApplyImmediately` parameter is enabled for this request. If you are
|
2153
|
+
# migrating from Provisioned IOPS to standard storage, set this value to
|
2154
|
+
# 0. The DB instance will require a reboot for the change in storage
|
2155
|
+
# type to take effect.
|
2151
2156
|
#
|
2152
2157
|
# If you choose to migrate your DB instance from using standard storage
|
2153
2158
|
# to using Provisioned IOPS, or from using Provisioned IOPS to using
|
@@ -2174,11 +2179,11 @@ module Aws::RDS
|
|
2174
2179
|
# Indicates that the DB instance should be associated with the specified
|
2175
2180
|
# option group. Changing this parameter doesn't result in an outage
|
2176
2181
|
# except in the following case and the change is applied during the next
|
2177
|
-
# maintenance window unless the `ApplyImmediately` parameter is
|
2178
|
-
#
|
2179
|
-
#
|
2180
|
-
#
|
2181
|
-
#
|
2182
|
+
# maintenance window unless the `ApplyImmediately` parameter is enabled
|
2183
|
+
# for this request. If the parameter change results in an option group
|
2184
|
+
# that enables OEM, this change can cause a brief (sub-second) period
|
2185
|
+
# during which new connections are rejected but existing connections are
|
2186
|
+
# not interrupted.
|
2182
2187
|
#
|
2183
2188
|
# Permanent options, such as the TDE option for Oracle Advanced Security
|
2184
2189
|
# TDE, can't be removed from an option group, and that option group
|
@@ -2187,9 +2192,9 @@ module Aws::RDS
|
|
2187
2192
|
# @option options [String] :new_db_instance_identifier
|
2188
2193
|
# The new DB instance identifier for the DB instance when renaming a DB
|
2189
2194
|
# instance. When you change the DB instance identifier, an instance
|
2190
|
-
# reboot
|
2191
|
-
#
|
2192
|
-
# Immediately
|
2195
|
+
# reboot occurs immediately if you enable `ApplyImmediately`, or will
|
2196
|
+
# occur during the next maintenance window if you disable Apply
|
2197
|
+
# Immediately. This value is stored as a lowercase string.
|
2193
2198
|
#
|
2194
2199
|
# Constraints:
|
2195
2200
|
#
|
@@ -2223,8 +2228,7 @@ module Aws::RDS
|
|
2223
2228
|
#
|
2224
2229
|
# Valid values: `standard | gp2 | io1`
|
2225
2230
|
#
|
2226
|
-
# Default: `io1` if the `Iops` parameter is specified, otherwise
|
2227
|
-
# `standard`
|
2231
|
+
# Default: `io1` if the `Iops` parameter is specified, otherwise `gp2`
|
2228
2232
|
# @option options [String] :tde_credential_arn
|
2229
2233
|
# The ARN from the key store with which to associate the instance for
|
2230
2234
|
# TDE encryption.
|
@@ -2240,14 +2244,14 @@ module Aws::RDS
|
|
2240
2244
|
# created prior to this operation. Currently only a Microsoft SQL Server
|
2241
2245
|
# instance can be created in a Active Directory Domain.
|
2242
2246
|
# @option options [Boolean] :copy_tags_to_snapshot
|
2243
|
-
#
|
2244
|
-
#
|
2247
|
+
# A value that indicates whether to copy all tags from the DB instance
|
2248
|
+
# to snapshots of the DB instance. By default, tags are not copied.
|
2245
2249
|
#
|
2246
2250
|
# **Amazon Aurora**
|
2247
2251
|
#
|
2248
2252
|
# Not applicable. Copying tags to snapshots is managed by the DB
|
2249
2253
|
# cluster. Setting this value for an Aurora DB instance has no effect on
|
2250
|
-
# the DB cluster setting. For more information, see ModifyDBCluster
|
2254
|
+
# the DB cluster setting. For more information, see `ModifyDBCluster`.
|
2251
2255
|
# @option options [Integer] :monitoring_interval
|
2252
2256
|
# The interval, in seconds, between points when Enhanced Monitoring
|
2253
2257
|
# metrics are collected for the DB instance. To disable collecting
|
@@ -2306,20 +2310,19 @@ module Aws::RDS
|
|
2306
2310
|
#
|
2307
2311
|
# Valid Values: `1150-65535`
|
2308
2312
|
# @option options [Boolean] :publicly_accessible
|
2309
|
-
#
|
2310
|
-
#
|
2311
|
-
#
|
2312
|
-
#
|
2313
|
-
# with a DNS name that resolves to a private IP
|
2313
|
+
# A value that indicates whether the DB instance is publicly accessible.
|
2314
|
+
# When the DB instance is publicly accessible, it is an Internet-facing
|
2315
|
+
# instance with a publicly resolvable DNS name, which resolves to a
|
2316
|
+
# public IP address. When the DB instance is not publicly accessible, it
|
2317
|
+
# is an internal instance with a DNS name that resolves to a private IP
|
2318
|
+
# address.
|
2314
2319
|
#
|
2315
2320
|
# `PubliclyAccessible` only applies to DB instances in a VPC. The DB
|
2316
2321
|
# instance must be part of a public subnet and `PubliclyAccessible` must
|
2317
|
-
# be
|
2322
|
+
# be enabled for it to be publicly accessible.
|
2318
2323
|
#
|
2319
2324
|
# Changes to the `PubliclyAccessible` parameter are applied immediately
|
2320
2325
|
# regardless of the value of the `ApplyImmediately` parameter.
|
2321
|
-
#
|
2322
|
-
# Default: false
|
2323
2326
|
# @option options [String] :monitoring_role_arn
|
2324
2327
|
# The ARN for the IAM role that permits RDS to send enhanced monitoring
|
2325
2328
|
# metrics to Amazon CloudWatch Logs. For example,
|
@@ -2350,8 +2353,9 @@ module Aws::RDS
|
|
2350
2353
|
#
|
2351
2354
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Managing.Backups.html#Aurora.Managing.FaultTolerance
|
2352
2355
|
# @option options [Boolean] :enable_iam_database_authentication
|
2353
|
-
#
|
2354
|
-
# accounts to database accounts
|
2356
|
+
# A value that indicates whether to enable mapping of AWS Identity and
|
2357
|
+
# Access Management (IAM) accounts to database accounts. By default,
|
2358
|
+
# mapping is disabled.
|
2355
2359
|
#
|
2356
2360
|
# You can enable IAM database authentication for the following database
|
2357
2361
|
# engines
|
@@ -2359,18 +2363,17 @@ module Aws::RDS
|
|
2359
2363
|
# **Amazon Aurora**
|
2360
2364
|
#
|
2361
2365
|
# Not applicable. Mapping AWS IAM accounts to database accounts is
|
2362
|
-
# managed by the DB cluster. For more information, see
|
2366
|
+
# managed by the DB cluster. For more information, see
|
2367
|
+
# `ModifyDBCluster`.
|
2363
2368
|
#
|
2364
2369
|
# **MySQL**
|
2365
2370
|
#
|
2366
2371
|
# * For MySQL 5.6, minor version 5.6.34 or higher
|
2367
2372
|
#
|
2368
2373
|
# * For MySQL 5.7, minor version 5.7.16 or higher
|
2369
|
-
#
|
2370
|
-
# Default: `false`
|
2371
2374
|
# @option options [Boolean] :enable_performance_insights
|
2372
|
-
#
|
2373
|
-
#
|
2375
|
+
# A value that indicates whether to enable Performance Insights for the
|
2376
|
+
# DB instance.
|
2374
2377
|
#
|
2375
2378
|
# For more information, see [Using Amazon Performance Insights][1] in
|
2376
2379
|
# the *Amazon Relational Database Service User Guide*.
|
@@ -2382,6 +2385,11 @@ module Aws::RDS
|
|
2382
2385
|
# The AWS KMS key identifier for encryption of Performance Insights
|
2383
2386
|
# data. The KMS key ID is the Amazon Resource Name (ARN), KMS key
|
2384
2387
|
# identifier, or the KMS key alias for the KMS encryption key.
|
2388
|
+
#
|
2389
|
+
# If you do not specify a value for `PerformanceInsightsKMSKeyId`, then
|
2390
|
+
# Amazon RDS uses your default encryption key. AWS KMS creates the
|
2391
|
+
# default encryption key for your AWS account. Your AWS account has a
|
2392
|
+
# different default encryption key for each AWS Region.
|
2385
2393
|
# @option options [Integer] :performance_insights_retention_period
|
2386
2394
|
# The amount of time, in days, to retain Performance Insights data.
|
2387
2395
|
# Valid values are 7 or 731 (2 years).
|
@@ -2396,11 +2404,12 @@ module Aws::RDS
|
|
2396
2404
|
# The number of CPU cores and the number of threads per core for the DB
|
2397
2405
|
# instance class of the DB instance.
|
2398
2406
|
# @option options [Boolean] :use_default_processor_features
|
2399
|
-
# A value that
|
2400
|
-
# uses its default processor features.
|
2407
|
+
# A value that indicates whether the DB instance class of the DB
|
2408
|
+
# instance uses its default processor features.
|
2401
2409
|
# @option options [Boolean] :deletion_protection
|
2402
|
-
#
|
2403
|
-
# database can't be deleted when
|
2410
|
+
# A value that indicates whether the DB instance has deletion protection
|
2411
|
+
# enabled. The database can't be deleted when deletion protection is
|
2412
|
+
# enabled. By default, deletion protection is disabled. For more
|
2404
2413
|
# information, see [ Deleting a DB Instance][1].
|
2405
2414
|
#
|
2406
2415
|
#
|
@@ -2477,10 +2486,11 @@ module Aws::RDS
|
|
2477
2486
|
# })
|
2478
2487
|
# @param [Hash] options ({})
|
2479
2488
|
# @option options [Boolean] :force_failover
|
2480
|
-
#
|
2489
|
+
# A value that indicates whether the reboot is conducted through a
|
2490
|
+
# Multi-AZ failover.
|
2481
2491
|
#
|
2482
|
-
# Constraint: You can't
|
2483
|
-
# configured for
|
2492
|
+
# Constraint: You can't enable force failover if the instance is not
|
2493
|
+
# configured for Multi-AZ.
|
2484
2494
|
# @return [DBInstance]
|
2485
2495
|
def reboot(options = {})
|
2486
2496
|
options = options.merge(db_instance_identifier: @id)
|
@@ -2557,16 +2567,17 @@ module Aws::RDS
|
|
2557
2567
|
#
|
2558
2568
|
# * Must be before the latest restorable time for the DB instance
|
2559
2569
|
#
|
2560
|
-
# * Can't be specified if UseLatestRestorableTime parameter is
|
2570
|
+
# * Can't be specified if the `UseLatestRestorableTime` parameter is
|
2571
|
+
# enabled
|
2561
2572
|
#
|
2562
2573
|
# Example: `2009-09-07T23:45:00Z`
|
2563
2574
|
# @option options [Boolean] :use_latest_restorable_time
|
2564
|
-
#
|
2565
|
-
#
|
2566
|
-
#
|
2567
|
-
# Default: `false`
|
2575
|
+
# A value that indicates whether the DB instance is restored from the
|
2576
|
+
# latest backup time. By default, the DB instance is not restored from
|
2577
|
+
# the latest backup time.
|
2568
2578
|
#
|
2569
|
-
# Constraints: Can't be specified if RestoreTime parameter is
|
2579
|
+
# Constraints: Can't be specified if the `RestoreTime` parameter is
|
2580
|
+
# provided.
|
2570
2581
|
# @option options [String] :db_instance_class
|
2571
2582
|
# The compute and memory capacity of the Amazon RDS DB instance, for
|
2572
2583
|
# example, `db.m4.large`. Not all DB instance classes are available in
|
@@ -2586,12 +2597,12 @@ module Aws::RDS
|
|
2586
2597
|
#
|
2587
2598
|
# Default: The same port as the original DB instance.
|
2588
2599
|
# @option options [String] :availability_zone
|
2589
|
-
# The
|
2600
|
+
# The Availability Zone (AZ) where the DB instance will be created.
|
2590
2601
|
#
|
2591
2602
|
# Default: A random, system-chosen Availability Zone.
|
2592
2603
|
#
|
2593
|
-
# Constraint: You can't specify the AvailabilityZone parameter if the
|
2594
|
-
#
|
2604
|
+
# Constraint: You can't specify the `AvailabilityZone` parameter if the
|
2605
|
+
# DB instance is a Multi-AZ deployment.
|
2595
2606
|
#
|
2596
2607
|
# Example: `us-east-1a`
|
2597
2608
|
# @option options [String] :db_subnet_group_name
|
@@ -2602,19 +2613,21 @@ module Aws::RDS
|
|
2602
2613
|
#
|
2603
2614
|
# Example: `mySubnetgroup`
|
2604
2615
|
# @option options [Boolean] :multi_az
|
2605
|
-
#
|
2616
|
+
# A value that indicates whether the DB instance is a Multi-AZ
|
2617
|
+
# deployment.
|
2606
2618
|
#
|
2607
|
-
# Constraint: You can't specify the AvailabilityZone parameter if the
|
2608
|
-
#
|
2619
|
+
# Constraint: You can't specify the `AvailabilityZone` parameter if the
|
2620
|
+
# DB instance is a Multi-AZ deployment.
|
2609
2621
|
# @option options [Boolean] :publicly_accessible
|
2610
|
-
#
|
2611
|
-
#
|
2612
|
-
# DNS name, which resolves to a
|
2613
|
-
#
|
2614
|
-
#
|
2622
|
+
# A value that indicates whether the DB instance is publicly accessible.
|
2623
|
+
# When the DB instance is publicly accessible, it is an Internet-facing
|
2624
|
+
# instance with a publicly resolvable DNS name, which resolves to a
|
2625
|
+
# public IP address. When the DB instance is not publicly accessible, it
|
2626
|
+
# is an internal instance with a DNS name that resolves to a private IP
|
2627
|
+
# address. For more information, see CreateDBInstance.
|
2615
2628
|
# @option options [Boolean] :auto_minor_version_upgrade
|
2616
|
-
#
|
2617
|
-
# DB instance during the maintenance window.
|
2629
|
+
# A value that indicates whether minor version upgrades are applied
|
2630
|
+
# automatically to the DB instance during the maintenance window.
|
2618
2631
|
# @option options [String] :license_model
|
2619
2632
|
# License model information for the restored DB instance.
|
2620
2633
|
#
|
@@ -2676,8 +2689,9 @@ module Aws::RDS
|
|
2676
2689
|
# can't be removed from a DB instance once it is associated with a DB
|
2677
2690
|
# instance
|
2678
2691
|
# @option options [Boolean] :copy_tags_to_snapshot
|
2679
|
-
#
|
2680
|
-
#
|
2692
|
+
# A value that indicates whether to copy all tags from the restored DB
|
2693
|
+
# instance to snapshots of the DB instance. By default, tags are not
|
2694
|
+
# copied.
|
2681
2695
|
# @option options [Array<Types::Tag>] :tags
|
2682
2696
|
# A list of tags. For more information, see [Tagging Amazon RDS
|
2683
2697
|
# Resources][1] in the *Amazon RDS User Guide.*
|
@@ -2693,8 +2707,7 @@ module Aws::RDS
|
|
2693
2707
|
# If you specify `io1`, you must also include a value for the `Iops`
|
2694
2708
|
# parameter.
|
2695
2709
|
#
|
2696
|
-
# Default: `io1` if the `Iops` parameter is specified, otherwise
|
2697
|
-
# `standard`
|
2710
|
+
# Default: `io1` if the `Iops` parameter is specified, otherwise `gp2`
|
2698
2711
|
# @option options [String] :tde_credential_arn
|
2699
2712
|
# The ARN from the key store with which to associate the instance for
|
2700
2713
|
# TDE encryption.
|
@@ -2712,8 +2725,9 @@ module Aws::RDS
|
|
2712
2725
|
# Specify the name of the IAM role to be used when making API calls to
|
2713
2726
|
# the Directory Service.
|
2714
2727
|
# @option options [Boolean] :enable_iam_database_authentication
|
2715
|
-
#
|
2716
|
-
# accounts to database accounts
|
2728
|
+
# A value that indicates whether to enable mapping of AWS Identity and
|
2729
|
+
# Access Management (IAM) accounts to database accounts. By default,
|
2730
|
+
# mapping is disabled.
|
2717
2731
|
#
|
2718
2732
|
# You can enable IAM database authentication for the following database
|
2719
2733
|
# engines
|
@@ -2721,8 +2735,6 @@ module Aws::RDS
|
|
2721
2735
|
# * For MySQL 5.6, minor version 5.6.34 or higher
|
2722
2736
|
#
|
2723
2737
|
# * For MySQL 5.7, minor version 5.7.16 or higher
|
2724
|
-
#
|
2725
|
-
# Default: `false`
|
2726
2738
|
# @option options [Array<String>] :enable_cloudwatch_logs_exports
|
2727
2739
|
# The list of logs that the restored DB instance is to export to
|
2728
2740
|
# CloudWatch Logs. The values in the list depend on the DB engine being
|
@@ -2736,8 +2748,8 @@ module Aws::RDS
|
|
2736
2748
|
# The number of CPU cores and the number of threads per core for the DB
|
2737
2749
|
# instance class of the DB instance.
|
2738
2750
|
# @option options [Boolean] :use_default_processor_features
|
2739
|
-
# A value that
|
2740
|
-
# uses its default processor features.
|
2751
|
+
# A value that indicates whether the DB instance class of the DB
|
2752
|
+
# instance uses its default processor features.
|
2741
2753
|
# @option options [String] :db_parameter_group_name
|
2742
2754
|
# The name of the DB parameter group to associate with this DB instance.
|
2743
2755
|
# If this argument is omitted, the default DBParameterGroup for the
|
@@ -2753,10 +2765,10 @@ module Aws::RDS
|
|
2753
2765
|
#
|
2754
2766
|
# * Can't end with a hyphen or contain two consecutive hyphens.
|
2755
2767
|
# @option options [Boolean] :deletion_protection
|
2756
|
-
#
|
2757
|
-
# The database can't be deleted when
|
2758
|
-
# default is
|
2759
|
-
# Instance][1].
|
2768
|
+
# A value that indicates whether the DB instance has deletion protection
|
2769
|
+
# enabled. The database can't be deleted when deletion protection is
|
2770
|
+
# enabled. By default, deletion protection is disabled. For more
|
2771
|
+
# information, see [ Deleting a DB Instance][1].
|
2760
2772
|
#
|
2761
2773
|
#
|
2762
2774
|
#
|
@@ -3121,9 +3133,9 @@ module Aws::RDS
|
|
3121
3133
|
# If you don't specify a `SnapshotType` value, then both automated and
|
3122
3134
|
# manual snapshots are returned. Shared and public DB snapshots are not
|
3123
3135
|
# included in the returned results by default. You can include shared
|
3124
|
-
# snapshots with these results by
|
3125
|
-
#
|
3126
|
-
#
|
3136
|
+
# snapshots with these results by enabling the `IncludeShared`
|
3137
|
+
# parameter. You can include public snapshots with these results by
|
3138
|
+
# enabling the `IncludePublic` parameter.
|
3127
3139
|
#
|
3128
3140
|
# The `IncludeShared` and `IncludePublic` parameters don't apply for
|
3129
3141
|
# `SnapshotType` values of `manual` or `automated`. The `IncludePublic`
|
@@ -3137,17 +3149,18 @@ module Aws::RDS
|
|
3137
3149
|
# @option options [Array<Types::Filter>] :filters
|
3138
3150
|
# This parameter is not currently supported.
|
3139
3151
|
# @option options [Boolean] :include_shared
|
3140
|
-
#
|
3141
|
-
# that this AWS account has been given
|
3142
|
-
#
|
3152
|
+
# A value that indicates whether to include shared manual DB cluster
|
3153
|
+
# snapshots from other AWS accounts that this AWS account has been given
|
3154
|
+
# permission to copy or restore. By default, these snapshots are not
|
3155
|
+
# included.
|
3143
3156
|
#
|
3144
3157
|
# You can give an AWS account permission to restore a manual DB snapshot
|
3145
|
-
# from another AWS account by using the ModifyDBSnapshotAttribute API
|
3158
|
+
# from another AWS account by using the `ModifyDBSnapshotAttribute` API
|
3146
3159
|
# action.
|
3147
3160
|
# @option options [Boolean] :include_public
|
3148
|
-
#
|
3149
|
-
# or restored by any AWS account
|
3150
|
-
#
|
3161
|
+
# A value that indicates whether to include manual DB cluster snapshots
|
3162
|
+
# that are public and can be copied or restored by any AWS account. By
|
3163
|
+
# default, the public snapshots are not included.
|
3151
3164
|
#
|
3152
3165
|
# You can share a manual DB snapshot as public by using the
|
3153
3166
|
# ModifyDBSnapshotAttribute API.
|