Amazonka.SecretsManager.PutSecretValue

Creates a new version with a new encrypted secret value and attaches it to the secret. The version can contain a new SecretString value or a new SecretBinary value.

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.

You can specify the staging labels to attach to the new version in VersionStages. If you don't include VersionStages, then Secrets Manager automatically moves the staging label AWSCURRENT to this version. If this operation creates the first version for the secret, then Secrets Manager automatically attaches the staging label AWSCURRENT to it. 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 you call this operation with a ClientRequestToken that matches an existing version's VersionId, 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 can't modify an existing version; you can only create new ones.

Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters except SecretBinary or SecretString because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.

Required permissions: secretsmanager:PutSecretValue. For more information, see IAM policy actions for Secrets Manager and Authentication and access control in Secrets Manager.

Creating a Request

data PutSecretValue

See: newPutSecretValue smart constructor.

Constructors

PutSecretValue'

Fields

• clientRequestToken :: Maybe Text

  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 SDKs to call this operation, then you can leave this parameter empty because they generate a random UUID for you. 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 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 can't modify a secret version. You can only create new versions to store new secret values.

  This value becomes the VersionId of the new version.

• secretBinary :: Maybe (Sensitive Base64)

  The binary data 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 pass the contents of the file as a parameter.

  You must include SecretBinary or SecretString, but not both.

  You can't access this value from the Secrets Manager console.

• secretString :: Maybe (Sensitive Text)

  The text to encrypt and store in the new version of the secret.

  You must include SecretBinary or SecretString, but not both.

  We recommend you create the secret string as JSON key/value pairs, as shown in the example.

• versionStages :: Maybe (NonEmpty Text)

  A list of staging labels to attach to this version of the secret. Secrets Manager uses staging labels to track versions of a secret through the rotation process.

  If you specify a staging label that's already associated with a different version of the same secret, then Secrets Manager removes the label from the other version and attaches it to this version. If you specify AWSCURRENT, and it is already attached to another version, then Secrets Manager also moves the staging label AWSPREVIOUS to the version that AWSCURRENT was removed from.

  If you don't include VersionStages, then Secrets Manager automatically moves the staging label AWSCURRENT to this version.

• secretId :: Text

  The ARN or name of the secret to add a new version to.

  For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. See Finding a secret from a partial ARN.

  If the secret doesn't already exist, use CreateSecret instead.

Instances

ToJSON PutSecretValue

Defined in Amazonka.SecretsManager.PutSecretValue

Methods

toJSON :: PutSecretValue -> Value

toEncoding :: PutSecretValue -> Encoding

toJSONList :: [PutSecretValue] -> Value

toEncodingList :: [PutSecretValue] -> Encoding

ToHeaders PutSecretValue

Defined in Amazonka.SecretsManager.PutSecretValue

Methods

toHeaders :: PutSecretValue -> [Header]

ToPath PutSecretValue

Defined in Amazonka.SecretsManager.PutSecretValue

Methods

toPath :: PutSecretValue -> ByteString

ToQuery PutSecretValue

Defined in Amazonka.SecretsManager.PutSecretValue

Methods

toQuery :: PutSecretValue -> QueryString

AWSRequest PutSecretValue

Defined in Amazonka.SecretsManager.PutSecretValue

Associated Types

type AWSResponse PutSecretValue

Methods

request :: (Service -> Service) -> PutSecretValue -> Request PutSecretValue

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy PutSecretValue -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse PutSecretValue)))

Generic PutSecretValue

Defined in Amazonka.SecretsManager.PutSecretValue

Associated Types

type Rep PutSecretValue :: Type -> Type

Methods

from :: PutSecretValue -> Rep PutSecretValue x

to :: Rep PutSecretValue x -> PutSecretValue

Show PutSecretValue

Defined in Amazonka.SecretsManager.PutSecretValue

Methods

showsPrec :: Int -> PutSecretValue -> ShowS

show :: PutSecretValue -> String

showList :: [PutSecretValue] -> ShowS

NFData PutSecretValue

Defined in Amazonka.SecretsManager.PutSecretValue

Methods

rnf :: PutSecretValue -> ()

Eq PutSecretValue

Defined in Amazonka.SecretsManager.PutSecretValue

Methods

(==) :: PutSecretValue -> PutSecretValue -> Bool

(/=) :: PutSecretValue -> PutSecretValue -> Bool

Hashable PutSecretValue

Defined in Amazonka.SecretsManager.PutSecretValue

Methods

hashWithSalt :: Int -> PutSecretValue -> Int

hash :: PutSecretValue -> Int

type AWSResponse PutSecretValue

Defined in Amazonka.SecretsManager.PutSecretValue

type AWSResponse PutSecretValue = PutSecretValueResponse

type Rep PutSecretValue

Defined in Amazonka.SecretsManager.PutSecretValue

