aws-sdk-secretsmanager 1.45.0 → 1.49.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 +258 -0
- data/LICENSE.txt +202 -0
- data/VERSION +1 -0
- data/lib/aws-sdk-secretsmanager/client.rb +189 -170
- data/lib/aws-sdk-secretsmanager/client_api.rb +8 -1
- data/lib/aws-sdk-secretsmanager/errors.rb +1 -1
- data/lib/aws-sdk-secretsmanager/resource.rb +1 -1
- data/lib/aws-sdk-secretsmanager/types.rb +102 -90
- data/lib/aws-sdk-secretsmanager.rb +2 -2
- metadata +12 -10
data/VERSION
ADDED
@@ -0,0 +1 @@
|
|
1
|
+
1.49.0
|
@@ -3,7 +3,7 @@
|
|
3
3
|
# WARNING ABOUT GENERATED CODE
|
4
4
|
#
|
5
5
|
# This file is generated. See the contributing guide for more information:
|
6
|
-
# https://github.com/aws/aws-sdk-ruby/blob/
|
6
|
+
# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
|
7
7
|
#
|
8
8
|
# WARNING ABOUT GENERATED CODE
|
9
9
|
|
@@ -479,25 +479,27 @@ module Aws::SecretsManager
|
|
479
479
|
#
|
480
480
|
# <note markdown="1"> * If you call an operation to encrypt or decrypt the `SecretString` or
|
481
481
|
# `SecretBinary` for a secret in the same account as the calling user
|
482
|
-
# and that secret doesn't specify a
|
483
|
-
# Manager uses the account's default
|
484
|
-
# (CMK) with the alias
|
485
|
-
#
|
486
|
-
#
|
482
|
+
# and that secret doesn't specify a Amazon Web Services KMS
|
483
|
+
# encryption key, Secrets Manager uses the account's default Amazon
|
484
|
+
# Web Services managed customer master key (CMK) with the alias
|
485
|
+
# `aws/secretsmanager`. If this key doesn't already exist in your
|
486
|
+
# account then Secrets Manager creates it for you automatically. All
|
487
|
+
# users and roles in the same Amazon Web Services account
|
487
488
|
# automatically have access to use the default CMK. Note that if an
|
488
|
-
# Secrets Manager API call results in
|
489
|
-
#
|
490
|
-
# returning the result.
|
491
|
-
#
|
492
|
-
# * If the secret resides in a different
|
493
|
-
# credentials calling an API that requires encryption or
|
494
|
-
# the secret value then you must create and use a custom
|
495
|
-
# because you can't access the default
|
496
|
-
#
|
497
|
-
#
|
498
|
-
#
|
499
|
-
#
|
500
|
-
#
|
489
|
+
# Secrets Manager API call results in Amazon Web Services creating the
|
490
|
+
# account's Amazon Web Services-managed CMK, it can result in a
|
491
|
+
# one-time significant delay in returning the result.
|
492
|
+
#
|
493
|
+
# * If the secret resides in a different Amazon Web Services account
|
494
|
+
# from the credentials calling an API that requires encryption or
|
495
|
+
# decryption of the secret value then you must create and use a custom
|
496
|
+
# Amazon Web Services KMS CMK because you can't access the default
|
497
|
+
# CMK for the account using credentials from a different Amazon Web
|
498
|
+
# Services account. Store the ARN of the CMK in the secret when you
|
499
|
+
# create the secret or when you update it by including it in the
|
500
|
+
# `KMSKeyId`. If you call an API that must encrypt or decrypt
|
501
|
+
# `SecretString` or `SecretBinary` using credentials from a different
|
502
|
+
# account then the Amazon Web Services KMS key policy must grant
|
501
503
|
# cross-account access to that other account's user or role for both
|
502
504
|
# the kms:GenerateDataKey and kms:Decrypt operations.
|
503
505
|
#
|
@@ -511,13 +513,15 @@ module Aws::SecretsManager
|
|
511
513
|
#
|
512
514
|
# * secretsmanager:CreateSecret
|
513
515
|
#
|
514
|
-
# * kms:GenerateDataKey - needed only if you use a customer-managed
|
515
|
-
# KMS key to encrypt the secret. You do not need
|
516
|
-
# use the account default
|
516
|
+
# * kms:GenerateDataKey - needed only if you use a customer-managed
|
517
|
+
# Amazon Web Services KMS key to encrypt the secret. You do not need
|
518
|
+
# this permission to use the account default Amazon Web Services
|
519
|
+
# managed CMK for Secrets Manager.
|
517
520
|
#
|
518
|
-
# * kms:Decrypt - needed only if you use a customer-managed
|
519
|
-
# to encrypt the secret. You do not need this
|
520
|
-
# account default
|
521
|
+
# * kms:Decrypt - needed only if you use a customer-managed Amazon Web
|
522
|
+
# Services KMS key to encrypt the secret. You do not need this
|
523
|
+
# permission to use the account default Amazon Web Services managed
|
524
|
+
# CMK for Secrets Manager.
|
521
525
|
#
|
522
526
|
# * secretsmanager:TagResource - needed only if you include the `Tags`
|
523
527
|
# parameter.
|
@@ -559,13 +563,13 @@ module Aws::SecretsManager
|
|
559
563
|
# initial version is created as part of the secret, and this parameter
|
560
564
|
# specifies a unique identifier for the new version.
|
561
565
|
#
|
562
|
-
# <note markdown="1"> If you use the
|
563
|
-
#
|
564
|
-
# random UUID for you and includes it
|
565
|
-
# the request. If you don't use the
|
566
|
-
# request to the Secrets Manager
|
567
|
-
# generate a `ClientRequestToken`
|
568
|
-
# include the value in the request.
|
566
|
+
# <note markdown="1"> If you use the Amazon Web Services CLI or one of the Amazon Web
|
567
|
+
# Services SDK to call this operation, then you can leave this parameter
|
568
|
+
# empty. The CLI or SDK generates a random UUID for you and includes it
|
569
|
+
# as the value for this parameter in the request. If you don't use the
|
570
|
+
# SDK and instead generate a raw HTTP request to the Secrets Manager
|
571
|
+
# service endpoint, then you must generate a `ClientRequestToken`
|
572
|
+
# yourself for the new version and include the value in the request.
|
569
573
|
#
|
570
574
|
# </note>
|
571
575
|
#
|
@@ -601,20 +605,21 @@ module Aws::SecretsManager
|
|
601
605
|
# (Optional) Specifies a user-provided description of the secret.
|
602
606
|
#
|
603
607
|
# @option params [String] :kms_key_id
|
604
|
-
# (Optional) Specifies the ARN, Key ID, or alias of the
|
605
|
-
# master key (CMK) to be used to encrypt the
|
606
|
-
# `SecretBinary` values in the versions stored in this
|
608
|
+
# (Optional) Specifies the ARN, Key ID, or alias of the Amazon Web
|
609
|
+
# Services KMS customer master key (CMK) to be used to encrypt the
|
610
|
+
# `SecretString` or `SecretBinary` values in the versions stored in this
|
611
|
+
# secret.
|
607
612
|
#
|
608
|
-
# You can specify any of the supported ways to identify a
|
609
|
-
# ID. If you need to reference a CMK in a different
|
610
|
-
# only the key ARN or the alias ARN.
|
613
|
+
# You can specify any of the supported ways to identify a Amazon Web
|
614
|
+
# Services KMS key ID. If you need to reference a CMK in a different
|
615
|
+
# account, you can use only the key ARN or the alias ARN.
|
611
616
|
#
|
612
617
|
# If you don't specify this value, then Secrets Manager defaults to
|
613
|
-
# using the
|
614
|
-
# `aws/secretsmanager`). If a
|
615
|
-
# exist, then Secrets Manager creates it for you
|
616
|
-
# time it needs to encrypt a version's
|
617
|
-
# fields.
|
618
|
+
# using the Amazon Web Services account's default CMK (the one named
|
619
|
+
# `aws/secretsmanager`). If a Amazon Web Services KMS CMK with that name
|
620
|
+
# doesn't yet exist, then Secrets Manager creates it for you
|
621
|
+
# automatically the first time it needs to encrypt a version's
|
622
|
+
# `SecretString` or `SecretBinary` fields.
|
618
623
|
#
|
619
624
|
# You can use the account default CMK to encrypt and decrypt only if you
|
620
625
|
# call this operation using credentials from the same account that owns
|
@@ -632,7 +637,8 @@ module Aws::SecretsManager
|
|
632
637
|
# both. They cannot both be empty.
|
633
638
|
#
|
634
639
|
# This parameter is not available using the Secrets Manager console. It
|
635
|
-
# can be accessed only by using the
|
640
|
+
# can be accessed only by using the Amazon Web Services CLI or one of
|
641
|
+
# the Amazon Web Services SDKs.
|
636
642
|
#
|
637
643
|
# @option params [String] :secret_string
|
638
644
|
# (Optional) Specifies text data that you want to encrypt and store in
|
@@ -650,7 +656,7 @@ module Aws::SecretsManager
|
|
650
656
|
# For storing multiple values, we recommend that you use a JSON text
|
651
657
|
# string argument and specify key/value pairs. For information on how to
|
652
658
|
# format a JSON parameter for the various command line tool
|
653
|
-
# environments, see [Using JSON for Parameters][1] in the *
|
659
|
+
# environments, see [Using JSON for Parameters][1] in the *CLI User
|
654
660
|
# Guide*. For example:
|
655
661
|
#
|
656
662
|
# `\{"username":"bob","password":"abc123xyz456"\}`
|
@@ -680,7 +686,7 @@ module Aws::SecretsManager
|
|
680
686
|
#
|
681
687
|
# This parameter requires a JSON text string argument. For information
|
682
688
|
# on how to format a JSON parameter for the various command line tool
|
683
|
-
# environments, see [Using JSON for Parameters][1] in the *
|
689
|
+
# environments, see [Using JSON for Parameters][1] in the *CLI User
|
684
690
|
# Guide*. For example:
|
685
691
|
#
|
686
692
|
# `[\{"Key":"CostCenter","Value":"12345"\},\{"Key":"environment","Value":"production"\}]`
|
@@ -699,10 +705,10 @@ module Aws::SecretsManager
|
|
699
705
|
#
|
700
706
|
# * Tag keys and values are case sensitive.
|
701
707
|
#
|
702
|
-
# * Do not use the `aws:` prefix in your tag names or values because
|
703
|
-
# reserves it for
|
704
|
-
#
|
705
|
-
# your tags per secret limit.
|
708
|
+
# * Do not use the `aws:` prefix in your tag names or values because
|
709
|
+
# Amazon Web Services reserves it for Amazon Web Services use. You
|
710
|
+
# can't edit or delete tag names or values with this prefix. Tags
|
711
|
+
# with this prefix do not count against your tags per secret limit.
|
706
712
|
#
|
707
713
|
# * If you use your tagging schema across multiple services and
|
708
714
|
# resources, remember other services might have restrictions on
|
@@ -970,10 +976,10 @@ module Aws::SecretsManager
|
|
970
976
|
#
|
971
977
|
# Use this parameter with caution. This parameter causes the operation
|
972
978
|
# to skip the normal waiting period before the permanent deletion that
|
973
|
-
#
|
974
|
-
# If you delete a secret with the
|
975
|
-
# then you have no opportunity to
|
976
|
-
# secret permanently.
|
979
|
+
# Amazon Web Services would normally impose with the
|
980
|
+
# `RecoveryWindowInDays` parameter. If you delete a secret with the
|
981
|
+
# `ForceDeleteWithouRecovery` parameter, then you have no opportunity to
|
982
|
+
# recover the secret. You lose the secret permanently.
|
977
983
|
#
|
978
984
|
# If you use this parameter and include a previously deleted or
|
979
985
|
# nonexistent secret, the operation does not return the error
|
@@ -1048,7 +1054,8 @@ module Aws::SecretsManager
|
|
1048
1054
|
# * To retrieve the encrypted secret information in a version of the
|
1049
1055
|
# secret, use GetSecretValue.
|
1050
1056
|
#
|
1051
|
-
# * To list all of the secrets in the
|
1057
|
+
# * To list all of the secrets in the Amazon Web Services account, use
|
1058
|
+
# ListSecrets.
|
1052
1059
|
#
|
1053
1060
|
# @option params [required, String] :secret_id
|
1054
1061
|
# The identifier of the secret whose details you want to retrieve. You
|
@@ -1392,9 +1399,10 @@ module Aws::SecretsManager
|
|
1392
1399
|
#
|
1393
1400
|
# * secretsmanager:GetSecretValue
|
1394
1401
|
#
|
1395
|
-
# * kms:Decrypt - required only if you use a customer-managed
|
1396
|
-
# key to encrypt the secret. You do not need this
|
1397
|
-
# the account's default
|
1402
|
+
# * kms:Decrypt - required only if you use a customer-managed Amazon Web
|
1403
|
+
# Services KMS key to encrypt the secret. You do not need this
|
1404
|
+
# permission to use the account's default Amazon Web Services managed
|
1405
|
+
# CMK for Secrets Manager.
|
1398
1406
|
#
|
1399
1407
|
# **Related operations**
|
1400
1408
|
#
|
@@ -1660,6 +1668,8 @@ module Aws::SecretsManager
|
|
1660
1668
|
# resp.versions[0].version_stages[0] #=> String
|
1661
1669
|
# resp.versions[0].last_accessed_date #=> Time
|
1662
1670
|
# resp.versions[0].created_date #=> Time
|
1671
|
+
# resp.versions[0].kms_key_ids #=> Array
|
1672
|
+
# resp.versions[0].kms_key_ids[0] #=> String
|
1663
1673
|
# resp.next_token #=> String
|
1664
1674
|
# resp.arn #=> String
|
1665
1675
|
# resp.name #=> String
|
@@ -1673,11 +1683,11 @@ module Aws::SecretsManager
|
|
1673
1683
|
req.send_request(options)
|
1674
1684
|
end
|
1675
1685
|
|
1676
|
-
# Lists all of the secrets that are stored by Secrets Manager in the
|
1677
|
-
# account. To list the versions currently stored for
|
1678
|
-
# use ListSecretVersionIds. The encrypted fields
|
1679
|
-
# `SecretBinary` are not included in the output. To
|
1680
|
-
# information, call the GetSecretValue operation.
|
1686
|
+
# Lists all of the secrets that are stored by Secrets Manager in the
|
1687
|
+
# Amazon Web Services account. To list the versions currently stored for
|
1688
|
+
# a specific secret, use ListSecretVersionIds. The encrypted fields
|
1689
|
+
# `SecretString` and `SecretBinary` are not included in the output. To
|
1690
|
+
# get that information, call the GetSecretValue operation.
|
1681
1691
|
#
|
1682
1692
|
# <note markdown="1"> Always check the `NextToken` response parameter when calling any of
|
1683
1693
|
# the `List*` operations. These operations can occasionally return an
|
@@ -1826,9 +1836,9 @@ module Aws::SecretsManager
|
|
1826
1836
|
# identity-based and resource-based policies. The affected users and
|
1827
1837
|
# roles receive the permissions that are permitted by all of the
|
1828
1838
|
# relevant policies. For more information, see [Using Resource-Based
|
1829
|
-
# Policies for
|
1830
|
-
# the
|
1831
|
-
# in the *IAM User Guide*.
|
1839
|
+
# Policies for Amazon Web Services Secrets Manager][1]. For the complete
|
1840
|
+
# description of the Amazon Web Services policy syntax and grammar, see
|
1841
|
+
# [IAM JSON Policy Reference][2] in the *IAM User Guide*.
|
1832
1842
|
#
|
1833
1843
|
# **Minimum permissions**
|
1834
1844
|
#
|
@@ -1881,11 +1891,11 @@ module Aws::SecretsManager
|
|
1881
1891
|
#
|
1882
1892
|
# @option params [required, String] :resource_policy
|
1883
1893
|
# A JSON-formatted string constructed according to the grammar and
|
1884
|
-
# syntax for an
|
1885
|
-
# identifies who can access or manage this secret and its
|
1886
|
-
# information on how to format a JSON parameter for the
|
1887
|
-
# line tool environments, see [Using JSON for
|
1888
|
-
# CLI User Guide*.
|
1894
|
+
# syntax for an Amazon Web Services resource-based policy. The policy in
|
1895
|
+
# the string identifies who can access or manage this secret and its
|
1896
|
+
# versions. For information on how to format a JSON parameter for the
|
1897
|
+
# various command line tool environments, see [Using JSON for
|
1898
|
+
# Parameters][1] in the *CLI User Guide*.
|
1889
1899
|
#
|
1890
1900
|
#
|
1891
1901
|
#
|
@@ -1947,7 +1957,7 @@ module Aws::SecretsManager
|
|
1947
1957
|
#
|
1948
1958
|
# <note markdown="1"> The Secrets Manager console uses only the `SecretString` field. To add
|
1949
1959
|
# binary data to a secret with the `SecretBinary` field you must use the
|
1950
|
-
#
|
1960
|
+
# Amazon Web Services CLI or one of the Amazon Web Services SDKs.
|
1951
1961
|
#
|
1952
1962
|
# </note>
|
1953
1963
|
#
|
@@ -1973,25 +1983,27 @@ module Aws::SecretsManager
|
|
1973
1983
|
#
|
1974
1984
|
# <note markdown="1"> * If you call an operation to encrypt or decrypt the `SecretString` or
|
1975
1985
|
# `SecretBinary` for a secret in the same account as the calling user
|
1976
|
-
# and that secret doesn't specify a
|
1977
|
-
# Manager uses the account's default
|
1978
|
-
# (CMK) with the alias
|
1979
|
-
#
|
1980
|
-
#
|
1986
|
+
# and that secret doesn't specify a Amazon Web Services KMS
|
1987
|
+
# encryption key, Secrets Manager uses the account's default Amazon
|
1988
|
+
# Web Services managed customer master key (CMK) with the alias
|
1989
|
+
# `aws/secretsmanager`. If this key doesn't already exist in your
|
1990
|
+
# account then Secrets Manager creates it for you automatically. All
|
1991
|
+
# users and roles in the same Amazon Web Services account
|
1981
1992
|
# automatically have access to use the default CMK. Note that if an
|
1982
|
-
# Secrets Manager API call results in
|
1983
|
-
#
|
1984
|
-
# returning the result.
|
1985
|
-
#
|
1986
|
-
# * If the secret resides in a different
|
1987
|
-
# credentials calling an API that requires encryption or
|
1988
|
-
# the secret value then you must create and use a custom
|
1989
|
-
# because you can't access the default
|
1990
|
-
#
|
1991
|
-
#
|
1992
|
-
#
|
1993
|
-
#
|
1994
|
-
#
|
1993
|
+
# Secrets Manager API call results in Amazon Web Services creating the
|
1994
|
+
# account's Amazon Web Services-managed CMK, it can result in a
|
1995
|
+
# one-time significant delay in returning the result.
|
1996
|
+
#
|
1997
|
+
# * If the secret resides in a different Amazon Web Services account
|
1998
|
+
# from the credentials calling an API that requires encryption or
|
1999
|
+
# decryption of the secret value then you must create and use a custom
|
2000
|
+
# Amazon Web Services KMS CMK because you can't access the default
|
2001
|
+
# CMK for the account using credentials from a different Amazon Web
|
2002
|
+
# Services account. Store the ARN of the CMK in the secret when you
|
2003
|
+
# create the secret or when you update it by including it in the
|
2004
|
+
# `KMSKeyId`. If you call an API that must encrypt or decrypt
|
2005
|
+
# `SecretString` or `SecretBinary` using credentials from a different
|
2006
|
+
# account then the Amazon Web Services KMS key policy must grant
|
1995
2007
|
# cross-account access to that other account's user or role for both
|
1996
2008
|
# the kms:GenerateDataKey and kms:Decrypt operations.
|
1997
2009
|
#
|
@@ -2003,9 +2015,10 @@ module Aws::SecretsManager
|
|
2003
2015
|
#
|
2004
2016
|
# * secretsmanager:PutSecretValue
|
2005
2017
|
#
|
2006
|
-
# * kms:GenerateDataKey - needed only if you use a customer-managed
|
2007
|
-
# KMS key to encrypt the secret. You do not need
|
2008
|
-
# use the account's default
|
2018
|
+
# * kms:GenerateDataKey - needed only if you use a customer-managed
|
2019
|
+
# Amazon Web Services KMS key to encrypt the secret. You do not need
|
2020
|
+
# this permission to use the account's default Amazon Web Services
|
2021
|
+
# managed CMK for Secrets Manager.
|
2009
2022
|
#
|
2010
2023
|
# **Related operations**
|
2011
2024
|
#
|
@@ -2048,13 +2061,13 @@ module Aws::SecretsManager
|
|
2048
2061
|
# (Optional) Specifies a unique identifier for the new version of the
|
2049
2062
|
# secret.
|
2050
2063
|
#
|
2051
|
-
# <note markdown="1"> If you use the
|
2052
|
-
#
|
2053
|
-
#
|
2054
|
-
# use the SDK and instead generate a
|
2055
|
-
# Manager service endpoint, then you
|
2056
|
-
# `ClientRequestToken` yourself for new versions and
|
2057
|
-
# in the request.
|
2064
|
+
# <note markdown="1"> If you use the Amazon Web Services CLI or one of the Amazon Web
|
2065
|
+
# Services SDK to call this operation, then you can leave this parameter
|
2066
|
+
# empty. The CLI or SDK generates a random UUID for you and includes
|
2067
|
+
# that in the request. If you don't use the SDK and instead generate a
|
2068
|
+
# raw HTTP request to the Secrets Manager service endpoint, then you
|
2069
|
+
# must generate a `ClientRequestToken` yourself for new versions and
|
2070
|
+
# include that value in the request.
|
2058
2071
|
#
|
2059
2072
|
# </note>
|
2060
2073
|
#
|
@@ -2113,7 +2126,7 @@ module Aws::SecretsManager
|
|
2113
2126
|
# For storing multiple values, we recommend that you use a JSON text
|
2114
2127
|
# string argument and specify key/value pairs. For information on how to
|
2115
2128
|
# format a JSON parameter for the various command line tool
|
2116
|
-
# environments, see [Using JSON for Parameters][1] in the *
|
2129
|
+
# environments, see [Using JSON for Parameters][1] in the *CLI User
|
2117
2130
|
# Guide*.
|
2118
2131
|
#
|
2119
2132
|
# For example:
|
@@ -2380,16 +2393,17 @@ module Aws::SecretsManager
|
|
2380
2393
|
# secret. After the rotation completes, the protected service and its
|
2381
2394
|
# clients all use the new version of the secret.
|
2382
2395
|
#
|
2383
|
-
# This required configuration information includes the ARN of an
|
2384
|
-
# Lambda function and the time between
|
2385
|
-
# rotation function creates a new
|
2386
|
-
#
|
2387
|
-
#
|
2388
|
-
# the staging label `AWSCURRENT` so
|
2389
|
-
# begin to use the new version. For
|
2390
|
-
# secrets and how to configure a Lambda
|
2391
|
-
# for your protected service, see
|
2392
|
-
#
|
2396
|
+
# This required configuration information includes the ARN of an Amazon
|
2397
|
+
# Web Services Lambda function and optionally, the time between
|
2398
|
+
# scheduled rotations. The Lambda rotation function creates a new
|
2399
|
+
# version of the secret and creates or updates the credentials on the
|
2400
|
+
# protected service to match. After testing the new credentials, the
|
2401
|
+
# function marks the new secret with the staging label `AWSCURRENT` so
|
2402
|
+
# that your clients all immediately begin to use the new version. For
|
2403
|
+
# more information about rotating secrets and how to configure a Lambda
|
2404
|
+
# function to rotate the secrets for your protected service, see
|
2405
|
+
# [Rotating Secrets in Amazon Web Services Secrets Manager][1] in the
|
2406
|
+
# *Amazon Web Services Secrets Manager User Guide*.
|
2393
2407
|
#
|
2394
2408
|
# Secrets Manager schedules the next rotation when the previous one
|
2395
2409
|
# completes. Secrets Manager schedules the date by adding the rotation
|
@@ -2466,13 +2480,13 @@ module Aws::SecretsManager
|
|
2466
2480
|
# (Optional) Specifies a unique identifier for the new version of the
|
2467
2481
|
# secret that helps ensure idempotency.
|
2468
2482
|
#
|
2469
|
-
# If you use the
|
2470
|
-
#
|
2471
|
-
# random UUID for you and includes
|
2472
|
-
# parameter. If you don't use the SDK and
|
2473
|
-
# request to the Secrets Manager service
|
2474
|
-
# generate a `ClientRequestToken` yourself for
|
2475
|
-
# that value in the request.
|
2483
|
+
# If you use the Amazon Web Services CLI or one of the Amazon Web
|
2484
|
+
# Services SDK to call this operation, then you can leave this parameter
|
2485
|
+
# empty. The CLI or SDK generates a random UUID for you and includes
|
2486
|
+
# that in the request for this parameter. If you don't use the SDK and
|
2487
|
+
# instead generate a raw HTTP request to the Secrets Manager service
|
2488
|
+
# endpoint, then you must generate a `ClientRequestToken` yourself for
|
2489
|
+
# new versions and include that value in the request.
|
2476
2490
|
#
|
2477
2491
|
# You only need to specify your own value if you implement your own
|
2478
2492
|
# retry logic and want to ensure that a given secret is not created
|
@@ -2576,10 +2590,10 @@ module Aws::SecretsManager
|
|
2576
2590
|
#
|
2577
2591
|
# * Tag keys and values are case sensitive.
|
2578
2592
|
#
|
2579
|
-
# * Do not use the `aws:` prefix in your tag names or values because
|
2580
|
-
# reserves it for
|
2581
|
-
#
|
2582
|
-
# your tags per secret limit.
|
2593
|
+
# * Do not use the `aws:` prefix in your tag names or values because
|
2594
|
+
# Amazon Web Services reserves it for Amazon Web Services use. You
|
2595
|
+
# can't edit or delete tag names or values with this prefix. Tags
|
2596
|
+
# with this prefix do not count against your tags per secret limit.
|
2583
2597
|
#
|
2584
2598
|
# * If you use your tagging schema across multiple services and
|
2585
2599
|
# resources, remember other services might have restrictions on
|
@@ -2639,8 +2653,8 @@ module Aws::SecretsManager
|
|
2639
2653
|
#
|
2640
2654
|
# This parameter to the API requires a JSON text string argument. For
|
2641
2655
|
# information on how to format a JSON parameter for the various command
|
2642
|
-
# line tool environments, see [Using JSON for Parameters][1] in the *
|
2643
|
-
#
|
2656
|
+
# line tool environments, see [Using JSON for Parameters][1] in the *CLI
|
2657
|
+
# User Guide*. For the CLI, you can also use the syntax: `--Tags
|
2644
2658
|
# Key="Key1",Value="Value1" Key="Key2",Value="Value2"[,…]`
|
2645
2659
|
#
|
2646
2660
|
#
|
@@ -2747,8 +2761,8 @@ module Aws::SecretsManager
|
|
2747
2761
|
#
|
2748
2762
|
# This parameter to the API requires a JSON text string argument. For
|
2749
2763
|
# information on how to format a JSON parameter for the various command
|
2750
|
-
# line tool environments, see [Using JSON for Parameters][1] in the *
|
2751
|
-
#
|
2764
|
+
# line tool environments, see [Using JSON for Parameters][1] in the *CLI
|
2765
|
+
# User Guide*.
|
2752
2766
|
#
|
2753
2767
|
#
|
2754
2768
|
#
|
@@ -2796,7 +2810,8 @@ module Aws::SecretsManager
|
|
2796
2810
|
# <note markdown="1"> The Secrets Manager console uses only the `SecretString` parameter and
|
2797
2811
|
# therefore limits you to encrypting and storing only a text string. To
|
2798
2812
|
# encrypt and store binary data as part of the version of a secret, you
|
2799
|
-
# must use either the
|
2813
|
+
# must use either the Amazon Web Services CLI or one of the Amazon Web
|
2814
|
+
# Services SDKs.
|
2800
2815
|
#
|
2801
2816
|
# </note>
|
2802
2817
|
#
|
@@ -2811,25 +2826,27 @@ module Aws::SecretsManager
|
|
2811
2826
|
#
|
2812
2827
|
# <note markdown="1"> * If you call an operation to encrypt or decrypt the `SecretString` or
|
2813
2828
|
# `SecretBinary` for a secret in the same account as the calling user
|
2814
|
-
# and that secret doesn't specify a
|
2815
|
-
# Manager uses the account's default
|
2816
|
-
# (CMK) with the alias
|
2817
|
-
#
|
2818
|
-
#
|
2829
|
+
# and that secret doesn't specify a Amazon Web Services KMS
|
2830
|
+
# encryption key, Secrets Manager uses the account's default Amazon
|
2831
|
+
# Web Services managed customer master key (CMK) with the alias
|
2832
|
+
# `aws/secretsmanager`. If this key doesn't already exist in your
|
2833
|
+
# account then Secrets Manager creates it for you automatically. All
|
2834
|
+
# users and roles in the same Amazon Web Services account
|
2819
2835
|
# automatically have access to use the default CMK. Note that if an
|
2820
|
-
# Secrets Manager API call results in
|
2821
|
-
#
|
2822
|
-
# returning the result.
|
2823
|
-
#
|
2824
|
-
# * If the secret resides in a different
|
2825
|
-
# credentials calling an API that requires encryption or
|
2826
|
-
# the secret value then you must create and use a custom
|
2827
|
-
# because you can't access the default
|
2828
|
-
#
|
2829
|
-
#
|
2830
|
-
#
|
2831
|
-
#
|
2832
|
-
#
|
2836
|
+
# Secrets Manager API call results in Amazon Web Services creating the
|
2837
|
+
# account's Amazon Web Services-managed CMK, it can result in a
|
2838
|
+
# one-time significant delay in returning the result.
|
2839
|
+
#
|
2840
|
+
# * If the secret resides in a different Amazon Web Services account
|
2841
|
+
# from the credentials calling an API that requires encryption or
|
2842
|
+
# decryption of the secret value then you must create and use a custom
|
2843
|
+
# Amazon Web Services KMS CMK because you can't access the default
|
2844
|
+
# CMK for the account using credentials from a different Amazon Web
|
2845
|
+
# Services account. Store the ARN of the CMK in the secret when you
|
2846
|
+
# create the secret or when you update it by including it in the
|
2847
|
+
# `KMSKeyId`. If you call an API that must encrypt or decrypt
|
2848
|
+
# `SecretString` or `SecretBinary` using credentials from a different
|
2849
|
+
# account then the Amazon Web Services KMS key policy must grant
|
2833
2850
|
# cross-account access to that other account's user or role for both
|
2834
2851
|
# the kms:GenerateDataKey and kms:Decrypt operations.
|
2835
2852
|
#
|
@@ -2841,13 +2858,15 @@ module Aws::SecretsManager
|
|
2841
2858
|
#
|
2842
2859
|
# * secretsmanager:UpdateSecret
|
2843
2860
|
#
|
2844
|
-
# * kms:GenerateDataKey - needed only if you use a custom
|
2845
|
-
# encrypt the secret. You do not need this
|
2846
|
-
# account's
|
2861
|
+
# * kms:GenerateDataKey - needed only if you use a custom Amazon Web
|
2862
|
+
# Services KMS key to encrypt the secret. You do not need this
|
2863
|
+
# permission to use the account's Amazon Web Services managed CMK for
|
2864
|
+
# Secrets Manager.
|
2847
2865
|
#
|
2848
|
-
# * kms:Decrypt - needed only if you use a custom
|
2849
|
-
# the secret. You do not need this permission to
|
2850
|
-
#
|
2866
|
+
# * kms:Decrypt - needed only if you use a custom Amazon Web Services
|
2867
|
+
# KMS key to encrypt the secret. You do not need this permission to
|
2868
|
+
# use the account's Amazon Web Services managed CMK for Secrets
|
2869
|
+
# Manager.
|
2851
2870
|
#
|
2852
2871
|
# **Related operations**
|
2853
2872
|
#
|
@@ -2891,13 +2910,13 @@ module Aws::SecretsManager
|
|
2891
2910
|
# parameter specifies a unique identifier for the new version that helps
|
2892
2911
|
# ensure idempotency.
|
2893
2912
|
#
|
2894
|
-
# If you use the
|
2895
|
-
#
|
2896
|
-
#
|
2897
|
-
# use the SDK and instead generate a
|
2898
|
-
# Manager service endpoint, then you
|
2899
|
-
# `ClientRequestToken` yourself for new versions and
|
2900
|
-
# in the request.
|
2913
|
+
# If you use the Amazon Web Services CLI or one of the Amazon Web
|
2914
|
+
# Services SDK to call this operation, then you can leave this parameter
|
2915
|
+
# empty. The CLI or SDK generates a random UUID for you and includes
|
2916
|
+
# that in the request. If you don't use the SDK and instead generate a
|
2917
|
+
# raw HTTP request to the Secrets Manager service endpoint, then you
|
2918
|
+
# must generate a `ClientRequestToken` yourself for new versions and
|
2919
|
+
# include that value in the request.
|
2901
2920
|
#
|
2902
2921
|
# You typically only need to interact with this value if you implement
|
2903
2922
|
# your own retry logic and want to ensure that a given secret is not
|
@@ -2935,9 +2954,9 @@ module Aws::SecretsManager
|
|
2935
2954
|
# secret.
|
2936
2955
|
#
|
2937
2956
|
# @option params [String] :kms_key_id
|
2938
|
-
# (Optional) Specifies an updated ARN or alias of the
|
2939
|
-
# master key (CMK) to be used to encrypt the
|
2940
|
-
# versions of this secret.
|
2957
|
+
# (Optional) Specifies an updated ARN or alias of the Amazon Web
|
2958
|
+
# Services KMS customer master key (CMK) to be used to encrypt the
|
2959
|
+
# protected text in new versions of this secret.
|
2941
2960
|
#
|
2942
2961
|
# You can only use the account's default CMK to encrypt and decrypt if
|
2943
2962
|
# you call this operation using credentials from the same account that
|
@@ -2972,7 +2991,7 @@ module Aws::SecretsManager
|
|
2972
2991
|
# For storing multiple values, we recommend that you use a JSON text
|
2973
2992
|
# string argument and specify key/value pairs. For information on how to
|
2974
2993
|
# format a JSON parameter for the various command line tool
|
2975
|
-
# environments, see [Using JSON for Parameters][1] in the *
|
2994
|
+
# environments, see [Using JSON for Parameters][1] in the *CLI User
|
2976
2995
|
# Guide*. For example:
|
2977
2996
|
#
|
2978
2997
|
# `[\{"username":"bob"\},\{"password":"abc123xyz456"\}]`
|
@@ -3078,8 +3097,8 @@ module Aws::SecretsManager
|
|
3078
3097
|
# of a secret at a time. If a staging label to be added is already
|
3079
3098
|
# attached to another version, then it is moved--removed from the other
|
3080
3099
|
# version first and then attached to this one. For more information
|
3081
|
-
# about staging labels, see [Staging Labels][1] in the *
|
3082
|
-
# Manager User Guide*.
|
3100
|
+
# about staging labels, see [Staging Labels][1] in the *Amazon Web
|
3101
|
+
# Services Secrets Manager User Guide*.
|
3083
3102
|
#
|
3084
3103
|
# The staging labels that you specify in the `VersionStage` parameter
|
3085
3104
|
# are added to the existing list of staging labels--they don't replace
|
@@ -3304,11 +3323,11 @@ module Aws::SecretsManager
|
|
3304
3323
|
#
|
3305
3324
|
# @option params [required, String] :resource_policy
|
3306
3325
|
# A JSON-formatted string constructed according to the grammar and
|
3307
|
-
# syntax for an
|
3308
|
-
# identifies who can access or manage this secret and its
|
3309
|
-
# information on how to format a JSON parameter for the
|
3310
|
-
# line tool environments, see [Using JSON for
|
3311
|
-
# CLI User Guide*.publi
|
3326
|
+
# syntax for an Amazon Web Services resource-based policy. The policy in
|
3327
|
+
# the string identifies who can access or manage this secret and its
|
3328
|
+
# versions. For information on how to format a JSON parameter for the
|
3329
|
+
# various command line tool environments, see [Using JSON for
|
3330
|
+
# Parameters][1] in the *CLI User Guide*.publi
|
3312
3331
|
#
|
3313
3332
|
#
|
3314
3333
|
#
|
@@ -3372,7 +3391,7 @@ module Aws::SecretsManager
|
|
3372
3391
|
params: params,
|
3373
3392
|
config: config)
|
3374
3393
|
context[:gem_name] = 'aws-sdk-secretsmanager'
|
3375
|
-
context[:gem_version] = '1.
|
3394
|
+
context[:gem_version] = '1.49.0'
|
3376
3395
|
Seahorse::Client::Request.new(handlers, context)
|
3377
3396
|
end
|
3378
3397
|
|