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

Description

The AWSConfigRemediation-DeleteRDSClusterSnapshot runbook deletes the given Amazon Relational Database Service (Amazon RDS) cluster snapshot.

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.

  • DBClusterSnapshotId

    Type: String

    Description: (Required) The Amazon RDS cluster snapshot identifier to be deleted.

Required IAM permissions

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

  • ssm:StartAutomationExecution

  • ssm:GetAutomationExecution

  • rds:DeleteDBClusterSnapshot

  • rds:DescribeDBClusterSnapshots

Document Steps

  • aws:branch - Checks if the cluster snapshot is in the available state. If it is not available, the flow ends.

  • aws:executeAwsApi - Deletes the given Amazon RDS cluster snapshot using the database (DB) cluster snapshot identifier.

  • aws:executeScript - Verifies that the given Amazon RDS cluster snapshot was deleted.