aws-sdk-rds 1.54.0 → 1.55.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.
@@ -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 deletion protection is enabled. For
453
- # more information, see [ Deleting a DB Instance][1].
452
+ # database can't be deleted when this value is set to true. For more
453
+ # information, see [ Deleting a DB Instance][1].
454
454
  #
455
455
  #
456
456
  #
@@ -753,10 +753,10 @@ module Aws::RDS
753
753
  # following:
754
754
  #
755
755
  # * General Purpose (SSD) storage (gp2): Must be an integer from 20 to
756
- # 65536.
756
+ # 32768.
757
757
  #
758
758
  # * Provisioned IOPS storage (io1): Must be an integer from 100 to
759
- # 65536.
759
+ # 32768.
760
760
  #
761
761
  # * Magnetic storage (standard): Must be an integer from 5 to 3072.
762
762
  #
@@ -766,10 +766,10 @@ module Aws::RDS
766
766
  # following:
767
767
  #
768
768
  # * General Purpose (SSD) storage (gp2): Must be an integer from 20 to
769
- # 65536.
769
+ # 32768.
770
770
  #
771
771
  # * Provisioned IOPS storage (io1): Must be an integer from 100 to
772
- # 65536.
772
+ # 32768.
773
773
  #
774
774
  # * Magnetic storage (standard): Must be an integer from 5 to 3072.
775
775
  #
@@ -779,10 +779,10 @@ module Aws::RDS
779
779
  # following:
780
780
  #
781
781
  # * General Purpose (SSD) storage (gp2): Must be an integer from 20 to
782
- # 65536.
782
+ # 32768.
783
783
  #
784
784
  # * Provisioned IOPS storage (io1): Must be an integer from 100 to
785
- # 65536.
785
+ # 32768.
786
786
  #
787
787
  # * Magnetic storage (standard): Must be an integer from 5 to 3072.
788
788
  #
@@ -792,10 +792,10 @@ module Aws::RDS
792
792
  # following:
793
793
  #
794
794
  # * General Purpose (SSD) storage (gp2): Must be an integer from 20 to
795
- # 65536.
795
+ # 32768.
796
796
  #
797
797
  # * Provisioned IOPS storage (io1): Must be an integer from 100 to
798
- # 65536.
798
+ # 32768.
799
799
  #
800
800
  # * Magnetic storage (standard): Must be an integer from 10 to 3072.
801
801
  #
@@ -986,9 +986,9 @@ module Aws::RDS
986
986
  #
987
987
  # Example: `us-east-1d`
988
988
  #
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.
989
+ # Constraint: The AvailabilityZone parameter can't be specified if the
990
+ # MultiAZ parameter is set to `true`. The specified Availability Zone
991
+ # must be in the same AWS Region as the current endpoint.
992
992
  #
993
993
  #
994
994
  #
@@ -1122,9 +1122,9 @@ module Aws::RDS
1122
1122
  #
1123
1123
  # Type: Integer
1124
1124
  # @option options [Boolean] :multi_az
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.
1125
+ # A value that specifies whether the DB instance is a Multi-AZ
1126
+ # deployment. You can't set the AvailabilityZone parameter if the
1127
+ # MultiAZ parameter is set to true.
1128
1128
  # @option options [String] :engine_version
1129
1129
  # The version number of the database engine to use.
1130
1130
  #
@@ -1172,9 +1172,10 @@ module Aws::RDS
1172
1172
  # [4]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Appendix.Oracle.PatchComposition.html
1173
1173
  # [5]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_PostgreSQL.html#PostgreSQL.Concepts.General.DBVersions
1174
1174
  # @option options [Boolean] :auto_minor_version_upgrade
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.
1175
+ # Indicates that minor engine upgrades are applied automatically to the
1176
+ # DB instance during the maintenance window.
1177
+ #
1178
+ # Default: `true`
1178
1179
  # @option options [String] :license_model
1179
1180
  # License model information for this DB instance.
1180
1181
  #
@@ -1209,12 +1210,11 @@ module Aws::RDS
1209
1210
  # Not applicable. The character set is managed by the DB cluster. For
1210
1211
  # more information, see `CreateDBCluster`.
1211
1212
  # @option options [Boolean] :publicly_accessible
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.
1213
+ # Specifies the accessibility options for the DB instance. A value of
1214
+ # true specifies an Internet-facing instance with a publicly resolvable
1215
+ # DNS name, which resolves to a public IP address. A value of false
1216
+ # specifies an internal instance with a DNS name that resolves to a
1217
+ # private IP address.
1218
1218
  #
1219
1219
  # Default: The default behavior varies depending on whether
1220
1220
  # `DBSubnetGroupName` is specified.
@@ -1248,7 +1248,8 @@ module Aws::RDS
1248
1248
  # If you specify `io1`, you must also include a value for the `Iops`
1249
1249
  # parameter.
1250
1250
  #
1251
- # Default: `io1` if the `Iops` parameter is specified, otherwise `gp2`
1251
+ # Default: `io1` if the `Iops` parameter is specified, otherwise
1252
+ # `standard`
1252
1253
  # @option options [String] :tde_credential_arn
1253
1254
  # The ARN from the key store with which to associate the instance for
1254
1255
  # TDE encryption.
@@ -1256,13 +1257,14 @@ module Aws::RDS
1256
1257
  # The password for the given ARN from the key store in order to access
1257
1258
  # the device.
1258
1259
  # @option options [Boolean] :storage_encrypted
1259
- # A value that indicates whether the DB instance is encrypted. By
1260
- # default, it is not encrypted.
1260
+ # Specifies whether the DB instance is encrypted.
1261
1261
  #
1262
1262
  # **Amazon Aurora**
1263
1263
  #
1264
1264
  # Not applicable. The encryption for DB instances is managed by the DB
1265
1265
  # cluster.
1266
+ #
1267
+ # Default: false
1266
1268
  # @option options [String] :kms_key_id
1267
1269
  # The AWS KMS key identifier for an encrypted DB instance.
1268
1270
  #
@@ -1277,11 +1279,11 @@ module Aws::RDS
1277
1279
  # Not applicable. The KMS key identifier is managed by the DB cluster.
1278
1280
  # For more information, see `CreateDBCluster`.
1279
1281
  #
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.
1282
+ # If the `StorageEncrypted` parameter is true, and you do not specify a
1283
+ # value for the `KmsKeyId` parameter, then Amazon RDS will use your
1284
+ # default encryption key. AWS KMS creates the default encryption key for
1285
+ # your AWS account. Your AWS account has a different default encryption
1286
+ # key for each AWS Region.
1285
1287
  # @option options [String] :domain
1286
1288
  # For an Amazon RDS DB instance that's running Microsoft SQL Server,
1287
1289
  # this parameter specifies the Active Directory directory ID to create
@@ -1295,8 +1297,8 @@ module Aws::RDS
1295
1297
  #
1296
1298
  # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/DeveloperGuide/USER_SQLServerWinAuth.html
1297
1299
  # @option options [Boolean] :copy_tags_to_snapshot
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.
1300
+ # True to copy all tags from the DB instance to snapshots of the DB
1301
+ # instance, and otherwise false. The default is false.
1300
1302
  #
1301
1303
  # **Amazon Aurora**
1302
1304
  #
@@ -1349,9 +1351,8 @@ module Aws::RDS
1349
1351
  #
1350
1352
  # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_SQLServer.html#SQLServer.Concepts.General.TimeZone
1351
1353
  # @option options [Boolean] :enable_iam_database_authentication
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.
1354
+ # True to enable mapping of AWS Identity and Access Management (IAM)
1355
+ # accounts to database accounts, and otherwise false.
1355
1356
  #
1356
1357
  # You can enable IAM database authentication for the following database
1357
1358
  # engines:
@@ -1366,9 +1367,11 @@ module Aws::RDS
1366
1367
  # * For MySQL 5.6, minor version 5.6.34 or higher
1367
1368
  #
1368
1369
  # * For MySQL 5.7, minor version 5.7.16 or higher
1370
+ #
1371
+ # Default: `false`
1369
1372
  # @option options [Boolean] :enable_performance_insights
1370
- # A value that indicates whether to enable Performance Insights for the
1371
- # DB instance.
1373
+ # True to enable Performance Insights for the DB instance, and otherwise
1374
+ # false.
1372
1375
  #
1373
1376
  # For more information, see [Using Amazon Performance Insights][1] in
1374
1377
  # the *Amazon Relational Database Service User Guide*.
@@ -1380,11 +1383,6 @@ module Aws::RDS
1380
1383
  # The AWS KMS key identifier for encryption of Performance Insights
1381
1384
  # data. The KMS key ID is the Amazon Resource Name (ARN), KMS key
1382
1385
  # 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.
1388
1386
  # @option options [Integer] :performance_insights_retention_period
1389
1387
  # The amount of time, in days, to retain Performance Insights data.
1390
1388
  # Valid values are 7 or 731 (2 years).
@@ -1402,10 +1400,10 @@ module Aws::RDS
1402
1400
  # The number of CPU cores and the number of threads per core for the DB
1403
1401
  # instance class of the DB instance.
1404
1402
  # @option options [Boolean] :deletion_protection
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].
1403
+ # Indicates if the DB instance should have deletion protection enabled.
1404
+ # The database can't be deleted when this value is set to true. The
1405
+ # default is false. For more information, see [ Deleting a DB
1406
+ # Instance][1].
1409
1407
  #
1410
1408
  #
1411
1409
  #
@@ -1493,8 +1491,7 @@ module Aws::RDS
1493
1491
  #
1494
1492
  # Valid Values: `1150-65535`
