aws-sdk-secretsmanager 1.58.0 → 1.61.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 +15 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-secretsmanager/client.rb +235 -98
- data/lib/aws-sdk-secretsmanager/types.rb +75 -15
- data/lib/aws-sdk-secretsmanager.rb +1 -1
- metadata +2 -2
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 832ad9eeab3ae719d2d6c26151ec9aaab148192d6b42be17490c00193d3b928c
|
|
4
|
+
data.tar.gz: ed9c5788cb61c16cd77a7e64384d5e37a5af226b4be7f068e0846324a84459d0
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: f453772e841f802a633a803ae51207e58382dc4a02c874939bf6042fbd37c956c25d841774459bdc427bc6d017a811b4d9fd9617551e1271e57bb9ad27fb89f3
|
|
7
|
+
data.tar.gz: 43a2d852ca685d9fa80b454620d1b2a448605400891915b78d4214f06a501e35cf8e58be55c5d56d5b84e9d25245432bc25456036e3b07276452e1121996eb78
|
data/CHANGELOG.md
CHANGED
|
@@ -1,6 +1,21 @@
|
|
|
1
1
|
Unreleased Changes
|
|
2
2
|
------------------
|
|
3
3
|
|
|
4
|
+
1.61.0 (2022-05-11)
|
|
5
|
+
------------------
|
|
6
|
+
|
|
7
|
+
* Feature - Doc only update for Secrets Manager that fixes several customer-reported issues.
|
|
8
|
+
|
|
9
|
+
1.60.0 (2022-04-21)
|
|
10
|
+
------------------
|
|
11
|
+
|
|
12
|
+
* Feature - Documentation updates for Secrets Manager
|
|
13
|
+
|
|
14
|
+
1.59.0 (2022-03-11)
|
|
15
|
+
------------------
|
|
16
|
+
|
|
17
|
+
* Feature - Documentation updates for Secrets Manager.
|
|
18
|
+
|
|
4
19
|
1.58.0 (2022-02-24)
|
|
5
20
|
------------------
|
|
6
21
|
|
data/VERSION
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
1.
|
|
1
|
+
1.61.0
|
|
@@ -364,32 +364,37 @@ module Aws::SecretsManager
|
|
|
364
364
|
# Turns off automatic rotation, and if a rotation is currently in
|
|
365
365
|
# progress, cancels the rotation.
|
|
366
366
|
#
|
|
367
|
-
#
|
|
368
|
-
#
|
|
369
|
-
#
|
|
370
|
-
#
|
|
371
|
-
#
|
|
372
|
-
#
|
|
373
|
-
#
|
|
374
|
-
#
|
|
375
|
-
#
|
|
367
|
+
# If you cancel a rotation in progress, it can leave the `VersionStage`
|
|
368
|
+
# labels in an unexpected state. You might need to remove the staging
|
|
369
|
+
# label `AWSPENDING` from the partially created version. You also need
|
|
370
|
+
# to determine whether to roll back to the previous version of the
|
|
371
|
+
# secret by moving the staging label `AWSCURRENT` to the version that
|
|
372
|
+
# has `AWSPENDING`. To determine which version has a specific staging
|
|
373
|
+
# label, call ListSecretVersionIds. Then use UpdateSecretVersionStage to
|
|
374
|
+
# change staging labels. For more information, see [How rotation
|
|
375
|
+
# works][1].
|
|
376
376
|
#
|
|
377
|
-
#
|
|
377
|
+
# To turn on automatic rotation again, call RotateSecret.
|
|
378
378
|
#
|
|
379
379
|
# <b>Required permissions: </b> `secretsmanager:CancelRotateSecret`. For
|
|
380
|
-
# more information, see [ IAM policy actions for Secrets Manager][
|
|
381
|
-
# [Authentication and access control in Secrets Manager][
|
|
380
|
+
# more information, see [ IAM policy actions for Secrets Manager][2] and
|
|
381
|
+
# [Authentication and access control in Secrets Manager][3].
|
|
382
382
|
#
|
|
383
383
|
#
|
|
384
384
|
#
|
|
385
|
-
# [1]: https://docs.aws.amazon.com/
|
|
386
|
-
# [2]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/
|
|
385
|
+
# [1]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/rotate-secrets_how.html
|
|
386
|
+
# [2]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions
|
|
387
|
+
# [3]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html
|
|
387
388
|
#
|
|
388
389
|
# @option params [required, String] :secret_id
|
|
389
390
|
# The ARN or name of the secret.
|
|
390
391
|
#
|
|
391
392
|
# For an ARN, we recommend that you specify a complete ARN rather than a
|
|
392
|
-
# partial ARN.
|
|
393
|
+
# partial ARN. See [Finding a secret from a partial ARN][1].
|
|
394
|
+
#
|
|
395
|
+
#
|
|
396
|
+
#
|
|
397
|
+
# [1]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot.html#ARN_secretnamehyphen
|
|
393
398
|
#
|
|
394
399
|
# @return [Types::CancelRotateSecretResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
395
400
|
#
|
|
@@ -435,8 +440,9 @@ module Aws::SecretsManager
|
|
|
435
440
|
req.send_request(options)
|
|
436
441
|
end
|
|
437
442
|
|
|
438
|
-
# Creates a new secret. A *secret*
|
|
439
|
-
# user name and password,
|
|
443
|
+
# Creates a new secret. A *secret* can be a password, a set of
|
|
444
|
+
# credentials such as a user name and password, an OAuth token, or other
|
|
445
|
+
# secret information that you store in an encrypted form in Secrets
|
|
440
446
|
# Manager. The secret also includes the connection information to access
|
|
441
447
|
# a database or other service, which Secrets Manager doesn't encrypt. A
|
|
442
448
|
# secret in Secrets Manager consists of both the protected secret data
|
|
@@ -451,6 +457,11 @@ module Aws::SecretsManager
|
|
|
451
457
|
# `SecretBinary` then Secrets Manager creates an initial secret version
|
|
452
458
|
# and automatically attaches the staging label `AWSCURRENT` to it.
|
|
453
459
|
#
|
|
460
|
+
# For database credentials you want to rotate, for Secrets Manager to be
|
|
461
|
+
# able to rotate the secret, you must make sure the JSON you store in
|
|
462
|
+
# the `SecretString` matches the [JSON structure of a database
|
|
463
|
+
# secret][2].
|
|
464
|
+
#
|
|
454
465
|
# If you don't specify an KMS encryption key, Secrets Manager uses the
|
|
455
466
|
# Amazon Web Services managed key `aws/secretsmanager`. If this key
|
|
456
467
|
# doesn't already exist in your account, then Secrets Manager creates
|
|
@@ -464,15 +475,22 @@ module Aws::SecretsManager
|
|
|
464
475
|
# to encrypt the secret, and you must create and use a customer managed
|
|
465
476
|
# KMS key.
|
|
466
477
|
#
|
|
467
|
-
# <b>Required permissions: </b> `secretsmanager:CreateSecret`.
|
|
468
|
-
#
|
|
469
|
-
#
|
|
478
|
+
# <b>Required permissions: </b> `secretsmanager:CreateSecret`. If you
|
|
479
|
+
# include tags in the secret, you also need
|
|
480
|
+
# `secretsmanager:TagResource`. For more information, see [ IAM policy
|
|
481
|
+
# actions for Secrets Manager][3] and [Authentication and access control
|
|
482
|
+
# in Secrets Manager][4].
|
|
483
|
+
#
|
|
484
|
+
# To encrypt the secret with a KMS key other than `aws/secretsmanager`,
|
|
485
|
+
# you need `kms:GenerateDataKey` and `kms:Decrypt` permission to the
|
|
486
|
+
# key.
|
|
470
487
|
#
|
|
471
488
|
#
|
|
472
489
|
#
|
|
473
490
|
# [1]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/manage_create-basic-secret.html
|
|
474
|
-
# [2]: https://docs.aws.amazon.com/
|
|
475
|
-
# [3]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/
|
|
491
|
+
# [2]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_secret_json_structure.html
|
|
492
|
+
# [3]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions
|
|
493
|
+
# [4]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html
|
|
476
494
|
#
|
|
477
495
|
# @option params [required, String] :name
|
|
478
496
|
# The name of the new secret.
|
|
@@ -648,7 +666,7 @@ module Aws::SecretsManager
|
|
|
648
666
|
# client_request_token: "EXAMPLE1-90ab-cdef-fedc-ba987SECRET1",
|
|
649
667
|
# description: "My test database secret created with the CLI",
|
|
650
668
|
# name: "MyTestDatabaseSecret",
|
|
651
|
-
# secret_string: "{\"username\":\"david\",\"password\":\"
|
|
669
|
+
# secret_string: "{\"username\":\"david\",\"password\":\"EXAMPLE-PASSWORD\"}",
|
|
652
670
|
# })
|
|
653
671
|
#
|
|
654
672
|
# resp.to_h outputs the following:
|
|
@@ -712,7 +730,7 @@ module Aws::SecretsManager
|
|
|
712
730
|
#
|
|
713
731
|
#
|
|
714
732
|
#
|
|
715
|
-
# [1]: https://docs.aws.amazon.com/
|
|
733
|
+
# [1]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions
|
|
716
734
|
# [2]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html
|
|
717
735
|
#
|
|
718
736
|
# @option params [required, String] :secret_id
|
|
@@ -720,7 +738,11 @@ module Aws::SecretsManager
|
|
|
720
738
|
# policy for.
|
|
721
739
|
#
|
|
722
740
|
# For an ARN, we recommend that you specify a complete ARN rather than a
|
|
723
|
-
# partial ARN.
|
|
741
|
+
# partial ARN. See [Finding a secret from a partial ARN][1].
|
|
742
|
+
#
|
|
743
|
+
#
|
|
744
|
+
#
|
|
745
|
+
# [1]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot.html#ARN_secretnamehyphen
|
|
724
746
|
#
|
|
725
747
|
# @return [Types::DeleteResourcePolicyResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
726
748
|
#
|
|
@@ -769,8 +791,20 @@ module Aws::SecretsManager
|
|
|
769
791
|
# the end of the recovery window. At the end of the recovery window,
|
|
770
792
|
# Secrets Manager deletes the secret permanently.
|
|
771
793
|
#
|
|
772
|
-
#
|
|
773
|
-
#
|
|
794
|
+
# You can't delete a primary secret that is replicated to other
|
|
795
|
+
# Regions. You must first delete the replicas using
|
|
796
|
+
# RemoveRegionsFromReplication, and then delete the primary secret. When
|
|
797
|
+
# you delete a replica, it is deleted immediately.
|
|
798
|
+
#
|
|
799
|
+
# You can't directly delete a version of a secret. Instead, you remove
|
|
800
|
+
# all staging labels from the version using UpdateSecretVersionStage.
|
|
801
|
+
# This marks the version as deprecated, and then Secrets Manager can
|
|
802
|
+
# automatically delete the version in the background.
|
|
803
|
+
#
|
|
804
|
+
# To determine whether an application still uses a secret, you can
|
|
805
|
+
# create an Amazon CloudWatch alarm to alert you to any attempts to
|
|
806
|
+
# access a secret during the recovery window. For more information, see
|
|
807
|
+
# [ Monitor secrets scheduled for deletion][1].
|
|
774
808
|
#
|
|
775
809
|
# Secrets Manager performs the permanent secret deletion at the end of
|
|
776
810
|
# the waiting period as a background task with low priority. There is no
|
|
@@ -780,9 +814,9 @@ module Aws::SecretsManager
|
|
|
780
814
|
# At any time before recovery window ends, you can use RestoreSecret to
|
|
781
815
|
# remove the `DeletionDate` and cancel the deletion of the secret.
|
|
782
816
|
#
|
|
783
|
-
#
|
|
784
|
-
# secret value.
|
|
785
|
-
#
|
|
817
|
+
# When a secret is scheduled for deletion, you cannot retrieve the
|
|
818
|
+
# secret value. You must first cancel the deletion with RestoreSecret
|
|
819
|
+
# and then you can retrieve the secret.
|
|
786
820
|
#
|
|
787
821
|
# <b>Required permissions: </b> `secretsmanager:DeleteSecret`. For more
|
|
788
822
|
# information, see [ IAM policy actions for Secrets Manager][2] and
|
|
@@ -790,15 +824,19 @@ module Aws::SecretsManager
|
|
|
790
824
|
#
|
|
791
825
|
#
|
|
792
826
|
#
|
|
793
|
-
# [1]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/
|
|
794
|
-
# [2]: https://docs.aws.amazon.com/
|
|
827
|
+
# [1]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/monitoring_cloudwatch_deleted-secrets.html
|
|
828
|
+
# [2]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions
|
|
795
829
|
# [3]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html
|
|
796
830
|
#
|
|
797
831
|
# @option params [required, String] :secret_id
|
|
798
832
|
# The ARN or name of the secret to delete.
|
|
799
833
|
#
|
|
800
834
|
# For an ARN, we recommend that you specify a complete ARN rather than a
|
|
801
|
-
# partial ARN.
|
|
835
|
+
# partial ARN. See [Finding a secret from a partial ARN][1].
|
|
836
|
+
#
|
|
837
|
+
#
|
|
838
|
+
#
|
|
839
|
+
# [1]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot.html#ARN_secretnamehyphen
|
|
802
840
|
#
|
|
803
841
|
# @option params [Integer] :recovery_window_in_days
|
|
804
842
|
# The number of days from 7 to 30 that Secrets Manager waits before
|
|
@@ -883,14 +921,18 @@ module Aws::SecretsManager
|
|
|
883
921
|
#
|
|
884
922
|
#
|
|
885
923
|
#
|
|
886
|
-
# [1]: https://docs.aws.amazon.com/
|
|
924
|
+
# [1]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions
|
|
887
925
|
# [2]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html
|
|
888
926
|
#
|
|
889
927
|
# @option params [required, String] :secret_id
|
|
890
928
|
# The ARN or name of the secret.
|
|
891
929
|
#
|
|
892
930
|
# For an ARN, we recommend that you specify a complete ARN rather than a
|
|
893
|
-
# partial ARN.
|
|
931
|
+
# partial ARN. See [Finding a secret from a partial ARN][1].
|
|
932
|
+
#
|
|
933
|
+
#
|
|
934
|
+
#
|
|
935
|
+
# [1]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot.html#ARN_secretnamehyphen
|
|
894
936
|
#
|
|
895
937
|
# @return [Types::DescribeSecretResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
896
938
|
#
|
|
@@ -933,7 +975,9 @@ module Aws::SecretsManager
|
|
|
933
975
|
# rotation_enabled: true,
|
|
934
976
|
# rotation_lambda_arn: "arn:aws:lambda:us-west-2:123456789012:function:MyTestRotationLambda",
|
|
935
977
|
# rotation_rules: {
|
|
936
|
-
# automatically_after_days:
|
|
978
|
+
# automatically_after_days: 14,
|
|
979
|
+
# duration: "2h",
|
|
980
|
+
# schedule_expression: "cron(0 16 1,15 * ? *)",
|
|
937
981
|
# },
|
|
938
982
|
# tags: [
|
|
939
983
|
# {
|
|
@@ -1011,7 +1055,7 @@ module Aws::SecretsManager
|
|
|
1011
1055
|
#
|
|
1012
1056
|
#
|
|
1013
1057
|
#
|
|
1014
|
-
# [1]: https://docs.aws.amazon.com/
|
|
1058
|
+
# [1]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions
|
|
1015
1059
|
# [2]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html
|
|
1016
1060
|
#
|
|
1017
1061
|
# @option params [Integer] :password_length
|
|
@@ -1068,7 +1112,7 @@ module Aws::SecretsManager
|
|
|
1068
1112
|
#
|
|
1069
1113
|
# resp.to_h outputs the following:
|
|
1070
1114
|
# {
|
|
1071
|
-
# random_password: "
|
|
1115
|
+
# random_password: "EXAMPLE-PASSWORD",
|
|
1072
1116
|
# }
|
|
1073
1117
|
#
|
|
1074
1118
|
# @example Request syntax with placeholder values
|
|
@@ -1109,7 +1153,7 @@ module Aws::SecretsManager
|
|
|
1109
1153
|
#
|
|
1110
1154
|
#
|
|
1111
1155
|
# [1]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access_resource-policies.html
|
|
1112
|
-
# [2]: https://docs.aws.amazon.com/
|
|
1156
|
+
# [2]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions
|
|
1113
1157
|
# [3]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html
|
|
1114
1158
|
#
|
|
1115
1159
|
# @option params [required, String] :secret_id
|
|
@@ -1117,7 +1161,11 @@ module Aws::SecretsManager
|
|
|
1117
1161
|
# policy for.
|
|
1118
1162
|
#
|
|
1119
1163
|
# For an ARN, we recommend that you specify a complete ARN rather than a
|
|
1120
|
-
# partial ARN.
|
|
1164
|
+
# partial ARN. See [Finding a secret from a partial ARN][1].
|
|
1165
|
+
#
|
|
1166
|
+
#
|
|
1167
|
+
#
|
|
1168
|
+
# [1]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot.html#ARN_secretnamehyphen
|
|
1121
1169
|
#
|
|
1122
1170
|
# @return [Types::GetResourcePolicyResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
1123
1171
|
#
|
|
@@ -1180,14 +1228,18 @@ module Aws::SecretsManager
|
|
|
1180
1228
|
#
|
|
1181
1229
|
#
|
|
1182
1230
|
# [1]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/retrieving-secrets.html
|
|
1183
|
-
# [2]: https://docs.aws.amazon.com/
|
|
1231
|
+
# [2]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions
|
|
1184
1232
|
# [3]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html
|
|
1185
1233
|
#
|
|
1186
1234
|
# @option params [required, String] :secret_id
|
|
1187
1235
|
# The ARN or name of the secret to retrieve.
|
|
1188
1236
|
#
|
|
1189
1237
|
# For an ARN, we recommend that you specify a complete ARN rather than a
|
|
1190
|
-
# partial ARN.
|
|
1238
|
+
# partial ARN. See [Finding a secret from a partial ARN][1].
|
|
1239
|
+
#
|
|
1240
|
+
#
|
|
1241
|
+
#
|
|
1242
|
+
# [1]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot.html#ARN_secretnamehyphen
|
|
1191
1243
|
#
|
|
1192
1244
|
# @option params [String] :version_id
|
|
1193
1245
|
# The unique identifier of the version of the secret to retrieve. If you
|
|
@@ -1225,13 +1277,10 @@ module Aws::SecretsManager
|
|
|
1225
1277
|
#
|
|
1226
1278
|
# @example Example: To retrieve the encrypted secret value of a secret
|
|
1227
1279
|
#
|
|
1228
|
-
# # The following example shows how to retrieve
|
|
1229
|
-
# # AWSPREVIOUS staging label attached. If you want to retrieve the AWSCURRENT version of the secret, then you can omit the
|
|
1230
|
-
# # VersionStage parameter because it defaults to AWSCURRENT.
|
|
1280
|
+
# # The following example shows how to retrieve a secret string value.
|
|
1231
1281
|
#
|
|
1232
1282
|
# resp = client.get_secret_value({
|
|
1233
1283
|
# secret_id: "MyTestDatabaseSecret",
|
|
1234
|
-
# version_stage: "AWSPREVIOUS",
|
|
1235
1284
|
# })
|
|
1236
1285
|
#
|
|
1237
1286
|
# resp.to_h outputs the following:
|
|
@@ -1239,7 +1288,7 @@ module Aws::SecretsManager
|
|
|
1239
1288
|
# arn: "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-a1b2c3",
|
|
1240
1289
|
# created_date: Time.parse(1523477145.713),
|
|
1241
1290
|
# name: "MyTestDatabaseSecret",
|
|
1242
|
-
# secret_string: "{\n \"username\":\"david\",\n \"password\":\"
|
|
1291
|
+
# secret_string: "{\n \"username\":\"david\",\n \"password\":\"EXAMPLE-PASSWORD\"\n}\n",
|
|
1243
1292
|
# version_id: "EXAMPLE1-90ab-cdef-fedc-ba987SECRET1",
|
|
1244
1293
|
# version_stages: [
|
|
1245
1294
|
# "AWSPREVIOUS",
|
|
@@ -1274,27 +1323,31 @@ module Aws::SecretsManager
|
|
|
1274
1323
|
req.send_request(options)
|
|
1275
1324
|
end
|
|
1276
1325
|
|
|
1277
|
-
# Lists the versions
|
|
1326
|
+
# Lists the versions of a secret. Secrets Manager uses staging labels to
|
|
1327
|
+
# indicate the different versions of a secret. For more information, see
|
|
1328
|
+
# [ Secrets Manager concepts: Versions][1].
|
|
1278
1329
|
#
|
|
1279
1330
|
# To list the secrets in the account, use ListSecrets.
|
|
1280
1331
|
#
|
|
1281
|
-
# To get the secret value from `SecretString` or `SecretBinary`, call
|
|
1282
|
-
# GetSecretValue.
|
|
1283
|
-
#
|
|
1284
1332
|
# <b>Required permissions: </b> `secretsmanager:ListSecretVersionIds`.
|
|
1285
|
-
# For more information, see [ IAM policy actions for Secrets Manager][
|
|
1286
|
-
# and [Authentication and access control in Secrets Manager][
|
|
1333
|
+
# For more information, see [ IAM policy actions for Secrets Manager][2]
|
|
1334
|
+
# and [Authentication and access control in Secrets Manager][3].
|
|
1287
1335
|
#
|
|
1288
1336
|
#
|
|
1289
1337
|
#
|
|
1290
|
-
# [1]: https://docs.aws.amazon.com/
|
|
1291
|
-
# [2]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/
|
|
1338
|
+
# [1]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/getting-started.html#term_version
|
|
1339
|
+
# [2]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions
|
|
1340
|
+
# [3]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html
|
|
1292
1341
|
#
|
|
1293
1342
|
# @option params [required, String] :secret_id
|
|
1294
1343
|
# The ARN or name of the secret whose versions you want to list.
|
|
1295
1344
|
#
|
|
1296
1345
|
# For an ARN, we recommend that you specify a complete ARN rather than a
|
|
1297
|
-
# partial ARN.
|
|
1346
|
+
# partial ARN. See [Finding a secret from a partial ARN][1].
|
|
1347
|
+
#
|
|
1348
|
+
#
|
|
1349
|
+
#
|
|
1350
|
+
# [1]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot.html#ARN_secretnamehyphen
|
|
1298
1351
|
#
|
|
1299
1352
|
# @option params [Integer] :max_results
|
|
1300
1353
|
# The number of results to include in the response.
|
|
@@ -1392,15 +1445,16 @@ module Aws::SecretsManager
|
|
|
1392
1445
|
end
|
|
1393
1446
|
|
|
1394
1447
|
# Lists the secrets that are stored by Secrets Manager in the Amazon Web
|
|
1395
|
-
# Services account.
|
|
1448
|
+
# Services account, not including secrets that are marked for deletion.
|
|
1449
|
+
# To see secrets marked for deletion, use the Secrets Manager console.
|
|
1396
1450
|
#
|
|
1397
1451
|
# To list the versions of a secret, use ListSecretVersionIds.
|
|
1398
1452
|
#
|
|
1399
1453
|
# To get the secret value from `SecretString` or `SecretBinary`, call
|
|
1400
1454
|
# GetSecretValue.
|
|
1401
1455
|
#
|
|
1402
|
-
# For information about finding secrets in the console, see [
|
|
1403
|
-
#
|
|
1456
|
+
# For information about finding secrets in the console, see [Find
|
|
1457
|
+
# secrets in Secrets Manager][1].
|
|
1404
1458
|
#
|
|
1405
1459
|
# <b>Required permissions: </b> `secretsmanager:ListSecrets`. For more
|
|
1406
1460
|
# information, see [ IAM policy actions for Secrets Manager][2] and
|
|
@@ -1409,7 +1463,7 @@ module Aws::SecretsManager
|
|
|
1409
1463
|
#
|
|
1410
1464
|
#
|
|
1411
1465
|
# [1]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/manage_search-secret.html
|
|
1412
|
-
# [2]: https://docs.aws.amazon.com/
|
|
1466
|
+
# [2]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions
|
|
1413
1467
|
# [3]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html
|
|
1414
1468
|
#
|
|
1415
1469
|
# @option params [Integer] :max_results
|
|
@@ -1538,13 +1592,17 @@ module Aws::SecretsManager
|
|
|
1538
1592
|
#
|
|
1539
1593
|
# [1]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html
|
|
1540
1594
|
# [2]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access_resource-based-policies.html
|
|
1541
|
-
# [3]: https://docs.aws.amazon.com/
|
|
1595
|
+
# [3]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions
|
|
1542
1596
|
#
|
|
1543
1597
|
# @option params [required, String] :secret_id
|
|
1544
1598
|
# The ARN or name of the secret to attach the resource-based policy.
|
|
1545
1599
|
#
|
|
1546
1600
|
# For an ARN, we recommend that you specify a complete ARN rather than a
|
|
1547
|
-
# partial ARN.
|
|
1601
|
+
# partial ARN. See [Finding a secret from a partial ARN][1].
|
|
1602
|
+
#
|
|
1603
|
+
#
|
|
1604
|
+
#
|
|
1605
|
+
# [1]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot.html#ARN_secretnamehyphen
|
|
1548
1606
|
#
|
|
1549
1607
|
# @option params [required, String] :resource_policy
|
|
1550
1608
|
# A JSON-formatted string for an Amazon Web Services resource-based
|
|
@@ -1641,17 +1699,21 @@ module Aws::SecretsManager
|
|
|
1641
1699
|
#
|
|
1642
1700
|
#
|
|
1643
1701
|
#
|
|
1644
|
-
# [1]: https://docs.aws.amazon.com/
|
|
1702
|
+
# [1]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions
|
|
1645
1703
|
# [2]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html
|
|
1646
1704
|
#
|
|
1647
1705
|
# @option params [required, String] :secret_id
|
|
1648
1706
|
# The ARN or name of the secret to add a new version to.
|
|
1649
1707
|
#
|
|
1650
1708
|
# For an ARN, we recommend that you specify a complete ARN rather than a
|
|
1651
|
-
# partial ARN.
|
|
1709
|
+
# partial ARN. See [Finding a secret from a partial ARN][1].
|
|
1652
1710
|
#
|
|
1653
1711
|
# If the secret doesn't already exist, use `CreateSecret` instead.
|
|
1654
1712
|
#
|
|
1713
|
+
#
|
|
1714
|
+
#
|
|
1715
|
+
# [1]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot.html#ARN_secretnamehyphen
|
|
1716
|
+
#
|
|
1655
1717
|
# @option params [String] :client_request_token
|
|
1656
1718
|
# A unique identifier for the new version of the secret.
|
|
1657
1719
|
#
|
|
@@ -1742,7 +1804,7 @@ module Aws::SecretsManager
|
|
|
1742
1804
|
# resp = client.put_secret_value({
|
|
1743
1805
|
# client_request_token: "EXAMPLE2-90ab-cdef-fedc-ba987EXAMPLE",
|
|
1744
1806
|
# secret_id: "MyTestDatabaseSecret",
|
|
1745
|
-
# secret_string: "{\"username\":\"david\",\"password\":\"
|
|
1807
|
+
# secret_string: "{\"username\":\"david\",\"password\":\"EXAMPLE-PASSWORD\"}",
|
|
1746
1808
|
# })
|
|
1747
1809
|
#
|
|
1748
1810
|
# resp.to_h outputs the following:
|
|
@@ -1792,7 +1854,7 @@ module Aws::SecretsManager
|
|
|
1792
1854
|
#
|
|
1793
1855
|
#
|
|
1794
1856
|
#
|
|
1795
|
-
# [1]: https://docs.aws.amazon.com/
|
|
1857
|
+
# [1]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions
|
|
1796
1858
|
# [2]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html
|
|
1797
1859
|
#
|
|
1798
1860
|
# @option params [required, String] :secret_id
|
|
@@ -1842,7 +1904,7 @@ module Aws::SecretsManager
|
|
|
1842
1904
|
#
|
|
1843
1905
|
#
|
|
1844
1906
|
# [1]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/create-manage-multi-region-secrets.html
|
|
1845
|
-
# [2]: https://docs.aws.amazon.com/
|
|
1907
|
+
# [2]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions
|
|
1846
1908
|
# [3]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html
|
|
1847
1909
|
#
|
|
1848
1910
|
# @option params [required, String] :secret_id
|
|
@@ -1902,14 +1964,18 @@ module Aws::SecretsManager
|
|
|
1902
1964
|
#
|
|
1903
1965
|
#
|
|
1904
1966
|
#
|
|
1905
|
-
# [1]: https://docs.aws.amazon.com/
|
|
1967
|
+
# [1]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions
|
|
1906
1968
|
# [2]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html
|
|
1907
1969
|
#
|
|
1908
1970
|
# @option params [required, String] :secret_id
|
|
1909
1971
|
# The ARN or name of the secret to restore.
|
|
1910
1972
|
#
|
|
1911
1973
|
# For an ARN, we recommend that you specify a complete ARN rather than a
|
|
1912
|
-
# partial ARN.
|
|
1974
|
+
# partial ARN. See [Finding a secret from a partial ARN][1].
|
|
1975
|
+
#
|
|
1976
|
+
#
|
|
1977
|
+
#
|
|
1978
|
+
# [1]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot.html#ARN_secretnamehyphen
|
|
1913
1979
|
#
|
|
1914
1980
|
# @return [Types::RestoreSecretResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
1915
1981
|
#
|
|
@@ -1952,49 +2018,65 @@ module Aws::SecretsManager
|
|
|
1952
2018
|
end
|
|
1953
2019
|
|
|
1954
2020
|
# Configures and starts the asynchronous process of rotating the secret.
|
|
2021
|
+
# For more information about rotation, see [Rotate secrets][1].
|
|
1955
2022
|
#
|
|
1956
2023
|
# If you include the configuration parameters, the operation sets the
|
|
1957
2024
|
# values for the secret and then immediately starts a rotation. If you
|
|
1958
2025
|
# don't include the configuration parameters, the operation starts a
|
|
1959
|
-
# rotation with the values already stored in the secret.
|
|
1960
|
-
#
|
|
2026
|
+
# rotation with the values already stored in the secret.
|
|
2027
|
+
#
|
|
2028
|
+
# For database credentials you want to rotate, for Secrets Manager to be
|
|
2029
|
+
# able to rotate the secret, you must make sure the secret value is in
|
|
2030
|
+
# the [ JSON structure of a database secret][2]. In particular, if you
|
|
2031
|
+
# want to use the [ alternating users strategy][3], your secret must
|
|
2032
|
+
# contain the ARN of a superuser secret.
|
|
1961
2033
|
#
|
|
1962
|
-
# To configure rotation, you
|
|
2034
|
+
# To configure rotation, you also need the ARN of an Amazon Web Services
|
|
1963
2035
|
# Lambda function and the schedule for the rotation. The Lambda rotation
|
|
1964
2036
|
# function creates a new version of the secret and creates or updates
|
|
1965
2037
|
# the credentials on the database or service to match. After testing the
|
|
1966
2038
|
# new credentials, the function marks the new secret version with the
|
|
1967
2039
|
# staging label `AWSCURRENT`. Then anyone who retrieves the secret gets
|
|
1968
|
-
# the new version. For more information, see [How rotation works][
|
|
2040
|
+
# the new version. For more information, see [How rotation works][4].
|
|
2041
|
+
#
|
|
2042
|
+
# You can create the Lambda rotation function based on the [rotation
|
|
2043
|
+
# function templates][5] that Secrets Manager provides. Choose a
|
|
2044
|
+
# template that matches your [Rotation strategy][6].
|
|
1969
2045
|
#
|
|
1970
2046
|
# When rotation is successful, the `AWSPENDING` staging label might be
|
|
1971
2047
|
# attached to the same version as the `AWSCURRENT` version, or it might
|
|
1972
|
-
# not be attached to any version.
|
|
1973
|
-
#
|
|
1974
|
-
#
|
|
1975
|
-
#
|
|
1976
|
-
# `RotateSecret` assumes that a previous rotation request is still in
|
|
1977
|
-
# progress and returns an error.
|
|
2048
|
+
# not be attached to any version. If the `AWSPENDING` staging label is
|
|
2049
|
+
# present but not attached to the same version as `AWSCURRENT`, then any
|
|
2050
|
+
# later invocation of `RotateSecret` assumes that a previous rotation
|
|
2051
|
+
# request is still in progress and returns an error.
|
|
1978
2052
|
#
|
|
1979
2053
|
# <b>Required permissions: </b> `secretsmanager:RotateSecret`. For more
|
|
1980
|
-
# information, see [ IAM policy actions for Secrets Manager][
|
|
1981
|
-
# [Authentication and access control in Secrets Manager][
|
|
2054
|
+
# information, see [ IAM policy actions for Secrets Manager][7] and
|
|
2055
|
+
# [Authentication and access control in Secrets Manager][8]. You also
|
|
1982
2056
|
# need `lambda:InvokeFunction` permissions on the rotation function. For
|
|
1983
|
-
# more information, see [ Permissions for rotation][
|
|
2057
|
+
# more information, see [ Permissions for rotation][9].
|
|
1984
2058
|
#
|
|
1985
2059
|
#
|
|
1986
2060
|
#
|
|
1987
2061
|
# [1]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/rotating-secrets.html
|
|
1988
|
-
# [2]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/
|
|
1989
|
-
# [3]: https://docs.aws.amazon.com/
|
|
1990
|
-
# [4]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/
|
|
1991
|
-
# [5]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/
|
|
2062
|
+
# [2]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_secret_json_structure.html
|
|
2063
|
+
# [3]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/rotating-secrets_strategies.html#rotating-secrets-two-users
|
|
2064
|
+
# [4]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/rotate-secrets_how.html
|
|
2065
|
+
# [5]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_available-rotation-templates.html
|
|
2066
|
+
# [6]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/rotating-secrets_strategies.html
|
|
2067
|
+
# [7]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions
|
|
2068
|
+
# [8]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html
|
|
2069
|
+
# [9]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/rotating-secrets-required-permissions-function.html
|
|
1992
2070
|
#
|
|
1993
2071
|
# @option params [required, String] :secret_id
|
|
1994
2072
|
# The ARN or name of the secret to rotate.
|
|
1995
2073
|
#
|
|
1996
2074
|
# For an ARN, we recommend that you specify a complete ARN rather than a
|
|
1997
|
-
# partial ARN.
|
|
2075
|
+
# partial ARN. See [Finding a secret from a partial ARN][1].
|
|
2076
|
+
#
|
|
2077
|
+
#
|
|
2078
|
+
#
|
|
2079
|
+
# [1]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot.html#ARN_secretnamehyphen
|
|
1998
2080
|
#
|
|
1999
2081
|
# @option params [String] :client_request_token
|
|
2000
2082
|
# A unique identifier for the new version of the secret that helps
|
|
@@ -2052,6 +2134,45 @@ module Aws::SecretsManager
|
|
|
2052
2134
|
# * {Types::RotateSecretResponse#name #name} => String
|
|
2053
2135
|
# * {Types::RotateSecretResponse#version_id #version_id} => String
|
|
2054
2136
|
#
|
|
2137
|
+
#
|
|
2138
|
+
# @example Example: To configure rotation for a secret
|
|
2139
|
+
#
|
|
2140
|
+
# # The following example configures rotation for a secret using a cron expression. The first rotation happens immediately
|
|
2141
|
+
# # after the changes are stored in the secret. The rotation schedule is the first and 15th day of every month. The rotation
|
|
2142
|
+
# # window begins at 4:00 PM UTC and ends at 6:00 PM.
|
|
2143
|
+
#
|
|
2144
|
+
# resp = client.rotate_secret({
|
|
2145
|
+
# rotation_lambda_arn: "arn:aws:lambda:us-west-2:123456789012:function:MyTestDatabaseRotationLambda",
|
|
2146
|
+
# rotation_rules: {
|
|
2147
|
+
# duration: "2h",
|
|
2148
|
+
# schedule_expression: "cron(0 16 1,15 * ? *)",
|
|
2149
|
+
# },
|
|
2150
|
+
# secret_id: "MyTestDatabaseSecret",
|
|
2151
|
+
# })
|
|
2152
|
+
#
|
|
2153
|
+
# resp.to_h outputs the following:
|
|
2154
|
+
# {
|
|
2155
|
+
# arn: "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-a1b2c3",
|
|
2156
|
+
# name: "MyTestDatabaseSecret",
|
|
2157
|
+
# version_id: "EXAMPLE2-90ab-cdef-fedc-ba987SECRET2",
|
|
2158
|
+
# }
|
|
2159
|
+
#
|
|
2160
|
+
# @example Example: To request an immediate rotation for a secret
|
|
2161
|
+
#
|
|
2162
|
+
# # The following example requests an immediate invocation of the secret's Lambda rotation function. It assumes that the
|
|
2163
|
+
# # specified secret already has rotation configured. The rotation function runs asynchronously in the background.
|
|
2164
|
+
#
|
|
2165
|
+
# resp = client.rotate_secret({
|
|
2166
|
+
# secret_id: "MyTestDatabaseSecret",
|
|
2167
|
+
# })
|
|
2168
|
+
#
|
|
2169
|
+
# resp.to_h outputs the following:
|
|
2170
|
+
# {
|
|
2171
|
+
# arn: "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-a1b2c3",
|
|
2172
|
+
# name: "MyTestDatabaseSecret",
|
|
2173
|
+
# version_id: "EXAMPLE2-90ab-cdef-fedc-ba987SECRET2",
|
|
2174
|
+
# }
|
|
2175
|
+
#
|
|
2055
2176
|
# @example Request syntax with placeholder values
|
|
2056
2177
|
#
|
|
2057
2178
|
# resp = client.rotate_secret({
|
|
@@ -2094,7 +2215,7 @@ module Aws::SecretsManager
|
|
|
2094
2215
|
#
|
|
2095
2216
|
#
|
|
2096
2217
|
#
|
|
2097
|
-
# [1]: https://docs.aws.amazon.com/
|
|
2218
|
+
# [1]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions
|
|
2098
2219
|
# [2]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html
|
|
2099
2220
|
#
|
|
2100
2221
|
# @option params [required, String] :secret_id
|
|
@@ -2160,7 +2281,7 @@ module Aws::SecretsManager
|
|
|
2160
2281
|
#
|
|
2161
2282
|
#
|
|
2162
2283
|
#
|
|
2163
|
-
# [1]: https://docs.aws.amazon.com/
|
|
2284
|
+
# [1]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions
|
|
2164
2285
|
# [2]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html
|
|
2165
2286
|
#
|
|
2166
2287
|
# @option params [required, String] :secret_id
|
|
@@ -2169,7 +2290,11 @@ module Aws::SecretsManager
|
|
|
2169
2290
|
# secret.
|
|
2170
2291
|
#
|
|
2171
2292
|
# For an ARN, we recommend that you specify a complete ARN rather than a
|
|
2172
|
-
# partial ARN.
|
|
2293
|
+
# partial ARN. See [Finding a secret from a partial ARN][1].
|
|
2294
|
+
#
|
|
2295
|
+
#
|
|
2296
|
+
#
|
|
2297
|
+
# [1]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot.html#ARN_secretnamehyphen
|
|
2173
2298
|
#
|
|
2174
2299
|
# @option params [required, Array<Types::Tag>] :tags
|
|
2175
2300
|
# The tags to attach to the secret as a JSON text string argument. Each
|
|
@@ -2243,14 +2368,18 @@ module Aws::SecretsManager
|
|
|
2243
2368
|
#
|
|
2244
2369
|
#
|
|
2245
2370
|
#
|
|
2246
|
-
# [1]: https://docs.aws.amazon.com/
|
|
2371
|
+
# [1]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions
|
|
2247
2372
|
# [2]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html
|
|
2248
2373
|
#
|
|
2249
2374
|
# @option params [required, String] :secret_id
|
|
2250
2375
|
# The ARN or name of the secret.
|
|
2251
2376
|
#
|
|
2252
2377
|
# For an ARN, we recommend that you specify a complete ARN rather than a
|
|
2253
|
-
# partial ARN.
|
|
2378
|
+
# partial ARN. See [Finding a secret from a partial ARN][1].
|
|
2379
|
+
#
|
|
2380
|
+
#
|
|
2381
|
+
#
|
|
2382
|
+
# [1]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot.html#ARN_secretnamehyphen
|
|
2254
2383
|
#
|
|
2255
2384
|
# @option params [required, Array<String>] :tag_keys
|
|
2256
2385
|
# A list of tag key names to remove from the secret. You don't specify
|
|
@@ -2346,7 +2475,7 @@ module Aws::SecretsManager
|
|
|
2346
2475
|
#
|
|
2347
2476
|
#
|
|
2348
2477
|
#
|
|
2349
|
-
# [1]: https://docs.aws.amazon.com/
|
|
2478
|
+
# [1]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions
|
|
2350
2479
|
# [2]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html
|
|
2351
2480
|
# [3]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/security-encryption.html
|
|
2352
2481
|
#
|
|
@@ -2354,7 +2483,11 @@ module Aws::SecretsManager
|
|
|
2354
2483
|
# The ARN or name of the secret.
|
|
2355
2484
|
#
|
|
2356
2485
|
# For an ARN, we recommend that you specify a complete ARN rather than a
|
|
2357
|
-
# partial ARN.
|
|
2486
|
+
# partial ARN. See [Finding a secret from a partial ARN][1].
|
|
2487
|
+
#
|
|
2488
|
+
#
|
|
2489
|
+
#
|
|
2490
|
+
# [1]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot.html#ARN_secretnamehyphen
|
|
2358
2491
|
#
|
|
2359
2492
|
# @option params [String] :client_request_token
|
|
2360
2493
|
# If you include `SecretString` or `SecretBinary`, then Secrets Manager
|
|
@@ -2532,7 +2665,7 @@ module Aws::SecretsManager
|
|
|
2532
2665
|
#
|
|
2533
2666
|
#
|
|
2534
2667
|
# [1]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/getting-started.html#term_version
|
|
2535
|
-
# [2]: https://docs.aws.amazon.com/
|
|
2668
|
+
# [2]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions
|
|
2536
2669
|
# [3]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html
|
|
2537
2670
|
#
|
|
2538
2671
|
# @option params [required, String] :secret_id
|
|
@@ -2540,7 +2673,11 @@ module Aws::SecretsManager
|
|
|
2540
2673
|
# labelsto modify.
|
|
2541
2674
|
#
|
|
2542
2675
|
# For an ARN, we recommend that you specify a complete ARN rather than a
|
|
2543
|
-
# partial ARN.
|
|
2676
|
+
# partial ARN. See [Finding a secret from a partial ARN][1].
|
|
2677
|
+
#
|
|
2678
|
+
#
|
|
2679
|
+
#
|
|
2680
|
+
# [1]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot.html#ARN_secretnamehyphen
|
|
2544
2681
|
#
|
|
2545
2682
|
# @option params [required, String] :version_stage
|
|
2546
2683
|
# The staging label to add to this version.
|
|
@@ -2665,7 +2802,7 @@ module Aws::SecretsManager
|
|
|
2665
2802
|
#
|
|
2666
2803
|
#
|
|
2667
2804
|
# [1]: https://aws.amazon.com/blogs/security/protect-sensitive-data-in-the-cloud-with-automated-reasoning-zelkova/
|
|
2668
|
-
# [2]: https://docs.aws.amazon.com/
|
|
2805
|
+
# [2]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions
|
|
2669
2806
|
# [3]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html
|
|
2670
2807
|
#
|
|
2671
2808
|
# @option params [String] :secret_id
|
|
@@ -2739,7 +2876,7 @@ module Aws::SecretsManager
|
|
|
2739
2876
|
params: params,
|
|
2740
2877
|
config: config)
|
|
2741
2878
|
context[:gem_name] = 'aws-sdk-secretsmanager'
|
|
2742
|
-
context[:gem_version] = '1.
|
|
2879
|
+
context[:gem_version] = '1.61.0'
|
|
2743
2880
|
Seahorse::Client::Request.new(handlers, context)
|
|
2744
2881
|
end
|
|
2745
2882
|
|
|
@@ -21,7 +21,11 @@ module Aws::SecretsManager
|
|
|
21
21
|
# The ARN or name of the secret.
|
|
22
22
|
#
|
|
23
23
|
# For an ARN, we recommend that you specify a complete ARN rather than
|
|
24
|
-
# a partial ARN.
|
|
24
|
+
# a partial ARN. See [Finding a secret from a partial ARN][1].
|
|
25
|
+
#
|
|
26
|
+
#
|
|
27
|
+
#
|
|
28
|
+
# [1]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot.html#ARN_secretnamehyphen
|
|
25
29
|
# @return [String]
|
|
26
30
|
#
|
|
27
31
|
# @see http://docs.aws.amazon.com/goto/WebAPI/secretsmanager-2017-10-17/CancelRotateSecretRequest AWS API Documentation
|
|
@@ -330,7 +334,11 @@ module Aws::SecretsManager
|
|
|
330
334
|
# policy for.
|
|
331
335
|
#
|
|
332
336
|
# For an ARN, we recommend that you specify a complete ARN rather than
|
|
333
|
-
# a partial ARN.
|
|
337
|
+
# a partial ARN. See [Finding a secret from a partial ARN][1].
|
|
338
|
+
#
|
|
339
|
+
#
|
|
340
|
+
#
|
|
341
|
+
# [1]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot.html#ARN_secretnamehyphen
|
|
334
342
|
# @return [String]
|
|
335
343
|
#
|
|
336
344
|
# @see http://docs.aws.amazon.com/goto/WebAPI/secretsmanager-2017-10-17/DeleteResourcePolicyRequest AWS API Documentation
|
|
@@ -373,7 +381,11 @@ module Aws::SecretsManager
|
|
|
373
381
|
# The ARN or name of the secret to delete.
|
|
374
382
|
#
|
|
375
383
|
# For an ARN, we recommend that you specify a complete ARN rather than
|
|
376
|
-
# a partial ARN.
|
|
384
|
+
# a partial ARN. See [Finding a secret from a partial ARN][1].
|
|
385
|
+
#
|
|
386
|
+
#
|
|
387
|
+
#
|
|
388
|
+
# [1]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot.html#ARN_secretnamehyphen
|
|
377
389
|
# @return [String]
|
|
378
390
|
#
|
|
379
391
|
# @!attribute [rw] recovery_window_in_days
|
|
@@ -449,7 +461,11 @@ module Aws::SecretsManager
|
|
|
449
461
|
# The ARN or name of the secret.
|
|
450
462
|
#
|
|
451
463
|
# For an ARN, we recommend that you specify a complete ARN rather than
|
|
452
|
-
# a partial ARN.
|
|
464
|
+
# a partial ARN. See [Finding a secret from a partial ARN][1].
|
|
465
|
+
#
|
|
466
|
+
#
|
|
467
|
+
#
|
|
468
|
+
# [1]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot.html#ARN_secretnamehyphen
|
|
453
469
|
# @return [String]
|
|
454
470
|
#
|
|
455
471
|
# @see http://docs.aws.amazon.com/goto/WebAPI/secretsmanager-2017-10-17/DescribeSecretRequest AWS API Documentation
|
|
@@ -775,7 +791,11 @@ module Aws::SecretsManager
|
|
|
775
791
|
# resource-based policy for.
|
|
776
792
|
#
|
|
777
793
|
# For an ARN, we recommend that you specify a complete ARN rather than
|
|
778
|
-
# a partial ARN.
|
|
794
|
+
# a partial ARN. See [Finding a secret from a partial ARN][1].
|
|
795
|
+
#
|
|
796
|
+
#
|
|
797
|
+
#
|
|
798
|
+
# [1]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot.html#ARN_secretnamehyphen
|
|
779
799
|
# @return [String]
|
|
780
800
|
#
|
|
781
801
|
# @see http://docs.aws.amazon.com/goto/WebAPI/secretsmanager-2017-10-17/GetResourcePolicyRequest AWS API Documentation
|
|
@@ -830,7 +850,11 @@ module Aws::SecretsManager
|
|
|
830
850
|
# The ARN or name of the secret to retrieve.
|
|
831
851
|
#
|
|
832
852
|
# For an ARN, we recommend that you specify a complete ARN rather than
|
|
833
|
-
# a partial ARN.
|
|
853
|
+
# a partial ARN. See [Finding a secret from a partial ARN][1].
|
|
854
|
+
#
|
|
855
|
+
#
|
|
856
|
+
#
|
|
857
|
+
# [1]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot.html#ARN_secretnamehyphen
|
|
834
858
|
# @return [String]
|
|
835
859
|
#
|
|
836
860
|
# @!attribute [rw] version_id
|
|
@@ -1018,7 +1042,11 @@ module Aws::SecretsManager
|
|
|
1018
1042
|
# The ARN or name of the secret whose versions you want to list.
|
|
1019
1043
|
#
|
|
1020
1044
|
# For an ARN, we recommend that you specify a complete ARN rather than
|
|
1021
|
-
# a partial ARN.
|
|
1045
|
+
# a partial ARN. See [Finding a secret from a partial ARN][1].
|
|
1046
|
+
#
|
|
1047
|
+
#
|
|
1048
|
+
#
|
|
1049
|
+
# [1]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot.html#ARN_secretnamehyphen
|
|
1022
1050
|
# @return [String]
|
|
1023
1051
|
#
|
|
1024
1052
|
# @!attribute [rw] max_results
|
|
@@ -1207,7 +1235,11 @@ module Aws::SecretsManager
|
|
|
1207
1235
|
# The ARN or name of the secret to attach the resource-based policy.
|
|
1208
1236
|
#
|
|
1209
1237
|
# For an ARN, we recommend that you specify a complete ARN rather than
|
|
1210
|
-
# a partial ARN.
|
|
1238
|
+
# a partial ARN. See [Finding a secret from a partial ARN][1].
|
|
1239
|
+
#
|
|
1240
|
+
#
|
|
1241
|
+
#
|
|
1242
|
+
# [1]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot.html#ARN_secretnamehyphen
|
|
1211
1243
|
# @return [String]
|
|
1212
1244
|
#
|
|
1213
1245
|
# @!attribute [rw] resource_policy
|
|
@@ -1268,9 +1300,13 @@ module Aws::SecretsManager
|
|
|
1268
1300
|
# The ARN or name of the secret to add a new version to.
|
|
1269
1301
|
#
|
|
1270
1302
|
# For an ARN, we recommend that you specify a complete ARN rather than
|
|
1271
|
-
# a partial ARN.
|
|
1303
|
+
# a partial ARN. See [Finding a secret from a partial ARN][1].
|
|
1272
1304
|
#
|
|
1273
1305
|
# If the secret doesn't already exist, use `CreateSecret` instead.
|
|
1306
|
+
#
|
|
1307
|
+
#
|
|
1308
|
+
#
|
|
1309
|
+
# [1]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot.html#ARN_secretnamehyphen
|
|
1274
1310
|
# @return [String]
|
|
1275
1311
|
#
|
|
1276
1312
|
# @!attribute [rw] client_request_token
|
|
@@ -1597,7 +1633,11 @@ module Aws::SecretsManager
|
|
|
1597
1633
|
# The ARN or name of the secret to restore.
|
|
1598
1634
|
#
|
|
1599
1635
|
# For an ARN, we recommend that you specify a complete ARN rather than
|
|
1600
|
-
# a partial ARN.
|
|
1636
|
+
# a partial ARN. See [Finding a secret from a partial ARN][1].
|
|
1637
|
+
#
|
|
1638
|
+
#
|
|
1639
|
+
#
|
|
1640
|
+
# [1]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot.html#ARN_secretnamehyphen
|
|
1601
1641
|
# @return [String]
|
|
1602
1642
|
#
|
|
1603
1643
|
# @see http://docs.aws.amazon.com/goto/WebAPI/secretsmanager-2017-10-17/RestoreSecretRequest AWS API Documentation
|
|
@@ -1644,7 +1684,11 @@ module Aws::SecretsManager
|
|
|
1644
1684
|
# The ARN or name of the secret to rotate.
|
|
1645
1685
|
#
|
|
1646
1686
|
# For an ARN, we recommend that you specify a complete ARN rather than
|
|
1647
|
-
# a partial ARN.
|
|
1687
|
+
# a partial ARN. See [Finding a secret from a partial ARN][1].
|
|
1688
|
+
#
|
|
1689
|
+
#
|
|
1690
|
+
#
|
|
1691
|
+
# [1]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot.html#ARN_secretnamehyphen
|
|
1648
1692
|
# @return [String]
|
|
1649
1693
|
#
|
|
1650
1694
|
# @!attribute [rw] client_request_token
|
|
@@ -2060,7 +2104,11 @@ module Aws::SecretsManager
|
|
|
2060
2104
|
# secret.
|
|
2061
2105
|
#
|
|
2062
2106
|
# For an ARN, we recommend that you specify a complete ARN rather than
|
|
2063
|
-
# a partial ARN.
|
|
2107
|
+
# a partial ARN. See [Finding a secret from a partial ARN][1].
|
|
2108
|
+
#
|
|
2109
|
+
#
|
|
2110
|
+
#
|
|
2111
|
+
# [1]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot.html#ARN_secretnamehyphen
|
|
2064
2112
|
# @return [String]
|
|
2065
2113
|
#
|
|
2066
2114
|
# @!attribute [rw] tags
|
|
@@ -2098,7 +2146,11 @@ module Aws::SecretsManager
|
|
|
2098
2146
|
# The ARN or name of the secret.
|
|
2099
2147
|
#
|
|
2100
2148
|
# For an ARN, we recommend that you specify a complete ARN rather than
|
|
2101
|
-
# a partial ARN.
|
|
2149
|
+
# a partial ARN. See [Finding a secret from a partial ARN][1].
|
|
2150
|
+
#
|
|
2151
|
+
#
|
|
2152
|
+
#
|
|
2153
|
+
# [1]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot.html#ARN_secretnamehyphen
|
|
2102
2154
|
# @return [String]
|
|
2103
2155
|
#
|
|
2104
2156
|
# @!attribute [rw] tag_keys
|
|
@@ -2143,7 +2195,11 @@ module Aws::SecretsManager
|
|
|
2143
2195
|
# The ARN or name of the secret.
|
|
2144
2196
|
#
|
|
2145
2197
|
# For an ARN, we recommend that you specify a complete ARN rather than
|
|
2146
|
-
# a partial ARN.
|
|
2198
|
+
# a partial ARN. See [Finding a secret from a partial ARN][1].
|
|
2199
|
+
#
|
|
2200
|
+
#
|
|
2201
|
+
#
|
|
2202
|
+
# [1]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot.html#ARN_secretnamehyphen
|
|
2147
2203
|
# @return [String]
|
|
2148
2204
|
#
|
|
2149
2205
|
# @!attribute [rw] client_request_token
|
|
@@ -2264,7 +2320,11 @@ module Aws::SecretsManager
|
|
|
2264
2320
|
# labelsto modify.
|
|
2265
2321
|
#
|
|
2266
2322
|
# For an ARN, we recommend that you specify a complete ARN rather than
|
|
2267
|
-
# a partial ARN.
|
|
2323
|
+
# a partial ARN. See [Finding a secret from a partial ARN][1].
|
|
2324
|
+
#
|
|
2325
|
+
#
|
|
2326
|
+
#
|
|
2327
|
+
# [1]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot.html#ARN_secretnamehyphen
|
|
2268
2328
|
# @return [String]
|
|
2269
2329
|
#
|
|
2270
2330
|
# @!attribute [rw] version_stage
|
metadata
CHANGED
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: aws-sdk-secretsmanager
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 1.
|
|
4
|
+
version: 1.61.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: 2022-
|
|
11
|
+
date: 2022-05-11 00:00:00.000000000 Z
|
|
12
12
|
dependencies:
|
|
13
13
|
- !ruby/object:Gem::Dependency
|
|
14
14
|
name: aws-sdk-core
|