AWSConfigRemediation-EnableMultiAZOnRDSInstance
Description
The AWSConfigRemediation-EnableMultiAZOnRDSInstance
runbook changes
your Amazon Relational Database Service (Amazon RDS) database (DB) instance to a Multi-AZ deployment. Changing
this setting doesn't result in an outage. The change is applied during the next
maintenance window unless you set the ApplyImmediately
parameter to
true
.
Document type
Automation
Owner
Amazon
Platforms
Linux, macOS, Windows
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 thePreferredMaintenanceWindow
setting for the DB instance. -
AutomationAssumeRole
Type: String
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 Amazon Web Services Region-unique, immutable identifier for the DB instance to enable the
MultiAZ
setting.
Required IAM permissions
The AutomationAssumeRole
parameter requires the following actions to
use the runbook successfully.
-
rds:DescribeDBInstances
-
rds:ModifyDBInstance
-
ssm:StartAutomationExecution
-
ssm:GetAutomationExecution
Document Steps
-
aws:executeAwsApi
- Retrieves the DB instance name using the value provided in theDBInstanceId
parameter. -
aws:executeAwsApi
- Verifies theDBInstanceStatus
isavailable
. -
aws:branch
- Checks whether theMultiAZ
is already set totrue
on the DB instance you specify in theDbiResourceId
parameter. -
aws:executeAwsApi
- Changes theMultiAZ
setting totrue
on the DB instance you specify in theDbiResourceId
parameter. -
aws:assertAwsResourceProperty
- Verifies theMultiAZ
is set totrue
on the DB instance you specify in theDbiResourceId
parameter.