aws-cdk-lib.aws_ssm.CfnMaintenanceWindowProps

interface CfnMaintenanceWindowProps

LanguageType name
.NETAmazon.CDK.AWS.SSM.CfnMaintenanceWindowProps
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsssm#CfnMaintenanceWindowProps
Javasoftware.amazon.awscdk.services.ssm.CfnMaintenanceWindowProps
Pythonaws_cdk.aws_ssm.CfnMaintenanceWindowProps
TypeScript aws-cdk-lib » 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 { aws_ssm as ssm } from 'aws-cdk-lib';
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

NameTypeDescription
allowUnassociatedTargetsboolean | IResolvableEnables a maintenance window task to run on managed instances, even if you have not registered those instances as targets.
cutoffnumberThe number of hours before the end of the maintenance window that AWS Systems Manager stops scheduling new tasks for execution.
durationnumberThe duration of the maintenance window in hours.
namestringThe name of the maintenance window.
schedulestringThe schedule of the maintenance window in the form of a cron or rate expression.
description?stringA description of the maintenance window.
endDate?stringThe date and time, in ISO-8601 Extended format, for when the maintenance window is scheduled to become inactive.
scheduleOffset?numberThe number of days to wait to run a maintenance window after the scheduled cron expression date and time.
scheduleTimezone?stringThe time zone that the scheduled maintenance window executions are based on, in Internet Assigned Numbers Authority (IANA) format.
startDate?stringThe date and time, in ISO-8601 Extended format, for when the maintenance window is scheduled to become active.
tags?CfnTag[]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: CfnTag[] (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.