software.amazon.awssdk.services.ssm.model

Class UpdateMaintenanceWindowRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.ssm.model.SsmRequest

software.amazon.awssdk.services.ssm.model.UpdateMaintenanceWindowRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<UpdateMaintenanceWindowRequest.Builder,UpdateMaintenanceWindowRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class UpdateMaintenanceWindowRequest
extends SsmRequest
implements ToCopyableBuilder<UpdateMaintenanceWindowRequest.Builder,UpdateMaintenanceWindowRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	UpdateMaintenanceWindowRequest.Builder

Method Summary

Modifier and Type	Method and Description
Boolean	allowUnassociatedTargets() Whether targets must be registered with the maintenance window before tasks can be defined for those targets.
static UpdateMaintenanceWindowRequest.Builder	builder()
Integer	cutoff() The number of hours before the end of the maintenance window that Systems Manager stops scheduling new tasks for execution.
String	description() An optional description for the update request.
Integer	duration() The duration of the maintenance window in hours.
Boolean	enabled() Whether the maintenance window is enabled.
String	endDate() The date and time, in ISO-8601 Extended format, for when you want the maintenance window to become inactive.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkRequest.
int	hashCode()
String	name() The name of the maintenance window.
Boolean	replace() If True, then all fields that are required by the CreateMaintenanceWindow action are also required for this API request.
String	schedule() The schedule of the maintenance window in the form of a cron or rate expression.
Integer	scheduleOffset() The number of days to wait after the date and time specified by a CRON expression before running the maintenance window.
String	scheduleTimezone() The time zone that the scheduled maintenance window executions are based on, in Internet Assigned Numbers Authority (IANA) format.
List<SdkField<?>>	sdkFields()
static Class<? extends UpdateMaintenanceWindowRequest.Builder>	serializableBuilderClass()
String	startDate() The time zone that the scheduled maintenance window executions are based on, in Internet Assigned Numbers Authority (IANA) format.
UpdateMaintenanceWindowRequest.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString() Returns a string representation of this object.
String	windowId() The ID of the maintenance window to update.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

windowId

public String windowId()

The ID of the maintenance window to update.

Returns:

The ID of the maintenance window to update.

name

public String name()

The name of the maintenance window.

Returns:

The name of the maintenance window.

description

public String description()

An optional description for the update request.

Returns:

An optional description for the update request.

startDate

public String startDate()

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:

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.

endDate

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

Returns:

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.

schedule

public String schedule()

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

Returns:

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

scheduleTimezone

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

Returns:

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.

scheduleOffset

public Integer scheduleOffset()

The number of days to wait after the date and time specified by a CRON expression before running the maintenance window.

For example, the following cron expression schedules a maintenance window to run the third Tuesday of every month at 11:30 PM.

cron(0 30 23 ? * TUE#3 *)

If the schedule offset is 2, the maintenance window won't run until two days later.

Returns:

The number of days to wait after the date and time specified by a CRON expression before running the maintenance window.

For example, the following cron expression schedules a maintenance window to run the third Tuesday of every month at 11:30 PM.

cron(0 30 23 ? * TUE#3 *)

If the schedule offset is 2, the maintenance window won't run until two days later.

duration

public Integer duration()

The duration of the maintenance window in hours.

Returns:

The duration of the maintenance window in hours.

cutoff

public Integer cutoff()

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

Returns:

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

allowUnassociatedTargets

public Boolean allowUnassociatedTargets()

Whether targets must be registered with the maintenance window before tasks can be defined for those targets.

Returns:

Whether targets must be registered with the maintenance window before tasks can be defined for those targets.

enabled

public Boolean enabled()

Whether the maintenance window is enabled.

Returns:

Whether the maintenance window is enabled.

replace

public Boolean replace()

If True, then all fields that are required by the CreateMaintenanceWindow action are also required for this API request. Optional fields that are not specified are set to null.

Returns:

If True, then all fields that are required by the CreateMaintenanceWindow action are also required for this API request. Optional fields that are not specified are set to null.

toBuilder

public UpdateMaintenanceWindowRequest.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<UpdateMaintenanceWindowRequest.Builder,UpdateMaintenanceWindowRequest>

Specified by:

toBuilder in class SsmRequest

Returns:

a builder for type T

builder

public static UpdateMaintenanceWindowRequest.Builder builder()

serializableBuilderClass

public static Class<? extends UpdateMaintenanceWindowRequest.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public boolean equalsBySdkFields(Object obj)

Description copied from interface: SdkPojo

Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

Specified by:

equalsBySdkFields in interface SdkPojo

Parameters:

obj - the object to be compared with

Returns:

true if the other object equals to this object by sdk fields, false otherwise.

toString

public String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Description copied from class: SdkRequest

Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkRequest

Parameters:

fieldName - The name of the member to be retrieved.

clazz - The class to cast the returned object to.

Returns:

Optional containing the casted return value

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.