Cancel Rotate Secret

secretsmanager_cancel_rotate_secret

R Documentation

Turns off automatic rotation, and if a rotation is currently in progress, cancels the rotation¶

Description¶

Turns off automatic rotation, and if a rotation is currently in progress, cancels the rotation.

If you cancel a rotation in progress, it can leave the VersionStage labels in an unexpected state. You might need to remove the staging label AWSPENDING from the partially created version. You also need to determine whether to roll back to the previous version of the secret by moving the staging label AWSCURRENT to the version that has AWSPENDING. To determine which version has a specific staging label, call list_secret_version_ids. Then use update_secret_version_stage to change staging labels. For more information, see How rotation works.

To turn on automatic rotation again, call rotate_secret.

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:CancelRotateSecret. For more information, see IAM policy actions for Secrets Manager and Authentication and access control in Secrets Manager.

Usage¶

secretsmanager_cancel_rotate_secret(SecretId)

Arguments¶

SecretId

[required] The ARN or name of the secret.

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

Value¶

A list with the following syntax:

list(
  ARN = "string",
  Name = "string",
  VersionId = "string"
)

Request syntax¶

svc$cancel_rotate_secret(
  SecretId = "string"
)

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.
svc$cancel_rotate_secret(
  SecretId = "MyTestDatabaseSecret"
)

## End(Not run)