AWSSupport-ExecuteEC2Rescue - 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).

AWSSupport-ExecuteEC2Rescue

Description

This runbook uses the EC2Rescue tool to troubleshoot and, where possible, repair common connectivity issues with the specified Amazon Elastic Compute Cloud (Amazon EC2) instance for Linux or Windows Server. Instances with encrypted root volumes are not supported.

Run this Automation (console)

Document type

Automation

Owner

Amazon

Platforms

Linux, macOS, Windows

Parameters

  • 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.

  • EC2RescueInstanceType

    Type: String

    Valid values: t2.small | t2.medium | t2.large

    Default: t2.small

    Description: (Required) The EC2 instance type for the EC2Rescue instance. Recommended size: t2.small

  • LogDestination

    Type: String

    Description: (Optional) Amazon S3 bucket name in your account where you want to upload the troubleshooting logs. Make sure the bucket policy does not grant unnecessary read/write permissions to parties that do not need access to the collected logs.

  • SubnetId

    Type: String

    Default: CreateNewVPC

    Description: (Optional) The subnet ID for the EC2Rescue instance. By default, Amazon Systems Manager Automation creates a new VPC. Alternatively, use SelectedInstanceSubnet to use the same subnet as your instance, or specify a custom subnet ID.

    Important

    The subnet must be in the same Availability Zone as UnreachableInstanceId, and it must allow access to the SSM endpoints.

  • UnreachableInstanceId

    Type: String

    Description: (Required) ID of your unreachable EC2 instance.

    Important

    Systems Manager Automation stops this instance, and creates an AMI before attempting any operations. Data stored in instance store volumes will be lost. The public IP address will change if you are not using an Elastic IP address.

Required IAM permissions

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

You must have at least ssm:StartAutomationExecution and ssm:GetAutomationExecution to be able to read the automation output. For more information about the required permissions, see AWSSupport-StartEC2RescueWorkflow.

Document Steps

  1. aws:assertAwsResourceProperty - Asserts if the provided instance is Windows Server:

    1. (EC2Rescue for Windows Server) If the provided instance is a Windows Server instance:

      1. aws:executeAutomation - Invokes AWSSupport-StartEC2RescueWorkflow with the EC2Rescue for Windows Server offline script.

      2. aws:executeAwsApi - Retrieves the backup AMI ID from the nested automation.

      3. aws:executeAwsApi - Retrieves the EC2Rescue summary from the nested automation.

    2. (EC2Rescue for Linux) If the provided instance is a Linux instance:

      1. aws:executeAutomation - Invokes AWSSupport-StartEC2RescueWorkflow with the EC2Rescue for Linux offline scripts

      2. aws:executeAwsApi - Retrieves the backup AMI ID from the nested automation.

      3. aws:executeAwsApi - Retrieves the EC2Rescue summary from the nested automation.

Outputs

getEC2RescueForWindowsResult.Output

getWindowsBackupAmi.ImageId

getEC2RescueForLinuxResult.Output

getLinuxBackupAmi.ImageId