1495
1493
  # @option options [Boolean] :multi_az
1496
- # A value that indicates whether the Read Replica is in a Multi-AZ
1497
- # deployment.
1494
+ # Specifies whether the Read Replica is in a Multi-AZ deployment.
1498
1495
  #
1499
1496
  # You can create a Read Replica as a Multi-AZ DB instance. RDS creates a
1500
1497
  # standby of your replica in another Availability Zone for failover
@@ -1502,8 +1499,8 @@ module Aws::RDS
1502
1499
  # instance is independent of whether the source database is a Multi-AZ
1503
1500
  # DB instance.
1504
1501
  # @option options [Boolean] :auto_minor_version_upgrade
1505
- # A value that indicates whether minor engine upgrades are applied
1506
- # automatically to the Read Replica during the maintenance window.
1502
+ # Indicates that minor engine upgrades are applied automatically to the
1503
+ # Read Replica during the maintenance window.
1507
1504
  #
1508
1505
  # Default: Inherits from the source DB instance
1509
1506
  # @option options [Integer] :iops
@@ -1513,12 +1510,11 @@ module Aws::RDS
1513
1510
  # The option group the DB instance is associated with. If omitted, the
1514
1511
  # option group associated with the source instance is used.
1515
1512
  # @option options [Boolean] :publicly_accessible
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.
1513
+ # Specifies the accessibility options for the DB instance. A value of
1514
+ # true specifies an Internet-facing instance with a publicly resolvable
1515
+ # DNS name, which resolves to a public IP address. A value of false
1516
+ # specifies an internal instance with a DNS name that resolves to a
1517
+ # private IP address. For more information, see `CreateDBInstance`.
1522
1518
  # @option options [Array<Types::Tag>] :tags
1523
1519
  # A list of tags. For more information, see [Tagging Amazon RDS
1524
1520
  # Resources][1] in the *Amazon RDS User Guide.*
@@ -1565,10 +1561,11 @@ module Aws::RDS
1565
1561
  # If you specify `io1`, you must also include a value for the `Iops`
1566
1562
  # parameter.
1567
1563
  #
1568
- # Default: `io1` if the `Iops` parameter is specified, otherwise `gp2`
1564
+ # Default: `io1` if the `Iops` parameter is specified, otherwise
1565
+ # `standard`
1569
1566
  # @option options [Boolean] :copy_tags_to_snapshot
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.
1567
+ # True to copy all tags from the Read Replica to snapshots of the Read
1568
+ # Replica, and otherwise false. The default is false.
1572
1569
  # @option options [Integer] :monitoring_interval
1573
1570
  # The interval, in seconds, between points when Enhanced Monitoring
1574
1571
  # metrics are collected for the Read Replica. To disable collecting
@@ -1661,9 +1658,8 @@ module Aws::RDS
1661
1658
  # [1]: https://docs.aws.amazon.com/AmazonS3/latest/API/sigv4-query-string-auth.html
1662
1659
  # [2]: https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html
1663
1660
  # @option options [Boolean] :enable_iam_database_authentication
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.
1661
+ # True to enable mapping of AWS Identity and Access Management (IAM)
1662
+ # accounts to database accounts, and otherwise false.
1667
1663
  #
1668
1664
  # You can enable IAM database authentication for the following database
1669
1665
  # engines
@@ -1673,9 +1669,11 @@ module Aws::RDS
1673
1669
  # * For MySQL 5.7, minor version 5.7.16 or higher
1674
1670
  #
1675
1671
  # * Aurora MySQL 5.6 or higher
1672
+ #
1673
+ # Default: `false`
1676
1674
  # @option options [Boolean] :enable_performance_insights
1677
- # A value that indicates whether to enable Performance Insights for the
1678
- # Read Replica.
1675
+ # True to enable Performance Insights for the Read Replica, and
1676
+ # otherwise false.
1679
1677
  #
1680
1678
  # For more information, see [Using Amazon Performance Insights][1] in
1681
1679
  # the *Amazon RDS User Guide*.
@@ -1687,11 +1685,6 @@ module Aws::RDS
1687
1685
  # The AWS KMS key identifier for encryption of Performance Insights
1688
1686
  # data. The KMS key ID is the Amazon Resource Name (ARN), KMS key
1689
1687
  # 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.
1695
1688
  # @option options [Integer] :performance_insights_retention_period
1696
1689
  # The amount of time, in days, to retain Performance Insights data.
1697
1690
  # Valid values are 7 or 731 (2 years).
@@ -1708,13 +1701,13 @@ module Aws::RDS
1708
1701
  # The number of CPU cores and the number of threads per core for the DB
1709
1702
  # instance class of the DB instance.
1710
1703
  # @option options [Boolean] :use_default_processor_features
