AWSConfigRemediation-EnableKeyRotation - 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-EnableKeyRotation

Description

The AWSConfigRemediation-EnableKeyRotation runbook enables automatic key rotation for the symmetric Amazon Key Management Service (Amazon KMS) customer managed key.

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.

  • KeyId

    Type: String

    Description: (Required) The ID of the customer managed key you want to enable automatic key rotation on.

Required IAM permissions

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

  • ssm:StartAutomationExecution

  • ssm:GetAutomationExecution

  • kms:EnableKeyRotation

  • kms:GetKeyRotationStatus

Document Steps

  • aws:executeAwsApi - Enables automatic key rotation on the customer managed key you specify in the KeyId parameter.

  • aws:assertAwsResourceProperty - Confirms that automatic key rotation is enabled on your customer managed key.