Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.SecretsManager.PutSecretValue

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Stores a new encrypted secret value in the specified secret. To do this, the operation creates a new version and attaches it to the secret. The version can contain a new SecretString value or a new SecretBinary value. You can also specify the staging labels that are initially attached to the new version.

We recommend you avoid calling PutSecretValue at a sustained rate of more than once every 10 minutes. When you update the secret value, Secrets Manager creates a new version of the secret. Secrets Manager removes outdated versions when there are more than 100, but it does not remove versions created less than 24 hours ago. If you call PutSecretValue more than once every 10 minutes, you create more versions than Secrets Manager removes, and you will reach the quota for secret versions.

If this operation creates the first version for the secret then Secrets Manager automatically attaches the staging label AWSCURRENT to the new version.
If you do not specify a value for VersionStages then Secrets Manager automatically moves the staging label AWSCURRENT to this new version.
If this operation moves the staging label AWSCURRENT from another version to this version, then Secrets Manager also automatically moves the staging label AWSPREVIOUS to the version that AWSCURRENT was removed from.
This operation is idempotent. If a version with a VersionId with the same value as the ClientRequestToken parameter already exists and you specify the same secret data, the operation succeeds but does nothing. However, if the secret data is different, then the operation fails because you cannot modify an existing version; you can only create new ones.
If you call an operation to encrypt or decrypt the SecretString or SecretBinary for a secret in the same account as the calling user and that secret doesn't specify a Amazon Web Services KMS encryption key, Secrets Manager uses the account's default Amazon Web Services managed customer master key (CMK) with the alias aws/secretsmanager. If this key doesn't already exist in your account then Secrets Manager creates it for you automatically. All users and roles in the same Amazon Web Services account automatically have access to use the default CMK. Note that if an Secrets Manager API call results in Amazon Web Services creating the account's Amazon Web Services-managed CMK, it can result in a one-time significant delay in returning the result.
If the secret resides in a different Amazon Web Services account from the credentials calling an API that requires encryption or decryption of the secret value then you must create and use a custom Amazon Web Services KMS CMK because you can't access the default CMK for the account using credentials from a different Amazon Web Services account. Store the ARN of the CMK in the secret when you create the secret or when you update it by including it in the KMSKeyId. If you call an API that must encrypt or decrypt SecretString or SecretBinary using credentials from a different account then the Amazon Web Services KMS key policy must grant cross-account access to that other account's user or role for both the kms:GenerateDataKey and kms:Decrypt operations.

Minimum permissions

To run this command, you must have the following permissions:

secretsmanager:PutSecretValue
kms:GenerateDataKey - needed only if you use a customer-managed Amazon Web Services KMS key to encrypt the secret. You do not need this permission to use the account's default Amazon Web Services managed CMK for Secrets Manager.

Related operations

To retrieve the encrypted value you store in the version of a secret, use GetSecretValue.
To create a secret, use CreateSecret.
To get the details for a secret, use DescribeSecret.
To list the versions attached to a secret, use ListSecretVersionIds.

Synopsis

data PutSecretValue = PutSecretValue' {
- versionStages :: Maybe (NonEmpty Text)
- secretBinary :: Maybe (Sensitive Base64)
- secretString :: Maybe (Sensitive Text)
- clientRequestToken :: Maybe Text
- secretId :: Text
}
newPutSecretValue :: Text -> PutSecretValue
putSecretValue_versionStages :: Lens' PutSecretValue (Maybe (NonEmpty Text))
putSecretValue_secretBinary :: Lens' PutSecretValue (Maybe ByteString)
putSecretValue_secretString :: Lens' PutSecretValue (Maybe Text)
putSecretValue_clientRequestToken :: Lens' PutSecretValue (Maybe Text)
putSecretValue_secretId :: Lens' PutSecretValue Text
data PutSecretValueResponse = PutSecretValueResponse' {
- versionId :: Maybe Text
- arn :: Maybe Text
- versionStages :: Maybe (NonEmpty Text)
- name :: Maybe Text
- httpStatus :: Int
}
newPutSecretValueResponse :: Int -> PutSecretValueResponse
putSecretValueResponse_versionId :: Lens' PutSecretValueResponse (Maybe Text)
putSecretValueResponse_arn :: Lens' PutSecretValueResponse (Maybe Text)
putSecretValueResponse_versionStages :: Lens' PutSecretValueResponse (Maybe (NonEmpty Text))
putSecretValueResponse_name :: Lens' PutSecretValueResponse (Maybe Text)
putSecretValueResponse_httpStatus :: Lens' PutSecretValueResponse Int

