AWSSupport-TroubleshootECSContainerInstance - AWS Systems Manager Automation runbook reference



The AWSSupport-TroubleshootECSContainerInstance runbook helps you troubleshoot an Amazon Elastic Compute Cloud (Amazon EC2) instance that fails to register with an Amazon ECS cluster. This automation reviews whether the user data for the instance contains the correct cluster information, whether the instance profile contains the required permissions, and network configuration issues.


To successfully run this automation, the state of your Amazon EC2 instance must be running , and the Amazon ECS cluster state must be ACTIVE .

Run this Automation (console)

Document type





Linux, macOS, Windows


  • AutomationAssumeRole

    Type: String

    Description: (Optional) The Amazon Resource Name (ARN) of the AWS 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 Amazon ECS cluster that the instance failed to register with.

  • InstanceId

    Type: String

    Description: (Required) The ID of the Amazon EC2 instance you want to troubleshoot.

Required IAM permissions

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

  • ec2:DescribeIamInstanceProfileAssociations

  • ec2:DescribeInstanceAttribute

  • ec2:DescribeInstances

  • ec2:DescribeNetworkAcls

  • ec2:DescribeRouteTables

  • ec2:DescribeSecurityGroups

  • ec2:DescribeSubnets

  • ec2:DescribeVpcEndpoints

  • ec2:DescribeVpcs

  • iam:GetInstanceProfile

  • iam:GetRole

  • iam:SimulateCustomPolicy

  • iam:SimulatePrincipalPolicy

Document Steps

aws:executeScript: Reviews whether the Amazon EC2 instance meets the prerequisites needed to register with an Amazon ECS cluster.