aws-sdk-docdb 1.79.0 → 1.81.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-docdb/client.rb +139 -1
- data/lib/aws-sdk-docdb/client_api.rb +12 -0
- data/lib/aws-sdk-docdb/types.rb +147 -2
- data/lib/aws-sdk-docdb.rb +1 -1
- data/sig/client.rbs +8 -1
- data/sig/resource.rbs +2 -0
- data/sig/types.rbs +13 -0
- metadata +4 -4
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 6adbfdf67f16ce1567f4613788bf19c2df7d629ec6015dad05b1e1de7b68fcd6
|
4
|
+
data.tar.gz: c7f4978704f193d5c4e1f52f486953622a57726f7b6c884f8b8765dc1977b40c
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: cd30086743d23d20083e908f79634733f27dfd1c5488ef28b3df8ccae913da985f2ac7c92c923a93efbe982a32ea8aa56431f1e9b0b4b714e04ea1397cd85774
|
7
|
+
data.tar.gz: 75df490a009076b5376f2ecabbed52443ed7ea91e30082be0625712d8a383f1fecafb5ed69bc8681ba5ab6bae1056609c68f254a2cd5948697d2879525831da0
|
data/CHANGELOG.md
CHANGED
@@ -1,6 +1,16 @@
|
|
1
1
|
Unreleased Changes
|
2
2
|
------------------
|
3
3
|
|
4
|
+
1.81.0 (2025-01-15)
|
5
|
+
------------------
|
6
|
+
|
7
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
8
|
+
|
9
|
+
1.80.0 (2024-12-20)
|
10
|
+
------------------
|
11
|
+
|
12
|
+
* Feature - Support AWS Secret Manager managed password for AWS DocumentDB instance-based cluster.
|
13
|
+
|
4
14
|
1.79.0 (2024-11-06)
|
5
15
|
------------------
|
6
16
|
|
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.
|
1
|
+
1.81.0
|
data/lib/aws-sdk-docdb/client.rb
CHANGED
@@ -259,11 +259,34 @@ module Aws::DocDB
|
|
259
259
|
# Used when loading credentials from the shared credentials file
|
260
260
|
# at HOME/.aws/credentials. When not specified, 'default' is used.
|
261
261
|
#
|
262
|
+
# @option options [String] :request_checksum_calculation ("when_supported")
|
263
|
+
# Determines when a checksum will be calculated for request payloads. Values are:
|
264
|
+
#
|
265
|
+
# * `when_supported` - (default) When set, a checksum will be
|
266
|
+
# calculated for all request payloads of operations modeled with the
|
267
|
+
# `httpChecksum` trait where `requestChecksumRequired` is `true` and/or a
|
268
|
+
# `requestAlgorithmMember` is modeled.
|
269
|
+
# * `when_required` - When set, a checksum will only be calculated for
|
270
|
+
# request payloads of operations modeled with the `httpChecksum` trait where
|
271
|
+
# `requestChecksumRequired` is `true` or where a `requestAlgorithmMember`
|
272
|
+
# is modeled and supplied.
|
273
|
+
#
|
262
274
|
# @option options [Integer] :request_min_compression_size_bytes (10240)
|
263
275
|
# The minimum size in bytes that triggers compression for request
|
264
276
|
# bodies. The value must be non-negative integer value between 0
|
265
277
|
# and 10485780 bytes inclusive.
|
266
278
|
#
|
279
|
+
# @option options [String] :response_checksum_validation ("when_supported")
|
280
|
+
# Determines when checksum validation will be performed on response payloads. Values are:
|
281
|
+
#
|
282
|
+
# * `when_supported` - (default) When set, checksum validation is performed on all
|
283
|
+
# response payloads of operations modeled with the `httpChecksum` trait where
|
284
|
+
# `responseAlgorithms` is modeled, except when no modeled checksum algorithms
|
285
|
+
# are supported.
|
286
|
+
# * `when_required` - When set, checksum validation is not performed on
|
287
|
+
# response payloads of operations unless the checksum algorithm is supported and
|
288
|
+
# the `requestValidationModeMember` member is set to `ENABLED`.
|
289
|
+
#
|
267
290
|
# @option options [Proc] :retry_backoff
|
268
291
|
# A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay.
|
269
292
|
# This option is only used in the `legacy` retry mode.
|
@@ -1020,6 +1043,35 @@ module Aws::DocDB
|
|
1020
1043
|
#
|
1021
1044
|
# </note>
|
1022
1045
|
#
|
1046
|
+
# @option params [Boolean] :manage_master_user_password
|
1047
|
+
# Specifies whether to manage the master user password with Amazon Web
|
1048
|
+
# Services Secrets Manager.
|
1049
|
+
#
|
1050
|
+
# Constraint: You can't manage the master user password with Amazon Web
|
1051
|
+
# Services Secrets Manager if `MasterUserPassword` is specified.
|
1052
|
+
#
|
1053
|
+
# @option params [String] :master_user_secret_kms_key_id
|
1054
|
+
# The Amazon Web Services KMS key identifier to encrypt a secret that is
|
1055
|
+
# automatically generated and managed in Amazon Web Services Secrets
|
1056
|
+
# Manager. This setting is valid only if the master user password is
|
1057
|
+
# managed by Amazon DocumentDB in Amazon Web Services Secrets Manager
|
1058
|
+
# for the DB cluster.
|
1059
|
+
#
|
1060
|
+
# The Amazon Web Services KMS key identifier is the key ARN, key ID,
|
1061
|
+
# alias ARN, or alias name for the KMS key. To use a KMS key in a
|
1062
|
+
# different Amazon Web Services account, specify the key ARN or alias
|
1063
|
+
# ARN.
|
1064
|
+
#
|
1065
|
+
# If you don't specify `MasterUserSecretKmsKeyId`, then the
|
1066
|
+
# `aws/secretsmanager` KMS key is used to encrypt the secret. If the
|
1067
|
+
# secret is in a different Amazon Web Services account, then you can't
|
1068
|
+
# use the `aws/secretsmanager` KMS key to encrypt the secret, and you
|
1069
|
+
# must use a customer managed KMS key.
|
1070
|
+
#
|
1071
|
+
# There is a default KMS key for your Amazon Web Services account. Your
|
1072
|
+
# Amazon Web Services account has a different default KMS key for each
|
1073
|
+
# Amazon Web Services Region.
|
1074
|
+
#
|
1023
1075
|
# @option params [String] :source_region
|
1024
1076
|
# The source region of the snapshot. This is only needed when the
|
1025
1077
|
# shapshot is encrypted and in a different region.
|
@@ -1057,6 +1109,8 @@ module Aws::DocDB
|
|
1057
1109
|
# deletion_protection: false,
|
1058
1110
|
# global_cluster_identifier: "GlobalClusterIdentifier",
|
1059
1111
|
# storage_type: "String",
|
1112
|
+
# manage_master_user_password: false,
|
1113
|
+
# master_user_secret_kms_key_id: "String",
|
1060
1114
|
# source_region: "String",
|
1061
1115
|
# })
|
1062
1116
|
#
|
@@ -1106,6 +1160,9 @@ module Aws::DocDB
|
|
1106
1160
|
# resp.db_cluster.enabled_cloudwatch_logs_exports[0] #=> String
|
1107
1161
|
# resp.db_cluster.deletion_protection #=> Boolean
|
1108
1162
|
# resp.db_cluster.storage_type #=> String
|
1163
|
+
# resp.db_cluster.master_user_secret.secret_arn #=> String
|
1164
|
+
# resp.db_cluster.master_user_secret.secret_status #=> String
|
1165
|
+
# resp.db_cluster.master_user_secret.kms_key_id #=> String
|
1109
1166
|
#
|
1110
1167
|
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/CreateDBCluster AWS API Documentation
|
1111
1168
|
#
|
@@ -1858,6 +1915,9 @@ module Aws::DocDB
|
|
1858
1915
|
# resp.db_cluster.enabled_cloudwatch_logs_exports[0] #=> String
|
1859
1916
|
# resp.db_cluster.deletion_protection #=> Boolean
|
1860
1917
|
# resp.db_cluster.storage_type #=> String
|
1918
|
+
# resp.db_cluster.master_user_secret.secret_arn #=> String
|
1919
|
+
# resp.db_cluster.master_user_secret.secret_status #=> String
|
1920
|
+
# resp.db_cluster.master_user_secret.kms_key_id #=> String
|
1861
1921
|
#
|
1862
1922
|
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DeleteDBCluster AWS API Documentation
|
1863
1923
|
#
|
@@ -2706,6 +2766,9 @@ module Aws::DocDB
|
|
2706
2766
|
# resp.db_clusters[0].enabled_cloudwatch_logs_exports[0] #=> String
|
2707
2767
|
# resp.db_clusters[0].deletion_protection #=> Boolean
|
2708
2768
|
# resp.db_clusters[0].storage_type #=> String
|
2769
|
+
# resp.db_clusters[0].master_user_secret.secret_arn #=> String
|
2770
|
+
# resp.db_clusters[0].master_user_secret.secret_status #=> String
|
2771
|
+
# resp.db_clusters[0].master_user_secret.kms_key_id #=> String
|
2709
2772
|
#
|
2710
2773
|
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DescribeDBClusters AWS API Documentation
|
2711
2774
|
#
|
@@ -3676,6 +3739,9 @@ module Aws::DocDB
|
|
3676
3739
|
# resp.db_cluster.enabled_cloudwatch_logs_exports[0] #=> String
|
3677
3740
|
# resp.db_cluster.deletion_protection #=> Boolean
|
3678
3741
|
# resp.db_cluster.storage_type #=> String
|
3742
|
+
# resp.db_cluster.master_user_secret.secret_arn #=> String
|
3743
|
+
# resp.db_cluster.master_user_secret.secret_status #=> String
|
3744
|
+
# resp.db_cluster.master_user_secret.kms_key_id #=> String
|
3679
3745
|
#
|
3680
3746
|
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/FailoverDBCluster AWS API Documentation
|
3681
3747
|
#
|
@@ -3979,6 +4045,60 @@ module Aws::DocDB
|
|
3979
4045
|
#
|
3980
4046
|
# Default value is `standard `
|
3981
4047
|
#
|
4048
|
+
# @option params [Boolean] :manage_master_user_password
|
4049
|
+
# Specifies whether to manage the master user password with Amazon Web
|
4050
|
+
# Services Secrets Manager. If the cluster doesn't manage the master
|
4051
|
+
# user password with Amazon Web Services Secrets Manager, you can turn
|
4052
|
+
# on this management. In this case, you can't specify
|
4053
|
+
# `MasterUserPassword`. If the cluster already manages the master user
|
4054
|
+
# password with Amazon Web Services Secrets Manager, and you specify
|
4055
|
+
# that the master user password is not managed with Amazon Web Services
|
4056
|
+
# Secrets Manager, then you must specify `MasterUserPassword`. In this
|
4057
|
+
# case, Amazon DocumentDB deletes the secret and uses the new password
|
4058
|
+
# for the master user specified by `MasterUserPassword`.
|
4059
|
+
#
|
4060
|
+
# @option params [String] :master_user_secret_kms_key_id
|
4061
|
+
# The Amazon Web Services KMS key identifier to encrypt a secret that is
|
4062
|
+
# automatically generated and managed in Amazon Web Services Secrets
|
4063
|
+
# Manager.
|
4064
|
+
#
|
4065
|
+
# This setting is valid only if both of the following conditions are
|
4066
|
+
# met:
|
4067
|
+
#
|
4068
|
+
# * The cluster doesn't manage the master user password in Amazon Web
|
4069
|
+
# Services Secrets Manager. If the cluster already manages the master
|
4070
|
+
# user password in Amazon Web Services Secrets Manager, you can't
|
4071
|
+
# change the KMS key that is used to encrypt the secret.
|
4072
|
+
#
|
4073
|
+
# * You are enabling `ManageMasterUserPassword` to manage the master
|
4074
|
+
# user password in Amazon Web Services Secrets Manager. If you are
|
4075
|
+
# turning on `ManageMasterUserPassword` and don't specify
|
4076
|
+
# `MasterUserSecretKmsKeyId`, then the `aws/secretsmanager` KMS key is
|
4077
|
+
# used to encrypt the secret. If the secret is in a different Amazon
|
4078
|
+
# Web Services account, then you can't use the `aws/secretsmanager`
|
4079
|
+
# KMS key to encrypt the secret, and you must use a customer managed
|
4080
|
+
# KMS key.
|
4081
|
+
#
|
4082
|
+
# The Amazon Web Services KMS key identifier is the key ARN, key ID,
|
4083
|
+
# alias ARN, or alias name for the KMS key. To use a KMS key in a
|
4084
|
+
# different Amazon Web Services account, specify the key ARN or alias
|
4085
|
+
# ARN.
|
4086
|
+
#
|
4087
|
+
# There is a default KMS key for your Amazon Web Services account. Your
|
4088
|
+
# Amazon Web Services account has a different default KMS key for each
|
4089
|
+
# Amazon Web Services Region.
|
4090
|
+
#
|
4091
|
+
# @option params [Boolean] :rotate_master_user_password
|
4092
|
+
# Specifies whether to rotate the secret managed by Amazon Web Services
|
4093
|
+
# Secrets Manager for the master user password.
|
4094
|
+
#
|
4095
|
+
# This setting is valid only if the master user password is managed by
|
4096
|
+
# Amazon DocumentDB in Amazon Web Services Secrets Manager for the
|
4097
|
+
# cluster. The secret value contains the updated password.
|
4098
|
+
#
|
4099
|
+
# Constraint: You must apply the change immediately when rotating the
|
4100
|
+
# master user password.
|
4101
|
+
#
|
3982
4102
|
# @return [Types::ModifyDBClusterResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3983
4103
|
#
|
3984
4104
|
# * {Types::ModifyDBClusterResult#db_cluster #db_cluster} => Types::DBCluster
|
@@ -4004,6 +4124,9 @@ module Aws::DocDB
|
|
4004
4124
|
# allow_major_version_upgrade: false,
|
4005
4125
|
# deletion_protection: false,
|
4006
4126
|
# storage_type: "String",
|
4127
|
+
# manage_master_user_password: false,
|
4128
|
+
# master_user_secret_kms_key_id: "String",
|
4129
|
+
# rotate_master_user_password: false,
|
4007
4130
|
# })
|
4008
4131
|
#
|
4009
4132
|
# @example Response structure
|
@@ -4052,6 +4175,9 @@ module Aws::DocDB
|
|
4052
4175
|
# resp.db_cluster.enabled_cloudwatch_logs_exports[0] #=> String
|
4053
4176
|
# resp.db_cluster.deletion_protection #=> Boolean
|
4054
4177
|
# resp.db_cluster.storage_type #=> String
|
4178
|
+
# resp.db_cluster.master_user_secret.secret_arn #=> String
|
4179
|
+
# resp.db_cluster.master_user_secret.secret_status #=> String
|
4180
|
+
# resp.db_cluster.master_user_secret.kms_key_id #=> String
|
4055
4181
|
#
|
4056
4182
|
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/ModifyDBCluster AWS API Documentation
|
4057
4183
|
#
|
@@ -5127,6 +5253,9 @@ module Aws::DocDB
|
|
5127
5253
|
# resp.db_cluster.enabled_cloudwatch_logs_exports[0] #=> String
|
5128
5254
|
# resp.db_cluster.deletion_protection #=> Boolean
|
5129
5255
|
# resp.db_cluster.storage_type #=> String
|
5256
|
+
# resp.db_cluster.master_user_secret.secret_arn #=> String
|
5257
|
+
# resp.db_cluster.master_user_secret.secret_status #=> String
|
5258
|
+
# resp.db_cluster.master_user_secret.kms_key_id #=> String
|
5130
5259
|
#
|
5131
5260
|
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/RestoreDBClusterFromSnapshot AWS API Documentation
|
5132
5261
|
#
|
@@ -5351,6 +5480,9 @@ module Aws::DocDB
|
|
5351
5480
|
# resp.db_cluster.enabled_cloudwatch_logs_exports[0] #=> String
|
5352
5481
|
# resp.db_cluster.deletion_protection #=> Boolean
|
5353
5482
|
# resp.db_cluster.storage_type #=> String
|
5483
|
+
# resp.db_cluster.master_user_secret.secret_arn #=> String
|
5484
|
+
# resp.db_cluster.master_user_secret.secret_status #=> String
|
5485
|
+
# resp.db_cluster.master_user_secret.kms_key_id #=> String
|
5354
5486
|
#
|
5355
5487
|
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/RestoreDBClusterToPointInTime AWS API Documentation
|
5356
5488
|
#
|
@@ -5429,6 +5561,9 @@ module Aws::DocDB
|
|
5429
5561
|
# resp.db_cluster.enabled_cloudwatch_logs_exports[0] #=> String
|
5430
5562
|
# resp.db_cluster.deletion_protection #=> Boolean
|
5431
5563
|
# resp.db_cluster.storage_type #=> String
|
5564
|
+
# resp.db_cluster.master_user_secret.secret_arn #=> String
|
5565
|
+
# resp.db_cluster.master_user_secret.secret_status #=> String
|
5566
|
+
# resp.db_cluster.master_user_secret.kms_key_id #=> String
|
5432
5567
|
#
|
5433
5568
|
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/StartDBCluster AWS API Documentation
|
5434
5569
|
#
|
@@ -5507,6 +5642,9 @@ module Aws::DocDB
|
|
5507
5642
|
# resp.db_cluster.enabled_cloudwatch_logs_exports[0] #=> String
|
5508
5643
|
# resp.db_cluster.deletion_protection #=> Boolean
|
5509
5644
|
# resp.db_cluster.storage_type #=> String
|
5645
|
+
# resp.db_cluster.master_user_secret.secret_arn #=> String
|
5646
|
+
# resp.db_cluster.master_user_secret.secret_status #=> String
|
5647
|
+
# resp.db_cluster.master_user_secret.kms_key_id #=> String
|
5510
5648
|
#
|
5511
5649
|
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/StopDBCluster AWS API Documentation
|
5512
5650
|
#
|
@@ -5605,7 +5743,7 @@ module Aws::DocDB
|
|
5605
5743
|
tracer: tracer
|
5606
5744
|
)
|
5607
5745
|
context[:gem_name] = 'aws-sdk-docdb'
|
5608
|
-
context[:gem_version] = '1.
|
5746
|
+
context[:gem_version] = '1.81.0'
|
5609
5747
|
Seahorse::Client::Request.new(handlers, context)
|
5610
5748
|
end
|
5611
5749
|
|
@@ -34,6 +34,7 @@ module Aws::DocDB
|
|
34
34
|
CertificateMessage = Shapes::StructureShape.new(name: 'CertificateMessage')
|
35
35
|
CertificateNotFoundFault = Shapes::StructureShape.new(name: 'CertificateNotFoundFault', error: {"code"=>"CertificateNotFound", "httpStatusCode"=>404, "senderFault"=>true})
|
36
36
|
CloudwatchLogsExportConfiguration = Shapes::StructureShape.new(name: 'CloudwatchLogsExportConfiguration')
|
37
|
+
ClusterMasterUserSecret = Shapes::StructureShape.new(name: 'ClusterMasterUserSecret')
|
37
38
|
CopyDBClusterParameterGroupMessage = Shapes::StructureShape.new(name: 'CopyDBClusterParameterGroupMessage')
|
38
39
|
CopyDBClusterParameterGroupResult = Shapes::StructureShape.new(name: 'CopyDBClusterParameterGroupResult')
|
39
40
|
CopyDBClusterSnapshotMessage = Shapes::StructureShape.new(name: 'CopyDBClusterSnapshotMessage')
|
@@ -314,6 +315,11 @@ module Aws::DocDB
|
|
314
315
|
CloudwatchLogsExportConfiguration.add_member(:disable_log_types, Shapes::ShapeRef.new(shape: LogTypeList, location_name: "DisableLogTypes"))
|
315
316
|
CloudwatchLogsExportConfiguration.struct_class = Types::CloudwatchLogsExportConfiguration
|
316
317
|
|
318
|
+
ClusterMasterUserSecret.add_member(:secret_arn, Shapes::ShapeRef.new(shape: String, location_name: "SecretArn"))
|
319
|
+
ClusterMasterUserSecret.add_member(:secret_status, Shapes::ShapeRef.new(shape: String, location_name: "SecretStatus"))
|
320
|
+
ClusterMasterUserSecret.add_member(:kms_key_id, Shapes::ShapeRef.new(shape: String, location_name: "KmsKeyId"))
|
321
|
+
ClusterMasterUserSecret.struct_class = Types::ClusterMasterUserSecret
|
322
|
+
|
317
323
|
CopyDBClusterParameterGroupMessage.add_member(:source_db_cluster_parameter_group_identifier, Shapes::ShapeRef.new(shape: String, required: true, location_name: "SourceDBClusterParameterGroupIdentifier"))
|
318
324
|
CopyDBClusterParameterGroupMessage.add_member(:target_db_cluster_parameter_group_identifier, Shapes::ShapeRef.new(shape: String, required: true, location_name: "TargetDBClusterParameterGroupIdentifier"))
|
319
325
|
CopyDBClusterParameterGroupMessage.add_member(:target_db_cluster_parameter_group_description, Shapes::ShapeRef.new(shape: String, required: true, location_name: "TargetDBClusterParameterGroupDescription"))
|
@@ -356,6 +362,8 @@ module Aws::DocDB
|
|
356
362
|
CreateDBClusterMessage.add_member(:deletion_protection, Shapes::ShapeRef.new(shape: BooleanOptional, location_name: "DeletionProtection"))
|
357
363
|
CreateDBClusterMessage.add_member(:global_cluster_identifier, Shapes::ShapeRef.new(shape: GlobalClusterIdentifier, location_name: "GlobalClusterIdentifier"))
|
358
364
|
CreateDBClusterMessage.add_member(:storage_type, Shapes::ShapeRef.new(shape: String, location_name: "StorageType"))
|
365
|
+
CreateDBClusterMessage.add_member(:manage_master_user_password, Shapes::ShapeRef.new(shape: BooleanOptional, location_name: "ManageMasterUserPassword"))
|
366
|
+
CreateDBClusterMessage.add_member(:master_user_secret_kms_key_id, Shapes::ShapeRef.new(shape: String, location_name: "MasterUserSecretKmsKeyId"))
|
359
367
|
CreateDBClusterMessage.add_member(:source_region, Shapes::ShapeRef.new(shape: String, location_name: "SourceRegion"))
|
360
368
|
CreateDBClusterMessage.struct_class = Types::CreateDBClusterMessage
|
361
369
|
|
@@ -463,6 +471,7 @@ module Aws::DocDB
|
|
463
471
|
DBCluster.add_member(:enabled_cloudwatch_logs_exports, Shapes::ShapeRef.new(shape: LogTypeList, location_name: "EnabledCloudwatchLogsExports"))
|
464
472
|
DBCluster.add_member(:deletion_protection, Shapes::ShapeRef.new(shape: Boolean, location_name: "DeletionProtection"))
|
465
473
|
DBCluster.add_member(:storage_type, Shapes::ShapeRef.new(shape: String, location_name: "StorageType"))
|
474
|
+
DBCluster.add_member(:master_user_secret, Shapes::ShapeRef.new(shape: ClusterMasterUserSecret, location_name: "MasterUserSecret"))
|
466
475
|
DBCluster.struct_class = Types::DBCluster
|
467
476
|
|
468
477
|
DBClusterAlreadyExistsFault.struct_class = Types::DBClusterAlreadyExistsFault
|
@@ -981,6 +990,9 @@ module Aws::DocDB
|
|
981
990
|
ModifyDBClusterMessage.add_member(:allow_major_version_upgrade, Shapes::ShapeRef.new(shape: Boolean, location_name: "AllowMajorVersionUpgrade"))
|
982
991
|
ModifyDBClusterMessage.add_member(:deletion_protection, Shapes::ShapeRef.new(shape: BooleanOptional, location_name: "DeletionProtection"))
|
983
992
|
ModifyDBClusterMessage.add_member(:storage_type, Shapes::ShapeRef.new(shape: String, location_name: "StorageType"))
|
993
|
+
ModifyDBClusterMessage.add_member(:manage_master_user_password, Shapes::ShapeRef.new(shape: BooleanOptional, location_name: "ManageMasterUserPassword"))
|
994
|
+
ModifyDBClusterMessage.add_member(:master_user_secret_kms_key_id, Shapes::ShapeRef.new(shape: String, location_name: "MasterUserSecretKmsKeyId"))
|
995
|
+
ModifyDBClusterMessage.add_member(:rotate_master_user_password, Shapes::ShapeRef.new(shape: BooleanOptional, location_name: "RotateMasterUserPassword"))
|
984
996
|
ModifyDBClusterMessage.struct_class = Types::ModifyDBClusterMessage
|
985
997
|
|
986
998
|
ModifyDBClusterParameterGroupMessage.add_member(:db_cluster_parameter_group_name, Shapes::ShapeRef.new(shape: String, required: true, location_name: "DBClusterParameterGroupName"))
|
data/lib/aws-sdk-docdb/types.rb
CHANGED
@@ -279,6 +279,51 @@ module Aws::DocDB
|
|
279
279
|
include Aws::Structure
|
280
280
|
end
|
281
281
|
|
282
|
+
# Contains the secret managed by Amazon DocumentDB in Amazon Web
|
283
|
+
# Services Secrets Manager for the master user password.
|
284
|
+
#
|
285
|
+
# @!attribute [rw] secret_arn
|
286
|
+
# The Amazon Resource Name (ARN) of the secret.
|
287
|
+
# @return [String]
|
288
|
+
#
|
289
|
+
# @!attribute [rw] secret_status
|
290
|
+
# The status of the secret.
|
291
|
+
#
|
292
|
+
# The possible status values include the following:
|
293
|
+
#
|
294
|
+
# * creating - The secret is being created.
|
295
|
+
#
|
296
|
+
# * active - The secret is available for normal use and rotation.
|
297
|
+
#
|
298
|
+
# * rotating - The secret is being rotated.
|
299
|
+
#
|
300
|
+
# * impaired - The secret can be used to access database credentials,
|
301
|
+
# but it can't be rotated. A secret might have this status if, for
|
302
|
+
# example, permissions are changed so that Amazon DocumentDB can no
|
303
|
+
# longer access either the secret or the KMS key for the secret.
|
304
|
+
#
|
305
|
+
# When a secret has this status, you can correct the condition that
|
306
|
+
# caused the status. Alternatively, modify the instance to turn off
|
307
|
+
# automatic management of database credentials, and then modify the
|
308
|
+
# instance again to turn on automatic management of database
|
309
|
+
# credentials.
|
310
|
+
# @return [String]
|
311
|
+
#
|
312
|
+
# @!attribute [rw] kms_key_id
|
313
|
+
# The Amazon Web Services KMS key identifier that is used to encrypt
|
314
|
+
# the secret.
|
315
|
+
# @return [String]
|
316
|
+
#
|
317
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/ClusterMasterUserSecret AWS API Documentation
|
318
|
+
#
|
319
|
+
class ClusterMasterUserSecret < Struct.new(
|
320
|
+
:secret_arn,
|
321
|
+
:secret_status,
|
322
|
+
:kms_key_id)
|
323
|
+
SENSITIVE = []
|
324
|
+
include Aws::Structure
|
325
|
+
end
|
326
|
+
|
282
327
|
# Represents the input to CopyDBClusterParameterGroup.
|
283
328
|
#
|
284
329
|
# @!attribute [rw] source_db_cluster_parameter_group_identifier
|
@@ -686,6 +731,37 @@ module Aws::DocDB
|
|
686
731
|
# </note>
|
687
732
|
# @return [String]
|
688
733
|
#
|
734
|
+
# @!attribute [rw] manage_master_user_password
|
735
|
+
# Specifies whether to manage the master user password with Amazon Web
|
736
|
+
# Services Secrets Manager.
|
737
|
+
#
|
738
|
+
# Constraint: You can't manage the master user password with Amazon
|
739
|
+
# Web Services Secrets Manager if `MasterUserPassword` is specified.
|
740
|
+
# @return [Boolean]
|
741
|
+
#
|
742
|
+
# @!attribute [rw] master_user_secret_kms_key_id
|
743
|
+
# The Amazon Web Services KMS key identifier to encrypt a secret that
|
744
|
+
# is automatically generated and managed in Amazon Web Services
|
745
|
+
# Secrets Manager. This setting is valid only if the master user
|
746
|
+
# password is managed by Amazon DocumentDB in Amazon Web Services
|
747
|
+
# Secrets Manager for the DB cluster.
|
748
|
+
#
|
749
|
+
# The Amazon Web Services KMS key identifier is the key ARN, key ID,
|
750
|
+
# alias ARN, or alias name for the KMS key. To use a KMS key in a
|
751
|
+
# different Amazon Web Services account, specify the key ARN or alias
|
752
|
+
# ARN.
|
753
|
+
#
|
754
|
+
# If you don't specify `MasterUserSecretKmsKeyId`, then the
|
755
|
+
# `aws/secretsmanager` KMS key is used to encrypt the secret. If the
|
756
|
+
# secret is in a different Amazon Web Services account, then you
|
757
|
+
# can't use the `aws/secretsmanager` KMS key to encrypt the secret,
|
758
|
+
# and you must use a customer managed KMS key.
|
759
|
+
#
|
760
|
+
# There is a default KMS key for your Amazon Web Services account.
|
761
|
+
# Your Amazon Web Services account has a different default KMS key for
|
762
|
+
# each Amazon Web Services Region.
|
763
|
+
# @return [String]
|
764
|
+
#
|
689
765
|
# @!attribute [rw] source_region
|
690
766
|
# The source region of the snapshot. This is only needed when the
|
691
767
|
# shapshot is encrypted and in a different region.
|
@@ -715,6 +791,8 @@ module Aws::DocDB
|
|
715
791
|
:deletion_protection,
|
716
792
|
:global_cluster_identifier,
|
717
793
|
:storage_type,
|
794
|
+
:manage_master_user_password,
|
795
|
+
:master_user_secret_kms_key_id,
|
718
796
|
:source_region)
|
719
797
|
SENSITIVE = []
|
720
798
|
include Aws::Structure
|
@@ -1373,6 +1451,11 @@ module Aws::DocDB
|
|
1373
1451
|
# Default value is `standard `
|
1374
1452
|
# @return [String]
|
1375
1453
|
#
|
1454
|
+
# @!attribute [rw] master_user_secret
|
1455
|
+
# The secret managed by Amazon DocumentDB in Amazon Web Services
|
1456
|
+
# Secrets Manager for the master user password.
|
1457
|
+
# @return [Types::ClusterMasterUserSecret]
|
1458
|
+
#
|
1376
1459
|
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DBCluster AWS API Documentation
|
1377
1460
|
#
|
1378
1461
|
class DBCluster < Struct.new(
|
@@ -1408,7 +1491,8 @@ module Aws::DocDB
|
|
1408
1491
|
:cluster_create_time,
|
1409
1492
|
:enabled_cloudwatch_logs_exports,
|
1410
1493
|
:deletion_protection,
|
1411
|
-
:storage_type
|
1494
|
+
:storage_type,
|
1495
|
+
:master_user_secret)
|
1412
1496
|
SENSITIVE = []
|
1413
1497
|
include Aws::Structure
|
1414
1498
|
end
|
@@ -4228,6 +4312,64 @@ module Aws::DocDB
|
|
4228
4312
|
# Default value is `standard `
|
4229
4313
|
# @return [String]
|
4230
4314
|
#
|
4315
|
+
# @!attribute [rw] manage_master_user_password
|
4316
|
+
# Specifies whether to manage the master user password with Amazon Web
|
4317
|
+
# Services Secrets Manager. If the cluster doesn't manage the master
|
4318
|
+
# user password with Amazon Web Services Secrets Manager, you can turn
|
4319
|
+
# on this management. In this case, you can't specify
|
4320
|
+
# `MasterUserPassword`. If the cluster already manages the master user
|
4321
|
+
# password with Amazon Web Services Secrets Manager, and you specify
|
4322
|
+
# that the master user password is not managed with Amazon Web
|
4323
|
+
# Services Secrets Manager, then you must specify
|
4324
|
+
# `MasterUserPassword`. In this case, Amazon DocumentDB deletes the
|
4325
|
+
# secret and uses the new password for the master user specified by
|
4326
|
+
# `MasterUserPassword`.
|
4327
|
+
# @return [Boolean]
|
4328
|
+
#
|
4329
|
+
# @!attribute [rw] master_user_secret_kms_key_id
|
4330
|
+
# The Amazon Web Services KMS key identifier to encrypt a secret that
|
4331
|
+
# is automatically generated and managed in Amazon Web Services
|
4332
|
+
# Secrets Manager.
|
4333
|
+
#
|
4334
|
+
# This setting is valid only if both of the following conditions are
|
4335
|
+
# met:
|
4336
|
+
#
|
4337
|
+
# * The cluster doesn't manage the master user password in Amazon Web
|
4338
|
+
# Services Secrets Manager. If the cluster already manages the
|
4339
|
+
# master user password in Amazon Web Services Secrets Manager, you
|
4340
|
+
# can't change the KMS key that is used to encrypt the secret.
|
4341
|
+
#
|
4342
|
+
# * You are enabling `ManageMasterUserPassword` to manage the master
|
4343
|
+
# user password in Amazon Web Services Secrets Manager. If you are
|
4344
|
+
# turning on `ManageMasterUserPassword` and don't specify
|
4345
|
+
# `MasterUserSecretKmsKeyId`, then the `aws/secretsmanager` KMS key
|
4346
|
+
# is used to encrypt the secret. If the secret is in a different
|
4347
|
+
# Amazon Web Services account, then you can't use the
|
4348
|
+
# `aws/secretsmanager` KMS key to encrypt the secret, and you must
|
4349
|
+
# use a customer managed KMS key.
|
4350
|
+
#
|
4351
|
+
# The Amazon Web Services KMS key identifier is the key ARN, key ID,
|
4352
|
+
# alias ARN, or alias name for the KMS key. To use a KMS key in a
|
4353
|
+
# different Amazon Web Services account, specify the key ARN or alias
|
4354
|
+
# ARN.
|
4355
|
+
#
|
4356
|
+
# There is a default KMS key for your Amazon Web Services account.
|
4357
|
+
# Your Amazon Web Services account has a different default KMS key for
|
4358
|
+
# each Amazon Web Services Region.
|
4359
|
+
# @return [String]
|
4360
|
+
#
|
4361
|
+
# @!attribute [rw] rotate_master_user_password
|
4362
|
+
# Specifies whether to rotate the secret managed by Amazon Web
|
4363
|
+
# Services Secrets Manager for the master user password.
|
4364
|
+
#
|
4365
|
+
# This setting is valid only if the master user password is managed by
|
4366
|
+
# Amazon DocumentDB in Amazon Web Services Secrets Manager for the
|
4367
|
+
# cluster. The secret value contains the updated password.
|
4368
|
+
#
|
4369
|
+
# Constraint: You must apply the change immediately when rotating the
|
4370
|
+
# master user password.
|
4371
|
+
# @return [Boolean]
|
4372
|
+
#
|
4231
4373
|
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/ModifyDBClusterMessage AWS API Documentation
|
4232
4374
|
#
|
4233
4375
|
class ModifyDBClusterMessage < Struct.new(
|
@@ -4245,7 +4387,10 @@ module Aws::DocDB
|
|
4245
4387
|
:engine_version,
|
4246
4388
|
:allow_major_version_upgrade,
|
4247
4389
|
:deletion_protection,
|
4248
|
-
:storage_type
|
4390
|
+
:storage_type,
|
4391
|
+
:manage_master_user_password,
|
4392
|
+
:master_user_secret_kms_key_id,
|
4393
|
+
:rotate_master_user_password)
|
4249
4394
|
SENSITIVE = []
|
4250
4395
|
include Aws::Structure
|
4251
4396
|
end
|
data/lib/aws-sdk-docdb.rb
CHANGED
data/sig/client.rbs
CHANGED
@@ -39,7 +39,9 @@ module Aws
|
|
39
39
|
?logger: untyped,
|
40
40
|
?max_attempts: Integer,
|
41
41
|
?profile: String,
|
42
|
+
?request_checksum_calculation: String,
|
42
43
|
?request_min_compression_size_bytes: Integer,
|
44
|
+
?response_checksum_validation: String,
|
43
45
|
?retry_backoff: Proc,
|
44
46
|
?retry_base_delay: Float,
|
45
47
|
?retry_jitter: (:none | :equal | :full | ^(Integer) -> Integer),
|
@@ -181,6 +183,8 @@ module Aws
|
|
181
183
|
?deletion_protection: bool,
|
182
184
|
?global_cluster_identifier: ::String,
|
183
185
|
?storage_type: ::String,
|
186
|
+
?manage_master_user_password: bool,
|
187
|
+
?master_user_secret_kms_key_id: ::String,
|
184
188
|
?source_region: ::String
|
185
189
|
) -> _CreateDBClusterResponseSuccess
|
186
190
|
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _CreateDBClusterResponseSuccess
|
@@ -739,7 +743,10 @@ module Aws
|
|
739
743
|
?engine_version: ::String,
|
740
744
|
?allow_major_version_upgrade: bool,
|
741
745
|
?deletion_protection: bool,
|
742
|
-
?storage_type: ::String
|
746
|
+
?storage_type: ::String,
|
747
|
+
?manage_master_user_password: bool,
|
748
|
+
?master_user_secret_kms_key_id: ::String,
|
749
|
+
?rotate_master_user_password: bool
|
743
750
|
) -> _ModifyDBClusterResponseSuccess
|
744
751
|
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ModifyDBClusterResponseSuccess
|
745
752
|
|
data/sig/resource.rbs
CHANGED
@@ -39,7 +39,9 @@ module Aws
|
|
39
39
|
?logger: untyped,
|
40
40
|
?max_attempts: Integer,
|
41
41
|
?profile: String,
|
42
|
+
?request_checksum_calculation: String,
|
42
43
|
?request_min_compression_size_bytes: Integer,
|
44
|
+
?response_checksum_validation: String,
|
43
45
|
?retry_backoff: Proc,
|
44
46
|
?retry_base_delay: Float,
|
45
47
|
?retry_jitter: (:none | :equal | :full | ^(Integer) -> Integer),
|
data/sig/types.rbs
CHANGED
@@ -76,6 +76,13 @@ module Aws::DocDB
|
|
76
76
|
SENSITIVE: []
|
77
77
|
end
|
78
78
|
|
79
|
+
class ClusterMasterUserSecret
|
80
|
+
attr_accessor secret_arn: ::String
|
81
|
+
attr_accessor secret_status: ::String
|
82
|
+
attr_accessor kms_key_id: ::String
|
83
|
+
SENSITIVE: []
|
84
|
+
end
|
85
|
+
|
79
86
|
class CopyDBClusterParameterGroupMessage
|
80
87
|
attr_accessor source_db_cluster_parameter_group_identifier: ::String
|
81
88
|
attr_accessor target_db_cluster_parameter_group_identifier: ::String
|
@@ -127,6 +134,8 @@ module Aws::DocDB
|
|
127
134
|
attr_accessor deletion_protection: bool
|
128
135
|
attr_accessor global_cluster_identifier: ::String
|
129
136
|
attr_accessor storage_type: ::String
|
137
|
+
attr_accessor manage_master_user_password: bool
|
138
|
+
attr_accessor master_user_secret_kms_key_id: ::String
|
130
139
|
attr_accessor source_region: ::String
|
131
140
|
SENSITIVE: []
|
132
141
|
end
|
@@ -262,6 +271,7 @@ module Aws::DocDB
|
|
262
271
|
attr_accessor enabled_cloudwatch_logs_exports: ::Array[::String]
|
263
272
|
attr_accessor deletion_protection: bool
|
264
273
|
attr_accessor storage_type: ::String
|
274
|
+
attr_accessor master_user_secret: Types::ClusterMasterUserSecret
|
265
275
|
SENSITIVE: []
|
266
276
|
end
|
267
277
|
|
@@ -914,6 +924,9 @@ module Aws::DocDB
|
|
914
924
|
attr_accessor allow_major_version_upgrade: bool
|
915
925
|
attr_accessor deletion_protection: bool
|
916
926
|
attr_accessor storage_type: ::String
|
927
|
+
attr_accessor manage_master_user_password: bool
|
928
|
+
attr_accessor master_user_secret_kms_key_id: ::String
|
929
|
+
attr_accessor rotate_master_user_password: bool
|
917
930
|
SENSITIVE: []
|
918
931
|
end
|
919
932
|
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: aws-sdk-docdb
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 1.
|
4
|
+
version: 1.81.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Amazon Web Services
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date:
|
11
|
+
date: 2025-01-15 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: aws-sdk-core
|
@@ -19,7 +19,7 @@ dependencies:
|
|
19
19
|
version: '3'
|
20
20
|
- - ">="
|
21
21
|
- !ruby/object:Gem::Version
|
22
|
-
version: 3.
|
22
|
+
version: 3.216.0
|
23
23
|
type: :runtime
|
24
24
|
prerelease: false
|
25
25
|
version_requirements: !ruby/object:Gem::Requirement
|
@@ -29,7 +29,7 @@ dependencies:
|
|
29
29
|
version: '3'
|
30
30
|
- - ">="
|
31
31
|
- !ruby/object:Gem::Version
|
32
|
-
version: 3.
|
32
|
+
version: 3.216.0
|
33
33
|
- !ruby/object:Gem::Dependency
|
34
34
|
name: aws-sigv4
|
35
35
|
requirement: !ruby/object:Gem::Requirement
|