@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class CreateMaintenanceWindowRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
NOOP
Constructor and Description |
---|
CreateMaintenanceWindowRequest() |
Modifier and Type | Method and Description |
---|---|
CreateMaintenanceWindowRequest |
clone()
Creates a shallow clone of this object for all fields except the handler context.
|
boolean |
equals(Object obj) |
Boolean |
getAllowUnassociatedTargets()
Enables a maintenance window task to run on managed instances, even if you have not registered those instances as
targets.
|
String |
getClientToken()
User-provided idempotency token.
|
Integer |
getCutoff()
The number of hours before the end of the maintenance window that Systems Manager stops scheduling new tasks for
execution.
|
String |
getDescription()
An optional description for the maintenance window.
|
Integer |
getDuration()
The duration of the maintenance window in hours.
|
String |
getEndDate()
The date and time, in ISO-8601 Extended format, for when you want the maintenance window to become inactive.
|
String |
getName()
The name of the maintenance window.
|
String |
getSchedule()
The schedule of the maintenance window in the form of a cron or rate expression.
|
Integer |
getScheduleOffset()
The number of days to wait after the date and time specified by a CRON expression before running the maintenance
window.
|
String |
getScheduleTimezone()
The time zone that the scheduled maintenance window executions are based on, in Internet Assigned Numbers
Authority (IANA) format.
|
String |
getStartDate()
The date and time, in ISO-8601 Extended format, for when you want the maintenance window to become active.
|
List<Tag> |
getTags()
Optional metadata that you assign to a resource.
|
int |
hashCode() |
Boolean |
isAllowUnassociatedTargets()
Enables a maintenance window task to run on managed instances, even if you have not registered those instances as
targets.
|
void |
setAllowUnassociatedTargets(Boolean allowUnassociatedTargets)
Enables a maintenance window task to run on managed instances, even if you have not registered those instances as
targets.
|
void |
setClientToken(String clientToken)
User-provided idempotency token.
|
void |
setCutoff(Integer cutoff)
The number of hours before the end of the maintenance window that Systems Manager stops scheduling new tasks for
execution.
|
void |
setDescription(String description)
An optional description for the maintenance window.
|
void |
setDuration(Integer duration)
The duration of the maintenance window in hours.
|
void |
setEndDate(String endDate)
The date and time, in ISO-8601 Extended format, for when you want the maintenance window to become inactive.
|
void |
setName(String name)
The name of the maintenance window.
|
void |
setSchedule(String schedule)
The schedule of the maintenance window in the form of a cron or rate expression.
|
void |
setScheduleOffset(Integer scheduleOffset)
The number of days to wait after the date and time specified by a CRON expression before running the maintenance
window.
|
void |
setScheduleTimezone(String scheduleTimezone)
The time zone that the scheduled maintenance window executions are based on, in Internet Assigned Numbers
Authority (IANA) format.
|
void |
setStartDate(String startDate)
The date and time, in ISO-8601 Extended format, for when you want the maintenance window to become active.
|
void |
setTags(Collection<Tag> tags)
Optional metadata that you assign to a resource.
|
String |
toString()
Returns a string representation of this object.
|
CreateMaintenanceWindowRequest |
withAllowUnassociatedTargets(Boolean allowUnassociatedTargets)
Enables a maintenance window task to run on managed instances, even if you have not registered those instances as
targets.
|
CreateMaintenanceWindowRequest |
withClientToken(String clientToken)
User-provided idempotency token.
|
CreateMaintenanceWindowRequest |
withCutoff(Integer cutoff)
The number of hours before the end of the maintenance window that Systems Manager stops scheduling new tasks for
execution.
|
CreateMaintenanceWindowRequest |
withDescription(String description)
An optional description for the maintenance window.
|
CreateMaintenanceWindowRequest |
withDuration(Integer duration)
The duration of the maintenance window in hours.
|
CreateMaintenanceWindowRequest |
withEndDate(String endDate)
The date and time, in ISO-8601 Extended format, for when you want the maintenance window to become inactive.
|
CreateMaintenanceWindowRequest |
withName(String name)
The name of the maintenance window.
|
CreateMaintenanceWindowRequest |
withSchedule(String schedule)
The schedule of the maintenance window in the form of a cron or rate expression.
|
CreateMaintenanceWindowRequest |
withScheduleOffset(Integer scheduleOffset)
The number of days to wait after the date and time specified by a CRON expression before running the maintenance
window.
|
CreateMaintenanceWindowRequest |
withScheduleTimezone(String scheduleTimezone)
The time zone that the scheduled maintenance window executions are based on, in Internet Assigned Numbers
Authority (IANA) format.
|
CreateMaintenanceWindowRequest |
withStartDate(String startDate)
The date and time, in ISO-8601 Extended format, for when you want the maintenance window to become active.
|
CreateMaintenanceWindowRequest |
withTags(Collection<Tag> tags)
Optional metadata that you assign to a resource.
|
CreateMaintenanceWindowRequest |
withTags(Tag... tags)
Optional metadata that you assign to a resource.
|
addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
public void setName(String name)
The name of the maintenance window.
name
- The name of the maintenance window.public String getName()
The name of the maintenance window.
public CreateMaintenanceWindowRequest withName(String name)
The name of the maintenance window.
name
- The name of the maintenance window.public void setDescription(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.public String getDescription()
An optional description for the maintenance window. We recommend specifying a description to help you organize your maintenance windows.
public CreateMaintenanceWindowRequest withDescription(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.public void setStartDate(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.public String getStartDate()
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.
public CreateMaintenanceWindowRequest withStartDate(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.public void setEndDate(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.public String getEndDate()
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.
public CreateMaintenanceWindowRequest withEndDate(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.public void setSchedule(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.public String getSchedule()
The schedule of the maintenance window in the form of a cron or rate expression.
public CreateMaintenanceWindowRequest withSchedule(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.public void setScheduleTimezone(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.
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.public String getScheduleTimezone()
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.
public CreateMaintenanceWindowRequest withScheduleTimezone(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.
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.public void setScheduleOffset(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(0 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(0 30 23 ? * TUE#3 *)
If the schedule offset is 2
, the maintenance window won't run until two days later.
public Integer getScheduleOffset()
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(0 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(0 30 23 ? * TUE#3 *)
If the schedule offset is 2
, the maintenance window won't run until two days later.
public CreateMaintenanceWindowRequest withScheduleOffset(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(0 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(0 30 23 ? * TUE#3 *)
If the schedule offset is 2
, the maintenance window won't run until two days later.
public void setDuration(Integer duration)
The duration of the maintenance window in hours.
duration
- The duration of the maintenance window in hours.public Integer getDuration()
The duration of the maintenance window in hours.
public CreateMaintenanceWindowRequest withDuration(Integer duration)
The duration of the maintenance window in hours.
duration
- The duration of the maintenance window in hours.public void setCutoff(Integer cutoff)
The number of hours before the end of the maintenance window that Systems Manager stops scheduling new tasks for execution.
cutoff
- The number of hours before the end of the maintenance window that Systems Manager stops scheduling new
tasks for execution.public Integer getCutoff()
The number of hours before the end of the maintenance window that Systems Manager stops scheduling new tasks for execution.
public CreateMaintenanceWindowRequest withCutoff(Integer cutoff)
The number of hours before the end of the maintenance window that Systems Manager stops scheduling new tasks for execution.
cutoff
- The number of hours before the end of the maintenance window that Systems Manager stops scheduling new
tasks for execution.public void setAllowUnassociatedTargets(Boolean allowUnassociatedTargets)
Enables a maintenance window task to run on managed instances, even if you have not 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.
allowUnassociatedTargets
- Enables a maintenance window task to run on managed instances, even if you have not 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.
public Boolean getAllowUnassociatedTargets()
Enables a maintenance window task to run on managed instances, even if you have not 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 CreateMaintenanceWindowRequest withAllowUnassociatedTargets(Boolean allowUnassociatedTargets)
Enables a maintenance window task to run on managed instances, even if you have not 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.
allowUnassociatedTargets
- Enables a maintenance window task to run on managed instances, even if you have not 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.
public Boolean isAllowUnassociatedTargets()
Enables a maintenance window task to run on managed instances, even if you have not 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 void setClientToken(String clientToken)
User-provided idempotency token.
clientToken
- User-provided idempotency token.public String getClientToken()
User-provided idempotency token.
public CreateMaintenanceWindowRequest withClientToken(String clientToken)
User-provided idempotency token.
clientToken
- User-provided idempotency token.public List<Tag> getTags()
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 name/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 action.
Key=TaskType,Value=AgentUpdate
Key=OS,Value=Windows
Key=Environment,Value=Production
To add tags to an existing maintenance window, use the AddTagsToResource action.
public void setTags(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 name/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 action.
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 name/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 action.
public CreateMaintenanceWindowRequest withTags(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 name/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 action.
NOTE: This method appends the values to the existing list (if any). Use
setTags(java.util.Collection)
or withTags(java.util.Collection)
if you want to override the
existing values.
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 name/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 action.
public CreateMaintenanceWindowRequest withTags(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 name/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 action.
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 name/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 action.
public String toString()
toString
in class Object
Object.toString()
public CreateMaintenanceWindowRequest clone()
AmazonWebServiceRequest
clone
in class AmazonWebServiceRequest
Object.clone()