aws-sdk-rds 1.6.0 → 1.7.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 +181 -156
- data/lib/aws-sdk-rds/client_api.rb +7 -0
- data/lib/aws-sdk-rds/db_cluster.rb +7 -9
- data/lib/aws-sdk-rds/db_instance.rb +124 -102
- data/lib/aws-sdk-rds/db_log_file.rb +2 -2
- data/lib/aws-sdk-rds/db_snapshot.rb +27 -24
- data/lib/aws-sdk-rds/event_subscription.rb +9 -9
- data/lib/aws-sdk-rds/pending_maintenance_action.rb +10 -10
- data/lib/aws-sdk-rds/resource.rb +47 -33
- data/lib/aws-sdk-rds/types.rb +240 -190
- metadata +2 -2
@@ -203,6 +203,7 @@ module Aws::RDS
|
|
203
203
|
DomainMembershipList = Shapes::ListShape.new(name: 'DomainMembershipList')
|
204
204
|
DomainNotFoundFault = Shapes::StructureShape.new(name: 'DomainNotFoundFault')
|
205
205
|
Double = Shapes::FloatShape.new(name: 'Double')
|
206
|
+
DoubleOptional = Shapes::FloatShape.new(name: 'DoubleOptional')
|
206
207
|
DoubleRange = Shapes::StructureShape.new(name: 'DoubleRange')
|
207
208
|
DoubleRangeList = Shapes::ListShape.new(name: 'DoubleRangeList')
|
208
209
|
DownloadDBLogFilePortionDetails = Shapes::StructureShape.new(name: 'DownloadDBLogFilePortionDetails')
|
@@ -1630,6 +1631,12 @@ module Aws::RDS
|
|
1630
1631
|
OrderableDBInstanceOption.add_member(:supports_enhanced_monitoring, Shapes::ShapeRef.new(shape: Boolean, location_name: "SupportsEnhancedMonitoring"))
|
1631
1632
|
OrderableDBInstanceOption.add_member(:supports_iam_database_authentication, Shapes::ShapeRef.new(shape: Boolean, location_name: "SupportsIAMDatabaseAuthentication"))
|
1632
1633
|
OrderableDBInstanceOption.add_member(:supports_performance_insights, Shapes::ShapeRef.new(shape: Boolean, location_name: "SupportsPerformanceInsights"))
|
1634
|
+
OrderableDBInstanceOption.add_member(:min_storage_size, Shapes::ShapeRef.new(shape: IntegerOptional, location_name: "MinStorageSize"))
|
1635
|
+
OrderableDBInstanceOption.add_member(:max_storage_size, Shapes::ShapeRef.new(shape: IntegerOptional, location_name: "MaxStorageSize"))
|
1636
|
+
OrderableDBInstanceOption.add_member(:min_iops_per_db_instance, Shapes::ShapeRef.new(shape: IntegerOptional, location_name: "MinIopsPerDbInstance"))
|
1637
|
+
OrderableDBInstanceOption.add_member(:max_iops_per_db_instance, Shapes::ShapeRef.new(shape: IntegerOptional, location_name: "MaxIopsPerDbInstance"))
|
1638
|
+
OrderableDBInstanceOption.add_member(:min_iops_per_gib, Shapes::ShapeRef.new(shape: DoubleOptional, location_name: "MinIopsPerGib"))
|
1639
|
+
OrderableDBInstanceOption.add_member(:max_iops_per_gib, Shapes::ShapeRef.new(shape: DoubleOptional, location_name: "MaxIopsPerGib"))
|
1633
1640
|
OrderableDBInstanceOption.struct_class = Types::OrderableDBInstanceOption
|
1634
1641
|
|
1635
1642
|
OrderableDBInstanceOptionsList.member = Shapes::ShapeRef.new(shape: OrderableDBInstanceOption, location_name: "OrderableDBInstanceOption")
|
@@ -118,10 +118,9 @@ module Aws::RDS
|
|
118
118
|
# your read workload across multiple Aurora Replicas in your DB cluster.
|
119
119
|
#
|
120
120
|
# If a failover occurs, and the Aurora Replica that you are connected to
|
121
|
-
# is promoted to be the primary instance, your connection
|
122
|
-
#
|
123
|
-
#
|
124
|
-
# endpoint.
|
121
|
+
# is promoted to be the primary instance, your connection is dropped. To
|
122
|
+
# continue sending your read workload to other Aurora Replicas in the
|
123
|
+
# cluster, you can then reconnect to the reader endpoint.
|
125
124
|
# @return [String]
|
126
125
|
def reader_endpoint
|
127
126
|
data[:reader_endpoint]
|
@@ -468,8 +467,7 @@ module Aws::RDS
|
|
468
467
|
# the DB cluster you are creating.
|
469
468
|
# @option options [String] :db_cluster_parameter_group_name
|
470
469
|
# The name of the DB cluster parameter group to associate with this DB
|
471
|
-
# cluster. If this argument is omitted, `default.aurora5.6`
|
472
|
-
# used.
|
470
|
+
# cluster. If this argument is omitted, `default.aurora5.6` is used.
|
473
471
|
#
|
474
472
|
# Constraints:
|
475
473
|
#
|
@@ -600,7 +598,7 @@ module Aws::RDS
|
|
600
598
|
# @option options [String] :pre_signed_url
|
601
599
|
# A URL that contains a Signature Version 4 signed request for the
|
602
600
|
# `CreateDBCluster` action to be called in the source AWS Region where
|
603
|
-
# the DB cluster
|
601
|
+
# the DB cluster is replicated from. You only need to specify
|
604
602
|
# `PreSignedUrl` when you are performing cross-region replication from
|
605
603
|
# an encrypted DB cluster.
|
606
604
|
#
|
@@ -1008,8 +1006,8 @@ module Aws::RDS
|
|
1008
1006
|
#
|
1009
1007
|
# You can restore to a new DB cluster and encrypt the new DB cluster
|
1010
1008
|
# with a KMS key that is different than the KMS key used to encrypt the
|
1011
|
-
# source DB cluster. The new DB cluster
|
1012
|
-
#
|
1009
|
+
# source DB cluster. The new DB cluster is encrypted with the KMS key
|
1010
|
+
# identified by the `KmsKeyId` parameter.
|
1013
1011
|
#
|
1014
1012
|
# If you do not specify a value for the `KmsKeyId` parameter, then the
|
1015
1013
|
# following will occur:
|
@@ -256,17 +256,17 @@ module Aws::RDS
|
|
256
256
|
# * **VPC:**false
|
257
257
|
#
|
258
258
|
# If no DB subnet group has been specified as part of the request and
|
259
|
-
# the PubliclyAccessible value has not been set, the DB instance
|
259
|
+
# the PubliclyAccessible value has not been set, the DB instance is
|
260
260
|
# publicly accessible. If a specific DB subnet group has been specified
|
261
261
|
# as part of the request and the PubliclyAccessible value has not been
|
262
|
-
# set, the DB instance
|
262
|
+
# set, the DB instance is private.
|
263
263
|
# @return [Boolean]
|
264
264
|
def publicly_accessible
|
265
265
|
data[:publicly_accessible]
|
266
266
|
end
|
267
267
|
|
268
268
|
# The status of a Read Replica. If the instance is not a Read Replica,
|
269
|
-
# this
|
269
|
+
# this is blank.
|
270
270
|
# @return [Array<Types::DBInstanceStatusInfo>]
|
271
271
|
def status_infos
|
272
272
|
data[:status_infos]
|
@@ -407,11 +407,16 @@ module Aws::RDS
|
|
407
407
|
data[:iam_database_authentication_enabled]
|
408
408
|
end
|
409
409
|
|
410
|
+
# True if Performance Insights is enabled for the DB instance; otherwise
|
411
|
+
# false.
|
410
412
|
# @return [Boolean]
|
411
413
|
def performance_insights_enabled
|
412
414
|
data[:performance_insights_enabled]
|
413
415
|
end
|
414
416
|
|
417
|
+
# The KMS key identifier for encryption of Performance Insights data.
|
418
|
+
# The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier,
|
419
|
+
# or the KMS key alias for the KMS encryption key.
|
415
420
|
# @return [String]
|
416
421
|
def performance_insights_kms_key_id
|
417
422
|
data[:performance_insights_kms_key_id]
|
@@ -759,16 +764,15 @@ module Aws::RDS
|
|
759
764
|
#
|
760
765
|
# * Web and Express editions: Must be an integer from 20 to 1024.
|
761
766
|
# @option options [required, String] :db_instance_class
|
762
|
-
# The compute and memory capacity of the DB instance
|
763
|
-
# instance classes are available in all
|
764
|
-
#
|
765
|
-
#
|
766
|
-
#
|
767
|
-
#
|
768
|
-
#
|
769
|
-
#
|
770
|
-
#
|
771
|
-
# db.t2.medium | db.t2.large`
|
767
|
+
# The compute and memory capacity of the DB instance, for example,
|
768
|
+
# `db.m4.large`. Not all DB instance classes are available in all
|
769
|
+
# regions, or for all database engines. For the full list of DB instance
|
770
|
+
# classes, and availability for your engine, see [DB Instance Class][1]
|
771
|
+
# in the Amazon RDS User Guide.
|
772
|
+
#
|
773
|
+
#
|
774
|
+
#
|
775
|
+
# [1]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html
|
772
776
|
# @option options [required, String] :engine
|
773
777
|
# The name of the database engine to be used for this instance.
|
774
778
|
#
|
@@ -907,9 +911,9 @@ module Aws::RDS
|
|
907
911
|
# Default: The default EC2 VPC security group for the DB subnet group's
|
908
912
|
# VPC.
|
909
913
|
# @option options [String] :availability_zone
|
910
|
-
# The EC2 Availability Zone that the database instance
|
911
|
-
#
|
912
|
-
#
|
914
|
+
# The EC2 Availability Zone that the database instance is created in.
|
915
|
+
# For information on regions and Availability Zones, see [Regions and
|
916
|
+
# Availability Zones][1].
|
913
917
|
#
|
914
918
|
# Default: A random, system-chosen Availability Zone in the endpoint's
|
915
919
|
# AWS Region.
|
@@ -950,7 +954,7 @@ module Aws::RDS
|
|
950
954
|
# @option options [String] :db_parameter_group_name
|
951
955
|
# The name of the DB parameter group to associate with this DB instance.
|
952
956
|
# If this argument is omitted, the default DBParameterGroup for the
|
953
|
-
# specified engine
|
957
|
+
# specified engine is used.
|
954
958
|
#
|
955
959
|
# Constraints:
|
956
960
|
#
|
@@ -1127,6 +1131,8 @@ module Aws::RDS
|
|
1127
1131
|
#
|
1128
1132
|
# **MySQL**
|
1129
1133
|
#
|
1134
|
+
# * `5.7.19` (supported in all AWS regions)
|
1135
|
+
#
|
1130
1136
|
# * `5.7.17` (supported in all AWS regions)
|
1131
1137
|
#
|
1132
1138
|
# * `5.7.16` (supported in all AWS regions)
|
@@ -1135,6 +1141,8 @@ module Aws::RDS
|
|
1135
1141
|
#
|
1136
1142
|
#
|
1137
1143
|
#
|
1144
|
+
# * `5.6.37` (supported in all AWS regions)
|
1145
|
+
#
|
1138
1146
|
# * `5.6.35` (supported in all AWS regions)
|
1139
1147
|
#
|
1140
1148
|
# * `5.6.34` (supported in all AWS regions)
|
@@ -1146,6 +1154,8 @@ module Aws::RDS
|
|
1146
1154
|
#
|
1147
1155
|
#
|
1148
1156
|
#
|
1157
|
+
# * `5.5.57` (supported in all AWS regions)
|
1158
|
+
#
|
1149
1159
|
# * `5.5.54` (supported in all AWS regions)
|
1150
1160
|
#
|
1151
1161
|
# * `5.5.53` (supported in all AWS regions)
|
@@ -1154,6 +1164,9 @@ module Aws::RDS
|
|
1154
1164
|
#
|
1155
1165
|
# **Oracle 12c**
|
1156
1166
|
#
|
1167
|
+
# * `12.1.0.2.v9` (supported for EE in all AWS regions, and SE2 in all
|
1168
|
+
# AWS regions except us-gov-west-1)
|
1169
|
+
#
|
1157
1170
|
# * `12.1.0.2.v8` (supported for EE in all AWS regions, and SE2 in all
|
1158
1171
|
# AWS regions except us-gov-west-1)
|
1159
1172
|
#
|
@@ -1180,6 +1193,8 @@ module Aws::RDS
|
|
1180
1193
|
#
|
1181
1194
|
# **Oracle 11g**
|
1182
1195
|
#
|
1196
|
+
# * `11.2.0.4.v13` (supported for EE, SE1, and SE, in all AWS regions)
|
1197
|
+
#
|
1183
1198
|
# * `11.2.0.4.v12` (supported for EE, SE1, and SE, in all AWS regions)
|
1184
1199
|
#
|
1185
1200
|
# * `11.2.0.4.v11` (supported for EE, SE1, and SE, in all AWS regions)
|
@@ -1204,16 +1219,16 @@ module Aws::RDS
|
|
1204
1219
|
#
|
1205
1220
|
# **PostgreSQL**
|
1206
1221
|
#
|
1207
|
-
# * **Version 9.6.x:** ` 9.6.
|
1222
|
+
# * **Version 9.6.x:** ` 9.6.5 | 9.6.3 | 9.6.2 | 9.6.1`
|
1208
1223
|
#
|
1209
|
-
# * **Version 9.5.x:** `9.5.6 | 9.5.4 | 9.5.2`
|
1224
|
+
# * **Version 9.5.x:** ` 9.5.9 | 9.5.7 | 9.5.6 | 9.5.4 | 9.5.2`
|
1210
1225
|
#
|
1211
|
-
# * **Version 9.4.x:** `9.4.11 | 9.4.9 | 9.4.7`
|
1226
|
+
# * **Version 9.4.x:** ` 9.4.14 | 9.4.12 | 9.4.11 | 9.4.9 | 9.4.7`
|
1212
1227
|
#
|
1213
|
-
# * **Version 9.3.x:** `9.3.16 | 9.3.14 | 9.3.12`
|
1228
|
+
# * **Version 9.3.x:** ` 9.3.19 | 9.3.17 | 9.3.16 | 9.3.14 | 9.3.12`
|
1214
1229
|
# @option options [Boolean] :auto_minor_version_upgrade
|
1215
|
-
# Indicates that minor engine upgrades
|
1216
|
-
#
|
1230
|
+
# Indicates that minor engine upgrades are applied automatically to the
|
1231
|
+
# DB instance during the maintenance window.
|
1217
1232
|
#
|
1218
1233
|
# Default: `true`
|
1219
1234
|
# @option options [String] :license_model
|
@@ -1261,10 +1276,10 @@ module Aws::RDS
|
|
1261
1276
|
# * **VPC:** false
|
1262
1277
|
#
|
1263
1278
|
# If no DB subnet group has been specified as part of the request and
|
1264
|
-
# the PubliclyAccessible value has not been set, the DB instance
|
1279
|
+
# the PubliclyAccessible value has not been set, the DB instance is
|
1265
1280
|
# publicly accessible. If a specific DB subnet group has been specified
|
1266
1281
|
# as part of the request and the PubliclyAccessible value has not been
|
1267
|
-
# set, the DB instance
|
1282
|
+
# set, the DB instance is private.
|
1268
1283
|
# @option options [Array<Types::Tag>] :tags
|
1269
1284
|
# A list of tags.
|
1270
1285
|
# @option options [String] :db_cluster_identifier
|
@@ -1387,7 +1402,12 @@ module Aws::RDS
|
|
1387
1402
|
#
|
1388
1403
|
# Default: `false`
|
1389
1404
|
# @option options [Boolean] :enable_performance_insights
|
1405
|
+
# True to enable Performance Insights for the DB instance; otherwise
|
1406
|
+
# false.
|
1390
1407
|
# @option options [String] :performance_insights_kms_key_id
|
1408
|
+
# The KMS key identifier for encryption of Performance Insights data.
|
1409
|
+
# The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier,
|
1410
|
+
# or the KMS key alias for the KMS encryption key.
|
1391
1411
|
# @return [DBInstance]
|
1392
1412
|
def create(options = {})
|
1393
1413
|
options = options.merge(db_instance_identifier: @id)
|
@@ -1434,21 +1454,19 @@ module Aws::RDS
|
|
1434
1454
|
# unique key that identifies a DB instance. This parameter is stored as
|
1435
1455
|
# a lowercase string.
|
1436
1456
|
# @option options [String] :db_instance_class
|
1437
|
-
# The compute and memory capacity of the Read Replica
|
1438
|
-
# instance classes are available in all
|
1439
|
-
#
|
1440
|
-
#
|
1441
|
-
#
|
1442
|
-
# db.m3.large | db.m3.xlarge | db.m3.2xlarge | db.m4.large |
|
1443
|
-
# db.m4.xlarge | db.m4.2xlarge | db.m4.4xlarge | db.m4.10xlarge |
|
1444
|
-
# db.r3.large | db.r3.xlarge | db.r3.2xlarge | db.r3.4xlarge |
|
1445
|
-
# db.r3.8xlarge | db.t2.micro | db.t2.small | db.t2.medium |
|
1446
|
-
# db.t2.large`
|
1457
|
+
# The compute and memory capacity of the Read Replica, for example,
|
1458
|
+
# `db.m4.large`. Not all DB instance classes are available in all
|
1459
|
+
# regions, or for all database engines. For the full list of DB instance
|
1460
|
+
# classes, and availability for your engine, see [DB Instance Class][1]
|
1461
|
+
# in the Amazon RDS User Guide.
|
1447
1462
|
#
|
1448
1463
|
# Default: Inherits from the source DB instance.
|
1464
|
+
#
|
1465
|
+
#
|
1466
|
+
#
|
1467
|
+
# [1]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html
|
1449
1468
|
# @option options [String] :availability_zone
|
1450
|
-
# The Amazon EC2 Availability Zone that the Read Replica
|
1451
|
-
# in.
|
1469
|
+
# The Amazon EC2 Availability Zone that the Read Replica is created in.
|
1452
1470
|
#
|
1453
1471
|
# Default: A random, system-chosen Availability Zone in the endpoint's
|
1454
1472
|
# AWS Region.
|
@@ -1461,16 +1479,16 @@ module Aws::RDS
|
|
1461
1479
|
#
|
1462
1480
|
# Valid Values: `1150-65535`
|
1463
1481
|
# @option options [Boolean] :auto_minor_version_upgrade
|
1464
|
-
# Indicates that minor engine upgrades
|
1465
|
-
#
|
1482
|
+
# Indicates that minor engine upgrades are applied automatically to the
|
1483
|
+
# Read Replica during the maintenance window.
|
1466
1484
|
#
|
1467
1485
|
# Default: Inherits from the source DB instance
|
1468
1486
|
# @option options [Integer] :iops
|
1469
1487
|
# The amount of Provisioned IOPS (input/output operations per second) to
|
1470
1488
|
# be initially allocated for the DB instance.
|
1471
1489
|
# @option options [String] :option_group_name
|
1472
|
-
# The option group the DB instance
|
1473
|
-
#
|
1490
|
+
# The option group the DB instance is associated with. If omitted, the
|
1491
|
+
# default option group for the engine specified is used.
|
1474
1492
|
# @option options [Boolean] :publicly_accessible
|
1475
1493
|
# Specifies the accessibility options for the DB instance. A value of
|
1476
1494
|
# true specifies an Internet-facing instance with a publicly resolvable
|
@@ -1487,17 +1505,17 @@ module Aws::RDS
|
|
1487
1505
|
# * **VPC:**false
|
1488
1506
|
#
|
1489
1507
|
# If no DB subnet group has been specified as part of the request and
|
1490
|
-
# the PubliclyAccessible value has not been set, the DB instance
|
1508
|
+
# the PubliclyAccessible value has not been set, the DB instance is
|
1491
1509
|
# publicly accessible. If a specific DB subnet group has been specified
|
1492
1510
|
# as part of the request and the PubliclyAccessible value has not been
|
1493
|
-
# set, the DB instance
|
1511
|
+
# set, the DB instance is private.
|
1494
1512
|
# @option options [Array<Types::Tag>] :tags
|
1495
1513
|
# A list of tags.
|
1496
1514
|
# @option options [String] :db_subnet_group_name
|
1497
1515
|
# Specifies a DB subnet group for the DB instance. The new DB instance
|
1498
|
-
#
|
1499
|
-
#
|
1500
|
-
#
|
1516
|
+
# is created in the VPC associated with the DB subnet group. If no DB
|
1517
|
+
# subnet group is specified, then the new DB instance is not created in
|
1518
|
+
# a VPC.
|
1501
1519
|
#
|
1502
1520
|
# Constraints:
|
1503
1521
|
#
|
@@ -1513,10 +1531,10 @@ module Aws::RDS
|
|
1513
1531
|
# source DB instance must either:>
|
1514
1532
|
#
|
1515
1533
|
# * Specify DB subnet groups from the same VPC. All these Read
|
1516
|
-
# Replicas
|
1534
|
+
# Replicas are created in the same VPC.
|
1517
1535
|
#
|
1518
|
-
# * Not specify a DB subnet group. All these Read Replicas
|
1519
|
-
#
|
1536
|
+
# * Not specify a DB subnet group. All these Read Replicas are created
|
1537
|
+
# outside of any VPC.
|
1520
1538
|
#
|
1521
1539
|
# Example: `mySubnetgroup`
|
1522
1540
|
# @option options [String] :storage_type
|
@@ -1589,7 +1607,7 @@ module Aws::RDS
|
|
1589
1607
|
# presigned URL request must contain the following parameter values:
|
1590
1608
|
#
|
1591
1609
|
# * `DestinationRegion` - The AWS Region that the encrypted Read Replica
|
1592
|
-
#
|
1610
|
+
# is created in. This AWS Region is the same one where the
|
1593
1611
|
# `CreateDBInstanceReadReplica` action is called that contains this
|
1594
1612
|
# presigned URL.
|
1595
1613
|
#
|
@@ -1638,7 +1656,12 @@ module Aws::RDS
|
|
1638
1656
|
#
|
1639
1657
|
# Default: `false`
|
1640
1658
|
# @option options [Boolean] :enable_performance_insights
|
1659
|
+
# True to enable Performance Insights for the read replica; otherwise
|
1660
|
+
# false.
|
1641
1661
|
# @option options [String] :performance_insights_kms_key_id
|
1662
|
+
# The KMS key identifier for encryption of Performance Insights data.
|
1663
|
+
# The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier,
|
1664
|
+
# or the KMS key alias for the KMS encryption key.
|
1642
1665
|
# @option options [String] :destination_region
|
1643
1666
|
# @option options [String] :source_region
|
1644
1667
|
# The source region of the snapshot. This is only needed when the
|
@@ -1856,32 +1879,28 @@ module Aws::RDS
|
|
1856
1879
|
# provisioned (if any), and the number of prior scale storage
|
1857
1880
|
# operations. Typical migration times are under 24 hours, but the
|
1858
1881
|
# process can take up to several days in some cases. During the
|
1859
|
-
# migration, the DB instance
|
1860
|
-
#
|
1861
|
-
#
|
1862
|
-
#
|
1863
|
-
#
|
1864
|
-
#
|
1865
|
-
# instance.
|
1882
|
+
# migration, the DB instance is available for use, but might experience
|
1883
|
+
# performance degradation. While the migration takes place, nightly
|
1884
|
+
# backups for the instance are suspended. No other Amazon RDS operations
|
1885
|
+
# can take place for the instance, including modifying the instance,
|
1886
|
+
# rebooting the instance, deleting the instance, creating a Read Replica
|
1887
|
+
# for the instance, and creating a DB snapshot of the instance.
|
1866
1888
|
# @option options [String] :db_instance_class
|
1867
|
-
# The new compute and memory capacity of the DB instance
|
1868
|
-
#
|
1869
|
-
#
|
1870
|
-
#
|
1889
|
+
# The new compute and memory capacity of the DB instance, for example,
|
1890
|
+
# `db.m4.large`. Not all DB instance classes are available in all
|
1891
|
+
# regions, or for all database engines. For the full list of DB instance
|
1892
|
+
# classes, and availability for your engine, see [DB Instance Class][1]
|
1893
|
+
# in the Amazon RDS User Guide.
|
1871
1894
|
#
|
1872
|
-
#
|
1873
|
-
#
|
1874
|
-
# `ApplyImmediately` is specified as `true` for this request.
|
1895
|
+
# If you modify the DB instance class, an outage occurs during the
|
1896
|
+
# change. The change is applied during the next maintenance window,
|
1897
|
+
# unless `ApplyImmediately` is specified as `true` for this request.
|
1875
1898
|
#
|
1876
1899
|
# Default: Uses existing setting
|
1877
1900
|
#
|
1878
|
-
#
|
1879
|
-
#
|
1880
|
-
#
|
1881
|
-
# db.m4.large | db.m4.xlarge | db.m4.2xlarge | db.m4.4xlarge |
|
1882
|
-
# db.m4.10xlarge | db.r3.large | db.r3.xlarge | db.r3.2xlarge |
|
1883
|
-
# db.r3.4xlarge | db.r3.8xlarge | db.t2.micro | db.t2.small |
|
1884
|
-
# db.t2.medium | db.t2.large`
|
1901
|
+
#
|
1902
|
+
#
|
1903
|
+
# [1]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html
|
1885
1904
|
# @option options [String] :db_subnet_group_name
|
1886
1905
|
# The new DB subnet group for the DB instance. You can use this
|
1887
1906
|
# parameter to move your DB instance to a different VPC. If your DB
|
@@ -1933,12 +1952,12 @@ module Aws::RDS
|
|
1933
1952
|
#
|
1934
1953
|
# If this parameter is set to `false`, changes to the DB instance are
|
1935
1954
|
# applied during the next maintenance window. Some parameter changes can
|
1936
|
-
# cause an outage and
|
1937
|
-
#
|
1938
|
-
#
|
1939
|
-
#
|
1940
|
-
#
|
1941
|
-
#
|
1955
|
+
# cause an outage and are applied on the next call to RebootDBInstance,
|
1956
|
+
# or the next failure reboot. Review the table of parameters in
|
1957
|
+
# [Modifying a DB Instance and Using the Apply Immediately Parameter][1]
|
1958
|
+
# to see the impact that setting `ApplyImmediately` to `true` or `false`
|
1959
|
+
# has for each modified parameter and to determine when the changes are
|
1960
|
+
# applied.
|
1942
1961
|
#
|
1943
1962
|
# Default: `false`
|
1944
1963
|
#
|
@@ -2098,8 +2117,8 @@ module Aws::RDS
|
|
2098
2117
|
# value for the EngineVersion parameter that is a different major
|
2099
2118
|
# version than the DB instance's current version.
|
2100
2119
|
# @option options [Boolean] :auto_minor_version_upgrade
|
2101
|
-
# Indicates that minor version upgrades
|
2102
|
-
#
|
2120
|
+
# Indicates that minor version upgrades are applied automatically to the
|
2121
|
+
# DB instance during the maintenance window. Changing this parameter
|
2103
2122
|
# does not result in an outage except in the following case and the
|
2104
2123
|
# change is asynchronously applied as soon as possible. An outage will
|
2105
2124
|
# result if this parameter is set to `true` during the maintenance
|
@@ -2140,13 +2159,12 @@ module Aws::RDS
|
|
2140
2159
|
# provisioned (if any), and the number of prior scale storage
|
2141
2160
|
# operations. Typical migration times are under 24 hours, but the
|
2142
2161
|
# process can take up to several days in some cases. During the
|
2143
|
-
# migration, the DB instance
|
2144
|
-
#
|
2145
|
-
#
|
2146
|
-
#
|
2147
|
-
#
|
2148
|
-
#
|
2149
|
-
# instance.
|
2162
|
+
# migration, the DB instance is available for use, but might experience
|
2163
|
+
# performance degradation. While the migration takes place, nightly
|
2164
|
+
# backups for the instance are suspended. No other Amazon RDS operations
|
2165
|
+
# can take place for the instance, including modifying the instance,
|
2166
|
+
# rebooting the instance, deleting the instance, creating a Read Replica
|
2167
|
+
# for the instance, and creating a DB snapshot of the instance.
|
2150
2168
|
# @option options [String] :option_group_name
|
2151
2169
|
# Indicates that the DB instance should be associated with the specified
|
2152
2170
|
# option group. Changing this parameter does not result in an outage
|
@@ -2325,7 +2343,12 @@ module Aws::RDS
|
|
2325
2343
|
#
|
2326
2344
|
# Default: `false`
|
2327
2345
|
# @option options [Boolean] :enable_performance_insights
|
2346
|
+
# True to enable Performance Insights for the DB instance; otherwise
|
2347
|
+
# false.
|
2328
2348
|
# @option options [String] :performance_insights_kms_key_id
|
2349
|
+
# The KMS key identifier for encryption of Performance Insights data.
|
2350
|
+
# The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier,
|
2351
|
+
# or the KMS key alias for the KMS encryption key.
|
2329
2352
|
# @return [DBInstance]
|
2330
2353
|
def modify(options = {})
|
2331
2354
|
options = options.merge(db_instance_identifier: @id)
|
@@ -2396,7 +2419,7 @@ module Aws::RDS
|
|
2396
2419
|
# })
|
2397
2420
|
# @param [Hash] options ({})
|
2398
2421
|
# @option options [Boolean] :force_failover
|
2399
|
-
# When `true`, the reboot
|
2422
|
+
# When `true`, the reboot is conducted through a MultiAZ failover.
|
2400
2423
|
#
|
2401
2424
|
# Constraint: You cannot specify `true` if the instance is not
|
2402
2425
|
# configured for MultiAZ.
|
@@ -2475,17 +2498,17 @@ module Aws::RDS
|
|
2475
2498
|
#
|
2476
2499
|
# Constraints: Cannot be specified if RestoreTime parameter is provided.
|
2477
2500
|
# @option options [String] :db_instance_class
|
2478
|
-
# The compute and memory capacity of the Amazon RDS DB instance
|
2479
|
-
#
|
2480
|
-
#
|
2481
|
-
#
|
2482
|
-
#
|
2483
|
-
# db.m4.xlarge | db.m4.2xlarge | db.m4.4xlarge | db.m4.10xlarge |
|
2484
|
-
# db.r3.large | db.r3.xlarge | db.r3.2xlarge | db.r3.4xlarge |
|
2485
|
-
# db.r3.8xlarge | db.t2.micro | db.t2.small | db.t2.medium |
|
2486
|
-
# db.t2.large`
|
2501
|
+
# The compute and memory capacity of the Amazon RDS DB instance, for
|
2502
|
+
# example, `db.m4.large`. Not all DB instance classes are available in
|
2503
|
+
# all regions, or for all database engines. For the full list of DB
|
2504
|
+
# instance classes, and availability for your engine, see [DB Instance
|
2505
|
+
# Class][1] in the Amazon RDS User Guide.
|
2487
2506
|
#
|
2488
2507
|
# Default: The same DBInstanceClass as the original DB instance.
|
2508
|
+
#
|
2509
|
+
#
|
2510
|
+
#
|
2511
|
+
# [1]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html
|
2489
2512
|
# @option options [Integer] :port
|
2490
2513
|
# The port number on which the database accepts connections.
|
2491
2514
|
#
|
@@ -2493,8 +2516,7 @@ module Aws::RDS
|
|
2493
2516
|
#
|
2494
2517
|
# Default: The same port as the original DB instance.
|
2495
2518
|
# @option options [String] :availability_zone
|
2496
|
-
# The EC2 Availability Zone that the database instance
|
2497
|
-
# in.
|
2519
|
+
# The EC2 Availability Zone that the database instance is created in.
|
2498
2520
|
#
|
2499
2521
|
# Default: A random, system-chosen Availability Zone.
|
2500
2522
|
#
|
@@ -2530,13 +2552,13 @@ module Aws::RDS
|
|
2530
2552
|
# * **VPC:**false
|
2531
2553
|
#
|
2532
2554
|
# If no DB subnet group has been specified as part of the request and
|
2533
|
-
# the PubliclyAccessible value has not been set, the DB instance
|
2555
|
+
# the PubliclyAccessible value has not been set, the DB instance is
|
2534
2556
|
# publicly accessible. If a specific DB subnet group has been specified
|
2535
2557
|
# as part of the request and the PubliclyAccessible value has not been
|
2536
|
-
# set, the DB instance
|
2558
|
+
# set, the DB instance is private.
|
2537
2559
|
# @option options [Boolean] :auto_minor_version_upgrade
|
2538
|
-
# Indicates that minor version upgrades
|
2539
|
-
#
|
2560
|
+
# Indicates that minor version upgrades are applied automatically to the
|
2561
|
+
# DB instance during the maintenance window.
|
2540
2562
|
# @option options [String] :license_model
|
2541
2563
|
# License model information for the restored DB instance.
|
2542
2564
|
#
|