aws-sdk-rds 1.51.0 → 1.52.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/lib/aws-sdk-rds.rb +1 -1
- data/lib/aws-sdk-rds/client.rb +506 -511
- data/lib/aws-sdk-rds/db_cluster.rb +85 -90
- data/lib/aws-sdk-rds/db_cluster_parameter_group.rb +6 -11
- data/lib/aws-sdk-rds/db_cluster_snapshot.rb +16 -15
- data/lib/aws-sdk-rds/db_engine.rb +10 -4
- data/lib/aws-sdk-rds/db_instance.rb +247 -234
- data/lib/aws-sdk-rds/db_parameter_group.rb +4 -10
- data/lib/aws-sdk-rds/db_security_group.rb +3 -8
- data/lib/aws-sdk-rds/db_snapshot.rb +30 -29
- data/lib/aws-sdk-rds/db_subnet_group.rb +2 -7
- data/lib/aws-sdk-rds/event_subscription.rb +4 -3
- data/lib/aws-sdk-rds/option_group.rb +4 -9
- data/lib/aws-sdk-rds/pending_maintenance_action.rb +1 -1
- data/lib/aws-sdk-rds/resource.rb +113 -136
- data/lib/aws-sdk-rds/types.rb +771 -704
- metadata +4 -4
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA1:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 2c4b94ef3cbd16fa33f4e43a7b82d8e6a72e0b29
|
4
|
+
data.tar.gz: 5b2944825109830f6e8411a3b0a7bb08a6a79529
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 9536f21805fbce6b6d68fe62d2a8b4758f50f3488c62842f6d272dd75867ae30e0c82f07dee41136c03e25b4c0efa610f02b353122b470923557ccae2856f380
|
7
|
+
data.tar.gz: 97e240fa1808881c64f41798d50c95fc9088647852a72d6067d997e5b19cfedaed3af70bd98cab2f1fe2567e6fb2826860820c0f48842bc7b94476ef9130d53a
|
data/lib/aws-sdk-rds.rb
CHANGED
data/lib/aws-sdk-rds/client.rb
CHANGED
@@ -315,7 +315,7 @@ module Aws::RDS
|
|
315
315
|
# @option params [required, String] :feature_name
|
316
316
|
# The name of the feature for the DB instance that the IAM role is to be
|
317
317
|
# associated with. For the list of supported feature names, see
|
318
|
-
# DBEngineVersion
|
318
|
+
# `DBEngineVersion`.
|
319
319
|
#
|
320
320
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
321
321
|
#
|
@@ -707,14 +707,16 @@ 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
|
-
# binary logging is enabled. Otherwise, an error occurs when binary
|
710
|
+
# A value that indicates whether to force the DB cluster to backtrack
|
711
|
+
# when 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
|
-
# backtrack time
|
717
|
-
#
|
715
|
+
# A value that indicates whether to backtrack the DB cluster to the
|
716
|
+
# earliest possible backtrack time when *BacktrackTo* is set to a
|
717
|
+
# timestamp earlier than the earliest backtrack time. When this
|
718
|
+
# parameter is disabled and *BacktrackTo* is set to a timestamp earlier
|
719
|
+
# than the earliest backtrack time, an error occurs.
|
718
720
|
#
|
719
721
|
# @return [Types::DBClusterBacktrack] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
720
722
|
#
|
@@ -1043,8 +1045,9 @@ module Aws::RDS
|
|
1043
1045
|
# [2]: https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html
|
1044
1046
|
#
|
1045
1047
|
# @option params [Boolean] :copy_tags
|
1046
|
-
#
|
1047
|
-
# target DB cluster snapshot
|
1048
|
+
# A value that indicates whether to copy all tags from the source DB
|
1049
|
+
# cluster snapshot to the target DB cluster snapshot. By default, tags
|
1050
|
+
# are not copied.
|
1048
1051
|
#
|
1049
1052
|
# @option params [Array<Types::Tag>] :tags
|
1050
1053
|
# A list of tags. For more information, see [Tagging Amazon RDS
|
@@ -1312,8 +1315,8 @@ module Aws::RDS
|
|
1312
1315
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html
|
1313
1316
|
#
|
1314
1317
|
# @option params [Boolean] :copy_tags
|
1315
|
-
#
|
1316
|
-
# snapshot
|
1318
|
+
# A value that indicates whether to copy all tags from the source DB
|
1319
|
+
# snapshot to the target DB snapshot. By default, tags are not copied.
|
1317
1320
|
#
|
1318
1321
|
# @option params [String] :pre_signed_url
|
1319
1322
|
# The URL that contains a Signature Version 4 signed request for the
|
@@ -1609,8 +1612,8 @@ module Aws::RDS
|
|
1609
1612
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html
|
1610
1613
|
#
|
1611
1614
|
# @option params [Array<String>] :availability_zones
|
1612
|
-
# A list of
|
1613
|
-
# be created
|
1615
|
+
# A list of Availability Zones (AZs) where instances in the DB cluster
|
1616
|
+
# can be created. For information on AWS Regions and Availability Zones,
|
1614
1617
|
# see [Choosing the Regions and Availability Zones][1] in the *Amazon
|
1615
1618
|
# Aurora User Guide*.
|
1616
1619
|
#
|
@@ -1619,8 +1622,7 @@ module Aws::RDS
|
|
1619
1622
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Concepts.RegionsAndAvailabilityZones.html
|
1620
1623
|
#
|
1621
1624
|
# @option params [Integer] :backup_retention_period
|
1622
|
-
# The number of days for which automated backups are retained.
|
1623
|
-
# specify a minimum value of 1.
|
1625
|
+
# The number of days for which automated backups are retained.
|
1624
1626
|
#
|
1625
1627
|
# Default: 1
|
1626
1628
|
#
|
@@ -1773,15 +1775,10 @@ module Aws::RDS
|
|
1773
1775
|
# if this DB cluster is created as a Read Replica.
|
1774
1776
|
#
|
1775
1777
|
# @option params [Array<Types::Tag>] :tags
|
1776
|
-
#
|
1777
|
-
# Resources][1] in the *Amazon RDS User Guide.*
|
1778
|
-
#
|
1779
|
-
#
|
1780
|
-
#
|
1781
|
-
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html
|
1778
|
+
# Tags to assign to the DB cluster.
|
1782
1779
|
#
|
1783
1780
|
# @option params [Boolean] :storage_encrypted
|
1784
|
-
#
|
1781
|
+
# A value that indicates whether the DB cluster is encrypted.
|
1785
1782
|
#
|
1786
1783
|
# @option params [String] :kms_key_id
|
1787
1784
|
# The AWS KMS key identifier for an encrypted DB cluster.
|
@@ -1798,7 +1795,7 @@ module Aws::RDS
|
|
1798
1795
|
# then Amazon RDS will use the encryption key used to encrypt the
|
1799
1796
|
# source. Otherwise, Amazon RDS will use your default encryption key.
|
1800
1797
|
#
|
1801
|
-
# * If the `StorageEncrypted` parameter is
|
1798
|
+
# * If the `StorageEncrypted` parameter is enabled and
|
1802
1799
|
# `ReplicationSourceIdentifier` is not specified, then Amazon RDS will
|
1803
1800
|
# use your default encryption key.
|
1804
1801
|
#
|
@@ -1852,10 +1849,9 @@ module Aws::RDS
|
|
1852
1849
|
# [2]: https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html
|
1853
1850
|
#
|
1854
1851
|
# @option params [Boolean] :enable_iam_database_authentication
|
1855
|
-
#
|
1856
|
-
# accounts to database accounts
|
1857
|
-
#
|
1858
|
-
# Default: `false`
|
1852
|
+
# A value that indicates whether to enable mapping of AWS Identity and
|
1853
|
+
# Access Management (IAM) accounts to database accounts. By default,
|
1854
|
+
# mapping is disabled.
|
1859
1855
|
#
|
1860
1856
|
# @option params [Integer] :backtrack_window
|
1861
1857
|
# The target backtrack window, in seconds. To disable backtracking, set
|
@@ -1889,17 +1885,17 @@ module Aws::RDS
|
|
1889
1885
|
# of the DB cluster.
|
1890
1886
|
#
|
1891
1887
|
# @option params [Boolean] :deletion_protection
|
1892
|
-
#
|
1893
|
-
# The database can't be deleted when
|
1894
|
-
# default is
|
1888
|
+
# A value that indicates whether the DB cluster has deletion protection
|
1889
|
+
# enabled. The database can't be deleted when deletion protection is
|
1890
|
+
# enabled. By default, deletion protection is disabled.
|
1895
1891
|
#
|
1896
1892
|
# @option params [String] :global_cluster_identifier
|
1897
1893
|
# The global cluster ID of an Aurora cluster that becomes the primary
|
1898
1894
|
# cluster in the new global database cluster.
|
1899
1895
|
#
|
1900
1896
|
# @option params [Boolean] :copy_tags_to_snapshot
|
1901
|
-
#
|
1902
|
-
#
|
1897
|
+
# A value that indicates whether to copy all tags from the DB cluster to
|
1898
|
+
# snapshots of the DB cluster. The default is not to copy them.
|
1903
1899
|
#
|
1904
1900
|
# @option params [String] :source_region
|
1905
1901
|
# The source region of the snapshot. This is only needed when the
|
@@ -2142,9 +2138,9 @@ module Aws::RDS
|
|
2142
2138
|
# parameters for the database engine used by instances in the DB
|
2143
2139
|
# cluster. To provide custom values for any of the parameters, you must
|
2144
2140
|
# modify the group after creating it using
|
2145
|
-
# ModifyDBClusterParameterGroup
|
2141
|
+
# `ModifyDBClusterParameterGroup`. Once you've created a DB cluster
|
2146
2142
|
# parameter group, you need to associate it with your DB cluster using
|
2147
|
-
# ModifyDBCluster
|
2143
|
+
# `ModifyDBCluster`. When you associate a new DB cluster parameter group
|
2148
2144
|
# with a running DB cluster, you need to reboot the DB instances in the
|
2149
2145
|
# DB cluster without failover for the new DB cluster parameter group and
|
2150
2146
|
# associated settings to take effect.
|
@@ -2158,7 +2154,7 @@ module Aws::RDS
|
|
2158
2154
|
# the default database for a DB cluster, such as the character set for
|
2159
2155
|
# the default database defined by the `character_set_database`
|
2160
2156
|
# parameter. You can use the *Parameter Groups* option of the [Amazon
|
2161
|
-
# RDS console][1] or the DescribeDBClusterParameters
|
2157
|
+
# RDS console][1] or the `DescribeDBClusterParameters` action to verify
|
2162
2158
|
# that your DB cluster parameter group has been created or modified.
|
2163
2159
|
#
|
2164
2160
|
# For more information on Amazon Aurora, see [ What Is Amazon
|
@@ -2205,12 +2201,7 @@ module Aws::RDS
|
|
2205
2201
|
# The description for the DB cluster parameter group.
|
2206
2202
|
#
|
2207
2203
|
# @option params [Array<Types::Tag>] :tags
|
2208
|
-
#
|
2209
|
-
# Resources][1] in the *Amazon RDS User Guide.*
|
2210
|
-
#
|
2211
|
-
#
|
2212
|
-
#
|
2213
|
-
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html
|
2204
|
+
# Tags to assign to the DB cluster parameter group.
|
2214
2205
|
#
|
2215
2206
|
# @return [Types::CreateDBClusterParameterGroupResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2216
2207
|
#
|
@@ -2376,8 +2367,6 @@ module Aws::RDS
|
|
2376
2367
|
# The meaning of this parameter differs according to the database engine
|
2377
2368
|
# you use.
|
2378
2369
|
#
|
2379
|
-
# Type: String
|
2380
|
-
#
|
2381
2370
|
# **MySQL**
|
2382
2371
|
#
|
2383
2372
|
# The name of the database to create when the DB instance is created. If
|
@@ -2602,7 +2591,7 @@ module Aws::RDS
|
|
2602
2591
|
# **Amazon Aurora**
|
2603
2592
|
#
|
2604
2593
|
# Not applicable. The name for the master user is managed by the DB
|
2605
|
-
# cluster.
|
2594
|
+
# cluster.
|
2606
2595
|
#
|
2607
2596
|
# **MariaDB**
|
2608
2597
|
#
|
@@ -2669,7 +2658,7 @@ module Aws::RDS
|
|
2669
2658
|
# **Amazon Aurora**
|
2670
2659
|
#
|
2671
2660
|
# Not applicable. The password for the master user is managed by the DB
|
2672
|
-
# cluster.
|
2661
|
+
# cluster.
|
2673
2662
|
#
|
2674
2663
|
# **MariaDB**
|
2675
2664
|
#
|
@@ -2703,13 +2692,13 @@ module Aws::RDS
|
|
2703
2692
|
# **Amazon Aurora**
|
2704
2693
|
#
|
2705
2694
|
# Not applicable. The associated list of EC2 VPC security groups is
|
2706
|
-
# managed by the DB cluster.
|
2695
|
+
# managed by the DB cluster.
|
2707
2696
|
#
|
2708
2697
|
# Default: The default EC2 VPC security group for the DB subnet group's
|
2709
2698
|
# VPC.
|
2710
2699
|
#
|
2711
2700
|
# @option params [String] :availability_zone
|
2712
|
-
# The
|
2701
|
+
# The Availability Zone (AZ) where the database will be created. For
|
2713
2702
|
# information on AWS Regions and Availability Zones, see [Regions and
|
2714
2703
|
# Availability Zones][1].
|
2715
2704
|
#
|
@@ -2718,9 +2707,9 @@ module Aws::RDS
|
|
2718
2707
|
#
|
2719
2708
|
# Example: `us-east-1d`
|
2720
2709
|
#
|
2721
|
-
# Constraint: The AvailabilityZone parameter can't be specified if
|
2722
|
-
#
|
2723
|
-
# must be in the same AWS Region as the current endpoint.
|
2710
|
+
# Constraint: The `AvailabilityZone` parameter can't be specified if
|
2711
|
+
# the DB instance is a Multi-AZ deployment. The specified Availability
|
2712
|
+
# Zone must be in the same AWS Region as the current endpoint.
|
2724
2713
|
#
|
2725
2714
|
#
|
2726
2715
|
#
|
@@ -2771,7 +2760,7 @@ module Aws::RDS
|
|
2771
2760
|
# **Amazon Aurora**
|
2772
2761
|
#
|
2773
2762
|
# Not applicable. The retention period for automated backups is managed
|
2774
|
-
# by the DB cluster.
|
2763
|
+
# by the DB cluster.
|
2775
2764
|
#
|
2776
2765
|
# Default: 1
|
2777
2766
|
#
|
@@ -2790,7 +2779,7 @@ module Aws::RDS
|
|
2790
2779
|
# **Amazon Aurora**
|
2791
2780
|
#
|
2792
2781
|
# Not applicable. The daily time range for creating automated backups is
|
2793
|
-
# managed by the DB cluster.
|
2782
|
+
# managed by the DB cluster.
|
2794
2783
|
#
|
2795
2784
|
# The default is a 30-minute window selected at random from an 8-hour
|
2796
2785
|
# block of time for each AWS Region. To see the time blocks available,
|
@@ -2861,14 +2850,15 @@ module Aws::RDS
|
|
2861
2850
|
# Type: Integer
|
2862
2851
|
#
|
2863
2852
|
# @option params [Boolean] :multi_az
|
2864
|
-
# A value that
|
2865
|
-
# deployment. You can't set the AvailabilityZone parameter if the
|
2866
|
-
#
|
2853
|
+
# A value that indicates whether the DB instance is a Multi-AZ
|
2854
|
+
# deployment. You can't set the `AvailabilityZone` parameter if the DB
|
2855
|
+
# instance is a Multi-AZ deployment.
|
2867
2856
|
#
|
2868
2857
|
# @option params [String] :engine_version
|
2869
2858
|
# The version number of the database engine to use.
|
2870
2859
|
#
|
2871
|
-
# For a list of valid engine versions,
|
2860
|
+
# For a list of valid engine versions, use the
|
2861
|
+
# `DescribeDBEngineVersions` action.
|
2872
2862
|
#
|
2873
2863
|
# The following are the database engines and links to information about
|
2874
2864
|
# the major and minor versions that are available with Amazon RDS. Not
|
@@ -2877,8 +2867,7 @@ module Aws::RDS
|
|
2877
2867
|
# **Amazon Aurora**
|
2878
2868
|
#
|
2879
2869
|
# Not applicable. The version number of the database engine to be used
|
2880
|
-
# by the DB instance is managed by the DB cluster.
|
2881
|
-
# see CreateDBCluster.
|
2870
|
+
# by the DB instance is managed by the DB cluster.
|
2882
2871
|
#
|
2883
2872
|
# **MariaDB**
|
2884
2873
|
#
|
@@ -2913,10 +2902,9 @@ module Aws::RDS
|
|
2913
2902
|
# [5]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_PostgreSQL.html#PostgreSQL.Concepts.General.DBVersions
|
2914
2903
|
#
|
2915
2904
|
# @option params [Boolean] :auto_minor_version_upgrade
|
2916
|
-
#
|
2917
|
-
# DB instance during the maintenance window.
|
2918
|
-
#
|
2919
|
-
# Default: `true`
|
2905
|
+
# A value that indicates whether minor engine upgrades are applied
|
2906
|
+
# automatically to the DB instance during the maintenance window. By
|
2907
|
+
# default, minor engine upgrades are applied automatically.
|
2920
2908
|
#
|
2921
2909
|
# @option params [String] :license_model
|
2922
2910
|
# License model information for this DB instance.
|
@@ -2953,14 +2941,15 @@ module Aws::RDS
|
|
2953
2941
|
# **Amazon Aurora**
|
2954
2942
|
#
|
2955
2943
|
# Not applicable. The character set is managed by the DB cluster. For
|
2956
|
-
# more information, see CreateDBCluster
|
2944
|
+
# more information, see `CreateDBCluster`.
|
2957
2945
|
#
|
2958
2946
|
# @option params [Boolean] :publicly_accessible
|
2959
|
-
#
|
2960
|
-
#
|
2961
|
-
# DNS name, which resolves to a
|
2962
|
-
#
|
2963
|
-
# private IP
|
2947
|
+
# A value that indicates whether the DB instance is publicly accessible.
|
2948
|
+
# When the DB instance is publicly accessible, it is an Internet-facing
|
2949
|
+
# instance with a publicly resolvable DNS name, which resolves to a
|
2950
|
+
# public IP address. When the DB instance is not publicly accessible, it
|
2951
|
+
# is an internal instance with a DNS name that resolves to a private IP
|
2952
|
+
# address.
|
2964
2953
|
#
|
2965
2954
|
# Default: The default behavior varies depending on whether
|
2966
2955
|
# `DBSubnetGroupName` is specified.
|
@@ -2984,20 +2973,11 @@ module Aws::RDS
|
|
2984
2973
|
# attached to it, the DB instance is public.
|
2985
2974
|
#
|
2986
2975
|
# @option params [Array<Types::Tag>] :tags
|
2987
|
-
#
|
2988
|
-
# Resources][1] in the *Amazon RDS User Guide.*
|
2989
|
-
#
|
2990
|
-
#
|
2991
|
-
#
|
2992
|
-
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html
|
2976
|
+
# Tags to assign to the DB instance.
|
2993
2977
|
#
|
2994
2978
|
# @option params [String] :db_cluster_identifier
|
2995
2979
|
# The identifier of the DB cluster that the instance will belong to.
|
2996
2980
|
#
|
2997
|
-
# For information on creating a DB cluster, see CreateDBCluster.
|
2998
|
-
#
|
2999
|
-
# Type: String
|
3000
|
-
#
|
3001
2981
|
# @option params [String] :storage_type
|
3002
2982
|
# Specifies the storage type to be associated with the DB instance.
|
3003
2983
|
#
|
@@ -3006,8 +2986,7 @@ module Aws::RDS
|
|
3006
2986
|
# If you specify `io1`, you must also include a value for the `Iops`
|
3007
2987
|
# parameter.
|
3008
2988
|
#
|
3009
|
-
# Default: `io1` if the `Iops` parameter is specified, otherwise
|
3010
|
-
# `standard`
|
2989
|
+
# Default: `io1` if the `Iops` parameter is specified, otherwise `gp2`
|
3011
2990
|
#
|
3012
2991
|
# @option params [String] :tde_credential_arn
|
3013
2992
|
# The ARN from the key store with which to associate the instance for
|
@@ -3018,14 +2997,13 @@ module Aws::RDS
|
|
3018
2997
|
# the device.
|
3019
2998
|
#
|
3020
2999
|
# @option params [Boolean] :storage_encrypted
|
3021
|
-
#
|
3000
|
+
# A value that indicates whether the DB instance is encrypted. By
|
3001
|
+
# default, it is not encrypted.
|
3022
3002
|
#
|
3023
3003
|
# **Amazon Aurora**
|
3024
3004
|
#
|
3025
3005
|
# Not applicable. The encryption for DB instances is managed by the DB
|
3026
|
-
# cluster.
|
3027
|
-
#
|
3028
|
-
# Default: false
|
3006
|
+
# cluster.
|
3029
3007
|
#
|
3030
3008
|
# @option params [String] :kms_key_id
|
3031
3009
|
# The AWS KMS key identifier for an encrypted DB instance.
|
@@ -3039,26 +3017,36 @@ module Aws::RDS
|
|
3039
3017
|
# **Amazon Aurora**
|
3040
3018
|
#
|
3041
3019
|
# Not applicable. The KMS key identifier is managed by the DB cluster.
|
3042
|
-
# For more information, see CreateDBCluster
|
3020
|
+
# For more information, see `CreateDBCluster`.
|
3043
3021
|
#
|
3044
|
-
# If
|
3045
|
-
#
|
3046
|
-
#
|
3047
|
-
#
|
3048
|
-
#
|
3022
|
+
# If `StorageEncrypted` is enabled, and you do not specify a value for
|
3023
|
+
# the `KmsKeyId` parameter, then Amazon RDS will use your default
|
3024
|
+
# encryption key. AWS KMS creates the default encryption key for your
|
3025
|
+
# AWS account. Your AWS account has a different default encryption key
|
3026
|
+
# for each AWS Region.
|
3049
3027
|
#
|
3050
3028
|
# @option params [String] :domain
|
3051
|
-
#
|
3029
|
+
# For an Amazon RDS DB instance that's running Microsoft SQL Server,
|
3030
|
+
# this parameter specifies the Active Directory directory ID to create
|
3031
|
+
# the instance in. Amazon RDS uses Windows Authentication to
|
3032
|
+
# authenticate users that connect to the DB instance. For more
|
3033
|
+
# information, see [Using Windows Authentication with an Amazon RDS DB
|
3034
|
+
# Instance Running Microsoft SQL Server][1] in the *Amazon RDS User
|
3035
|
+
# Guide*.
|
3036
|
+
#
|
3037
|
+
#
|
3038
|
+
#
|
3039
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/DeveloperGuide/USER_SQLServerWinAuth.html
|
3052
3040
|
#
|
3053
3041
|
# @option params [Boolean] :copy_tags_to_snapshot
|
3054
|
-
#
|
3055
|
-
#
|
3042
|
+
# A value that indicates whether to copy tags from the DB instance to
|
3043
|
+
# snapshots of the DB instance. By default, tags are not copied.
|
3056
3044
|
#
|
3057
3045
|
# **Amazon Aurora**
|
3058
3046
|
#
|
3059
3047
|
# Not applicable. Copying tags to snapshots is managed by the DB
|
3060
3048
|
# cluster. Setting this value for an Aurora DB instance has no effect on
|
3061
|
-
# the DB cluster setting.
|
3049
|
+
# the DB cluster setting.
|
3062
3050
|
#
|
3063
3051
|
# @option params [Integer] :monitoring_interval
|
3064
3052
|
# The interval, in seconds, between points when Enhanced Monitoring
|
@@ -3111,8 +3099,9 @@ module Aws::RDS
|
|
3111
3099
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_SQLServer.html#SQLServer.Concepts.General.TimeZone
|
3112
3100
|
#
|
3113
3101
|
# @option params [Boolean] :enable_iam_database_authentication
|
3114
|
-
#
|
3115
|
-
# accounts to database accounts
|
3102
|
+
# A value that indicates whether to enable mapping of AWS Identity and
|
3103
|
+
# Access Management (IAM) accounts to database accounts. By default,
|
3104
|
+
# mapping is disabled.
|
3116
3105
|
#
|
3117
3106
|
# You can enable IAM database authentication for the following database
|
3118
3107
|
# engines:
|
@@ -3120,7 +3109,7 @@ module Aws::RDS
|
|
3120
3109
|
# **Amazon Aurora**
|
3121
3110
|
#
|
3122
3111
|
# Not applicable. Mapping AWS IAM accounts to database accounts is
|
3123
|
-
# managed by the DB cluster.
|
3112
|
+
# managed by the DB cluster.
|
3124
3113
|
#
|
3125
3114
|
# **MySQL**
|
3126
3115
|
#
|
@@ -3128,11 +3117,9 @@ module Aws::RDS
|
|
3128
3117
|
#
|
3129
3118
|
# * For MySQL 5.7, minor version 5.7.16 or higher
|
3130
3119
|
#
|
3131
|
-
# Default: `false`
|
3132
|
-
#
|
3133
3120
|
# @option params [Boolean] :enable_performance_insights
|
3134
|
-
#
|
3135
|
-
#
|
3121
|
+
# A value that indicates whether to enable Performance Insights for the
|
3122
|
+
# DB instance.
|
3136
3123
|
#
|
3137
3124
|
# For more information, see [Using Amazon Performance Insights][1] in
|
3138
3125
|
# the *Amazon Relational Database Service User Guide*.
|
@@ -3146,6 +3133,11 @@ module Aws::RDS
|
|
3146
3133
|
# data. The KMS key ID is the Amazon Resource Name (ARN), KMS key
|
3147
3134
|
# identifier, or the KMS key alias for the KMS encryption key.
|
3148
3135
|
#
|
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
|
+
#
|
3149
3141
|
# @option params [Integer] :performance_insights_retention_period
|
3150
3142
|
# The amount of time, in days, to retain Performance Insights data.
|
3151
3143
|
# Valid values are 7 or 731 (2 years).
|
@@ -3166,10 +3158,10 @@ module Aws::RDS
|
|
3166
3158
|
# instance class of the DB instance.
|
3167
3159
|
#
|
3168
3160
|
# @option params [Boolean] :deletion_protection
|
3169
|
-
#
|
3170
|
-
# The database can't be deleted when
|
3171
|
-
# default is
|
3172
|
-
# Instance][1].
|
3161
|
+
# A value that indicates whether the DB instance has deletion protection
|
3162
|
+
# enabled. The database can't be deleted when deletion protection is
|
3163
|
+
# enabled. By default, deletion protection is disabled. For more
|
3164
|
+
# information, see [ Deleting a DB Instance][1].
|
3173
3165
|
#
|
3174
3166
|
#
|
3175
3167
|
#
|
@@ -3457,7 +3449,7 @@ module Aws::RDS
|
|
3457
3449
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html
|
3458
3450
|
#
|
3459
3451
|
# @option params [String] :availability_zone
|
3460
|
-
# The
|
3452
|
+
# The Availability Zone (AZ) where the Read Replica will be created.
|
3461
3453
|
#
|
3462
3454
|
# Default: A random, system-chosen Availability Zone in the endpoint's
|
3463
3455
|
# AWS Region.
|
@@ -3472,7 +3464,8 @@ module Aws::RDS
|
|
3472
3464
|
# Valid Values: `1150-65535`
|
3473
3465
|
#
|
3474
3466
|
# @option params [Boolean] :multi_az
|
3475
|
-
#
|
3467
|
+
# A value that indicates whether the Read Replica is in a Multi-AZ
|
3468
|
+
# deployment.
|
3476
3469
|
#
|
3477
3470
|
# You can create a Read Replica as a Multi-AZ DB instance. RDS creates a
|
3478
3471
|
# standby of your replica in another Availability Zone for failover
|
@@ -3481,8 +3474,8 @@ module Aws::RDS
|
|
3481
3474
|
# DB instance.
|
3482
3475
|
#
|
3483
3476
|
# @option params [Boolean] :auto_minor_version_upgrade
|
3484
|
-
#
|
3485
|
-
# Read Replica during the maintenance window.
|
3477
|
+
# A value that indicates whether minor engine upgrades are applied
|
3478
|
+
# automatically to the Read Replica during the maintenance window.
|
3486
3479
|
#
|
3487
3480
|
# Default: Inherits from the source DB instance
|
3488
3481
|
#
|
@@ -3495,11 +3488,12 @@ module Aws::RDS
|
|
3495
3488
|
# option group associated with the source instance is used.
|
3496
3489
|
#
|
3497
3490
|
# @option params [Boolean] :publicly_accessible
|
3498
|
-
#
|
3499
|
-
#
|
3500
|
-
# DNS name, which resolves to a
|
3501
|
-
#
|
3502
|
-
#
|
3491
|
+
# A value that indicates whether the DB instance is publicly accessible.
|
3492
|
+
# When the DB instance is publicly accessible, it is an Internet-facing
|
3493
|
+
# instance with a publicly resolvable DNS name, which resolves to a
|
3494
|
+
# public IP address. When the DB instance is not publicly accessible, it
|
3495
|
+
# is an internal instance with a DNS name that resolves to a private IP
|
3496
|
+
# address. For more information, see CreateDBInstance.
|
3503
3497
|
#
|
3504
3498
|
# @option params [Array<Types::Tag>] :tags
|
3505
3499
|
# A list of tags. For more information, see [Tagging Amazon RDS
|
@@ -3550,12 +3544,11 @@ module Aws::RDS
|
|
3550
3544
|
# If you specify `io1`, you must also include a value for the `Iops`
|
3551
3545
|
# parameter.
|
3552
3546
|
#
|
3553
|
-
# Default: `io1` if the `Iops` parameter is specified, otherwise
|
3554
|
-
# `standard`
|
3547
|
+
# Default: `io1` if the `Iops` parameter is specified, otherwise `gp2`
|
3555
3548
|
#
|
3556
3549
|
# @option params [Boolean] :copy_tags_to_snapshot
|
3557
|
-
#
|
3558
|
-
#
|
3550
|
+
# A value that indicates whether to copy all tags from the Read Replica
|
3551
|
+
# to snapshots of the Read Replica. By default, tags are not copied.
|
3559
3552
|
#
|
3560
3553
|
# @option params [Integer] :monitoring_interval
|
3561
3554
|
# The interval, in seconds, between points when Enhanced Monitoring
|
@@ -3653,8 +3646,9 @@ module Aws::RDS
|
|
3653
3646
|
# [2]: https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html
|
3654
3647
|
#
|
3655
3648
|
# @option params [Boolean] :enable_iam_database_authentication
|
3656
|
-
#
|
3657
|
-
# accounts to database accounts
|
3649
|
+
# A value that indicates whether to enable mapping of AWS Identity and
|
3650
|
+
# Access Management (IAM) accounts to database accounts. By default,
|
3651
|
+
# mapping is disabled.
|
3658
3652
|
#
|
3659
3653
|
# You can enable IAM database authentication for the following database
|
3660
3654
|
# engines
|
@@ -3665,11 +3659,9 @@ module Aws::RDS
|
|
3665
3659
|
#
|
3666
3660
|
# * Aurora MySQL 5.6 or higher
|
3667
3661
|
#
|
3668
|
-
# Default: `false`
|
3669
|
-
#
|
3670
3662
|
# @option params [Boolean] :enable_performance_insights
|
3671
|
-
#
|
3672
|
-
#
|
3663
|
+
# A value that indicates whether to enable Performance Insights for the
|
3664
|
+
# Read Replica.
|
3673
3665
|
#
|
3674
3666
|
# For more information, see [Using Amazon Performance Insights][1] in
|
3675
3667
|
# the *Amazon RDS User Guide*.
|
@@ -3683,6 +3675,11 @@ module Aws::RDS
|
|
3683
3675
|
# data. The KMS key ID is the Amazon Resource Name (ARN), KMS key
|
3684
3676
|
# identifier, or the KMS key alias for the KMS encryption key.
|
3685
3677
|
#
|
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
|
+
#
|
3686
3683
|
# @option params [Integer] :performance_insights_retention_period
|
3687
3684
|
# The amount of time, in days, to retain Performance Insights data.
|
3688
3685
|
# Valid values are 7 or 731 (2 years).
|
@@ -3702,14 +3699,14 @@ module Aws::RDS
|
|
3702
3699
|
# instance class of the DB instance.
|
3703
3700
|
#
|
3704
3701
|
# @option params [Boolean] :use_default_processor_features
|
3705
|
-
# A value that
|
3706
|
-
# uses its default processor features.
|
3702
|
+
# A value that indicates whether the DB instance class of the DB
|
3703
|
+
# instance uses its default processor features.
|
3707
3704
|
#
|
3708
3705
|
# @option params [Boolean] :deletion_protection
|
3709
|
-
#
|
3710
|
-
# The database can't be deleted when
|
3711
|
-
# default is
|
3712
|
-
# Instance][1].
|
3706
|
+
# A value that indicates whether the DB instance has deletion protection
|
3707
|
+
# enabled. The database can't be deleted when deletion protection is
|
3708
|
+
# enabled. By default, deletion protection is disabled. For more
|
3709
|
+
# information, see [ Deleting a DB Instance][1].
|
3713
3710
|
#
|
3714
3711
|
#
|
3715
3712
|
#
|
@@ -3980,12 +3977,7 @@ module Aws::RDS
|
|
3980
3977
|
# The description for the DB parameter group.
|
3981
3978
|
#
|
3982
3979
|
# @option params [Array<Types::Tag>] :tags
|
3983
|
-
#
|
3984
|
-
# Resources][1] in the *Amazon RDS User Guide.*
|
3985
|
-
#
|
3986
|
-
#
|
3987
|
-
#
|
3988
|
-
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html
|
3980
|
+
# Tags to assign to the DB parameter group.
|
3989
3981
|
#
|
3990
3982
|
# @return [Types::CreateDBParameterGroupResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3991
3983
|
#
|
@@ -4066,12 +4058,7 @@ module Aws::RDS
|
|
4066
4058
|
# The description for the DB security group.
|
4067
4059
|
#
|
4068
4060
|
# @option params [Array<Types::Tag>] :tags
|
4069
|
-
#
|
4070
|
-
# Resources][1] in the *Amazon RDS User Guide.*
|
4071
|
-
#
|
4072
|
-
#
|
4073
|
-
#
|
4074
|
-
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html
|
4061
|
+
# Tags to assign to the DB security group.
|
4075
4062
|
#
|
4076
4063
|
# @return [Types::CreateDBSecurityGroupResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4077
4064
|
#
|
@@ -4261,12 +4248,7 @@ module Aws::RDS
|
|
4261
4248
|
# The EC2 Subnet IDs for the DB subnet group.
|
4262
4249
|
#
|
4263
4250
|
# @option params [Array<Types::Tag>] :tags
|
4264
|
-
#
|
4265
|
-
# Resources][1] in the *Amazon RDS User Guide.*
|
4266
|
-
#
|
4267
|
-
#
|
4268
|
-
#
|
4269
|
-
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html
|
4251
|
+
# Tags to assign to the DB subnet group.
|
4270
4252
|
#
|
4271
4253
|
# @return [Types::CreateDBSubnetGroupResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4272
4254
|
#
|
@@ -4402,8 +4384,9 @@ module Aws::RDS
|
|
4402
4384
|
# be supplied.
|
4403
4385
|
#
|
4404
4386
|
# @option params [Boolean] :enabled
|
4405
|
-
# A
|
4406
|
-
#
|
4387
|
+
# A value that indicates whether to activate the subscription. If the
|
4388
|
+
# event notification subscription is not activated, the subscription is
|
4389
|
+
# created but not active.
|
4407
4390
|
#
|
4408
4391
|
# @option params [Array<Types::Tag>] :tags
|
4409
4392
|
# A list of tags. For more information, see [Tagging Amazon RDS
|
@@ -4513,7 +4496,7 @@ module Aws::RDS
|
|
4513
4496
|
#
|
4514
4497
|
# @option params [Boolean] :deletion_protection
|
4515
4498
|
# The deletion protection setting for the new global database. The
|
4516
|
-
# global database can't be deleted when
|
4499
|
+
# global database can't be deleted when deletion protection is enabled.
|
4517
4500
|
#
|
4518
4501
|
# @option params [String] :database_name
|
4519
4502
|
# The name for your database of up to 64 alpha-numeric characters. If
|
@@ -4592,12 +4575,7 @@ module Aws::RDS
|
|
4592
4575
|
# The description of the option group.
|
4593
4576
|
#
|
4594
4577
|
# @option params [Array<Types::Tag>] :tags
|
4595
|
-
#
|
4596
|
-
# Resources][1] in the *Amazon RDS User Guide.*
|
4597
|
-
#
|
4598
|
-
#
|
4599
|
-
#
|
4600
|
-
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html
|
4578
|
+
# Tags to assign to the option group.
|
4601
4579
|
#
|
4602
4580
|
# @return [Types::CreateOptionGroupResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4603
4581
|
#
|
@@ -4707,24 +4685,25 @@ module Aws::RDS
|
|
4707
4685
|
# ^
|
4708
4686
|
#
|
4709
4687
|
# @option params [Boolean] :skip_final_snapshot
|
4710
|
-
#
|
4711
|
-
# DB cluster is deleted. If
|
4712
|
-
#
|
4713
|
-
# before the DB cluster is
|
4688
|
+
# A value that indicates whether to skip the creation of a final DB
|
4689
|
+
# cluster snapshot before the DB cluster is deleted. If skip is
|
4690
|
+
# specified, no DB cluster snapshot is created. If skip is not
|
4691
|
+
# specified, a DB cluster snapshot is created before the DB cluster is
|
4692
|
+
# deleted. By default, skip is not specified, and the DB cluster
|
4693
|
+
# snapshot is created. By default, this parameter is disabled.
|
4714
4694
|
#
|
4715
4695
|
# <note markdown="1"> You must specify a `FinalDBSnapshotIdentifier` parameter if
|
4716
|
-
# `SkipFinalSnapshot` is
|
4696
|
+
# `SkipFinalSnapshot` is disabled.
|
4717
4697
|
#
|
4718
4698
|
# </note>
|
4719
4699
|
#
|
4720
|
-
# Default: `false`
|
4721
|
-
#
|
4722
4700
|
# @option params [String] :final_db_snapshot_identifier
|
4723
4701
|
# The DB cluster snapshot identifier of the new DB cluster snapshot
|
4724
|
-
# created when `SkipFinalSnapshot` is
|
4702
|
+
# created when `SkipFinalSnapshot` is disabled.
|
4725
4703
|
#
|
4726
|
-
# <note markdown="1"> Specifying this parameter and also
|
4727
|
-
#
|
4704
|
+
# <note markdown="1"> Specifying this parameter and also skipping the creation of a final DB
|
4705
|
+
# cluster snapshot with the `SkipFinalShapshot` parameter results in an
|
4706
|
+
# error.
|
4728
4707
|
#
|
4729
4708
|
# </note>
|
4730
4709
|
#
|
@@ -5043,8 +5022,8 @@ module Aws::RDS
|
|
5043
5022
|
#
|
5044
5023
|
# Note that when a DB instance is in a failure state and has a status of
|
5045
5024
|
# `failed`, `incompatible-restore`, or `incompatible-network`, you can
|
5046
|
-
# only delete it when the
|
5047
|
-
# `
|
5025
|
+
# only delete it when you skip creation of the final snapshot with the
|
5026
|
+
# `SkipFinalSnapshot` parameter.
|
5048
5027
|
#
|
5049
5028
|
# If the specified DB instance is part of an Amazon Aurora DB cluster,
|
5050
5029
|
# you can't delete the DB instance if both of the following conditions
|
@@ -5056,7 +5035,7 @@ module Aws::RDS
|
|
5056
5035
|
# * The DB instance is the only instance in the DB cluster.
|
5057
5036
|
#
|
5058
5037
|
# To delete a DB instance in this case, first call the
|
5059
|
-
# PromoteReadReplicaDBCluster API action to promote the DB cluster so
|
5038
|
+
# `PromoteReadReplicaDBCluster` API action to promote the DB cluster so
|
5060
5039
|
# it's no longer a Read Replica. After the promotion completes, then
|
5061
5040
|
# call the `DeleteDBInstance` API action to delete the final instance in
|
5062
5041
|
# the DB cluster.
|
@@ -5072,30 +5051,29 @@ module Aws::RDS
|
|
5072
5051
|
# ^
|
5073
5052
|
#
|
5074
5053
|
# @option params [Boolean] :skip_final_snapshot
|
5075
|
-
# A value that indicates whether
|
5076
|
-
# the DB instance is deleted. If
|
5077
|
-
# created. If
|
5078
|
-
# DB instance is deleted.
|
5054
|
+
# A value that indicates whether to skip the creation of a final DB
|
5055
|
+
# snapshot before the DB instance is deleted. If skip is specified, no
|
5056
|
+
# DB snapshot is created. If skip is not specified, a DB snapshot is
|
5057
|
+
# created before the DB instance is deleted. By default, skip is not
|
5058
|
+
# specified, and the DB snapshot is created.
|
5079
5059
|
#
|
5080
|
-
#
|
5081
|
-
#
|
5082
|
-
#
|
5060
|
+
# Note that when a DB instance is in a failure state and has a status of
|
5061
|
+
# 'failed', 'incompatible-restore', or 'incompatible-network', it
|
5062
|
+
# can only be deleted when skip is specified.
|
5083
5063
|
#
|
5084
|
-
# Specify
|
5064
|
+
# Specify skip when deleting a Read Replica.
|
5085
5065
|
#
|
5086
|
-
# <note markdown="1"> The
|
5087
|
-
#
|
5066
|
+
# <note markdown="1"> The FinalDBSnapshotIdentifier parameter must be specified if skip is
|
5067
|
+
# not specified.
|
5088
5068
|
#
|
5089
5069
|
# </note>
|
5090
5070
|
#
|
5091
|
-
# Default: `false`
|
5092
|
-
#
|
5093
5071
|
# @option params [String] :final_db_snapshot_identifier
|
5094
|
-
# The `DBSnapshotIdentifier` of the new
|
5095
|
-
# `SkipFinalSnapshot` is
|
5072
|
+
# The `DBSnapshotIdentifier` of the new `DBSnapshot` created when the
|
5073
|
+
# `SkipFinalSnapshot` parameter is disabled.
|
5096
5074
|
#
|
5097
|
-
# <note markdown="1"> Specifying this parameter and also
|
5098
|
-
#
|
5075
|
+
# <note markdown="1"> Specifying this parameter and also specifying to skip final DB
|
5076
|
+
# snapshot creation in SkipFinalShapshot results in an error.
|
5099
5077
|
#
|
5100
5078
|
# </note>
|
5101
5079
|
#
|
@@ -5112,7 +5090,8 @@ module Aws::RDS
|
|
5112
5090
|
# @option params [Boolean] :delete_automated_backups
|
5113
5091
|
# A value that indicates whether to remove automated backups immediately
|
5114
5092
|
# after the DB instance is deleted. This parameter isn't
|
5115
|
-
# case-sensitive.
|
5093
|
+
# case-sensitive. The default is to remove automated backups immediately
|
5094
|
+
# after the DB instance is deleted.
|
5116
5095
|
#
|
5117
5096
|
# @return [Types::DeleteDBInstanceResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
5118
5097
|
#
|
@@ -5741,7 +5720,7 @@ module Aws::RDS
|
|
5741
5720
|
#
|
5742
5721
|
# @option params [String] :marker
|
5743
5722
|
# An optional pagination token provided by a previous
|
5744
|
-
# DescribeCertificates request. If this parameter is specified, the
|
5723
|
+
# `DescribeCertificates` request. If this parameter is specified, the
|
5745
5724
|
# response includes only records beyond the marker, up to the value
|
5746
5725
|
# specified by `MaxRecords`.
|
5747
5726
|
#
|
@@ -5863,8 +5842,7 @@ module Aws::RDS
|
|
5863
5842
|
# * `pending`
|
5864
5843
|
#
|
5865
5844
|
# The results list includes information about only the backtracks
|
5866
|
-
# identified by these values.
|
5867
|
-
# status values, see DBClusterBacktrack.
|
5845
|
+
# identified by these values.
|
5868
5846
|
#
|
5869
5847
|
# @option params [Integer] :max_records
|
5870
5848
|
# The maximum number of records to include in the response. If more
|
@@ -5878,7 +5856,7 @@ module Aws::RDS
|
|
5878
5856
|
#
|
5879
5857
|
# @option params [String] :marker
|
5880
5858
|
# An optional pagination token provided by a previous
|
5881
|
-
# DescribeDBClusterBacktracks request. If this parameter is specified,
|
5859
|
+
# `DescribeDBClusterBacktracks` request. If this parameter is specified,
|
5882
5860
|
# the response includes only records beyond the marker, up to the value
|
5883
5861
|
# specified by `MaxRecords`.
|
5884
5862
|
#
|
@@ -5961,7 +5939,7 @@ module Aws::RDS
|
|
5961
5939
|
#
|
5962
5940
|
# @option params [String] :marker
|
5963
5941
|
# An optional pagination token provided by a previous
|
5964
|
-
# DescribeDBClusterEndpoints request. If this parameter is specified,
|
5942
|
+
# `DescribeDBClusterEndpoints` request. If this parameter is specified,
|
5965
5943
|
# the response includes only records beyond the marker, up to the value
|
5966
5944
|
# specified by `MaxRecords`.
|
5967
5945
|
#
|
@@ -6227,7 +6205,7 @@ module Aws::RDS
|
|
6227
6205
|
#
|
6228
6206
|
# To add or remove access for an AWS account to copy or restore a manual
|
6229
6207
|
# DB cluster snapshot, or to make the manual DB cluster snapshot public
|
6230
|
-
# or private, use the ModifyDBClusterSnapshotAttribute API action.
|
6208
|
+
# or private, use the `ModifyDBClusterSnapshotAttribute` API action.
|
6231
6209
|
#
|
6232
6210
|
# <note markdown="1"> This action only applies to Aurora DB clusters.
|
6233
6211
|
#
|
@@ -6336,9 +6314,9 @@ module Aws::RDS
|
|
6336
6314
|
#
|
6337
6315
|
# If you don't specify a `SnapshotType` value, then both automated and
|
6338
6316
|
# manual DB cluster snapshots are returned. You can include shared DB
|
6339
|
-
# cluster snapshots with these results by
|
6340
|
-
# parameter
|
6341
|
-
#
|
6317
|
+
# cluster snapshots with these results by enabling the `IncludeShared`
|
6318
|
+
# parameter. You can include public DB cluster snapshots with these
|
6319
|
+
# results by enabling the `IncludePublic` parameter.
|
6342
6320
|
#
|
6343
6321
|
# The `IncludeShared` and `IncludePublic` parameters don't apply for
|
6344
6322
|
# `SnapshotType` values of `manual` or `automated`. The `IncludePublic`
|
@@ -6366,18 +6344,19 @@ module Aws::RDS
|
|
6366
6344
|
# specified by `MaxRecords`.
|
6367
6345
|
#
|
6368
6346
|
# @option params [Boolean] :include_shared
|
6369
|
-
#
|
6370
|
-
# accounts that this AWS account has been given
|
6371
|
-
#
|
6347
|
+
# A value that indicates whether to include shared manual DB cluster
|
6348
|
+
# snapshots from other AWS accounts that this AWS account has been given
|
6349
|
+
# permission to copy or restore. By default, these snapshots are not
|
6350
|
+
# included.
|
6372
6351
|
#
|
6373
6352
|
# You can give an AWS account permission to restore a manual DB cluster
|
6374
6353
|
# snapshot from another AWS account by the
|
6375
|
-
# ModifyDBClusterSnapshotAttribute API action.
|
6354
|
+
# `ModifyDBClusterSnapshotAttribute` API action.
|
6376
6355
|
#
|
6377
6356
|
# @option params [Boolean] :include_public
|
6378
|
-
#
|
6379
|
-
# copied or restored by any AWS account
|
6380
|
-
# default
|
6357
|
+
# A value that indicates whether to include manual DB cluster snapshots
|
6358
|
+
# that are public and can be copied or restored by any AWS account. By
|
6359
|
+
# default, the public snapshots are not included.
|
6381
6360
|
#
|
6382
6361
|
# You can share a manual DB cluster snapshot as public by using the
|
6383
6362
|
# ModifyDBClusterSnapshotAttribute API action.
|
@@ -6501,9 +6480,10 @@ module Aws::RDS
|
|
6501
6480
|
# Constraints: Minimum 20, maximum 100.
|
6502
6481
|
#
|
6503
6482
|
# @option params [String] :marker
|
6504
|
-
# An optional pagination token provided by a previous
|
6505
|
-
# request. If this parameter is specified, the
|
6506
|
-
# records beyond the marker, up to the value
|
6483
|
+
# An optional pagination token provided by a previous
|
6484
|
+
# `DescribeDBClusters` request. If this parameter is specified, the
|
6485
|
+
# response includes only records beyond the marker, up to the value
|
6486
|
+
# specified by `MaxRecords`.
|
6507
6487
|
#
|
6508
6488
|
# @return [Types::DBClusterMessage] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
6509
6489
|
#
|
@@ -6655,16 +6635,22 @@ module Aws::RDS
|
|
6655
6635
|
# marker, up to the value specified by `MaxRecords`.
|
6656
6636
|
#
|
6657
6637
|
# @option params [Boolean] :default_only
|
6658
|
-
#
|
6659
|
-
# engine and major version combination is returned.
|
6638
|
+
# A value that indicates whether only the default version of the
|
6639
|
+
# specified engine or engine and major version combination is returned.
|
6660
6640
|
#
|
6661
6641
|
# @option params [Boolean] :list_supported_character_sets
|
6662
|
-
#
|
6642
|
+
# A value that indicates whether to list the supported character sets
|
6643
|
+
# for each engine version.
|
6644
|
+
#
|
6645
|
+
# If this parameter is enabled and the requested engine supports the
|
6663
6646
|
# `CharacterSetName` parameter for `CreateDBInstance`, the response
|
6664
6647
|
# includes a list of supported character sets for each engine version.
|
6665
6648
|
#
|
6666
6649
|
# @option params [Boolean] :list_supported_timezones
|
6667
|
-
#
|
6650
|
+
# A value that indicates whether to list the supported time zones for
|
6651
|
+
# each engine version.
|
6652
|
+
#
|
6653
|
+
# If this parameter is enabled and the requested engine supports the
|
6668
6654
|
# `TimeZone` parameter for `CreateDBInstance`, the response includes a
|
6669
6655
|
# list of supported time zones for each engine version.
|
6670
6656
|
#
|
@@ -7439,7 +7425,7 @@ module Aws::RDS
|
|
7439
7425
|
#
|
7440
7426
|
# To add or remove access for an AWS account to copy or restore a manual
|
7441
7427
|
# DB snapshot, or to make the manual DB snapshot public or private, use
|
7442
|
-
# the ModifyDBSnapshotAttribute API action.
|
7428
|
+
# the `ModifyDBSnapshotAttribute` API action.
|
7443
7429
|
#
|
7444
7430
|
# @option params [required, String] :db_snapshot_identifier
|
7445
7431
|
# The identifier for the DB snapshot to describe the attributes for.
|
@@ -7538,9 +7524,9 @@ module Aws::RDS
|
|
7538
7524
|
# If you don't specify a `SnapshotType` value, then both automated and
|
7539
7525
|
# manual snapshots are returned. Shared and public DB snapshots are not
|
7540
7526
|
# included in the returned results by default. You can include shared
|
7541
|
-
# snapshots with these results by
|
7542
|
-
#
|
7543
|
-
#
|
7527
|
+
# snapshots with these results by enabling the `IncludeShared`
|
7528
|
+
# parameter. You can include public snapshots with these results by
|
7529
|
+
# enabling the `IncludePublic` parameter.
|
7544
7530
|
#
|
7545
7531
|
# The `IncludeShared` and `IncludePublic` parameters don't apply for
|
7546
7532
|
# `SnapshotType` values of `manual` or `automated`. The `IncludePublic`
|
@@ -7572,18 +7558,19 @@ module Aws::RDS
|
|
7572
7558
|
# specified by `MaxRecords`.
|
7573
7559
|
#
|
7574
7560
|
# @option params [Boolean] :include_shared
|
7575
|
-
#
|
7576
|
-
# that this AWS account has been given
|
7577
|
-
#
|
7561
|
+
# A value that indicates whether to include shared manual DB cluster
|
7562
|
+
# snapshots from other AWS accounts that this AWS account has been given
|
7563
|
+
# permission to copy or restore. By default, these snapshots are not
|
7564
|
+
# included.
|
7578
7565
|
#
|
7579
7566
|
# You can give an AWS account permission to restore a manual DB snapshot
|
7580
|
-
# from another AWS account by using the ModifyDBSnapshotAttribute API
|
7567
|
+
# from another AWS account by using the `ModifyDBSnapshotAttribute` API
|
7581
7568
|
# action.
|
7582
7569
|
#
|
7583
7570
|
# @option params [Boolean] :include_public
|
7584
|
-
#
|
7585
|
-
# or restored by any AWS account
|
7586
|
-
#
|
7571
|
+
# A value that indicates whether to include manual DB cluster snapshots
|
7572
|
+
# that are public and can be copied or restored by any AWS account. By
|
7573
|
+
# default, the public snapshots are not included.
|
7587
7574
|
#
|
7588
7575
|
# You can share a manual DB snapshot as public by using the
|
7589
7576
|
# ModifyDBSnapshotAttribute API.
|
@@ -8284,7 +8271,7 @@ module Aws::RDS
|
|
8284
8271
|
#
|
8285
8272
|
# @option params [String] :marker
|
8286
8273
|
# An optional pagination token provided by a previous
|
8287
|
-
# DescribeGlobalClusters request. If this parameter is specified, the
|
8274
|
+
# `DescribeGlobalClusters` request. If this parameter is specified, the
|
8288
8275
|
# response includes only records beyond the marker, up to the value
|
8289
8276
|
# specified by `MaxRecords`.
|
8290
8277
|
#
|
@@ -8573,8 +8560,7 @@ module Aws::RDS
|
|
8573
8560
|
# the available offerings matching the specified license model.
|
8574
8561
|
#
|
8575
8562
|
# @option params [Boolean] :vpc
|
8576
|
-
#
|
8577
|
-
# available VPC or non-VPC offerings.
|
8563
|
+
# A value that indicates whether to show only VPC or non-VPC offerings.
|
8578
8564
|
#
|
8579
8565
|
# @option params [Array<Types::Filter>] :filters
|
8580
8566
|
# This parameter is not currently supported.
|
@@ -8802,8 +8788,8 @@ module Aws::RDS
|
|
8802
8788
|
# Valid Values: `"Partial Upfront" | "All Upfront" | "No Upfront" `
|
8803
8789
|
#
|
8804
8790
|
# @option params [Boolean] :multi_az
|
8805
|
-
#
|
8806
|
-
#
|
8791
|
+
# A value that indicates whether to show only those reservations that
|
8792
|
+
# support Multi-AZ.
|
8807
8793
|
#
|
8808
8794
|
# @option params [Array<Types::Filter>] :filters
|
8809
8795
|
# This parameter is not currently supported.
|
@@ -8932,8 +8918,8 @@ module Aws::RDS
|
|
8932
8918
|
# Valid Values: `"Partial Upfront" | "All Upfront" | "No Upfront" `
|
8933
8919
|
#
|
8934
8920
|
# @option params [Boolean] :multi_az
|
8935
|
-
#
|
8936
|
-
#
|
8921
|
+
# A value that indicates whether to show only those reservations that
|
8922
|
+
# support Multi-AZ.
|
8937
8923
|
#
|
8938
8924
|
# @option params [Array<Types::Filter>] :filters
|
8939
8925
|
# This parameter is not currently supported.
|
@@ -9046,7 +9032,7 @@ module Aws::RDS
|
|
9046
9032
|
#
|
9047
9033
|
# @option params [String] :marker
|
9048
9034
|
# An optional pagination token provided by a previous
|
9049
|
-
# DescribeSourceRegions request. If this parameter is specified, the
|
9035
|
+
# `DescribeSourceRegions` request. If this parameter is specified, the
|
9050
9036
|
# response includes only records beyond the marker, up to the value
|
9051
9037
|
# specified by `MaxRecords`.
|
9052
9038
|
#
|
@@ -9153,9 +9139,9 @@ module Aws::RDS
|
|
9153
9139
|
req.send_request(options)
|
9154
9140
|
end
|
9155
9141
|
|
9156
|
-
# You can call DescribeValidDBInstanceModifications to learn what
|
9142
|
+
# You can call `DescribeValidDBInstanceModifications` to learn what
|
9157
9143
|
# modifications you can make to your DB instance. You can use this
|
9158
|
-
# information when you call ModifyDBInstance
|
9144
|
+
# information when you call `ModifyDBInstance`.
|
9159
9145
|
#
|
9160
9146
|
# @option params [required, String] :db_instance_identifier
|
9161
9147
|
# The customer identifier or the ARN of your DB instance.
|
@@ -9549,7 +9535,7 @@ module Aws::RDS
|
|
9549
9535
|
#
|
9550
9536
|
# Constraints:
|
9551
9537
|
#
|
9552
|
-
# * Value must be `2`, `4`, `8`, `16`, `32`, `64`, `128`, or `256`.
|
9538
|
+
# * Value must be `1`, `2`, `4`, `8`, `16`, `32`, `64`, `128`, or `256`.
|
9553
9539
|
#
|
9554
9540
|
# ^
|
9555
9541
|
#
|
@@ -9645,22 +9631,22 @@ module Aws::RDS
|
|
9645
9631
|
# Example: `my-cluster2`
|
9646
9632
|
#
|
9647
9633
|
# @option params [Boolean] :apply_immediately
|
9648
|
-
# A value that
|
9634
|
+
# A value that indicates whether the modifications in this request and
|
9649
9635
|
# any pending modifications are asynchronously applied as soon as
|
9650
9636
|
# possible, regardless of the `PreferredMaintenanceWindow` setting for
|
9651
|
-
# the DB cluster. If this parameter is
|
9637
|
+
# the DB cluster. If this parameter is disabled, changes to the DB
|
9652
9638
|
# cluster are applied during the next maintenance window.
|
9653
9639
|
#
|
9654
9640
|
# The `ApplyImmediately` parameter only affects the
|
9655
9641
|
# `EnableIAMDatabaseAuthentication`, `MasterUserPassword`, and
|
9656
|
-
# `NewDBClusterIdentifier` values. If
|
9657
|
-
#
|
9658
|
-
# `
|
9659
|
-
#
|
9660
|
-
#
|
9661
|
-
#
|
9642
|
+
# `NewDBClusterIdentifier` values. If the `ApplyImmediately` parameter
|
9643
|
+
# is disabled, then changes to the `EnableIAMDatabaseAuthentication`,
|
9644
|
+
# `MasterUserPassword`, and `NewDBClusterIdentifier` values are applied
|
9645
|
+
# during the next maintenance window. All other changes are applied
|
9646
|
+
# immediately, regardless of the value of the `ApplyImmediately`
|
9647
|
+
# parameter.
|
9662
9648
|
#
|
9663
|
-
#
|
9649
|
+
# By default, this parameter is disabled.
|
9664
9650
|
#
|
9665
9651
|
# @option params [Integer] :backup_retention_period
|
9666
9652
|
# The number of days for which automated backups are retained. You must
|
@@ -9697,11 +9683,11 @@ module Aws::RDS
|
|
9697
9683
|
# A value that indicates that the DB cluster should be associated with
|
9698
9684
|
# the specified option group. Changing this parameter doesn't result in
|
9699
9685
|
# an outage except in the following case, and the change is applied
|
9700
|
-
# during the next maintenance window unless the `ApplyImmediately`
|
9701
|
-
#
|
9702
|
-
#
|
9703
|
-
#
|
9704
|
-
#
|
9686
|
+
# during the next maintenance window unless the `ApplyImmediately` is
|
9687
|
+
# enabled for this request. If the parameter change results in an option
|
9688
|
+
# group that enables OEM, this change can cause a brief (sub-second)
|
9689
|
+
# period during which new connections are rejected but existing
|
9690
|
+
# connections are not interrupted.
|
9705
9691
|
#
|
9706
9692
|
# Permanent options can't be removed from an option group. The option
|
9707
9693
|
# group can't be removed from a DB cluster once it is associated with a
|
@@ -9751,10 +9737,9 @@ module Aws::RDS
|
|
9751
9737
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_UpgradeDBInstance.Maintenance.html#AdjustingTheMaintenanceWindow.Aurora
|
9752
9738
|
#
|
9753
9739
|
# @option params [Boolean] :enable_iam_database_authentication
|
9754
|
-
#
|
9755
|
-
# accounts to database accounts
|
9756
|
-
#
|
9757
|
-
# Default: `false`
|
9740
|
+
# A value that indicates whether to enable mapping of AWS Identity and
|
9741
|
+
# Access Management (IAM) accounts to database accounts. By default,
|
9742
|
+
# mapping is disabled.
|
9758
9743
|
#
|
9759
9744
|
# @option params [Integer] :backtrack_window
|
9760
9745
|
# The target backtrack window, in seconds. To disable backtracking, set
|
@@ -9776,19 +9761,19 @@ module Aws::RDS
|
|
9776
9761
|
# @option params [String] :engine_version
|
9777
9762
|
# The version number of the database engine to which you want to
|
9778
9763
|
# upgrade. Changing this parameter results in an outage. The change is
|
9779
|
-
# applied during the next maintenance window unless
|
9780
|
-
#
|
9764
|
+
# applied during the next maintenance window unless `ApplyImmediately`
|
9765
|
+
# is enabled.
|
9781
9766
|
#
|
9782
|
-
# For a list of valid engine versions,
|
9783
|
-
# DescribeDBEngineVersions.
|
9767
|
+
# For a list of valid engine versions, use DescribeDBEngineVersions.
|
9784
9768
|
#
|
9785
9769
|
# @option params [Types::ScalingConfiguration] :scaling_configuration
|
9786
9770
|
# The scaling properties of the DB cluster. You can only modify scaling
|
9787
9771
|
# properties for DB clusters in `serverless` DB engine mode.
|
9788
9772
|
#
|
9789
9773
|
# @option params [Boolean] :deletion_protection
|
9790
|
-
#
|
9791
|
-
# database can't be deleted when
|
9774
|
+
# A value that indicates whether the DB cluster has deletion protection
|
9775
|
+
# enabled. The database can't be deleted when deletion protection is
|
9776
|
+
# enabled. By default, deletion protection is disabled.
|
9792
9777
|
#
|
9793
9778
|
# @option params [Boolean] :enable_http_endpoint
|
9794
9779
|
# <note markdown="1"> HTTP endpoint functionality is in beta for Aurora Serverless and is
|
@@ -9813,8 +9798,8 @@ module Aws::RDS
|
|
9813
9798
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless.html
|
9814
9799
|
#
|
9815
9800
|
# @option params [Boolean] :copy_tags_to_snapshot
|
9816
|
-
#
|
9817
|
-
#
|
9801
|
+
# A value that indicates whether to copy all tags from the DB cluster to
|
9802
|
+
# snapshots of the DB cluster. The default is not to copy them.
|
9818
9803
|
#
|
9819
9804
|
# @return [Types::ModifyDBClusterResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
9820
9805
|
#
|
@@ -10041,8 +10026,8 @@ module Aws::RDS
|
|
10041
10026
|
# database for a DB cluster, such as the character set for the default
|
10042
10027
|
# database defined by the `character_set_database` parameter. You can
|
10043
10028
|
# use the *Parameter Groups* option of the [Amazon RDS console][2] or
|
10044
|
-
# the DescribeDBClusterParameters
|
10045
|
-
# parameter group has been created or modified.
|
10029
|
+
# the `DescribeDBClusterParameters` action to verify that your DB
|
10030
|
+
# cluster parameter group has been created or modified.
|
10046
10031
|
#
|
10047
10032
|
# <note markdown="1"> This action only applies to Aurora DB clusters.
|
10048
10033
|
#
|
@@ -10134,7 +10119,7 @@ module Aws::RDS
|
|
10134
10119
|
#
|
10135
10120
|
# To view which AWS accounts have access to copy or restore a manual DB
|
10136
10121
|
# cluster snapshot, or whether a manual DB cluster snapshot public or
|
10137
|
-
# private, use the DescribeDBClusterSnapshotAttributes API action.
|
10122
|
+
# private, use the `DescribeDBClusterSnapshotAttributes` API action.
|
10138
10123
|
#
|
10139
10124
|
# <note markdown="1"> This action only applies to Aurora DB clusters.
|
10140
10125
|
#
|
@@ -10230,8 +10215,8 @@ module Aws::RDS
|
|
10230
10215
|
# Modifies settings for a DB instance. You can change one or more
|
10231
10216
|
# database configuration parameters by specifying these parameters and
|
10232
10217
|
# the new values in the request. To learn what modifications you can
|
10233
|
-
# make to your DB instance, call DescribeValidDBInstanceModifications
|
10234
|
-
# before you call ModifyDBInstance
|
10218
|
+
# make to your DB instance, call `DescribeValidDBInstanceModifications`
|
10219
|
+
# before you call `ModifyDBInstance`.
|
10235
10220
|
#
|
10236
10221
|
# @option params [required, String] :db_instance_identifier
|
10237
10222
|
# The DB instance identifier. This value is stored as a lowercase
|
@@ -10253,7 +10238,7 @@ module Aws::RDS
|
|
10253
10238
|
# are 10% greater than the current value.
|
10254
10239
|
#
|
10255
10240
|
# For the valid values for allocated storage for each engine, see
|
10256
|
-
# CreateDBInstance
|
10241
|
+
# `CreateDBInstance`.
|
10257
10242
|
#
|
10258
10243
|
# @option params [String] :db_instance_class
|
10259
10244
|
# The new compute and memory capacity of the DB instance, for example,
|
@@ -10264,7 +10249,7 @@ module Aws::RDS
|
|
10264
10249
|
#
|
10265
10250
|
# If you modify the DB instance class, an outage occurs during the
|
10266
10251
|
# change. The change is applied during the next maintenance window,
|
10267
|
-
# unless `ApplyImmediately` is
|
10252
|
+
# unless `ApplyImmediately` is enabled for this request.
|
10268
10253
|
#
|
10269
10254
|
# Default: Uses existing setting
|
10270
10255
|
#
|
@@ -10281,7 +10266,7 @@ module Aws::RDS
|
|
10281
10266
|
#
|
10282
10267
|
# Changing the subnet group causes an outage during the change. The
|
10283
10268
|
# change is applied during the next maintenance window, unless you
|
10284
|
-
#
|
10269
|
+
# enable `ApplyImmediately`.
|
10285
10270
|
#
|
10286
10271
|
# Constraints: If supplied, must match the name of an existing
|
10287
10272
|
# DBSubnetGroup.
|
@@ -10310,7 +10295,8 @@ module Aws::RDS
|
|
10310
10295
|
# **Amazon Aurora**
|
10311
10296
|
#
|
10312
10297
|
# Not applicable. The associated list of EC2 VPC security groups is
|
10313
|
-
# managed by the DB cluster. For more information, see
|
10298
|
+
# managed by the DB cluster. For more information, see
|
10299
|
+
# `ModifyDBCluster`.
|
10314
10300
|
#
|
10315
10301
|
# Constraints:
|
10316
10302
|
#
|
@@ -10319,21 +10305,18 @@ module Aws::RDS
|
|
10319
10305
|
# ^
|
10320
10306
|
#
|
10321
10307
|
# @option params [Boolean] :apply_immediately
|
10322
|
-
#
|
10323
|
-
# modifications are asynchronously applied as soon as
|
10324
|
-
# regardless of the `PreferredMaintenanceWindow` setting for
|
10325
|
-
# instance.
|
10326
|
-
#
|
10327
|
-
# If this parameter is set to `false`, changes to the DB instance are
|
10328
|
-
# applied during the next maintenance window. Some parameter changes can
|
10329
|
-
# cause an outage and are applied on the next call to RebootDBInstance,
|
10330
|
-
# or the next failure reboot. Review the table of parameters in
|
10331
|
-
# [Modifying a DB Instance and Using the Apply Immediately Parameter][1]
|
10332
|
-
# in the *Amazon RDS User Guide.* to see the impact that setting
|
10333
|
-
# `ApplyImmediately` to `true` or `false` has for each modified
|
10334
|
-
# parameter and to determine when the changes are applied.
|
10308
|
+
# A value that indicates whether the modifications in this request and
|
10309
|
+
# any pending modifications are asynchronously applied as soon as
|
10310
|
+
# possible, regardless of the `PreferredMaintenanceWindow` setting for
|
10311
|
+
# the DB instance. By default, this parameter is disabled.
|
10335
10312
|
#
|
10336
|
-
#
|
10313
|
+
# If this parameter is disabled, changes to the DB instance are applied
|
10314
|
+
# during the next maintenance window. Some parameter changes can cause
|
10315
|
+
# an outage and are applied on the next call to RebootDBInstance, or the
|
10316
|
+
# next failure reboot. Review the table of parameters in [Modifying a DB
|
10317
|
+
# Instance][1] in the *Amazon RDS User Guide.* to see the impact of
|
10318
|
+
# enabling or disabling `ApplyImmediately` for each modified parameter
|
10319
|
+
# and to determine when the changes are applied.
|
10337
10320
|
#
|
10338
10321
|
#
|
10339
10322
|
#
|
@@ -10352,7 +10335,7 @@ module Aws::RDS
|
|
10352
10335
|
# **Amazon Aurora**
|
10353
10336
|
#
|
10354
10337
|
# Not applicable. The password for the master user is managed by the DB
|
10355
|
-
# cluster. For more information, see ModifyDBCluster
|
10338
|
+
# cluster. For more information, see `ModifyDBCluster`.
|
10356
10339
|
#
|
10357
10340
|
# Default: Uses existing setting
|
10358
10341
|
#
|
@@ -10388,7 +10371,7 @@ module Aws::RDS
|
|
10388
10371
|
# Changing this setting doesn't result in an outage. The parameter
|
10389
10372
|
# group name itself is changed immediately, but the actual parameter
|
10390
10373
|
# changes are not applied until you reboot the instance without
|
10391
|
-
# failover. The
|
10374
|
+
# failover. The DB instance will NOT be rebooted automatically and the
|
10392
10375
|
# parameter changes will NOT be applied during the next maintenance
|
10393
10376
|
# window.
|
10394
10377
|
#
|
@@ -10405,14 +10388,14 @@ module Aws::RDS
|
|
10405
10388
|
# Changing this parameter can result in an outage if you change from 0
|
10406
10389
|
# to a non-zero value or from a non-zero value to 0. These changes are
|
10407
10390
|
# applied during the next maintenance window unless the
|
10408
|
-
# `ApplyImmediately` parameter is
|
10391
|
+
# `ApplyImmediately` parameter is enabled for this request. If you
|
10409
10392
|
# change the parameter from one non-zero value to another non-zero
|
10410
10393
|
# value, the change is asynchronously applied as soon as possible.
|
10411
10394
|
#
|
10412
10395
|
# **Amazon Aurora**
|
10413
10396
|
#
|
10414
10397
|
# Not applicable. The retention period for automated backups is managed
|
10415
|
-
# by the DB cluster. For more information, see ModifyDBCluster
|
10398
|
+
# by the DB cluster. For more information, see `ModifyDBCluster`.
|
10416
10399
|
#
|
10417
10400
|
# Default: Uses existing setting
|
10418
10401
|
#
|
@@ -10438,7 +10421,8 @@ module Aws::RDS
|
|
10438
10421
|
# **Amazon Aurora**
|
10439
10422
|
#
|
10440
10423
|
# Not applicable. The daily time range for creating automated backups is
|
10441
|
-
# managed by the DB cluster. For more information, see
|
10424
|
+
# managed by the DB cluster. For more information, see
|
10425
|
+
# `ModifyDBCluster`.
|
10442
10426
|
#
|
10443
10427
|
# Constraints:
|
10444
10428
|
#
|
@@ -10470,42 +10454,42 @@ module Aws::RDS
|
|
10470
10454
|
# Constraints: Must be at least 30 minutes
|
10471
10455
|
#
|
10472
10456
|
# @option params [Boolean] :multi_az
|
10473
|
-
#
|
10474
|
-
# parameter doesn't result in an outage and
|
10475
|
-
# during the next maintenance window unless the
|
10476
|
-
# parameter is
|
10457
|
+
# A value that indicates whether the DB instance is a Multi-AZ
|
10458
|
+
# deployment. Changing this parameter doesn't result in an outage and
|
10459
|
+
# the change is applied during the next maintenance window unless the
|
10460
|
+
# `ApplyImmediately` parameter is enabled for this request.
|
10477
10461
|
#
|
10478
10462
|
# @option params [String] :engine_version
|
10479
10463
|
# The version number of the database engine to upgrade to. Changing this
|
10480
10464
|
# parameter results in an outage and the change is applied during the
|
10481
|
-
# next maintenance window unless the `ApplyImmediately` parameter is
|
10482
|
-
#
|
10465
|
+
# next maintenance window unless the `ApplyImmediately` parameter is
|
10466
|
+
# eanbled for this request.
|
10483
10467
|
#
|
10484
10468
|
# For major version upgrades, if a nondefault DB parameter group is
|
10485
10469
|
# currently in use, a new DB parameter group in the DB parameter group
|
10486
10470
|
# family for the new engine version must be specified. The new DB
|
10487
10471
|
# parameter group can be the default for that DB parameter group family.
|
10488
10472
|
#
|
10489
|
-
# For information about valid engine versions, see CreateDBInstance
|
10490
|
-
# call DescribeDBEngineVersions
|
10473
|
+
# For information about valid engine versions, see `CreateDBInstance`,
|
10474
|
+
# or call `DescribeDBEngineVersions`.
|
10491
10475
|
#
|
10492
10476
|
# @option params [Boolean] :allow_major_version_upgrade
|
10493
|
-
#
|
10494
|
-
# parameter doesn't result in an outage and the change is
|
10477
|
+
# A value that indicates whether major version upgrades are allowed.
|
10478
|
+
# Changing this parameter doesn't result in an outage and the change is
|
10495
10479
|
# asynchronously applied as soon as possible.
|
10496
10480
|
#
|
10497
|
-
# Constraints:
|
10481
|
+
# Constraints: Major version upgrades must be allowed when specifying a
|
10498
10482
|
# value for the EngineVersion parameter that is a different major
|
10499
10483
|
# version than the DB instance's current version.
|
10500
10484
|
#
|
10501
10485
|
# @option params [Boolean] :auto_minor_version_upgrade
|
10502
|
-
#
|
10503
|
-
# DB instance during the maintenance window.
|
10504
|
-
# doesn't result in an outage except in the
|
10505
|
-
# change is asynchronously applied as soon as
|
10506
|
-
#
|
10507
|
-
# window, and a newer minor version is available, and RDS
|
10508
|
-
# auto patching for that engine version.
|
10486
|
+
# A value that indicates whether minor version upgrades are applied
|
10487
|
+
# automatically to the DB instance during the maintenance window.
|
10488
|
+
# Changing this parameter doesn't result in an outage except in the
|
10489
|
+
# following case and the change is asynchronously applied as soon as
|
10490
|
+
# possible. An outage results if this parameter is enabled during the
|
10491
|
+
# maintenance window, and a newer minor version is available, and RDS
|
10492
|
+
# has enabled auto patching for that engine version.
|
10509
10493
|
#
|
10510
10494
|
# @option params [String] :license_model
|
10511
10495
|
# The license model for the DB instance.
|
@@ -10519,10 +10503,10 @@ module Aws::RDS
|
|
10519
10503
|
#
|
10520
10504
|
# Changing this setting doesn't result in an outage and the change is
|
10521
10505
|
# applied during the next maintenance window unless the
|
10522
|
-
# `ApplyImmediately` parameter is
|
10523
|
-
#
|
10524
|
-
#
|
10525
|
-
#
|
10506
|
+
# `ApplyImmediately` parameter is enabled for this request. If you are
|
10507
|
+
# migrating from Provisioned IOPS to standard storage, set this value to
|
10508
|
+
# 0. The DB instance will require a reboot for the change in storage
|
10509
|
+
# type to take effect.
|
10526
10510
|
#
|
10527
10511
|
# If you choose to migrate your DB instance from using standard storage
|
10528
10512
|
# to using Provisioned IOPS, or from using Provisioned IOPS to using
|
@@ -10550,11 +10534,11 @@ module Aws::RDS
|
|
10550
10534
|
# Indicates that the DB instance should be associated with the specified
|
10551
10535
|
# option group. Changing this parameter doesn't result in an outage
|
10552
10536
|
# except in the following case and the change is applied during the next
|
10553
|
-
# maintenance window unless the `ApplyImmediately` parameter is
|
10554
|
-
#
|
10555
|
-
#
|
10556
|
-
#
|
10557
|
-
#
|
10537
|
+
# maintenance window unless the `ApplyImmediately` parameter is enabled
|
10538
|
+
# for this request. If the parameter change results in an option group
|
10539
|
+
# that enables OEM, this change can cause a brief (sub-second) period
|
10540
|
+
# during which new connections are rejected but existing connections are
|
10541
|
+
# not interrupted.
|
10558
10542
|
#
|
10559
10543
|
# Permanent options, such as the TDE option for Oracle Advanced Security
|
10560
10544
|
# TDE, can't be removed from an option group, and that option group
|
@@ -10564,9 +10548,9 @@ module Aws::RDS
|
|
10564
10548
|
# @option params [String] :new_db_instance_identifier
|
10565
10549
|
# The new DB instance identifier for the DB instance when renaming a DB
|
10566
10550
|
# instance. When you change the DB instance identifier, an instance
|
10567
|
-
# reboot
|
10568
|
-
#
|
10569
|
-
# Immediately
|
10551
|
+
# reboot occurs immediately if you enable `ApplyImmediately`, or will
|
10552
|
+
# occur during the next maintenance window if you disable Apply
|
10553
|
+
# Immediately. This value is stored as a lowercase string.
|
10570
10554
|
#
|
10571
10555
|
# Constraints:
|
10572
10556
|
#
|
@@ -10601,8 +10585,7 @@ module Aws::RDS
|
|
10601
10585
|
#
|
10602
10586
|
# Valid values: `standard | gp2 | io1`
|
10603
10587
|
#
|
10604
|
-
# Default: `io1` if the `Iops` parameter is specified, otherwise
|
10605
|
-
# `standard`
|
10588
|
+
# Default: `io1` if the `Iops` parameter is specified, otherwise `gp2`
|
10606
10589
|
#
|
10607
10590
|
# @option params [String] :tde_credential_arn
|
10608
10591
|
# The ARN from the key store with which to associate the instance for
|
@@ -10623,14 +10606,14 @@ module Aws::RDS
|
|
10623
10606
|
# instance can be created in a Active Directory Domain.
|
10624
10607
|
#
|
10625
10608
|
# @option params [Boolean] :copy_tags_to_snapshot
|
10626
|
-
#
|
10627
|
-
#
|
10609
|
+
# A value that indicates whether to copy all tags from the DB instance
|
10610
|
+
# to snapshots of the DB instance. By default, tags are not copied.
|
10628
10611
|
#
|
10629
10612
|
# **Amazon Aurora**
|
10630
10613
|
#
|
10631
10614
|
# Not applicable. Copying tags to snapshots is managed by the DB
|
10632
10615
|
# cluster. Setting this value for an Aurora DB instance has no effect on
|
10633
|
-
# the DB cluster setting. For more information, see ModifyDBCluster
|
10616
|
+
# the DB cluster setting. For more information, see `ModifyDBCluster`.
|
10634
10617
|
#
|
10635
10618
|
# @option params [Integer] :monitoring_interval
|
10636
10619
|
# The interval, in seconds, between points when Enhanced Monitoring
|
@@ -10692,21 +10675,20 @@ module Aws::RDS
|
|
10692
10675
|
# Valid Values: `1150-65535`
|
10693
10676
|
#
|
10694
10677
|
# @option params [Boolean] :publicly_accessible
|
10695
|
-
#
|
10696
|
-
#
|
10697
|
-
#
|
10698
|
-
#
|
10699
|
-
# with a DNS name that resolves to a private IP
|
10678
|
+
# A value that indicates whether the DB instance is publicly accessible.
|
10679
|
+
# When the DB instance is publicly accessible, it is an Internet-facing
|
10680
|
+
# instance with a publicly resolvable DNS name, which resolves to a
|
10681
|
+
# public IP address. When the DB instance is not publicly accessible, it
|
10682
|
+
# is an internal instance with a DNS name that resolves to a private IP
|
10683
|
+
# address.
|
10700
10684
|
#
|
10701
10685
|
# `PubliclyAccessible` only applies to DB instances in a VPC. The DB
|
10702
10686
|
# instance must be part of a public subnet and `PubliclyAccessible` must
|
10703
|
-
# be
|
10687
|
+
# be enabled for it to be publicly accessible.
|
10704
10688
|
#
|
10705
10689
|
# Changes to the `PubliclyAccessible` parameter are applied immediately
|
10706
10690
|
# regardless of the value of the `ApplyImmediately` parameter.
|
10707
10691
|
#
|
10708
|
-
# Default: false
|
10709
|
-
#
|
10710
10692
|
# @option params [String] :monitoring_role_arn
|
10711
10693
|
# The ARN for the IAM role that permits RDS to send enhanced monitoring
|
10712
10694
|
# metrics to Amazon CloudWatch Logs. For example,
|
@@ -10740,8 +10722,9 @@ module Aws::RDS
|
|
10740
10722
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Managing.Backups.html#Aurora.Managing.FaultTolerance
|
10741
10723
|
#
|
10742
10724
|
# @option params [Boolean] :enable_iam_database_authentication
|
10743
|
-
#
|
10744
|
-
# accounts to database accounts
|
10725
|
+
# A value that indicates whether to enable mapping of AWS Identity and
|
10726
|
+
# Access Management (IAM) accounts to database accounts. By default,
|
10727
|
+
# mapping is disabled.
|
10745
10728
|
#
|
10746
10729
|
# You can enable IAM database authentication for the following database
|
10747
10730
|
# engines
|
@@ -10749,7 +10732,8 @@ module Aws::RDS
|
|
10749
10732
|
# **Amazon Aurora**
|
10750
10733
|
#
|
10751
10734
|
# Not applicable. Mapping AWS IAM accounts to database accounts is
|
10752
|
-
# managed by the DB cluster. For more information, see
|
10735
|
+
# managed by the DB cluster. For more information, see
|
10736
|
+
# `ModifyDBCluster`.
|
10753
10737
|
#
|
10754
10738
|
# **MySQL**
|
10755
10739
|
#
|
@@ -10757,11 +10741,9 @@ module Aws::RDS
|
|
10757
10741
|
#
|
10758
10742
|
# * For MySQL 5.7, minor version 5.7.16 or higher
|
10759
10743
|
#
|
10760
|
-
# Default: `false`
|
10761
|
-
#
|
10762
10744
|
# @option params [Boolean] :enable_performance_insights
|
10763
|
-
#
|
10764
|
-
#
|
10745
|
+
# A value that indicates whether to enable Performance Insights for the
|
10746
|
+
# DB instance.
|
10765
10747
|
#
|
10766
10748
|
# For more information, see [Using Amazon Performance Insights][1] in
|
10767
10749
|
# the *Amazon Relational Database Service User Guide*.
|
@@ -10775,6 +10757,11 @@ module Aws::RDS
|
|
10775
10757
|
# data. The KMS key ID is the Amazon Resource Name (ARN), KMS key
|
10776
10758
|
# identifier, or the KMS key alias for the KMS encryption key.
|
10777
10759
|
#
|
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
|
+
#
|
10778
10765
|
# @option params [Integer] :performance_insights_retention_period
|
10779
10766
|
# The amount of time, in days, to retain Performance Insights data.
|
10780
10767
|
# Valid values are 7 or 731 (2 years).
|
@@ -10792,12 +10779,13 @@ module Aws::RDS
|
|
10792
10779
|
# instance class of the DB instance.
|
10793
10780
|
#
|
10794
10781
|
# @option params [Boolean] :use_default_processor_features
|
10795
|
-
# A value that
|
10796
|
-
# uses its default processor features.
|
10782
|
+
# A value that indicates whether the DB instance class of the DB
|
10783
|
+
# instance uses its default processor features.
|
10797
10784
|
#
|
10798
10785
|
# @option params [Boolean] :deletion_protection
|
10799
|
-
#
|
10800
|
-
# database can't be deleted when
|
10786
|
+
# A value that indicates whether the DB instance has deletion protection
|
10787
|
+
# enabled. The database can't be deleted when deletion protection is
|
10788
|
+
# enabled. By default, deletion protection is disabled. For more
|
10801
10789
|
# information, see [ Deleting a DB Instance][1].
|
10802
10790
|
#
|
10803
10791
|
#
|
@@ -11228,7 +11216,7 @@ module Aws::RDS
|
|
11228
11216
|
#
|
11229
11217
|
# To view which AWS accounts have access to copy or restore a manual DB
|
11230
11218
|
# snapshot, or whether a manual DB snapshot public or private, use the
|
11231
|
-
# DescribeDBSnapshotAttributes API action.
|
11219
|
+
# `DescribeDBSnapshotAttributes` API action.
|
11232
11220
|
#
|
11233
11221
|
# @option params [required, String] :db_snapshot_identifier
|
11234
11222
|
# The identifier for the DB snapshot to modify the attributes for.
|
@@ -11382,8 +11370,8 @@ module Aws::RDS
|
|
11382
11370
|
# Modifies an existing RDS event notification subscription. Note that
|
11383
11371
|
# you can't modify the source identifiers using this call; to change
|
11384
11372
|
# source identifiers for a subscription, use the
|
11385
|
-
# AddSourceIdentifierToSubscription and
|
11386
|
-
# RemoveSourceIdentifierFromSubscription calls.
|
11373
|
+
# `AddSourceIdentifierToSubscription` and
|
11374
|
+
# `RemoveSourceIdentifierFromSubscription` calls.
|
11387
11375
|
#
|
11388
11376
|
# You can see a list of the event categories for a given SourceType in
|
11389
11377
|
# the [Events][1] topic in the *Amazon RDS User Guide* or by using the
|
@@ -11421,7 +11409,7 @@ module Aws::RDS
|
|
11421
11409
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Events.html
|
11422
11410
|
#
|
11423
11411
|
# @option params [Boolean] :enabled
|
11424
|
-
# A
|
11412
|
+
# A value that indicates whether to activate the subscription.
|
11425
11413
|
#
|
11426
11414
|
# @return [Types::ModifyEventSubscriptionResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
11427
11415
|
#
|
@@ -11523,8 +11511,8 @@ module Aws::RDS
|
|
11523
11511
|
#
|
11524
11512
|
# @option params [Boolean] :deletion_protection
|
11525
11513
|
# Indicates if the global database cluster has deletion protection
|
11526
|
-
# enabled. The global database cluster can't be deleted when
|
11527
|
-
# is
|
11514
|
+
# enabled. The global database cluster can't be deleted when deletion
|
11515
|
+
# protection is enabled.
|
11528
11516
|
#
|
11529
11517
|
# @return [Types::ModifyGlobalClusterResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
11530
11518
|
#
|
@@ -11583,9 +11571,9 @@ module Aws::RDS
|
|
11583
11571
|
# Options in this list are removed from the option group.
|
11584
11572
|
#
|
11585
11573
|
# @option params [Boolean] :apply_immediately
|
11586
|
-
#
|
11587
|
-
# the next maintenance window for each instance associated with
|
11588
|
-
# option group.
|
11574
|
+
# A value that indicates whether to apply the change immediately or
|
11575
|
+
# during the next maintenance window for each instance associated with
|
11576
|
+
# the option group.
|
11589
11577
|
#
|
11590
11578
|
# @return [Types::ModifyOptionGroupResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
11591
11579
|
#
|
@@ -12124,10 +12112,11 @@ module Aws::RDS
|
|
12124
12112
|
# ^
|
12125
12113
|
#
|
12126
12114
|
# @option params [Boolean] :force_failover
|
12127
|
-
#
|
12115
|
+
# A value that indicates whether the reboot is conducted through a
|
12116
|
+
# Multi-AZ failover.
|
12128
12117
|
#
|
12129
|
-
# Constraint: You can't
|
12130
|
-
# configured for
|
12118
|
+
# Constraint: You can't enable force failover if the instance is not
|
12119
|
+
# configured for Multi-AZ.
|
12131
12120
|
#
|
12132
12121
|
# @return [Types::RebootDBInstanceResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
12133
12122
|
#
|
@@ -12393,7 +12382,7 @@ module Aws::RDS
|
|
12393
12382
|
# @option params [required, String] :feature_name
|
12394
12383
|
# The name of the feature for the DB instance that the IAM role is to be
|
12395
12384
|
# disassociated from. For the list of supported feature names, see
|
12396
|
-
# DBEngineVersion
|
12385
|
+
# `DBEngineVersion`.
|
12397
12386
|
#
|
12398
12387
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
12399
12388
|
#
|
@@ -12537,8 +12526,8 @@ module Aws::RDS
|
|
12537
12526
|
#
|
12538
12527
|
# When resetting the entire group, dynamic parameters are updated
|
12539
12528
|
# immediately and static parameters are set to `pending-reboot` to take
|
12540
|
-
# effect on the next DB instance restart or RebootDBInstance request.
|
12541
|
-
# You must call RebootDBInstance for every DB instance in your DB
|
12529
|
+
# effect on the next DB instance restart or `RebootDBInstance` request.
|
12530
|
+
# You must call `RebootDBInstance` for every DB instance in your DB
|
12542
12531
|
# cluster that you want the updated static parameter to apply to.
|
12543
12532
|
#
|
12544
12533
|
# For more information on Amazon Aurora, see [ What Is Amazon
|
@@ -12556,15 +12545,15 @@ module Aws::RDS
|
|
12556
12545
|
# The name of the DB cluster parameter group to reset.
|
12557
12546
|
#
|
12558
12547
|
# @option params [Boolean] :reset_all_parameters
|
12559
|
-
# A value that
|
12560
|
-
# cluster parameter group to their default values
|
12561
|
-
#
|
12562
|
-
#
|
12548
|
+
# A value that indicates whether to reset all parameters in the DB
|
12549
|
+
# cluster parameter group to their default values. You can't use this
|
12550
|
+
# parameter if there is a list of parameter names specified for the
|
12551
|
+
# `Parameters` parameter.
|
12563
12552
|
#
|
12564
12553
|
# @option params [Array<Types::Parameter>] :parameters
|
12565
12554
|
# A list of parameter names in the DB cluster parameter group to reset
|
12566
12555
|
# to the default values. You can't use this parameter if the
|
12567
|
-
# `ResetAllParameters` parameter is
|
12556
|
+
# `ResetAllParameters` parameter is enabled.
|
12568
12557
|
#
|
12569
12558
|
# @return [Types::DBClusterParameterGroupNameMessage] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
12570
12559
|
#
|
@@ -12638,10 +12627,9 @@ module Aws::RDS
|
|
12638
12627
|
# ^
|
12639
12628
|
#
|
12640
12629
|
# @option params [Boolean] :reset_all_parameters
|
12641
|
-
#
|
12642
|
-
#
|
12643
|
-
#
|
12644
|
-
# Default: `true`
|
12630
|
+
# A value that indicates whether to reset all parameters in the DB
|
12631
|
+
# parameter group to default values. By default, all parameters in the
|
12632
|
+
# DB parameter group are reset to default values.
|
12645
12633
|
#
|
12646
12634
|
# @option params [Array<Types::Parameter>] :parameters
|
12647
12635
|
# To reset the entire DB parameter group, specify the `DBParameterGroup`
|
@@ -12738,8 +12726,8 @@ module Aws::RDS
|
|
12738
12726
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraMySQL.Migrating.html
|
12739
12727
|
#
|
12740
12728
|
# @option params [Array<String>] :availability_zones
|
12741
|
-
# A list of
|
12742
|
-
# cluster can be created
|
12729
|
+
# A list of Availability Zones (AZs) where instances in the restored DB
|
12730
|
+
# cluster can be created.
|
12743
12731
|
#
|
12744
12732
|
# @option params [Integer] :backup_retention_period
|
12745
12733
|
# The number of days for which automated backups of the restored DB
|
@@ -12898,7 +12886,7 @@ module Aws::RDS
|
|
12898
12886
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html
|
12899
12887
|
#
|
12900
12888
|
# @option params [Boolean] :storage_encrypted
|
12901
|
-
#
|
12889
|
+
# A value that indicates whether the restored DB cluster is encrypted.
|
12902
12890
|
#
|
12903
12891
|
# @option params [String] :kms_key_id
|
12904
12892
|
# The AWS KMS key identifier for an encrypted DB cluster.
|
@@ -12909,17 +12897,16 @@ module Aws::RDS
|
|
12909
12897
|
# cluster, then you can use the KMS key alias instead of the ARN for the
|
12910
12898
|
# KM encryption key.
|
12911
12899
|
#
|
12912
|
-
# If the
|
12900
|
+
# If the StorageEncrypted parameter is enabled, and you do not specify a
|
12913
12901
|
# value for the `KmsKeyId` parameter, then Amazon RDS will use your
|
12914
12902
|
# default encryption key. AWS KMS creates the default encryption key for
|
12915
12903
|
# your AWS account. Your AWS account has a different default encryption
|
12916
12904
|
# key for each AWS Region.
|
12917
12905
|
#
|
12918
12906
|
# @option params [Boolean] :enable_iam_database_authentication
|
12919
|
-
#
|
12920
|
-
# accounts to database accounts
|
12921
|
-
#
|
12922
|
-
# Default: `false`
|
12907
|
+
# A value that indicates whether to enable mapping of AWS Identity and
|
12908
|
+
# Access Management (IAM) accounts to database accounts. By default,
|
12909
|
+
# mapping is disabled.
|
12923
12910
|
#
|
12924
12911
|
# @option params [required, String] :source_engine
|
12925
12912
|
# The identifier for the database engine that was backed up to create
|
@@ -12973,13 +12960,14 @@ module Aws::RDS
|
|
12973
12960
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch
|
12974
12961
|
#
|
12975
12962
|
# @option params [Boolean] :deletion_protection
|
12976
|
-
#
|
12977
|
-
# The database can't be deleted when
|
12978
|
-
# default is
|
12963
|
+
# A value that indicates whether the DB cluster has deletion protection
|
12964
|
+
# enabled. The database can't be deleted when deletion protection is
|
12965
|
+
# enabled. By default, deletion protection is disabled.
|
12979
12966
|
#
|
12980
12967
|
# @option params [Boolean] :copy_tags_to_snapshot
|
12981
|
-
#
|
12982
|
-
# restored DB cluster
|
12968
|
+
# A value that indicates whether to copy all tags from the restored DB
|
12969
|
+
# cluster to snapshots of the restored DB cluster. The default is not to
|
12970
|
+
# copy them.
|
12983
12971
|
#
|
12984
12972
|
# @return [Types::RestoreDBClusterFromS3Result] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
12985
12973
|
#
|
@@ -13124,8 +13112,8 @@ module Aws::RDS
|
|
13124
13112
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html
|
13125
13113
|
#
|
13126
13114
|
# @option params [Array<String>] :availability_zones
|
13127
|
-
# Provides the list of
|
13128
|
-
#
|
13115
|
+
# Provides the list of Availability Zones (AZs) where instances in the
|
13116
|
+
# restored DB cluster can be created.
|
13129
13117
|
#
|
13130
13118
|
# @option params [required, String] :db_cluster_identifier
|
13131
13119
|
# The name of the DB cluster to create from the DB snapshot or DB
|
@@ -13213,10 +13201,9 @@ module Aws::RDS
|
|
13213
13201
|
# not encrypted, then the restored DB cluster is not encrypted.
|
13214
13202
|
#
|
13215
13203
|
# @option params [Boolean] :enable_iam_database_authentication
|
13216
|
-
#
|
13217
|
-
# accounts to database accounts
|
13218
|
-
#
|
13219
|
-
# Default: `false`
|
13204
|
+
# A value that indicates whether to enable mapping of AWS Identity and
|
13205
|
+
# Access Management (IAM) accounts to database accounts. By default,
|
13206
|
+
# mapping is disabled.
|
13220
13207
|
#
|
13221
13208
|
# @option params [Integer] :backtrack_window
|
13222
13209
|
# The target backtrack window, in seconds. To disable backtracking, set
|
@@ -13266,13 +13253,14 @@ module Aws::RDS
|
|
13266
13253
|
# * Can't end with a hyphen or contain two consecutive hyphens.
|
13267
13254
|
#
|
13268
13255
|
# @option params [Boolean] :deletion_protection
|
13269
|
-
#
|
13270
|
-
# The database can't be deleted when
|
13271
|
-
# default is
|
13256
|
+
# A value that indicates whether the DB cluster has deletion protection
|
13257
|
+
# enabled. The database can't be deleted when deletion protection is
|
13258
|
+
# enabled. By default, deletion protection is disabled.
|
13272
13259
|
#
|
13273
13260
|
# @option params [Boolean] :copy_tags_to_snapshot
|
13274
|
-
#
|
13275
|
-
# restored DB cluster
|
13261
|
+
# A value that indicates whether to copy all tags from the restored DB
|
13262
|
+
# cluster to snapshots of the restored DB cluster. The default is not to
|
13263
|
+
# copy them.
|
13276
13264
|
#
|
13277
13265
|
# @return [Types::RestoreDBClusterFromSnapshotResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
13278
13266
|
#
|
@@ -13416,11 +13404,11 @@ module Aws::RDS
|
|
13416
13404
|
# security group.
|
13417
13405
|
#
|
13418
13406
|
# <note markdown="1"> This action only restores the DB cluster, not the DB instances for
|
13419
|
-
# that DB cluster. You must invoke the CreateDBInstance action to
|
13420
|
-
# DB instances for the restored DB cluster, specifying the
|
13421
|
-
# the restored DB cluster in `DBClusterIdentifier`. You
|
13422
|
-
# instances only after the `RestoreDBClusterToPointInTime`
|
13423
|
-
# completed and the DB cluster is available.
|
13407
|
+
# that DB cluster. You must invoke the `CreateDBInstance` action to
|
13408
|
+
# create DB instances for the restored DB cluster, specifying the
|
13409
|
+
# identifier of the restored DB cluster in `DBClusterIdentifier`. You
|
13410
|
+
# can create DB instances only after the `RestoreDBClusterToPointInTime`
|
13411
|
+
# action has completed and the DB cluster is available.
|
13424
13412
|
#
|
13425
13413
|
# </note>
|
13426
13414
|
#
|
@@ -13484,17 +13472,18 @@ module Aws::RDS
|
|
13484
13472
|
# * Must be specified if `UseLatestRestorableTime` parameter is not
|
13485
13473
|
# provided
|
13486
13474
|
#
|
13487
|
-
# * Can't be specified if `UseLatestRestorableTime` parameter is
|
13475
|
+
# * Can't be specified if the `UseLatestRestorableTime` parameter is
|
13476
|
+
# enabled
|
13488
13477
|
#
|
13489
|
-
# * Can't be specified if `RestoreType` parameter is
|
13478
|
+
# * Can't be specified if the `RestoreType` parameter is
|
13479
|
+
# `copy-on-write`
|
13490
13480
|
#
|
13491
13481
|
# Example: `2015-03-07T23:45:00Z`
|
13492
13482
|
#
|
13493
13483
|
# @option params [Boolean] :use_latest_restorable_time
|
13494
|
-
# A value that
|
13495
|
-
# restorable backup time,
|
13496
|
-
#
|
13497
|
-
# Default: `false`
|
13484
|
+
# A value that indicates whether to restore the DB cluster to the latest
|
13485
|
+
# restorable backup time. By default, the DB cluster is not restored to
|
13486
|
+
# the latest restorable backup time.
|
13498
13487
|
#
|
13499
13488
|
# Constraints: Can't be specified if `RestoreToTime` parameter is
|
13500
13489
|
# provided.
|
@@ -13557,10 +13546,9 @@ module Aws::RDS
|
|
13557
13546
|
# then the restore request is rejected.
|
13558
13547
|
#
|
13559
13548
|
# @option params [Boolean] :enable_iam_database_authentication
|
13560
|
-
#
|
13561
|
-
# accounts to database accounts
|
13562
|
-
#
|
13563
|
-
# Default: `false`
|
13549
|
+
# A value that indicates whether to enable mapping of AWS Identity and
|
13550
|
+
# Access Management (IAM) accounts to database accounts. By default,
|
13551
|
+
# mapping is disabled.
|
13564
13552
|
#
|
13565
13553
|
# @option params [Integer] :backtrack_window
|
13566
13554
|
# The target backtrack window, in seconds. To disable backtracking, set
|
@@ -13602,13 +13590,14 @@ module Aws::RDS
|
|
13602
13590
|
# * Can't end with a hyphen or contain two consecutive hyphens.
|
13603
13591
|
#
|
13604
13592
|
# @option params [Boolean] :deletion_protection
|
13605
|
-
#
|
13606
|
-
# The database can't be deleted when
|
13607
|
-
# default is
|
13593
|
+
# A value that indicates whether the DB cluster has deletion protection
|
13594
|
+
# enabled. The database can't be deleted when deletion protection is
|
13595
|
+
# enabled. By default, deletion protection is disabled.
|
13608
13596
|
#
|
13609
13597
|
# @option params [Boolean] :copy_tags_to_snapshot
|
13610
|
-
#
|
13611
|
-
# restored DB cluster
|
13598
|
+
# A value that indicates whether to copy all tags from the restored DB
|
13599
|
+
# cluster to snapshots of the restored DB cluster. The default is not to
|
13600
|
+
# copy them.
|
13612
13601
|
#
|
13613
13602
|
# @return [Types::RestoreDBClusterToPointInTimeResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
13614
13603
|
#
|
@@ -13758,7 +13747,7 @@ module Aws::RDS
|
|
13758
13747
|
# `DBSnapshotIdentifier` must be the ARN of the shared DB snapshot.
|
13759
13748
|
#
|
13760
13749
|
# <note markdown="1"> This command doesn't apply to Aurora MySQL and Aurora PostgreSQL. For
|
13761
|
-
# Aurora, use RestoreDBClusterFromSnapshot
|
13750
|
+
# Aurora, use `RestoreDBClusterFromSnapshot`.
|
13762
13751
|
#
|
13763
13752
|
# </note>
|
13764
13753
|
#
|
@@ -13807,12 +13796,12 @@ module Aws::RDS
|
|
13807
13796
|
# Constraints: Value must be `1150-65535`
|
13808
13797
|
#
|
13809
13798
|
# @option params [String] :availability_zone
|
13810
|
-
# The
|
13799
|
+
# The Availability Zone (AZ) where the DB instance will be created.
|
13811
13800
|
#
|
13812
13801
|
# Default: A random, system-chosen Availability Zone.
|
13813
13802
|
#
|
13814
|
-
# Constraint: You can't specify the AvailabilityZone parameter if the
|
13815
|
-
#
|
13803
|
+
# Constraint: You can't specify the `AvailabilityZone` parameter if the
|
13804
|
+
# DB instance is a Multi-AZ deployment.
|
13816
13805
|
#
|
13817
13806
|
# Example: `us-east-1a`
|
13818
13807
|
#
|
@@ -13825,21 +13814,23 @@ module Aws::RDS
|
|
13825
13814
|
# Example: `mySubnetgroup`
|
13826
13815
|
#
|
13827
13816
|
# @option params [Boolean] :multi_az
|
13828
|
-
#
|
13817
|
+
# A value that indicates whether the DB instance is a Multi-AZ
|
13818
|
+
# deployment.
|
13829
13819
|
#
|
13830
|
-
# Constraint: You can't specify the AvailabilityZone parameter if the
|
13831
|
-
#
|
13820
|
+
# Constraint: You can't specify the `AvailabilityZone` parameter if the
|
13821
|
+
# DB instance is a Multi-AZ deployment.
|
13832
13822
|
#
|
13833
13823
|
# @option params [Boolean] :publicly_accessible
|
13834
|
-
#
|
13835
|
-
#
|
13836
|
-
# DNS name, which resolves to a
|
13837
|
-
#
|
13838
|
-
#
|
13824
|
+
# A value that indicates whether the DB instance is publicly accessible.
|
13825
|
+
# When the DB instance is publicly accessible, it is an Internet-facing
|
13826
|
+
# instance with a publicly resolvable DNS name, which resolves to a
|
13827
|
+
# public IP address. When the DB instance is not publicly accessible, it
|
13828
|
+
# is an internal instance with a DNS name that resolves to a private IP
|
13829
|
+
# address. For more information, see CreateDBInstance.
|
13839
13830
|
#
|
13840
13831
|
# @option params [Boolean] :auto_minor_version_upgrade
|
13841
|
-
#
|
13842
|
-
# DB instance during the maintenance window.
|
13832
|
+
# A value that indicates whether minor version upgrades are applied
|
13833
|
+
# automatically to the DB instance during the maintenance window.
|
13843
13834
|
#
|
13844
13835
|
# @option params [String] :license_model
|
13845
13836
|
# License model information for the restored DB instance.
|
@@ -13933,8 +13924,7 @@ module Aws::RDS
|
|
13933
13924
|
# If you specify `io1`, you must also include a value for the `Iops`
|
13934
13925
|
# parameter.
|
13935
13926
|
#
|
13936
|
-
# Default: `io1` if the `Iops` parameter is specified, otherwise
|
13937
|
-
# `standard`
|
13927
|
+
# Default: `io1` if the `Iops` parameter is specified, otherwise `gp2`
|
13938
13928
|
#
|
13939
13929
|
# @option params [String] :tde_credential_arn
|
13940
13930
|
# The ARN from the key store with which to associate the instance for
|
@@ -13954,16 +13944,18 @@ module Aws::RDS
|
|
13954
13944
|
# Specify the Active Directory Domain to restore the instance in.
|
13955
13945
|
#
|
13956
13946
|
# @option params [Boolean] :copy_tags_to_snapshot
|
13957
|
-
#
|
13958
|
-
#
|
13947
|
+
# A value that indicates whether to copy all tags from the restored DB
|
13948
|
+
# instance to snapshots of the DB instance. By default, tags are not
|
13949
|
+
# copied.
|
13959
13950
|
#
|
13960
13951
|
# @option params [String] :domain_iam_role_name
|
13961
13952
|
# Specify the name of the IAM role to be used when making API calls to
|
13962
13953
|
# the Directory Service.
|
13963
13954
|
#
|
13964
13955
|
# @option params [Boolean] :enable_iam_database_authentication
|
13965
|
-
#
|
13966
|
-
# accounts to database accounts
|
13956
|
+
# A value that indicates whether to enable mapping of AWS Identity and
|
13957
|
+
# Access Management (IAM) accounts to database accounts. By default,
|
13958
|
+
# mapping is disabled.
|
13967
13959
|
#
|
13968
13960
|
# You can enable IAM database authentication for the following database
|
13969
13961
|
# engines
|
@@ -13972,8 +13964,6 @@ module Aws::RDS
|
|
13972
13964
|
#
|
13973
13965
|
# * For MySQL 5.7, minor version 5.7.16 or higher
|
13974
13966
|
#
|
13975
|
-
# Default: `false`
|
13976
|
-
#
|
13977
13967
|
# @option params [Array<String>] :enable_cloudwatch_logs_exports
|
13978
13968
|
# The list of logs that the restored DB instance is to export to
|
13979
13969
|
# CloudWatch Logs. The values in the list depend on the DB engine being
|
@@ -13989,8 +13979,8 @@ module Aws::RDS
|
|
13989
13979
|
# instance class of the DB instance.
|
13990
13980
|
#
|
13991
13981
|
# @option params [Boolean] :use_default_processor_features
|
13992
|
-
# A value that
|
13993
|
-
# uses its default processor features.
|
13982
|
+
# A value that indicates whether the DB instance class of the DB
|
13983
|
+
# instance uses its default processor features.
|
13994
13984
|
#
|
13995
13985
|
# @option params [String] :db_parameter_group_name
|
13996
13986
|
# The name of the DB parameter group to associate with this DB instance.
|
@@ -14008,10 +13998,10 @@ module Aws::RDS
|
|
14008
13998
|
# * Can't end with a hyphen or contain two consecutive hyphens.
|
14009
13999
|
#
|
14010
14000
|
# @option params [Boolean] :deletion_protection
|
14011
|
-
#
|
14012
|
-
# The database can't be deleted when
|
14013
|
-
# default is
|
14014
|
-
# Instance][1].
|
14001
|
+
# A value that indicates whether the DB instance has deletion protection
|
14002
|
+
# enabled. The database can't be deleted when deletion protection is
|
14003
|
+
# enabled. By default, deletion protection is disabled. For more
|
14004
|
+
# information, see [ Deleting a DB Instance][1].
|
14015
14005
|
#
|
14016
14006
|
#
|
14017
14007
|
#
|
@@ -14296,7 +14286,7 @@ module Aws::RDS
|
|
14296
14286
|
#
|
14297
14287
|
# @option params [String] :db_name
|
14298
14288
|
# The name of the database to create when the DB instance is created.
|
14299
|
-
# Follow the naming rules specified in CreateDBInstance
|
14289
|
+
# Follow the naming rules specified in `CreateDBInstance`.
|
14300
14290
|
#
|
14301
14291
|
# @option params [required, String] :db_instance_identifier
|
14302
14292
|
# The DB instance identifier. This parameter is stored as a lowercase
|
@@ -14314,7 +14304,7 @@ module Aws::RDS
|
|
14314
14304
|
#
|
14315
14305
|
# @option params [Integer] :allocated_storage
|
14316
14306
|
# The amount of storage (in gigabytes) to allocate initially for the DB
|
14317
|
-
# instance. Follow the allocation rules specified in CreateDBInstance
|
14307
|
+
# instance. Follow the allocation rules specified in `CreateDBInstance`.
|
14318
14308
|
#
|
14319
14309
|
# <note markdown="1"> Be sure to allocate enough memory for your new DB instance so that the
|
14320
14310
|
# restore operation can succeed. You can also allocate additional memory
|
@@ -14376,9 +14366,9 @@ module Aws::RDS
|
|
14376
14366
|
#
|
14377
14367
|
# Example: `us-east-1d`
|
14378
14368
|
#
|
14379
|
-
# Constraint: The AvailabilityZone parameter can't be specified if
|
14380
|
-
#
|
14381
|
-
# must be in the same AWS Region as the current endpoint.
|
14369
|
+
# Constraint: The `AvailabilityZone` parameter can't be specified if
|
14370
|
+
# the DB instance is a Multi-AZ deployment. The specified Availability
|
14371
|
+
# Zone must be in the same AWS Region as the current endpoint.
|
14382
14372
|
#
|
14383
14373
|
#
|
14384
14374
|
#
|
@@ -14416,7 +14406,7 @@ module Aws::RDS
|
|
14416
14406
|
# @option params [Integer] :backup_retention_period
|
14417
14407
|
# The number of days for which automated backups are retained. Setting
|
14418
14408
|
# this parameter to a positive number enables backups. For more
|
14419
|
-
# information, see CreateDBInstance
|
14409
|
+
# information, see `CreateDBInstance`.
|
14420
14410
|
#
|
14421
14411
|
# @option params [String] :preferred_backup_window
|
14422
14412
|
# The time range each day during which automated backups are created if
|
@@ -14447,19 +14437,19 @@ module Aws::RDS
|
|
14447
14437
|
# Default: `3306`
|
14448
14438
|
#
|
14449
14439
|
# @option params [Boolean] :multi_az
|
14450
|
-
#
|
14451
|
-
# is
|
14440
|
+
# A value that indicates whether the DB instance is a Multi-AZ
|
14441
|
+
# deployment. If the DB instance is a Multi-AZ deployment, you can't
|
14442
|
+
# set the `AvailabilityZone` parameter.
|
14452
14443
|
#
|
14453
14444
|
# @option params [String] :engine_version
|
14454
14445
|
# The version number of the database engine to use. Choose the latest
|
14455
14446
|
# minor version of your database engine. For information about engine
|
14456
|
-
# versions, see CreateDBInstance
|
14447
|
+
# versions, see `CreateDBInstance`, or call `DescribeDBEngineVersions`.
|
14457
14448
|
#
|
14458
14449
|
# @option params [Boolean] :auto_minor_version_upgrade
|
14459
|
-
#
|
14460
|
-
# to the DB instance during the maintenance window
|
14461
|
-
#
|
14462
|
-
# Default: `true`
|
14450
|
+
# A value that indicates whether minor engine upgrades are applied
|
14451
|
+
# automatically to the DB instance during the maintenance window. By
|
14452
|
+
# default, minor engine upgrades are not applied automatically.
|
14463
14453
|
#
|
14464
14454
|
# @option params [String] :license_model
|
14465
14455
|
# The license model for this DB instance. Use `general-public-license`.
|
@@ -14480,11 +14470,12 @@ module Aws::RDS
|
|
14480
14470
|
# engine is used.
|
14481
14471
|
#
|
14482
14472
|
# @option params [Boolean] :publicly_accessible
|
14483
|
-
#
|
14484
|
-
#
|
14485
|
-
# DNS name, which resolves to a
|
14486
|
-
#
|
14487
|
-
#
|
14473
|
+
# A value that indicates whether the DB instance is publicly accessible.
|
14474
|
+
# When the DB instance is publicly accessible, it is an Internet-facing
|
14475
|
+
# instance with a publicly resolvable DNS name, which resolves to a
|
14476
|
+
# public IP address. When the DB instance is not publicly accessible, it
|
14477
|
+
# is an internal instance with a DNS name that resolves to a private IP
|
14478
|
+
# address. For more information, see CreateDBInstance.
|
14488
14479
|
#
|
14489
14480
|
# @option params [Array<Types::Tag>] :tags
|
14490
14481
|
# A list of tags to associate with this DB instance. For more
|
@@ -14503,11 +14494,11 @@ module Aws::RDS
|
|
14503
14494
|
# If you specify `io1`, you must also include a value for the `Iops`
|
14504
14495
|
# parameter.
|
14505
14496
|
#
|
14506
|
-
# Default: `io1` if the `Iops` parameter is specified; otherwise
|
14507
|
-
# `standard`
|
14497
|
+
# Default: `io1` if the `Iops` parameter is specified; otherwise `gp2`
|
14508
14498
|
#
|
14509
14499
|
# @option params [Boolean] :storage_encrypted
|
14510
|
-
#
|
14500
|
+
# A value that indicates whether the new DB instance is encrypted or
|
14501
|
+
# not.
|
14511
14502
|
#
|
14512
14503
|
# @option params [String] :kms_key_id
|
14513
14504
|
# The AWS KMS key identifier for an encrypted DB instance.
|
@@ -14518,17 +14509,15 @@ module Aws::RDS
|
|
14518
14509
|
# instance, then you can use the KMS key alias instead of the ARN for
|
14519
14510
|
# the KM encryption key.
|
14520
14511
|
#
|
14521
|
-
# If the `StorageEncrypted` parameter is
|
14522
|
-
# value for the `KmsKeyId` parameter, then Amazon RDS will use your
|
14512
|
+
# If the `StorageEncrypted` parameter is enabled, and you do not specify
|
14513
|
+
# a value for the `KmsKeyId` parameter, then Amazon RDS will use your
|
14523
14514
|
# default encryption key. AWS KMS creates the default encryption key for
|
14524
14515
|
# your AWS account. Your AWS account has a different default encryption
|
14525
14516
|
# key for each AWS Region.
|
14526
14517
|
#
|
14527
14518
|
# @option params [Boolean] :copy_tags_to_snapshot
|
14528
|
-
#
|
14529
|
-
# the
|
14530
|
-
#
|
14531
|
-
# Default: false.
|
14519
|
+
# A value that indicates whether to copy all tags from the DB instance
|
14520
|
+
# to snapshots of the DB instance. By default, tags are not copied.
|
14532
14521
|
#
|
14533
14522
|
# @option params [Integer] :monitoring_interval
|
14534
14523
|
# The interval, in seconds, between points when Enhanced Monitoring
|
@@ -14557,10 +14546,9 @@ module Aws::RDS
|
|
14557
14546
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Monitoring.OS.html#USER_Monitoring.OS.Enabling
|
14558
14547
|
#
|
14559
14548
|
# @option params [Boolean] :enable_iam_database_authentication
|
14560
|
-
#
|
14561
|
-
# accounts to database accounts
|
14562
|
-
#
|
14563
|
-
# Default: `false`
|
14549
|
+
# A value that indicates whether to enable mapping of AWS Identity and
|
14550
|
+
# Access Management (IAM) accounts to database accounts. By default,
|
14551
|
+
# mapping is disabled.
|
14564
14552
|
#
|
14565
14553
|
# @option params [required, String] :source_engine
|
14566
14554
|
# The name of the engine of your source database.
|
@@ -14584,8 +14572,8 @@ module Aws::RDS
|
|
14584
14572
|
# to access your Amazon S3 bucket.
|
14585
14573
|
#
|
14586
14574
|
# @option params [Boolean] :enable_performance_insights
|
14587
|
-
#
|
14588
|
-
#
|
14575
|
+
# A value that indicates whether to enable Performance Insights for the
|
14576
|
+
# DB instance.
|
14589
14577
|
#
|
14590
14578
|
# For more information, see [Using Amazon Performance Insights][1] in
|
14591
14579
|
# the *Amazon Relational Database Service User Guide*.
|
@@ -14599,6 +14587,11 @@ module Aws::RDS
|
|
14599
14587
|
# data. The KMS key ID is the Amazon Resource Name (ARN), the KMS key
|
14600
14588
|
# identifier, or the KMS key alias for the KMS encryption key.
|
14601
14589
|
#
|
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
|
+
#
|
14602
14595
|
# @option params [Integer] :performance_insights_retention_period
|
14603
14596
|
# The amount of time, in days, to retain Performance Insights data.
|
14604
14597
|
# Valid values are 7 or 731 (2 years).
|
@@ -14618,14 +14611,14 @@ module Aws::RDS
|
|
14618
14611
|
# instance class of the DB instance.
|
14619
14612
|
#
|
14620
14613
|
# @option params [Boolean] :use_default_processor_features
|
14621
|
-
# A value that
|
14622
|
-
# uses its default processor features.
|
14614
|
+
# A value that indicates whether the DB instance class of the DB
|
14615
|
+
# instance uses its default processor features.
|
14623
14616
|
#
|
14624
14617
|
# @option params [Boolean] :deletion_protection
|
14625
|
-
#
|
14626
|
-
# The database can't be deleted when
|
14627
|
-
# default is
|
14628
|
-
# Instance][1].
|
14618
|
+
# A value that indicates whether the DB instance has deletion protection
|
14619
|
+
# enabled. The database can't be deleted when deletion protection is
|
14620
|
+
# enabled. By default, deletion protection is disabled. For more
|
14621
|
+
# information, see [ Deleting a DB Instance][1].
|
14629
14622
|
#
|
14630
14623
|
#
|
14631
14624
|
#
|
@@ -14832,7 +14825,7 @@ module Aws::RDS
|
|
14832
14825
|
# deployment.
|
14833
14826
|
#
|
14834
14827
|
# <note markdown="1"> This command doesn't apply to Aurora MySQL and Aurora PostgreSQL. For
|
14835
|
-
# Aurora, use RestoreDBClusterToPointInTime
|
14828
|
+
# Aurora, use `RestoreDBClusterToPointInTime`.
|
14836
14829
|
#
|
14837
14830
|
# </note>
|
14838
14831
|
#
|
@@ -14866,17 +14859,18 @@ module Aws::RDS
|
|
14866
14859
|
#
|
14867
14860
|
# * Must be before the latest restorable time for the DB instance
|
14868
14861
|
#
|
14869
|
-
# * Can't be specified if UseLatestRestorableTime parameter is
|
14862
|
+
# * Can't be specified if the `UseLatestRestorableTime` parameter is
|
14863
|
+
# enabled
|
14870
14864
|
#
|
14871
14865
|
# Example: `2009-09-07T23:45:00Z`
|
14872
14866
|
#
|
14873
14867
|
# @option params [Boolean] :use_latest_restorable_time
|
14874
|
-
#
|
14875
|
-
#
|
14876
|
-
#
|
14877
|
-
# Default: `false`
|
14868
|
+
# A value that indicates whether the DB instance is restored from the
|
14869
|
+
# latest backup time. By default, the DB instance is not restored from
|
14870
|
+
# the latest backup time.
|
14878
14871
|
#
|
14879
|
-
# Constraints: Can't be specified if RestoreTime parameter is
|
14872
|
+
# Constraints: Can't be specified if the `RestoreTime` parameter is
|
14873
|
+
# provided.
|
14880
14874
|
#
|
14881
14875
|
# @option params [String] :db_instance_class
|
14882
14876
|
# The compute and memory capacity of the Amazon RDS DB instance, for
|
@@ -14899,12 +14893,12 @@ module Aws::RDS
|
|
14899
14893
|
# Default: The same port as the original DB instance.
|
14900
14894
|
#
|
14901
14895
|
# @option params [String] :availability_zone
|
14902
|
-
# The
|
14896
|
+
# The Availability Zone (AZ) where the DB instance will be created.
|
14903
14897
|
#
|
14904
14898
|
# Default: A random, system-chosen Availability Zone.
|
14905
14899
|
#
|
14906
|
-
# Constraint: You can't specify the AvailabilityZone parameter if the
|
14907
|
-
#
|
14900
|
+
# Constraint: You can't specify the `AvailabilityZone` parameter if the
|
14901
|
+
# DB instance is a Multi-AZ deployment.
|
14908
14902
|
#
|
14909
14903
|
# Example: `us-east-1a`
|
14910
14904
|
#
|
@@ -14917,21 +14911,23 @@ module Aws::RDS
|
|
14917
14911
|
# Example: `mySubnetgroup`
|
14918
14912
|
#
|
14919
14913
|
# @option params [Boolean] :multi_az
|
14920
|
-
#
|
14914
|
+
# A value that indicates whether the DB instance is a Multi-AZ
|
14915
|
+
# deployment.
|
14921
14916
|
#
|
14922
|
-
# Constraint: You can't specify the AvailabilityZone parameter if the
|
14923
|
-
#
|
14917
|
+
# Constraint: You can't specify the `AvailabilityZone` parameter if the
|
14918
|
+
# DB instance is a Multi-AZ deployment.
|
14924
14919
|
#
|
14925
14920
|
# @option params [Boolean] :publicly_accessible
|
14926
|
-
#
|
14927
|
-
#
|
14928
|
-
# DNS name, which resolves to a
|
14929
|
-
#
|
14930
|
-
#
|
14921
|
+
# A value that indicates whether the DB instance is publicly accessible.
|
14922
|
+
# When the DB instance is publicly accessible, it is an Internet-facing
|
14923
|
+
# instance with a publicly resolvable DNS name, which resolves to a
|
14924
|
+
# public IP address. When the DB instance is not publicly accessible, it
|
14925
|
+
# is an internal instance with a DNS name that resolves to a private IP
|
14926
|
+
# address. For more information, see CreateDBInstance.
|
14931
14927
|
#
|
14932
14928
|
# @option params [Boolean] :auto_minor_version_upgrade
|
14933
|
-
#
|
14934
|
-
# DB instance during the maintenance window.
|
14929
|
+
# A value that indicates whether minor version upgrades are applied
|
14930
|
+
# automatically to the DB instance during the maintenance window.
|
14935
14931
|
#
|
14936
14932
|
# @option params [String] :license_model
|
14937
14933
|
# License model information for the restored DB instance.
|
@@ -14999,8 +14995,9 @@ module Aws::RDS
|
|
14999
14995
|
# instance
|
15000
14996
|
#
|
15001
14997
|
# @option params [Boolean] :copy_tags_to_snapshot
|
15002
|
-
#
|
15003
|
-
#
|
14998
|
+
# A value that indicates whether to copy all tags from the restored DB
|
14999
|
+
# instance to snapshots of the DB instance. By default, tags are not
|
15000
|
+
# copied.
|
15004
15001
|
#
|
15005
15002
|
# @option params [Array<Types::Tag>] :tags
|
15006
15003
|
# A list of tags. For more information, see [Tagging Amazon RDS
|
@@ -15018,8 +15015,7 @@ module Aws::RDS
|
|
15018
15015
|
# If you specify `io1`, you must also include a value for the `Iops`
|
15019
15016
|
# parameter.
|
15020
15017
|
#
|
15021
|
-
# Default: `io1` if the `Iops` parameter is specified, otherwise
|
15022
|
-
# `standard`
|
15018
|
+
# Default: `io1` if the `Iops` parameter is specified, otherwise `gp2`
|
15023
15019
|
#
|
15024
15020
|
# @option params [String] :tde_credential_arn
|
15025
15021
|
# The ARN from the key store with which to associate the instance for
|
@@ -15043,8 +15039,9 @@ module Aws::RDS
|
|
15043
15039
|
# the Directory Service.
|
15044
15040
|
#
|
15045
15041
|
# @option params [Boolean] :enable_iam_database_authentication
|
15046
|
-
#
|
15047
|
-
# accounts to database accounts
|
15042
|
+
# A value that indicates whether to enable mapping of AWS Identity and
|
15043
|
+
# Access Management (IAM) accounts to database accounts. By default,
|
15044
|
+
# mapping is disabled.
|
15048
15045
|
#
|
15049
15046
|
# You can enable IAM database authentication for the following database
|
15050
15047
|
# engines
|
@@ -15053,8 +15050,6 @@ module Aws::RDS
|
|
15053
15050
|
#
|
15054
15051
|
# * For MySQL 5.7, minor version 5.7.16 or higher
|
15055
15052
|
#
|
15056
|
-
# Default: `false`
|
15057
|
-
#
|
15058
15053
|
# @option params [Array<String>] :enable_cloudwatch_logs_exports
|
15059
15054
|
# The list of logs that the restored DB instance is to export to
|
15060
15055
|
# CloudWatch Logs. The values in the list depend on the DB engine being
|
@@ -15070,8 +15065,8 @@ module Aws::RDS
|
|
15070
15065
|
# instance class of the DB instance.
|
15071
15066
|
#
|
15072
15067
|
# @option params [Boolean] :use_default_processor_features
|
15073
|
-
# A value that
|
15074
|
-
# uses its default processor features.
|
15068
|
+
# A value that indicates whether the DB instance class of the DB
|
15069
|
+
# instance uses its default processor features.
|
15075
15070
|
#
|
15076
15071
|
# @option params [String] :db_parameter_group_name
|
15077
15072
|
# The name of the DB parameter group to associate with this DB instance.
|
@@ -15089,10 +15084,10 @@ module Aws::RDS
|
|
15089
15084
|
# * Can't end with a hyphen or contain two consecutive hyphens.
|
15090
15085
|
#
|
15091
15086
|
# @option params [Boolean] :deletion_protection
|
15092
|
-
#
|
15093
|
-
# The database can't be deleted when
|
15094
|
-
# default is
|
15095
|
-
# Instance][1].
|
15087
|
+
# A value that indicates whether the DB instance has deletion protection
|
15088
|
+
# enabled. The database can't be deleted when deletion protection is
|
15089
|
+
# enabled. By default, deletion protection is disabled. For more
|
15090
|
+
# information, see [ Deleting a DB Instance][1].
|
15096
15091
|
#
|
15097
15092
|
#
|
15098
15093
|
#
|
@@ -15574,7 +15569,7 @@ module Aws::RDS
|
|
15574
15569
|
# Was Previously Stopped][1] in the *Amazon RDS User Guide.*
|
15575
15570
|
#
|
15576
15571
|
# <note markdown="1"> This command doesn't apply to Aurora MySQL and Aurora PostgreSQL. For
|
15577
|
-
# Aurora DB clusters, use StartDBCluster instead.
|
15572
|
+
# Aurora DB clusters, use `StartDBCluster` instead.
|
15578
15573
|
#
|
15579
15574
|
# </note>
|
15580
15575
|
#
|
@@ -15836,7 +15831,7 @@ module Aws::RDS
|
|
15836
15831
|
# Temporarily][1] in the *Amazon RDS User Guide.*
|
15837
15832
|
#
|
15838
15833
|
# <note markdown="1"> This command doesn't apply to Aurora MySQL and Aurora PostgreSQL. For
|
15839
|
-
# Aurora clusters, use StopDBCluster instead.
|
15834
|
+
# Aurora clusters, use `StopDBCluster` instead.
|
15840
15835
|
#
|
15841
15836
|
# </note>
|
15842
15837
|
#
|
@@ -15999,7 +15994,7 @@ module Aws::RDS
|
|
15999
15994
|
params: params,
|
16000
15995
|
config: config)
|
16001
15996
|
context[:gem_name] = 'aws-sdk-rds'
|
16002
|
-
context[:gem_version] = '1.
|
15997
|
+
context[:gem_version] = '1.52.0'
|
16003
15998
|
Seahorse::Client::Request.new(handlers, context)
|
16004
15999
|
end
|
16005
16000
|
|