Amazon EC2 Systems Manager
User Guide

Maintenance Window Console Walkthrough

The following walkthrough introduces you to Maintenance Windows concepts and walks you through the process of creating and configuring a maintenance window using the Amazon EC2 console. You'll configure the Maintenance Window to run on a test instance that is configured for Systems Manager. After you finish the walkthrough, you can delete the test instance.

To create a Maintenance Window

  1. Open the Amazon EC2 console, expand Systems Manager Shared Resources in the navigation pane, and then choose Maintenance Windows.

  2. Choose Create a Maintenance Window.

  3. For Name, type a descriptive name to help you identify this Maintenance Window as a test Maintenance Window.

  4. Allow unregistered targets: This option is not selected by default, which means any managed instance can execute a Maintenance Window task as long as the instance is targeted using its instance ID. Targets defined by tags must be registered.

  5. Specify a schedule for the Maintenance Window using either the schedule builder or by specifying a schedule in cron format. For more information about cron format, see Cron Schedules for Systems Manager.

  6. In the Duration field, type the number of hours the Maintenance Window should run.

  7. In the Stop initiating tasks field, type the number of hours before the end of the Maintenance Window that the system should stop scheduling new tasks to run.

  8. Choose Create maintenance window. The system returns you to the Maintenance Window page. The state of the Maintenance Window you just created is Enabled.

After you create a Maintenance Window, you assign targets where the tasks will run.

To assign targets to a Maintenance Window

  1. In the Maintenance Window list, choose the Maintenance Window you just created.

  2. From the Actions list, choose Register targets.

  3. In the Owner information field, specify your name or work alias.

  4. In the Select targets by section, choose Specifying instances.

  5. Choose the instance you created at the start of this walkthrough.

  6. Choose Register targets.

The tasks you specified run on the targets you selected according to the Maintenance Window you defined when you created the window.

After you assign targets, you assign tasks to perform during the window.

To assign tasks to a Maintenance Window

  1. In the Maintenance Window list, choose the Maintenance Window you just created.

  2. From the Actionslist, choose Register task.

  3. From the Document list, choose the SSM command document that defines the task(s) to run. For more information about creating SSM command documents, see Creating Systems Manager Documents.

  4. In the Task Priority field, specify a priority for this task. 1 is the highest priority. Tasks in a Maintenance Window are scheduled in priority order with tasks that have the same priority scheduled in parallel.

  5. In the Target by section, choose Selecting unregistered targets, and then choose the instance you created at the start of this walkthrough.

  6. In the Parameters section, specify parameters for the SSM command document.

  7. In the Role field, specify the Maintenance Windows ARN. For more information about creating a Maintenance Windows ARN, see Configuring Roles and Permissions for Maintenance Windows.

  8. The Execute on field lets you specify either a number of targets where the Maintenance Window tasks can run concurrently or a percentage of the total number of targets. This field is relevant when you target a large number of instances using tags. For the purposes of this walkthrough, specify 1.

  9. In the Stop after field, specify the number of allowed errors before the system stops sending the task to new instances.

  10. Choose Register task.