type Rep PutSecretValue = D1 ('MetaData "PutSecretValue" "Amazonka.SecretsManager.PutSecretValue" "amazonka-secretsmanager-2.0-8tljeZ4CwL92E7JavkDb0o" 'False) (C1 ('MetaCons "PutSecretValue'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "clientRequestToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe 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 "versionStages") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Text))) :*: S1 ('MetaSel ('Just "secretId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newPutSecretValue

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:clientRequestToken:PutSecretValue', putSecretValue_clientRequestToken - 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 SDKs to call this operation, then you can leave this parameter empty because they generate a random UUID for you. 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 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 can't modify a secret version. You can only create new versions to store new secret values.

This value becomes the VersionId of the new version.

$sel:secretBinary:PutSecretValue', putSecretValue_secretBinary - The binary data 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 pass the contents of the file as a parameter.

You must include SecretBinary or SecretString, but not both.

You can't access this value from 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 - The text to encrypt and store in the new version of the secret.

You must include SecretBinary or SecretString, but not both.

We recommend you create the secret string as JSON key/value pairs, as shown in the example.

PutSecretValue, putSecretValue_versionStages - A list of staging labels to attach to this version of the secret. Secrets Manager uses staging labels to track versions of a secret through the rotation process.

If you specify a staging label that's already associated with a different version of the same secret, then Secrets Manager removes the label from the other version and attaches it to this version. If you specify AWSCURRENT, and it is already attached to another version, then Secrets Manager also moves the staging label AWSPREVIOUS to the version that AWSCURRENT was removed from.

If you don't include VersionStages, then Secrets Manager automatically moves the staging label AWSCURRENT to this version.

$sel:secretId:PutSecretValue', putSecretValue_secretId - The ARN or name of the secret to add a new version to.

For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. See Finding a secret from a partial ARN.

If the secret doesn't already exist, use CreateSecret instead.

Request Lenses

putSecretValue_clientRequestToken :: Lens' PutSecretValue (Maybe Text)

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 SDKs to call this operation, then you can leave this parameter empty because they generate a random UUID for you. 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 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 can't modify a secret version. You can only create new versions to store new secret values.

This value becomes the VersionId of the new version.

putSecretValue_secretBinary :: Lens' PutSecretValue (Maybe ByteString)

The binary data 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 pass the contents of the file as a parameter.

You must include SecretBinary or SecretString, but not both.

You can't access this value from 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)

The text to encrypt and store in the new version of the secret.

You must include SecretBinary or SecretString, but not both.

We recommend you create the secret string as JSON key/value pairs, as shown in the example.

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

A list of staging labels to attach to this version of the secret. Secrets Manager uses staging labels to track versions of a secret through the rotation process.

If you specify a staging label that's already associated with a different version of the same secret, then Secrets Manager removes the label from the other version and attaches it to this version. If you specify AWSCURRENT, and it is already attached to another version, then Secrets Manager also moves the staging label AWSPREVIOUS to the version that AWSCURRENT was removed from.

If you don't include VersionStages, then Secrets Manager automatically moves the staging label AWSCURRENT to this version.

putSecretValue_secretId :: Lens' PutSecretValue Text

The ARN or name of the secret to add a new version to.

For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. See Finding a secret from a partial ARN.

If the secret doesn't already exist, use CreateSecret instead.

Destructuring the Response

data PutSecretValueResponse

See: newPutSecretValueResponse smart constructor.

Constructors

PutSecretValueResponse'

Fields

• arn :: Maybe Text

  The ARN of the secret.

• name :: Maybe Text

  The name of the secret.

• versionId :: Maybe Text

  The unique identifier of the version of the secret.

• versionStages :: Maybe (NonEmpty Text)

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

• httpStatus :: Int

  The response's http status code.

Instances

Generic PutSecretValueResponse

Defined in Amazonka.SecretsManager.PutSecretValue

Associated Types

type Rep PutSecretValueResponse :: Type -> Type

Methods

from :: PutSecretValueResponse -> Rep PutSecretValueResponse x

to :: Rep PutSecretValueResponse x -> PutSecretValueResponse

Read PutSecretValueResponse

Defined in Amazonka.SecretsManager.PutSecretValue

Methods

readsPrec :: Int -> ReadS PutSecretValueResponse

readList :: ReadS [PutSecretValueResponse]

readPrec :: ReadPrec PutSecretValueResponse

readListPrec :: ReadPrec [PutSecretValueResponse]

Show PutSecretValueResponse

Defined in Amazonka.SecretsManager.PutSecretValue

Methods

showsPrec :: Int -> PutSecretValueResponse -> ShowS

show :: PutSecretValueResponse -> String

showList :: [PutSecretValueResponse] -> ShowS

NFData PutSecretValueResponse

Defined in Amazonka.SecretsManager.PutSecretValue

Methods

rnf :: PutSecretValueResponse -> ()

Eq PutSecretValueResponse

Defined in Amazonka.SecretsManager.PutSecretValue

Methods

(==) :: PutSecretValueResponse -> PutSecretValueResponse -> Bool

(/=) :: PutSecretValueResponse -> PutSecretValueResponse -> Bool

type Rep PutSecretValueResponse

Defined in Amazonka.SecretsManager.PutSecretValue

type Rep PutSecretValueResponse = D1 ('MetaData "PutSecretValueResponse" "Amazonka.SecretsManager.PutSecretValue" "amazonka-secretsmanager-2.0-8tljeZ4CwL92E7JavkDb0o" 'False) (C1 ('MetaCons "PutSecretValueResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "versionId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "versionStages") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Text))) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))

newPutSecretValueResponse

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:

PutSecretValueResponse, putSecretValueResponse_arn - The ARN of the secret.

PutSecretValueResponse, putSecretValueResponse_name - The name of the secret.

PutSecretValueResponse, putSecretValueResponse_versionId - The unique identifier of the version of the secret.

PutSecretValue, putSecretValueResponse_versionStages - The list of staging labels that are currently attached to this version of the secret. Secrets Manager uses staging labels to track a version as it progresses through the secret rotation process.

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

Response Lenses

putSecretValueResponse_arn :: Lens' PutSecretValueResponse (Maybe Text)

The ARN of the secret.

putSecretValueResponse_name :: Lens' PutSecretValueResponse (Maybe Text)

The name of the secret.

putSecretValueResponse_versionId :: Lens' PutSecretValueResponse (Maybe Text)

The unique identifier of the version of the secret.

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

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

putSecretValueResponse_httpStatus :: Lens' PutSecretValueResponse Int

The response's http status code.