Table of Contents

Class CancelRotateSecretRequest

Namespace
Amazon.SecretsManager.Model
Assembly
AWSSDK.SecretsManager.dll

Container for the parameters to the CancelRotateSecret operation. Disables automatic scheduled rotation and cancels the rotation of a secret if currently in progress.

To re-enable scheduled rotation, call RotateSecret with 

AutomaticallyRotateAfterDays
set to a value greater than 0. This immediately rotates your secret and then enables the automatic schedule.
note

If you cancel a rotation while in progress, it can leave the 

VersionStage
labels in an unexpected state. Depending on the step of the rotation 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 
VersionStage
field.

To successfully start a rotation, the staging label 

AWSPENDING
must be in one of the following states:

  • Not attached to any version at all

  • Attached to the same version as the staging label 

    AWSCURRENT

If the staging label 

AWSPENDING
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. 

public class CancelRotateSecretRequest : AmazonSecretsManagerRequest
Inheritance
CancelRotateSecretRequest

Constructors

CancelRotateSecretRequest() 

public CancelRotateSecretRequest()

Properties

SecretId

Gets and sets the property SecretId.

Specifies the secret to cancel a rotation request. 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. 

public string SecretId { get; set; }

Property Value

string