| Copyright | (c) 2013-2023 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
Amazonka.SecretsManager.UpdateSecretVersionStage
Description
Modifies the staging labels attached to a version of a secret. Secrets Manager uses staging labels to track a version as it progresses through the secret rotation process. Each staging label can be attached to only one version at a time. To add a staging label to a version when it is already attached to another version, Secrets Manager first removes it from the other version first and then attaches it to this one. For more information about versions and staging labels, see Concepts: Version.
The staging labels that you specify in the VersionStage parameter are
added to the existing list of staging labels for the version.
You can move the AWSCURRENT staging label to this version by including
it in this call.
Whenever you move AWSCURRENT, Secrets Manager automatically moves the
label AWSPREVIOUS to the version that AWSCURRENT was removed from.
If this action results in the last label being removed from a version, then the version is considered to be 'deprecated' and can be deleted by Secrets Manager.
Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.
Required permissions: secretsmanager:UpdateSecretVersionStage. For
more information, see
IAM policy actions for Secrets Manager
and
Authentication and access control in Secrets Manager.
Synopsis
- data UpdateSecretVersionStage = UpdateSecretVersionStage' {}
- newUpdateSecretVersionStage :: Text -> Text -> UpdateSecretVersionStage
- updateSecretVersionStage_moveToVersionId :: Lens' UpdateSecretVersionStage (Maybe Text)
- updateSecretVersionStage_removeFromVersionId :: Lens' UpdateSecretVersionStage (Maybe Text)
- updateSecretVersionStage_secretId :: Lens' UpdateSecretVersionStage Text
- updateSecretVersionStage_versionStage :: Lens' UpdateSecretVersionStage Text
- data UpdateSecretVersionStageResponse = UpdateSecretVersionStageResponse' {}
- newUpdateSecretVersionStageResponse :: Int -> UpdateSecretVersionStageResponse
- updateSecretVersionStageResponse_arn :: Lens' UpdateSecretVersionStageResponse (Maybe Text)
- updateSecretVersionStageResponse_name :: Lens' UpdateSecretVersionStageResponse (Maybe Text)
- updateSecretVersionStageResponse_httpStatus :: Lens' UpdateSecretVersionStageResponse Int
Creating a Request
data UpdateSecretVersionStage Source #
See: newUpdateSecretVersionStage smart constructor.
Constructors
| UpdateSecretVersionStage' | |
Fields
| |
Instances
newUpdateSecretVersionStage Source #
Arguments
| :: Text | |
| -> Text | |
| -> UpdateSecretVersionStage |
Create a value of UpdateSecretVersionStage 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:moveToVersionId:UpdateSecretVersionStage', updateSecretVersionStage_moveToVersionId - The ID of the version to add the staging label to. To remove a label
from a version, then do not specify this parameter.
If the staging label is already attached to a different version of the
secret, then you must also specify the RemoveFromVersionId parameter.
$sel:removeFromVersionId:UpdateSecretVersionStage', updateSecretVersionStage_removeFromVersionId - The ID of the version that the staging label is to be removed from. If
the staging label you are trying to attach to one version is already
attached to a different version, then you must include this parameter
and specify the version that the label is to be removed from. If the
label is attached and you either do not specify this parameter, or the
version ID does not match, then the operation fails.
$sel:secretId:UpdateSecretVersionStage', updateSecretVersionStage_secretId - The ARN or the name of the secret with the version and staging labelsto
modify.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. See Finding a secret from a partial ARN.
$sel:versionStage:UpdateSecretVersionStage', updateSecretVersionStage_versionStage - The staging label to add to this version.
Request Lenses
updateSecretVersionStage_moveToVersionId :: Lens' UpdateSecretVersionStage (Maybe Text) Source #
The ID of the version to add the staging label to. To remove a label from a version, then do not specify this parameter.
If the staging label is already attached to a different version of the
secret, then you must also specify the RemoveFromVersionId parameter.
updateSecretVersionStage_removeFromVersionId :: Lens' UpdateSecretVersionStage (Maybe Text) Source #
The ID of the version that the staging label is to be removed from. If the staging label you are trying to attach to one version is already attached to a different version, then you must include this parameter and specify the version that the label is to be removed from. If the label is attached and you either do not specify this parameter, or the version ID does not match, then the operation fails.
updateSecretVersionStage_secretId :: Lens' UpdateSecretVersionStage Text Source #
The ARN or the name of the secret with the version and staging labelsto modify.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. See Finding a secret from a partial ARN.
updateSecretVersionStage_versionStage :: Lens' UpdateSecretVersionStage Text Source #
The staging label to add to this version.
Destructuring the Response
data UpdateSecretVersionStageResponse Source #
See: newUpdateSecretVersionStageResponse smart constructor.
Constructors
| UpdateSecretVersionStageResponse' | |
Instances
newUpdateSecretVersionStageResponse Source #
Create a value of UpdateSecretVersionStageResponse 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:
UpdateSecretVersionStageResponse, updateSecretVersionStageResponse_arn - The ARN of the secret that was updated.
UpdateSecretVersionStageResponse, updateSecretVersionStageResponse_name - The name of the secret that was updated.
$sel:httpStatus:UpdateSecretVersionStageResponse', updateSecretVersionStageResponse_httpStatus - The response's http status code.
Response Lenses
updateSecretVersionStageResponse_arn :: Lens' UpdateSecretVersionStageResponse (Maybe Text) Source #
The ARN of the secret that was updated.
updateSecretVersionStageResponse_name :: Lens' UpdateSecretVersionStageResponse (Maybe Text) Source #
The name of the secret that was updated.
updateSecretVersionStageResponse_httpStatus :: Lens' UpdateSecretVersionStageResponse Int Source #
The response's http status code.