[ aws . secretsmanager ]

update-secret-version-stage

Description

Modifies the staging labels attached to a version of a secret. Staging labels are used to track a version as it progresses through the secret rotation process. You can attach a staging label to only one version of a secret at a time. If a staging label to be added is already attached to another version, then it is moved–removed from the other version first and then attached to this one. For more information about staging labels, see Staging Labels in the AWS Secrets Manager User Guide .

The staging labels that you specify in the VersionStage parameter are added to the existing list of staging labels–they don’t replace it.

You can move the AWSCURRENT staging label to this version by including it in this call.

Note

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.

Minimum permissions

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

• secretsmanager:UpdateSecretVersionStage

Related operations

• To get the list of staging labels that are currently associated with a version of a secret, use `` DescribeSecret `` and examine the SecretVersionsToStages response value.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  update-secret-version-stage
--secret-id <value>
--version-stage <value>
[--remove-from-version-id <value>]
[--move-to-version-id <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]

Options

--secret-id (string)

Specifies the secret with the version with the list of staging labels you want to modify. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.

Note

If you specify an ARN, we generally recommend that you specify a complete ARN. You can specify a partial ARN too—for example, if you don’t include the final hyphen and six random characters that Secrets Manager adds at the end of the ARN when you created the secret. A partial ARN match can work as long as it uniquely matches only one secret. However, if your secret has a name that ends in a hyphen followed by six characters (before Secrets Manager adds the hyphen and six characters to the ARN) and you try to use that as a partial ARN, then those characters cause Secrets Manager to assume that you’re specifying a complete ARN. This confusion can cause unexpected results. To avoid this situation, we recommend that you don’t create secret names ending with a hyphen followed by six characters.

If you specify an incomplete ARN without the random suffix, and instead provide the ‘friendly name’, you must not include the random suffix. If you do include the random suffix added by Secrets Manager, you receive either a ResourceNotFoundException or an AccessDeniedException error, depending on your permissions.

--version-stage (string)

The staging label to add to this version.

--remove-from-version-id (string)

Specifies the secret version 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.

--move-to-version-id (string)

(Optional) The secret version ID that you want to add the staging label. If you want 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.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

--cli-auto-prompt (boolean) Automatically prompt for CLI input parameters.

See ‘aws help’ for descriptions of global parameters.

Examples

To add a staging label attached to a version of a secret

The following example shows you how to add a staging label to a version of a secret. You can review the results by running the command list-secret-version-ids and viewing the VersionStages response field for the affected version.

aws secretsmanager update-secret-version-stage --secret-id MyTestDatabaseSecret \
  --version-stage STAGINGLABEL1 \
  --move-to-version-id EXAMPLE1-90ab-cdef-fedc-ba987EXAMPLE

The output shows the following:

{
  "ARN": "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-a1b2c3",
  "Name": "MyTestDatabaseSecret"
}

To delete a staging label attached to a version of a secret

The following example shows you how to delete a staging label that is attached to a version of a secret. You can review the results by running the command list-secret-version-ids and viewing the VersionStages response field for the affected version.

aws secretsmanager update-secret-version-stage --secret-id MyTestDatabaseSecret \
  --version-stage STAGINGLABEL1 \
  --remove-from-version-id EXAMPLE1-90ab-cdef-fedc-ba987EXAMPLE

The output shows the following:

{
  "ARN": "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-a1b2c3",
  "Name": "MyTestDatabaseSecret"
}

To move a staging label from one version of a secret to another

The following example shows you how to move a staging label that is attached to one version of a secret to a different version. You can review the results by running the command list-secret-version-ids and viewing the VersionStages response field for the affected version.

aws secretsmanager update-secret-version-stage --secret-id MyTestDatabaseSecret \
  --version-stage AWSCURRENT \
  --move-to-version-id EXAMPLE1-90ab-cdef-fedc-ba987EXAMPLE \
  --remove-from-version-id EXAMPLE2-90ab-cdef-fedc-ba987EXAMPLE

The output shows the following:

{
  "ARN": "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-a1b2c3",
  "Name": "MyTestDatabaseSecret"
}

Output

ARN -> (string)

The ARN of the secret with the modified staging label.

Name -> (string)

The friendly name of the secret with the modified staging label.