Creating a Request

data PutSecretValue Source #

See: newPutSecretValue smart constructor.

Constructors

PutSecretValue'

Fields

versionStages :: Maybe (NonEmpty Text)
(Optional) Specifies a list of staging labels that are attached to this version of the secret. These staging labels are used to track the versions through the rotation process by the Lambda rotation function.
A staging label must be unique to a single version of the secret. If you specify a staging label that's already associated with a different version of the same secret then that staging label is automatically removed from the other version and attached to this version.
If you do not specify a value for VersionStages then Secrets Manager automatically moves the staging label AWSCURRENT to this new version.
secretBinary :: Maybe (Sensitive Base64)
(Optional) Specifies binary data that you want to encrypt and store in the new version of the secret. To use this parameter in the command-line tools, we recommend that you store your binary data in a file and then use the appropriate technique for your tool to pass the contents of the file as a parameter. Either SecretBinary or SecretString must have a value, but not both. They cannot both be empty.
This parameter is not accessible if the secret using the Secrets Manager console.
secretString :: Maybe (Sensitive Text)
(Optional) Specifies text data that you want to encrypt and store in this new version of the secret. Either SecretString or SecretBinary must have a value, but not both. They cannot both be empty.
If you create this secret by using the Secrets Manager console then Secrets Manager puts the protected secret text in only the SecretString parameter. The Secrets Manager console stores the information as a JSON structure of key/value pairs that the default Lambda rotation function knows how to parse.
For storing multiple values, we recommend that you use a JSON text string argument and specify key/value pairs. For more information, see Specifying parameter values for the Amazon Web Services CLI in the Amazon Web Services CLI User Guide.
clientRequestToken :: Maybe Text
(Optional) Specifies a unique identifier for the new version of the secret.
If you use the Amazon Web Services CLI or one of the Amazon Web Services SDK to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes that in the request. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken yourself for new versions and include that value in the request.
This value helps ensure idempotency. Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during the Lambda rotation function's processing. We recommend that you generate a UUID-type value to ensure uniqueness within the specified secret.
- If the ClientRequestToken value isn't already associated with a version of the secret then a new version of the secret is created.
- If a version with this value already exists and that version's SecretString or SecretBinary values are the same as those in the request then the request is ignored (the operation is idempotent).
- If a version with this value already exists and the version of the SecretString and SecretBinary values are different from those in the request then the request fails because you cannot modify an existing secret version. You can only create new versions to store new secret values.
This value becomes the VersionId of the new version.
secretId :: Text
Specifies the secret to which you want to add a new version. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret. The secret must already exist.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.

Instances

Instances details

