Package software.amazon.awscdk.cfnpropertymixins.services.ssm

Interface CfnMaintenanceWindowMixinProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnMaintenanceWindowMixinProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)",
           date="2026-03-11T13:20:05.678Z")
@Stability(Stable)
public interface CfnMaintenanceWindowMixinProps
extends software.amazon.jsii.JsiiSerializable

Properties for CfnMaintenanceWindowPropsMixin.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.cfnpropertymixins.services.ssm.*;
 CfnMaintenanceWindowMixinProps cfnMaintenanceWindowMixinProps = CfnMaintenanceWindowMixinProps.builder()
         .allowUnassociatedTargets(false)
         .cutoff(123)
         .description("description")
         .duration(123)
         .endDate("endDate")
         .name("name")
         .schedule("schedule")
         .scheduleOffset(123)
         .scheduleTimezone("scheduleTimezone")
         .startDate("startDate")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindow.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnMaintenanceWindowMixinProps.Builder	A builder for CfnMaintenanceWindowMixinProps
static final class	CfnMaintenanceWindowMixinProps.Jsii$Proxy	An implementation for CfnMaintenanceWindowMixinProps

Method Summary

Modifier and Type	Method	Description
static CfnMaintenanceWindowMixinProps.Builder	builder()
default Object	getAllowUnassociatedTargets()	Enables a maintenance window task to run on managed instances, even if you have not registered those instances as targets.
default Number	getCutoff()	The number of hours before the end of the maintenance window that AWS Systems Manager stops scheduling new tasks for execution.
default String	getDescription()	A description of the maintenance window.
default Number	getDuration()	The duration of the maintenance window in hours.
default String	getEndDate()	The date and time, in ISO-8601 Extended format, for when the maintenance window is scheduled to become inactive.
default String	getName()	The name of the maintenance window.
default String	getSchedule()	The schedule of the maintenance window in the form of a cron or rate expression.
default Number	getScheduleOffset()	The number of days to wait to run a maintenance window after the scheduled cron expression date and time.
default String	getScheduleTimezone()	The time zone that the scheduled maintenance window executions are based on, in Internet Assigned Numbers Authority (IANA) format.
default String	getStartDate()	The date and time, in ISO-8601 Extended format, for when the maintenance window is scheduled to become active.
default List<CfnTag>	getTags()	Optional metadata that you assign to a resource in the form of an arbitrary set of tags (key-value pairs).

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAllowUnassociatedTargets

@Stability(Stable)
@Nullable
default Object getAllowUnassociatedTargets()

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.

Returns union: either Boolean or IResolvable

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindow.html#cfn-ssm-maintenancewindow-allowunassociatedtargets

getCutoff

@Stability(Stable)
@Nullable
default Number getCutoff()

The number of hours before the end of the maintenance window that AWS Systems Manager stops scheduling new tasks for execution.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindow.html#cfn-ssm-maintenancewindow-cutoff

getDescription

@Stability(Stable)
@Nullable
default String getDescription()

A description of the maintenance window.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindow.html#cfn-ssm-maintenancewindow-description

getDuration

@Stability(Stable)
@Nullable
default Number getDuration()

The duration of the maintenance window in hours.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindow.html#cfn-ssm-maintenancewindow-duration

getEndDate

@Stability(Stable)
@Nullable
default String getEndDate()

The date and time, in ISO-8601 Extended format, for when the maintenance window is scheduled to become inactive.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindow.html#cfn-ssm-maintenancewindow-enddate

getName

@Stability(Stable)
@Nullable
default String getName()

The name of the maintenance window.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindow.html#cfn-ssm-maintenancewindow-name

getSchedule

@Stability(Stable)
@Nullable
default String getSchedule()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindow.html#cfn-ssm-maintenancewindow-schedule

getScheduleOffset

@Stability(Stable)
@Nullable
default Number getScheduleOffset()

The number of days to wait to run a maintenance window after the scheduled cron expression date and time.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindow.html#cfn-ssm-maintenancewindow-scheduleoffset

getScheduleTimezone

@Stability(Stable)
@Nullable
default String getScheduleTimezone()

The time zone that the scheduled maintenance window executions are based on, in Internet Assigned Numbers Authority (IANA) format.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindow.html#cfn-ssm-maintenancewindow-scheduletimezone

getStartDate

@Stability(Stable)
@Nullable
default String getStartDate()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindow.html#cfn-ssm-maintenancewindow-startdate

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindow.html#cfn-ssm-maintenancewindow-tags

builder

@Stability(Stable)
static CfnMaintenanceWindowMixinProps.Builder builder()

Returns:

a CfnMaintenanceWindowMixinProps.Builder of CfnMaintenanceWindowMixinProps