paws.security.identity (version 0.1.0)

secretsmanager_cancel_rotate_secret: Disables automatic scheduled rotation and cancels the rotation of a secret if one is currently in progress

Description

Disables automatic scheduled rotation and cancels the rotation of a secret if one is currently in progress.

Usage

secretsmanager_cancel_rotate_secret(SecretId)

Arguments

SecretId

[required] Specifies the secret for which you want to cancel a rotation request. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.

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 that end with a hyphen followed by six characters.

Request syntax

svc$cancel_rotate_secret(
  SecretId = "string"
)

Details

To re-enable scheduled rotation, call RotateSecret with AutomaticallyRotateAfterDays set to a value greater than 0. This will immediately rotate your secret and then enable the automatic schedule.

If you cancel a rotation that is in progress, it can leave the VersionStage labels in an unexpected state. Depending on what step of the rotation was in progress, you might need to remove the staging label AWSPENDING from the partially created version, specified by the VersionId response value. You should also evaluate the partially rotated new version to see if it should be deleted, which you can do by removing all staging labels from the new version's VersionStage field.

To successfully start a rotation, the staging label AWSPENDING must be in one of the following states:

• Not be attached to any version at all

• Attached to the same version as the staging label AWSCURRENT

If the staging label AWSPENDING is attached to a different version than the version with AWSCURRENT then the attempt to rotate fails.

Minimum permissions

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

• secretsmanager:CancelRotateSecret

Related operations

• To configure rotation for a secret or to manually trigger a rotation, use RotateSecret.

• To get the rotation configuration details for a secret, use DescribeSecret.

• To list all of the currently available secrets, use ListSecrets.

• To list all of the versions currently associated with a secret, use ListSecretVersionIds.

Examples

# NOT RUN {
# The following example shows how to cancel rotation for a secret. The
# operation sets the RotationEnabled field to false and cancels all
# scheduled rotations. To resume scheduled rotations, you must re-enable
# rotation by calling the rotate-secret operation.
# }
# NOT RUN {
svc$cancel_rotate_secret(
  SecretId = "MyTestDatabaseSecret"
)
# }
# NOT RUN {
# }