Eq PutSecretValue Source #
Instance details Defined in Amazonka.SecretsManager.PutSecretValue Methods (==) :: PutSecretValue -> PutSecretValue -> Bool # (/=) :: PutSecretValue -> PutSecretValue -> Bool #
Show PutSecretValue Source #
Instance details Defined in Amazonka.SecretsManager.PutSecretValue Methods showsPrec :: Int -> PutSecretValue -> ShowS # show :: PutSecretValue -> String # showList :: [PutSecretValue] -> ShowS #
Generic PutSecretValue Source #
Instance details Defined in Amazonka.SecretsManager.PutSecretValue Associated Types type Rep PutSecretValue :: Type -> Type # Methods from :: PutSecretValue -> Rep PutSecretValue x # to :: Rep PutSecretValue x -> PutSecretValue #
NFData PutSecretValue Source #
Instance details Defined in Amazonka.SecretsManager.PutSecretValue Methods rnf :: PutSecretValue -> () #
Hashable PutSecretValue Source #
Instance details Defined in Amazonka.SecretsManager.PutSecretValue Methods hashWithSalt :: Int -> PutSecretValue -> Int # hash :: PutSecretValue -> Int #
ToJSON PutSecretValue Source #
Instance details Defined in Amazonka.SecretsManager.PutSecretValue Methods toJSON :: PutSecretValue -> Value # toEncoding :: PutSecretValue -> Encoding # toJSONList :: [PutSecretValue] -> Value # toEncodingList :: [PutSecretValue] -> Encoding #
AWSRequest PutSecretValue Source #
Instance details Defined in Amazonka.SecretsManager.PutSecretValue Associated Types type AWSResponse PutSecretValue # Methods request :: PutSecretValue -> Request PutSecretValue # response :: MonadResource m => Logger -> Service -> Proxy PutSecretValue -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse PutSecretValue))) #
ToHeaders PutSecretValue Source #
Instance details Defined in Amazonka.SecretsManager.PutSecretValue Methods toHeaders :: PutSecretValue -> [Header] #
ToPath PutSecretValue Source #
Instance details Defined in Amazonka.SecretsManager.PutSecretValue Methods toPath :: PutSecretValue -> ByteString #
ToQuery PutSecretValue Source #
Instance details Defined in Amazonka.SecretsManager.PutSecretValue Methods toQuery :: PutSecretValue -> QueryString #
type Rep PutSecretValue Source #
Instance details Defined in Amazonka.SecretsManager.PutSecretValue type Rep PutSecretValue = D1 ('MetaData "PutSecretValue" "Amazonka.SecretsManager.PutSecretValue" "libZSservicesZSamazonka-secretsmanagerZSamazonka-secretsmanager" 'False) (C1 ('MetaCons "PutSecretValue'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "versionStages") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Text))) :: S1 ('MetaSel ('Just "secretBinary") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Base64)))) :: (S1 ('MetaSel ('Just "secretString") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))) :: (S1 ('MetaSel ('Just "clientRequestToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "secretId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))
type AWSResponse PutSecretValue Source #
Instance details Defined in Amazonka.SecretsManager.PutSecretValue type AWSResponse PutSecretValue = PutSecretValueResponse

newPutSecretValue Source #

Arguments

:: Text	`$sel:secretId:PutSecretValue'`
-> PutSecretValue

Create a value of PutSecretValue with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:versionStages:PutSecretValue', putSecretValue_versionStages - (Optional) Specifies a list of staging labels that are attached to this version of the secret. These staging labels are used to track the versions through the rotation process by the Lambda rotation function.

A staging label must be unique to a single version of the secret. If you specify a staging label that's already associated with a different version of the same secret then that staging label is automatically removed from the other version and attached to this version.

If you do not specify a value for VersionStages then Secrets Manager automatically moves the staging label AWSCURRENT to this new version.

$sel:secretBinary:PutSecretValue', putSecretValue_secretBinary - (Optional) Specifies binary data that you want to encrypt and store in the new version of the secret. To use this parameter in the command-line tools, we recommend that you store your binary data in a file and then use the appropriate technique for your tool to pass the contents of the file as a parameter. Either SecretBinary or SecretString must have a value, but not both. They cannot both be empty.

This parameter is not accessible if the secret using the Secrets Manager console.-- -- Note: This Lens automatically encodes and decodes Base64 data. -- The underlying isomorphism will encode to Base64 representation during -- serialisation, and decode from Base64 representation during deserialisation. -- This Lens accepts and returns only raw unencoded data.

$sel:secretString:PutSecretValue', putSecretValue_secretString - (Optional) Specifies text data that you want to encrypt and store in this new version of the secret. Either SecretString or SecretBinary must have a value, but not both. They cannot both be empty.

If you create this secret by using the Secrets Manager console then Secrets Manager puts the protected secret text in only the SecretString parameter. The Secrets Manager console stores the information as a JSON structure of key/value pairs that the default Lambda rotation function knows how to parse.

For storing multiple values, we recommend that you use a JSON text string argument and specify key/value pairs. For more information, see Specifying parameter values for the Amazon Web Services CLI in the Amazon Web Services CLI User Guide.

