com.amazonaws.services.simplesystemsmanagement.model

Class CreateMaintenanceWindowRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.simplesystemsmanagement.model.CreateMaintenanceWindowRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CreateMaintenanceWindowRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
CreateMaintenanceWindowRequest()

Method Summary

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 nodes, even if you haven't registered those nodes as targets.
String	getClientToken() User-provided idempotency token.
Integer	getCutoff() The number of hours before the end of the maintenance window that Amazon Web Services 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 nodes, even if you haven't registered those nodes as targets.
void	setAllowUnassociatedTargets(Boolean allowUnassociatedTargets) Enables a maintenance window task to run on managed nodes, even if you haven't registered those nodes 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 Amazon Web Services 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 nodes, even if you haven't registered those nodes 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 Amazon Web Services 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.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CreateMaintenanceWindowRequest

public CreateMaintenanceWindowRequest()

Method Detail

setName

public void setName(String name)

The name of the maintenance window.

Parameters:

name - The name of the maintenance window.

getName

public String getName()

The name of the maintenance window.

Returns:

The name of the maintenance window.

withName

public CreateMaintenanceWindowRequest withName(String 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.

setDescription

public void setDescription(String description)

An optional description for the maintenance window. We recommend specifying a description to help you organize your maintenance windows.

Parameters:

description - An optional description for the maintenance window. We recommend specifying a description to help you organize your maintenance windows.

getDescription

public String getDescription()

An optional description for the maintenance window. We recommend specifying a description to help you organize your maintenance windows.

Returns:

An optional description for the maintenance window. We recommend specifying a description to help you organize your maintenance windows.

withDescription

public CreateMaintenanceWindowRequest withDescription(String description)

An optional description for the maintenance window. We recommend specifying a description to help you organize your maintenance windows.

Parameters:

description - An optional description for the maintenance window. We recommend specifying a description to help you organize your maintenance windows.

Returns:

Returns a reference to this object so that method calls can be chained together.

setStartDate

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.

When using a rate schedule, if you provide a start date that occurs in the past, the current date and time are used as the start 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.

When using a rate schedule, if you provide a start date that occurs in the past, the current date and time are used as the start date.

getStartDate

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.

When using a rate schedule, if you provide a start date that occurs in the past, the current date and time are used as the start 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.

When using a rate schedule, if you provide a start date that occurs in the past, the current date and time are used as the start date.

withStartDate

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.

When using a rate schedule, if you provide a start date that occurs in the past, the current date and time are used as the start 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.

When using a rate schedule, if you provide a start date that occurs in the past, the current date and time are used as the start date.

Returns:

Returns a reference to this object so that method calls can be chained together.

setEndDate

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.

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.

getEndDate

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.

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.

withEndDate

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.

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.

setSchedule

public void setSchedule(String 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.

getSchedule

public String getSchedule()

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.

withSchedule

public CreateMaintenanceWindowRequest withSchedule(String 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.

setScheduleTimezone

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", "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.

getScheduleTimezone

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", "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.

withScheduleTimezone

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", "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.

setScheduleOffset

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(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 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.

getScheduleOffset

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(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 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.

withScheduleOffset

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(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 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

setDuration

public void setDuration(Integer duration)

The duration of the maintenance window in hours.

Parameters:

duration - The duration of the maintenance window in hours.

getDuration

public Integer getDuration()

The duration of the maintenance window in hours.

Returns:

The duration of the maintenance window in hours.

withDuration

public CreateMaintenanceWindowRequest withDuration(Integer 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.

setCutoff

public void setCutoff(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.

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.

getCutoff

public Integer getCutoff()

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.

withCutoff

public CreateMaintenanceWindowRequest withCutoff(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.

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.

setAllowUnassociatedTargets

public void setAllowUnassociatedTargets(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.

Parameters:

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.

getAllowUnassociatedTargets

public Boolean getAllowUnassociatedTargets()

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.

Returns:

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.

withAllowUnassociatedTargets

public CreateMaintenanceWindowRequest withAllowUnassociatedTargets(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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

isAllowUnassociatedTargets

public Boolean isAllowUnassociatedTargets()

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.

Returns:

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.

setClientToken

public void setClientToken(String clientToken)

User-provided idempotency token.

Parameters:

clientToken - User-provided idempotency token.

getClientToken

public String getClientToken()

User-provided idempotency token.

Returns:

User-provided idempotency token.

withClientToken

public CreateMaintenanceWindowRequest withClientToken(String clientToken)

User-provided idempotency token.

Parameters:

clientToken - User-provided idempotency token.

Returns:

Returns a reference to this object so that method calls can be chained together.

getTags

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-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.

Returns:

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.

setTags

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-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.

Parameters:

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.

withTags

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-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.

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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

withTags

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-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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

toString

public 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.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public CreateMaintenanceWindowRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()