Create service roles for Automation by using Amazon CloudFormation - Amazon Systems Manager
Create the service role using Amazon CloudFormationCopy role information for Automation
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).

Create service roles for Automation by using Amazon CloudFormation

You can create a service role for Automation, a capability of Amazon Systems Manager, from an Amazon CloudFormation template. After you create the service role, you can specify the service role in runbooks using the parameter AutomationAssumeRole.

Create the service role using Amazon CloudFormation

Use the following procedure to create the required Amazon Identity and Access Management (IAM) role for Systems Manager Automation by using Amazon CloudFormation.

To create the required IAM role

  1. Download and unzip the AWS-SystemsManager-AutomationServiceRole.zip file. This file includes the AWS-SystemsManager-AutomationServiceRole.yaml Amazon CloudFormation template file.

  2. Open the Amazon CloudFormation console at https://console.amazonaws.cn/cloudformation.

  3. Choose Create Stack.

  4. In the Specify template section, choose Upload a template file.

  5. Choose Browse, and then choose the AWS-SystemsManager-AutomationServiceRole.yaml Amazon CloudFormation template file.

  6. Choose Next.

  7. On the Specify stack details page, in the Stack name field, enter a name.

  8. On the Configure stack options page, you don’t need to make any selections. Choose Next.

  9. On the Review page, scroll down and choose the I acknowledge that Amazon CloudFormation might create IAM resources option.

  10. Choose Create.

CloudFormation shows the CREATE_IN_PROGRESS status for approximately three minutes. The status changes to CREATE_COMPLETE after the stack is created and your roles are ready to use.

Important

If you run an automation workflow that invokes other services by using an Amazon Identity and Access Management (IAM) service role, be aware that the service role must be configured with permission to invoke those services. This requirement applies to all Amazon Automation runbooks (AWS-* runbooks) such as the AWS-ConfigureS3BucketLogging, AWS-CreateDynamoDBBackup, and AWS-RestartEC2Instance runbooks, to name a few. This requirement also applies to any custom Automation runbooks you create that invoke other Amazon Web Services by using actions that call other services. For example, if you use the aws:executeAwsApi, aws:createStack, or aws:copyImage actions, configure the service role with permission to invoke those services. You can give permissions to other Amazon Web Services by adding an IAM inline policy to the role. For more information, see (Optional) Add an Automation inline policy or customer managed policy to invoke other Amazon Web Services.

Copy role information for Automation

Use the following procedure to copy information about the Automation service role from the Amazon CloudFormation console. You must specify these roles when you use a runbook.

Note

You don't need to copy role information using this procedure if you run the AWS-UpdateLinuxAmi or AWS-UpdateWindowsAmi runbooks. These runbooks already have the required roles specified as default values. The roles specified in these runbooks use IAM managed policies.

To copy the role names

  1. Open the Amazon CloudFormation console at https://console.amazonaws.cn/cloudformation.

  2. Select the Automation Stack name you created in the previous procedure.

  3. Choose the Resources tab.

  4. Choose the Physical ID link for AutomationServiceRole. The IAM console opens to a summary of the Automation service role.

  5. Copy the Amazon Resource Name (ARN) next to Role ARN. The ARN is similar to the following: arn:aws-cn:iam::12345678:role/AutomationServiceRole

  6. Paste the ARN into a text file to use later.

You have finished configuring the service role for Automation. You can now use the Automation service role ARN in your runbooks.