RotateSecret
Configures and starts the asynchronous process of rotating the secret. For more information about rotation, see Rotate secrets.
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.
For database credentials you want to rotate, for Secrets Manager to be able to rotate the secret, you must make sure the secret value is in the JSON structure of a database secret. In particular, if you want to use the alternating users strategy, your secret must contain the ARN of a superuser secret.
To configure rotation, you also need the ARN of an Amazon Lambda function and the schedule
for the rotation. The Lambda rotation function creates a new
version of the secret and creates or updates the credentials on the database or service to
match. After testing the new credentials, the function marks the new secret version with the staging
label AWSCURRENT
. Then anyone who retrieves the secret gets the new version. For more
information, see How rotation works.
You can create the Lambda rotation function based on the rotation function templates that Secrets Manager provides. Choose a template that matches your Rotation strategy.
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.
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.
Request Syntax
{
"ClientRequestToken": "string
",
"RotateImmediately": boolean
,
"RotationLambdaARN": "string
",
"RotationRules": {
"AutomaticallyAfterDays": number
,
"Duration": "string
",
"ScheduleExpression": "string
"
},
"SecretId": "string
"
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- ClientRequestToken
-
A unique identifier for the new version of the secret that helps ensure idempotency. Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during rotation. This value becomes the
VersionId
of the new version.If you use the Amazon CLI or one of the Amazon SDK to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes that in the request for this parameter. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a
ClientRequestToken
yourself for new versions and include that value in the request.You only need to specify this value if you implement your own retry logic and you want to ensure that Secrets Manager doesn't attempt to create a secret version twice. We recommend that you generate a UUID-type
value to ensure uniqueness within the specified secret. Type: String
Length Constraints: Minimum length of 32. Maximum length of 64.
Required: No
- RotateImmediately
-
Specifies whether to rotate the secret immediately or wait until the next scheduled rotation window. The rotation schedule is defined in RotateSecret:RotationRules.
If you don't immediately rotate the secret, Secrets Manager tests the rotation configuration by running the
testSecret
step of the Lambda rotation function. The test creates anAWSPENDING
version of the secret and then removes it.If you don't specify this value, then by default, Secrets Manager rotates the secret immediately.
Type: Boolean
Required: No
- RotationLambdaARN
-
The ARN of the Lambda rotation function that can rotate the secret.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2048.
Required: No
- RotationRules
-
A structure that defines the rotation configuration for this secret.
Type: RotationRulesType object
Required: No
- SecretId
-
The ARN or name of the secret to rotate.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. See Finding a secret from a partial ARN.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Required: Yes
Response Syntax
{
"ARN": "string",
"Name": "string",
"VersionId": "string"
}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- ARN
-
The ARN of the secret.
Type: String
Length Constraints: Minimum length of 20. Maximum length of 2048.
- Name
-
The name of the secret.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
- VersionId
-
The ID of the new version of the secret.
Type: String
Length Constraints: Minimum length of 32. Maximum length of 64.
Errors
For information about the errors that are common to all actions, see Common Errors.
- InternalServiceError
-
An error occurred on the server side.
HTTP Status Code: 500
- InvalidParameterException
-
The parameter name or value is invalid.
HTTP Status Code: 400
- 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 services.
HTTP Status Code: 400
-
- ResourceNotFoundException
-
Secrets Manager can't find the resource that you asked for.
HTTP Status Code: 400
Examples
Example
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. The ClientRequestToken
field becomes the VersionId
of the new version created during the rotation. The
rotation function runs asynchronously in the background.
The JSON request string input and response output displays formatted code with white space and line breaks for better readability. Submit your input as a single line JSON string.
Sample Request
POST / HTTP/1.1
Host: secretsmanager.region.domain
Accept-Encoding: identity
X-Amz-Target: secretsmanager.RotateSecret
Content-Type: application/x-amz-json-1.1
User-Agent: <user-agent-string>
X-Amz-Date: <date>
Authorization: AWS4-HMAC-SHA256 Credential=<credentials>,SignedHeaders=<headers>, Signature=<signature>
Content-Length: <payload-size-bytes>
{
"SecretId": "MyTestDatabaseSecret",
"RotationLambdaARN": "arn:aws:lambda:us-west-2:123456789012:function:MyTestDatabaseRotationLambda",
"RotationRules": {"ScheduleExpression": "cron(0 16 1,15 * ? *)", "Duration": "2h"},
"RotateImmediately": true,
"ClientRequestToken": "EXAMPLE2-90ab-cdef-fedc-ba987SECRET2"
}
Sample Response
HTTP/1.1 200 OK
Date: <date>
Content-Type: application/x-amz-json-1.1
Content-Length: <response-size-bytes>
Connection: keep-alive
x-amzn-RequestId: <request-id-guid>
{
"ARN": "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-a1b2c3",
"Name": "MyTestDatabaseSecret",
"VersionId": "EXAMPLE2-90ab-cdef-fedc-ba987SECRET2"
}
Example
The following example configures rotation for a secret using a rate expression. The first rotation happens immediately
after the changes are stored in the secret. The rotation schedule is every 10 days. The ClientRequestToken
field becomes the VersionId
of the new version created during the rotation. The
rotation function runs asynchronously in the background.
The JSON request string input and response output displays formatted code with white space and line breaks for better readability. Submit your input as a single line JSON string.
Sample Request
POST / HTTP/1.1
Host: secretsmanager.region.domain
Accept-Encoding: identity
X-Amz-Target: secretsmanager.RotateSecret
Content-Type: application/x-amz-json-1.1
User-Agent: <user-agent-string>
X-Amz-Date: <date>
Authorization: AWS4-HMAC-SHA256 Credential=<credentials>,SignedHeaders=<headers>, Signature=<signature>
Content-Length: <payload-size-bytes>
{
"SecretId": "MyTestDatabaseSecret",
"RotationLambdaARN": "arn:aws:lambda:us-west-2:123456789012:function:MyTestDatabaseRotationLambda",
"RotationRules": {"ScheduleExpression": "rate(10 days)"},
"RotateImmediately": true,
"ClientRequestToken": "EXAMPLE2-90ab-cdef-fedc-ba987SECRET2"
}
Sample Response
HTTP/1.1 200 OK
Date: <date>
Content-Type: application/x-amz-json-1.1
Content-Length: <response-size-bytes>
Connection: keep-alive
x-amzn-RequestId: <request-id-guid>
{
"ARN": "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-a1b2c3",
"Name": "MyTestDatabaseSecret",
"VersionId": "EXAMPLE2-90ab-cdef-fedc-ba987SECRET2"
}
Example
The following example starts an immediate rotation, so the secret must already have rotation configured. The
ClientRequestToken
field becomes the VersionId
of the new
version created during the rotation. The rotation function runs asynchronously in the
background.
The JSON request string input and response output displays formatted code with white space and line breaks for better readability. Submit your input as a single line JSON string.
Sample Request
POST / HTTP/1.1
Host: secretsmanager.region.domain
Accept-Encoding: identity
X-Amz-Target: secretsmanager.RotateSecret
Content-Type: application/x-amz-json-1.1
User-Agent: <user-agent-string>
X-Amz-Date: <date>
Authorization: AWS4-HMAC-SHA256 Credential=<credentials>,SignedHeaders=<headers>, Signature=<signature>
Content-Length: <payload-size-bytes>
{
"SecretId": "MyTestDatabaseSecret",
"ClientRequestToken": "EXAMPLE2-90ab-cdef-fedc-ba987SECRET2"
}
Sample Response
HTTP/1.1 200 OK
Date: <date>
Content-Type: application/x-amz-json-1.1
Content-Length: <response-size-bytes>
Connection: keep-alive
x-amzn-RequestId: <request-id-guid>
{
"ARN": "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-a1b2c3",
"Name": "MyTestDatabaseSecret",
"VersionId": "EXAMPLE2-90ab-cdef-fedc-ba987SECRET2"
}
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: