Class CfnMaintenanceWindowProps.Builder
java.lang.Object
software.amazon.awscdk.services.ssm.CfnMaintenanceWindowProps.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<CfnMaintenanceWindowProps>
- Enclosing interface:
CfnMaintenanceWindowProps
@Stability(Stable)
public static final class CfnMaintenanceWindowProps.Builder
extends Object
implements software.amazon.jsii.Builder<CfnMaintenanceWindowProps>
A builder for
CfnMaintenanceWindowProps
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionallowUnassociatedTargets
(Boolean allowUnassociatedTargets) Sets the value ofCfnMaintenanceWindowProps.getAllowUnassociatedTargets()
allowUnassociatedTargets
(IResolvable allowUnassociatedTargets) Sets the value ofCfnMaintenanceWindowProps.getAllowUnassociatedTargets()
build()
Builds the configured instance.Sets the value ofCfnMaintenanceWindowProps.getCutoff()
description
(String description) Sets the value ofCfnMaintenanceWindowProps.getDescription()
Sets the value ofCfnMaintenanceWindowProps.getDuration()
Sets the value ofCfnMaintenanceWindowProps.getEndDate()
Sets the value ofCfnMaintenanceWindowProps.getName()
Sets the value ofCfnMaintenanceWindowProps.getSchedule()
scheduleOffset
(Number scheduleOffset) Sets the value ofCfnMaintenanceWindowProps.getScheduleOffset()
scheduleTimezone
(String scheduleTimezone) Sets the value ofCfnMaintenanceWindowProps.getScheduleTimezone()
Sets the value ofCfnMaintenanceWindowProps.getStartDate()
Sets the value ofCfnMaintenanceWindowProps.getTags()
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
allowUnassociatedTargets
@Stability(Stable) public CfnMaintenanceWindowProps.Builder allowUnassociatedTargets(Boolean allowUnassociatedTargets) Sets the value ofCfnMaintenanceWindowProps.getAllowUnassociatedTargets()
- 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. If enabled, then you must specify the unregistered instances (by instance ID) when you register a task with the maintenance window.- Returns:
this
-
allowUnassociatedTargets
@Stability(Stable) public CfnMaintenanceWindowProps.Builder allowUnassociatedTargets(IResolvable allowUnassociatedTargets) Sets the value ofCfnMaintenanceWindowProps.getAllowUnassociatedTargets()
- 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. If enabled, then you must specify the unregistered instances (by instance ID) when you register a task with the maintenance window.- Returns:
this
-
cutoff
Sets the value ofCfnMaintenanceWindowProps.getCutoff()
- 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
Sets the value ofCfnMaintenanceWindowProps.getDuration()
- Parameters:
duration
- The duration of the maintenance window in hours. This parameter is required.- Returns:
this
-
name
Sets the value ofCfnMaintenanceWindowProps.getName()
- Parameters:
name
- The name of the maintenance window. This parameter is required.- Returns:
this
-
schedule
Sets the value ofCfnMaintenanceWindowProps.getSchedule()
- Parameters:
schedule
- The schedule of the maintenance window in the form of a cron or rate expression. This parameter is required.- Returns:
this
-
description
Sets the value ofCfnMaintenanceWindowProps.getDescription()
- Parameters:
description
- A description of the maintenance window.- Returns:
this
-
endDate
Sets the value ofCfnMaintenanceWindowProps.getEndDate()
- Parameters:
endDate
- The date and time, in ISO-8601 Extended format, for when the maintenance window is scheduled to become inactive.- Returns:
this
-
scheduleOffset
Sets the value ofCfnMaintenanceWindowProps.getScheduleOffset()
- Parameters:
scheduleOffset
- The number of days to wait to run a maintenance window after the scheduled cron expression date and time.- Returns:
this
-
scheduleTimezone
@Stability(Stable) public CfnMaintenanceWindowProps.Builder scheduleTimezone(String scheduleTimezone) Sets the value ofCfnMaintenanceWindowProps.getScheduleTimezone()
- Parameters:
scheduleTimezone
- The time zone that the scheduled maintenance window executions are based on, in Internet Assigned Numbers Authority (IANA) format.- Returns:
this
-
startDate
Sets the value ofCfnMaintenanceWindowProps.getStartDate()
- Parameters:
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.- Returns:
this
-
tags
Sets the value ofCfnMaintenanceWindowProps.getTags()
- Parameters:
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.- Returns:
this
-
build
Builds the configured instance.- Specified by:
build
in interfacesoftware.amazon.jsii.Builder<CfnMaintenanceWindowProps>
- Returns:
- a new instance of
CfnMaintenanceWindowProps
- Throws:
NullPointerException
- if any required attribute was not provided
-