@Generated(value="software.amazon.awssdk:codegen") public final class CreateMaintenanceWindowRequest extends SsmRequest implements ToCopyableBuilder<CreateMaintenanceWindowRequest.Builder,CreateMaintenanceWindowRequest>
| Modifier and Type | Class and Description |
|---|---|
static interface |
CreateMaintenanceWindowRequest.Builder |
| Modifier and Type | Method and Description |
|---|---|
Boolean |
allowUnassociatedTargets()
Enables a maintenance window task to run on managed instances, even if you haven't registered those instances as
targets.
|
static CreateMaintenanceWindowRequest.Builder |
builder() |
String |
clientToken()
User-provided idempotency token.
|
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 maintenance window.
|
Integer |
duration()
The duration of the maintenance window in hours.
|
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() |
boolean |
hasTags()
For responses, this returns true if the service returned a value for the Tags property.
|
String |
name()
The name of the maintenance window.
|
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 CreateMaintenanceWindowRequest.Builder> |
serializableBuilderClass() |
String |
startDate()
The date and time, in ISO-8601 Extended format, for when you want the maintenance window to become active.
|
List<Tag> |
tags()
Optional metadata that you assign to a resource.
|
CreateMaintenanceWindowRequest.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.
|
overrideConfigurationcopypublic final String name()
The name of the maintenance window.
public final String description()
An optional description for the maintenance window. We recommend specifying a description to help you organize your maintenance windows.
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.
StartDate allows you to delay activation of the maintenance window until the
specified future date.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.
EndDate allows you to set a date and time in the future when the maintenance
window will no longer run.public final String schedule()
The schedule of the maintenance window in the form of a cron or rate expression.
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.
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 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.
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.
public final Integer duration()
The duration of the maintenance window in hours.
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.
public final Boolean allowUnassociatedTargets()
Enables a maintenance window task to run on managed instances, even if you haven't 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.
If you don't enable this option, then you must specify previously-registered targets when you register a task with the maintenance window.
public final String clientToken()
User-provided idempotency token.
public final boolean hasTags()
isEmpty() method on the property). This is useful
because the SDK will never return a null collection or map, but you may need to differentiate between the service
returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true
if a value for the property was specified in the request builder, and false if a value was not specified.public final List<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.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasTags() method.
Key=TaskType,Value=AgentUpdate
Key=OS,Value=Windows
Key=Environment,Value=Production
To add tags to an existing maintenance window, use the AddTagsToResource operation.
public CreateMaintenanceWindowRequest.Builder toBuilder()
ToCopyableBuildertoBuilder in interface ToCopyableBuilder<CreateMaintenanceWindowRequest.Builder,CreateMaintenanceWindowRequest>toBuilder in class SsmRequestpublic static CreateMaintenanceWindowRequest.Builder builder()
public static Class<? extends CreateMaintenanceWindowRequest.Builder> serializableBuilderClass()
public final int hashCode()
hashCode in class AwsRequestpublic final boolean equals(Object obj)
equals in class AwsRequestpublic final boolean equalsBySdkFields(Object obj)
SdkPojoSdkPojo 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.
equalsBySdkFields in interface SdkPojoobj - the object to be compared withpublic final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkRequestSdkRequest. 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.getValueForField in class SdkRequestfieldName - The name of the member to be retrieved.clazz - The class to cast the returned object to.