Interface UpdateMaintenanceWindowRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<UpdateMaintenanceWindowRequest.Builder,
,UpdateMaintenanceWindowRequest> SdkBuilder<UpdateMaintenanceWindowRequest.Builder,
,UpdateMaintenanceWindowRequest> SdkPojo
,SdkRequest.Builder
,SsmRequest.Builder
- Enclosing class:
UpdateMaintenanceWindowRequest
-
Method Summary
Modifier and TypeMethodDescriptionallowUnassociatedTargets
(Boolean allowUnassociatedTargets) Whether targets must be registered with the maintenance window before tasks can be defined for those targets.The number of hours before the end of the maintenance window that Amazon Web Services Systems Manager stops scheduling new tasks for execution.description
(String description) An optional description for the update request.The duration of the maintenance window in hours.Whether the maintenance window is enabled.The date and time, in ISO-8601 Extended format, for when you want the maintenance window to become inactive.The name of the maintenance window.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.IfTrue
, then all fields that are required by the CreateMaintenanceWindow operation are also required for this API request.The schedule of the maintenance window in the form of a cron or rate expression.scheduleOffset
(Integer scheduleOffset) The number of days to wait after the date and time specified by a cron expression before running the maintenance window.scheduleTimezone
(String scheduleTimezone) The time zone that the scheduled maintenance window executions are based on, in Internet Assigned Numbers Authority (IANA) format.The date and time, in ISO-8601 Extended format, for when you want the maintenance window to become active.The ID of the maintenance window to update.Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
Methods inherited from interface software.amazon.awssdk.services.ssm.model.SsmRequest.Builder
build
-
Method Details
-
windowId
The ID of the maintenance window to update.
- Parameters:
windowId
- The ID of the maintenance window to update.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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
An optional description for the update request.
- Parameters:
description
- An optional description for the update request.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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
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
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
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.
- 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", "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.
-
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.- Parameters:
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:
- Returns a reference to this object so that method calls can be chained together.
-
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
The number of hours before the end of the maintenance window that Amazon Web Services Systems Manager stops scheduling new tasks for execution.
- Parameters:
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:
- Returns a reference to this object so that method calls can be chained together.
-
allowUnassociatedTargets
Whether targets must be registered with the maintenance window before tasks can be defined for those targets.
- Parameters:
allowUnassociatedTargets
- Whether targets must be registered with the maintenance window before tasks can be defined for those targets.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
enabled
Whether the maintenance window is enabled.
- Parameters:
enabled
- Whether the maintenance window is enabled.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.- Parameters:
replace
- IfTrue
, 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:
- Returns a reference to this object so that method calls can be chained together.
-
overrideConfiguration
UpdateMaintenanceWindowRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
overrideConfiguration
- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
UpdateMaintenanceWindowRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-