rotateSecret

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.

Samples

import aws.sdk.kotlin.services.secretsmanager.model.RotationRulesType

fun main() { 
   //sampleStart 
   // 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.
val resp = secretsManagerClient.rotateSecret {
    secretId = "MyTestDatabaseSecret"
    rotationLambdaArn = "arn:aws:lambda:us-west-2:123456789012:function:MyTestDatabaseRotationLambda"
    rotationRules = RotationRulesType {
        scheduleExpression = "cron(0 16 1,15 * ? *)"
        duration = "2h"
    }
} 
   //sampleEnd
}

import aws.sdk.kotlin.services.secretsmanager.model.RotationRulesType

fun main() { 
   //sampleStart 
   // 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.
val resp = secretsManagerClient.rotateSecret {
    secretId = "MyTestDatabaseSecret"
} 
   //sampleEnd
}