AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.
Configures and starts the asynchronous process of rotating the secret. For information about rotation, see Rotate secrets in the Secrets Manager User Guide. If you include the configuration parameters, the operation sets the values for the secret and then immediately starts a rotation. If you don't include the configuration parameters, the operation starts a rotation with the values already stored in the secret.
When rotation is successful, the AWSPENDING staging label might be attached
to the same version as the AWSCURRENT version, or it might not be attached
to any version. If the AWSPENDING staging label is present but not attached
to the same version as AWSCURRENT, then any later invocation of RotateSecret
assumes that a previous rotation request is still in progress and returns an error.
When rotation is unsuccessful, the AWSPENDING staging label might be attached
to an empty secret version. For more information, see Troubleshoot
rotation in the Secrets Manager User Guide.
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:RotateSecret. For more information,
see
IAM policy actions for Secrets Manager and Authentication
and access control in Secrets Manager. You also need lambda:InvokeFunction
permissions on the rotation function. For more information, see
Permissions for rotation.
For .NET Core this operation is only available in asynchronous form. Please refer to RotateSecretAsync.
Namespace: Amazon.SecretsManager
Assembly: AWSSDK.SecretsManager.dll
Version: 3.x.y.z
public virtual RotateSecretResponse RotateSecret( RotateSecretRequest request )
Container for the necessary parameters to execute the RotateSecret service method.
| 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. |
The following example configures rotation for a secret using a cron expression. The first rotation happens immediately after the changes are stored in the secret. The rotation schedule is the first and 15th day of every month. The rotation window begins at 4:00 PM UTC and ends at 6:00 PM.
var client = new AmazonSecretsManagerClient();
var response = client.RotateSecret(new RotateSecretRequest
{
RotationLambdaARN = "arn:aws:lambda:us-west-2:123456789012:function:MyTestDatabaseRotationLambda",
RotationRules = new RotationRulesType {
Duration = "2h",
ScheduleExpression = "cron(0 16 1,15 * ? *)"
},
SecretId = "MyTestDatabaseSecret"
});
string arn = response.ARN;
string name = response.Name;
string versionId = response.VersionId;
The following example requests an immediate invocation of the secret's Lambda rotation function. It assumes that the specified secret already has rotation configured. The rotation function runs asynchronously in the background.
var client = new AmazonSecretsManagerClient();
var response = client.RotateSecret(new RotateSecretRequest
{
SecretId = "MyTestDatabaseSecret"
});
string arn = response.ARN;
string name = response.Name;
string versionId = response.VersionId;
.NET Framework:
Supported in: 4.5, 4.0, 3.5