Container for the parameters to the CancelRotateSecret operation. 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.
Inheritance Hierarchy
Amazon.Runtime.AmazonWebServiceRequest
Amazon.SecretsManager.AmazonSecretsManagerRequest
Amazon.SecretsManager.Model.CancelRotateSecretRequest
Namespace: Amazon.SecretsManager.Model
Assembly: AWSSDK.SecretsManager.dll
Version: 3.x.y.z
Syntax
public class CancelRotateSecretRequest : AmazonSecretsManagerRequest IAmazonWebServiceRequest
The CancelRotateSecretRequest type exposes the following members
Constructors
| Name | Description | |
|---|---|---|
|
CancelRotateSecretRequest() |
Properties
| Name | Type | Description | |
|---|---|---|---|
|
|
SecretId | System.String |
Gets and sets the property SecretId. 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. |
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 Core App:
Supported in: 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5, 4.0, 3.5