secretsmanager_update_secret_version_stage: Modifies the staging labels attached to a version of a secret

View source: R/secretsmanager_operations.R

secretsmanager_update_secret_version_stageR Documentation

Modifies the staging labels attached to a version of a secret

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.

See https://www.paws-r-sdk.com/docs/secretsmanager_update_secret_version_stage/ for full documentation.

Usage

secretsmanager_update_secret_version_stage(
  SecretId,
  VersionStage,
  RemoveFromVersionId = NULL,
  MoveToVersionId = NULL
)

Arguments

SecretId

[required] 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.

VersionStage

[required] The staging label to add to this version.

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.

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.


paws.security.identity documentation built on Sept. 12, 2024, 6:30 a.m.