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

Description

The AWSConfigRemediation-EnableRDSInstanceDeletionProtection runbook enables deletion protection on the Amazon RDS database instance you specify.

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.

  • DbInstanceResourceId

    Type: String

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

Required IAM permissions

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

  • ssm:StartAutomationExecution

  • ssm:GetAutomationExecution

  • rds:DescribeDBInstances

  • rds:ModifyDBInstance

Document Steps

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

  • aws:executeAwsApi - Enables deletion protection on your DB instance.

  • aws:assertAwsResourceProperty - Confirms deletion protection is enabled on the DB instance.