AWS-StartStopAuroraCluster - 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).



This runbook starts or stops an Amazon Aurora cluster.


To start a cluster it must be in a stopped status. To stop a cluster it must be in an available status. This runbook can't be used to start or stop a cluster that is an Aurora Serverless cluster, an Aurora multi-master cluster, part of an Aurora global database, or a cluster that uses Aurora parallel query.

Run this Automation (console)

Document type







  • AutomationAssumeRole

    Type: String

    Description: (Optional) 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. If no role is specified, Systems Manager Automation uses the permissions of the user that starts this runbook.

  • ClusterName

    Type: String

    Description: (Required) The name of the Aurora cluster you want to stop or start.

  • Action

    Type: String

    Valid values: Start | Stop

    Default: Start

    Description: (Required) The name of the Aurora cluster you want to stop or start.

Required IAM permissions

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

  • rds:DescribeDBClusters

  • rds:StartDBCluster

  • rds:StopDBCluster

Document Steps

  • aws:executeScript - Starts or stops the cluster based on the values you specify for the.


StartStopAuroraCluster.ClusterName - The name of the Aurora cluster

StartStopAuroraCluster.CurrentStatus - The current status of the Aurora cluster

StartStopAuroraCluster.Message - Details of the automation