AWS::SSM::MaintenanceWindowCfnMaintenanceWindow
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](https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-maintenance.html) in the *AWS Systems Manager User Guide* and [CreateMaintenanceWindow](https://docs.aws.amazon.com/systems-manager/latest/APIReference/API_CreateMaintenanceWindow.html) in the *AWS Systems Manager API Reference* .
Import
import { CfnMaintenanceWindow } from 'aws-cdk-lib/aws-ssm';Or use the module namespace:
import * as ssm from 'aws-cdk-lib/aws-ssm';
// ssm.CfnMaintenanceWindowProperties
Configuration passed to the constructor as CfnMaintenanceWindowProps.
allowUnassociatedTargetsRequiredboolean | IResolvableEnables a maintenance window task to run on managed instances, even if you have not registered those instances as targets. If enabled, then you must specify the unregistered instances (by instance ID) when you register a task with the maintenance window.
cutoffRequirednumberThe number of hours before the end of the maintenance window that AWS Systems Manager stops scheduling new tasks for execution.
durationRequirednumberThe duration of the maintenance window in hours.
nameRequiredstringThe name of the maintenance window.
scheduleRequiredstringThe schedule of the maintenance window in the form of a cron or rate expression.
descriptionOptionalstringA description of the maintenance window.
endDateOptionalstringThe date and time, in ISO-8601 Extended format, for when the maintenance window is scheduled to become inactive.
scheduleOffsetOptionalnumberThe number of days to wait to run a maintenance window after the scheduled cron expression date and time.
scheduleTimezoneOptionalstringThe time zone that the scheduled maintenance window executions are based on, in Internet Assigned Numbers Authority (IANA) format.
startDateOptionalstringThe date and time, in ISO-8601 Extended format, for when the maintenance window is scheduled to become active. `StartDate` allows you to delay activation of the maintenance window until the specified future date.
tagsOptionalCfnTag[]Optional metadata that you assign to a resource in the form of an arbitrary set of tags (key-value pairs). Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag a maintenance window to identify the type of tasks it will run, the types of targets, and the environment it will run in.
CloudFormation Resource
This L1 construct maps directly to the following CloudFormation resource type.
Learn AWS the Practical Way
Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.
Subscribe to NewsletterQuick Facts
aws-ssmAWS::SSM::MaintenanceWindow