Class CfnMaintenanceWindow.Builder
java.lang.Object
software.amazon.awscdk.services.ssm.CfnMaintenanceWindow.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<CfnMaintenanceWindow>
- Enclosing class:
CfnMaintenanceWindow
@Stability(Stable)
public static final class CfnMaintenanceWindow.Builder
extends Object
implements software.amazon.jsii.Builder<CfnMaintenanceWindow>
A fluent builder for
CfnMaintenanceWindow
.-
Method Summary
Modifier and TypeMethodDescriptionallowUnassociatedTargets
(Boolean allowUnassociatedTargets) Enables a maintenance window task to run on managed instances, even if you have not registered those instances as targets.allowUnassociatedTargets
(IResolvable allowUnassociatedTargets) Enables a maintenance window task to run on managed instances, even if you have not registered those instances as targets.build()
static CfnMaintenanceWindow.Builder
The number of hours before the end of the maintenance window that AWS Systems Manager stops scheduling new tasks for execution.description
(String description) A description of the maintenance window.The duration of the maintenance window in hours.The date and time, in ISO-8601 Extended format, for when the maintenance window is scheduled to become inactive.The name of the maintenance window.The schedule of the maintenance window in the form of a cron or rate expression.scheduleOffset
(Number scheduleOffset) The number of days to wait to run a maintenance window after the scheduled cron expression date and time.scheduleTimezone
(String scheduleTimezone) The time zone that the scheduled maintenance window executions are based on, in Internet Assigned Numbers Authority (IANA) format.The date and time, in ISO-8601 Extended format, for when the maintenance window is scheduled to become active.Optional metadata that you assign to a resource in the form of an arbitrary set of tags (key-value pairs).
-
Method Details
-
create
- Parameters:
scope
-- scope in which this resource is defined.
id
-- scoped id of the resource.
- Returns:
- a new instance of
CfnMaintenanceWindow.Builder
.
-
allowUnassociatedTargets
@Stability(Stable) public CfnMaintenanceWindow.Builder allowUnassociatedTargets(Boolean allowUnassociatedTargets) 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.
- Parameters:
allowUnassociatedTargets
- Enables a maintenance window task to run on managed instances, even if you have not registered those instances as targets. This parameter is required.- Returns:
this
-
allowUnassociatedTargets
@Stability(Stable) public CfnMaintenanceWindow.Builder allowUnassociatedTargets(IResolvable allowUnassociatedTargets) 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.
- Parameters:
allowUnassociatedTargets
- Enables a maintenance window task to run on managed instances, even if you have not registered those instances as targets. This parameter is required.- Returns:
this
-
cutoff
The number of hours before the end of the maintenance window that AWS Systems Manager stops scheduling new tasks for execution.- Parameters:
cutoff
- The number of hours before the end of the maintenance window that AWS Systems Manager stops scheduling new tasks for execution. This parameter is required.- Returns:
this
-
duration
The duration of the maintenance window in hours.- Parameters:
duration
- The duration of the maintenance window in hours. This parameter is required.- Returns:
this
-
name
The name of the maintenance window.- Parameters:
name
- The name of the maintenance window. This parameter is required.- Returns:
this
-
schedule
The schedule of the maintenance window in the form of a cron or rate expression.- Parameters:
schedule
- The schedule of the maintenance window in the form of a cron or rate expression. This parameter is required.- Returns:
this
-
description
A description of the maintenance window.- Parameters:
description
- A description of the maintenance window. This parameter is required.- Returns:
this
-
endDate
The date and time, in ISO-8601 Extended format, for when the maintenance window is scheduled to become inactive.- Parameters:
endDate
- The date and time, in ISO-8601 Extended format, for when the maintenance window is scheduled to become inactive. This parameter is required.- Returns:
this
-
scheduleOffset
The number of days to wait to run a maintenance window after the scheduled cron expression date and time.- Parameters:
scheduleOffset
- The number of days to wait to run a maintenance window after the scheduled cron expression date and time. This parameter is required.- Returns:
this
-
scheduleTimezone
The time zone that the scheduled maintenance window executions are based on, in Internet Assigned Numbers Authority (IANA) format.- Parameters:
scheduleTimezone
- The time zone that the scheduled maintenance window executions are based on, in Internet Assigned Numbers Authority (IANA) format. This parameter is required.- Returns:
this
-
startDate
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.
- Parameters:
startDate
- The date and time, in ISO-8601 Extended format, for when the maintenance window is scheduled to become active. This parameter is required.- Returns:
this
-
tags
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.
- Parameters:
tags
- Optional metadata that you assign to a resource in the form of an arbitrary set of tags (key-value pairs). This parameter is required.- Returns:
this
-
build
- Specified by:
build
in interfacesoftware.amazon.jsii.Builder<CfnMaintenanceWindow>
- Returns:
- a newly built instance of
CfnMaintenanceWindow
.
-