software.amazon.awscdk.services.ssm

Interface CfnMaintenanceWindowProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnMaintenanceWindowProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-28T21:34:20.908Z")
 @Stability(value=Stable)
public interface CfnMaintenanceWindowProps
extends software.amazon.jsii.JsiiSerializable

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 software.amazon.awscdk.services.ssm.*;
 CfnMaintenanceWindowProps cfnMaintenanceWindowProps = CfnMaintenanceWindowProps.builder()
         .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(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static CfnMaintenanceWindowProps.Builder	builder()
Object	getAllowUnassociatedTargets() Enables a maintenance window task to run on managed instances, even if you have not registered those instances as targets.
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.
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.
String	getName() The name of the maintenance window.
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 Detail

getAllowUnassociatedTargets

@Stability(value=Stable)
 @NotNull
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.

getCutoff

@Stability(value=Stable)
 @NotNull
Number getCutoff()

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

getDuration

@Stability(value=Stable)
 @NotNull
Number getDuration()

The duration of the maintenance window in hours.

getName

@Stability(value=Stable)
 @NotNull
String getName()

The name of the maintenance window.

getSchedule

@Stability(value=Stable)
 @NotNull
String getSchedule()

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

getDescription

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

A description of the maintenance window.

getEndDate

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

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

getScheduleOffset

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

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

getScheduleTimezone

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

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

getStartDate

@Stability(value=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.

getTags

@Stability(value=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.

builder

@Stability(value=Stable)
static CfnMaintenanceWindowProps.Builder builder()

Returns:

a CfnMaintenanceWindowProps.Builder of CfnMaintenanceWindowProps