1711
- # A value that indicates whether the DB instance class of the DB
1712
- # instance uses its default processor features.
1704
+ # A value that specifies that the DB instance class of the DB instance
1705
+ # uses its default processor features.
1713
1706
  # @option options [Boolean] :deletion_protection
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].
1707
+ # Indicates if the DB instance should have deletion protection enabled.
1708
+ # The database can't be deleted when this value is set to true. The
1709
+ # default is false. For more information, see [ Deleting a DB
1710
+ # Instance][1].
1718
1711
  #
1719
1712
  #
1720
1713
  #
@@ -1788,28 +1781,29 @@ module Aws::RDS
1788
1781
  # })
1789
1782
  # @param [Hash] options ({})
1790
1783
  # @option options [Boolean] :skip_final_snapshot
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.
1784
+ # A value that indicates whether a final DB snapshot is created before
1785
+ # the DB instance is deleted. If `true` is specified, no DB snapshot is
1786
+ # created. If `false` is specified, a DB snapshot is created before the
1787
+ # DB instance is deleted.
1796
1788
  #
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.
1789
+ # When a DB instance is in a failure state and has a status of `failed`,
1790
+ # `incompatible-restore`, or `incompatible-network`, you can only delete
1791
+ # it when the `SkipFinalSnapshot` parameter is set to `true`.
1800
1792
  #
1801
- # Specify skip when deleting a Read Replica.
1793
+ # Specify `true` when deleting a Read Replica.
1802
1794
  #
1803
- # <note markdown="1"> The FinalDBSnapshotIdentifier parameter must be specified if skip is
1804
- # not specified.
1795
+ # <note markdown="1"> The `FinalDBSnapshotIdentifier` parameter must be specified if
1796
+ # `SkipFinalSnapshot` is `false`.
1805
1797
  #
1806
1798
  # </note>
1799
+ #
1800
+ # Default: `false`
1807
1801
  # @option options [String] :final_db_snapshot_identifier
1808
- # The `DBSnapshotIdentifier` of the new `DBSnapshot` created when the
1809
- # `SkipFinalSnapshot` parameter is disabled.
1802
+ # The `DBSnapshotIdentifier` of the new DB snapshot created when
1803
+ # `SkipFinalSnapshot` is set to `false`.
1810
1804
  #
1811
- # <note markdown="1"> Specifying this parameter and also specifying to skip final DB
1812
- # snapshot creation in SkipFinalShapshot results in an error.
1805
+ # <note markdown="1"> Specifying this parameter and also setting the `SkipFinalShapshot`
1806
+ # parameter to `true` results in an error.
1813
1807
  #
1814
1808
  # </note>
1815
1809
  #
@@ -1825,8 +1819,7 @@ module Aws::RDS
1825
1819
  # @option options [Boolean] :delete_automated_backups
1826
1820
  # A value that indicates whether to remove automated backups immediately
1827
1821
  # after the DB instance is deleted. This parameter isn't
1828
- # case-sensitive. The default is to remove automated backups immediately
1829
- # after the DB instance is deleted.
1822
+ # case-sensitive. This parameter defaults to `true`.
1830
1823
  # @return [DBInstance]
1831
1824
  def delete(options = {})
1832
1825
  options = options.merge(db_instance_identifier: @id)
@@ -1910,7 +1903,7 @@ module Aws::RDS
1910
1903
  #
1911
1904
  # If you modify the DB instance class, an outage occurs during the
1912
1905
  # change. The change is applied during the next maintenance window,
1913
- # unless `ApplyImmediately` is enabled for this request.
1906
+ # unless `ApplyImmediately` is specified as `true` for this request.
1914
1907
  #
1915
1908
  # Default: Uses existing setting
1916
1909
  #
@@ -1926,7 +1919,7 @@ module Aws::RDS
1926
1919
  #
1927
1920
  # Changing the subnet group causes an outage during the change. The
1928
1921
  # change is applied during the next maintenance window, unless you
1929
- # enable `ApplyImmediately`.
1922
+ # specify `true` for the `ApplyImmediately` parameter.
1930
1923
  #
1931
1924
  # Constraints: If supplied, must match the name of an existing
1932
1925
  # DBSubnetGroup.
@@ -1962,18 +1955,21 @@ module Aws::RDS
1962
1955
  #
1963
1956
  # ^
1964
1957
  # @option options [Boolean] :apply_immediately
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.
1958
+ # Specifies whether the modifications in this request and any pending
1959
+ # modifications are asynchronously applied as soon as possible,
1960
+ # regardless of the `PreferredMaintenanceWindow` setting for the DB
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
1966
+ # `RebootDBInstance`, or the next failure reboot. Review the table of
1967
+ # parameters in [Modifying a DB Instance and Using the Apply Immediately
1968
+ # Parameter][1] in the *Amazon RDS User Guide.* to see the impact that
1969
+ # setting `ApplyImmediately` to `true` or `false` has for each modified
1970
+ # parameter and to determine when the changes are applied.
1969
1971
  #
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.
1972
+ # Default: `false`
1977
1973
  #
