aws-sdk-rds 1.54.0 → 1.55.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/lib/aws-sdk-rds.rb +1 -1
- data/lib/aws-sdk-rds/client.rb +398 -416
- data/lib/aws-sdk-rds/client_api.rb +2 -0
- data/lib/aws-sdk-rds/db_cluster.rb +78 -79
- data/lib/aws-sdk-rds/db_cluster_parameter_group.rb +5 -5
- data/lib/aws-sdk-rds/db_cluster_snapshot.rb +11 -12
- data/lib/aws-sdk-rds/db_engine.rb +8 -10
- data/lib/aws-sdk-rds/db_engine_version.rb +7 -0
- data/lib/aws-sdk-rds/db_instance.rb +200 -211
- data/lib/aws-sdk-rds/db_parameter_group.rb +4 -3
- data/lib/aws-sdk-rds/db_snapshot.rb +28 -29
- data/lib/aws-sdk-rds/event_subscription.rb +3 -4
- data/lib/aws-sdk-rds/option_group.rb +3 -3
- data/lib/aws-sdk-rds/resource.rb +80 -85
- data/lib/aws-sdk-rds/types.rb +427 -525
- metadata +2 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA1:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: e4e3a69334a102babc4ff7604631331cffc0cdcb
|
4
|
+
data.tar.gz: 2538d30852ed4066a8d3096dabc93f66203597c0
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 30c2a669b945198835fb1027467d5ad3fc18575eebbe3ea6ec529033efaabe29afca25f488b488a689608f11489be41f4154ba89f2ed4fe3af39dc3a975515da
|
7
|
+
data.tar.gz: 128e2f365ad25e7078f34d24216b00bd9ac4469d981993dc8bc61f94cda10b8ce1c11d25775e9be77d95ed02b530d4a0966f41919cc022a8fbc828d9442f62a4
|
data/lib/aws-sdk-rds.rb
CHANGED
data/lib/aws-sdk-rds/client.rb
CHANGED
@@ -707,16 +707,14 @@ module Aws::RDS
|
|
707
707
|
# [1]: http://en.wikipedia.org/wiki/ISO_8601
|
708
708
|
#
|
709
709
|
# @option params [Boolean] :force
|
710
|
-
# A value that
|
711
|
-
#
|
710
|
+
# A value that, if specified, forces the DB cluster to backtrack when
|
711
|
+
# binary logging is enabled. Otherwise, an error occurs when binary
|
712
712
|
# logging is enabled.
|
713
713
|
#
|
714
714
|
# @option params [Boolean] :use_earliest_time_on_point_in_time_unavailable
|
715
|
-
#
|
716
|
-
#
|
717
|
-
#
|
718
|
-
# parameter is disabled and *BacktrackTo* is set to a timestamp earlier
|
719
|
-
# than the earliest backtrack time, an error occurs.
|
715
|
+
# If *BacktrackTo* is set to a timestamp earlier than the earliest
|
716
|
+
# backtrack time, this value backtracks the DB cluster to the earliest
|
717
|
+
# possible backtrack time. Otherwise, an error occurs.
|
720
718
|
#
|
721
719
|
# @return [Types::DBClusterBacktrack] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
722
720
|
#
|
@@ -1045,9 +1043,8 @@ module Aws::RDS
|
|
1045
1043
|
# [2]: https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html
|
1046
1044
|
#
|
1047
1045
|
# @option params [Boolean] :copy_tags
|
1048
|
-
#
|
1049
|
-
#
|
1050
|
-
# are not copied.
|
1046
|
+
# True to copy all tags from the source DB cluster snapshot to the
|
1047
|
+
# target DB cluster snapshot, and otherwise false. The default is false.
|
1051
1048
|
#
|
1052
1049
|
# @option params [Array<Types::Tag>] :tags
|
1053
1050
|
# A list of tags. For more information, see [Tagging Amazon RDS
|
@@ -1315,8 +1312,8 @@ module Aws::RDS
|
|
1315
1312
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html
|
1316
1313
|
#
|
1317
1314
|
# @option params [Boolean] :copy_tags
|
1318
|
-
#
|
1319
|
-
# snapshot
|
1315
|
+
# True to copy all tags from the source DB snapshot to the target DB
|
1316
|
+
# snapshot, and otherwise false. The default is false.
|
1320
1317
|
#
|
1321
1318
|
# @option params [String] :pre_signed_url
|
1322
1319
|
# The URL that contains a Signature Version 4 signed request for the
|
@@ -1778,7 +1775,7 @@ module Aws::RDS
|
|
1778
1775
|
# Tags to assign to the DB cluster.
|
1779
1776
|
#
|
1780
1777
|
# @option params [Boolean] :storage_encrypted
|
1781
|
-
#
|
1778
|
+
# Specifies whether the DB cluster is encrypted.
|
1782
1779
|
#
|
1783
1780
|
# @option params [String] :kms_key_id
|
1784
1781
|
# The AWS KMS key identifier for an encrypted DB cluster.
|
@@ -1795,7 +1792,7 @@ module Aws::RDS
|
|
1795
1792
|
# then Amazon RDS will use the encryption key used to encrypt the
|
1796
1793
|
# source. Otherwise, Amazon RDS will use your default encryption key.
|
1797
1794
|
#
|
1798
|
-
# * If the `StorageEncrypted` parameter is
|
1795
|
+
# * If the `StorageEncrypted` parameter is true and
|
1799
1796
|
# `ReplicationSourceIdentifier` is not specified, then Amazon RDS will
|
1800
1797
|
# use your default encryption key.
|
1801
1798
|
#
|
@@ -1849,9 +1846,10 @@ module Aws::RDS
|
|
1849
1846
|
# [2]: https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html
|
1850
1847
|
#
|
1851
1848
|
# @option params [Boolean] :enable_iam_database_authentication
|
1852
|
-
#
|
1853
|
-
#
|
1854
|
-
#
|
1849
|
+
# True to enable mapping of AWS Identity and Access Management (IAM)
|
1850
|
+
# accounts to database accounts, and otherwise false.
|
1851
|
+
#
|
1852
|
+
# Default: `false`
|
1855
1853
|
#
|
1856
1854
|
# @option params [Integer] :backtrack_window
|
1857
1855
|
# The target backtrack window, in seconds. To disable backtracking, set
|
@@ -1885,17 +1883,17 @@ module Aws::RDS
|
|
1885
1883
|
# of the DB cluster.
|
1886
1884
|
#
|
1887
1885
|
# @option params [Boolean] :deletion_protection
|
1888
|
-
#
|
1889
|
-
# enabled. The database can't be deleted when
|
1890
|
-
#
|
1886
|
+
# Indicates whether the DB cluster should have deletion protection
|
1887
|
+
# enabled. The database can't be deleted when this value is set to
|
1888
|
+
# true. The default is false.
|
1891
1889
|
#
|
1892
1890
|
# @option params [String] :global_cluster_identifier
|
1893
1891
|
# The global cluster ID of an Aurora cluster that becomes the primary
|
1894
1892
|
# cluster in the new global database cluster.
|
1895
1893
|
#
|
1896
1894
|
# @option params [Boolean] :copy_tags_to_snapshot
|
1897
|
-
#
|
1898
|
-
#
|
1895
|
+
# True to copy all tags from the DB cluster to snapshots of the DB
|
1896
|
+
# cluster, and otherwise false. The default is false.
|
1899
1897
|
#
|
1900
1898
|
# @option params [String] :source_region
|
1901
1899
|
# The source region of the snapshot. This is only needed when the
|
@@ -2467,10 +2465,10 @@ module Aws::RDS
|
|
2467
2465
|
# following:
|
2468
2466
|
#
|
2469
2467
|
# * General Purpose (SSD) storage (gp2): Must be an integer from 20 to
|
2470
|
-
#
|
2468
|
+
# 32768.
|
2471
2469
|
#
|
2472
2470
|
# * Provisioned IOPS storage (io1): Must be an integer from 100 to
|
2473
|
-
#
|
2471
|
+
# 32768.
|
2474
2472
|
#
|
2475
2473
|
# * Magnetic storage (standard): Must be an integer from 5 to 3072.
|
2476
2474
|
#
|
@@ -2480,10 +2478,10 @@ module Aws::RDS
|
|
2480
2478
|
# following:
|
2481
2479
|
#
|
2482
2480
|
# * General Purpose (SSD) storage (gp2): Must be an integer from 20 to
|
2483
|
-
#
|
2481
|
+
# 32768.
|
2484
2482
|
#
|
2485
2483
|
# * Provisioned IOPS storage (io1): Must be an integer from 100 to
|
2486
|
-
#
|
2484
|
+
# 32768.
|
2487
2485
|
#
|
2488
2486
|
# * Magnetic storage (standard): Must be an integer from 5 to 3072.
|
2489
2487
|
#
|
@@ -2493,10 +2491,10 @@ module Aws::RDS
|
|
2493
2491
|
# following:
|
2494
2492
|
#
|
2495
2493
|
# * General Purpose (SSD) storage (gp2): Must be an integer from 20 to
|
2496
|
-
#
|
2494
|
+
# 32768.
|
2497
2495
|
#
|
2498
2496
|
# * Provisioned IOPS storage (io1): Must be an integer from 100 to
|
2499
|
-
#
|
2497
|
+
# 32768.
|
2500
2498
|
#
|
2501
2499
|
# * Magnetic storage (standard): Must be an integer from 5 to 3072.
|
2502
2500
|
#
|
@@ -2506,10 +2504,10 @@ module Aws::RDS
|
|
2506
2504
|
# following:
|
2507
2505
|
#
|
2508
2506
|
# * General Purpose (SSD) storage (gp2): Must be an integer from 20 to
|
2509
|
-
#
|
2507
|
+
# 32768.
|
2510
2508
|
#
|
2511
2509
|
# * Provisioned IOPS storage (io1): Must be an integer from 100 to
|
2512
|
-
#
|
2510
|
+
# 32768.
|
2513
2511
|
#
|
2514
2512
|
# * Magnetic storage (standard): Must be an integer from 10 to 3072.
|
2515
2513
|
#
|
@@ -2707,9 +2705,9 @@ module Aws::RDS
|
|
2707
2705
|
#
|
2708
2706
|
# Example: `us-east-1d`
|
2709
2707
|
#
|
2710
|
-
# Constraint: The
|
2711
|
-
#
|
2712
|
-
#
|
2708
|
+
# Constraint: The AvailabilityZone parameter can't be specified if the
|
2709
|
+
# MultiAZ parameter is set to `true`. The specified Availability Zone
|
2710
|
+
# must be in the same AWS Region as the current endpoint.
|
2713
2711
|
#
|
2714
2712
|
#
|
2715
2713
|
#
|
@@ -2850,9 +2848,9 @@ module Aws::RDS
|
|
2850
2848
|
# Type: Integer
|
2851
2849
|
#
|
2852
2850
|
# @option params [Boolean] :multi_az
|
2853
|
-
# A value that
|
2854
|
-
# deployment. You can't set the
|
2855
|
-
#
|
2851
|
+
# A value that specifies whether the DB instance is a Multi-AZ
|
2852
|
+
# deployment. You can't set the AvailabilityZone parameter if the
|
2853
|
+
# MultiAZ parameter is set to true.
|
2856
2854
|
#
|
2857
2855
|
# @option params [String] :engine_version
|
2858
2856
|
# The version number of the database engine to use.
|
@@ -2902,9 +2900,10 @@ module Aws::RDS
|
|
2902
2900
|
# [5]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_PostgreSQL.html#PostgreSQL.Concepts.General.DBVersions
|
2903
2901
|
#
|
2904
2902
|
# @option params [Boolean] :auto_minor_version_upgrade
|
2905
|
-
#
|
2906
|
-
#
|
2907
|
-
#
|
2903
|
+
# Indicates that minor engine upgrades are applied automatically to the
|
2904
|
+
# DB instance during the maintenance window.
|
2905
|
+
#
|
2906
|
+
# Default: `true`
|
2908
2907
|
#
|
2909
2908
|
# @option params [String] :license_model
|
2910
2909
|
# License model information for this DB instance.
|
@@ -2944,12 +2943,11 @@ module Aws::RDS
|
|
2944
2943
|
# more information, see `CreateDBCluster`.
|
2945
2944
|
#
|
2946
2945
|
# @option params [Boolean] :publicly_accessible
|
2947
|
-
#
|
2948
|
-
#
|
2949
|
-
#
|
2950
|
-
#
|
2951
|
-
#
|
2952
|
-
# address.
|
2946
|
+
# Specifies the accessibility options for the DB instance. A value of
|
2947
|
+
# true specifies an Internet-facing instance with a publicly resolvable
|
2948
|
+
# DNS name, which resolves to a public IP address. A value of false
|
2949
|
+
# specifies an internal instance with a DNS name that resolves to a
|
2950
|
+
# private IP address.
|
2953
2951
|
#
|
2954
2952
|
# Default: The default behavior varies depending on whether
|
2955
2953
|
# `DBSubnetGroupName` is specified.
|
@@ -2986,7 +2984,8 @@ module Aws::RDS
|
|
2986
2984
|
# If you specify `io1`, you must also include a value for the `Iops`
|
2987
2985
|
# parameter.
|
2988
2986
|
#
|
2989
|
-
# Default: `io1` if the `Iops` parameter is specified, otherwise
|
2987
|
+
# Default: `io1` if the `Iops` parameter is specified, otherwise
|
2988
|
+
# `standard`
|
2990
2989
|
#
|
2991
2990
|
# @option params [String] :tde_credential_arn
|
2992
2991
|
# The ARN from the key store with which to associate the instance for
|
@@ -2997,14 +2996,15 @@ module Aws::RDS
|
|
2997
2996
|
# the device.
|
2998
2997
|
#
|
2999
2998
|
# @option params [Boolean] :storage_encrypted
|
3000
|
-
#
|
3001
|
-
# default, it is not encrypted.
|
2999
|
+
# Specifies whether the DB instance is encrypted.
|
3002
3000
|
#
|
3003
3001
|
# **Amazon Aurora**
|
3004
3002
|
#
|
3005
3003
|
# Not applicable. The encryption for DB instances is managed by the DB
|
3006
3004
|
# cluster.
|
3007
3005
|
#
|
3006
|
+
# Default: false
|
3007
|
+
#
|
3008
3008
|
# @option params [String] :kms_key_id
|
3009
3009
|
# The AWS KMS key identifier for an encrypted DB instance.
|
3010
3010
|
#
|
@@ -3019,11 +3019,11 @@ module Aws::RDS
|
|
3019
3019
|
# Not applicable. The KMS key identifier is managed by the DB cluster.
|
3020
3020
|
# For more information, see `CreateDBCluster`.
|
3021
3021
|
#
|
3022
|
-
# If `StorageEncrypted` is
|
3023
|
-
# the `KmsKeyId` parameter, then Amazon RDS will use your
|
3024
|
-
# encryption key. AWS KMS creates the default encryption key for
|
3025
|
-
# AWS account. Your AWS account has a different default encryption
|
3026
|
-
# for each AWS Region.
|
3022
|
+
# If the `StorageEncrypted` parameter is true, and you do not specify a
|
3023
|
+
# value for the `KmsKeyId` parameter, then Amazon RDS will use your
|
3024
|
+
# default encryption key. AWS KMS creates the default encryption key for
|
3025
|
+
# your AWS account. Your AWS account has a different default encryption
|
3026
|
+
# key for each AWS Region.
|
3027
3027
|
#
|
3028
3028
|
# @option params [String] :domain
|
3029
3029
|
# For an Amazon RDS DB instance that's running Microsoft SQL Server,
|
@@ -3039,8 +3039,8 @@ module Aws::RDS
|
|
3039
3039
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/DeveloperGuide/USER_SQLServerWinAuth.html
|
3040
3040
|
#
|
3041
3041
|
# @option params [Boolean] :copy_tags_to_snapshot
|
3042
|
-
#
|
3043
|
-
#
|
3042
|
+
# True to copy all tags from the DB instance to snapshots of the DB
|
3043
|
+
# instance, and otherwise false. The default is false.
|
3044
3044
|
#
|
3045
3045
|
# **Amazon Aurora**
|
3046
3046
|
#
|
@@ -3099,9 +3099,8 @@ module Aws::RDS
|
|
3099
3099
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_SQLServer.html#SQLServer.Concepts.General.TimeZone
|
3100
3100
|
#
|
3101
3101
|
# @option params [Boolean] :enable_iam_database_authentication
|
3102
|
-
#
|
3103
|
-
#
|
3104
|
-
# mapping is disabled.
|
3102
|
+
# True to enable mapping of AWS Identity and Access Management (IAM)
|
3103
|
+
# accounts to database accounts, and otherwise false.
|
3105
3104
|
#
|
3106
3105
|
# You can enable IAM database authentication for the following database
|
3107
3106
|
# engines:
|
@@ -3117,9 +3116,11 @@ module Aws::RDS
|
|
3117
3116
|
#
|
3118
3117
|
# * For MySQL 5.7, minor version 5.7.16 or higher
|
3119
3118
|
#
|
3119
|
+
# Default: `false`
|
3120
|
+
#
|
3120
3121
|
# @option params [Boolean] :enable_performance_insights
|
3121
|
-
#
|
3122
|
-
#
|
3122
|
+
# True to enable Performance Insights for the DB instance, and otherwise
|
3123
|
+
# false.
|
3123
3124
|
#
|
3124
3125
|
# For more information, see [Using Amazon Performance Insights][1] in
|
3125
3126
|
# the *Amazon Relational Database Service User Guide*.
|
@@ -3133,11 +3134,6 @@ module Aws::RDS
|
|
3133
3134
|
# data. The KMS key ID is the Amazon Resource Name (ARN), KMS key
|
3134
3135
|
# identifier, or the KMS key alias for the KMS encryption key.
|
3135
3136
|
#
|
3136
|
-
# If you do not specify a value for `PerformanceInsightsKMSKeyId`, then
|
3137
|
-
# Amazon RDS uses your default encryption key. AWS KMS creates the
|
3138
|
-
# default encryption key for your AWS account. Your AWS account has a
|
3139
|
-
# different default encryption key for each AWS Region.
|
3140
|
-
#
|
3141
3137
|
# @option params [Integer] :performance_insights_retention_period
|
3142
3138
|
# The amount of time, in days, to retain Performance Insights data.
|
3143
3139
|
# Valid values are 7 or 731 (2 years).
|
@@ -3158,10 +3154,10 @@ module Aws::RDS
|
|
3158
3154
|
# instance class of the DB instance.
|
3159
3155
|
#
|
3160
3156
|
# @option params [Boolean] :deletion_protection
|
3161
|
-
#
|
3162
|
-
#
|
3163
|
-
#
|
3164
|
-
#
|
3157
|
+
# Indicates if the DB instance should have deletion protection enabled.
|
3158
|
+
# The database can't be deleted when this value is set to true. The
|
3159
|
+
# default is false. For more information, see [ Deleting a DB
|
3160
|
+
# Instance][1].
|
3165
3161
|
#
|
3166
3162
|
#
|
3167
3163
|
#
|
@@ -3464,8 +3460,7 @@ module Aws::RDS
|
|
3464
3460
|
# Valid Values: `1150-65535`
|
3465
3461
|
#
|
3466
3462
|
# @option params [Boolean] :multi_az
|
3467
|
-
#
|
3468
|
-
# deployment.
|
3463
|
+
# Specifies whether the Read Replica is in a Multi-AZ deployment.
|
3469
3464
|
#
|
3470
3465
|
# You can create a Read Replica as a Multi-AZ DB instance. RDS creates a
|
3471
3466
|
# standby of your replica in another Availability Zone for failover
|
@@ -3474,8 +3469,8 @@ module Aws::RDS
|
|
3474
3469
|
# DB instance.
|
3475
3470
|
#
|
3476
3471
|
# @option params [Boolean] :auto_minor_version_upgrade
|
3477
|
-
#
|
3478
|
-
#
|
3472
|
+
# Indicates that minor engine upgrades are applied automatically to the
|
3473
|
+
# Read Replica during the maintenance window.
|
3479
3474
|
#
|
3480
3475
|
# Default: Inherits from the source DB instance
|
3481
3476
|
#
|
@@ -3488,12 +3483,11 @@ module Aws::RDS
|
|
3488
3483
|
# option group associated with the source instance is used.
|
3489
3484
|
#
|
3490
3485
|
# @option params [Boolean] :publicly_accessible
|
3491
|
-
#
|
3492
|
-
#
|
3493
|
-
#
|
3494
|
-
#
|
3495
|
-
#
|
3496
|
-
# address. For more information, see CreateDBInstance.
|
3486
|
+
# Specifies the accessibility options for the DB instance. A value of
|
3487
|
+
# true specifies an Internet-facing instance with a publicly resolvable
|
3488
|
+
# DNS name, which resolves to a public IP address. A value of false
|
3489
|
+
# specifies an internal instance with a DNS name that resolves to a
|
3490
|
+
# private IP address. For more information, see `CreateDBInstance`.
|
3497
3491
|
#
|
3498
3492
|
# @option params [Array<Types::Tag>] :tags
|
3499
3493
|
# A list of tags. For more information, see [Tagging Amazon RDS
|
@@ -3544,11 +3538,12 @@ module Aws::RDS
|
|
3544
3538
|
# If you specify `io1`, you must also include a value for the `Iops`
|
3545
3539
|
# parameter.
|
3546
3540
|
#
|
3547
|
-
# Default: `io1` if the `Iops` parameter is specified, otherwise
|
3541
|
+
# Default: `io1` if the `Iops` parameter is specified, otherwise
|
3542
|
+
# `standard`
|
3548
3543
|
#
|
3549
3544
|
# @option params [Boolean] :copy_tags_to_snapshot
|
3550
|
-
#
|
3551
|
-
#
|
3545
|
+
# True to copy all tags from the Read Replica to snapshots of the Read
|
3546
|
+
# Replica, and otherwise false. The default is false.
|
3552
3547
|
#
|
3553
3548
|
# @option params [Integer] :monitoring_interval
|
3554
3549
|
# The interval, in seconds, between points when Enhanced Monitoring
|
@@ -3646,9 +3641,8 @@ module Aws::RDS
|
|
3646
3641
|
# [2]: https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html
|
3647
3642
|
#
|
3648
3643
|
# @option params [Boolean] :enable_iam_database_authentication
|
3649
|
-
#
|
3650
|
-
#
|
3651
|
-
# mapping is disabled.
|
3644
|
+
# True to enable mapping of AWS Identity and Access Management (IAM)
|
3645
|
+
# accounts to database accounts, and otherwise false.
|
3652
3646
|
#
|
3653
3647
|
# You can enable IAM database authentication for the following database
|
3654
3648
|
# engines
|
@@ -3659,9 +3653,11 @@ module Aws::RDS
|
|
3659
3653
|
#
|
3660
3654
|
# * Aurora MySQL 5.6 or higher
|
3661
3655
|
#
|
3656
|
+
# Default: `false`
|
3657
|
+
#
|
3662
3658
|
# @option params [Boolean] :enable_performance_insights
|
3663
|
-
#
|
3664
|
-
#
|
3659
|
+
# True to enable Performance Insights for the Read Replica, and
|
3660
|
+
# otherwise false.
|
3665
3661
|
#
|
3666
3662
|
# For more information, see [Using Amazon Performance Insights][1] in
|
3667
3663
|
# the *Amazon RDS User Guide*.
|
@@ -3675,11 +3671,6 @@ module Aws::RDS
|
|
3675
3671
|
# data. The KMS key ID is the Amazon Resource Name (ARN), KMS key
|
3676
3672
|
# identifier, or the KMS key alias for the KMS encryption key.
|
3677
3673
|
#
|
3678
|
-
# If you do not specify a value for `PerformanceInsightsKMSKeyId`, then
|
3679
|
-
# Amazon RDS uses your default encryption key. AWS KMS creates the
|
3680
|
-
# default encryption key for your AWS account. Your AWS account has a
|
3681
|
-
# different default encryption key for each AWS Region.
|
3682
|
-
#
|
3683
3674
|
# @option params [Integer] :performance_insights_retention_period
|
3684
3675
|
# The amount of time, in days, to retain Performance Insights data.
|
3685
3676
|
# Valid values are 7 or 731 (2 years).
|
@@ -3699,14 +3690,14 @@ module Aws::RDS
|
|
3699
3690
|
# instance class of the DB instance.
|
3700
3691
|
#
|
3701
3692
|
# @option params [Boolean] :use_default_processor_features
|
3702
|
-
# A value that
|
3703
|
-
#
|
3693
|
+
# A value that specifies that the DB instance class of the DB instance
|
3694
|
+
# uses its default processor features.
|
3704
3695
|
#
|
3705
3696
|
# @option params [Boolean] :deletion_protection
|
3706
|
-
#
|
3707
|
-
#
|
3708
|
-
#
|
3709
|
-
#
|
3697
|
+
# Indicates if the DB instance should have deletion protection enabled.
|
3698
|
+
# The database can't be deleted when this value is set to true. The
|
3699
|
+
# default is false. For more information, see [ Deleting a DB
|
3700
|
+
# Instance][1].
|
3710
3701
|
#
|
3711
3702
|
#
|
3712
3703
|
#
|
@@ -4384,9 +4375,8 @@ module Aws::RDS
|
|
4384
4375
|
# be supplied.
|
4385
4376
|
#
|
4386
4377
|
# @option params [Boolean] :enabled
|
4387
|
-
# A value
|
4388
|
-
#
|
4389
|
-
# created but not active.
|
4378
|
+
# A Boolean value; set to **true** to activate the subscription, set to
|
4379
|
+
# **false** to create the subscription but not active it.
|
4390
4380
|
#
|
4391
4381
|
# @option params [Array<Types::Tag>] :tags
|
4392
4382
|
# A list of tags. For more information, see [Tagging Amazon RDS
|
@@ -4496,7 +4486,7 @@ module Aws::RDS
|
|
4496
4486
|
#
|
4497
4487
|
# @option params [Boolean] :deletion_protection
|
4498
4488
|
# The deletion protection setting for the new global database. The
|
4499
|
-
# global database can't be deleted when
|
4489
|
+
# global database can't be deleted when this value is set to true.
|
4500
4490
|
#
|
4501
4491
|
# @option params [String] :database_name
|
4502
4492
|
# The name for your database of up to 64 alpha-numeric characters. If
|
@@ -4685,25 +4675,24 @@ module Aws::RDS
|
|
4685
4675
|
# ^
|
4686
4676
|
#
|
4687
4677
|
# @option params [Boolean] :skip_final_snapshot
|
4688
|
-
#
|
4689
|
-
#
|
4690
|
-
# specified,
|
4691
|
-
#
|
4692
|
-
# deleted. By default, skip is not specified, and the DB cluster
|
4693
|
-
# snapshot is created. By default, this parameter is disabled.
|
4678
|
+
# Determines whether a final DB cluster snapshot is created before the
|
4679
|
+
# DB cluster is deleted. If `true` is specified, no DB cluster snapshot
|
4680
|
+
# is created. If `false` is specified, a DB cluster snapshot is created
|
4681
|
+
# before the DB cluster is deleted.
|
4694
4682
|
#
|
4695
4683
|
# <note markdown="1"> You must specify a `FinalDBSnapshotIdentifier` parameter if
|
4696
|
-
# `SkipFinalSnapshot` is
|
4684
|
+
# `SkipFinalSnapshot` is `false`.
|
4697
4685
|
#
|
4698
4686
|
# </note>
|
4699
4687
|
#
|
4688
|
+
# Default: `false`
|
4689
|
+
#
|
4700
4690
|
# @option params [String] :final_db_snapshot_identifier
|
4701
4691
|
# The DB cluster snapshot identifier of the new DB cluster snapshot
|
4702
|
-
# created when `SkipFinalSnapshot` is
|
4692
|
+
# created when `SkipFinalSnapshot` is set to `false`.
|
4703
4693
|
#
|
4704
|
-
# <note markdown="1"> Specifying this parameter and also
|
4705
|
-
#
|
4706
|
-
# error.
|
4694
|
+
# <note markdown="1"> Specifying this parameter and also setting the `SkipFinalShapshot`
|
4695
|
+
# parameter to true results in an error.
|
4707
4696
|
#
|
4708
4697
|
# </note>
|
4709
4698
|
#
|
@@ -5022,8 +5011,8 @@ module Aws::RDS
|
|
5022
5011
|
#
|
5023
5012
|
# Note that when a DB instance is in a failure state and has a status of
|
5024
5013
|
# `failed`, `incompatible-restore`, or `incompatible-network`, you can
|
5025
|
-
# only delete it when
|
5026
|
-
# `
|
5014
|
+
# only delete it when the `SkipFinalSnapshot` parameter is set to
|
5015
|
+
# `true`.
|
5027
5016
|
#
|
5028
5017
|
# If the specified DB instance is part of an Amazon Aurora DB cluster,
|
5029
5018
|
# you can't delete the DB instance if both of the following conditions
|
@@ -5051,29 +5040,30 @@ module Aws::RDS
|
|
5051
5040
|
# ^
|
5052
5041
|
#
|
5053
5042
|
# @option params [Boolean] :skip_final_snapshot
|
5054
|
-
# A value that indicates whether
|
5055
|
-
#
|
5056
|
-
#
|
5057
|
-
#
|
5058
|
-
# specified, and the DB snapshot is created.
|
5043
|
+
# A value that indicates whether a final DB snapshot is created before
|
5044
|
+
# the DB instance is deleted. If `true` is specified, no DB snapshot is
|
5045
|
+
# created. If `false` is specified, a DB snapshot is created before the
|
5046
|
+
# DB instance is deleted.
|
5059
5047
|
#
|
5060
|
-
#
|
5061
|
-
#
|
5062
|
-
#
|
5048
|
+
# When a DB instance is in a failure state and has a status of `failed`,
|
5049
|
+
# `incompatible-restore`, or `incompatible-network`, you can only delete
|
5050
|
+
# it when the `SkipFinalSnapshot` parameter is set to `true`.
|
5063
5051
|
#
|
5064
|
-
# Specify
|
5052
|
+
# Specify `true` when deleting a Read Replica.
|
5065
5053
|
#
|
5066
|
-
# <note markdown="1"> The FinalDBSnapshotIdentifier parameter must be specified if
|
5067
|
-
#
|
5054
|
+
# <note markdown="1"> The `FinalDBSnapshotIdentifier` parameter must be specified if
|
5055
|
+
# `SkipFinalSnapshot` is `false`.
|
5068
5056
|
#
|
5069
5057
|
# </note>
|
5070
5058
|
#
|
5059
|
+
# Default: `false`
|
5060
|
+
#
|
5071
5061
|
# @option params [String] :final_db_snapshot_identifier
|
5072
|
-
# The `DBSnapshotIdentifier` of the new
|
5073
|
-
# `SkipFinalSnapshot`
|
5062
|
+
# The `DBSnapshotIdentifier` of the new DB snapshot created when
|
5063
|
+
# `SkipFinalSnapshot` is set to `false`.
|
5074
5064
|
#
|
5075
|
-
# <note markdown="1"> Specifying this parameter and also
|
5076
|
-
#
|
5065
|
+
# <note markdown="1"> Specifying this parameter and also setting the `SkipFinalShapshot`
|
5066
|
+
# parameter to `true` results in an error.
|
5077
5067
|
#
|
5078
5068
|
# </note>
|
5079
5069
|
#
|
@@ -5090,8 +5080,7 @@ module Aws::RDS
|
|
5090
5080
|
# @option params [Boolean] :delete_automated_backups
|
5091
5081
|
# A value that indicates whether to remove automated backups immediately
|
5092
5082
|
# after the DB instance is deleted. This parameter isn't
|
5093
|
-
# case-sensitive.
|
5094
|
-
# after the DB instance is deleted.
|
5083
|
+
# case-sensitive. This parameter defaults to `true`.
|
5095
5084
|
#
|
5096
5085
|
# @return [Types::DeleteDBInstanceResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
5097
5086
|
#
|
@@ -6314,9 +6303,9 @@ module Aws::RDS
|
|
6314
6303
|
#
|
6315
6304
|
# If you don't specify a `SnapshotType` value, then both automated and
|
6316
6305
|
# manual DB cluster snapshots are returned. You can include shared DB
|
6317
|
-
# cluster snapshots with these results by
|
6318
|
-
# parameter
|
6319
|
-
# results by
|
6306
|
+
# cluster snapshots with these results by setting the `IncludeShared`
|
6307
|
+
# parameter to `true`. You can include public DB cluster snapshots with
|
6308
|
+
# these results by setting the `IncludePublic` parameter to `true`.
|
6320
6309
|
#
|
6321
6310
|
# The `IncludeShared` and `IncludePublic` parameters don't apply for
|
6322
6311
|
# `SnapshotType` values of `manual` or `automated`. The `IncludePublic`
|
@@ -6344,22 +6333,21 @@ module Aws::RDS
|
|
6344
6333
|
# specified by `MaxRecords`.
|
6345
6334
|
#
|
6346
6335
|
# @option params [Boolean] :include_shared
|
6347
|
-
#
|
6348
|
-
#
|
6349
|
-
#
|
6350
|
-
# included.
|
6336
|
+
# True to include shared manual DB cluster snapshots from other AWS
|
6337
|
+
# accounts that this AWS account has been given permission to copy or
|
6338
|
+
# restore, and otherwise false. The default is `false`.
|
6351
6339
|
#
|
6352
6340
|
# You can give an AWS account permission to restore a manual DB cluster
|
6353
6341
|
# snapshot from another AWS account by the
|
6354
6342
|
# `ModifyDBClusterSnapshotAttribute` API action.
|
6355
6343
|
#
|
6356
6344
|
# @option params [Boolean] :include_public
|
6357
|
-
#
|
6358
|
-
#
|
6359
|
-
# default
|
6345
|
+
# True to include manual DB cluster snapshots that are public and can be
|
6346
|
+
# copied or restored by any AWS account, and otherwise false. The
|
6347
|
+
# default is `false`. The default is false.
|
6360
6348
|
#
|
6361
6349
|
# You can share a manual DB cluster snapshot as public by using the
|
6362
|
-
# ModifyDBClusterSnapshotAttribute API action.
|
6350
|
+
# `ModifyDBClusterSnapshotAttribute` API action.
|
6363
6351
|
#
|
6364
6352
|
# @return [Types::DBClusterSnapshotMessage] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
6365
6353
|
#
|
@@ -6635,25 +6623,23 @@ module Aws::RDS
|
|
6635
6623
|
# marker, up to the value specified by `MaxRecords`.
|
6636
6624
|
#
|
6637
6625
|
# @option params [Boolean] :default_only
|
6638
|
-
#
|
6639
|
-
#
|
6626
|
+
# Indicates that only the default version of the specified engine or
|
6627
|
+
# engine and major version combination is returned.
|
6640
6628
|
#
|
6641
6629
|
# @option params [Boolean] :list_supported_character_sets
|
6642
|
-
#
|
6643
|
-
# for each engine version.
|
6644
|
-
#
|
6645
|
-
# If this parameter is enabled and the requested engine supports the
|
6630
|
+
# If this parameter is specified and the requested engine supports the
|
6646
6631
|
# `CharacterSetName` parameter for `CreateDBInstance`, the response
|
6647
6632
|
# includes a list of supported character sets for each engine version.
|
6648
6633
|
#
|
6649
6634
|
# @option params [Boolean] :list_supported_timezones
|
6650
|
-
#
|
6651
|
-
# each engine version.
|
6652
|
-
#
|
6653
|
-
# If this parameter is enabled and the requested engine supports the
|
6635
|
+
# If this parameter is specified and the requested engine supports the
|
6654
6636
|
# `TimeZone` parameter for `CreateDBInstance`, the response includes a
|
6655
6637
|
# list of supported time zones for each engine version.
|
6656
6638
|
#
|
6639
|
+
# @option params [Boolean] :include_all
|
6640
|
+
# Whether to include non-available engine versions in the list. The
|
6641
|
+
# default is to list only available engine versions.
|
6642
|
+
#
|
6657
6643
|
# @return [Types::DBEngineVersionMessage] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
6658
6644
|
#
|
6659
6645
|
# * {Types::DBEngineVersionMessage#marker #marker} => String
|
@@ -6693,6 +6679,7 @@ module Aws::RDS
|
|
6693
6679
|
# default_only: false,
|
6694
6680
|
# list_supported_character_sets: false,
|
6695
6681
|
# list_supported_timezones: false,
|
6682
|
+
# include_all: false,
|
6696
6683
|
# })
|
6697
6684
|
#
|
6698
6685
|
# @example Response structure
|
@@ -6725,6 +6712,7 @@ module Aws::RDS
|
|
6725
6712
|
# resp.db_engine_versions[0].supported_engine_modes[0] #=> String
|
6726
6713
|
# resp.db_engine_versions[0].supported_feature_names #=> Array
|
6727
6714
|
# resp.db_engine_versions[0].supported_feature_names[0] #=> String
|
6715
|
+
# resp.db_engine_versions[0].status #=> String
|
6728
6716
|
#
|
6729
6717
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DescribeDBEngineVersions AWS API Documentation
|
6730
6718
|
#
|
@@ -7524,9 +7512,9 @@ module Aws::RDS
|
|
7524
7512
|
# If you don't specify a `SnapshotType` value, then both automated and
|
7525
7513
|
# manual snapshots are returned. Shared and public DB snapshots are not
|
7526
7514
|
# included in the returned results by default. You can include shared
|
7527
|
-
# snapshots with these results by
|
7528
|
-
#
|
7529
|
-
#
|
7515
|
+
# snapshots with these results by setting the `IncludeShared` parameter
|
7516
|
+
# to `true`. You can include public snapshots with these results by
|
7517
|
+
# setting the `IncludePublic` parameter to `true`.
|
7530
7518
|
#
|
7531
7519
|
# The `IncludeShared` and `IncludePublic` parameters don't apply for
|
7532
7520
|
# `SnapshotType` values of `manual` or `automated`. The `IncludePublic`
|
@@ -7558,22 +7546,21 @@ module Aws::RDS
|
|
7558
7546
|
# specified by `MaxRecords`.
|
7559
7547
|
#
|
7560
7548
|
# @option params [Boolean] :include_shared
|
7561
|
-
#
|
7562
|
-
#
|
7563
|
-
#
|
7564
|
-
# included.
|
7549
|
+
# True to include shared manual DB snapshots from other AWS accounts
|
7550
|
+
# that this AWS account has been given permission to copy or restore,
|
7551
|
+
# and otherwise false. The default is `false`.
|
7565
7552
|
#
|
7566
7553
|
# You can give an AWS account permission to restore a manual DB snapshot
|
7567
7554
|
# from another AWS account by using the `ModifyDBSnapshotAttribute` API
|
7568
7555
|
# action.
|
7569
7556
|
#
|
7570
7557
|
# @option params [Boolean] :include_public
|
7571
|
-
#
|
7572
|
-
#
|
7573
|
-
#
|
7558
|
+
# True to include manual DB snapshots that are public and can be copied
|
7559
|
+
# or restored by any AWS account, and otherwise false. The default is
|
7560
|
+
# false.
|
7574
7561
|
#
|
7575
7562
|
# You can share a manual DB snapshot as public by using the
|
7576
|
-
# ModifyDBSnapshotAttribute API.
|
7563
|
+
# `ModifyDBSnapshotAttribute` API.
|
7577
7564
|
#
|
7578
7565
|
# @option params [String] :dbi_resource_id
|
7579
7566
|
# A specific DB resource ID to describe.
|
@@ -8560,7 +8547,8 @@ module Aws::RDS
|
|
8560
8547
|
# the available offerings matching the specified license model.
|
8561
8548
|
#
|
8562
8549
|
# @option params [Boolean] :vpc
|
8563
|
-
#
|
8550
|
+
# The VPC filter value. Specify this parameter to show only the
|
8551
|
+
# available VPC or non-VPC offerings.
|
8564
8552
|
#
|
8565
8553
|
# @option params [Array<Types::Filter>] :filters
|
8566
8554
|
# This parameter is not currently supported.
|
@@ -8788,8 +8776,8 @@ module Aws::RDS
|
|
8788
8776
|
# Valid Values: `"Partial Upfront" | "All Upfront" | "No Upfront" `
|
8789
8777
|
#
|
8790
8778
|
# @option params [Boolean] :multi_az
|
8791
|
-
#
|
8792
|
-
#
|
8779
|
+
# The Multi-AZ filter value. Specify this parameter to show only those
|
8780
|
+
# reservations matching the specified Multi-AZ parameter.
|
8793
8781
|
#
|
8794
8782
|
# @option params [Array<Types::Filter>] :filters
|
8795
8783
|
# This parameter is not currently supported.
|
@@ -8918,8 +8906,8 @@ module Aws::RDS
|
|
8918
8906
|
# Valid Values: `"Partial Upfront" | "All Upfront" | "No Upfront" `
|
8919
8907
|
#
|
8920
8908
|
# @option params [Boolean] :multi_az
|
8921
|
-
#
|
8922
|
-
#
|
8909
|
+
# The Multi-AZ filter value. Specify this parameter to show only the
|
8910
|
+
# available offerings matching the specified Multi-AZ parameter.
|
8923
8911
|
#
|
8924
8912
|
# @option params [Array<Types::Filter>] :filters
|
8925
8913
|
# This parameter is not currently supported.
|
@@ -9535,7 +9523,7 @@ module Aws::RDS
|
|
9535
9523
|
#
|
9536
9524
|
# Constraints:
|
9537
9525
|
#
|
9538
|
-
# * Value must be `
|
9526
|
+
# * Value must be `2`, `4`, `8`, `16`, `32`, `64`, `128`, or `256`.
|
9539
9527
|
#
|
9540
9528
|
# ^
|
9541
9529
|
#
|
@@ -9631,22 +9619,22 @@ module Aws::RDS
|
|
9631
9619
|
# Example: `my-cluster2`
|
9632
9620
|
#
|
9633
9621
|
# @option params [Boolean] :apply_immediately
|
9634
|
-
# A value that
|
9622
|
+
# A value that specifies whether the modifications in this request and
|
9635
9623
|
# any pending modifications are asynchronously applied as soon as
|
9636
9624
|
# possible, regardless of the `PreferredMaintenanceWindow` setting for
|
9637
|
-
# the DB cluster. If this parameter is
|
9625
|
+
# the DB cluster. If this parameter is set to `false`, changes to the DB
|
9638
9626
|
# cluster are applied during the next maintenance window.
|
9639
9627
|
#
|
9640
9628
|
# The `ApplyImmediately` parameter only affects the
|
9641
9629
|
# `EnableIAMDatabaseAuthentication`, `MasterUserPassword`, and
|
9642
|
-
# `NewDBClusterIdentifier` values. If the `ApplyImmediately`
|
9643
|
-
#
|
9644
|
-
# `MasterUserPassword`, and
|
9645
|
-
#
|
9646
|
-
#
|
9647
|
-
# parameter.
|
9630
|
+
# `NewDBClusterIdentifier` values. If you set the `ApplyImmediately`
|
9631
|
+
# parameter value to false, then changes to the
|
9632
|
+
# `EnableIAMDatabaseAuthentication`, `MasterUserPassword`, and
|
9633
|
+
# `NewDBClusterIdentifier` values are applied during the next
|
9634
|
+
# maintenance window. All other changes are applied immediately,
|
9635
|
+
# regardless of the value of the `ApplyImmediately` parameter.
|
9648
9636
|
#
|
9649
|
-
#
|
9637
|
+
# Default: `false`
|
9650
9638
|
#
|
9651
9639
|
# @option params [Integer] :backup_retention_period
|
9652
9640
|
# The number of days for which automated backups are retained. You must
|
@@ -9683,11 +9671,11 @@ module Aws::RDS
|
|
9683
9671
|
# A value that indicates that the DB cluster should be associated with
|
9684
9672
|
# the specified option group. Changing this parameter doesn't result in
|
9685
9673
|
# an outage except in the following case, and the change is applied
|
9686
|
-
# during the next maintenance window unless the `ApplyImmediately`
|
9687
|
-
#
|
9688
|
-
# group that enables OEM, this change can cause a
|
9689
|
-
# period during which new connections are rejected
|
9690
|
-
# connections are not interrupted.
|
9674
|
+
# during the next maintenance window unless the `ApplyImmediately`
|
9675
|
+
# parameter is set to `true` for this request. If the parameter change
|
9676
|
+
# results in an option group that enables OEM, this change can cause a
|
9677
|
+
# brief (sub-second) period during which new connections are rejected
|
9678
|
+
# but existing connections are not interrupted.
|
9691
9679
|
#
|
9692
9680
|
# Permanent options can't be removed from an option group. The option
|
9693
9681
|
# group can't be removed from a DB cluster once it is associated with a
|
@@ -9737,9 +9725,10 @@ module Aws::RDS
|
|
9737
9725
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_UpgradeDBInstance.Maintenance.html#AdjustingTheMaintenanceWindow.Aurora
|
9738
9726
|
#
|
9739
9727
|
# @option params [Boolean] :enable_iam_database_authentication
|
9740
|
-
#
|
9741
|
-
#
|
9742
|
-
#
|
9728
|
+
# True to enable mapping of AWS Identity and Access Management (IAM)
|
9729
|
+
# accounts to database accounts, and otherwise false.
|
9730
|
+
#
|
9731
|
+
# Default: `false`
|
9743
9732
|
#
|
9744
9733
|
# @option params [Integer] :backtrack_window
|
9745
9734
|
# The target backtrack window, in seconds. To disable backtracking, set
|
@@ -9761,19 +9750,19 @@ module Aws::RDS
|
|
9761
9750
|
# @option params [String] :engine_version
|
9762
9751
|
# The version number of the database engine to which you want to
|
9763
9752
|
# upgrade. Changing this parameter results in an outage. The change is
|
9764
|
-
# applied during the next maintenance window unless
|
9765
|
-
# is
|
9753
|
+
# applied during the next maintenance window unless the ApplyImmediately
|
9754
|
+
# parameter is set to true.
|
9766
9755
|
#
|
9767
|
-
# For a list of valid engine versions, use
|
9756
|
+
# For a list of valid engine versions, use the
|
9757
|
+
# `DescribeDBEngineVersions` action.
|
9768
9758
|
#
|
9769
9759
|
# @option params [Types::ScalingConfiguration] :scaling_configuration
|
9770
9760
|
# The scaling properties of the DB cluster. You can only modify scaling
|
9771
9761
|
# properties for DB clusters in `serverless` DB engine mode.
|
9772
9762
|
#
|
9773
9763
|
# @option params [Boolean] :deletion_protection
|
9774
|
-
#
|
9775
|
-
#
|
9776
|
-
# enabled. By default, deletion protection is disabled.
|
9764
|
+
# Indicates if the DB cluster has deletion protection enabled. The
|
9765
|
+
# database can't be deleted when this value is set to true.
|
9777
9766
|
#
|
9778
9767
|
# @option params [Boolean] :enable_http_endpoint
|
9779
9768
|
# <note markdown="1"> HTTP endpoint functionality is in beta for Aurora Serverless and is
|
@@ -9798,8 +9787,8 @@ module Aws::RDS
|
|
9798
9787
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless.html
|
9799
9788
|
#
|
9800
9789
|
# @option params [Boolean] :copy_tags_to_snapshot
|
9801
|
-
#
|
9802
|
-
#
|
9790
|
+
# True to copy all tags from the DB cluster to snapshots of the DB
|
9791
|
+
# cluster, and otherwise false. The default is false.
|
9803
9792
|
#
|
9804
9793
|
# @return [Types::ModifyDBClusterResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
9805
9794
|
#
|
@@ -10249,7 +10238,7 @@ module Aws::RDS
|
|
10249
10238
|
#
|
10250
10239
|
# If you modify the DB instance class, an outage occurs during the
|
10251
10240
|
# change. The change is applied during the next maintenance window,
|
10252
|
-
# unless `ApplyImmediately` is
|
10241
|
+
# unless `ApplyImmediately` is specified as `true` for this request.
|
10253
10242
|
#
|
10254
10243
|
# Default: Uses existing setting
|
10255
10244
|
#
|
@@ -10266,7 +10255,7 @@ module Aws::RDS
|
|
10266
10255
|
#
|
10267
10256
|
# Changing the subnet group causes an outage during the change. The
|
10268
10257
|
# change is applied during the next maintenance window, unless you
|
10269
|
-
#
|
10258
|
+
# specify `true` for the `ApplyImmediately` parameter.
|
10270
10259
|
#
|
10271
10260
|
# Constraints: If supplied, must match the name of an existing
|
10272
10261
|
# DBSubnetGroup.
|
@@ -10305,18 +10294,21 @@ module Aws::RDS
|
|
10305
10294
|
# ^
|
10306
10295
|
#
|
10307
10296
|
# @option params [Boolean] :apply_immediately
|
10308
|
-
#
|
10309
|
-
#
|
10310
|
-
#
|
10311
|
-
#
|
10297
|
+
# Specifies whether the modifications in this request and any pending
|
10298
|
+
# modifications are asynchronously applied as soon as possible,
|
10299
|
+
# regardless of the `PreferredMaintenanceWindow` setting for the DB
|
10300
|
+
# instance.
|
10312
10301
|
#
|
10313
|
-
# If this parameter is
|
10314
|
-
# during the next maintenance window. Some parameter changes can
|
10315
|
-
# an outage and are applied on the next call to
|
10316
|
-
# next failure reboot. Review the table of
|
10317
|
-
#
|
10318
|
-
#
|
10319
|
-
#
|
10302
|
+
# If this parameter is set to `false`, changes to the DB instance are
|
10303
|
+
# applied during the next maintenance window. Some parameter changes can
|
10304
|
+
# cause an outage and are applied on the next call to
|
10305
|
+
# `RebootDBInstance`, or the next failure reboot. Review the table of
|
10306
|
+
# parameters in [Modifying a DB Instance and Using the Apply Immediately
|
10307
|
+
# Parameter][1] in the *Amazon RDS User Guide.* to see the impact that
|
10308
|
+
# setting `ApplyImmediately` to `true` or `false` has for each modified
|
10309
|
+
# parameter and to determine when the changes are applied.
|
10310
|
+
#
|
10311
|
+
# Default: `false`
|
10320
10312
|
#
|
10321
10313
|
#
|
10322
10314
|
#
|
@@ -10388,7 +10380,7 @@ module Aws::RDS
|
|
10388
10380
|
# Changing this parameter can result in an outage if you change from 0
|
10389
10381
|
# to a non-zero value or from a non-zero value to 0. These changes are
|
10390
10382
|
# applied during the next maintenance window unless the
|
10391
|
-
# `ApplyImmediately` parameter is
|
10383
|
+
# `ApplyImmediately` parameter is set to `true` for this request. If you
|
10392
10384
|
# change the parameter from one non-zero value to another non-zero
|
10393
10385
|
# value, the change is asynchronously applied as soon as possible.
|
10394
10386
|
#
|
@@ -10454,16 +10446,16 @@ module Aws::RDS
|
|
10454
10446
|
# Constraints: Must be at least 30 minutes
|
10455
10447
|
#
|
10456
10448
|
# @option params [Boolean] :multi_az
|
10457
|
-
#
|
10458
|
-
#
|
10459
|
-
#
|
10460
|
-
#
|
10449
|
+
# Specifies if the DB instance is a Multi-AZ deployment. Changing this
|
10450
|
+
# parameter doesn't result in an outage and the change is applied
|
10451
|
+
# during the next maintenance window unless the `ApplyImmediately`
|
10452
|
+
# parameter is set to `true` for this request.
|
10461
10453
|
#
|
10462
10454
|
# @option params [String] :engine_version
|
10463
10455
|
# The version number of the database engine to upgrade to. Changing this
|
10464
10456
|
# parameter results in an outage and the change is applied during the
|
10465
|
-
# next maintenance window unless the `ApplyImmediately` parameter is
|
10466
|
-
#
|
10457
|
+
# next maintenance window unless the `ApplyImmediately` parameter is set
|
10458
|
+
# to `true` for this request.
|
10467
10459
|
#
|
10468
10460
|
# For major version upgrades, if a nondefault DB parameter group is
|
10469
10461
|
# currently in use, a new DB parameter group in the DB parameter group
|
@@ -10474,22 +10466,22 @@ module Aws::RDS
|
|
10474
10466
|
# or call `DescribeDBEngineVersions`.
|
10475
10467
|
#
|
10476
10468
|
# @option params [Boolean] :allow_major_version_upgrade
|
10477
|
-
#
|
10478
|
-
#
|
10469
|
+
# Indicates that major version upgrades are allowed. Changing this
|
10470
|
+
# parameter doesn't result in an outage and the change is
|
10479
10471
|
# asynchronously applied as soon as possible.
|
10480
10472
|
#
|
10481
|
-
# Constraints:
|
10473
|
+
# Constraints: This parameter must be set to true when specifying a
|
10482
10474
|
# value for the EngineVersion parameter that is a different major
|
10483
10475
|
# version than the DB instance's current version.
|
10484
10476
|
#
|
10485
10477
|
# @option params [Boolean] :auto_minor_version_upgrade
|
10486
|
-
#
|
10487
|
-
#
|
10488
|
-
#
|
10489
|
-
#
|
10490
|
-
#
|
10491
|
-
#
|
10492
|
-
#
|
10478
|
+
# Indicates that minor version upgrades are applied automatically to the
|
10479
|
+
# DB instance during the maintenance window. Changing this parameter
|
10480
|
+
# doesn't result in an outage except in the following case and the
|
10481
|
+
# change is asynchronously applied as soon as possible. An outage will
|
10482
|
+
# result if this parameter is set to `true` during the maintenance
|
10483
|
+
# window, and a newer minor version is available, and RDS has enabled
|
10484
|
+
# auto patching for that engine version.
|
10493
10485
|
#
|
10494
10486
|
# @option params [String] :license_model
|
10495
10487
|
# The license model for the DB instance.
|
@@ -10503,10 +10495,10 @@ module Aws::RDS
|
|
10503
10495
|
#
|
10504
10496
|
# Changing this setting doesn't result in an outage and the change is
|
10505
10497
|
# applied during the next maintenance window unless the
|
10506
|
-
# `ApplyImmediately` parameter is
|
10507
|
-
# migrating from Provisioned IOPS to standard storage, set this
|
10508
|
-
# 0. The DB instance will require a reboot for the change in
|
10509
|
-
# type to take effect.
|
10498
|
+
# `ApplyImmediately` parameter is set to `true` for this request. If you
|
10499
|
+
# are migrating from Provisioned IOPS to standard storage, set this
|
10500
|
+
# value to 0. The DB instance will require a reboot for the change in
|
10501
|
+
# storage type to take effect.
|
10510
10502
|
#
|
10511
10503
|
# If you choose to migrate your DB instance from using standard storage
|
10512
10504
|
# to using Provisioned IOPS, or from using Provisioned IOPS to using
|
@@ -10534,11 +10526,11 @@ module Aws::RDS
|
|
10534
10526
|
# Indicates that the DB instance should be associated with the specified
|
10535
10527
|
# option group. Changing this parameter doesn't result in an outage
|
10536
10528
|
# except in the following case and the change is applied during the next
|
10537
|
-
# maintenance window unless the `ApplyImmediately` parameter is
|
10538
|
-
# for this request. If the parameter change results in an option
|
10539
|
-
# that enables OEM, this change can cause a brief (sub-second)
|
10540
|
-
# during which new connections are rejected but existing
|
10541
|
-
# not interrupted.
|
10529
|
+
# maintenance window unless the `ApplyImmediately` parameter is set to
|
10530
|
+
# `true` for this request. If the parameter change results in an option
|
10531
|
+
# group that enables OEM, this change can cause a brief (sub-second)
|
10532
|
+
# period during which new connections are rejected but existing
|
10533
|
+
# connections are not interrupted.
|
10542
10534
|
#
|
10543
10535
|
# Permanent options, such as the TDE option for Oracle Advanced Security
|
10544
10536
|
# TDE, can't be removed from an option group, and that option group
|
@@ -10548,9 +10540,9 @@ module Aws::RDS
|
|
10548
10540
|
# @option params [String] :new_db_instance_identifier
|
10549
10541
|
# The new DB instance identifier for the DB instance when renaming a DB
|
10550
10542
|
# instance. When you change the DB instance identifier, an instance
|
10551
|
-
# reboot
|
10552
|
-
# occur during the next maintenance window if
|
10553
|
-
# Immediately. This value is stored as a lowercase string.
|
10543
|
+
# reboot will occur immediately if you set `Apply Immediately` to true,
|
10544
|
+
# or will occur during the next maintenance window if `Apply
|
10545
|
+
# Immediately` to false. This value is stored as a lowercase string.
|
10554
10546
|
#
|
10555
10547
|
# Constraints:
|
10556
10548
|
#
|
@@ -10585,7 +10577,8 @@ module Aws::RDS
|
|
10585
10577
|
#
|
10586
10578
|
# Valid values: `standard | gp2 | io1`
|
10587
10579
|
#
|
10588
|
-
# Default: `io1` if the `Iops` parameter is specified, otherwise
|
10580
|
+
# Default: `io1` if the `Iops` parameter is specified, otherwise
|
10581
|
+
# `standard`
|
10589
10582
|
#
|
10590
10583
|
# @option params [String] :tde_credential_arn
|
10591
10584
|
# The ARN from the key store with which to associate the instance for
|
@@ -10606,8 +10599,8 @@ module Aws::RDS
|
|
10606
10599
|
# instance can be created in a Active Directory Domain.
|
10607
10600
|
#
|
10608
10601
|
# @option params [Boolean] :copy_tags_to_snapshot
|
10609
|
-
#
|
10610
|
-
#
|
10602
|
+
# True to copy all tags from the DB instance to snapshots of the DB
|
10603
|
+
# instance, and otherwise false. The default is false.
|
10611
10604
|
#
|
10612
10605
|
# **Amazon Aurora**
|
10613
10606
|
#
|
@@ -10675,20 +10668,21 @@ module Aws::RDS
|
|
10675
10668
|
# Valid Values: `1150-65535`
|
10676
10669
|
#
|
10677
10670
|
# @option params [Boolean] :publicly_accessible
|
10678
|
-
#
|
10679
|
-
#
|
10680
|
-
#
|
10681
|
-
# public IP address.
|
10682
|
-
#
|
10683
|
-
# address.
|
10671
|
+
# Boolean value that indicates if the DB instance has a publicly
|
10672
|
+
# resolvable DNS name. Set to `True` to make the DB instance
|
10673
|
+
# Internet-facing with a publicly resolvable DNS name, which resolves to
|
10674
|
+
# a public IP address. Set to `False` to make the DB instance internal
|
10675
|
+
# with a DNS name that resolves to a private IP address.
|
10684
10676
|
#
|
10685
10677
|
# `PubliclyAccessible` only applies to DB instances in a VPC. The DB
|
10686
10678
|
# instance must be part of a public subnet and `PubliclyAccessible` must
|
10687
|
-
# be
|
10679
|
+
# be true in order for it to be publicly accessible.
|
10688
10680
|
#
|
10689
10681
|
# Changes to the `PubliclyAccessible` parameter are applied immediately
|
10690
10682
|
# regardless of the value of the `ApplyImmediately` parameter.
|
10691
10683
|
#
|
10684
|
+
# Default: false
|
10685
|
+
#
|
10692
10686
|
# @option params [String] :monitoring_role_arn
|
10693
10687
|
# The ARN for the IAM role that permits RDS to send enhanced monitoring
|
10694
10688
|
# metrics to Amazon CloudWatch Logs. For example,
|
@@ -10722,9 +10716,8 @@ module Aws::RDS
|
|
10722
10716
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Managing.Backups.html#Aurora.Managing.FaultTolerance
|
10723
10717
|
#
|
10724
10718
|
# @option params [Boolean] :enable_iam_database_authentication
|
10725
|
-
#
|
10726
|
-
#
|
10727
|
-
# mapping is disabled.
|
10719
|
+
# True to enable mapping of AWS Identity and Access Management (IAM)
|
10720
|
+
# accounts to database accounts, and otherwise false.
|
10728
10721
|
#
|
10729
10722
|
# You can enable IAM database authentication for the following database
|
10730
10723
|
# engines
|
@@ -10741,9 +10734,11 @@ module Aws::RDS
|
|
10741
10734
|
#
|
10742
10735
|
# * For MySQL 5.7, minor version 5.7.16 or higher
|
10743
10736
|
#
|
10737
|
+
# Default: `false`
|
10738
|
+
#
|
10744
10739
|
# @option params [Boolean] :enable_performance_insights
|
10745
|
-
#
|
10746
|
-
#
|
10740
|
+
# True to enable Performance Insights for the DB instance, and otherwise
|
10741
|
+
# false.
|
10747
10742
|
#
|
10748
10743
|
# For more information, see [Using Amazon Performance Insights][1] in
|
10749
10744
|
# the *Amazon Relational Database Service User Guide*.
|
@@ -10757,11 +10752,6 @@ module Aws::RDS
|
|
10757
10752
|
# data. The KMS key ID is the Amazon Resource Name (ARN), KMS key
|
10758
10753
|
# identifier, or the KMS key alias for the KMS encryption key.
|
10759
10754
|
#
|
10760
|
-
# If you do not specify a value for `PerformanceInsightsKMSKeyId`, then
|
10761
|
-
# Amazon RDS uses your default encryption key. AWS KMS creates the
|
10762
|
-
# default encryption key for your AWS account. Your AWS account has a
|
10763
|
-
# different default encryption key for each AWS Region.
|
10764
|
-
#
|
10765
10755
|
# @option params [Integer] :performance_insights_retention_period
|
10766
10756
|
# The amount of time, in days, to retain Performance Insights data.
|
10767
10757
|
# Valid values are 7 or 731 (2 years).
|
@@ -10779,13 +10769,12 @@ module Aws::RDS
|
|
10779
10769
|
# instance class of the DB instance.
|
10780
10770
|
#
|
10781
10771
|
# @option params [Boolean] :use_default_processor_features
|
10782
|
-
# A value that
|
10783
|
-
#
|
10772
|
+
# A value that specifies that the DB instance class of the DB instance
|
10773
|
+
# uses its default processor features.
|
10784
10774
|
#
|
10785
10775
|
# @option params [Boolean] :deletion_protection
|
10786
|
-
#
|
10787
|
-
#
|
10788
|
-
# enabled. By default, deletion protection is disabled. For more
|
10776
|
+
# Indicates if the DB instance has deletion protection enabled. The
|
10777
|
+
# database can't be deleted when this value is set to true. For more
|
10789
10778
|
# information, see [ Deleting a DB Instance][1].
|
10790
10779
|
#
|
10791
10780
|
#
|
@@ -11409,7 +11398,7 @@ module Aws::RDS
|
|
11409
11398
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Events.html
|
11410
11399
|
#
|
11411
11400
|
# @option params [Boolean] :enabled
|
11412
|
-
# A value
|
11401
|
+
# A Boolean value; set to **true** to activate the subscription.
|
11413
11402
|
#
|
11414
11403
|
# @return [Types::ModifyEventSubscriptionResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
11415
11404
|
#
|
@@ -11511,8 +11500,8 @@ module Aws::RDS
|
|
11511
11500
|
#
|
11512
11501
|
# @option params [Boolean] :deletion_protection
|
11513
11502
|
# Indicates if the global database cluster has deletion protection
|
11514
|
-
# enabled. The global database cluster can't be deleted when
|
11515
|
-
#
|
11503
|
+
# enabled. The global database cluster can't be deleted when this value
|
11504
|
+
# is set to true.
|
11516
11505
|
#
|
11517
11506
|
# @return [Types::ModifyGlobalClusterResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
11518
11507
|
#
|
@@ -11571,9 +11560,9 @@ module Aws::RDS
|
|
11571
11560
|
# Options in this list are removed from the option group.
|
11572
11561
|
#
|
11573
11562
|
# @option params [Boolean] :apply_immediately
|
11574
|
-
#
|
11575
|
-
#
|
11576
|
-
#
|
11563
|
+
# Indicates whether the changes should be applied immediately, or during
|
11564
|
+
# the next maintenance window for each instance associated with the
|
11565
|
+
# option group.
|
11577
11566
|
#
|
11578
11567
|
# @return [Types::ModifyOptionGroupResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
11579
11568
|
#
|
@@ -12112,11 +12101,10 @@ module Aws::RDS
|
|
12112
12101
|
# ^
|
12113
12102
|
#
|
12114
12103
|
# @option params [Boolean] :force_failover
|
12115
|
-
#
|
12116
|
-
# Multi-AZ failover.
|
12104
|
+
# When `true`, the reboot is conducted through a MultiAZ failover.
|
12117
12105
|
#
|
12118
|
-
# Constraint: You can't
|
12119
|
-
# configured for
|
12106
|
+
# Constraint: You can't specify `true` if the instance is not
|
12107
|
+
# configured for MultiAZ.
|
12120
12108
|
#
|
12121
12109
|
# @return [Types::RebootDBInstanceResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
12122
12110
|
#
|
@@ -12545,15 +12533,15 @@ module Aws::RDS
|
|
12545
12533
|
# The name of the DB cluster parameter group to reset.
|
12546
12534
|
#
|
12547
12535
|
# @option params [Boolean] :reset_all_parameters
|
12548
|
-
# A value that
|
12549
|
-
# cluster parameter group to their default values
|
12550
|
-
# parameter if there is a list of
|
12551
|
-
# `Parameters` parameter.
|
12536
|
+
# A value that is set to `true` to reset all parameters in the DB
|
12537
|
+
# cluster parameter group to their default values, and `false`
|
12538
|
+
# otherwise. You can't use this parameter if there is a list of
|
12539
|
+
# parameter names specified for the `Parameters` parameter.
|
12552
12540
|
#
|
12553
12541
|
# @option params [Array<Types::Parameter>] :parameters
|
12554
12542
|
# A list of parameter names in the DB cluster parameter group to reset
|
12555
12543
|
# to the default values. You can't use this parameter if the
|
12556
|
-
# `ResetAllParameters` parameter is
|
12544
|
+
# `ResetAllParameters` parameter is set to `true`.
|
12557
12545
|
#
|
12558
12546
|
# @return [Types::DBClusterParameterGroupNameMessage] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
12559
12547
|
#
|
@@ -12627,9 +12615,10 @@ module Aws::RDS
|
|
12627
12615
|
# ^
|
12628
12616
|
#
|
12629
12617
|
# @option params [Boolean] :reset_all_parameters
|
12630
|
-
#
|
12631
|
-
# parameter group to default values.
|
12632
|
-
#
|
12618
|
+
# Specifies whether (`true`) or not (`false`) to reset all parameters in
|
12619
|
+
# the DB parameter group to default values.
|
12620
|
+
#
|
12621
|
+
# Default: `true`
|
12633
12622
|
#
|
12634
12623
|
# @option params [Array<Types::Parameter>] :parameters
|
12635
12624
|
# To reset the entire DB parameter group, specify the `DBParameterGroup`
|
@@ -12886,7 +12875,7 @@ module Aws::RDS
|
|
12886
12875
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html
|
12887
12876
|
#
|
12888
12877
|
# @option params [Boolean] :storage_encrypted
|
12889
|
-
#
|
12878
|
+
# Specifies whether the restored DB cluster is encrypted.
|
12890
12879
|
#
|
12891
12880
|
# @option params [String] :kms_key_id
|
12892
12881
|
# The AWS KMS key identifier for an encrypted DB cluster.
|
@@ -12897,16 +12886,17 @@ module Aws::RDS
|
|
12897
12886
|
# cluster, then you can use the KMS key alias instead of the ARN for the
|
12898
12887
|
# KM encryption key.
|
12899
12888
|
#
|
12900
|
-
# If the StorageEncrypted parameter is
|
12889
|
+
# If the `StorageEncrypted` parameter is true, and you do not specify a
|
12901
12890
|
# value for the `KmsKeyId` parameter, then Amazon RDS will use your
|
12902
12891
|
# default encryption key. AWS KMS creates the default encryption key for
|
12903
12892
|
# your AWS account. Your AWS account has a different default encryption
|
12904
12893
|
# key for each AWS Region.
|
12905
12894
|
#
|
12906
12895
|
# @option params [Boolean] :enable_iam_database_authentication
|
12907
|
-
#
|
12908
|
-
#
|
12909
|
-
#
|
12896
|
+
# True to enable mapping of AWS Identity and Access Management (IAM)
|
12897
|
+
# accounts to database accounts, and otherwise false.
|
12898
|
+
#
|
12899
|
+
# Default: `false`
|
12910
12900
|
#
|
12911
12901
|
# @option params [required, String] :source_engine
|
12912
12902
|
# The identifier for the database engine that was backed up to create
|
@@ -12960,14 +12950,13 @@ module Aws::RDS
|
|
12960
12950
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch
|
12961
12951
|
#
|
12962
12952
|
# @option params [Boolean] :deletion_protection
|
12963
|
-
#
|
12964
|
-
#
|
12965
|
-
#
|
12953
|
+
# Indicates if the DB cluster should have deletion protection enabled.
|
12954
|
+
# The database can't be deleted when this value is set to true. The
|
12955
|
+
# default is false.
|
12966
12956
|
#
|
12967
12957
|
# @option params [Boolean] :copy_tags_to_snapshot
|
12968
|
-
#
|
12969
|
-
#
|
12970
|
-
# copy them.
|
12958
|
+
# True to copy all tags from the restored DB cluster to snapshots of the
|
12959
|
+
# restored DB cluster, and otherwise false. The default is false.
|
12971
12960
|
#
|
12972
12961
|
# @return [Types::RestoreDBClusterFromS3Result] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
12973
12962
|
#
|
@@ -13201,9 +13190,10 @@ module Aws::RDS
|
|
13201
13190
|
# not encrypted, then the restored DB cluster is not encrypted.
|
13202
13191
|
#
|
13203
13192
|
# @option params [Boolean] :enable_iam_database_authentication
|
13204
|
-
#
|
13205
|
-
#
|
13206
|
-
#
|
13193
|
+
# True to enable mapping of AWS Identity and Access Management (IAM)
|
13194
|
+
# accounts to database accounts, and otherwise false.
|
13195
|
+
#
|
13196
|
+
# Default: `false`
|
13207
13197
|
#
|
13208
13198
|
# @option params [Integer] :backtrack_window
|
13209
13199
|
# The target backtrack window, in seconds. To disable backtracking, set
|
@@ -13253,14 +13243,13 @@ module Aws::RDS
|
|
13253
13243
|
# * Can't end with a hyphen or contain two consecutive hyphens.
|
13254
13244
|
#
|
13255
13245
|
# @option params [Boolean] :deletion_protection
|
13256
|
-
#
|
13257
|
-
#
|
13258
|
-
#
|
13246
|
+
# Indicates if the DB cluster should have deletion protection enabled.
|
13247
|
+
# The database can't be deleted when this value is set to true. The
|
13248
|
+
# default is false.
|
13259
13249
|
#
|
13260
13250
|
# @option params [Boolean] :copy_tags_to_snapshot
|
13261
|
-
#
|
13262
|
-
#
|
13263
|
-
# copy them.
|
13251
|
+
# True to copy all tags from the restored DB cluster to snapshots of the
|
13252
|
+
# restored DB cluster, and otherwise false. The default is false.
|
13264
13253
|
#
|
13265
13254
|
# @return [Types::RestoreDBClusterFromSnapshotResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
13266
13255
|
#
|
@@ -13472,18 +13461,17 @@ module Aws::RDS
|
|
13472
13461
|
# * Must be specified if `UseLatestRestorableTime` parameter is not
|
13473
13462
|
# provided
|
13474
13463
|
#
|
13475
|
-
# * Can't be specified if
|
13476
|
-
# enabled
|
13464
|
+
# * Can't be specified if `UseLatestRestorableTime` parameter is true
|
13477
13465
|
#
|
13478
|
-
# * Can't be specified if
|
13479
|
-
# `copy-on-write`
|
13466
|
+
# * Can't be specified if `RestoreType` parameter is `copy-on-write`
|
13480
13467
|
#
|
13481
13468
|
# Example: `2015-03-07T23:45:00Z`
|
13482
13469
|
#
|
13483
13470
|
# @option params [Boolean] :use_latest_restorable_time
|
13484
|
-
# A value that
|
13485
|
-
# restorable backup time
|
13486
|
-
#
|
13471
|
+
# A value that is set to `true` to restore the DB cluster to the latest
|
13472
|
+
# restorable backup time, and `false` otherwise.
|
13473
|
+
#
|
13474
|
+
# Default: `false`
|
13487
13475
|
#
|
13488
13476
|
# Constraints: Can't be specified if `RestoreToTime` parameter is
|
13489
13477
|
# provided.
|
@@ -13546,9 +13534,10 @@ module Aws::RDS
|
|
13546
13534
|
# then the restore request is rejected.
|
13547
13535
|
#
|
13548
13536
|
# @option params [Boolean] :enable_iam_database_authentication
|
13549
|
-
#
|
13550
|
-
#
|
13551
|
-
#
|
13537
|
+
# True to enable mapping of AWS Identity and Access Management (IAM)
|
13538
|
+
# accounts to database accounts, and otherwise false.
|
13539
|
+
#
|
13540
|
+
# Default: `false`
|
13552
13541
|
#
|
13553
13542
|
# @option params [Integer] :backtrack_window
|
13554
13543
|
# The target backtrack window, in seconds. To disable backtracking, set
|
@@ -13590,14 +13579,13 @@ module Aws::RDS
|
|
13590
13579
|
# * Can't end with a hyphen or contain two consecutive hyphens.
|
13591
13580
|
#
|
13592
13581
|
# @option params [Boolean] :deletion_protection
|
13593
|
-
#
|
13594
|
-
#
|
13595
|
-
#
|
13582
|
+
# Indicates if the DB cluster should have deletion protection enabled.
|
13583
|
+
# The database can't be deleted when this value is set to true. The
|
13584
|
+
# default is false.
|
13596
13585
|
#
|
13597
13586
|
# @option params [Boolean] :copy_tags_to_snapshot
|
13598
|
-
#
|
13599
|
-
#
|
13600
|
-
# copy them.
|
13587
|
+
# True to copy all tags from the restored DB cluster to snapshots of the
|
13588
|
+
# restored DB cluster, and otherwise false. The default is false.
|
13601
13589
|
#
|
13602
13590
|
# @return [Types::RestoreDBClusterToPointInTimeResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
13603
13591
|
#
|
@@ -13800,8 +13788,8 @@ module Aws::RDS
|
|
13800
13788
|
#
|
13801
13789
|
# Default: A random, system-chosen Availability Zone.
|
13802
13790
|
#
|
13803
|
-
# Constraint: You can't specify the
|
13804
|
-
#
|
13791
|
+
# Constraint: You can't specify the AvailabilityZone parameter if the
|
13792
|
+
# MultiAZ parameter is set to `true`.
|
13805
13793
|
#
|
13806
13794
|
# Example: `us-east-1a`
|
13807
13795
|
#
|
@@ -13814,23 +13802,21 @@ module Aws::RDS
|
|
13814
13802
|
# Example: `mySubnetgroup`
|
13815
13803
|
#
|
13816
13804
|
# @option params [Boolean] :multi_az
|
13817
|
-
#
|
13818
|
-
# deployment.
|
13805
|
+
# Specifies if the DB instance is a Multi-AZ deployment.
|
13819
13806
|
#
|
13820
|
-
# Constraint: You can't specify the
|
13821
|
-
#
|
13807
|
+
# Constraint: You can't specify the AvailabilityZone parameter if the
|
13808
|
+
# MultiAZ parameter is set to `true`.
|
13822
13809
|
#
|
13823
13810
|
# @option params [Boolean] :publicly_accessible
|
13824
|
-
#
|
13825
|
-
#
|
13826
|
-
#
|
13827
|
-
#
|
13828
|
-
#
|
13829
|
-
# address. For more information, see CreateDBInstance.
|
13811
|
+
# Specifies the accessibility options for the DB instance. A value of
|
13812
|
+
# true specifies an Internet-facing instance with a publicly resolvable
|
13813
|
+
# DNS name, which resolves to a public IP address. A value of false
|
13814
|
+
# specifies an internal instance with a DNS name that resolves to a
|
13815
|
+
# private IP address. For more information, see `CreateDBInstance`.
|
13830
13816
|
#
|
13831
13817
|
# @option params [Boolean] :auto_minor_version_upgrade
|
13832
|
-
#
|
13833
|
-
#
|
13818
|
+
# Indicates that minor version upgrades are applied automatically to the
|
13819
|
+
# DB instance during the maintenance window.
|
13834
13820
|
#
|
13835
13821
|
# @option params [String] :license_model
|
13836
13822
|
# License model information for the restored DB instance.
|
@@ -13924,7 +13910,8 @@ module Aws::RDS
|
|
13924
13910
|
# If you specify `io1`, you must also include a value for the `Iops`
|
13925
13911
|
# parameter.
|
13926
13912
|
#
|
13927
|
-
# Default: `io1` if the `Iops` parameter is specified, otherwise
|
13913
|
+
# Default: `io1` if the `Iops` parameter is specified, otherwise
|
13914
|
+
# `standard`
|
13928
13915
|
#
|
13929
13916
|
# @option params [String] :tde_credential_arn
|
13930
13917
|
# The ARN from the key store with which to associate the instance for
|
@@ -13944,18 +13931,16 @@ module Aws::RDS
|
|
13944
13931
|
# Specify the Active Directory Domain to restore the instance in.
|
13945
13932
|
#
|
13946
13933
|
# @option params [Boolean] :copy_tags_to_snapshot
|
13947
|
-
#
|
13948
|
-
#
|
13949
|
-
# copied.
|
13934
|
+
# True to copy all tags from the restored DB instance to snapshots of
|
13935
|
+
# the restored DB instance, and otherwise false. The default is false.
|
13950
13936
|
#
|
13951
13937
|
# @option params [String] :domain_iam_role_name
|
13952
13938
|
# Specify the name of the IAM role to be used when making API calls to
|
13953
13939
|
# the Directory Service.
|
13954
13940
|
#
|
13955
13941
|
# @option params [Boolean] :enable_iam_database_authentication
|
13956
|
-
#
|
13957
|
-
#
|
13958
|
-
# mapping is disabled.
|
13942
|
+
# True to enable mapping of AWS Identity and Access Management (IAM)
|
13943
|
+
# accounts to database accounts, and otherwise false.
|
13959
13944
|
#
|
13960
13945
|
# You can enable IAM database authentication for the following database
|
13961
13946
|
# engines
|
@@ -13964,6 +13949,8 @@ module Aws::RDS
|
|
13964
13949
|
#
|
13965
13950
|
# * For MySQL 5.7, minor version 5.7.16 or higher
|
13966
13951
|
#
|
13952
|
+
# Default: `false`
|
13953
|
+
#
|
13967
13954
|
# @option params [Array<String>] :enable_cloudwatch_logs_exports
|
13968
13955
|
# The list of logs that the restored DB instance is to export to
|
13969
13956
|
# CloudWatch Logs. The values in the list depend on the DB engine being
|
@@ -13979,8 +13966,8 @@ module Aws::RDS
|
|
13979
13966
|
# instance class of the DB instance.
|
13980
13967
|
#
|
13981
13968
|
# @option params [Boolean] :use_default_processor_features
|
13982
|
-
# A value that
|
13983
|
-
#
|
13969
|
+
# A value that specifies that the DB instance class of the DB instance
|
13970
|
+
# uses its default processor features.
|
13984
13971
|
#
|
13985
13972
|
# @option params [String] :db_parameter_group_name
|
13986
13973
|
# The name of the DB parameter group to associate with this DB instance.
|
@@ -13998,10 +13985,10 @@ module Aws::RDS
|
|
13998
13985
|
# * Can't end with a hyphen or contain two consecutive hyphens.
|
13999
13986
|
#
|
14000
13987
|
# @option params [Boolean] :deletion_protection
|
14001
|
-
#
|
14002
|
-
#
|
14003
|
-
#
|
14004
|
-
#
|
13988
|
+
# Indicates if the DB instance should have deletion protection enabled.
|
13989
|
+
# The database can't be deleted when this value is set to true. The
|
13990
|
+
# default is false. For more information, see [ Deleting a DB
|
13991
|
+
# Instance][1].
|
14005
13992
|
#
|
14006
13993
|
#
|
14007
13994
|
#
|
@@ -14366,9 +14353,9 @@ module Aws::RDS
|
|
14366
14353
|
#
|
14367
14354
|
# Example: `us-east-1d`
|
14368
14355
|
#
|
14369
|
-
# Constraint: The
|
14370
|
-
#
|
14371
|
-
#
|
14356
|
+
# Constraint: The AvailabilityZone parameter can't be specified if the
|
14357
|
+
# MultiAZ parameter is set to `true`. The specified Availability Zone
|
14358
|
+
# must be in the same AWS Region as the current endpoint.
|
14372
14359
|
#
|
14373
14360
|
#
|
14374
14361
|
#
|
@@ -14437,9 +14424,8 @@ module Aws::RDS
|
|
14437
14424
|
# Default: `3306`
|
14438
14425
|
#
|
14439
14426
|
# @option params [Boolean] :multi_az
|
14440
|
-
#
|
14441
|
-
#
|
14442
|
-
# set the `AvailabilityZone` parameter.
|
14427
|
+
# Specifies whether the DB instance is a Multi-AZ deployment. If MultiAZ
|
14428
|
+
# is set to `true`, you can't set the AvailabilityZone parameter.
|
14443
14429
|
#
|
14444
14430
|
# @option params [String] :engine_version
|
14445
14431
|
# The version number of the database engine to use. Choose the latest
|
@@ -14447,9 +14433,10 @@ module Aws::RDS
|
|
14447
14433
|
# versions, see `CreateDBInstance`, or call `DescribeDBEngineVersions`.
|
14448
14434
|
#
|
14449
14435
|
# @option params [Boolean] :auto_minor_version_upgrade
|
14450
|
-
#
|
14451
|
-
#
|
14452
|
-
#
|
14436
|
+
# True to indicate that minor engine upgrades are applied automatically
|
14437
|
+
# to the DB instance during the maintenance window, and otherwise false.
|
14438
|
+
#
|
14439
|
+
# Default: `true`
|
14453
14440
|
#
|
14454
14441
|
# @option params [String] :license_model
|
14455
14442
|
# The license model for this DB instance. Use `general-public-license`.
|
@@ -14470,12 +14457,11 @@ module Aws::RDS
|
|
14470
14457
|
# engine is used.
|
14471
14458
|
#
|
14472
14459
|
# @option params [Boolean] :publicly_accessible
|
14473
|
-
#
|
14474
|
-
#
|
14475
|
-
#
|
14476
|
-
#
|
14477
|
-
#
|
14478
|
-
# address. For more information, see CreateDBInstance.
|
14460
|
+
# Specifies the accessibility options for the DB instance. A value of
|
14461
|
+
# true specifies an Internet-facing instance with a publicly resolvable
|
14462
|
+
# DNS name, which resolves to a public IP address. A value of false
|
14463
|
+
# specifies an internal instance with a DNS name that resolves to a
|
14464
|
+
# private IP address. For more information, see `CreateDBInstance`.
|
14479
14465
|
#
|
14480
14466
|
# @option params [Array<Types::Tag>] :tags
|
14481
14467
|
# A list of tags to associate with this DB instance. For more
|
@@ -14494,11 +14480,11 @@ module Aws::RDS
|
|
14494
14480
|
# If you specify `io1`, you must also include a value for the `Iops`
|
14495
14481
|
# parameter.
|
14496
14482
|
#
|
14497
|
-
# Default: `io1` if the `Iops` parameter is specified; otherwise
|
14483
|
+
# Default: `io1` if the `Iops` parameter is specified; otherwise
|
14484
|
+
# `standard`
|
14498
14485
|
#
|
14499
14486
|
# @option params [Boolean] :storage_encrypted
|
14500
|
-
#
|
14501
|
-
# not.
|
14487
|
+
# Specifies whether the new DB instance is encrypted or not.
|
14502
14488
|
#
|
14503
14489
|
# @option params [String] :kms_key_id
|
14504
14490
|
# The AWS KMS key identifier for an encrypted DB instance.
|
@@ -14509,15 +14495,17 @@ module Aws::RDS
|
|
14509
14495
|
# instance, then you can use the KMS key alias instead of the ARN for
|
14510
14496
|
# the KM encryption key.
|
14511
14497
|
#
|
14512
|
-
# If the `StorageEncrypted` parameter is
|
14513
|
-
#
|
14498
|
+
# If the `StorageEncrypted` parameter is true, and you do not specify a
|
14499
|
+
# value for the `KmsKeyId` parameter, then Amazon RDS will use your
|
14514
14500
|
# default encryption key. AWS KMS creates the default encryption key for
|
14515
14501
|
# your AWS account. Your AWS account has a different default encryption
|
14516
14502
|
# key for each AWS Region.
|
14517
14503
|
#
|
14518
14504
|
# @option params [Boolean] :copy_tags_to_snapshot
|
14519
|
-
#
|
14520
|
-
#
|
14505
|
+
# True to copy all tags from the restored DB instance to snapshots of
|
14506
|
+
# the restored DB instance, and otherwise false.
|
14507
|
+
#
|
14508
|
+
# Default: false.
|
14521
14509
|
#
|
14522
14510
|
# @option params [Integer] :monitoring_interval
|
14523
14511
|
# The interval, in seconds, between points when Enhanced Monitoring
|
@@ -14546,9 +14534,10 @@ module Aws::RDS
|
|
14546
14534
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Monitoring.OS.html#USER_Monitoring.OS.Enabling
|
14547
14535
|
#
|
14548
14536
|
# @option params [Boolean] :enable_iam_database_authentication
|
14549
|
-
#
|
14550
|
-
#
|
14551
|
-
#
|
14537
|
+
# True to enable mapping of AWS Identity and Access Management (IAM)
|
14538
|
+
# accounts to database accounts, and otherwise false.
|
14539
|
+
#
|
14540
|
+
# Default: `false`
|
14552
14541
|
#
|
14553
14542
|
# @option params [required, String] :source_engine
|
14554
14543
|
# The name of the engine of your source database.
|
@@ -14572,8 +14561,8 @@ module Aws::RDS
|
|
14572
14561
|
# to access your Amazon S3 bucket.
|
14573
14562
|
#
|
14574
14563
|
# @option params [Boolean] :enable_performance_insights
|
14575
|
-
#
|
14576
|
-
#
|
14564
|
+
# True to enable Performance Insights for the DB instance, and otherwise
|
14565
|
+
# false.
|
14577
14566
|
#
|
14578
14567
|
# For more information, see [Using Amazon Performance Insights][1] in
|
14579
14568
|
# the *Amazon Relational Database Service User Guide*.
|
@@ -14587,11 +14576,6 @@ module Aws::RDS
|
|
14587
14576
|
# data. The KMS key ID is the Amazon Resource Name (ARN), the KMS key
|
14588
14577
|
# identifier, or the KMS key alias for the KMS encryption key.
|
14589
14578
|
#
|
14590
|
-
# If you do not specify a value for `PerformanceInsightsKMSKeyId`, then
|
14591
|
-
# Amazon RDS uses your default encryption key. AWS KMS creates the
|
14592
|
-
# default encryption key for your AWS account. Your AWS account has a
|
14593
|
-
# different default encryption key for each AWS Region.
|
14594
|
-
#
|
14595
14579
|
# @option params [Integer] :performance_insights_retention_period
|
14596
14580
|
# The amount of time, in days, to retain Performance Insights data.
|
14597
14581
|
# Valid values are 7 or 731 (2 years).
|
@@ -14611,14 +14595,14 @@ module Aws::RDS
|
|
14611
14595
|
# instance class of the DB instance.
|
14612
14596
|
#
|
14613
14597
|
# @option params [Boolean] :use_default_processor_features
|
14614
|
-
# A value that
|
14615
|
-
#
|
14598
|
+
# A value that specifies that the DB instance class of the DB instance
|
14599
|
+
# uses its default processor features.
|
14616
14600
|
#
|
14617
14601
|
# @option params [Boolean] :deletion_protection
|
14618
|
-
#
|
14619
|
-
#
|
14620
|
-
#
|
14621
|
-
#
|
14602
|
+
# Indicates if the DB instance should have deletion protection enabled.
|
14603
|
+
# The database can't be deleted when this value is set to true. The
|
14604
|
+
# default is false. For more information, see [ Deleting a DB
|
14605
|
+
# Instance][1].
|
14622
14606
|
#
|
14623
14607
|
#
|
14624
14608
|
#
|
@@ -14859,18 +14843,17 @@ module Aws::RDS
|
|
14859
14843
|
#
|
14860
14844
|
# * Must be before the latest restorable time for the DB instance
|
14861
14845
|
#
|
14862
|
-
# * Can't be specified if
|
14863
|
-
# enabled
|
14846
|
+
# * Can't be specified if UseLatestRestorableTime parameter is true
|
14864
14847
|
#
|
14865
14848
|
# Example: `2009-09-07T23:45:00Z`
|
14866
14849
|
#
|
14867
14850
|
# @option params [Boolean] :use_latest_restorable_time
|
14868
|
-
#
|
14869
|
-
# latest backup time.
|
14870
|
-
# the latest backup time.
|
14851
|
+
# Specifies whether (`true`) or not (`false`) the DB instance is
|
14852
|
+
# restored from the latest backup time.
|
14871
14853
|
#
|
14872
|
-
#
|
14873
|
-
#
|
14854
|
+
# Default: `false`
|
14855
|
+
#
|
14856
|
+
# Constraints: Can't be specified if RestoreTime parameter is provided.
|
14874
14857
|
#
|
14875
14858
|
# @option params [String] :db_instance_class
|
14876
14859
|
# The compute and memory capacity of the Amazon RDS DB instance, for
|
@@ -14897,8 +14880,8 @@ module Aws::RDS
|
|
14897
14880
|
#
|
14898
14881
|
# Default: A random, system-chosen Availability Zone.
|
14899
14882
|
#
|
14900
|
-
# Constraint: You can't specify the
|
14901
|
-
#
|
14883
|
+
# Constraint: You can't specify the AvailabilityZone parameter if the
|
14884
|
+
# MultiAZ parameter is set to true.
|
14902
14885
|
#
|
14903
14886
|
# Example: `us-east-1a`
|
14904
14887
|
#
|
@@ -14911,23 +14894,21 @@ module Aws::RDS
|
|
14911
14894
|
# Example: `mySubnetgroup`
|
14912
14895
|
#
|
14913
14896
|
# @option params [Boolean] :multi_az
|
14914
|
-
#
|
14915
|
-
# deployment.
|
14897
|
+
# Specifies if the DB instance is a Multi-AZ deployment.
|
14916
14898
|
#
|
14917
|
-
# Constraint: You can't specify the
|
14918
|
-
#
|
14899
|
+
# Constraint: You can't specify the AvailabilityZone parameter if the
|
14900
|
+
# MultiAZ parameter is set to `true`.
|
14919
14901
|
#
|
14920
14902
|
# @option params [Boolean] :publicly_accessible
|
14921
|
-
#
|
14922
|
-
#
|
14923
|
-
#
|
14924
|
-
#
|
14925
|
-
#
|
14926
|
-
# address. For more information, see CreateDBInstance.
|
14903
|
+
# Specifies the accessibility options for the DB instance. A value of
|
14904
|
+
# true specifies an Internet-facing instance with a publicly resolvable
|
14905
|
+
# DNS name, which resolves to a public IP address. A value of false
|
14906
|
+
# specifies an internal instance with a DNS name that resolves to a
|
14907
|
+
# private IP address. For more information, see `CreateDBInstance`.
|
14927
14908
|
#
|
14928
14909
|
# @option params [Boolean] :auto_minor_version_upgrade
|
14929
|
-
#
|
14930
|
-
#
|
14910
|
+
# Indicates that minor version upgrades are applied automatically to the
|
14911
|
+
# DB instance during the maintenance window.
|
14931
14912
|
#
|
14932
14913
|
# @option params [String] :license_model
|
14933
14914
|
# License model information for the restored DB instance.
|
@@ -14995,9 +14976,8 @@ module Aws::RDS
|
|
14995
14976
|
# instance
|
14996
14977
|
#
|
14997
14978
|
# @option params [Boolean] :copy_tags_to_snapshot
|
14998
|
-
#
|
14999
|
-
#
|
15000
|
-
# copied.
|
14979
|
+
# True to copy all tags from the restored DB instance to snapshots of
|
14980
|
+
# the restored DB instance, and otherwise false. The default is false.
|
15001
14981
|
#
|
15002
14982
|
# @option params [Array<Types::Tag>] :tags
|
15003
14983
|
# A list of tags. For more information, see [Tagging Amazon RDS
|
@@ -15015,7 +14995,8 @@ module Aws::RDS
|
|
15015
14995
|
# If you specify `io1`, you must also include a value for the `Iops`
|
15016
14996
|
# parameter.
|
15017
14997
|
#
|
15018
|
-
# Default: `io1` if the `Iops` parameter is specified, otherwise
|
14998
|
+
# Default: `io1` if the `Iops` parameter is specified, otherwise
|
14999
|
+
# `standard`
|
15019
15000
|
#
|
15020
15001
|
# @option params [String] :tde_credential_arn
|
15021
15002
|
# The ARN from the key store with which to associate the instance for
|
@@ -15039,9 +15020,8 @@ module Aws::RDS
|
|
15039
15020
|
# the Directory Service.
|
15040
15021
|
#
|
15041
15022
|
# @option params [Boolean] :enable_iam_database_authentication
|
15042
|
-
#
|
15043
|
-
#
|
15044
|
-
# mapping is disabled.
|
15023
|
+
# True to enable mapping of AWS Identity and Access Management (IAM)
|
15024
|
+
# accounts to database accounts, and otherwise false.
|
15045
15025
|
#
|
15046
15026
|
# You can enable IAM database authentication for the following database
|
15047
15027
|
# engines
|
@@ -15050,6 +15030,8 @@ module Aws::RDS
|
|
15050
15030
|
#
|
15051
15031
|
# * For MySQL 5.7, minor version 5.7.16 or higher
|
15052
15032
|
#
|
15033
|
+
# Default: `false`
|
15034
|
+
#
|
15053
15035
|
# @option params [Array<String>] :enable_cloudwatch_logs_exports
|
15054
15036
|
# The list of logs that the restored DB instance is to export to
|
15055
15037
|
# CloudWatch Logs. The values in the list depend on the DB engine being
|
@@ -15065,8 +15047,8 @@ module Aws::RDS
|
|
15065
15047
|
# instance class of the DB instance.
|
15066
15048
|
#
|
15067
15049
|
# @option params [Boolean] :use_default_processor_features
|
15068
|
-
# A value that
|
15069
|
-
#
|
15050
|
+
# A value that specifies that the DB instance class of the DB instance
|
15051
|
+
# uses its default processor features.
|
15070
15052
|
#
|
15071
15053
|
# @option params [String] :db_parameter_group_name
|
15072
15054
|
# The name of the DB parameter group to associate with this DB instance.
|
@@ -15084,10 +15066,10 @@ module Aws::RDS
|
|
15084
15066
|
# * Can't end with a hyphen or contain two consecutive hyphens.
|
15085
15067
|
#
|
15086
15068
|
# @option params [Boolean] :deletion_protection
|
15087
|
-
#
|
15088
|
-
#
|
15089
|
-
#
|
15090
|
-
#
|
15069
|
+
# Indicates if the DB instance should have deletion protection enabled.
|
15070
|
+
# The database can't be deleted when this value is set to true. The
|
15071
|
+
# default is false. For more information, see [ Deleting a DB
|
15072
|
+
# Instance][1].
|
15091
15073
|
#
|
15092
15074
|
#
|
15093
15075
|
#
|
@@ -15994,7 +15976,7 @@ module Aws::RDS
|
|
15994
15976
|
params: params,
|
15995
15977
|
config: config)
|
15996
15978
|
context[:gem_name] = 'aws-sdk-rds'
|
15997
|
-
context[:gem_version] = '1.
|
15979
|
+
context[:gem_version] = '1.55.0'
|
15998
15980
|
Seahorse::Client::Request.new(handlers, context)
|
15999
15981
|
end
|
16000
15982
|
|