interface CfnMaintenanceWindowProps
| Language | Type name |
|---|---|
 .NET | Amazon.CDK.AWS.SSM.CfnMaintenanceWindowProps |
 Java | software.amazon.awscdk.services.ssm.CfnMaintenanceWindowProps |
 Python | aws_cdk.aws_ssm.CfnMaintenanceWindowProps |
 TypeScript | @aws-cdk/aws-ssm » CfnMaintenanceWindowProps |
Properties for defining a CfnMaintenanceWindow.
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as ssm from '@aws-cdk/aws-ssm';
const cfnMaintenanceWindowProps: ssm.CfnMaintenanceWindowProps = {
allowUnassociatedTargets: false,
cutoff: 123,
duration: 123,
name: 'name',
schedule: 'schedule',
// the properties below are optional
description: 'description',
endDate: 'endDate',
scheduleOffset: 123,
scheduleTimezone: 'scheduleTimezone',
startDate: 'startDate',
tags: [{
key: 'key',
value: 'value',
}],
};
Properties
| Name | Type | Description |
|---|---|---|
| allow | boolean | IResolvable | Enables a maintenance window task to run on managed instances, even if you have not registered those instances as targets. |
| cutoff | number | The number of hours before the end of the maintenance window that AWS Systems Manager stops scheduling new tasks for execution. |
| duration | number | The duration of the maintenance window in hours. |
| name | string | The name of the maintenance window. |
| schedule | string | The schedule of the maintenance window in the form of a cron or rate expression. |
| description? | string | A description of the maintenance window. |
| end | string | The date and time, in ISO-8601 Extended format, for when the maintenance window is scheduled to become inactive. |
| schedule | number | The number of days to wait to run a maintenance window after the scheduled cron expression date and time. |
| schedule | string | The time zone that the scheduled maintenance window executions are based on, in Internet Assigned Numbers Authority (IANA) format. |
| start | string | The date and time, in ISO-8601 Extended format, for when the maintenance window is scheduled to become active. |
| tags? | Cfn[] | Optional metadata that you assign to a resource in the form of an arbitrary set of tags (key-value pairs). |
allowUnassociatedTargets
Type:
boolean | IResolvable
Enables 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.
cutoff
Type:
number
The number of hours before the end of the maintenance window that AWS Systems Manager stops scheduling new tasks for execution.
duration
Type:
number
The duration of the maintenance window in hours.
name
Type:
string
The name of the maintenance window.
schedule
Type:
string
The schedule of the maintenance window in the form of a cron or rate expression.
description?
Type:
string
(optional)
A description of the maintenance window.
endDate?
Type:
string
(optional)
The date and time, in ISO-8601 Extended format, for when the maintenance window is scheduled to become inactive.
scheduleOffset?
Type:
number
(optional)
The number of days to wait to run a maintenance window after the scheduled cron expression date and time.
scheduleTimezone?
Type:
string
(optional)
The time zone that the scheduled maintenance window executions are based on, in Internet Assigned Numbers Authority (IANA) format.
startDate?
Type:
string
(optional)
The 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.
tags?
Type:
Cfn[]
(optional)
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.