aws-sdk-rds 1.55.0 → 1.56.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 +419 -394
- data/lib/aws-sdk-rds/db_cluster.rb +79 -78
- data/lib/aws-sdk-rds/db_cluster_parameter_group.rb +5 -5
- data/lib/aws-sdk-rds/db_cluster_snapshot.rb +12 -11
- data/lib/aws-sdk-rds/db_engine.rb +13 -6
- data/lib/aws-sdk-rds/db_instance.rb +211 -200
- data/lib/aws-sdk-rds/db_parameter_group.rb +3 -4
- data/lib/aws-sdk-rds/db_snapshot.rb +29 -28
- data/lib/aws-sdk-rds/event_subscription.rb +4 -3
- data/lib/aws-sdk-rds/option_group.rb +3 -3
- data/lib/aws-sdk-rds/resource.rb +88 -78
- data/lib/aws-sdk-rds/types.rb +526 -414
- metadata +2 -2
@@ -231,7 +231,7 @@ module Aws::RDS
|
|
231
231
|
data[:storage_encrypted]
|
232
232
|
end
|
233
233
|
|
234
|
-
# If `StorageEncrypted` is
|
234
|
+
# If `StorageEncrypted` is enabled, the AWS KMS key identifier for the
|
235
235
|
# encrypted DB cluster.
|
236
236
|
# @return [String]
|
237
237
|
def kms_key_id
|
@@ -261,8 +261,8 @@ module Aws::RDS
|
|
261
261
|
data[:associated_roles]
|
262
262
|
end
|
263
263
|
|
264
|
-
#
|
265
|
-
# to database accounts is enabled
|
264
|
+
# A value that indicates whether the mapping of AWS Identity and Access
|
265
|
+
# Management (IAM) accounts to database accounts is enabled.
|
266
266
|
# @return [Boolean]
|
267
267
|
def iam_database_authentication_enabled
|
268
268
|
data[:iam_database_authentication_enabled]
|
@@ -352,7 +352,7 @@ module Aws::RDS
|
|
352
352
|
end
|
353
353
|
|
354
354
|
# Indicates if the DB cluster has deletion protection enabled. The
|
355
|
-
# database can't be deleted when
|
355
|
+
# database can't be deleted when deletion protection is enabled.
|
356
356
|
# @return [Boolean]
|
357
357
|
def deletion_protection
|
358
358
|
data[:deletion_protection]
|
@@ -363,8 +363,8 @@ module Aws::RDS
|
|
363
363
|
#
|
364
364
|
# </note>
|
365
365
|
#
|
366
|
-
#
|
367
|
-
# cluster is enabled
|
366
|
+
# A value that indicates whether the HTTP endpoint for an Aurora
|
367
|
+
# Serverless DB cluster is enabled.
|
368
368
|
#
|
369
369
|
# When enabled, the HTTP endpoint provides a connectionless web service
|
370
370
|
# API for running SQL queries on the Aurora Serverless DB cluster. You
|
@@ -702,7 +702,7 @@ module Aws::RDS
|
|
702
702
|
# @option options [Array<Types::Tag>] :tags
|
703
703
|
# Tags to assign to the DB cluster.
|
704
704
|
# @option options [Boolean] :storage_encrypted
|
705
|
-
#
|
705
|
+
# A value that indicates whether the DB cluster is encrypted.
|
706
706
|
# @option options [String] :kms_key_id
|
707
707
|
# The AWS KMS key identifier for an encrypted DB cluster.
|
708
708
|
#
|
@@ -718,7 +718,7 @@ module Aws::RDS
|
|
718
718
|
# then Amazon RDS will use the encryption key used to encrypt the
|
719
719
|
# source. Otherwise, Amazon RDS will use your default encryption key.
|
720
720
|
#
|
721
|
-
# * If the `StorageEncrypted` parameter is
|
721
|
+
# * If the `StorageEncrypted` parameter is enabled and
|
722
722
|
# `ReplicationSourceIdentifier` is not specified, then Amazon RDS will
|
723
723
|
# use your default encryption key.
|
724
724
|
#
|
@@ -770,10 +770,9 @@ module Aws::RDS
|
|
770
770
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/API/sigv4-query-string-auth.html
|
771
771
|
# [2]: https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html
|
772
772
|
# @option options [Boolean] :enable_iam_database_authentication
|
773
|
-
#
|
774
|
-
# accounts to database accounts
|
775
|
-
#
|
776
|
-
# Default: `false`
|
773
|
+
# A value that indicates whether to enable mapping of AWS Identity and
|
774
|
+
# Access Management (IAM) accounts to database accounts. By default,
|
775
|
+
# mapping is disabled.
|
777
776
|
# @option options [Integer] :backtrack_window
|
778
777
|
# The target backtrack window, in seconds. To disable backtracking, set
|
779
778
|
# this value to 0.
|
@@ -802,15 +801,15 @@ module Aws::RDS
|
|
802
801
|
# For DB clusters in `serverless` DB engine mode, the scaling properties
|
803
802
|
# of the DB cluster.
|
804
803
|
# @option options [Boolean] :deletion_protection
|
805
|
-
#
|
806
|
-
# enabled. The database can't be deleted when
|
807
|
-
#
|
804
|
+
# A value that indicates whether the DB cluster has deletion protection
|
805
|
+
# enabled. The database can't be deleted when deletion protection is
|
806
|
+
# enabled. By default, deletion protection is disabled.
|
808
807
|
# @option options [String] :global_cluster_identifier
|
809
808
|
# The global cluster ID of an Aurora cluster that becomes the primary
|
810
809
|
# cluster in the new global database cluster.
|
811
810
|
# @option options [Boolean] :copy_tags_to_snapshot
|
812
|
-
#
|
813
|
-
#
|
811
|
+
# A value that indicates whether to copy all tags from the DB cluster to
|
812
|
+
# snapshots of the DB cluster. The default is not to copy them.
|
814
813
|
# @option options [String] :destination_region
|
815
814
|
# @option options [String] :source_region
|
816
815
|
# The source region of the snapshot. This is only needed when the
|
@@ -873,23 +872,24 @@ module Aws::RDS
|
|
873
872
|
# })
|
874
873
|
# @param [Hash] options ({})
|
875
874
|
# @option options [Boolean] :skip_final_snapshot
|
876
|
-
#
|
877
|
-
# DB cluster is deleted. If
|
878
|
-
#
|
879
|
-
# before the DB cluster is
|
875
|
+
# A value that indicates whether to skip the creation of a final DB
|
876
|
+
# cluster snapshot before the DB cluster is deleted. If skip is
|
877
|
+
# specified, no DB cluster snapshot is created. If skip is not
|
878
|
+
# specified, a DB cluster snapshot is created before the DB cluster is
|
879
|
+
# deleted. By default, skip is not specified, and the DB cluster
|
880
|
+
# snapshot is created. By default, this parameter is disabled.
|
880
881
|
#
|
881
882
|
# <note markdown="1"> You must specify a `FinalDBSnapshotIdentifier` parameter if
|
882
|
-
# `SkipFinalSnapshot` is
|
883
|
+
# `SkipFinalSnapshot` is disabled.
|
883
884
|
#
|
884
885
|
# </note>
|
885
|
-
#
|
886
|
-
# Default: `false`
|
887
886
|
# @option options [String] :final_db_snapshot_identifier
|
888
887
|
# The DB cluster snapshot identifier of the new DB cluster snapshot
|
889
|
-
# created when `SkipFinalSnapshot` is
|
888
|
+
# created when `SkipFinalSnapshot` is disabled.
|
890
889
|
#
|
891
|
-
# <note markdown="1"> Specifying this parameter and also
|
892
|
-
#
|
890
|
+
# <note markdown="1"> Specifying this parameter and also skipping the creation of a final DB
|
891
|
+
# cluster snapshot with the `SkipFinalShapshot` parameter results in an
|
892
|
+
# error.
|
893
893
|
#
|
894
894
|
# </note>
|
895
895
|
#
|
@@ -979,22 +979,22 @@ module Aws::RDS
|
|
979
979
|
#
|
980
980
|
# Example: `my-cluster2`
|
981
981
|
# @option options [Boolean] :apply_immediately
|
982
|
-
# A value that
|
982
|
+
# A value that indicates whether the modifications in this request and
|
983
983
|
# any pending modifications are asynchronously applied as soon as
|
984
984
|
# possible, regardless of the `PreferredMaintenanceWindow` setting for
|
985
|
-
# the DB cluster. If this parameter is
|
985
|
+
# the DB cluster. If this parameter is disabled, changes to the DB
|
986
986
|
# cluster are applied during the next maintenance window.
|
987
987
|
#
|
988
988
|
# The `ApplyImmediately` parameter only affects the
|
989
989
|
# `EnableIAMDatabaseAuthentication`, `MasterUserPassword`, and
|
990
|
-
# `NewDBClusterIdentifier` values. If
|
991
|
-
#
|
992
|
-
# `
|
993
|
-
#
|
994
|
-
#
|
995
|
-
#
|
990
|
+
# `NewDBClusterIdentifier` values. If the `ApplyImmediately` parameter
|
991
|
+
# is disabled, then changes to the `EnableIAMDatabaseAuthentication`,
|
992
|
+
# `MasterUserPassword`, and `NewDBClusterIdentifier` values are applied
|
993
|
+
# during the next maintenance window. All other changes are applied
|
994
|
+
# immediately, regardless of the value of the `ApplyImmediately`
|
995
|
+
# parameter.
|
996
996
|
#
|
997
|
-
#
|
997
|
+
# By default, this parameter is disabled.
|
998
998
|
# @option options [Integer] :backup_retention_period
|
999
999
|
# The number of days for which automated backups are retained. You must
|
1000
1000
|
# specify a minimum value of 1.
|
@@ -1025,11 +1025,11 @@ module Aws::RDS
|
|
1025
1025
|
# A value that indicates that the DB cluster should be associated with
|
1026
1026
|
# the specified option group. Changing this parameter doesn't result in
|
1027
1027
|
# an outage except in the following case, and the change is applied
|
1028
|
-
# during the next maintenance window unless the `ApplyImmediately`
|
1029
|
-
#
|
1030
|
-
#
|
1031
|
-
#
|
1032
|
-
#
|
1028
|
+
# during the next maintenance window unless the `ApplyImmediately` is
|
1029
|
+
# enabled for this request. If the parameter change results in an option
|
1030
|
+
# group that enables OEM, this change can cause a brief (sub-second)
|
1031
|
+
# period during which new connections are rejected but existing
|
1032
|
+
# connections are not interrupted.
|
1033
1033
|
#
|
1034
1034
|
# Permanent options can't be removed from an option group. The option
|
1035
1035
|
# group can't be removed from a DB cluster once it is associated with a
|
@@ -1076,10 +1076,9 @@ module Aws::RDS
|
|
1076
1076
|
#
|
1077
1077
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_UpgradeDBInstance.Maintenance.html#AdjustingTheMaintenanceWindow.Aurora
|
1078
1078
|
# @option options [Boolean] :enable_iam_database_authentication
|
1079
|
-
#
|
1080
|
-
# accounts to database accounts
|
1081
|
-
#
|
1082
|
-
# Default: `false`
|
1079
|
+
# A value that indicates whether to enable mapping of AWS Identity and
|
1080
|
+
# Access Management (IAM) accounts to database accounts. By default,
|
1081
|
+
# mapping is disabled.
|
1083
1082
|
# @option options [Integer] :backtrack_window
|
1084
1083
|
# The target backtrack window, in seconds. To disable backtracking, set
|
1085
1084
|
# this value to 0.
|
@@ -1098,17 +1097,17 @@ module Aws::RDS
|
|
1098
1097
|
# @option options [String] :engine_version
|
1099
1098
|
# The version number of the database engine to which you want to
|
1100
1099
|
# upgrade. Changing this parameter results in an outage. The change is
|
1101
|
-
# applied during the next maintenance window unless
|
1102
|
-
#
|
1100
|
+
# applied during the next maintenance window unless `ApplyImmediately`
|
1101
|
+
# is enabled.
|
1103
1102
|
#
|
1104
|
-
# For a list of valid engine versions, use
|
1105
|
-
# `DescribeDBEngineVersions` action.
|
1103
|
+
# For a list of valid engine versions, use DescribeDBEngineVersions.
|
1106
1104
|
# @option options [Types::ScalingConfiguration] :scaling_configuration
|
1107
1105
|
# The scaling properties of the DB cluster. You can only modify scaling
|
1108
1106
|
# properties for DB clusters in `serverless` DB engine mode.
|
1109
1107
|
# @option options [Boolean] :deletion_protection
|
1110
|
-
#
|
1111
|
-
# database can't be deleted when
|
1108
|
+
# A value that indicates whether the DB cluster has deletion protection
|
1109
|
+
# enabled. The database can't be deleted when deletion protection is
|
1110
|
+
# enabled. By default, deletion protection is disabled.
|
1112
1111
|
# @option options [Boolean] :enable_http_endpoint
|
1113
1112
|
# <note markdown="1"> HTTP endpoint functionality is in beta for Aurora Serverless and is
|
1114
1113
|
# subject to change.
|
@@ -1131,8 +1130,8 @@ module Aws::RDS
|
|
1131
1130
|
#
|
1132
1131
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless.html
|
1133
1132
|
# @option options [Boolean] :copy_tags_to_snapshot
|
1134
|
-
#
|
1135
|
-
#
|
1133
|
+
# A value that indicates whether to copy all tags from the DB cluster to
|
1134
|
+
# snapshots of the DB cluster. The default is not to copy them.
|
1136
1135
|
# @return [DBCluster]
|
1137
1136
|
def modify(options = {})
|
1138
1137
|
options = options.merge(db_cluster_identifier: @id)
|
@@ -1208,16 +1207,17 @@ module Aws::RDS
|
|
1208
1207
|
# * Must be specified if `UseLatestRestorableTime` parameter is not
|
1209
1208
|
# provided
|
1210
1209
|
#
|
1211
|
-
# * Can't be specified if `UseLatestRestorableTime` parameter is
|
1210
|
+
# * Can't be specified if the `UseLatestRestorableTime` parameter is
|
1211
|
+
# enabled
|
1212
1212
|
#
|
1213
|
-
# * Can't be specified if `RestoreType` parameter is
|
1213
|
+
# * Can't be specified if the `RestoreType` parameter is
|
1214
|
+
# `copy-on-write`
|
1214
1215
|
#
|
1215
1216
|
# Example: `2015-03-07T23:45:00Z`
|
1216
1217
|
# @option options [Boolean] :use_latest_restorable_time
|
1217
|
-
# A value that
|
1218
|
-
# restorable backup time,
|
1219
|
-
#
|
1220
|
-
# Default: `false`
|
1218
|
+
# A value that indicates whether to restore the DB cluster to the latest
|
1219
|
+
# restorable backup time. By default, the DB cluster is not restored to
|
1220
|
+
# the latest restorable backup time.
|
1221
1221
|
#
|
1222
1222
|
# Constraints: Can't be specified if `RestoreToTime` parameter is
|
1223
1223
|
# provided.
|
@@ -1273,10 +1273,9 @@ module Aws::RDS
|
|
1273
1273
|
# If `DBClusterIdentifier` refers to a DB cluster that is not encrypted,
|
1274
1274
|
# then the restore request is rejected.
|
1275
1275
|
# @option options [Boolean] :enable_iam_database_authentication
|
1276
|
-
#
|
1277
|
-
# accounts to database accounts
|
1278
|
-
#
|
1279
|
-
# Default: `false`
|
1276
|
+
# A value that indicates whether to enable mapping of AWS Identity and
|
1277
|
+
# Access Management (IAM) accounts to database accounts. By default,
|
1278
|
+
# mapping is disabled.
|
1280
1279
|
# @option options [Integer] :backtrack_window
|
1281
1280
|
# The target backtrack window, in seconds. To disable backtracking, set
|
1282
1281
|
# this value to 0.
|
@@ -1314,12 +1313,13 @@ module Aws::RDS
|
|
1314
1313
|
#
|
1315
1314
|
# * Can't end with a hyphen or contain two consecutive hyphens.
|
1316
1315
|
# @option options [Boolean] :deletion_protection
|
1317
|
-
#
|
1318
|
-
# The database can't be deleted when
|
1319
|
-
# default is
|
1316
|
+
# A value that indicates whether the DB cluster has deletion protection
|
1317
|
+
# enabled. The database can't be deleted when deletion protection is
|
1318
|
+
# enabled. By default, deletion protection is disabled.
|
1320
1319
|
# @option options [Boolean] :copy_tags_to_snapshot
|
1321
|
-
#
|
1322
|
-
# restored DB cluster
|
1320
|
+
# A value that indicates whether to copy all tags from the restored DB
|
1321
|
+
# cluster to snapshots of the restored DB cluster. The default is not to
|
1322
|
+
# copy them.
|
1323
1323
|
# @return [DBCluster]
|
1324
1324
|
def restore(options = {})
|
1325
1325
|
options = options.merge(source_db_cluster_identifier: @id)
|
@@ -1486,9 +1486,9 @@ module Aws::RDS
|
|
1486
1486
|
#
|
1487
1487
|
# If you don't specify a `SnapshotType` value, then both automated and
|
1488
1488
|
# manual DB cluster snapshots are returned. You can include shared DB
|
1489
|
-
# cluster snapshots with these results by
|
1490
|
-
# parameter
|
1491
|
-
#
|
1489
|
+
# cluster snapshots with these results by enabling the `IncludeShared`
|
1490
|
+
# parameter. You can include public DB cluster snapshots with these
|
1491
|
+
# results by enabling the `IncludePublic` parameter.
|
1492
1492
|
#
|
1493
1493
|
# The `IncludeShared` and `IncludePublic` parameters don't apply for
|
1494
1494
|
# `SnapshotType` values of `manual` or `automated`. The `IncludePublic`
|
@@ -1512,20 +1512,21 @@ module Aws::RDS
|
|
1512
1512
|
# the response includes only records beyond the marker, up to the value
|
1513
1513
|
# specified by `MaxRecords`.
|
1514
1514
|
# @option options [Boolean] :include_shared
|
1515
|
-
#
|
1516
|
-
# accounts that this AWS account has been given
|
1517
|
-
#
|
1515
|
+
# A value that indicates whether to include shared manual DB cluster
|
1516
|
+
# snapshots from other AWS accounts that this AWS account has been given
|
1517
|
+
# permission to copy or restore. By default, these snapshots are not
|
1518
|
+
# included.
|
1518
1519
|
#
|
1519
1520
|
# You can give an AWS account permission to restore a manual DB cluster
|
1520
1521
|
# snapshot from another AWS account by the
|
1521
1522
|
# `ModifyDBClusterSnapshotAttribute` API action.
|
1522
1523
|
# @option options [Boolean] :include_public
|
1523
|
-
#
|
1524
|
-
# copied or restored by any AWS account
|
1525
|
-
# default
|
1524
|
+
# A value that indicates whether to include manual DB cluster snapshots
|
1525
|
+
# that are public and can be copied or restored by any AWS account. By
|
1526
|
+
# default, the public snapshots are not included.
|
1526
1527
|
#
|
1527
1528
|
# You can share a manual DB cluster snapshot as public by using the
|
1528
|
-
#
|
1529
|
+
# ModifyDBClusterSnapshotAttribute API action.
|
1529
1530
|
# @return [DBClusterSnapshot::Collection]
|
1530
1531
|
def snapshots(options = {})
|
1531
1532
|
batches = Enumerator.new do |y|
|
@@ -290,14 +290,14 @@ module Aws::RDS
|
|
290
290
|
# })
|
291
291
|
# @param [Hash] options ({})
|
292
292
|
# @option options [Boolean] :reset_all_parameters
|
293
|
-
# A value that
|
294
|
-
# cluster parameter group to their default values
|
295
|
-
#
|
296
|
-
#
|
293
|
+
# A value that indicates whether to reset all parameters in the DB
|
294
|
+
# cluster parameter group to their default values. You can't use this
|
295
|
+
# parameter if there is a list of parameter names specified for the
|
296
|
+
# `Parameters` parameter.
|
297
297
|
# @option options [Array<Types::Parameter>] :parameters
|
298
298
|
# A list of parameter names in the DB cluster parameter group to reset
|
299
299
|
# to the default values. You can't use this parameter if the
|
300
|
-
# `ResetAllParameters` parameter is
|
300
|
+
# `ResetAllParameters` parameter is enabled.
|
301
301
|
# @return [DBClusterParameterGroup]
|
302
302
|
def reset(options = {})
|
303
303
|
options = options.merge(db_cluster_parameter_group_name: @name)
|
@@ -410,8 +410,9 @@ module Aws::RDS
|
|
410
410
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/API/sigv4-query-string-auth.html
|
411
411
|
# [2]: https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html
|
412
412
|
# @option options [Boolean] :copy_tags
|
413
|
-
#
|
414
|
-
# target DB cluster snapshot
|
413
|
+
# A value that indicates whether to copy all tags from the source DB
|
414
|
+
# cluster snapshot to the target DB cluster snapshot. By default, tags
|
415
|
+
# are not copied.
|
415
416
|
# @option options [Array<Types::Tag>] :tags
|
416
417
|
# A list of tags. For more information, see [Tagging Amazon RDS
|
417
418
|
# Resources][1] in the *Amazon RDS User Guide.*
|
@@ -551,10 +552,9 @@ module Aws::RDS
|
|
551
552
|
# * If the DB snapshot or DB cluster snapshot in `SnapshotIdentifier` is
|
552
553
|
# not encrypted, then the restored DB cluster is not encrypted.
|
553
554
|
# @option options [Boolean] :enable_iam_database_authentication
|
554
|
-
#
|
555
|
-
# accounts to database accounts
|
556
|
-
#
|
557
|
-
# Default: `false`
|
555
|
+
# A value that indicates whether to enable mapping of AWS Identity and
|
556
|
+
# Access Management (IAM) accounts to database accounts. By default,
|
557
|
+
# mapping is disabled.
|
558
558
|
# @option options [Integer] :backtrack_window
|
559
559
|
# The target backtrack window, in seconds. To disable backtracking, set
|
560
560
|
# this value to 0.
|
@@ -598,12 +598,13 @@ module Aws::RDS
|
|
598
598
|
#
|
599
599
|
# * Can't end with a hyphen or contain two consecutive hyphens.
|
600
600
|
# @option options [Boolean] :deletion_protection
|
601
|
-
#
|
602
|
-
# The database can't be deleted when
|
603
|
-
# default is
|
601
|
+
# A value that indicates whether the DB cluster has deletion protection
|
602
|
+
# enabled. The database can't be deleted when deletion protection is
|
603
|
+
# enabled. By default, deletion protection is disabled.
|
604
604
|
# @option options [Boolean] :copy_tags_to_snapshot
|
605
|
-
#
|
606
|
-
# restored DB cluster
|
605
|
+
# A value that indicates whether to copy all tags from the restored DB
|
606
|
+
# cluster to snapshots of the restored DB cluster. The default is not to
|
607
|
+
# copy them.
|
607
608
|
# @return [DBCluster]
|
608
609
|
def restore(options = {})
|
609
610
|
options = options.merge(snapshot_identifier: @snapshot_id)
|
@@ -277,19 +277,26 @@ module Aws::RDS
|
|
277
277
|
# @option options [Array<Types::Filter>] :filters
|
278
278
|
# This parameter is not currently supported.
|
279
279
|
# @option options [Boolean] :default_only
|
280
|
-
#
|
281
|
-
# engine and major version combination is returned.
|
280
|
+
# A value that indicates whether only the default version of the
|
281
|
+
# specified engine or engine and major version combination is returned.
|
282
282
|
# @option options [Boolean] :list_supported_character_sets
|
283
|
-
#
|
283
|
+
# A value that indicates whether to list the supported character sets
|
284
|
+
# for each engine version.
|
285
|
+
#
|
286
|
+
# If this parameter is enabled and the requested engine supports the
|
284
287
|
# `CharacterSetName` parameter for `CreateDBInstance`, the response
|
285
288
|
# includes a list of supported character sets for each engine version.
|
286
289
|
# @option options [Boolean] :list_supported_timezones
|
287
|
-
#
|
290
|
+
# A value that indicates whether to list the supported time zones for
|
291
|
+
# each engine version.
|
292
|
+
#
|
293
|
+
# If this parameter is enabled and the requested engine supports the
|
288
294
|
# `TimeZone` parameter for `CreateDBInstance`, the response includes a
|
289
295
|
# list of supported time zones for each engine version.
|
290
296
|
# @option options [Boolean] :include_all
|
291
|
-
#
|
292
|
-
# default is to list only available engine
|
297
|
+
# A value that indicates whether to include engine versions that aren't
|
298
|
+
# available in the list. The default is to list only available engine
|
299
|
+
# versions.
|
293
300
|
# @return [DBEngineVersion::Collection]
|
294
301
|
def versions(options = {})
|
295
302
|
batches = Enumerator.new do |y|
|
@@ -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
|
#
|
@@ -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
|
-
#
|
756
|
+
# 65536.
|
757
757
|
#
|
758
758
|
# * Provisioned IOPS storage (io1): Must be an integer from 100 to
|
759
|
-
#
|
759
|
+
# 65536.
|
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
|
-
#
|
769
|
+
# 65536.
|
770
770
|
#
|
771
771
|
# * Provisioned IOPS storage (io1): Must be an integer from 100 to
|
772
|
-
#
|
772
|
+
# 65536.
|
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
|
-
#
|
782
|
+
# 65536.
|
783
783
|
#
|
784
784
|
# * Provisioned IOPS storage (io1): Must be an integer from 100 to
|
785
|
-
#
|
785
|
+
# 65536.
|
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
|
-
#
|
795
|
+
# 65536.
|
796
796
|
#
|
797
797
|
# * Provisioned IOPS storage (io1): Must be an integer from 100 to
|
798
|
-
#
|
798
|
+
# 65536.
|
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
|
-
#
|
991
|
-
# 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.
|
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
|
1126
|
-
# deployment. You can't set the AvailabilityZone parameter if the
|
1127
|
-
#
|
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.
|
1128
1128
|
# @option options [String] :engine_version
|
1129
1129
|
# The version number of the database engine to use.
|
1130
1130
|
#
|
@@ -1172,10 +1172,9 @@ 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
|
-
#
|
1176
|
-
# DB instance during the maintenance window.
|
1177
|
-
#
|
1178
|
-
# 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.
|
1179
1178
|
# @option options [String] :license_model
|
1180
1179
|
# License model information for this DB instance.
|
1181
1180
|
#
|
@@ -1210,11 +1209,12 @@ module Aws::RDS
|
|
1210
1209
|
# Not applicable. The character set is managed by the DB cluster. For
|
1211
1210
|
# more information, see `CreateDBCluster`.
|
1212
1211
|
# @option options [Boolean] :publicly_accessible
|
1213
|
-
#
|
1214
|
-
#
|
1215
|
-
# DNS name, which resolves to a
|
1216
|
-
#
|
1217
|
-
# 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.
|
1218
1218
|
#
|
1219
1219
|
# Default: The default behavior varies depending on whether
|
1220
1220
|
# `DBSubnetGroupName` is specified.
|
@@ -1248,8 +1248,7 @@ 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
|
1252
|
-
# `standard`
|
1251
|
+
# Default: `io1` if the `Iops` parameter is specified, otherwise `gp2`
|
1253
1252
|
# @option options [String] :tde_credential_arn
|
1254
1253
|
# The ARN from the key store with which to associate the instance for
|
1255
1254
|
# TDE encryption.
|
@@ -1257,14 +1256,13 @@ module Aws::RDS
|
|
1257
1256
|
# The password for the given ARN from the key store in order to access
|
1258
1257
|
# the device.
|
1259
1258
|
# @option options [Boolean] :storage_encrypted
|
1260
|
-
#
|
1259
|
+
# A value that indicates whether the DB instance is encrypted. By
|
1260
|
+
# default, it is not 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
|
1268
1266
|
# @option options [String] :kms_key_id
|
1269
1267
|
# The AWS KMS key identifier for an encrypted DB instance.
|
1270
1268
|
#
|
@@ -1279,11 +1277,11 @@ module Aws::RDS
|
|
1279
1277
|
# Not applicable. The KMS key identifier is managed by the DB cluster.
|
1280
1278
|
# For more information, see `CreateDBCluster`.
|
1281
1279
|
#
|
1282
|
-
# If
|
1283
|
-
#
|
1284
|
-
#
|
1285
|
-
#
|
1286
|
-
#
|
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.
|
1287
1285
|
# @option options [String] :domain
|
1288
1286
|
# For an Amazon RDS DB instance that's running Microsoft SQL Server,
|
1289
1287
|
# this parameter specifies the Active Directory directory ID to create
|
@@ -1297,8 +1295,8 @@ module Aws::RDS
|
|
1297
1295
|
#
|
1298
1296
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/DeveloperGuide/USER_SQLServerWinAuth.html
|
1299
1297
|
# @option options [Boolean] :copy_tags_to_snapshot
|
1300
|
-
#
|
1301
|
-
#
|
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.
|
1302
1300
|
#
|
1303
1301
|
# **Amazon Aurora**
|
1304
1302
|
#
|
@@ -1351,8 +1349,9 @@ module Aws::RDS
|
|
1351
1349
|
#
|
1352
1350
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_SQLServer.html#SQLServer.Concepts.General.TimeZone
|
1353
1351
|
# @option options [Boolean] :enable_iam_database_authentication
|
1354
|
-
#
|
1355
|
-
# 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.
|
1356
1355
|
#
|
1357
1356
|
# You can enable IAM database authentication for the following database
|
1358
1357
|
# engines:
|
@@ -1367,11 +1366,9 @@ module Aws::RDS
|
|
1367
1366
|
# * For MySQL 5.6, minor version 5.6.34 or higher
|
1368
1367
|
#
|
1369
1368
|
# * For MySQL 5.7, minor version 5.7.16 or higher
|
1370
|
-
#
|
1371
|
-
# Default: `false`
|
1372
1369
|
# @option options [Boolean] :enable_performance_insights
|
1373
|
-
#
|
1374
|
-
#
|
1370
|
+
# A value that indicates whether to enable Performance Insights for the
|
1371
|
+
# DB instance.
|
1375
1372
|
#
|
1376
1373
|
# For more information, see [Using Amazon Performance Insights][1] in
|
1377
1374
|
# the *Amazon Relational Database Service User Guide*.
|
@@ -1383,6 +1380,11 @@ module Aws::RDS
|
|
1383
1380
|
# The AWS KMS key identifier for encryption of Performance Insights
|
1384
1381
|
# data. The KMS key ID is the Amazon Resource Name (ARN), KMS key
|
1385
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.
|
1386
1388
|
# @option options [Integer] :performance_insights_retention_period
|
1387
1389
|
# The amount of time, in days, to retain Performance Insights data.
|
1388
1390
|
# Valid values are 7 or 731 (2 years).
|
@@ -1400,10 +1402,10 @@ module Aws::RDS
|
|
1400
1402
|
# The number of CPU cores and the number of threads per core for the DB
|
1401
1403
|
# instance class of the DB instance.
|
1402
1404
|
# @option options [Boolean] :deletion_protection
|
1403
|
-
#
|
1404
|
-
# The database can't be deleted when
|
1405
|
-
# default is
|
1406
|
-
# 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].
|
1407
1409
|
#
|
1408
1410
|
#
|
1409
1411
|
#
|
@@ -1491,7 +1493,8 @@ module Aws::RDS
|
|
1491
1493
|
#
|
1492
1494
|
# Valid Values: `1150-65535`
|
1493
1495
|
# @option options [Boolean] :multi_az
|
1494
|
-
#
|
1496
|
+
# A value that indicates whether the Read Replica is in a Multi-AZ
|
1497
|
+
# deployment.
|
1495
1498
|
#
|
1496
1499
|
# You can create a Read Replica as a Multi-AZ DB instance. RDS creates a
|
1497
1500
|
# standby of your replica in another Availability Zone for failover
|
@@ -1499,8 +1502,8 @@ module Aws::RDS
|
|
1499
1502
|
# instance is independent of whether the source database is a Multi-AZ
|
1500
1503
|
# DB instance.
|
1501
1504
|
# @option options [Boolean] :auto_minor_version_upgrade
|
1502
|
-
#
|
1503
|
-
# 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.
|
1504
1507
|
#
|
1505
1508
|
# Default: Inherits from the source DB instance
|
1506
1509
|
# @option options [Integer] :iops
|
@@ -1510,11 +1513,12 @@ module Aws::RDS
|
|
1510
1513
|
# The option group the DB instance is associated with. If omitted, the
|
1511
1514
|
# option group associated with the source instance is used.
|
1512
1515
|
# @option options [Boolean] :publicly_accessible
|
1513
|
-
#
|
1514
|
-
#
|
1515
|
-
# DNS name, which resolves to a
|
1516
|
-
#
|
1517
|
-
#
|
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.
|
1518
1522
|
# @option options [Array<Types::Tag>] :tags
|
1519
1523
|
# A list of tags. For more information, see [Tagging Amazon RDS
|
1520
1524
|
# Resources][1] in the *Amazon RDS User Guide.*
|
@@ -1561,11 +1565,10 @@ module Aws::RDS
|
|
1561
1565
|
# If you specify `io1`, you must also include a value for the `Iops`
|
1562
1566
|
# parameter.
|
1563
1567
|
#
|
1564
|
-
# Default: `io1` if the `Iops` parameter is specified, otherwise
|
1565
|
-
# `standard`
|
1568
|
+
# Default: `io1` if the `Iops` parameter is specified, otherwise `gp2`
|
1566
1569
|
# @option options [Boolean] :copy_tags_to_snapshot
|
1567
|
-
#
|
1568
|
-
#
|
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.
|
1569
1572
|
# @option options [Integer] :monitoring_interval
|
1570
1573
|
# The interval, in seconds, between points when Enhanced Monitoring
|
1571
1574
|
# metrics are collected for the Read Replica. To disable collecting
|
@@ -1658,8 +1661,9 @@ module Aws::RDS
|
|
1658
1661
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/API/sigv4-query-string-auth.html
|
1659
1662
|
# [2]: https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html
|
1660
1663
|
# @option options [Boolean] :enable_iam_database_authentication
|
1661
|
-
#
|
1662
|
-
# 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.
|
1663
1667
|
#
|
1664
1668
|
# You can enable IAM database authentication for the following database
|
1665
1669
|
# engines
|
@@ -1669,11 +1673,9 @@ module Aws::RDS
|
|
1669
1673
|
# * For MySQL 5.7, minor version 5.7.16 or higher
|
1670
1674
|
#
|
1671
1675
|
# * Aurora MySQL 5.6 or higher
|
1672
|
-
#
|
1673
|
-
# Default: `false`
|
1674
1676
|
# @option options [Boolean] :enable_performance_insights
|
1675
|
-
#
|
1676
|
-
#
|
1677
|
+
# A value that indicates whether to enable Performance Insights for the
|
1678
|
+
# Read Replica.
|
1677
1679
|
#
|
1678
1680
|
# For more information, see [Using Amazon Performance Insights][1] in
|
1679
1681
|
# the *Amazon RDS User Guide*.
|
@@ -1685,6 +1687,11 @@ module Aws::RDS
|
|
1685
1687
|
# The AWS KMS key identifier for encryption of Performance Insights
|
1686
1688
|
# data. The KMS key ID is the Amazon Resource Name (ARN), KMS key
|
1687
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.
|
1688
1695
|
# @option options [Integer] :performance_insights_retention_period
|
1689
1696
|
# The amount of time, in days, to retain Performance Insights data.
|
1690
1697
|
# Valid values are 7 or 731 (2 years).
|
@@ -1701,13 +1708,13 @@ module Aws::RDS
|
|
1701
1708
|
# The number of CPU cores and the number of threads per core for the DB
|
1702
1709
|
# instance class of the DB instance.
|
1703
1710
|
# @option options [Boolean] :use_default_processor_features
|
1704
|
-
# A value that
|
1705
|
-
# 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.
|
1706
1713
|
# @option options [Boolean] :deletion_protection
|
1707
|
-
#
|
1708
|
-
# The database can't be deleted when
|
1709
|
-
# default is
|
1710
|
-
# 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].
|
1711
1718
|
#
|
1712
1719
|
#
|
1713
1720
|
#
|
@@ -1781,29 +1788,28 @@ module Aws::RDS
|
|
1781
1788
|
# })
|
1782
1789
|
# @param [Hash] options ({})
|
1783
1790
|
# @option options [Boolean] :skip_final_snapshot
|
1784
|
-
# A value that indicates whether
|
1785
|
-
# the DB instance is deleted. If
|
1786
|
-
# created. If
|
1787
|
-
# 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.
|
1788
1796
|
#
|
1789
|
-
#
|
1790
|
-
#
|
1791
|
-
#
|
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.
|
1792
1800
|
#
|
1793
|
-
# Specify
|
1801
|
+
# Specify skip when deleting a Read Replica.
|
1794
1802
|
#
|
1795
|
-
# <note markdown="1"> The
|
1796
|
-
#
|
1803
|
+
# <note markdown="1"> The FinalDBSnapshotIdentifier parameter must be specified if skip is
|
1804
|
+
# not specified.
|
1797
1805
|
#
|
1798
1806
|
# </note>
|
1799
|
-
#
|
1800
|
-
# Default: `false`
|
1801
1807
|
# @option options [String] :final_db_snapshot_identifier
|
1802
|
-
# The `DBSnapshotIdentifier` of the new
|
1803
|
-
# `SkipFinalSnapshot` is
|
1808
|
+
# The `DBSnapshotIdentifier` of the new `DBSnapshot` created when the
|
1809
|
+
# `SkipFinalSnapshot` parameter is disabled.
|
1804
1810
|
#
|
1805
|
-
# <note markdown="1"> Specifying this parameter and also
|
1806
|
-
#
|
1811
|
+
# <note markdown="1"> Specifying this parameter and also specifying to skip final DB
|
1812
|
+
# snapshot creation in SkipFinalShapshot results in an error.
|
1807
1813
|
#
|
1808
1814
|
# </note>
|
1809
1815
|
#
|
@@ -1819,7 +1825,8 @@ module Aws::RDS
|
|
1819
1825
|
# @option options [Boolean] :delete_automated_backups
|
1820
1826
|
# A value that indicates whether to remove automated backups immediately
|
1821
1827
|
# after the DB instance is deleted. This parameter isn't
|
1822
|
-
# case-sensitive.
|
1828
|
+
# case-sensitive. The default is to remove automated backups immediately
|
1829
|
+
# after the DB instance is deleted.
|
1823
1830
|
# @return [DBInstance]
|
1824
1831
|
def delete(options = {})
|
1825
1832
|
options = options.merge(db_instance_identifier: @id)
|
@@ -1903,7 +1910,7 @@ module Aws::RDS
|
|
1903
1910
|
#
|
1904
1911
|
# If you modify the DB instance class, an outage occurs during the
|
1905
1912
|
# change. The change is applied during the next maintenance window,
|
1906
|
-
# unless `ApplyImmediately` is
|
1913
|
+
# unless `ApplyImmediately` is enabled for this request.
|
1907
1914
|
#
|
1908
1915
|
# Default: Uses existing setting
|
1909
1916
|
#
|
@@ -1919,7 +1926,7 @@ module Aws::RDS
|
|
1919
1926
|
#
|
1920
1927
|
# Changing the subnet group causes an outage during the change. The
|
1921
1928
|
# change is applied during the next maintenance window, unless you
|
1922
|
-
#
|
1929
|
+
# enable `ApplyImmediately`.
|
1923
1930
|
#
|
1924
1931
|
# Constraints: If supplied, must match the name of an existing
|
1925
1932
|
# DBSubnetGroup.
|
@@ -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
|
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.
|
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
|
#
|
@@ -2038,7 +2042,7 @@ 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
|
#
|
@@ -2101,15 +2105,15 @@ module Aws::RDS
|
|
2101
2105
|
#
|
2102
2106
|
# Constraints: Must be at least 30 minutes
|
2103
2107
|
# @option options [Boolean] :multi_az
|
2104
|
-
#
|
2105
|
-
# parameter doesn't result in an outage and
|
2106
|
-
# during the next maintenance window unless the
|
2107
|
-
# 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.
|
2108
2112
|
# @option options [String] :engine_version
|
2109
2113
|
# The version number of the database engine to upgrade to. Changing this
|
2110
2114
|
# parameter results in an outage and the change is applied during the
|
2111
|
-
# next maintenance window unless the `ApplyImmediately` parameter is
|
2112
|
-
#
|
2115
|
+
# next maintenance window unless the `ApplyImmediately` parameter is
|
2116
|
+
# eanbled for this request.
|
2113
2117
|
#
|
2114
2118
|
# For major version upgrades, if a nondefault DB parameter group is
|
2115
2119
|
# currently in use, a new DB parameter group in the DB parameter group
|
@@ -2119,21 +2123,21 @@ module Aws::RDS
|
|
2119
2123
|
# For information about valid engine versions, see `CreateDBInstance`,
|
2120
2124
|
# or call `DescribeDBEngineVersions`.
|
2121
2125
|
# @option options [Boolean] :allow_major_version_upgrade
|
2122
|
-
#
|
2123
|
-
# 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
|
2124
2128
|
# asynchronously applied as soon as possible.
|
2125
2129
|
#
|
2126
|
-
# Constraints:
|
2130
|
+
# Constraints: Major version upgrades must be allowed when specifying a
|
2127
2131
|
# value for the EngineVersion parameter that is a different major
|
2128
2132
|
# version than the DB instance's current version.
|
2129
2133
|
# @option options [Boolean] :auto_minor_version_upgrade
|
2130
|
-
#
|
2131
|
-
# DB instance during the maintenance window.
|
2132
|
-
# doesn't result in an outage except in the
|
2133
|
-
# change is asynchronously applied as soon as
|
2134
|
-
#
|
2135
|
-
# window, and a newer minor version is available, and RDS
|
2136
|
-
# 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.
|
2137
2141
|
# @option options [String] :license_model
|
2138
2142
|
# The license model for the DB instance.
|
2139
2143
|
#
|
@@ -2145,10 +2149,10 @@ module Aws::RDS
|
|
2145
2149
|
#
|
2146
2150
|
# Changing this setting doesn't result in an outage and the change is
|
2147
2151
|
# applied during the next maintenance window unless the
|
2148
|
-
# `ApplyImmediately` parameter is
|
2149
|
-
#
|
2150
|
-
#
|
2151
|
-
#
|
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.
|
2152
2156
|
#
|
2153
2157
|
# If you choose to migrate your DB instance from using standard storage
|
2154
2158
|
# to using Provisioned IOPS, or from using Provisioned IOPS to using
|
@@ -2175,11 +2179,11 @@ module Aws::RDS
|
|
2175
2179
|
# Indicates that the DB instance should be associated with the specified
|
2176
2180
|
# option group. Changing this parameter doesn't result in an outage
|
2177
2181
|
# except in the following case and the change is applied during the next
|
2178
|
-
# maintenance window unless the `ApplyImmediately` parameter is
|
2179
|
-
#
|
2180
|
-
#
|
2181
|
-
#
|
2182
|
-
#
|
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.
|
2183
2187
|
#
|
2184
2188
|
# Permanent options, such as the TDE option for Oracle Advanced Security
|
2185
2189
|
# TDE, can't be removed from an option group, and that option group
|
@@ -2188,9 +2192,9 @@ module Aws::RDS
|
|
2188
2192
|
# @option options [String] :new_db_instance_identifier
|
2189
2193
|
# The new DB instance identifier for the DB instance when renaming a DB
|
2190
2194
|
# instance. When you change the DB instance identifier, an instance
|
2191
|
-
# reboot
|
2192
|
-
#
|
2193
|
-
# 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.
|
2194
2198
|
#
|
2195
2199
|
# Constraints:
|
2196
2200
|
#
|
@@ -2224,8 +2228,7 @@ module Aws::RDS
|
|
2224
2228
|
#
|
2225
2229
|
# Valid values: `standard | gp2 | io1`
|
2226
2230
|
#
|
2227
|
-
# Default: `io1` if the `Iops` parameter is specified, otherwise
|
2228
|
-
# `standard`
|
2231
|
+
# Default: `io1` if the `Iops` parameter is specified, otherwise `gp2`
|
2229
2232
|
# @option options [String] :tde_credential_arn
|
2230
2233
|
# The ARN from the key store with which to associate the instance for
|
2231
2234
|
# TDE encryption.
|
@@ -2241,8 +2244,8 @@ module Aws::RDS
|
|
2241
2244
|
# created prior to this operation. Currently only a Microsoft SQL Server
|
2242
2245
|
# instance can be created in a Active Directory Domain.
|
2243
2246
|
# @option options [Boolean] :copy_tags_to_snapshot
|
2244
|
-
#
|
2245
|
-
#
|
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.
|
2246
2249
|
#
|
2247
2250
|
# **Amazon Aurora**
|
2248
2251
|
#
|
@@ -2307,20 +2310,19 @@ module Aws::RDS
|
|
2307
2310
|
#
|
2308
2311
|
# Valid Values: `1150-65535`
|
2309
2312
|
# @option options [Boolean] :publicly_accessible
|
2310
|
-
#
|
2311
|
-
#
|
2312
|
-
#
|
2313
|
-
#
|
2314
|
-
# 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.
|
2315
2319
|
#
|
2316
2320
|
# `PubliclyAccessible` only applies to DB instances in a VPC. The DB
|
2317
2321
|
# instance must be part of a public subnet and `PubliclyAccessible` must
|
2318
|
-
# be
|
2322
|
+
# be enabled for it to be publicly accessible.
|
2319
2323
|
#
|
2320
2324
|
# Changes to the `PubliclyAccessible` parameter are applied immediately
|
2321
2325
|
# regardless of the value of the `ApplyImmediately` parameter.
|
2322
|
-
#
|
2323
|
-
# Default: false
|
2324
2326
|
# @option options [String] :monitoring_role_arn
|
2325
2327
|
# The ARN for the IAM role that permits RDS to send enhanced monitoring
|
2326
2328
|
# metrics to Amazon CloudWatch Logs. For example,
|
@@ -2351,8 +2353,9 @@ module Aws::RDS
|
|
2351
2353
|
#
|
2352
2354
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Managing.Backups.html#Aurora.Managing.FaultTolerance
|
2353
2355
|
# @option options [Boolean] :enable_iam_database_authentication
|
2354
|
-
#
|
2355
|
-
# 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.
|
2356
2359
|
#
|
2357
2360
|
# You can enable IAM database authentication for the following database
|
2358
2361
|
# engines
|
@@ -2368,11 +2371,9 @@ module Aws::RDS
|
|
2368
2371
|
# * For MySQL 5.6, minor version 5.6.34 or higher
|
2369
2372
|
#
|
2370
2373
|
# * For MySQL 5.7, minor version 5.7.16 or higher
|
2371
|
-
#
|
2372
|
-
# Default: `false`
|
2373
2374
|
# @option options [Boolean] :enable_performance_insights
|
2374
|
-
#
|
2375
|
-
#
|
2375
|
+
# A value that indicates whether to enable Performance Insights for the
|
2376
|
+
# DB instance.
|
2376
2377
|
#
|
2377
2378
|
# For more information, see [Using Amazon Performance Insights][1] in
|
2378
2379
|
# the *Amazon Relational Database Service User Guide*.
|
@@ -2384,6 +2385,11 @@ module Aws::RDS
|
|
2384
2385
|
# The AWS KMS key identifier for encryption of Performance Insights
|
2385
2386
|
# data. The KMS key ID is the Amazon Resource Name (ARN), KMS key
|
2386
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.
|
2387
2393
|
# @option options [Integer] :performance_insights_retention_period
|
2388
2394
|
# The amount of time, in days, to retain Performance Insights data.
|
2389
2395
|
# Valid values are 7 or 731 (2 years).
|
@@ -2398,11 +2404,12 @@ module Aws::RDS
|
|
2398
2404
|
# The number of CPU cores and the number of threads per core for the DB
|
2399
2405
|
# instance class of the DB instance.
|
2400
2406
|
# @option options [Boolean] :use_default_processor_features
|
2401
|
-
# A value that
|
2402
|
-
# 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.
|
2403
2409
|
# @option options [Boolean] :deletion_protection
|
2404
|
-
#
|
2405
|
-
# 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
|
2406
2413
|
# information, see [ Deleting a DB Instance][1].
|
2407
2414
|
#
|
2408
2415
|
#
|
@@ -2479,10 +2486,11 @@ module Aws::RDS
|
|
2479
2486
|
# })
|
2480
2487
|
# @param [Hash] options ({})
|
2481
2488
|
# @option options [Boolean] :force_failover
|
2482
|
-
#
|
2489
|
+
# A value that indicates whether the reboot is conducted through a
|
2490
|
+
# Multi-AZ failover.
|
2483
2491
|
#
|
2484
|
-
# Constraint: You can't
|
2485
|
-
# configured for
|
2492
|
+
# Constraint: You can't enable force failover if the instance is not
|
2493
|
+
# configured for Multi-AZ.
|
2486
2494
|
# @return [DBInstance]
|
2487
2495
|
def reboot(options = {})
|
2488
2496
|
options = options.merge(db_instance_identifier: @id)
|
@@ -2559,16 +2567,17 @@ module Aws::RDS
|
|
2559
2567
|
#
|
2560
2568
|
# * Must be before the latest restorable time for the DB instance
|
2561
2569
|
#
|
2562
|
-
# * Can't be specified if UseLatestRestorableTime parameter is
|
2570
|
+
# * Can't be specified if the `UseLatestRestorableTime` parameter is
|
2571
|
+
# enabled
|
2563
2572
|
#
|
2564
2573
|
# Example: `2009-09-07T23:45:00Z`
|
2565
2574
|
# @option options [Boolean] :use_latest_restorable_time
|
2566
|
-
#
|
2567
|
-
#
|
2568
|
-
#
|
2569
|
-
# 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.
|
2570
2578
|
#
|
2571
|
-
# Constraints: Can't be specified if RestoreTime parameter is
|
2579
|
+
# Constraints: Can't be specified if the `RestoreTime` parameter is
|
2580
|
+
# provided.
|
2572
2581
|
# @option options [String] :db_instance_class
|
2573
2582
|
# The compute and memory capacity of the Amazon RDS DB instance, for
|
2574
2583
|
# example, `db.m4.large`. Not all DB instance classes are available in
|
@@ -2592,8 +2601,8 @@ module Aws::RDS
|
|
2592
2601
|
#
|
2593
2602
|
# Default: A random, system-chosen Availability Zone.
|
2594
2603
|
#
|
2595
|
-
# Constraint: You can't specify the AvailabilityZone parameter if the
|
2596
|
-
#
|
2604
|
+
# Constraint: You can't specify the `AvailabilityZone` parameter if the
|
2605
|
+
# DB instance is a Multi-AZ deployment.
|
2597
2606
|
#
|
2598
2607
|
# Example: `us-east-1a`
|
2599
2608
|
# @option options [String] :db_subnet_group_name
|
@@ -2604,19 +2613,21 @@ module Aws::RDS
|
|
2604
2613
|
#
|
2605
2614
|
# Example: `mySubnetgroup`
|
2606
2615
|
# @option options [Boolean] :multi_az
|
2607
|
-
#
|
2616
|
+
# A value that indicates whether the DB instance is a Multi-AZ
|
2617
|
+
# deployment.
|
2608
2618
|
#
|
2609
|
-
# Constraint: You can't specify the AvailabilityZone parameter if the
|
2610
|
-
#
|
2619
|
+
# Constraint: You can't specify the `AvailabilityZone` parameter if the
|
2620
|
+
# DB instance is a Multi-AZ deployment.
|
2611
2621
|
# @option options [Boolean] :publicly_accessible
|
2612
|
-
#
|
2613
|
-
#
|
2614
|
-
# DNS name, which resolves to a
|
2615
|
-
#
|
2616
|
-
#
|
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.
|
2617
2628
|
# @option options [Boolean] :auto_minor_version_upgrade
|
2618
|
-
#
|
2619
|
-
# 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.
|
2620
2631
|
# @option options [String] :license_model
|
2621
2632
|
# License model information for the restored DB instance.
|
2622
2633
|
#
|
@@ -2678,8 +2689,9 @@ module Aws::RDS
|
|
2678
2689
|
# can't be removed from a DB instance once it is associated with a DB
|
2679
2690
|
# instance
|
2680
2691
|
# @option options [Boolean] :copy_tags_to_snapshot
|
2681
|
-
#
|
2682
|
-
#
|
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.
|
2683
2695
|
# @option options [Array<Types::Tag>] :tags
|
2684
2696
|
# A list of tags. For more information, see [Tagging Amazon RDS
|
2685
2697
|
# Resources][1] in the *Amazon RDS User Guide.*
|
@@ -2695,8 +2707,7 @@ module Aws::RDS
|
|
2695
2707
|
# If you specify `io1`, you must also include a value for the `Iops`
|
2696
2708
|
# parameter.
|
2697
2709
|
#
|
2698
|
-
# Default: `io1` if the `Iops` parameter is specified, otherwise
|
2699
|
-
# `standard`
|
2710
|
+
# Default: `io1` if the `Iops` parameter is specified, otherwise `gp2`
|
2700
2711
|
# @option options [String] :tde_credential_arn
|
2701
2712
|
# The ARN from the key store with which to associate the instance for
|
2702
2713
|
# TDE encryption.
|
@@ -2714,8 +2725,9 @@ module Aws::RDS
|
|
2714
2725
|
# Specify the name of the IAM role to be used when making API calls to
|
2715
2726
|
# the Directory Service.
|
2716
2727
|
# @option options [Boolean] :enable_iam_database_authentication
|
2717
|
-
#
|
2718
|
-
# 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.
|
2719
2731
|
#
|
2720
2732
|
# You can enable IAM database authentication for the following database
|
2721
2733
|
# engines
|
@@ -2723,8 +2735,6 @@ module Aws::RDS
|
|
2723
2735
|
# * For MySQL 5.6, minor version 5.6.34 or higher
|
2724
2736
|
#
|
2725
2737
|
# * For MySQL 5.7, minor version 5.7.16 or higher
|
2726
|
-
#
|
2727
|
-
# Default: `false`
|
2728
2738
|
# @option options [Array<String>] :enable_cloudwatch_logs_exports
|
2729
2739
|
# The list of logs that the restored DB instance is to export to
|
2730
2740
|
# CloudWatch Logs. The values in the list depend on the DB engine being
|
@@ -2738,8 +2748,8 @@ module Aws::RDS
|
|
2738
2748
|
# The number of CPU cores and the number of threads per core for the DB
|
2739
2749
|
# instance class of the DB instance.
|
2740
2750
|
# @option options [Boolean] :use_default_processor_features
|
2741
|
-
# A value that
|
2742
|
-
# 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.
|
2743
2753
|
# @option options [String] :db_parameter_group_name
|
2744
2754
|
# The name of the DB parameter group to associate with this DB instance.
|
2745
2755
|
# If this argument is omitted, the default DBParameterGroup for the
|
@@ -2755,10 +2765,10 @@ module Aws::RDS
|
|
2755
2765
|
#
|
2756
2766
|
# * Can't end with a hyphen or contain two consecutive hyphens.
|
2757
2767
|
# @option options [Boolean] :deletion_protection
|
2758
|
-
#
|
2759
|
-
# The database can't be deleted when
|
2760
|
-
# default is
|
2761
|
-
# 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].
|
2762
2772
|
#
|
2763
2773
|
#
|
2764
2774
|
#
|
@@ -3123,9 +3133,9 @@ module Aws::RDS
|
|
3123
3133
|
# If you don't specify a `SnapshotType` value, then both automated and
|
3124
3134
|
# manual snapshots are returned. Shared and public DB snapshots are not
|
3125
3135
|
# included in the returned results by default. You can include shared
|
3126
|
-
# snapshots with these results by
|
3127
|
-
#
|
3128
|
-
#
|
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.
|
3129
3139
|
#
|
3130
3140
|
# The `IncludeShared` and `IncludePublic` parameters don't apply for
|
3131
3141
|
# `SnapshotType` values of `manual` or `automated`. The `IncludePublic`
|
@@ -3139,20 +3149,21 @@ module Aws::RDS
|
|
3139
3149
|
# @option options [Array<Types::Filter>] :filters
|
3140
3150
|
# This parameter is not currently supported.
|
3141
3151
|
# @option options [Boolean] :include_shared
|
3142
|
-
#
|
3143
|
-
# that this AWS account has been given
|
3144
|
-
#
|
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.
|
3145
3156
|
#
|
3146
3157
|
# You can give an AWS account permission to restore a manual DB snapshot
|
3147
3158
|
# from another AWS account by using the `ModifyDBSnapshotAttribute` API
|
3148
3159
|
# action.
|
3149
3160
|
# @option options [Boolean] :include_public
|
3150
|
-
#
|
3151
|
-
# or restored by any AWS account
|
3152
|
-
#
|
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.
|
3153
3164
|
#
|
3154
3165
|
# You can share a manual DB snapshot as public by using the
|
3155
|
-
#
|
3166
|
+
# ModifyDBSnapshotAttribute API.
|
3156
3167
|
# @option options [String] :dbi_resource_id
|
3157
3168
|
# A specific DB resource ID to describe.
|
3158
3169
|
# @return [DBSnapshot::Collection]
|