AmazonSecretsManagerClient.CancelRotateSecret Method (CancelRotateSecretRequest)

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 ListSecretVersionIds. Then use UpdateSecretVersionStage to change staging labels. For more information, see How rotation works.

To turn on automatic rotation again, call RotateSecret.

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.

Note:

For .NET Core this operation is only available in asynchronous form. Please refer to CancelRotateSecretAsync.

Namespace: Amazon.SecretsManager
Assembly: AWSSDK.SecretsManager.dll
Version: 3.x.y.z

Syntax

public virtual CancelRotateSecretResponse CancelRotateSecret(
         CancelRotateSecretRequest request
)

Parameters

request: Type: Amazon.SecretsManager.Model.CancelRotateSecretRequest

Container for the necessary parameters to execute the CancelRotateSecret service method.

Return Value

Type: CancelRotateSecretResponse

The response from the CancelRotateSecret service method, as returned by SecretsManager.

Exceptions

Exception	Condition
InternalServiceErrorException	An error occurred on the server side.
InvalidParameterException	The parameter name or value is invalid.
InvalidRequestException	A parameter value is not valid for the current state of the resource. Possible causes: The secret is scheduled for deletion. You tried to enable rotation on a secret that doesn't already have a Lambda function ARN configured and you didn't include such an ARN as a parameter in this call. The secret is managed by another service, and you must use that service to update it. For more information, see Secrets managed by other Amazon Web Services services.
ResourceNotFoundException	Secrets Manager can't find the resource that you asked for.

Examples

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.

To cancel scheduled rotation for a secret


var client = new AmazonSecretsManagerClient();
var response = client.CancelRotateSecret(new CancelRotateSecretRequest 
{
    SecretId = "MyTestDatabaseSecret"
});

string arn = response.ARN;
string name = response.Name;

Version Information

.NET Framework:
Supported in: 4.5 and newer, 3.5

AmazonSecretsManagerClient.CancelRotateSecret (CancelRotateSecretRequest)

Method