public static interface CreateMaintenanceWindowRequest.Builder extends SsmRequest.Builder, SdkPojo, CopyableBuilder<CreateMaintenanceWindowRequest.Builder,CreateMaintenanceWindowRequest>
| Modifier and Type | Method and Description |
|---|---|
CreateMaintenanceWindowRequest.Builder |
allowUnassociatedTargets(Boolean allowUnassociatedTargets)
Enables a maintenance window task to run on managed nodes, even if you haven't registered those nodes 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 Amazon Web Services 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) |
CreateMaintenanceWindowRequest.Builder |
overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) |
CreateMaintenanceWindowRequest.Builder |
schedule(String schedule)
The schedule of the maintenance window in the form of a cron or rate expression.
|
CreateMaintenanceWindowRequest.Builder |
scheduleOffset(Integer scheduleOffset)
The number of days to wait after the date and time specified by a cron expression before running the
maintenance window.
|
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.
|
CreateMaintenanceWindowRequest.Builder |
tags(Collection<Tag> tags)
Optional metadata that you assign to a resource.
|
CreateMaintenanceWindowRequest.Builder |
tags(Consumer<Tag.Builder>... tags)
Optional metadata that you assign to a resource.
|
CreateMaintenanceWindowRequest.Builder |
tags(Tag... tags)
Optional metadata that you assign to a resource.
|
buildoverrideConfigurationequalsBySdkFields, sdkFieldscopyapplyMutation, buildCreateMaintenanceWindowRequest.Builder name(String name)
The name of the maintenance window.
name - The name of the maintenance window.CreateMaintenanceWindowRequest.Builder description(String description)
An optional description for the maintenance window. We recommend specifying a description to help you organize your maintenance windows.
description - An optional description for the maintenance window. We recommend specifying a description to help you
organize your maintenance windows.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.
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.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.
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.CreateMaintenanceWindowRequest.Builder schedule(String schedule)
The schedule of the maintenance window in the form of a cron or rate expression.
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. For example: "America/Los_Angeles", "UTC", or "Asia/Seoul". For more information, see the Time Zone Database on the IANA website.
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.CreateMaintenanceWindowRequest.Builder scheduleOffset(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 on 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.
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 on 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.
CreateMaintenanceWindowRequest.Builder duration(Integer duration)
The duration of the maintenance window in hours.
duration - The duration of the maintenance window in hours.CreateMaintenanceWindowRequest.Builder cutoff(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.
cutoff - The number of hours before the end of the maintenance window that Amazon Web Services Systems Manager
stops scheduling new tasks for execution.CreateMaintenanceWindowRequest.Builder allowUnassociatedTargets(Boolean allowUnassociatedTargets)
Enables a maintenance window task to run on managed nodes, even if you haven't registered those nodes as targets. If enabled, then you must specify the unregistered managed nodes (by node 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.
allowUnassociatedTargets - Enables a maintenance window task to run on managed nodes, even if you haven't registered those nodes
as targets. If enabled, then you must specify the unregistered managed nodes (by node 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.
CreateMaintenanceWindowRequest.Builder clientToken(String clientToken)
User-provided idempotency token.
clientToken - User-provided idempotency token.CreateMaintenanceWindowRequest.Builder tags(Collection<Tag> tags)
Optional metadata that you assign to a resource. 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. In this case, you could specify the following key-value pairs:
Key=TaskType,Value=AgentUpdate
Key=OS,Value=Windows
Key=Environment,Value=Production
To add tags to an existing maintenance window, use the AddTagsToResource operation.
tags - Optional metadata that you assign to a resource. 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. In this case, you could specify the following key-value pairs:
Key=TaskType,Value=AgentUpdate
Key=OS,Value=Windows
Key=Environment,Value=Production
To add tags to an existing maintenance window, use the AddTagsToResource operation.
CreateMaintenanceWindowRequest.Builder tags(Tag... tags)
Optional metadata that you assign to a resource. 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. In this case, you could specify the following key-value pairs:
Key=TaskType,Value=AgentUpdate
Key=OS,Value=Windows
Key=Environment,Value=Production
To add tags to an existing maintenance window, use the AddTagsToResource operation.
tags - Optional metadata that you assign to a resource. 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. In this case, you could specify the following key-value pairs:
Key=TaskType,Value=AgentUpdate
Key=OS,Value=Windows
Key=Environment,Value=Production
To add tags to an existing maintenance window, use the AddTagsToResource operation.
CreateMaintenanceWindowRequest.Builder tags(Consumer<Tag.Builder>... tags)
Optional metadata that you assign to a resource. 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. In this case, you could specify the following key-value pairs:
Key=TaskType,Value=AgentUpdate
Key=OS,Value=Windows
Key=Environment,Value=Production
To add tags to an existing maintenance window, use the AddTagsToResource operation.
Tag.Builder avoiding the need to create one manually via
Tag.builder().
When the Consumer completes, SdkBuilder.build() is
called immediately and its result is passed to #tags(List.
tags - a consumer that will call methods on Tag.Builder#tags(java.util.Collection) CreateMaintenanceWindowRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
overrideConfiguration in interface AwsRequest.BuilderCreateMaintenanceWindowRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
overrideConfiguration in interface AwsRequest.BuilderCopyright © 2023. All rights reserved.