1978
1974
  #
1979
1975
  #
@@ -2042,7 +2038,7 @@ module Aws::RDS
2042
2038
  # Changing this parameter can result in an outage if you change from 0
2043
2039
  # to a non-zero value or from a non-zero value to 0. These changes are
2044
2040
  # applied during the next maintenance window unless the
2045
- # `ApplyImmediately` parameter is enabled for this request. If you
2041
+ # `ApplyImmediately` parameter is set to `true` for this request. If you
2046
2042
  # change the parameter from one non-zero value to another non-zero
2047
2043
  # value, the change is asynchronously applied as soon as possible.
2048
2044
  #
@@ -2105,15 +2101,15 @@ module Aws::RDS
2105
2101
  #
2106
2102
  # Constraints: Must be at least 30 minutes
2107
2103
  # @option options [Boolean] :multi_az
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.
2104
+ # Specifies if the DB instance is a Multi-AZ deployment. Changing this
2105
+ # parameter doesn't result in an outage and the change is applied
2106
+ # during the next maintenance window unless the `ApplyImmediately`
2107
+ # parameter is set to `true` for this request.
2112
2108
  # @option options [String] :engine_version
2113
2109
  # The version number of the database engine to upgrade to. Changing this
2114
2110
  # parameter results in an outage and the change is applied during the
2115
- # next maintenance window unless the `ApplyImmediately` parameter is
2116
- # eanbled for this request.
2111
+ # next maintenance window unless the `ApplyImmediately` parameter is set
2112
+ # to `true` for this request.
2117
2113
  #
2118
2114
  # For major version upgrades, if a nondefault DB parameter group is
2119
2115
  # currently in use, a new DB parameter group in the DB parameter group
@@ -2123,21 +2119,21 @@ module Aws::RDS
2123
2119
  # For information about valid engine versions, see `CreateDBInstance`,
2124
2120
  # or call `DescribeDBEngineVersions`.
2125
2121
  # @option options [Boolean] :allow_major_version_upgrade
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
2122
+ # Indicates that major version upgrades are allowed. Changing this
2123
+ # parameter doesn't result in an outage and the change is
2128
2124
  # asynchronously applied as soon as possible.
2129
2125
  #
2130
- # Constraints: Major version upgrades must be allowed when specifying a
2126
+ # Constraints: This parameter must be set to true when specifying a
2131
2127
  # value for the EngineVersion parameter that is a different major
2132
2128
  # version than the DB instance's current version.
2133
2129
  # @option options [Boolean] :auto_minor_version_upgrade
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.
2130
+ # Indicates that minor version upgrades are applied automatically to the
2131
+ # DB instance during the maintenance window. Changing this parameter
2132
+ # doesn't result in an outage except in the following case and the
2133
+ # change is asynchronously applied as soon as possible. An outage will
2134
+ # result if this parameter is set to `true` during the maintenance
2135
+ # window, and a newer minor version is available, and RDS has enabled
2136
+ # auto patching for that engine version.
2141
2137
  # @option options [String] :license_model
2142
2138
  # The license model for the DB instance.
2143
2139
  #
@@ -2149,10 +2145,10 @@ module Aws::RDS
2149
2145
  #
2150
2146
  # Changing this setting doesn't result in an outage and the change is
2151
2147
  # applied during the next maintenance window unless the
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.
2148
+ # `ApplyImmediately` parameter is set to `true` for this request. If you
2149
+ # are migrating from Provisioned IOPS to standard storage, set this
2150
+ # value to 0. The DB instance will require a reboot for the change in
2151
+ # storage type to take effect.
2156
2152
  #
2157
2153
  # If you choose to migrate your DB instance from using standard storage
2158
2154
  # to using Provisioned IOPS, or from using Provisioned IOPS to using
@@ -2179,11 +2175,11 @@ module Aws::RDS
2179
2175
  # Indicates that the DB instance should be associated with the specified
2180
2176
  # option group. Changing this parameter doesn't result in an outage
2181
2177
  # except in the following case and the change is applied during the next
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.
2178
+ # maintenance window unless the `ApplyImmediately` parameter is set to
2179
+ # `true` for this request. If the parameter change results in an option
2180
+ # group that enables OEM, this change can cause a brief (sub-second)
2181
+ # period during which new connections are rejected but existing
2182
+ # connections are not interrupted.
2187
2183
  #
2188
2184
  # Permanent options, such as the TDE option for Oracle Advanced Security
2189
2185
  # TDE, can't be removed from an option group, and that option group
@@ -2192,9 +2188,9 @@ module Aws::RDS
2192
2188
  # @option options [String] :new_db_instance_identifier
2193
2189
  # The new DB instance identifier for the DB instance when renaming a DB
