aws-sdk-rds 1.166.0 → 1.168.0
Sign up to get free protection for your applications and to get access to all the features.
- 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/types.rb
CHANGED
@@ -1753,6 +1753,11 @@ module Aws::RDS
|
|
1753
1753
|
# assumed.
|
1754
1754
|
# @return [String]
|
1755
1755
|
#
|
1756
|
+
# @!attribute [rw] image_id
|
1757
|
+
# The ID of the AMI. An AMI ID is required to create a CEV for RDS
|
1758
|
+
# Custom for SQL Server.
|
1759
|
+
# @return [String]
|
1760
|
+
#
|
1756
1761
|
# @!attribute [rw] kms_key_id
|
1757
1762
|
# The Amazon Web Services KMS key identifier for an encrypted CEV. A
|
1758
1763
|
# symmetric encryption KMS key is required for RDS Custom, but
|
@@ -1831,6 +1836,7 @@ module Aws::RDS
|
|
1831
1836
|
:engine_version,
|
1832
1837
|
:database_installation_files_s3_bucket_name,
|
1833
1838
|
:database_installation_files_s3_prefix,
|
1839
|
+
:image_id,
|
1834
1840
|
:kms_key_id,
|
1835
1841
|
:description,
|
1836
1842
|
:manifest,
|
@@ -2097,7 +2103,11 @@ module Aws::RDS
|
|
2097
2103
|
# The password for the master database user. This password can contain
|
2098
2104
|
# any printable ASCII character except "/", """, or "@".
|
2099
2105
|
#
|
2100
|
-
# Constraints:
|
2106
|
+
# Constraints:
|
2107
|
+
#
|
2108
|
+
# * Must contain from 8 to 41 characters.
|
2109
|
+
#
|
2110
|
+
# * Can't be specified if `ManageMasterUserPassword` is turned on.
|
2101
2111
|
#
|
2102
2112
|
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
2103
2113
|
# @return [String]
|
@@ -2704,6 +2714,56 @@ module Aws::RDS
|
|
2704
2714
|
# Reserved for future use.
|
2705
2715
|
# @return [String]
|
2706
2716
|
#
|
2717
|
+
# @!attribute [rw] manage_master_user_password
|
2718
|
+
# A value that indicates whether to manage the master user password
|
2719
|
+
# with Amazon Web Services Secrets Manager.
|
2720
|
+
#
|
2721
|
+
# For more information, see [Password management with Amazon Web
|
2722
|
+
# Services Secrets Manager][1] in the *Amazon RDS User Guide* and
|
2723
|
+
# [Password management with Amazon Web Services Secrets Manager][2] in
|
2724
|
+
# the *Amazon Aurora User Guide.*
|
2725
|
+
#
|
2726
|
+
# Constraints:
|
2727
|
+
#
|
2728
|
+
# * Can't manage the master user password with Amazon Web Services
|
2729
|
+
# Secrets Manager if `MasterUserPassword` is specified.
|
2730
|
+
#
|
2731
|
+
# ^
|
2732
|
+
#
|
2733
|
+
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
2734
|
+
#
|
2735
|
+
#
|
2736
|
+
#
|
2737
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html
|
2738
|
+
# [2]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/rds-secrets-manager.html
|
2739
|
+
# @return [Boolean]
|
2740
|
+
#
|
2741
|
+
# @!attribute [rw] master_user_secret_kms_key_id
|
2742
|
+
# The Amazon Web Services KMS key identifier to encrypt a secret that
|
2743
|
+
# is automatically generated and managed in Amazon Web Services
|
2744
|
+
# Secrets Manager.
|
2745
|
+
#
|
2746
|
+
# This setting is valid only if the master user password is managed by
|
2747
|
+
# RDS in Amazon Web Services Secrets Manager for the DB cluster.
|
2748
|
+
#
|
2749
|
+
# The Amazon Web Services KMS key identifier is the key ARN, key ID,
|
2750
|
+
# alias ARN, or alias name for the KMS key. To use a KMS key in a
|
2751
|
+
# different Amazon Web Services account, specify the key ARN or alias
|
2752
|
+
# ARN.
|
2753
|
+
#
|
2754
|
+
# If you don't specify `MasterUserSecretKmsKeyId`, then the
|
2755
|
+
# `aws/secretsmanager` KMS key is used to encrypt the secret. If the
|
2756
|
+
# secret is in a different Amazon Web Services account, then you
|
2757
|
+
# can't use the `aws/secretsmanager` KMS key to encrypt the secret,
|
2758
|
+
# and you must use a customer managed KMS key.
|
2759
|
+
#
|
2760
|
+
# There is a default KMS key for your Amazon Web Services account.
|
2761
|
+
# Your Amazon Web Services account has a different default KMS key for
|
2762
|
+
# each Amazon Web Services Region.
|
2763
|
+
#
|
2764
|
+
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
2765
|
+
# @return [String]
|
2766
|
+
#
|
2707
2767
|
# @!attribute [rw] source_region
|
2708
2768
|
# The source region of the snapshot. This is only needed when the
|
2709
2769
|
# shapshot is encrypted and in a different region.
|
@@ -2759,6 +2819,8 @@ module Aws::RDS
|
|
2759
2819
|
:serverless_v2_scaling_configuration,
|
2760
2820
|
:network_type,
|
2761
2821
|
:db_system_id,
|
2822
|
+
:manage_master_user_password,
|
2823
|
+
:master_user_secret_kms_key_id,
|
2762
2824
|
:source_region)
|
2763
2825
|
SENSITIVE = []
|
2764
2826
|
include Aws::Structure
|
@@ -3287,6 +3349,9 @@ module Aws::RDS
|
|
3287
3349
|
# Not applicable. The password for the master user is managed by the
|
3288
3350
|
# DB cluster.
|
3289
3351
|
#
|
3352
|
+
# Constraints: Can't be specified if `ManageMasterUserPassword` is
|
3353
|
+
# turned on.
|
3354
|
+
#
|
3290
3355
|
# **MariaDB**
|
3291
3356
|
#
|
3292
3357
|
# Constraints: Must contain from 8 to 41 characters.
|
@@ -4127,6 +4192,49 @@ module Aws::RDS
|
|
4127
4192
|
# This setting doesn't apply to RDS Custom or Amazon Aurora.
|
4128
4193
|
# @return [Integer]
|
4129
4194
|
#
|
4195
|
+
# @!attribute [rw] manage_master_user_password
|
4196
|
+
# A value that indicates whether to manage the master user password
|
4197
|
+
# with Amazon Web Services Secrets Manager.
|
4198
|
+
#
|
4199
|
+
# For more information, see [Password management with Amazon Web
|
4200
|
+
# Services Secrets Manager][1] in the *Amazon RDS User Guide.*
|
4201
|
+
#
|
4202
|
+
# Constraints:
|
4203
|
+
#
|
4204
|
+
# * Can't manage the master user password with Amazon Web Services
|
4205
|
+
# Secrets Manager if `MasterUserPassword` is specified.
|
4206
|
+
#
|
4207
|
+
# ^
|
4208
|
+
#
|
4209
|
+
#
|
4210
|
+
#
|
4211
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html
|
4212
|
+
# @return [Boolean]
|
4213
|
+
#
|
4214
|
+
# @!attribute [rw] master_user_secret_kms_key_id
|
4215
|
+
# The Amazon Web Services KMS key identifier to encrypt a secret that
|
4216
|
+
# is automatically generated and managed in Amazon Web Services
|
4217
|
+
# Secrets Manager.
|
4218
|
+
#
|
4219
|
+
# This setting is valid only if the master user password is managed by
|
4220
|
+
# RDS in Amazon Web Services Secrets Manager for the DB instance.
|
4221
|
+
#
|
4222
|
+
# The Amazon Web Services KMS key identifier is the key ARN, key ID,
|
4223
|
+
# alias ARN, or alias name for the KMS key. To use a KMS key in a
|
4224
|
+
# different Amazon Web Services account, specify the key ARN or alias
|
4225
|
+
# ARN.
|
4226
|
+
#
|
4227
|
+
# If you don't specify `MasterUserSecretKmsKeyId`, then the
|
4228
|
+
# `aws/secretsmanager` KMS key is used to encrypt the secret. If the
|
4229
|
+
# secret is in a different Amazon Web Services account, then you
|
4230
|
+
# can't use the `aws/secretsmanager` KMS key to encrypt the secret,
|
4231
|
+
# and you must use a customer managed KMS key.
|
4232
|
+
#
|
4233
|
+
# There is a default KMS key for your Amazon Web Services account.
|
4234
|
+
# Your Amazon Web Services account has a different default KMS key for
|
4235
|
+
# each Amazon Web Services Region.
|
4236
|
+
# @return [String]
|
4237
|
+
#
|
4130
4238
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/CreateDBInstanceMessage AWS API Documentation
|
4131
4239
|
#
|
4132
4240
|
class CreateDBInstanceMessage < Struct.new(
|
@@ -4181,7 +4289,9 @@ module Aws::RDS
|
|
4181
4289
|
:custom_iam_instance_profile,
|
4182
4290
|
:backup_target,
|
4183
4291
|
:network_type,
|
4184
|
-
:storage_throughput
|
4292
|
+
:storage_throughput,
|
4293
|
+
:manage_master_user_password,
|
4294
|
+
:master_user_secret_kms_key_id)
|
4185
4295
|
SENSITIVE = []
|
4186
4296
|
include Aws::Structure
|
4187
4297
|
end
|
@@ -5565,6 +5675,25 @@ module Aws::RDS
|
|
5565
5675
|
#
|
5566
5676
|
class CustomAvailabilityZoneNotFoundFault < Aws::EmptyStructure; end
|
5567
5677
|
|
5678
|
+
# A value that indicates the AMI information.
|
5679
|
+
#
|
5680
|
+
# @!attribute [rw] image_id
|
5681
|
+
# A value that indicates the ID of the AMI.
|
5682
|
+
# @return [String]
|
5683
|
+
#
|
5684
|
+
# @!attribute [rw] status
|
5685
|
+
# A value that indicates the status of a custom engine version (CEV).
|
5686
|
+
# @return [String]
|
5687
|
+
#
|
5688
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/CustomDBEngineVersionAMI AWS API Documentation
|
5689
|
+
#
|
5690
|
+
class CustomDBEngineVersionAMI < Struct.new(
|
5691
|
+
:image_id,
|
5692
|
+
:status)
|
5693
|
+
SENSITIVE = []
|
5694
|
+
include Aws::Structure
|
5695
|
+
end
|
5696
|
+
|
5568
5697
|
# A CEV with the specified name already exists.
|
5569
5698
|
#
|
5570
5699
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/CustomDBEngineVersionAlreadyExistsFault AWS API Documentation
|
@@ -6100,6 +6229,21 @@ module Aws::RDS
|
|
6100
6229
|
# Reserved for future use.
|
6101
6230
|
# @return [String]
|
6102
6231
|
#
|
6232
|
+
# @!attribute [rw] master_user_secret
|
6233
|
+
# Contains the secret managed by RDS in Amazon Web Services Secrets
|
6234
|
+
# Manager for the master user password.
|
6235
|
+
#
|
6236
|
+
# For more information, see [Password management with Amazon Web
|
6237
|
+
# Services Secrets Manager][1] in the *Amazon RDS User Guide* and
|
6238
|
+
# [Password management with Amazon Web Services Secrets Manager][2] in
|
6239
|
+
# the *Amazon Aurora User Guide.*
|
6240
|
+
#
|
6241
|
+
#
|
6242
|
+
#
|
6243
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html
|
6244
|
+
# [2]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/rds-secrets-manager.html
|
6245
|
+
# @return [Types::MasterUserSecret]
|
6246
|
+
#
|
6103
6247
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DBCluster AWS API Documentation
|
6104
6248
|
#
|
6105
6249
|
class DBCluster < Struct.new(
|
@@ -6172,7 +6316,8 @@ module Aws::RDS
|
|
6172
6316
|
:performance_insights_retention_period,
|
6173
6317
|
:serverless_v2_scaling_configuration,
|
6174
6318
|
:network_type,
|
6175
|
-
:db_system_id
|
6319
|
+
:db_system_id,
|
6320
|
+
:master_user_secret)
|
6176
6321
|
SENSITIVE = []
|
6177
6322
|
include Aws::Structure
|
6178
6323
|
end
|
@@ -6968,6 +7113,15 @@ module Aws::RDS
|
|
6968
7113
|
# isn't specified.
|
6969
7114
|
# @return [Types::CharacterSet]
|
6970
7115
|
#
|
7116
|
+
# @!attribute [rw] image
|
7117
|
+
# The EC2 image
|
7118
|
+
# @return [Types::CustomDBEngineVersionAMI]
|
7119
|
+
#
|
7120
|
+
# @!attribute [rw] db_engine_media_type
|
7121
|
+
# A value that indicates the source media provider of the AMI based on
|
7122
|
+
# the usage operation. Applicable for RDS Custom for SQL Server.
|
7123
|
+
# @return [String]
|
7124
|
+
#
|
6971
7125
|
# @!attribute [rw] supported_character_sets
|
6972
7126
|
# A list of the character sets supported by this engine for the
|
6973
7127
|
# `CharacterSetName` parameter of the `CreateDBInstance` operation.
|
@@ -7109,6 +7263,8 @@ module Aws::RDS
|
|
7109
7263
|
:db_engine_description,
|
7110
7264
|
:db_engine_version_description,
|
7111
7265
|
:default_character_set,
|
7266
|
+
:image,
|
7267
|
+
:db_engine_media_type,
|
7112
7268
|
:supported_character_sets,
|
7113
7269
|
:supported_nchar_character_sets,
|
7114
7270
|
:valid_upgrade_target,
|
@@ -7726,6 +7882,18 @@ module Aws::RDS
|
|
7726
7882
|
# for RDS Custom only.
|
7727
7883
|
# @return [String]
|
7728
7884
|
#
|
7885
|
+
# @!attribute [rw] master_user_secret
|
7886
|
+
# Contains the secret managed by RDS in Amazon Web Services Secrets
|
7887
|
+
# Manager for the master user password.
|
7888
|
+
#
|
7889
|
+
# For more information, see [Password management with Amazon Web
|
7890
|
+
# Services Secrets Manager][1] in the *Amazon RDS User Guide.*
|
7891
|
+
#
|
7892
|
+
#
|
7893
|
+
#
|
7894
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html
|
7895
|
+
# @return [Types::MasterUserSecret]
|
7896
|
+
#
|
7729
7897
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DBInstance AWS API Documentation
|
7730
7898
|
#
|
7731
7899
|
class DBInstance < Struct.new(
|
@@ -7806,7 +7974,8 @@ module Aws::RDS
|
|
7806
7974
|
:network_type,
|
7807
7975
|
:activity_stream_policy_status,
|
7808
7976
|
:storage_throughput,
|
7809
|
-
:db_system_id
|
7977
|
+
:db_system_id,
|
7978
|
+
:master_user_secret)
|
7810
7979
|
SENSITIVE = []
|
7811
7980
|
include Aws::Structure
|
7812
7981
|
end
|
@@ -12693,6 +12862,12 @@ module Aws::RDS
|
|
12693
12862
|
include Aws::Structure
|
12694
12863
|
end
|
12695
12864
|
|
12865
|
+
# The AMI configuration prerequisite has not been met.
|
12866
|
+
#
|
12867
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/Ec2ImagePropertiesNotSupportedFault AWS API Documentation
|
12868
|
+
#
|
12869
|
+
class Ec2ImagePropertiesNotSupportedFault < Aws::EmptyStructure; end
|
12870
|
+
|
12696
12871
|
# This data type represents the information you need to connect to an
|
12697
12872
|
# Amazon RDS DB instance. This data type is used as a response element
|
12698
12873
|
# in the following actions:
|
@@ -13734,6 +13909,61 @@ module Aws::RDS
|
|
13734
13909
|
include Aws::Structure
|
13735
13910
|
end
|
13736
13911
|
|
13912
|
+
# Contains the secret managed by RDS in Amazon Web Services Secrets
|
13913
|
+
# Manager for the master user password.
|
13914
|
+
#
|
13915
|
+
# For more information, see [Password management with Amazon Web
|
13916
|
+
# Services Secrets Manager][1] in the *Amazon RDS User Guide* and
|
13917
|
+
# [Password management with Amazon Web Services Secrets Manager][2] in
|
13918
|
+
# the *Amazon Aurora User Guide.*
|
13919
|
+
#
|
13920
|
+
#
|
13921
|
+
#
|
13922
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html
|
13923
|
+
# [2]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/rds-secrets-manager.html
|
13924
|
+
#
|
13925
|
+
# @!attribute [rw] secret_arn
|
13926
|
+
# The Amazon Resource Name (ARN) of the secret.
|
13927
|
+
# @return [String]
|
13928
|
+
#
|
13929
|
+
# @!attribute [rw] secret_status
|
13930
|
+
# The status of the secret.
|
13931
|
+
#
|
13932
|
+
# The possible status values include the following:
|
13933
|
+
#
|
13934
|
+
# * `creating` - The secret is being created.
|
13935
|
+
#
|
13936
|
+
# * `active` - The secret is available for normal use and rotation.
|
13937
|
+
#
|
13938
|
+
# * `rotating` - The secret is being rotated.
|
13939
|
+
#
|
13940
|
+
# * `impaired` - The secret can be used to access database
|
13941
|
+
# credentials, but it can't be rotated. A secret might have this
|
13942
|
+
# status if, for example, permissions are changed so that RDS can no
|
13943
|
+
# longer access either the secret or the KMS key for the secret.
|
13944
|
+
#
|
13945
|
+
# When a secret has this status, you can correct the condition that
|
13946
|
+
# caused the status. Alternatively, modify the DB instance to turn
|
13947
|
+
# off automatic management of database credentials, and then modify
|
13948
|
+
# the DB instance again to turn on automatic management of database
|
13949
|
+
# credentials.
|
13950
|
+
# @return [String]
|
13951
|
+
#
|
13952
|
+
# @!attribute [rw] kms_key_id
|
13953
|
+
# The Amazon Web Services KMS key identifier that is used to encrypt
|
13954
|
+
# the secret.
|
13955
|
+
# @return [String]
|
13956
|
+
#
|
13957
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/MasterUserSecret AWS API Documentation
|
13958
|
+
#
|
13959
|
+
class MasterUserSecret < Struct.new(
|
13960
|
+
:secret_arn,
|
13961
|
+
:secret_status,
|
13962
|
+
:kms_key_id)
|
13963
|
+
SENSITIVE = []
|
13964
|
+
include Aws::Structure
|
13965
|
+
end
|
13966
|
+
|
13737
13967
|
# The minimum DB engine version required for each corresponding allowed
|
13738
13968
|
# value for an option setting.
|
13739
13969
|
#
|
@@ -14079,7 +14309,11 @@ module Aws::RDS
|
|
14079
14309
|
# contain any printable ASCII character except "/", """, or
|
14080
14310
|
# "@".
|
14081
14311
|
#
|
14082
|
-
# Constraints:
|
14312
|
+
# Constraints:
|
14313
|
+
#
|
14314
|
+
# * Must contain from 8 to 41 characters.
|
14315
|
+
#
|
14316
|
+
# * Can't be specified if `ManageMasterUserPassword` is turned on.
|
14083
14317
|
#
|
14084
14318
|
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
14085
14319
|
# @return [String]
|
@@ -14552,6 +14786,99 @@ module Aws::RDS
|
|
14552
14786
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html
|
14553
14787
|
# @return [String]
|
14554
14788
|
#
|
14789
|
+
# @!attribute [rw] manage_master_user_password
|
14790
|
+
# A value that indicates whether to manage the master user password
|
14791
|
+
# with Amazon Web Services Secrets Manager.
|
14792
|
+
#
|
14793
|
+
# If the DB cluster doesn't manage the master user password with
|
14794
|
+
# Amazon Web Services Secrets Manager, you can turn on this
|
14795
|
+
# management. In this case, you can't specify `MasterUserPassword`.
|
14796
|
+
#
|
14797
|
+
# If the DB cluster already manages the master user password with
|
14798
|
+
# Amazon Web Services Secrets Manager, and you specify that the master
|
14799
|
+
# user password is not managed with Amazon Web Services Secrets
|
14800
|
+
# Manager, then you must specify `MasterUserPassword`. In this case,
|
14801
|
+
# RDS deletes the secret and uses the new password for the master user
|
14802
|
+
# specified by `MasterUserPassword`.
|
14803
|
+
#
|
14804
|
+
# For more information, see [Password management with Amazon Web
|
14805
|
+
# Services Secrets Manager][1] in the *Amazon RDS User Guide* and
|
14806
|
+
# [Password management with Amazon Web Services Secrets Manager][2] in
|
14807
|
+
# the *Amazon Aurora User Guide.*
|
14808
|
+
#
|
14809
|
+
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
14810
|
+
#
|
14811
|
+
#
|
14812
|
+
#
|
14813
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html
|
14814
|
+
# [2]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/rds-secrets-manager.html
|
14815
|
+
# @return [Boolean]
|
14816
|
+
#
|
14817
|
+
# @!attribute [rw] rotate_master_user_password
|
14818
|
+
# A value that indicates whether to rotate the secret managed by
|
14819
|
+
# Amazon Web Services Secrets Manager for the master user password.
|
14820
|
+
#
|
14821
|
+
# This setting is valid only if the master user password is managed by
|
14822
|
+
# RDS in Amazon Web Services Secrets Manager for the DB cluster. The
|
14823
|
+
# secret value contains the updated password.
|
14824
|
+
#
|
14825
|
+
# For more information, see [Password management with Amazon Web
|
14826
|
+
# Services Secrets Manager][1] in the *Amazon RDS User Guide* and
|
14827
|
+
# [Password management with Amazon Web Services Secrets Manager][2] in
|
14828
|
+
# the *Amazon Aurora User Guide.*
|
14829
|
+
#
|
14830
|
+
# Constraints:
|
14831
|
+
#
|
14832
|
+
# * You must apply the change immediately when rotating the master
|
14833
|
+
# user password.
|
14834
|
+
#
|
14835
|
+
# ^
|
14836
|
+
#
|
14837
|
+
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
14838
|
+
#
|
14839
|
+
#
|
14840
|
+
#
|
14841
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html
|
14842
|
+
# [2]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/rds-secrets-manager.html
|
14843
|
+
# @return [Boolean]
|
14844
|
+
#
|
14845
|
+
# @!attribute [rw] master_user_secret_kms_key_id
|
14846
|
+
# The Amazon Web Services KMS key identifier to encrypt a secret that
|
14847
|
+
# is automatically generated and managed in Amazon Web Services
|
14848
|
+
# Secrets Manager.
|
14849
|
+
#
|
14850
|
+
# This setting is valid only if both of the following conditions are
|
14851
|
+
# met:
|
14852
|
+
#
|
14853
|
+
# * The DB cluster doesn't manage the master user password in Amazon
|
14854
|
+
# Web Services Secrets Manager.
|
14855
|
+
#
|
14856
|
+
# If the DB cluster already manages the master user password in
|
14857
|
+
# Amazon Web Services Secrets Manager, you can't change the KMS key
|
14858
|
+
# that is used to encrypt the secret.
|
14859
|
+
#
|
14860
|
+
# * You are turning on `ManageMasterUserPassword` to manage the master
|
14861
|
+
# user password in Amazon Web Services Secrets Manager.
|
14862
|
+
#
|
14863
|
+
# If you are turning on `ManageMasterUserPassword` and don't
|
14864
|
+
# specify `MasterUserSecretKmsKeyId`, then the `aws/secretsmanager`
|
14865
|
+
# KMS key is used to encrypt the secret. If the secret is in a
|
14866
|
+
# different Amazon Web Services account, then you can't use the
|
14867
|
+
# `aws/secretsmanager` KMS key to encrypt the secret, and you must
|
14868
|
+
# use a customer managed KMS key.
|
14869
|
+
#
|
14870
|
+
# The Amazon Web Services KMS key identifier is the key ARN, key ID,
|
14871
|
+
# alias ARN, or alias name for the KMS key. To use a KMS key in a
|
14872
|
+
# different Amazon Web Services account, specify the key ARN or alias
|
14873
|
+
# ARN.
|
14874
|
+
#
|
14875
|
+
# There is a default KMS key for your Amazon Web Services account.
|
14876
|
+
# Your Amazon Web Services account has a different default KMS key for
|
14877
|
+
# each Amazon Web Services Region.
|
14878
|
+
#
|
14879
|
+
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
14880
|
+
# @return [String]
|
14881
|
+
#
|
14555
14882
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/ModifyDBClusterMessage AWS API Documentation
|
14556
14883
|
#
|
14557
14884
|
class ModifyDBClusterMessage < Struct.new(
|
@@ -14590,7 +14917,10 @@ module Aws::RDS
|
|
14590
14917
|
:performance_insights_kms_key_id,
|
14591
14918
|
:performance_insights_retention_period,
|
14592
14919
|
:serverless_v2_scaling_configuration,
|
14593
|
-
:network_type
|
14920
|
+
:network_type,
|
14921
|
+
:manage_master_user_password,
|
14922
|
+
:rotate_master_user_password,
|
14923
|
+
:master_user_secret_kms_key_id)
|
14594
14924
|
SENSITIVE = []
|
14595
14925
|
include Aws::Structure
|
14596
14926
|
end
|
@@ -14884,6 +15214,9 @@ module Aws::RDS
|
|
14884
15214
|
#
|
14885
15215
|
# Default: Uses existing setting
|
14886
15216
|
#
|
15217
|
+
# Constraints: Can't be specified if `ManageMasterUserPassword` is
|
15218
|
+
# turned on.
|
15219
|
+
#
|
14887
15220
|
# **MariaDB**
|
14888
15221
|
#
|
14889
15222
|
# Constraints: Must contain from 8 to 41 characters.
|
@@ -15631,6 +15964,94 @@ module Aws::RDS
|
|
15631
15964
|
# This setting doesn't apply to RDS Custom or Amazon Aurora.
|
15632
15965
|
# @return [Integer]
|
15633
15966
|
#
|
15967
|
+
# @!attribute [rw] manage_master_user_password
|
15968
|
+
# A value that indicates whether to manage the master user password
|
15969
|
+
# with Amazon Web Services Secrets Manager.
|
15970
|
+
#
|
15971
|
+
# If the DB cluster doesn't manage the master user password with
|
15972
|
+
# Amazon Web Services Secrets Manager, you can turn on this
|
15973
|
+
# management. In this case, you can't specify `MasterUserPassword`.
|
15974
|
+
#
|
15975
|
+
# If the DB cluster already manages the master user password with
|
15976
|
+
# Amazon Web Services Secrets Manager, and you specify that the master
|
15977
|
+
# user password is not managed with Amazon Web Services Secrets
|
15978
|
+
# Manager, then you must specify `MasterUserPassword`. In this case,
|
15979
|
+
# RDS deletes the secret and uses the new password for the master user
|
15980
|
+
# specified by `MasterUserPassword`.
|
15981
|
+
#
|
15982
|
+
# For more information, see [Password management with Amazon Web
|
15983
|
+
# Services Secrets Manager][1] in the *Amazon RDS User Guide.*
|
15984
|
+
#
|
15985
|
+
# Constraints:
|
15986
|
+
#
|
15987
|
+
# * Can't manage the master user password with Amazon Web Services
|
15988
|
+
# Secrets Manager if `MasterUserPassword` is specified.
|
15989
|
+
#
|
15990
|
+
# ^
|
15991
|
+
#
|
15992
|
+
#
|
15993
|
+
#
|
15994
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html
|
15995
|
+
# @return [Boolean]
|
15996
|
+
#
|
15997
|
+
# @!attribute [rw] rotate_master_user_password
|
15998
|
+
# A value that indicates whether to rotate the secret managed by
|
15999
|
+
# Amazon Web Services Secrets Manager for the master user password.
|
16000
|
+
#
|
16001
|
+
# This setting is valid only if the master user password is managed by
|
16002
|
+
# RDS in Amazon Web Services Secrets Manager for the DB cluster. The
|
16003
|
+
# secret value contains the updated password.
|
16004
|
+
#
|
16005
|
+
# For more information, see [Password management with Amazon Web
|
16006
|
+
# Services Secrets Manager][1] in the *Amazon RDS User Guide.*
|
16007
|
+
#
|
16008
|
+
# Constraints:
|
16009
|
+
#
|
16010
|
+
# * You must apply the change immediately when rotating the master
|
16011
|
+
# user password.
|
16012
|
+
#
|
16013
|
+
# ^
|
16014
|
+
#
|
16015
|
+
#
|
16016
|
+
#
|
16017
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html
|
16018
|
+
# @return [Boolean]
|
16019
|
+
#
|
16020
|
+
# @!attribute [rw] master_user_secret_kms_key_id
|
16021
|
+
# The Amazon Web Services KMS key identifier to encrypt a secret that
|
16022
|
+
# is automatically generated and managed in Amazon Web Services
|
16023
|
+
# Secrets Manager.
|
16024
|
+
#
|
16025
|
+
# This setting is valid only if both of the following conditions are
|
16026
|
+
# met:
|
16027
|
+
#
|
16028
|
+
# * The DB instance doesn't manage the master user password in Amazon
|
16029
|
+
# Web Services Secrets Manager.
|
16030
|
+
#
|
16031
|
+
# If the DB instance already manages the master user password in
|
16032
|
+
# Amazon Web Services Secrets Manager, you can't change the KMS key
|
16033
|
+
# used to encrypt the secret.
|
16034
|
+
#
|
16035
|
+
# * You are turning on `ManageMasterUserPassword` to manage the master
|
16036
|
+
# user password in Amazon Web Services Secrets Manager.
|
16037
|
+
#
|
16038
|
+
# If you are turning on `ManageMasterUserPassword` and don't
|
16039
|
+
# specify `MasterUserSecretKmsKeyId`, then the `aws/secretsmanager`
|
16040
|
+
# KMS key is used to encrypt the secret. If the secret is in a
|
16041
|
+
# different Amazon Web Services account, then you can't use the
|
16042
|
+
# `aws/secretsmanager` KMS key to encrypt the secret, and you must
|
16043
|
+
# use a customer managed KMS key.
|
16044
|
+
#
|
16045
|
+
# The Amazon Web Services KMS key identifier is the key ARN, key ID,
|
16046
|
+
# alias ARN, or alias name for the KMS key. To use a KMS key in a
|
16047
|
+
# different Amazon Web Services account, specify the key ARN or alias
|
16048
|
+
# ARN.
|
16049
|
+
#
|
16050
|
+
# There is a default KMS key for your Amazon Web Services account.
|
16051
|
+
# Your Amazon Web Services account has a different default KMS key for
|
16052
|
+
# each Amazon Web Services Region.
|
16053
|
+
# @return [String]
|
16054
|
+
#
|
15634
16055
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/ModifyDBInstanceMessage AWS API Documentation
|
15635
16056
|
#
|
15636
16057
|
class ModifyDBInstanceMessage < Struct.new(
|
@@ -15682,7 +16103,10 @@ module Aws::RDS
|
|
15682
16103
|
:automation_mode,
|
15683
16104
|
:resume_full_automation_mode_minutes,
|
15684
16105
|
:network_type,
|
15685
|
-
:storage_throughput
|
16106
|
+
:storage_throughput,
|
16107
|
+
:manage_master_user_password,
|
16108
|
+
:rotate_master_user_password,
|
16109
|
+
:master_user_secret_kms_key_id)
|
15686
16110
|
SENSITIVE = []
|
15687
16111
|
include Aws::Structure
|
15688
16112
|
end
|
@@ -18438,7 +18862,11 @@ module Aws::RDS
|
|
18438
18862
|
# The password for the master database user. This password can contain
|
18439
18863
|
# any printable ASCII character except "/", """, or "@".
|
18440
18864
|
#
|
18441
|
-
# Constraints:
|
18865
|
+
# Constraints:
|
18866
|
+
#
|
18867
|
+
# * Must contain from 8 to 41 characters.
|
18868
|
+
#
|
18869
|
+
# * Can't be specified if `ManageMasterUserPassword` is turned on.
|
18442
18870
|
# @return [String]
|
18443
18871
|
#
|
18444
18872
|
# @!attribute [rw] option_group_name
|
@@ -18676,6 +19104,52 @@ module Aws::RDS
|
|
18676
19104
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html
|
18677
19105
|
# @return [String]
|
18678
19106
|
#
|
19107
|
+
# @!attribute [rw] manage_master_user_password
|
19108
|
+
# A value that indicates whether to manage the master user password
|
19109
|
+
# with Amazon Web Services Secrets Manager.
|
19110
|
+
#
|
19111
|
+
# For more information, see [Password management with Amazon Web
|
19112
|
+
# Services Secrets Manager][1] in the *Amazon RDS User Guide* and
|
19113
|
+
# [Password management with Amazon Web Services Secrets Manager][2] in
|
19114
|
+
# the *Amazon Aurora User Guide.*
|
19115
|
+
#
|
19116
|
+
# Constraints:
|
19117
|
+
#
|
19118
|
+
# * Can't manage the master user password with Amazon Web Services
|
19119
|
+
# Secrets Manager if `MasterUserPassword` is specified.
|
19120
|
+
#
|
19121
|
+
# ^
|
19122
|
+
#
|
19123
|
+
#
|
19124
|
+
#
|
19125
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html
|
19126
|
+
# [2]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/rds-secrets-manager.html
|
19127
|
+
# @return [Boolean]
|
19128
|
+
#
|
19129
|
+
# @!attribute [rw] master_user_secret_kms_key_id
|
19130
|
+
# The Amazon Web Services KMS key identifier to encrypt a secret that
|
19131
|
+
# is automatically generated and managed in Amazon Web Services
|
19132
|
+
# Secrets Manager.
|
19133
|
+
#
|
19134
|
+
# This setting is valid only if the master user password is managed by
|
19135
|
+
# RDS in Amazon Web Services Secrets Manager for the DB cluster.
|
19136
|
+
#
|
19137
|
+
# The Amazon Web Services KMS key identifier is the key ARN, key ID,
|
19138
|
+
# alias ARN, or alias name for the KMS key. To use a KMS key in a
|
19139
|
+
# different Amazon Web Services account, specify the key ARN or alias
|
19140
|
+
# ARN.
|
19141
|
+
#
|
19142
|
+
# If you don't specify `MasterUserSecretKmsKeyId`, then the
|
19143
|
+
# `aws/secretsmanager` KMS key is used to encrypt the secret. If the
|
19144
|
+
# secret is in a different Amazon Web Services account, then you
|
19145
|
+
# can't use the `aws/secretsmanager` KMS key to encrypt the secret,
|
19146
|
+
# and you must use a customer managed KMS key.
|
19147
|
+
#
|
19148
|
+
# There is a default KMS key for your Amazon Web Services account.
|
19149
|
+
# Your Amazon Web Services account has a different default KMS key for
|
19150
|
+
# each Amazon Web Services Region.
|
19151
|
+
# @return [String]
|
19152
|
+
#
|
18679
19153
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/RestoreDBClusterFromS3Message AWS API Documentation
|
18680
19154
|
#
|
18681
19155
|
class RestoreDBClusterFromS3Message < Struct.new(
|
@@ -18711,7 +19185,9 @@ module Aws::RDS
|
|
18711
19185
|
:domain,
|
18712
19186
|
:domain_iam_role_name,
|
18713
19187
|
:serverless_v2_scaling_configuration,
|
18714
|
-
:network_type
|
19188
|
+
:network_type,
|
19189
|
+
:manage_master_user_password,
|
19190
|
+
:master_user_secret_kms_key_id)
|
18715
19191
|
SENSITIVE = []
|
18716
19192
|
include Aws::Structure
|
18717
19193
|
end
|
@@ -20383,7 +20859,28 @@ module Aws::RDS
|
|
20383
20859
|
# The password for the master user. The password can include any
|
20384
20860
|
# printable ASCII character except "/", """, or "@".
|
20385
20861
|
#
|
20862
|
+
# Constraints: Can't be specified if `ManageMasterUserPassword` is
|
20863
|
+
# turned on.
|
20864
|
+
#
|
20865
|
+
# **MariaDB**
|
20866
|
+
#
|
20386
20867
|
# Constraints: Must contain from 8 to 41 characters.
|
20868
|
+
#
|
20869
|
+
# **Microsoft SQL Server**
|
20870
|
+
#
|
20871
|
+
# Constraints: Must contain from 8 to 128 characters.
|
20872
|
+
#
|
20873
|
+
# **MySQL**
|
20874
|
+
#
|
20875
|
+
# Constraints: Must contain from 8 to 41 characters.
|
20876
|
+
#
|
20877
|
+
# **Oracle**
|
20878
|
+
#
|
20879
|
+
# Constraints: Must contain from 8 to 30 characters.
|
20880
|
+
#
|
20881
|
+
# **PostgreSQL**
|
20882
|
+
#
|
20883
|
+
# Constraints: Must contain from 8 to 128 characters.
|
20387
20884
|
# @return [String]
|
20388
20885
|
#
|
20389
20886
|
# @!attribute [rw] db_security_groups
|
@@ -20790,6 +21287,49 @@ module Aws::RDS
|
|
20790
21287
|
# This setting doesn't apply to RDS Custom or Amazon Aurora.
|
20791
21288
|
# @return [Integer]
|
20792
21289
|
#
|
21290
|
+
# @!attribute [rw] manage_master_user_password
|
21291
|
+
# A value that indicates whether to manage the master user password
|
21292
|
+
# with Amazon Web Services Secrets Manager.
|
21293
|
+
#
|
21294
|
+
# For more information, see [Password management with Amazon Web
|
21295
|
+
# Services Secrets Manager][1] in the *Amazon RDS User Guide.*
|
21296
|
+
#
|
21297
|
+
# Constraints:
|
21298
|
+
#
|
21299
|
+
# * Can't manage the master user password with Amazon Web Services
|
21300
|
+
# Secrets Manager if `MasterUserPassword` is specified.
|
21301
|
+
#
|
21302
|
+
# ^
|
21303
|
+
#
|
21304
|
+
#
|
21305
|
+
#
|
21306
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html
|
21307
|
+
# @return [Boolean]
|
21308
|
+
#
|
21309
|
+
# @!attribute [rw] master_user_secret_kms_key_id
|
21310
|
+
# The Amazon Web Services KMS key identifier to encrypt a secret that
|
21311
|
+
# is automatically generated and managed in Amazon Web Services
|
21312
|
+
# Secrets Manager.
|
21313
|
+
#
|
21314
|
+
# This setting is valid only if the master user password is managed by
|
21315
|
+
# RDS in Amazon Web Services Secrets Manager for the DB instance.
|
21316
|
+
#
|
21317
|
+
# The Amazon Web Services KMS key identifier is the key ARN, key ID,
|
21318
|
+
# alias ARN, or alias name for the KMS key. To use a KMS key in a
|
21319
|
+
# different Amazon Web Services account, specify the key ARN or alias
|
21320
|
+
# ARN.
|
21321
|
+
#
|
21322
|
+
# If you don't specify `MasterUserSecretKmsKeyId`, then the
|
21323
|
+
# `aws/secretsmanager` KMS key is used to encrypt the secret. If the
|
21324
|
+
# secret is in a different Amazon Web Services account, then you
|
21325
|
+
# can't use the `aws/secretsmanager` KMS key to encrypt the secret,
|
21326
|
+
# and you must use a customer managed KMS key.
|
21327
|
+
#
|
21328
|
+
# There is a default KMS key for your Amazon Web Services account.
|
21329
|
+
# Your Amazon Web Services account has a different default KMS key for
|
21330
|
+
# each Amazon Web Services Region.
|
21331
|
+
# @return [String]
|
21332
|
+
#
|
20793
21333
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/RestoreDBInstanceFromS3Message AWS API Documentation
|
20794
21334
|
#
|
20795
21335
|
class RestoreDBInstanceFromS3Message < Struct.new(
|
@@ -20838,7 +21378,9 @@ module Aws::RDS
|
|
20838
21378
|
:deletion_protection,
|
20839
21379
|
:max_allocated_storage,
|
20840
21380
|
:network_type,
|
20841
|
-
:storage_throughput
|
21381
|
+
:storage_throughput,
|
21382
|
+
:manage_master_user_password,
|
21383
|
+
:master_user_secret_kms_key_id)
|
20842
21384
|
SENSITIVE = []
|
20843
21385
|
include Aws::Structure
|
20844
21386
|
end
|