class CfnMaintenanceWindow (construct)

Language	Type name
.NET	`Amazon.CDK.AWS.SSM.CfnMaintenanceWindow`
Java	`software.amazon.awscdk.services.ssm.CfnMaintenanceWindow`
Python	`aws_cdk.aws_ssm.CfnMaintenanceWindow`
TypeScript	`@aws-cdk/aws-ssm` » `CfnMaintenanceWindow`

Implements IConstruct, IConstruct, IDependable, IInspectable

A CloudFormation 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 .

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 cfnMaintenanceWindow = new ssm.CfnMaintenanceWindow(this, 'MyCfnMaintenanceWindow', {
  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',
  }],
});

Initializer

new CfnMaintenanceWindow(scope: Construct, id: string, props: CfnMaintenanceWindowProps)

Parameters

scope Construct — - scope in which this resource is defined.
id string — - scoped id of the resource.
props CfnMaintenanceWindowProps — - resource properties.

Create a new AWS::SSM::MaintenanceWindow.

Construct Props

Name	Type	Description
allowUnassociatedTargets	`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.
endDate?	`string`	The date and time, in ISO-8601 Extended format, for when the maintenance window is scheduled to become inactive.
scheduleOffset?	`number`	The number of days to wait to run a maintenance window after the scheduled cron expression date and time.
scheduleTimezone?	`string`	The time zone that the scheduled maintenance window executions are based on, in Internet Assigned Numbers Authority (IANA) format.
startDate?	`string`	The 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.

Properties

Name	Type	Description
allowUnassociatedTargets	`boolean \|` `IResolvable`	Enables a maintenance window task to run on managed instances, even if you have not registered those instances as targets.
cfnOptions	`ICfnResourceOptions`	Options for this resource, such as condition, update policy etc.
cfnProperties	`{ [string]: any }`
cfnResourceType	`string`	AWS resource type.
creationStack	`string[]`
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.
logicalId	`string`	The logical ID for this CloudFormation stack element.
name	`string`	The name of the maintenance window.
node	`ConstructNode`	The construct tree node associated with this construct.
ref	`string`	Return a string that will be resolved to a CloudFormation `{ Ref }` for this element.
schedule	`string`	The schedule of the maintenance window in the form of a cron or rate expression.
stack	`Stack`	The stack in which this element is defined.
tags	`TagManager`	Optional metadata that you assign to a resource in the form of an arbitrary set of tags (key-value pairs).
description?	`string`	A description of the maintenance window.
endDate?	`string`	The date and time, in ISO-8601 Extended format, for when the maintenance window is scheduled to become inactive.
scheduleOffset?	`number`	The number of days to wait to run a maintenance window after the scheduled cron expression date and time.
scheduleTimezone?	`string`	The time zone that the scheduled maintenance window executions are based on, in Internet Assigned Numbers Authority (IANA) format.
startDate?	`string`	The date and time, in ISO-8601 Extended format, for when the maintenance window is scheduled to become active.
static CFN_RESOURCE_TYPE_NAME	`string`	The CloudFormation resource type name for this resource class.

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.

cfnOptions

Type: ICfnResourceOptions

Options for this resource, such as condition, update policy etc.

cfnProperties

Type: { [string]: any }

cfnResourceType

Type: string

AWS resource type.

creationStack

Type: string[]

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.

logicalId

Type: string

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

name

Type: string

The name of the maintenance window.

node

Type: ConstructNode

The construct tree node associated with this construct.

ref

Type: string

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

schedule

Type: string

The schedule of the maintenance window in the form of a cron or rate expression.

stack

Type: Stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

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.

static CFN_RESOURCE_TYPE_NAME

Type: string

The CloudFormation resource type name for this resource class.

Methods

Name	Description
addDeletionOverride(path)	Syntactic sugar for `addOverride(path, undefined)`.
addDependsOn(target)	Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
addMetadata(key, value)	Add a value to the CloudFormation Resource Metadata.
addOverride(path, value)	Adds an override to the synthesized CloudFormation resource.
addPropertyDeletionOverride(propertyPath)	Adds an override that deletes the value of a property from the resource definition.
addPropertyOverride(propertyPath, value)	Adds an override to a resource property.
applyRemovalPolicy(policy?, options?)	Sets the deletion policy of the resource based on the removal policy specified.
getAtt(attributeName)	Returns a token for an runtime attribute of this resource.
getMetadata(key)	Retrieve a value value from the CloudFormation Resource Metadata.
inspect(inspector)	Examines the CloudFormation resource and discloses attributes.
overrideLogicalId(newLogicalId)	Overrides the auto-generated logical ID with a specific ID.
toString()	Returns a string representation of this construct.
protected renderProperties(props)

addDeletionOverride(path)

public addDeletionOverride(path: string): void

Parameters

path string — The path of the value to delete.

Syntactic sugar for addOverride(path, undefined).

addDependsOn(target)

public addDependsOn(target: CfnResource): void

Parameters

target CfnResource

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

addMetadata(key, value)

public addMetadata(key: string, value: any): void

Parameters

key string
value any

Add a value to the CloudFormation Resource Metadata.

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)

addOverride(path, value)

public addOverride(path: string, value: any): void

Parameters

path string — - The path of the property, you can use dot notation to override values in complex types.
value any — - The value.

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with "Properties." (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example,

cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');

would add the overrides

"Properties": {
   "GlobalSecondaryIndexes": [
     {
       "Projection": {
         "NonKeyAttributes": [ "myattribute" ]
         ...
       }
       ...
     },
     {
       "ProjectionType": "INCLUDE"
       ...
     },
   ]
   ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

addPropertyDeletionOverride(propertyPath)

public addPropertyDeletionOverride(propertyPath: string): void

Parameters

propertyPath string — The path to the property.

Adds an override that deletes the value of a property from the resource definition.

addPropertyOverride(propertyPath, value)

public addPropertyOverride(propertyPath: string, value: any): void

Parameters

propertyPath string — The path of the property.
value any — The value.

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

applyRemovalPolicy(policy?, options?)

public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void

Parameters

policy RemovalPolicy
options RemovalPolicyOptions

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

getAtt(attributeName)

public getAtt(attributeName: string): Reference

Parameters

attributeName string — The name of the attribute.

Returns

Reference

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

getMetadata(key)

public getMetadata(key: string): any

Parameters

key string

Returns

any

Retrieve a value value from the CloudFormation Resource Metadata.

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)

inspect(inspector)

public inspect(inspector: TreeInspector): void

Parameters

inspector TreeInspector — - tree inspector to collect and process attributes.

Examines the CloudFormation resource and discloses attributes.

overrideLogicalId(newLogicalId)

public overrideLogicalId(newLogicalId: string): void

Parameters

newLogicalId string — The new logical ID to use for this stack element.

Overrides the auto-generated logical ID with a specific ID.

toString()

public toString(): string

Returns

string

Returns a string representation of this construct.

protected renderProperties(props)

protected renderProperties(props: { [string]: any }): { [string]: any }

Parameters

props { [string]: any }

Returns

{ [string]: any }