software.amazon.awssdk.services.ssm.model

Interface CreateMaintenanceWindowRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<CreateMaintenanceWindowRequest.Builder,CreateMaintenanceWindowRequest>, SdkBuilder<CreateMaintenanceWindowRequest.Builder,CreateMaintenanceWindowRequest>, SdkPojo, SdkRequest.Builder, SsmRequest.Builder

Enclosing class:

CreateMaintenanceWindowRequest

public static interface CreateMaintenanceWindowRequest.Builder
extends SsmRequest.Builder, SdkPojo, CopyableBuilder<CreateMaintenanceWindowRequest.Builder,CreateMaintenanceWindowRequest>

Method Summary

Modifier and Type	Method and Description
CreateMaintenanceWindowRequest.Builder	allowUnassociatedTargets(Boolean allowUnassociatedTargets) Enables a Maintenance Window task to execute on managed instances, even if you have not registered those instances as targets.
CreateMaintenanceWindowRequest.Builder	clientToken(String clientToken) User-provided idempotency token.
CreateMaintenanceWindowRequest.Builder	cutoff(Integer cutoff) The number of hours before the end of the Maintenance Window that Systems Manager stops scheduling new tasks for execution.
CreateMaintenanceWindowRequest.Builder	description(String description) An optional description for the Maintenance Window.
CreateMaintenanceWindowRequest.Builder	duration(Integer duration) The duration of the Maintenance Window in hours.
CreateMaintenanceWindowRequest.Builder	endDate(String endDate) The date and time, in ISO-8601 Extended format, for when you want the Maintenance Window to become inactive.
CreateMaintenanceWindowRequest.Builder	name(String name) The name of the Maintenance Window.
CreateMaintenanceWindowRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.
CreateMaintenanceWindowRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.
CreateMaintenanceWindowRequest.Builder	schedule(String schedule) The schedule of the Maintenance Window in the form of a cron or rate expression.
CreateMaintenanceWindowRequest.Builder	scheduleTimezone(String scheduleTimezone) The time zone that the scheduled Maintenance Window executions are based on, in Internet Assigned Numbers Authority (IANA) format.
CreateMaintenanceWindowRequest.Builder	startDate(String startDate) The date and time, in ISO-8601 Extended format, for when you want the Maintenance Window to become active.

Methods inherited from interface software.amazon.awssdk.services.ssm.model.SsmRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

name

CreateMaintenanceWindowRequest.Builder name(String name)

The name of the Maintenance Window.

Parameters:

name - The name of the Maintenance Window.

Returns:

Returns a reference to this object so that method calls can be chained together.

description

CreateMaintenanceWindowRequest.Builder description(String description)

An optional description for the Maintenance Window. We recommend specifying a description to help you organize your Maintenance Windows.

Parameters:

description - An optional description for the Maintenance Window. We recommend specifying a description to help you organize your Maintenance Windows.

Returns:

Returns a reference to this object so that method calls can be chained together.

startDate

CreateMaintenanceWindowRequest.Builder startDate(String startDate)

The date and time, in ISO-8601 Extended format, for when you want the Maintenance Window 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 you want the Maintenance Window to become active. StartDate allows you to delay activation of the Maintenance Window until the specified future date.

Returns:

Returns a reference to this object so that method calls can be chained together.

endDate

CreateMaintenanceWindowRequest.Builder endDate(String endDate)

The date and time, in ISO-8601 Extended format, for when you want the Maintenance Window to become inactive. EndDate allows you to set a date and time in the future when the Maintenance Window will no longer run.

Parameters:

endDate - The date and time, in ISO-8601 Extended format, for when you want the Maintenance Window to become inactive. EndDate allows you to set a date and time in the future when the Maintenance Window will no longer run.

Returns:

Returns a reference to this object so that method calls can be chained together.

schedule

CreateMaintenanceWindowRequest.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.

Returns:

Returns a reference to this object so that method calls can be chained together.

scheduleTimezone

CreateMaintenanceWindowRequest.Builder scheduleTimezone(String scheduleTimezone)

The time zone that the scheduled Maintenance Window executions are based on, in Internet Assigned Numbers Authority (IANA) format. For example: "America/Los_Angeles", "etc/UTC", or "Asia/Seoul". For more information, see the Time Zone Database on the IANA website.

Parameters:

scheduleTimezone - The time zone that the scheduled Maintenance Window executions are based on, in Internet Assigned Numbers Authority (IANA) format. For example: "America/Los_Angeles", "etc/UTC", or "Asia/Seoul". For more information, see the Time Zone Database on the IANA website.

Returns:

Returns a reference to this object so that method calls can be chained together.

duration

CreateMaintenanceWindowRequest.Builder duration(Integer duration)

The duration of the Maintenance Window in hours.

Parameters:

duration - The duration of the Maintenance Window in hours.

Returns:

Returns a reference to this object so that method calls can be chained together.

cutoff

CreateMaintenanceWindowRequest.Builder cutoff(Integer cutoff)

The number of hours before the end of the Maintenance Window that Systems Manager stops scheduling new tasks for execution.

Parameters:

cutoff - The number of hours before the end of the Maintenance Window that Systems Manager stops scheduling new tasks for execution.

Returns:

Returns a reference to this object so that method calls can be chained together.

allowUnassociatedTargets

CreateMaintenanceWindowRequest.Builder allowUnassociatedTargets(Boolean allowUnassociatedTargets)

Enables a Maintenance Window task to execute 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

If you don't enable this option, then you must specify previously-registered targets when you register a task with the Maintenance Window.

Parameters:

allowUnassociatedTargets - Enables a Maintenance Window task to execute 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

If you don't enable this option, then you must specify previously-registered targets when you register a task with the Maintenance Window.

Returns:

Returns a reference to this object so that method calls can be chained together.

clientToken

CreateMaintenanceWindowRequest.Builder clientToken(String clientToken)

User-provided idempotency token.

Parameters:

clientToken - User-provided idempotency token.

Returns:

Returns a reference to this object so that method calls can be chained together.

overrideConfiguration

CreateMaintenanceWindowRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

overrideConfiguration - The override configuration.

Returns:

This object for method chaining.

overrideConfiguration

CreateMaintenanceWindowRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.

Returns:

This object for method chaining.