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("software.amazon.awssdk:codegen") public final class UpdateMaintenanceWindowRequest extends SsmRequest implements ToCopyableBuilder<UpdateMaintenanceWindowRequest.Builder,UpdateMaintenanceWindowRequest>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
UpdateMaintenanceWindowRequest.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method 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 Amazon Web Services 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)
<T> Optional<T>
getValueForField(String fieldName, Class<T> clazz)
int
hashCode()
String
name()
The name of the maintenance window.Boolean
replace()
IfTrue
, then all fields that are required by the CreateMaintenanceWindow operation 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 date and time, in ISO-8601 Extended format, for when you want the maintenance window to become active.UpdateMaintenanceWindowRequest.Builder
toBuilder()
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
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
windowId
public final String windowId()
The ID of the maintenance window to update.
- Returns:
- The ID of the maintenance window to update.
-
name
public final String name()
The name of the maintenance window.
- Returns:
- The name of the maintenance window.
-
description
public final String description()
An optional description for the update request.
- Returns:
- An optional description for the update request.
-
startDate
public final 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.- Returns:
- 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.
-
endDate
public final 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 final 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 final 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", "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", "UTC", or "Asia/Seoul". For more information, see the Time Zone Database on the IANA website.
-
scheduleOffset
public final 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(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(30 23 ? * TUE#3 *)
If the schedule offset is
2
, the maintenance window won't run until two days later.
-
duration
public final Integer duration()
The duration of the maintenance window in hours.
- Returns:
- The duration of the maintenance window in hours.
-
cutoff
public final Integer cutoff()
The number of hours before the end of the maintenance window that Amazon Web Services Systems Manager stops scheduling new tasks for execution.
- Returns:
- The number of hours before the end of the maintenance window that Amazon Web Services Systems Manager stops scheduling new tasks for execution.
-
allowUnassociatedTargets
public final 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 final Boolean enabled()
Whether the maintenance window is enabled.
- Returns:
- Whether the maintenance window is enabled.
-
replace
public final Boolean replace()
If
True
, then all fields that are required by the CreateMaintenanceWindow operation are also required for this API request. Optional fields that aren't specified are set to null.- Returns:
- If
True
, then all fields that are required by the CreateMaintenanceWindow operation are also required for this API request. Optional fields that aren't specified are set to null.
-
toBuilder
public UpdateMaintenanceWindowRequest.Builder toBuilder()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<UpdateMaintenanceWindowRequest.Builder,UpdateMaintenanceWindowRequest>
- Specified by:
toBuilder
in classSsmRequest
-
builder
public static UpdateMaintenanceWindowRequest.Builder builder()
-
serializableBuilderClass
public static Class<? extends UpdateMaintenanceWindowRequest.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCode
in classAwsRequest
-
equals
public final boolean equals(Object obj)
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFields
in interfaceSdkPojo
-
toString
public final 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.
-
getValueForField
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
- Overrides:
getValueForField
in classSdkRequest
-
-