AWSConfigRemediation-RotateSecret - Amazon Systems Manager Automation runbook reference
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

AWSConfigRemediation-RotateSecret

Description

The AWSConfigRemediation-RotateSecret runbook rotates a secret stored in Amazon Secrets Manager.

Run this Automation (console)

Document type

Automation

Owner

Amazon

Platforms

Linux, macOS, Windows

Parameters

  • AutomationAssumeRole

    Type: String

    Allowed values: ^arn:(?:aws|aws-us-gov|aws-cn):iam::\d{12}:role\/[\w+=,.@/-]+$

    Description: (Required) The Amazon Resource Name (ARN) of the Amazon Identity and Access Management (IAM) role that allows Systems Manager Automation to perform the actions on your behalf.

  • RotationInterval

    Type: Interval

    Valid values: 1-365

    Description: (Required) The number of days between rotations of the secret.

  • RotationLambdaArn

    Type: String

    Description: (Required) The Amazon Resource Name (ARN) of the Amazon Lambda funtion that can rotate the secret.

  • SecretId

    Type: String

    Description: (Required) The Amazon Resource Name (ARN) of the secret you want to rotate.

Required IAM permissions

The AutomationAssumeRole parameter requires the following actions to successfully use the runbook.

  • ssm:StartAutomationExecution

  • ssm:GetAutomationExecution

  • lambda:InvokeFunction

  • secretsmanager:DescribeSecret

  • secretsmanager:RotateSecret

Document Steps

  • aws:executeAwsApi - Rotates the secret you specify in the SecretId parameter.

  • aws:executeScript - Verifies rotation has been enabled on the secret.