2194
2190
  # instance. When you change the DB instance identifier, an instance
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.
2191
+ # reboot will occur immediately if you set `Apply Immediately` to true,
2192
+ # or will occur during the next maintenance window if `Apply
2193
+ # Immediately` to false. This value is stored as a lowercase string.
2198
2194
  #
2199
2195
  # Constraints:
2200
2196
  #
@@ -2228,7 +2224,8 @@ module Aws::RDS
2228
2224
  #
2229
2225
  # Valid values: `standard | gp2 | io1`
2230
2226
  #
2231
- # Default: `io1` if the `Iops` parameter is specified, otherwise `gp2`
2227
+ # Default: `io1` if the `Iops` parameter is specified, otherwise
2228
+ # `standard`
2232
2229
  # @option options [String] :tde_credential_arn
2233
2230
  # The ARN from the key store with which to associate the instance for
2234
2231
  # TDE encryption.
@@ -2244,8 +2241,8 @@ module Aws::RDS
2244
2241
  # created prior to this operation. Currently only a Microsoft SQL Server
2245
2242
  # instance can be created in a Active Directory Domain.
2246
2243
  # @option options [Boolean] :copy_tags_to_snapshot
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.
2244
+ # True to copy all tags from the DB instance to snapshots of the DB
2245
+ # instance, and otherwise false. The default is false.
2249
2246
  #
2250
2247
  # **Amazon Aurora**
2251
2248
  #
@@ -2310,19 +2307,20 @@ module Aws::RDS
2310
2307
  #
2311
2308
  # Valid Values: `1150-65535`
2312
2309
  # @option options [Boolean] :publicly_accessible
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.
2310
+ # Boolean value that indicates if the DB instance has a publicly
2311
+ # resolvable DNS name. Set to `True` to make the DB instance
2312
+ # Internet-facing with a publicly resolvable DNS name, which resolves to
2313
+ # a public IP address. Set to `False` to make the DB instance internal
2314
+ # with a DNS name that resolves to a private IP address.
2319
2315
  #
2320
2316
  # `PubliclyAccessible` only applies to DB instances in a VPC. The DB
2321
2317
  # instance must be part of a public subnet and `PubliclyAccessible` must
2322
- # be enabled for it to be publicly accessible.
2318
+ # be true in order for it to be publicly accessible.
2323
2319
  #
2324
2320
  # Changes to the `PubliclyAccessible` parameter are applied immediately
2325
2321
  # regardless of the value of the `ApplyImmediately` parameter.
2322
+ #
2323
+ # Default: false
2326
2324
  # @option options [String] :monitoring_role_arn
2327
2325
  # The ARN for the IAM role that permits RDS to send enhanced monitoring
2328
2326
  # metrics to Amazon CloudWatch Logs. For example,
@@ -2353,9 +2351,8 @@ module Aws::RDS
2353
2351
  #
2354
2352
  # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Managing.Backups.html#Aurora.Managing.FaultTolerance
2355
2353
  # @option options [Boolean] :enable_iam_database_authentication
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.
2354
+ # True to enable mapping of AWS Identity and Access Management (IAM)
2355
+ # accounts to database accounts, and otherwise false.
2359
2356
  #
2360
2357
  # You can enable IAM database authentication for the following database
2361
2358
  # engines
@@ -2371,9 +2368,11 @@ module Aws::RDS
2371
2368
  # * For MySQL 5.6, minor version 5.6.34 or higher
2372
2369
  #
2373
2370
  # * For MySQL 5.7, minor version 5.7.16 or higher
2371
+ #
2372
+ # Default: `false`
2374
2373
  # @option options [Boolean] :enable_performance_insights
2375
- # A value that indicates whether to enable Performance Insights for the
2376
- # DB instance.
2374
+ # True to enable Performance Insights for the DB instance, and otherwise
2375
+ # false.
2377
2376
  #
2378
2377
  # For more information, see [Using Amazon Performance Insights][1] in
2379
2378
  # the *Amazon Relational Database Service User Guide*.
@@ -2385,11 +2384,6 @@ module Aws::RDS
2385
2384
  # The AWS KMS key identifier for encryption of Performance Insights
2386
2385
  # data. The KMS key ID is the Amazon Resource Name (ARN), KMS key
2387
2386
  # 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.
2393
2387
  # @option options [Integer] :performance_insights_retention_period
2394
2388
  # The amount of time, in days, to retain Performance Insights data.
2395
2389
  # Valid values are 7 or 731 (2 years).
@@ -2404,12 +2398,11 @@ module Aws::RDS
2404
2398
  # The number of CPU cores and the number of threads per core for the DB
2405
2399
  # instance class of the DB instance.
2406
2400
  # @option options [Boolean] :use_default_processor_features