$sel:clientRequestToken:PutSecretValue', putSecretValue_clientRequestToken - (Optional) Specifies a unique identifier for the new version of the secret.

If you use the Amazon Web Services CLI or one of the Amazon Web Services SDK to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes that in the request. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken yourself for new versions and include that value in the request.

This value helps ensure idempotency. Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during the Lambda rotation function's processing. We recommend that you generate a UUID-type value to ensure uniqueness within the specified secret.

If the ClientRequestToken value isn't already associated with a version of the secret then a new version of the secret is created.
If a version with this value already exists and that version's SecretString or SecretBinary values are the same as those in the request then the request is ignored (the operation is idempotent).
If a version with this value already exists and the version of the SecretString and SecretBinary values are different from those in the request then the request fails because you cannot modify an existing secret version. You can only create new versions to store new secret values.

This value becomes the VersionId of the new version.

$sel:secretId:PutSecretValue', putSecretValue_secretId - Specifies the secret to which you want to add a new version. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret. The secret must already exist.

For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.

Request Lenses

putSecretValue_versionStages :: Lens' PutSecretValue (Maybe (NonEmpty Text)) Source #

(Optional) Specifies a list of staging labels that are attached to this version of the secret. These staging labels are used to track the versions through the rotation process by the Lambda rotation function.

A staging label must be unique to a single version of the secret. If you specify a staging label that's already associated with a different version of the same secret then that staging label is automatically removed from the other version and attached to this version.

If you do not specify a value for VersionStages then Secrets Manager automatically moves the staging label AWSCURRENT to this new version.

putSecretValue_secretBinary :: Lens' PutSecretValue (Maybe ByteString) Source #

(Optional) Specifies binary data that you want to encrypt and store in the new version of the secret. To use this parameter in the command-line tools, we recommend that you store your binary data in a file and then use the appropriate technique for your tool to pass the contents of the file as a parameter. Either SecretBinary or SecretString must have a value, but not both. They cannot both be empty.

This parameter is not accessible if the secret using the Secrets Manager console.-- -- Note: This Lens automatically encodes and decodes Base64 data. -- The underlying isomorphism will encode to Base64 representation during -- serialisation, and decode from Base64 representation during deserialisation. -- This Lens accepts and returns only raw unencoded data.

putSecretValue_secretString :: Lens' PutSecretValue (Maybe Text) Source #

(Optional) Specifies text data that you want to encrypt and store in this new version of the secret. Either SecretString or SecretBinary must have a value, but not both. They cannot both be empty.

If you create this secret by using the Secrets Manager console then Secrets Manager puts the protected secret text in only the SecretString parameter. The Secrets Manager console stores the information as a JSON structure of key/value pairs that the default Lambda rotation function knows how to parse.

For storing multiple values, we recommend that you use a JSON text string argument and specify key/value pairs. For more information, see Specifying parameter values for the Amazon Web Services CLI in the Amazon Web Services CLI User Guide.

putSecretValue_clientRequestToken :: Lens' PutSecretValue (Maybe Text) Source #

(Optional) Specifies a unique identifier for the new version of the secret.

If you use the Amazon Web Services CLI or one of the Amazon Web Services SDK to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes that in the request. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken yourself for new versions and include that value in the request.

This value helps ensure idempotency. Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during the Lambda rotation function's processing. We recommend that you generate a UUID-type value to ensure uniqueness within the specified secret.

If the ClientRequestToken value isn't already associated with a version of the secret then a new version of the secret is created.
If a version with this value already exists and that version's SecretString or SecretBinary values are the same as those in the request then the request is ignored (the operation is idempotent).
If a version with this value already exists and the version of the SecretString and SecretBinary values are different from those in the request then the request fails because you cannot modify an existing secret version. You can only create new versions to store new secret values.

This value becomes the VersionId of the new version.

putSecretValue_secretId :: Lens' PutSecretValue Text Source #

Specifies the secret to which you want to add a new version. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret. The secret must already exist.

For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.

Destructuring the Response

data PutSecretValueResponse Source #

See: newPutSecretValueResponse smart constructor.

