Package software.amazon.awscdk.services.ssm

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 Type	Method	Description
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.
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.
CfnMaintenanceWindow	build()
static CfnMaintenanceWindow.Builder	create(software.constructs.Construct scope, String id)
CfnMaintenanceWindow.Builder	cutoff(Number cutoff)	The number of hours before the end of the maintenance window that AWS Systems Manager stops scheduling new tasks for execution.
CfnMaintenanceWindow.Builder	description(String description)	A description of the maintenance window.
CfnMaintenanceWindow.Builder	duration(Number duration)	The duration of the maintenance window in hours.
CfnMaintenanceWindow.Builder	endDate(String endDate)	The date and time, in ISO-8601 Extended format, for when the maintenance window is scheduled to become inactive.
CfnMaintenanceWindow.Builder	name(String name)	The name of the maintenance window.
CfnMaintenanceWindow.Builder	schedule(String schedule)	The schedule of the maintenance window in the form of a cron or rate expression.
CfnMaintenanceWindow.Builder	scheduleOffset(Number scheduleOffset)	The number of days to wait to run a maintenance window after the scheduled cron expression date and time.
CfnMaintenanceWindow.Builder	scheduleTimezone(String scheduleTimezone)	The time zone that the scheduled maintenance window executions are based on, in Internet Assigned Numbers Authority (IANA) format.
CfnMaintenanceWindow.Builder	startDate(String startDate)	The date and time, in ISO-8601 Extended format, for when the maintenance window is scheduled to become active.
CfnMaintenanceWindow.Builder	tags(List<? extends CfnTag> tags)	Optional metadata that you assign to a resource in the form of an arbitrary set of tags (key-value pairs).

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

create

@Stability(Stable)
public static CfnMaintenanceWindow.Builder create(software.constructs.Construct scope,
 String id)

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

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

See Also:

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

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

See Also:

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

cutoff

@Stability(Stable)
public CfnMaintenanceWindow.Builder cutoff(Number 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

See Also:

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

duration

@Stability(Stable)
public CfnMaintenanceWindow.Builder duration(Number 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

See Also:

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

name

@Stability(Stable)
public CfnMaintenanceWindow.Builder name(String name)

The name of the maintenance window.

Parameters:

name - The name of the maintenance window. This parameter is required.

Returns:

this

See Also:

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

schedule

@Stability(Stable)
public CfnMaintenanceWindow.Builder schedule(String 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

See Also:

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

description

@Stability(Stable)
public CfnMaintenanceWindow.Builder description(String description)

A description of the maintenance window.

Parameters:

description - A description of the maintenance window. This parameter is required.

Returns:

this

See Also:

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

endDate

@Stability(Stable)
public CfnMaintenanceWindow.Builder endDate(String 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

See Also:

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

scheduleOffset

@Stability(Stable)
public CfnMaintenanceWindow.Builder scheduleOffset(Number 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

See Also:

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

scheduleTimezone

@Stability(Stable)
public CfnMaintenanceWindow.Builder scheduleTimezone(String 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

See Also:

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

startDate

@Stability(Stable)
public CfnMaintenanceWindow.Builder startDate(String 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

See Also:

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

tags

@Stability(Stable)
public CfnMaintenanceWindow.Builder tags(List<? extends CfnTag> 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

See Also:

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

build

@Stability(Stable)
public CfnMaintenanceWindow build()

Specified by:

build in interface software.amazon.jsii.Builder<CfnMaintenanceWindow>

Returns:

a newly built instance of CfnMaintenanceWindow.