2407
- # A value that indicates whether the DB instance class of the DB
2408
- # instance uses its default processor features.
2401
+ # A value that specifies that the DB instance class of the DB instance
2402
+ # uses its default processor features.
2409
2403
  # @option options [Boolean] :deletion_protection
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
+ # Indicates if the DB instance has deletion protection enabled. The
2405
+ # database can't be deleted when this value is set to true. For more
2413
2406
  # information, see [ Deleting a DB Instance][1].
2414
2407
  #
2415
2408
  #
@@ -2486,11 +2479,10 @@ module Aws::RDS
2486
2479
  # })
2487
2480
  # @param [Hash] options ({})
2488
2481
  # @option options [Boolean] :force_failover
2489
- # A value that indicates whether the reboot is conducted through a
2490
- # Multi-AZ failover.
2482
+ # When `true`, the reboot is conducted through a MultiAZ failover.
2491
2483
  #
2492
- # Constraint: You can't enable force failover if the instance is not
2493
- # configured for Multi-AZ.
2484
+ # Constraint: You can't specify `true` if the instance is not
2485
+ # configured for MultiAZ.
2494
2486
  # @return [DBInstance]
2495
2487
  def reboot(options = {})
2496
2488
  options = options.merge(db_instance_identifier: @id)
@@ -2567,17 +2559,16 @@ module Aws::RDS
2567
2559
  #
2568
2560
  # * Must be before the latest restorable time for the DB instance
2569
2561
  #
2570
- # * Can't be specified if the `UseLatestRestorableTime` parameter is
2571
- # enabled
2562
+ # * Can't be specified if UseLatestRestorableTime parameter is true
2572
2563
  #
2573
2564
  # Example: `2009-09-07T23:45:00Z`
2574
2565
  # @option options [Boolean] :use_latest_restorable_time
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.
2566
+ # Specifies whether (`true`) or not (`false`) the DB instance is
2567
+ # restored from the latest backup time.
2568
+ #
2569
+ # Default: `false`
2578
2570
  #
2579
- # Constraints: Can't be specified if the `RestoreTime` parameter is
2580
- # provided.
2571
+ # Constraints: Can't be specified if RestoreTime parameter is provided.
2581
2572
  # @option options [String] :db_instance_class
2582
2573
  # The compute and memory capacity of the Amazon RDS DB instance, for
2583
2574
  # example, `db.m4.large`. Not all DB instance classes are available in
@@ -2601,8 +2592,8 @@ module Aws::RDS
2601
2592
  #
2602
2593
  # Default: A random, system-chosen Availability Zone.
2603
2594
  #
2604
- # Constraint: You can't specify the `AvailabilityZone` parameter if the
2605
- # DB instance is a Multi-AZ deployment.
2595
+ # Constraint: You can't specify the AvailabilityZone parameter if the
2596
+ # MultiAZ parameter is set to true.
2606
2597
  #
2607
2598
  # Example: `us-east-1a`
2608
2599
  # @option options [String] :db_subnet_group_name
@@ -2613,21 +2604,19 @@ module Aws::RDS
2613
2604
  #
2614
2605
  # Example: `mySubnetgroup`
2615
2606
  # @option options [Boolean] :multi_az
2616
- # A value that indicates whether the DB instance is a Multi-AZ
2617
- # deployment.
2607
+ # Specifies if the DB instance is a Multi-AZ deployment.
2618
2608
  #
2619
- # Constraint: You can't specify the `AvailabilityZone` parameter if the
2620
- # DB instance is a Multi-AZ deployment.
2609
+ # Constraint: You can't specify the AvailabilityZone parameter if the
2610
+ # MultiAZ parameter is set to `true`.
2621
2611
  # @option options [Boolean] :publicly_accessible
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.
2612
+ # Specifies the accessibility options for the DB instance. A value of
2613
+ # true specifies an Internet-facing instance with a publicly resolvable
2614
+ # DNS name, which resolves to a public IP address. A value of false
2615
+ # specifies an internal instance with a DNS name that resolves to a
2616
+ # private IP address. For more information, see `CreateDBInstance`.
2628
2617
  # @option options [Boolean] :auto_minor_version_upgrade
2629
- # A value that indicates whether minor version upgrades are applied
2630
- # automatically to the DB instance during the maintenance window.
2618
+ # Indicates that minor version upgrades are applied automatically to the
2619
+ # DB instance during the maintenance window.
2631
2620
  # @option options [String] :license_model
2632
2621
  # License model information for the restored DB instance.
2633
2622
  #
@@ -2689,9 +2678,8 @@ module Aws::RDS
2689
2678
  # can't be removed from a DB instance once it is associated with a DB
2690
2679
  # instance
2691
2680
  # @option options [Boolean] :copy_tags_to_snapshot
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
+ # True to copy all tags from the restored DB instance to snapshots of
2682
+ # the restored DB instance, and otherwise false. The default is false.
2695
2683
  # @option options [Array<Types::Tag>] :tags
2696
2684
  # A list of tags. For more information, see [Tagging Amazon RDS
2697
2685
  # Resources][1] in the *Amazon RDS User Guide.*
@@ -2707,7 +2695,8 @@ module Aws::RDS
2707
2695
  # If you specify `io1`, you must also include a value for the `Iops`
2708
2696
  # parameter.
2709
2697
  #
2710
- # Default: `io1` if the `Iops` parameter is specified, otherwise `gp2`
2698
+ # Default: `io1` if the `Iops` parameter is specified, otherwise
2699
+ # `standard`
2711
2700
  # @option options [String] :tde_credential_arn
2712
2701
  # The ARN from the key store with which to associate the instance for
2713
2702
  # TDE encryption.
@@ -2725,9 +2714,8 @@ module Aws::RDS
2725
2714
  # Specify the name of the IAM role to be used when making API calls to
2726
2715
  # the Directory Service.
2727
2716
  # @option options [Boolean] :enable_iam_database_authentication
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
+ # True to enable mapping of AWS Identity and Access Management (IAM)
2718
+ # accounts to database accounts, and otherwise false.
2731
2719
  #
2732
2720
  # You can enable IAM database authentication for the following database
2733
2721
  # engines
@@ -2735,6 +2723,8 @@ module Aws::RDS
2735
2723
  # * For MySQL 5.6, minor version 5.6.34 or higher
2736
2724
  #
2737
2725
  # * For MySQL 5.7, minor version 5.7.16 or higher
2726
+ #
2727
+ # Default: `false`
2738
2728
  # @option options [Array<String>] :enable_cloudwatch_logs_exports
2739
2729
  # The list of logs that the restored DB instance is to export to
2740
2730
  # CloudWatch Logs. The values in the list depend on the DB engine being
@@ -2748,8 +2738,8 @@ module Aws::RDS
2748
2738
  # The number of CPU cores and the number of threads per core for the DB
2749
2739
  # instance class of the DB instance.
2750
2740
  # @option options [Boolean] :use_default_processor_features
2751
- # A value that indicates whether the DB instance class of the DB
2752
- # instance uses its default processor features.
2741
+ # A value that specifies that the DB instance class of the DB instance
2742
+ # uses its default processor features.
2753
2743
  # @option options [String] :db_parameter_group_name
2754
2744
  # The name of the DB parameter group to associate with this DB instance.
2755
2745
  # If this argument is omitted, the default DBParameterGroup for the
@@ -2765,10 +2755,10 @@ module Aws::RDS
2765
2755
  #
2766
2756
  # * Can't end with a hyphen or contain two consecutive hyphens.
2767
2757
  # @option options [Boolean] :deletion_protection
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].
2758
+ # Indicates if the DB instance should have deletion protection enabled.
2759
+ # The database can't be deleted when this value is set to true. The
2760
+ # default is false. For more information, see [ Deleting a DB
2761
+ # Instance][1].
2772
2762
  #
2773
2763
  #
2774
2764
  #
@@ -3133,9 +3123,9 @@ module Aws::RDS
3133
3123
  # If you don't specify a `SnapshotType` value, then both automated and
3134
3124
  # manual snapshots are returned. Shared and public DB snapshots are not
3135
3125
  # included in the returned results by default. You can include shared
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.
3126
+ # snapshots with these results by setting the `IncludeShared` parameter
3127
+ # to `true`. You can include public snapshots with these results by
3128
+ # setting the `IncludePublic` parameter to `true`.
3139
3129
  #
3140
3130
  # The `IncludeShared` and `IncludePublic` parameters don't apply for
3141
3131
  # `SnapshotType` values of `manual` or `automated`. The `IncludePublic`
@@ -3149,21 +3139,20 @@ module Aws::RDS
3149
3139
  # @option options [Array<Types::Filter>] :filters
3150
3140
  # This parameter is not currently supported.
3151
3141
  # @option options [Boolean] :include_shared
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.
3142
+ # True to include shared manual DB snapshots from other AWS accounts
3143
+ # that this AWS account has been given permission to copy or restore,
3144
+ # and otherwise false. The default is `false`.
3156
3145
  #
3157
3146
  # You can give an AWS account permission to restore a manual DB snapshot
3158
3147
  # from another AWS account by using the `ModifyDBSnapshotAttribute` API
3159
3148
  # action.
3160
3149
  # @option options [Boolean] :include_public
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.
3150
+ # True to include manual DB snapshots that are public and can be copied
3151
+ # or restored by any AWS account, and otherwise false. The default is
3152
+ # false.
3164
3153
  #
3165
3154
  # You can share a manual DB snapshot as public by using the
3166
- # ModifyDBSnapshotAttribute API.
3155
+ # `ModifyDBSnapshotAttribute` API.
3167
3156
  # @option options [String] :dbi_resource_id
3168
3157
  # A specific DB resource ID to describe.
3169
3158
  # @return [DBSnapshot::Collection]