Constructors

PutSecretValueResponse'

Fields

versionId :: Maybe Text
The unique identifier of the version of the secret you just created or updated.
arn :: Maybe Text
The Amazon Resource Name (ARN) for the secret for which you just created a version.
versionStages :: Maybe (NonEmpty Text)
The list of staging labels that are currently attached to this version of the secret. Staging labels are used to track a version as it progresses through the secret rotation process.
name :: Maybe Text
The friendly name of the secret for which you just created or updated a version.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Eq PutSecretValueResponse Source #
Instance details Defined in Amazonka.SecretsManager.PutSecretValue Methods (==) :: PutSecretValueResponse -> PutSecretValueResponse -> Bool # (/=) :: PutSecretValueResponse -> PutSecretValueResponse -> Bool #
Read PutSecretValueResponse Source #
Instance details Defined in Amazonka.SecretsManager.PutSecretValue Methods readsPrec :: Int -> ReadS PutSecretValueResponse # readList :: ReadS [PutSecretValueResponse] # readPrec :: ReadPrec PutSecretValueResponse # readListPrec :: ReadPrec [PutSecretValueResponse] #
Show PutSecretValueResponse Source #
Instance details Defined in Amazonka.SecretsManager.PutSecretValue Methods showsPrec :: Int -> PutSecretValueResponse -> ShowS # show :: PutSecretValueResponse -> String # showList :: [PutSecretValueResponse] -> ShowS #
Generic PutSecretValueResponse Source #
Instance details Defined in Amazonka.SecretsManager.PutSecretValue Associated Types type Rep PutSecretValueResponse :: Type -> Type # Methods from :: PutSecretValueResponse -> Rep PutSecretValueResponse x # to :: Rep PutSecretValueResponse x -> PutSecretValueResponse #
NFData PutSecretValueResponse Source #
Instance details Defined in Amazonka.SecretsManager.PutSecretValue Methods rnf :: PutSecretValueResponse -> () #
type Rep PutSecretValueResponse Source #
Instance details Defined in Amazonka.SecretsManager.PutSecretValue type Rep PutSecretValueResponse = D1 ('MetaData "PutSecretValueResponse" "Amazonka.SecretsManager.PutSecretValue" "libZSservicesZSamazonka-secretsmanagerZSamazonka-secretsmanager" 'False) (C1 ('MetaCons "PutSecretValueResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "versionId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "versionStages") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Text))) :: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))

newPutSecretValueResponse Source #

Arguments

:: Int	`$sel:httpStatus:PutSecretValueResponse'`
-> PutSecretValueResponse

Create a value of PutSecretValueResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:versionId:PutSecretValueResponse', putSecretValueResponse_versionId - The unique identifier of the version of the secret you just created or updated.

$sel:arn:PutSecretValueResponse', putSecretValueResponse_arn - The Amazon Resource Name (ARN) for the secret for which you just created a version.

$sel:versionStages:PutSecretValue', putSecretValueResponse_versionStages - The list of staging labels that are currently attached to this version of the secret. Staging labels are used to track a version as it progresses through the secret rotation process.

$sel:name:PutSecretValueResponse', putSecretValueResponse_name - The friendly name of the secret for which you just created or updated a version.

$sel:httpStatus:PutSecretValueResponse', putSecretValueResponse_httpStatus - The response's http status code.

Response Lenses

putSecretValueResponse_versionId :: Lens' PutSecretValueResponse (Maybe Text) Source #

The unique identifier of the version of the secret you just created or updated.

putSecretValueResponse_arn :: Lens' PutSecretValueResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) for the secret for which you just created a version.

putSecretValueResponse_versionStages :: Lens' PutSecretValueResponse (Maybe (NonEmpty Text)) Source #

The list of staging labels that are currently attached to this version of the secret. Staging labels are used to track a version as it progresses through the secret rotation process.

putSecretValueResponse_name :: Lens' PutSecretValueResponse (Maybe Text) Source #

The friendly name of the secret for which you just created or updated a version.

putSecretValueResponse_httpStatus :: Lens' PutSecretValueResponse Int Source #

The response's http status code.