Sign In to the Console
AWS CloudFormation
User Guide (API Version 2010-05-15)

AWS Documentation » AWS CloudFormation » User Guide » Template Reference » AWS Resource and Property Types Reference » AWS Systems Manager Resource Types Reference » AWS::SSM::MaintenanceWindow

AWS::SSM::MaintenanceWindow

The AWS::SSM::MaintenanceWindow resource represents general information about a Maintenance Window for AWS 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 AWS Systems Manager User Guide and CreateMaintenanceWindow in the AWS Systems Manager API Reference.

Syntax

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

JSON

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

YAML

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

Properties

Name

The name of the Maintenance Window.

Required: Yes

Type: String

Update requires: No interruption

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

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

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

StartDate

The date and time, in ISO-8601 Extended format, for when you want the Maintenance Window to become active. StartDate allows you to delay activation of the Maintenance Window until the specified future date.

Required: No

Type: String

Update requires: No interruption

EndDate

The date and time, in ISO-8601 Extended format, for when you want the Maintenance Window to become inactive. EndDate allows you to set a date and time in the future when the Maintenance Window will no longer run.

Required: No

Type: String

Update requires: No interruption

ScheduleTimezone

The time zone that the scheduled Maintenance Window executions are based on, in Internet Assigned Numbers Authority (IANA) format. For example: "America/Los_Angeles", "etc/UTC", or "Asia/Seoul". For more information, see the Time Zone Database on the IANA website.

Required: No

Type: String

Update requires: No interruption

Return Values

Ref

When you pass the logical ID of an AWS::SSM::MaintenanceWindow resource to the intrinsic Ref function, the function returns the maintenance window ID, such as mw-abcde1234567890yz.

For more information about using the Ref function, see Ref.

See Also