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

Description

The AWSConfigRemediation-EnableCopyTagsToSnapshotOnRDSDBInstance runbook enables the CopyTagsToSnapshot setting on the Amazon Relational Database Service (Amazon RDS) instance you specify. Enabling this setting copies all tags from the DB instance to snapshots of the DB instance. The default is not to copy them. Amazon Config must be enabled in the Amazon Web Services Region where you run this automation.

Run this Automation (console)

Document type

Automation

Owner

Amazon

Platforms

Databases

Parameters

  • ApplyImmediately

    Type: Boolean

    Default: false

    Description: (Optional) If you specify true for this parameter, the modifications in this request and any pending modifications are asynchronously applied as soon as possible, regardless of the PreferredMaintenanceWindow setting for the DB instance.

  • 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.

  • DbiResourceId

    Type: String

    Description: (Required) The resource identifier for the DB instance you want to enable the CopyTagsToSnapshot setting on.

Required IAM permissions

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

  • ssm:StartAutomationExecution

  • ssm:GetAutomationExecution

  • config:GetResourceConfigHistory

  • rds:DescribeDBInstances

  • rds:ModifyDBInstance

Document Steps

  • aws:executeAwsApi - Gathers the DB instance identifier from the DB instance resource identifier.

  • aws:assertAwsResourceProperty - Confirms the DB instance is in an AVAILABLE state.

  • aws:executeAwsApi - Enables the CopyTagsToSnapshot setting on your DB instance.

  • aws:assertAwsResourceProperty - Confirms the CopyTagsToSnapshot setting is enabled on your DB instance.