Menu
AWS CloudFormation
User Guide (API Version 2010-05-15)

AWS::SSM::MaintenanceWindow

The AWS::SSM::MaintenanceWindow resource represents general information about a Maintenance Window for Amazon EC2 Systems Manager. Maintenance Windows let you define a schedule for when to perform potentially disruptive actions on your instances—such as patching an operating system (OS), updating drivers, or installing software. Each Maintenance Window has a schedule, a duration, a set of registered targets, and a set of registered tasks. For more information, see Systems Manager Maintenance Windows in the Amazon EC2 Systems Manager User Guide and CreateMaintenanceWindow in the Amazon EC2 Systems Manager API Reference.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

Copy
{ "Type" : "AWS::SSM::MaintenanceWindow", "Properties" : { "Description" : String, "AllowUnassociatedTargets" : Boolean, "Cutoff" : Integer, "Schedule" : String, "Duration" : Integer, "Name" : String } }

YAML

Copy
Type: "AWS::SSM::MaintenanceWindow" Properties: Description: String AllowUnassociatedTargets: Boolean Cutoff: Integer Schedule: String Duration: Integer Name: String

Properties

Description

A description of the Maintenance Window.

Required: No

Type: String

Update requires: No interruption

AllowUnassociatedTargets

Enables a Maintenance Window task to execute on managed instances, even if you haven't registered those instances as targets. If this is enabled, then you must specify the unregistered instances (by instance ID) when you register a task with the Maintenance Window.

Required: Yes

Type: Boolean

Update requires: No interruption

Cutoff

The number of hours before the end of the Maintenance Window that Systems Manager stops scheduling new tasks for execution.

Required: Yes

Type: Integer

Update requires: No interruption

Schedule

The schedule of the Maintenance Window in the form of a cron or rate expression.

Required: Yes

Type: String

Update requires: No interruption

Duration

The duration of the Maintenance Window in hours.

Required: Yes

Type: Integer

Update requires: No interruption

Name

The name of the Maintenance Window.

Required: Yes

Type: String

Update requires: No interruption

See Also

On this page: