aws-sdk-rds 1.166.0 → 1.168.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/CHANGELOG.md +10 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-rds/client.rb +513 -60
- data/lib/aws-sdk-rds/client_api.rb +38 -4
- data/lib/aws-sdk-rds/db_cluster.rb +165 -2
- data/lib/aws-sdk-rds/db_engine_version.rb +13 -0
- data/lib/aws-sdk-rds/db_instance.rb +146 -0
- data/lib/aws-sdk-rds/errors.rb +11 -0
- data/lib/aws-sdk-rds/resource.rb +97 -1
- data/lib/aws-sdk-rds/types.rb +552 -10
- data/lib/aws-sdk-rds.rb +1 -1
- metadata +2 -2
data/lib/aws-sdk-rds/client.rb
CHANGED
@@ -1918,54 +1918,7 @@ module Aws::RDS
|
|
1918
1918
|
req.send_request(options)
|
1919
1919
|
end
|
1920
1920
|
|
1921
|
-
# Creates a custom DB engine version (CEV).
|
1922
|
-
# snapshot of a database engine and specific AMI. The supported engines
|
1923
|
-
# are the following:
|
1924
|
-
#
|
1925
|
-
# * Oracle Database 12.1 Enterprise Edition with the January 2021 or
|
1926
|
-
# later RU/RUR
|
1927
|
-
#
|
1928
|
-
# * Oracle Database 19c Enterprise Edition with the January 2021 or
|
1929
|
-
# later RU/RUR
|
1930
|
-
#
|
1931
|
-
# Amazon RDS, which is a fully managed service, supplies the Amazon
|
1932
|
-
# Machine Image (AMI) and database software. The Amazon RDS database
|
1933
|
-
# software is preinstalled, so you need only select a DB engine and
|
1934
|
-
# version, and create your database. With Amazon RDS Custom for Oracle,
|
1935
|
-
# you upload your database installation files in Amazon S3.
|
1936
|
-
#
|
1937
|
-
# When you create a custom engine version, you specify the files in a
|
1938
|
-
# JSON document called a CEV manifest. This document describes
|
1939
|
-
# installation .zip files stored in Amazon S3. RDS Custom creates your
|
1940
|
-
# CEV from the installation files that you provided. This service model
|
1941
|
-
# is called Bring Your Own Media (BYOM).
|
1942
|
-
#
|
1943
|
-
# Creation takes approximately two hours. If creation fails, RDS Custom
|
1944
|
-
# issues `RDS-EVENT-0196` with the message `Creation failed for custom
|
1945
|
-
# engine version`, and includes details about the failure. For example,
|
1946
|
-
# the event prints missing files.
|
1947
|
-
#
|
1948
|
-
# After you create the CEV, it is available for use. You can create
|
1949
|
-
# multiple CEVs, and create multiple RDS Custom instances from any CEV.
|
1950
|
-
# You can also change the status of a CEV to make it available or
|
1951
|
-
# inactive.
|
1952
|
-
#
|
1953
|
-
# <note markdown="1"> The MediaImport service that imports files from Amazon S3 to create
|
1954
|
-
# CEVs isn't integrated with Amazon Web Services CloudTrail. If you
|
1955
|
-
# turn on data logging for Amazon RDS in CloudTrail, calls to the
|
1956
|
-
# `CreateCustomDbEngineVersion` event aren't logged. However, you might
|
1957
|
-
# see calls from the API gateway that accesses your Amazon S3 bucket.
|
1958
|
-
# These calls originate from the MediaImport service for the
|
1959
|
-
# `CreateCustomDbEngineVersion` event.
|
1960
|
-
#
|
1961
|
-
# </note>
|
1962
|
-
#
|
1963
|
-
# For more information, see [ Creating a CEV][1] in the *Amazon RDS User
|
1964
|
-
# Guide*.
|
1965
|
-
#
|
1966
|
-
#
|
1967
|
-
#
|
1968
|
-
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-cev.html#custom-cev.create
|
1921
|
+
# Creates a custom DB engine version (CEV).
|
1969
1922
|
#
|
1970
1923
|
# @option params [required, String] :engine
|
1971
1924
|
# The database engine to use for your custom engine version (CEV). The
|
@@ -1978,7 +1931,7 @@ module Aws::RDS
|
|
1978
1931
|
# combination of `Engine` and `EngineVersion` is unique per customer per
|
1979
1932
|
# Region.
|
1980
1933
|
#
|
1981
|
-
# @option params [
|
1934
|
+
# @option params [String] :database_installation_files_s3_bucket_name
|
1982
1935
|
# The name of an Amazon S3 bucket that contains database installation
|
1983
1936
|
# files for your CEV. For example, a valid bucket name is
|
1984
1937
|
# `my-custom-installation-files`.
|
@@ -1988,7 +1941,11 @@ module Aws::RDS
|
|
1988
1941
|
# for your CEV. For example, a valid bucket name is `123456789012/cev1`.
|
1989
1942
|
# If this setting isn't specified, no prefix is assumed.
|
1990
1943
|
#
|
1991
|
-
# @option params [
|
1944
|
+
# @option params [String] :image_id
|
1945
|
+
# The ID of the AMI. An AMI ID is required to create a CEV for RDS
|
1946
|
+
# Custom for SQL Server.
|
1947
|
+
#
|
1948
|
+
# @option params [String] :kms_key_id
|
1992
1949
|
# The Amazon Web Services KMS key identifier for an encrypted CEV. A
|
1993
1950
|
# symmetric encryption KMS key is required for RDS Custom, but optional
|
1994
1951
|
# for Amazon RDS.
|
@@ -2010,7 +1967,7 @@ module Aws::RDS
|
|
2010
1967
|
# @option params [String] :description
|
2011
1968
|
# An optional description of your CEV.
|
2012
1969
|
#
|
2013
|
-
# @option params [
|
1970
|
+
# @option params [String] :manifest
|
2014
1971
|
# The CEV manifest, which is a JSON document that describes the
|
2015
1972
|
# installation .zip files stored in Amazon S3. Specify the name/value
|
2016
1973
|
# pairs in a file or a quoted string. RDS Custom applies the patches in
|
@@ -2062,6 +2019,8 @@ module Aws::RDS
|
|
2062
2019
|
# * {Types::DBEngineVersion#db_engine_description #db_engine_description} => String
|
2063
2020
|
# * {Types::DBEngineVersion#db_engine_version_description #db_engine_version_description} => String
|
2064
2021
|
# * {Types::DBEngineVersion#default_character_set #default_character_set} => Types::CharacterSet
|
2022
|
+
# * {Types::DBEngineVersion#image #image} => Types::CustomDBEngineVersionAMI
|
2023
|
+
# * {Types::DBEngineVersion#db_engine_media_type #db_engine_media_type} => String
|
2065
2024
|
# * {Types::DBEngineVersion#supported_character_sets #supported_character_sets} => Array<Types::CharacterSet>
|
2066
2025
|
# * {Types::DBEngineVersion#supported_nchar_character_sets #supported_nchar_character_sets} => Array<Types::CharacterSet>
|
2067
2026
|
# * {Types::DBEngineVersion#valid_upgrade_target #valid_upgrade_target} => Array<Types::UpgradeTarget>
|
@@ -2089,11 +2048,12 @@ module Aws::RDS
|
|
2089
2048
|
# resp = client.create_custom_db_engine_version({
|
2090
2049
|
# engine: "CustomEngineName", # required
|
2091
2050
|
# engine_version: "CustomEngineVersion", # required
|
2092
|
-
# database_installation_files_s3_bucket_name: "BucketName",
|
2051
|
+
# database_installation_files_s3_bucket_name: "BucketName",
|
2093
2052
|
# database_installation_files_s3_prefix: "String255",
|
2094
|
-
#
|
2053
|
+
# image_id: "String255",
|
2054
|
+
# kms_key_id: "KmsKeyIdOrArn",
|
2095
2055
|
# description: "Description",
|
2096
|
-
# manifest: "CustomDBEngineVersionManifest",
|
2056
|
+
# manifest: "CustomDBEngineVersionManifest",
|
2097
2057
|
# tags: [
|
2098
2058
|
# {
|
2099
2059
|
# key: "String",
|
@@ -2111,6 +2071,9 @@ module Aws::RDS
|
|
2111
2071
|
# resp.db_engine_version_description #=> String
|
2112
2072
|
# resp.default_character_set.character_set_name #=> String
|
2113
2073
|
# resp.default_character_set.character_set_description #=> String
|
2074
|
+
# resp.image.image_id #=> String
|
2075
|
+
# resp.image.status #=> String
|
2076
|
+
# resp.db_engine_media_type #=> String
|
2114
2077
|
# resp.supported_character_sets #=> Array
|
2115
2078
|
# resp.supported_character_sets[0].character_set_name #=> String
|
2116
2079
|
# resp.supported_character_sets[0].character_set_description #=> String
|
@@ -2382,7 +2345,11 @@ module Aws::RDS
|
|
2382
2345
|
# The password for the master database user. This password can contain
|
2383
2346
|
# any printable ASCII character except "/", """, or "@".
|
2384
2347
|
#
|
2385
|
-
# Constraints:
|
2348
|
+
# Constraints:
|
2349
|
+
#
|
2350
|
+
# * Must contain from 8 to 41 characters.
|
2351
|
+
#
|
2352
|
+
# * Can't be specified if `ManageMasterUserPassword` is turned on.
|
2386
2353
|
#
|
2387
2354
|
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
2388
2355
|
#
|
@@ -2950,6 +2917,54 @@ module Aws::RDS
|
|
2950
2917
|
# @option params [String] :db_system_id
|
2951
2918
|
# Reserved for future use.
|
2952
2919
|
#
|
2920
|
+
# @option params [Boolean] :manage_master_user_password
|
2921
|
+
# A value that indicates whether to manage the master user password with
|
2922
|
+
# Amazon Web Services Secrets Manager.
|
2923
|
+
#
|
2924
|
+
# For more information, see [Password management with Amazon Web
|
2925
|
+
# Services Secrets Manager][1] in the *Amazon RDS User Guide* and
|
2926
|
+
# [Password management with Amazon Web Services Secrets Manager][2] in
|
2927
|
+
# the *Amazon Aurora User Guide.*
|
2928
|
+
#
|
2929
|
+
# Constraints:
|
2930
|
+
#
|
2931
|
+
# * Can't manage the master user password with Amazon Web Services
|
2932
|
+
# Secrets Manager if `MasterUserPassword` is specified.
|
2933
|
+
#
|
2934
|
+
# ^
|
2935
|
+
#
|
2936
|
+
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
2937
|
+
#
|
2938
|
+
#
|
2939
|
+
#
|
2940
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html
|
2941
|
+
# [2]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/rds-secrets-manager.html
|
2942
|
+
#
|
2943
|
+
# @option params [String] :master_user_secret_kms_key_id
|
2944
|
+
# The Amazon Web Services KMS key identifier to encrypt a secret that is
|
2945
|
+
# automatically generated and managed in Amazon Web Services Secrets
|
2946
|
+
# Manager.
|
2947
|
+
#
|
2948
|
+
# This setting is valid only if the master user password is managed by
|
2949
|
+
# RDS in Amazon Web Services Secrets Manager for the DB cluster.
|
2950
|
+
#
|
2951
|
+
# The Amazon Web Services KMS key identifier is the key ARN, key ID,
|
2952
|
+
# alias ARN, or alias name for the KMS key. To use a KMS key in a
|
2953
|
+
# different Amazon Web Services account, specify the key ARN or alias
|
2954
|
+
# ARN.
|
2955
|
+
#
|
2956
|
+
# If you don't specify `MasterUserSecretKmsKeyId`, then the
|
2957
|
+
# `aws/secretsmanager` KMS key is used to encrypt the secret. If the
|
2958
|
+
# secret is in a different Amazon Web Services account, then you can't
|
2959
|
+
# use the `aws/secretsmanager` KMS key to encrypt the secret, and you
|
2960
|
+
# must use a customer managed KMS key.
|
2961
|
+
#
|
2962
|
+
# There is a default KMS key for your Amazon Web Services account. Your
|
2963
|
+
# Amazon Web Services account has a different default KMS key for each
|
2964
|
+
# Amazon Web Services Region.
|
2965
|
+
#
|
2966
|
+
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
2967
|
+
#
|
2953
2968
|
# @option params [String] :source_region
|
2954
2969
|
# The source region of the snapshot. This is only needed when the
|
2955
2970
|
# shapshot is encrypted and in a different region.
|
@@ -3050,6 +3065,8 @@ module Aws::RDS
|
|
3050
3065
|
# },
|
3051
3066
|
# network_type: "String",
|
3052
3067
|
# db_system_id: "String",
|
3068
|
+
# manage_master_user_password: false,
|
3069
|
+
# master_user_secret_kms_key_id: "String",
|
3053
3070
|
# source_region: "String",
|
3054
3071
|
# })
|
3055
3072
|
#
|
@@ -3162,6 +3179,9 @@ module Aws::RDS
|
|
3162
3179
|
# resp.db_cluster.serverless_v2_scaling_configuration.max_capacity #=> Float
|
3163
3180
|
# resp.db_cluster.network_type #=> String
|
3164
3181
|
# resp.db_cluster.db_system_id #=> String
|
3182
|
+
# resp.db_cluster.master_user_secret.secret_arn #=> String
|
3183
|
+
# resp.db_cluster.master_user_secret.secret_status #=> String
|
3184
|
+
# resp.db_cluster.master_user_secret.kms_key_id #=> String
|
3165
3185
|
#
|
3166
3186
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/CreateDBCluster AWS API Documentation
|
3167
3187
|
#
|
@@ -3878,6 +3898,9 @@ module Aws::RDS
|
|
3878
3898
|
# Not applicable. The password for the master user is managed by the DB
|
3879
3899
|
# cluster.
|
3880
3900
|
#
|
3901
|
+
# Constraints: Can't be specified if `ManageMasterUserPassword` is
|
3902
|
+
# turned on.
|
3903
|
+
#
|
3881
3904
|
# **MariaDB**
|
3882
3905
|
#
|
3883
3906
|
# Constraints: Must contain from 8 to 41 characters.
|
@@ -4665,6 +4688,47 @@ module Aws::RDS
|
|
4665
4688
|
#
|
4666
4689
|
# This setting doesn't apply to RDS Custom or Amazon Aurora.
|
4667
4690
|
#
|
4691
|
+
# @option params [Boolean] :manage_master_user_password
|
4692
|
+
# A value that indicates whether to manage the master user password with
|
4693
|
+
# Amazon Web Services Secrets Manager.
|
4694
|
+
#
|
4695
|
+
# For more information, see [Password management with Amazon Web
|
4696
|
+
# Services Secrets Manager][1] in the *Amazon RDS User Guide.*
|
4697
|
+
#
|
4698
|
+
# Constraints:
|
4699
|
+
#
|
4700
|
+
# * Can't manage the master user password with Amazon Web Services
|
4701
|
+
# Secrets Manager if `MasterUserPassword` is specified.
|
4702
|
+
#
|
4703
|
+
# ^
|
4704
|
+
#
|
4705
|
+
#
|
4706
|
+
#
|
4707
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html
|
4708
|
+
#
|
4709
|
+
# @option params [String] :master_user_secret_kms_key_id
|
4710
|
+
# The Amazon Web Services KMS key identifier to encrypt a secret that is
|
4711
|
+
# automatically generated and managed in Amazon Web Services Secrets
|
4712
|
+
# Manager.
|
4713
|
+
#
|
4714
|
+
# This setting is valid only if the master user password is managed by
|
4715
|
+
# RDS in Amazon Web Services Secrets Manager for the DB instance.
|
4716
|
+
#
|
4717
|
+
# The Amazon Web Services KMS key identifier is the key ARN, key ID,
|
4718
|
+
# alias ARN, or alias name for the KMS key. To use a KMS key in a
|
4719
|
+
# different Amazon Web Services account, specify the key ARN or alias
|
4720
|
+
# ARN.
|
4721
|
+
#
|
4722
|
+
# If you don't specify `MasterUserSecretKmsKeyId`, then the
|
4723
|
+
# `aws/secretsmanager` KMS key is used to encrypt the secret. If the
|
4724
|
+
# secret is in a different Amazon Web Services account, then you can't
|
4725
|
+
# use the `aws/secretsmanager` KMS key to encrypt the secret, and you
|
4726
|
+
# must use a customer managed KMS key.
|
4727
|
+
#
|
4728
|
+
# There is a default KMS key for your Amazon Web Services account. Your
|
4729
|
+
# Amazon Web Services account has a different default KMS key for each
|
4730
|
+
# Amazon Web Services Region.
|
4731
|
+
#
|
4668
4732
|
# @return [Types::CreateDBInstanceResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4669
4733
|
#
|
4670
4734
|
# * {Types::CreateDBInstanceResult#db_instance #db_instance} => Types::DBInstance
|
@@ -4754,6 +4818,8 @@ module Aws::RDS
|
|
4754
4818
|
# backup_target: "String",
|
4755
4819
|
# network_type: "String",
|
4756
4820
|
# storage_throughput: 1,
|
4821
|
+
# manage_master_user_password: false,
|
4822
|
+
# master_user_secret_kms_key_id: "String",
|
4757
4823
|
# })
|
4758
4824
|
#
|
4759
4825
|
# @example Response structure
|
@@ -4901,6 +4967,9 @@ module Aws::RDS
|
|
4901
4967
|
# resp.db_instance.activity_stream_policy_status #=> String, one of "locked", "unlocked", "locking-policy", "unlocking-policy"
|
4902
4968
|
# resp.db_instance.storage_throughput #=> Integer
|
4903
4969
|
# resp.db_instance.db_system_id #=> String
|
4970
|
+
# resp.db_instance.master_user_secret.secret_arn #=> String
|
4971
|
+
# resp.db_instance.master_user_secret.secret_status #=> String
|
4972
|
+
# resp.db_instance.master_user_secret.kms_key_id #=> String
|
4904
4973
|
#
|
4905
4974
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/CreateDBInstance AWS API Documentation
|
4906
4975
|
#
|
@@ -5723,6 +5792,9 @@ module Aws::RDS
|
|
5723
5792
|
# resp.db_instance.activity_stream_policy_status #=> String, one of "locked", "unlocked", "locking-policy", "unlocking-policy"
|
5724
5793
|
# resp.db_instance.storage_throughput #=> Integer
|
5725
5794
|
# resp.db_instance.db_system_id #=> String
|
5795
|
+
# resp.db_instance.master_user_secret.secret_arn #=> String
|
5796
|
+
# resp.db_instance.master_user_secret.secret_status #=> String
|
5797
|
+
# resp.db_instance.master_user_secret.kms_key_id #=> String
|
5726
5798
|
#
|
5727
5799
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/CreateDBInstanceReadReplica AWS API Documentation
|
5728
5800
|
#
|
@@ -6918,6 +6990,8 @@ module Aws::RDS
|
|
6918
6990
|
# * {Types::DBEngineVersion#db_engine_description #db_engine_description} => String
|
6919
6991
|
# * {Types::DBEngineVersion#db_engine_version_description #db_engine_version_description} => String
|
6920
6992
|
# * {Types::DBEngineVersion#default_character_set #default_character_set} => Types::CharacterSet
|
6993
|
+
# * {Types::DBEngineVersion#image #image} => Types::CustomDBEngineVersionAMI
|
6994
|
+
# * {Types::DBEngineVersion#db_engine_media_type #db_engine_media_type} => String
|
6921
6995
|
# * {Types::DBEngineVersion#supported_character_sets #supported_character_sets} => Array<Types::CharacterSet>
|
6922
6996
|
# * {Types::DBEngineVersion#supported_nchar_character_sets #supported_nchar_character_sets} => Array<Types::CharacterSet>
|
6923
6997
|
# * {Types::DBEngineVersion#valid_upgrade_target #valid_upgrade_target} => Array<Types::UpgradeTarget>
|
@@ -6956,6 +7030,9 @@ module Aws::RDS
|
|
6956
7030
|
# resp.db_engine_version_description #=> String
|
6957
7031
|
# resp.default_character_set.character_set_name #=> String
|
6958
7032
|
# resp.default_character_set.character_set_description #=> String
|
7033
|
+
# resp.image.image_id #=> String
|
7034
|
+
# resp.image.status #=> String
|
7035
|
+
# resp.db_engine_media_type #=> String
|
6959
7036
|
# resp.supported_character_sets #=> Array
|
6960
7037
|
# resp.supported_character_sets[0].character_set_name #=> String
|
6961
7038
|
# resp.supported_character_sets[0].character_set_description #=> String
|
@@ -7202,6 +7279,9 @@ module Aws::RDS
|
|
7202
7279
|
# resp.db_cluster.serverless_v2_scaling_configuration.max_capacity #=> Float
|
7203
7280
|
# resp.db_cluster.network_type #=> String
|
7204
7281
|
# resp.db_cluster.db_system_id #=> String
|
7282
|
+
# resp.db_cluster.master_user_secret.secret_arn #=> String
|
7283
|
+
# resp.db_cluster.master_user_secret.secret_status #=> String
|
7284
|
+
# resp.db_cluster.master_user_secret.kms_key_id #=> String
|
7205
7285
|
#
|
7206
7286
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DeleteDBCluster AWS API Documentation
|
7207
7287
|
#
|
@@ -7672,6 +7752,9 @@ module Aws::RDS
|
|
7672
7752
|
# resp.db_instance.activity_stream_policy_status #=> String, one of "locked", "unlocked", "locking-policy", "unlocking-policy"
|
7673
7753
|
# resp.db_instance.storage_throughput #=> Integer
|
7674
7754
|
# resp.db_instance.db_system_id #=> String
|
7755
|
+
# resp.db_instance.master_user_secret.secret_arn #=> String
|
7756
|
+
# resp.db_instance.master_user_secret.secret_status #=> String
|
7757
|
+
# resp.db_instance.master_user_secret.kms_key_id #=> String
|
7675
7758
|
#
|
7676
7759
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DeleteDBInstance AWS API Documentation
|
7677
7760
|
#
|
@@ -9407,6 +9490,9 @@ module Aws::RDS
|
|
9407
9490
|
# resp.db_clusters[0].serverless_v2_scaling_configuration.max_capacity #=> Float
|
9408
9491
|
# resp.db_clusters[0].network_type #=> String
|
9409
9492
|
# resp.db_clusters[0].db_system_id #=> String
|
9493
|
+
# resp.db_clusters[0].master_user_secret.secret_arn #=> String
|
9494
|
+
# resp.db_clusters[0].master_user_secret.secret_status #=> String
|
9495
|
+
# resp.db_clusters[0].master_user_secret.kms_key_id #=> String
|
9410
9496
|
#
|
9411
9497
|
#
|
9412
9498
|
# The following waiters are defined for this operation (see {Client#wait_until} for detailed usage):
|
@@ -9615,6 +9701,9 @@ module Aws::RDS
|
|
9615
9701
|
# resp.db_engine_versions[0].db_engine_version_description #=> String
|
9616
9702
|
# resp.db_engine_versions[0].default_character_set.character_set_name #=> String
|
9617
9703
|
# resp.db_engine_versions[0].default_character_set.character_set_description #=> String
|
9704
|
+
# resp.db_engine_versions[0].image.image_id #=> String
|
9705
|
+
# resp.db_engine_versions[0].image.status #=> String
|
9706
|
+
# resp.db_engine_versions[0].db_engine_media_type #=> String
|
9618
9707
|
# resp.db_engine_versions[0].supported_character_sets #=> Array
|
9619
9708
|
# resp.db_engine_versions[0].supported_character_sets[0].character_set_name #=> String
|
9620
9709
|
# resp.db_engine_versions[0].supported_character_sets[0].character_set_description #=> String
|
@@ -10038,6 +10127,9 @@ module Aws::RDS
|
|
10038
10127
|
# resp.db_instances[0].activity_stream_policy_status #=> String, one of "locked", "unlocked", "locking-policy", "unlocking-policy"
|
10039
10128
|
# resp.db_instances[0].storage_throughput #=> Integer
|
10040
10129
|
# resp.db_instances[0].db_system_id #=> String
|
10130
|
+
# resp.db_instances[0].master_user_secret.secret_arn #=> String
|
10131
|
+
# resp.db_instances[0].master_user_secret.secret_status #=> String
|
10132
|
+
# resp.db_instances[0].master_user_secret.kms_key_id #=> String
|
10041
10133
|
#
|
10042
10134
|
#
|
10043
10135
|
# The following waiters are defined for this operation (see {Client#wait_until} for detailed usage):
|
@@ -13246,6 +13338,9 @@ module Aws::RDS
|
|
13246
13338
|
# resp.db_cluster.serverless_v2_scaling_configuration.max_capacity #=> Float
|
13247
13339
|
# resp.db_cluster.network_type #=> String
|
13248
13340
|
# resp.db_cluster.db_system_id #=> String
|
13341
|
+
# resp.db_cluster.master_user_secret.secret_arn #=> String
|
13342
|
+
# resp.db_cluster.master_user_secret.secret_status #=> String
|
13343
|
+
# resp.db_cluster.master_user_secret.kms_key_id #=> String
|
13249
13344
|
#
|
13250
13345
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/FailoverDBCluster AWS API Documentation
|
13251
13346
|
#
|
@@ -13713,6 +13808,8 @@ module Aws::RDS
|
|
13713
13808
|
# * {Types::DBEngineVersion#db_engine_description #db_engine_description} => String
|
13714
13809
|
# * {Types::DBEngineVersion#db_engine_version_description #db_engine_version_description} => String
|
13715
13810
|
# * {Types::DBEngineVersion#default_character_set #default_character_set} => Types::CharacterSet
|
13811
|
+
# * {Types::DBEngineVersion#image #image} => Types::CustomDBEngineVersionAMI
|
13812
|
+
# * {Types::DBEngineVersion#db_engine_media_type #db_engine_media_type} => String
|
13716
13813
|
# * {Types::DBEngineVersion#supported_character_sets #supported_character_sets} => Array<Types::CharacterSet>
|
13717
13814
|
# * {Types::DBEngineVersion#supported_nchar_character_sets #supported_nchar_character_sets} => Array<Types::CharacterSet>
|
13718
13815
|
# * {Types::DBEngineVersion#valid_upgrade_target #valid_upgrade_target} => Array<Types::UpgradeTarget>
|
@@ -13753,6 +13850,9 @@ module Aws::RDS
|
|
13753
13850
|
# resp.db_engine_version_description #=> String
|
13754
13851
|
# resp.default_character_set.character_set_name #=> String
|
13755
13852
|
# resp.default_character_set.character_set_description #=> String
|
13853
|
+
# resp.image.image_id #=> String
|
13854
|
+
# resp.image.status #=> String
|
13855
|
+
# resp.db_engine_media_type #=> String
|
13756
13856
|
# resp.supported_character_sets #=> Array
|
13757
13857
|
# resp.supported_character_sets[0].character_set_name #=> String
|
13758
13858
|
# resp.supported_character_sets[0].character_set_description #=> String
|
@@ -13902,7 +14002,11 @@ module Aws::RDS
|
|
13902
14002
|
# The new password for the master database user. This password can
|
13903
14003
|
# contain any printable ASCII character except "/", """, or "@".
|
13904
14004
|
#
|
13905
|
-
# Constraints:
|
14005
|
+
# Constraints:
|
14006
|
+
#
|
14007
|
+
# * Must contain from 8 to 41 characters.
|
14008
|
+
#
|
14009
|
+
# * Can't be specified if `ManageMasterUserPassword` is turned on.
|
13906
14010
|
#
|
13907
14011
|
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
13908
14012
|
#
|
@@ -14343,6 +14447,96 @@ module Aws::RDS
|
|
14343
14447
|
#
|
14344
14448
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html
|
14345
14449
|
#
|
14450
|
+
# @option params [Boolean] :manage_master_user_password
|
14451
|
+
# A value that indicates whether to manage the master user password with
|
14452
|
+
# Amazon Web Services Secrets Manager.
|
14453
|
+
#
|
14454
|
+
# If the DB cluster doesn't manage the master user password with Amazon
|
14455
|
+
# Web Services Secrets Manager, you can turn on this management. In this
|
14456
|
+
# case, you can't specify `MasterUserPassword`.
|
14457
|
+
#
|
14458
|
+
# If the DB cluster already manages the master user password with Amazon
|
14459
|
+
# Web Services Secrets Manager, and you specify that the master user
|
14460
|
+
# password is not managed with Amazon Web Services Secrets Manager, then
|
14461
|
+
# you must specify `MasterUserPassword`. In this case, RDS deletes the
|
14462
|
+
# secret and uses the new password for the master user specified by
|
14463
|
+
# `MasterUserPassword`.
|
14464
|
+
#
|
14465
|
+
# For more information, see [Password management with Amazon Web
|
14466
|
+
# Services Secrets Manager][1] in the *Amazon RDS User Guide* and
|
14467
|
+
# [Password management with Amazon Web Services Secrets Manager][2] in
|
14468
|
+
# the *Amazon Aurora User Guide.*
|
14469
|
+
#
|
14470
|
+
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
14471
|
+
#
|
14472
|
+
#
|
14473
|
+
#
|
14474
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html
|
14475
|
+
# [2]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/rds-secrets-manager.html
|
14476
|
+
#
|
14477
|
+
# @option params [Boolean] :rotate_master_user_password
|
14478
|
+
# A value that indicates whether to rotate the secret managed by Amazon
|
14479
|
+
# Web Services Secrets Manager for the master user password.
|
14480
|
+
#
|
14481
|
+
# This setting is valid only if the master user password is managed by
|
14482
|
+
# RDS in Amazon Web Services Secrets Manager for the DB cluster. The
|
14483
|
+
# secret value contains the updated password.
|
14484
|
+
#
|
14485
|
+
# For more information, see [Password management with Amazon Web
|
14486
|
+
# Services Secrets Manager][1] in the *Amazon RDS User Guide* and
|
14487
|
+
# [Password management with Amazon Web Services Secrets Manager][2] in
|
14488
|
+
# the *Amazon Aurora User Guide.*
|
14489
|
+
#
|
14490
|
+
# Constraints:
|
14491
|
+
#
|
14492
|
+
# * You must apply the change immediately when rotating the master user
|
14493
|
+
# password.
|
14494
|
+
#
|
14495
|
+
# ^
|
14496
|
+
#
|
14497
|
+
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
14498
|
+
#
|
14499
|
+
#
|
14500
|
+
#
|
14501
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html
|
14502
|
+
# [2]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/rds-secrets-manager.html
|
14503
|
+
#
|
14504
|
+
# @option params [String] :master_user_secret_kms_key_id
|
14505
|
+
# The Amazon Web Services KMS key identifier to encrypt a secret that is
|
14506
|
+
# automatically generated and managed in Amazon Web Services Secrets
|
14507
|
+
# Manager.
|
14508
|
+
#
|
14509
|
+
# This setting is valid only if both of the following conditions are
|
14510
|
+
# met:
|
14511
|
+
#
|
14512
|
+
# * The DB cluster doesn't manage the master user password in Amazon
|
14513
|
+
# Web Services Secrets Manager.
|
14514
|
+
#
|
14515
|
+
# If the DB cluster already manages the master user password in Amazon
|
14516
|
+
# Web Services Secrets Manager, you can't change the KMS key that is
|
14517
|
+
# used to encrypt the secret.
|
14518
|
+
#
|
14519
|
+
# * You are turning on `ManageMasterUserPassword` to manage the master
|
14520
|
+
# user password in Amazon Web Services Secrets Manager.
|
14521
|
+
#
|
14522
|
+
# If you are turning on `ManageMasterUserPassword` and don't specify
|
14523
|
+
# `MasterUserSecretKmsKeyId`, then the `aws/secretsmanager` KMS key is
|
14524
|
+
# used to encrypt the secret. If the secret is in a different Amazon
|
14525
|
+
# Web Services account, then you can't use the `aws/secretsmanager`
|
14526
|
+
# KMS key to encrypt the secret, and you must use a customer managed
|
14527
|
+
# KMS key.
|
14528
|
+
#
|
14529
|
+
# The Amazon Web Services KMS key identifier is the key ARN, key ID,
|
14530
|
+
# alias ARN, or alias name for the KMS key. To use a KMS key in a
|
14531
|
+
# different Amazon Web Services account, specify the key ARN or alias
|
14532
|
+
# ARN.
|
14533
|
+
#
|
14534
|
+
# There is a default KMS key for your Amazon Web Services account. Your
|
14535
|
+
# Amazon Web Services account has a different default KMS key for each
|
14536
|
+
# Amazon Web Services Region.
|
14537
|
+
#
|
14538
|
+
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
14539
|
+
#
|
14346
14540
|
# @return [Types::ModifyDBClusterResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
14347
14541
|
#
|
14348
14542
|
# * {Types::ModifyDBClusterResult#db_cluster #db_cluster} => Types::DBCluster
|
@@ -14419,6 +14613,9 @@ module Aws::RDS
|
|
14419
14613
|
# max_capacity: 1.0,
|
14420
14614
|
# },
|
14421
14615
|
# network_type: "String",
|
14616
|
+
# manage_master_user_password: false,
|
14617
|
+
# rotate_master_user_password: false,
|
14618
|
+
# master_user_secret_kms_key_id: "String",
|
14422
14619
|
# })
|
14423
14620
|
#
|
14424
14621
|
# @example Response structure
|
@@ -14530,6 +14727,9 @@ module Aws::RDS
|
|
14530
14727
|
# resp.db_cluster.serverless_v2_scaling_configuration.max_capacity #=> Float
|
14531
14728
|
# resp.db_cluster.network_type #=> String
|
14532
14729
|
# resp.db_cluster.db_system_id #=> String
|
14730
|
+
# resp.db_cluster.master_user_secret.secret_arn #=> String
|
14731
|
+
# resp.db_cluster.master_user_secret.secret_status #=> String
|
14732
|
+
# resp.db_cluster.master_user_secret.kms_key_id #=> String
|
14533
14733
|
#
|
14534
14734
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/ModifyDBCluster AWS API Documentation
|
14535
14735
|
#
|
@@ -14986,6 +15186,9 @@ module Aws::RDS
|
|
14986
15186
|
#
|
14987
15187
|
# Default: Uses existing setting
|
14988
15188
|
#
|
15189
|
+
# Constraints: Can't be specified if `ManageMasterUserPassword` is
|
15190
|
+
# turned on.
|
15191
|
+
#
|
14989
15192
|
# **MariaDB**
|
14990
15193
|
#
|
14991
15194
|
# Constraints: Must contain from 8 to 41 characters.
|
@@ -15681,6 +15884,91 @@ module Aws::RDS
|
|
15681
15884
|
#
|
15682
15885
|
# This setting doesn't apply to RDS Custom or Amazon Aurora.
|
15683
15886
|
#
|
15887
|
+
# @option params [Boolean] :manage_master_user_password
|
15888
|
+
# A value that indicates whether to manage the master user password with
|
15889
|
+
# Amazon Web Services Secrets Manager.
|
15890
|
+
#
|
15891
|
+
# If the DB cluster doesn't manage the master user password with Amazon
|
15892
|
+
# Web Services Secrets Manager, you can turn on this management. In this
|
15893
|
+
# case, you can't specify `MasterUserPassword`.
|
15894
|
+
#
|
15895
|
+
# If the DB cluster already manages the master user password with Amazon
|
15896
|
+
# Web Services Secrets Manager, and you specify that the master user
|
15897
|
+
# password is not managed with Amazon Web Services Secrets Manager, then
|
15898
|
+
# you must specify `MasterUserPassword`. In this case, RDS deletes the
|
15899
|
+
# secret and uses the new password for the master user specified by
|
15900
|
+
# `MasterUserPassword`.
|
15901
|
+
#
|
15902
|
+
# For more information, see [Password management with Amazon Web
|
15903
|
+
# Services Secrets Manager][1] in the *Amazon RDS User Guide.*
|
15904
|
+
#
|
15905
|
+
# Constraints:
|
15906
|
+
#
|
15907
|
+
# * Can't manage the master user password with Amazon Web Services
|
15908
|
+
# Secrets Manager if `MasterUserPassword` is specified.
|
15909
|
+
#
|
15910
|
+
# ^
|
15911
|
+
#
|
15912
|
+
#
|
15913
|
+
#
|
15914
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html
|
15915
|
+
#
|
15916
|
+
# @option params [Boolean] :rotate_master_user_password
|
15917
|
+
# A value that indicates whether to rotate the secret managed by Amazon
|
15918
|
+
# Web Services Secrets Manager for the master user password.
|
15919
|
+
#
|
15920
|
+
# This setting is valid only if the master user password is managed by
|
15921
|
+
# RDS in Amazon Web Services Secrets Manager for the DB cluster. The
|
15922
|
+
# secret value contains the updated password.
|
15923
|
+
#
|
15924
|
+
# For more information, see [Password management with Amazon Web
|
15925
|
+
# Services Secrets Manager][1] in the *Amazon RDS User Guide.*
|
15926
|
+
#
|
15927
|
+
# Constraints:
|
15928
|
+
#
|
15929
|
+
# * You must apply the change immediately when rotating the master user
|
15930
|
+
# password.
|
15931
|
+
#
|
15932
|
+
# ^
|
15933
|
+
#
|
15934
|
+
#
|
15935
|
+
#
|
15936
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html
|
15937
|
+
#
|
15938
|
+
# @option params [String] :master_user_secret_kms_key_id
|
15939
|
+
# The Amazon Web Services KMS key identifier to encrypt a secret that is
|
15940
|
+
# automatically generated and managed in Amazon Web Services Secrets
|
15941
|
+
# Manager.
|
15942
|
+
#
|
15943
|
+
# This setting is valid only if both of the following conditions are
|
15944
|
+
# met:
|
15945
|
+
#
|
15946
|
+
# * The DB instance doesn't manage the master user password in Amazon
|
15947
|
+
# Web Services Secrets Manager.
|
15948
|
+
#
|
15949
|
+
# If the DB instance already manages the master user password in
|
15950
|
+
# Amazon Web Services Secrets Manager, you can't change the KMS key
|
15951
|
+
# used to encrypt the secret.
|
15952
|
+
#
|
15953
|
+
# * You are turning on `ManageMasterUserPassword` to manage the master
|
15954
|
+
# user password in Amazon Web Services Secrets Manager.
|
15955
|
+
#
|
15956
|
+
# If you are turning on `ManageMasterUserPassword` and don't specify
|
15957
|
+
# `MasterUserSecretKmsKeyId`, then the `aws/secretsmanager` KMS key is
|
15958
|
+
# used to encrypt the secret. If the secret is in a different Amazon
|
15959
|
+
# Web Services account, then you can't use the `aws/secretsmanager`
|
15960
|
+
# KMS key to encrypt the secret, and you must use a customer managed
|
15961
|
+
# KMS key.
|
15962
|
+
#
|
15963
|
+
# The Amazon Web Services KMS key identifier is the key ARN, key ID,
|
15964
|
+
# alias ARN, or alias name for the KMS key. To use a KMS key in a
|
15965
|
+
# different Amazon Web Services account, specify the key ARN or alias
|
15966
|
+
# ARN.
|
15967
|
+
#
|
15968
|
+
# There is a default KMS key for your Amazon Web Services account. Your
|
15969
|
+
# Amazon Web Services account has a different default KMS key for each
|
15970
|
+
# Amazon Web Services Region.
|
15971
|
+
#
|
15684
15972
|
# @return [Types::ModifyDBInstanceResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
15685
15973
|
#
|
15686
15974
|
# * {Types::ModifyDBInstanceResult#db_instance #db_instance} => Types::DBInstance
|
@@ -15767,6 +16055,9 @@ module Aws::RDS
|
|
15767
16055
|
# resume_full_automation_mode_minutes: 1,
|
15768
16056
|
# network_type: "String",
|
15769
16057
|
# storage_throughput: 1,
|
16058
|
+
# manage_master_user_password: false,
|
16059
|
+
# rotate_master_user_password: false,
|
16060
|
+
# master_user_secret_kms_key_id: "String",
|
15770
16061
|
# })
|
15771
16062
|
#
|
15772
16063
|
# @example Response structure
|
@@ -15914,6 +16205,9 @@ module Aws::RDS
|
|
15914
16205
|
# resp.db_instance.activity_stream_policy_status #=> String, one of "locked", "unlocked", "locking-policy", "unlocking-policy"
|
15915
16206
|
# resp.db_instance.storage_throughput #=> Integer
|
15916
16207
|
# resp.db_instance.db_system_id #=> String
|
16208
|
+
# resp.db_instance.master_user_secret.secret_arn #=> String
|
16209
|
+
# resp.db_instance.master_user_secret.secret_status #=> String
|
16210
|
+
# resp.db_instance.master_user_secret.kms_key_id #=> String
|
15917
16211
|
#
|
15918
16212
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/ModifyDBInstance AWS API Documentation
|
15919
16213
|
#
|
@@ -17154,6 +17448,9 @@ module Aws::RDS
|
|
17154
17448
|
# resp.db_instance.activity_stream_policy_status #=> String, one of "locked", "unlocked", "locking-policy", "unlocking-policy"
|
17155
17449
|
# resp.db_instance.storage_throughput #=> Integer
|
17156
17450
|
# resp.db_instance.db_system_id #=> String
|
17451
|
+
# resp.db_instance.master_user_secret.secret_arn #=> String
|
17452
|
+
# resp.db_instance.master_user_secret.secret_status #=> String
|
17453
|
+
# resp.db_instance.master_user_secret.kms_key_id #=> String
|
17157
17454
|
#
|
17158
17455
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/PromoteReadReplica AWS API Documentation
|
17159
17456
|
#
|
@@ -17297,6 +17594,9 @@ module Aws::RDS
|
|
17297
17594
|
# resp.db_cluster.serverless_v2_scaling_configuration.max_capacity #=> Float
|
17298
17595
|
# resp.db_cluster.network_type #=> String
|
17299
17596
|
# resp.db_cluster.db_system_id #=> String
|
17597
|
+
# resp.db_cluster.master_user_secret.secret_arn #=> String
|
17598
|
+
# resp.db_cluster.master_user_secret.secret_status #=> String
|
17599
|
+
# resp.db_cluster.master_user_secret.kms_key_id #=> String
|
17300
17600
|
#
|
17301
17601
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/PromoteReadReplicaDBCluster AWS API Documentation
|
17302
17602
|
#
|
@@ -17544,6 +17844,9 @@ module Aws::RDS
|
|
17544
17844
|
# resp.db_cluster.serverless_v2_scaling_configuration.max_capacity #=> Float
|
17545
17845
|
# resp.db_cluster.network_type #=> String
|
17546
17846
|
# resp.db_cluster.db_system_id #=> String
|
17847
|
+
# resp.db_cluster.master_user_secret.secret_arn #=> String
|
17848
|
+
# resp.db_cluster.master_user_secret.secret_status #=> String
|
17849
|
+
# resp.db_cluster.master_user_secret.kms_key_id #=> String
|
17547
17850
|
#
|
17548
17851
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/RebootDBCluster AWS API Documentation
|
17549
17852
|
#
|
@@ -17764,6 +18067,9 @@ module Aws::RDS
|
|
17764
18067
|
# resp.db_instance.activity_stream_policy_status #=> String, one of "locked", "unlocked", "locking-policy", "unlocking-policy"
|
17765
18068
|
# resp.db_instance.storage_throughput #=> Integer
|
17766
18069
|
# resp.db_instance.db_system_id #=> String
|
18070
|
+
# resp.db_instance.master_user_secret.secret_arn #=> String
|
18071
|
+
# resp.db_instance.master_user_secret.secret_status #=> String
|
18072
|
+
# resp.db_instance.master_user_secret.kms_key_id #=> String
|
17767
18073
|
#
|
17768
18074
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/RebootDBInstance AWS API Documentation
|
17769
18075
|
#
|
@@ -18409,11 +18715,15 @@ module Aws::RDS
|
|
18409
18715
|
#
|
18410
18716
|
# * Can't be a reserved word for the chosen database engine.
|
18411
18717
|
#
|
18412
|
-
# @option params [
|
18718
|
+
# @option params [String] :master_user_password
|
18413
18719
|
# The password for the master database user. This password can contain
|
18414
18720
|
# any printable ASCII character except "/", """, or "@".
|
18415
18721
|
#
|
18416
|
-
# Constraints:
|
18722
|
+
# Constraints:
|
18723
|
+
#
|
18724
|
+
# * Must contain from 8 to 41 characters.
|
18725
|
+
#
|
18726
|
+
# * Can't be specified if `ManageMasterUserPassword` is turned on.
|
18417
18727
|
#
|
18418
18728
|
# @option params [String] :option_group_name
|
18419
18729
|
# A value that indicates that the restored DB cluster should be
|
@@ -18629,6 +18939,50 @@ module Aws::RDS
|
|
18629
18939
|
#
|
18630
18940
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html
|
18631
18941
|
#
|
18942
|
+
# @option params [Boolean] :manage_master_user_password
|
18943
|
+
# A value that indicates whether to manage the master user password with
|
18944
|
+
# Amazon Web Services Secrets Manager.
|
18945
|
+
#
|
18946
|
+
# For more information, see [Password management with Amazon Web
|
18947
|
+
# Services Secrets Manager][1] in the *Amazon RDS User Guide* and
|
18948
|
+
# [Password management with Amazon Web Services Secrets Manager][2] in
|
18949
|
+
# the *Amazon Aurora User Guide.*
|
18950
|
+
#
|
18951
|
+
# Constraints:
|
18952
|
+
#
|
18953
|
+
# * Can't manage the master user password with Amazon Web Services
|
18954
|
+
# Secrets Manager if `MasterUserPassword` is specified.
|
18955
|
+
#
|
18956
|
+
# ^
|
18957
|
+
#
|
18958
|
+
#
|
18959
|
+
#
|
18960
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html
|
18961
|
+
# [2]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/rds-secrets-manager.html
|
18962
|
+
#
|
18963
|
+
# @option params [String] :master_user_secret_kms_key_id
|
18964
|
+
# The Amazon Web Services KMS key identifier to encrypt a secret that is
|
18965
|
+
# automatically generated and managed in Amazon Web Services Secrets
|
18966
|
+
# Manager.
|
18967
|
+
#
|
18968
|
+
# This setting is valid only if the master user password is managed by
|
18969
|
+
# RDS in Amazon Web Services Secrets Manager for the DB cluster.
|
18970
|
+
#
|
18971
|
+
# The Amazon Web Services KMS key identifier is the key ARN, key ID,
|
18972
|
+
# alias ARN, or alias name for the KMS key. To use a KMS key in a
|
18973
|
+
# different Amazon Web Services account, specify the key ARN or alias
|
18974
|
+
# ARN.
|
18975
|
+
#
|
18976
|
+
# If you don't specify `MasterUserSecretKmsKeyId`, then the
|
18977
|
+
# `aws/secretsmanager` KMS key is used to encrypt the secret. If the
|
18978
|
+
# secret is in a different Amazon Web Services account, then you can't
|
18979
|
+
# use the `aws/secretsmanager` KMS key to encrypt the secret, and you
|
18980
|
+
# must use a customer managed KMS key.
|
18981
|
+
#
|
18982
|
+
# There is a default KMS key for your Amazon Web Services account. Your
|
18983
|
+
# Amazon Web Services account has a different default KMS key for each
|
18984
|
+
# Amazon Web Services Region.
|
18985
|
+
#
|
18632
18986
|
# @return [Types::RestoreDBClusterFromS3Result] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
18633
18987
|
#
|
18634
18988
|
# * {Types::RestoreDBClusterFromS3Result#db_cluster #db_cluster} => Types::DBCluster
|
@@ -18648,7 +19002,7 @@ module Aws::RDS
|
|
18648
19002
|
# engine_version: "String",
|
18649
19003
|
# port: 1,
|
18650
19004
|
# master_username: "String", # required
|
18651
|
-
# master_user_password: "String",
|
19005
|
+
# master_user_password: "String",
|
18652
19006
|
# option_group_name: "String",
|
18653
19007
|
# preferred_backup_window: "String",
|
18654
19008
|
# preferred_maintenance_window: "String",
|
@@ -18677,6 +19031,8 @@ module Aws::RDS
|
|
18677
19031
|
# max_capacity: 1.0,
|
18678
19032
|
# },
|
18679
19033
|
# network_type: "String",
|
19034
|
+
# manage_master_user_password: false,
|
19035
|
+
# master_user_secret_kms_key_id: "String",
|
18680
19036
|
# })
|
18681
19037
|
#
|
18682
19038
|
# @example Response structure
|
@@ -18788,6 +19144,9 @@ module Aws::RDS
|
|
18788
19144
|
# resp.db_cluster.serverless_v2_scaling_configuration.max_capacity #=> Float
|
18789
19145
|
# resp.db_cluster.network_type #=> String
|
18790
19146
|
# resp.db_cluster.db_system_id #=> String
|
19147
|
+
# resp.db_cluster.master_user_secret.secret_arn #=> String
|
19148
|
+
# resp.db_cluster.master_user_secret.secret_status #=> String
|
19149
|
+
# resp.db_cluster.master_user_secret.kms_key_id #=> String
|
18791
19150
|
#
|
18792
19151
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/RestoreDBClusterFromS3 AWS API Documentation
|
18793
19152
|
#
|
@@ -19426,6 +19785,9 @@ module Aws::RDS
|
|
19426
19785
|
# resp.db_cluster.serverless_v2_scaling_configuration.max_capacity #=> Float
|
19427
19786
|
# resp.db_cluster.network_type #=> String
|
19428
19787
|
# resp.db_cluster.db_system_id #=> String
|
19788
|
+
# resp.db_cluster.master_user_secret.secret_arn #=> String
|
19789
|
+
# resp.db_cluster.master_user_secret.secret_status #=> String
|
19790
|
+
# resp.db_cluster.master_user_secret.kms_key_id #=> String
|
19429
19791
|
#
|
19430
19792
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/RestoreDBClusterFromSnapshot AWS API Documentation
|
19431
19793
|
#
|
@@ -20033,6 +20395,9 @@ module Aws::RDS
|
|
20033
20395
|
# resp.db_cluster.serverless_v2_scaling_configuration.max_capacity #=> Float
|
20034
20396
|
# resp.db_cluster.network_type #=> String
|
20035
20397
|
# resp.db_cluster.db_system_id #=> String
|
20398
|
+
# resp.db_cluster.master_user_secret.secret_arn #=> String
|
20399
|
+
# resp.db_cluster.master_user_secret.secret_status #=> String
|
20400
|
+
# resp.db_cluster.master_user_secret.kms_key_id #=> String
|
20036
20401
|
#
|
20037
20402
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/RestoreDBClusterToPointInTime AWS API Documentation
|
20038
20403
|
#
|
@@ -20797,6 +21162,9 @@ module Aws::RDS
|
|
20797
21162
|
# resp.db_instance.activity_stream_policy_status #=> String, one of "locked", "unlocked", "locking-policy", "unlocking-policy"
|
20798
21163
|
# resp.db_instance.storage_throughput #=> Integer
|
20799
21164
|
# resp.db_instance.db_system_id #=> String
|
21165
|
+
# resp.db_instance.master_user_secret.secret_arn #=> String
|
21166
|
+
# resp.db_instance.master_user_secret.secret_status #=> String
|
21167
|
+
# resp.db_instance.master_user_secret.kms_key_id #=> String
|
20800
21168
|
#
|
20801
21169
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/RestoreDBInstanceFromDBSnapshot AWS API Documentation
|
20802
21170
|
#
|
@@ -20882,8 +21250,29 @@ module Aws::RDS
|
|
20882
21250
|
# The password for the master user. The password can include any
|
20883
21251
|
# printable ASCII character except "/", """, or "@".
|
20884
21252
|
#
|
21253
|
+
# Constraints: Can't be specified if `ManageMasterUserPassword` is
|
21254
|
+
# turned on.
|
21255
|
+
#
|
21256
|
+
# **MariaDB**
|
21257
|
+
#
|
21258
|
+
# Constraints: Must contain from 8 to 41 characters.
|
21259
|
+
#
|
21260
|
+
# **Microsoft SQL Server**
|
21261
|
+
#
|
21262
|
+
# Constraints: Must contain from 8 to 128 characters.
|
21263
|
+
#
|
21264
|
+
# **MySQL**
|
21265
|
+
#
|
20885
21266
|
# Constraints: Must contain from 8 to 41 characters.
|
20886
21267
|
#
|
21268
|
+
# **Oracle**
|
21269
|
+
#
|
21270
|
+
# Constraints: Must contain from 8 to 30 characters.
|
21271
|
+
#
|
21272
|
+
# **PostgreSQL**
|
21273
|
+
#
|
21274
|
+
# Constraints: Must contain from 8 to 128 characters.
|
21275
|
+
#
|
20887
21276
|
# @option params [Array<String>] :db_security_groups
|
20888
21277
|
# A list of DB security groups to associate with this DB instance.
|
20889
21278
|
#
|
@@ -21244,6 +21633,47 @@ module Aws::RDS
|
|
21244
21633
|
#
|
21245
21634
|
# This setting doesn't apply to RDS Custom or Amazon Aurora.
|
21246
21635
|
#
|
21636
|
+
# @option params [Boolean] :manage_master_user_password
|
21637
|
+
# A value that indicates whether to manage the master user password with
|
21638
|
+
# Amazon Web Services Secrets Manager.
|
21639
|
+
#
|
21640
|
+
# For more information, see [Password management with Amazon Web
|
21641
|
+
# Services Secrets Manager][1] in the *Amazon RDS User Guide.*
|
21642
|
+
#
|
21643
|
+
# Constraints:
|
21644
|
+
#
|
21645
|
+
# * Can't manage the master user password with Amazon Web Services
|
21646
|
+
# Secrets Manager if `MasterUserPassword` is specified.
|
21647
|
+
#
|
21648
|
+
# ^
|
21649
|
+
#
|
21650
|
+
#
|
21651
|
+
#
|
21652
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html
|
21653
|
+
#
|
21654
|
+
# @option params [String] :master_user_secret_kms_key_id
|
21655
|
+
# The Amazon Web Services KMS key identifier to encrypt a secret that is
|
21656
|
+
# automatically generated and managed in Amazon Web Services Secrets
|
21657
|
+
# Manager.
|
21658
|
+
#
|
21659
|
+
# This setting is valid only if the master user password is managed by
|
21660
|
+
# RDS in Amazon Web Services Secrets Manager for the DB instance.
|
21661
|
+
#
|
21662
|
+
# The Amazon Web Services KMS key identifier is the key ARN, key ID,
|
21663
|
+
# alias ARN, or alias name for the KMS key. To use a KMS key in a
|
21664
|
+
# different Amazon Web Services account, specify the key ARN or alias
|
21665
|
+
# ARN.
|
21666
|
+
#
|
21667
|
+
# If you don't specify `MasterUserSecretKmsKeyId`, then the
|
21668
|
+
# `aws/secretsmanager` KMS key is used to encrypt the secret. If the
|
21669
|
+
# secret is in a different Amazon Web Services account, then you can't
|
21670
|
+
# use the `aws/secretsmanager` KMS key to encrypt the secret, and you
|
21671
|
+
# must use a customer managed KMS key.
|
21672
|
+
#
|
21673
|
+
# There is a default KMS key for your Amazon Web Services account. Your
|
21674
|
+
# Amazon Web Services account has a different default KMS key for each
|
21675
|
+
# Amazon Web Services Region.
|
21676
|
+
#
|
21247
21677
|
# @return [Types::RestoreDBInstanceFromS3Result] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
21248
21678
|
#
|
21249
21679
|
# * {Types::RestoreDBInstanceFromS3Result#db_instance #db_instance} => Types::DBInstance
|
@@ -21307,6 +21737,8 @@ module Aws::RDS
|
|
21307
21737
|
# max_allocated_storage: 1,
|
21308
21738
|
# network_type: "String",
|
21309
21739
|
# storage_throughput: 1,
|
21740
|
+
# manage_master_user_password: false,
|
21741
|
+
# master_user_secret_kms_key_id: "String",
|
21310
21742
|
# })
|
21311
21743
|
#
|
21312
21744
|
# @example Response structure
|
@@ -21454,6 +21886,9 @@ module Aws::RDS
|
|
21454
21886
|
# resp.db_instance.activity_stream_policy_status #=> String, one of "locked", "unlocked", "locking-policy", "unlocking-policy"
|
21455
21887
|
# resp.db_instance.storage_throughput #=> Integer
|
21456
21888
|
# resp.db_instance.db_system_id #=> String
|
21889
|
+
# resp.db_instance.master_user_secret.secret_arn #=> String
|
21890
|
+
# resp.db_instance.master_user_secret.secret_status #=> String
|
21891
|
+
# resp.db_instance.master_user_secret.kms_key_id #=> String
|
21457
21892
|
#
|
21458
21893
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/RestoreDBInstanceFromS3 AWS API Documentation
|
21459
21894
|
#
|
@@ -22202,6 +22637,9 @@ module Aws::RDS
|
|
22202
22637
|
# resp.db_instance.activity_stream_policy_status #=> String, one of "locked", "unlocked", "locking-policy", "unlocking-policy"
|
22203
22638
|
# resp.db_instance.storage_throughput #=> Integer
|
22204
22639
|
# resp.db_instance.db_system_id #=> String
|
22640
|
+
# resp.db_instance.master_user_secret.secret_arn #=> String
|
22641
|
+
# resp.db_instance.master_user_secret.secret_status #=> String
|
22642
|
+
# resp.db_instance.master_user_secret.kms_key_id #=> String
|
22205
22643
|
#
|
22206
22644
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/RestoreDBInstanceToPointInTime AWS API Documentation
|
22207
22645
|
#
|
@@ -22525,6 +22963,9 @@ module Aws::RDS
|
|
22525
22963
|
# resp.db_cluster.serverless_v2_scaling_configuration.max_capacity #=> Float
|
22526
22964
|
# resp.db_cluster.network_type #=> String
|
22527
22965
|
# resp.db_cluster.db_system_id #=> String
|
22966
|
+
# resp.db_cluster.master_user_secret.secret_arn #=> String
|
22967
|
+
# resp.db_cluster.master_user_secret.secret_status #=> String
|
22968
|
+
# resp.db_cluster.master_user_secret.kms_key_id #=> String
|
22528
22969
|
#
|
22529
22970
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/StartDBCluster AWS API Documentation
|
22530
22971
|
#
|
@@ -22709,6 +23150,9 @@ module Aws::RDS
|
|
22709
23150
|
# resp.db_instance.activity_stream_policy_status #=> String, one of "locked", "unlocked", "locking-policy", "unlocking-policy"
|
22710
23151
|
# resp.db_instance.storage_throughput #=> Integer
|
22711
23152
|
# resp.db_instance.db_system_id #=> String
|
23153
|
+
# resp.db_instance.master_user_secret.secret_arn #=> String
|
23154
|
+
# resp.db_instance.master_user_secret.secret_status #=> String
|
23155
|
+
# resp.db_instance.master_user_secret.kms_key_id #=> String
|
22712
23156
|
#
|
22713
23157
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/StartDBInstance AWS API Documentation
|
22714
23158
|
#
|
@@ -23154,6 +23598,9 @@ module Aws::RDS
|
|
23154
23598
|
# resp.db_cluster.serverless_v2_scaling_configuration.max_capacity #=> Float
|
23155
23599
|
# resp.db_cluster.network_type #=> String
|
23156
23600
|
# resp.db_cluster.db_system_id #=> String
|
23601
|
+
# resp.db_cluster.master_user_secret.secret_arn #=> String
|
23602
|
+
# resp.db_cluster.master_user_secret.secret_status #=> String
|
23603
|
+
# resp.db_cluster.master_user_secret.kms_key_id #=> String
|
23157
23604
|
#
|
23158
23605
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/StopDBCluster AWS API Documentation
|
23159
23606
|
#
|
@@ -23345,6 +23792,9 @@ module Aws::RDS
|
|
23345
23792
|
# resp.db_instance.activity_stream_policy_status #=> String, one of "locked", "unlocked", "locking-policy", "unlocking-policy"
|
23346
23793
|
# resp.db_instance.storage_throughput #=> Integer
|
23347
23794
|
# resp.db_instance.db_system_id #=> String
|
23795
|
+
# resp.db_instance.master_user_secret.secret_arn #=> String
|
23796
|
+
# resp.db_instance.master_user_secret.secret_status #=> String
|
23797
|
+
# resp.db_instance.master_user_secret.kms_key_id #=> String
|
23348
23798
|
#
|
23349
23799
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/StopDBInstance AWS API Documentation
|
23350
23800
|
#
|
@@ -23667,6 +24117,9 @@ module Aws::RDS
|
|
23667
24117
|
# resp.db_instance.activity_stream_policy_status #=> String, one of "locked", "unlocked", "locking-policy", "unlocking-policy"
|
23668
24118
|
# resp.db_instance.storage_throughput #=> Integer
|
23669
24119
|
# resp.db_instance.db_system_id #=> String
|
24120
|
+
# resp.db_instance.master_user_secret.secret_arn #=> String
|
24121
|
+
# resp.db_instance.master_user_secret.secret_status #=> String
|
24122
|
+
# resp.db_instance.master_user_secret.kms_key_id #=> String
|
23670
24123
|
#
|
23671
24124
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/SwitchoverReadReplica AWS API Documentation
|
23672
24125
|
#
|
@@ -23690,7 +24143,7 @@ module Aws::RDS
|
|
23690
24143
|
params: params,
|
23691
24144
|
config: config)
|
23692
24145
|
context[:gem_name] = 'aws-sdk-rds'
|
23693
|
-
context[:gem_version] = '1.
|
24146
|
+
context[:gem_version] = '1.168.0'
|
23694
24147
|
Seahorse::Client::Request.new(handlers, context)
|
23695
24148
|
end
|
23696
24149
|
|