com.amazonaws.services.simplesystemsmanagement.model

Class RegisterTaskWithMaintenanceWindowRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.simplesystemsmanagement.model.RegisterTaskWithMaintenanceWindowRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class RegisterTaskWithMaintenanceWindowRequest
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
RegisterTaskWithMaintenanceWindowRequest()

Method Summary

Modifier and Type	Method and Description
RegisterTaskWithMaintenanceWindowRequest	addTaskParametersEntry(String key, MaintenanceWindowTaskParameterValueExpression value) Add a single TaskParameters entry
RegisterTaskWithMaintenanceWindowRequest	clearTaskParametersEntries() Removes all the entries added into TaskParameters.
RegisterTaskWithMaintenanceWindowRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
AlarmConfiguration	getAlarmConfiguration() The CloudWatch alarm you want to apply to your maintenance window task.
String	getClientToken() User-provided idempotency token.
String	getCutoffBehavior() Indicates whether tasks should continue to run after the cutoff time specified in the maintenance windows is reached.
String	getDescription() An optional description for the task.
LoggingInfo	getLoggingInfo() A structure containing information about an Amazon Simple Storage Service (Amazon S3) bucket to write managed node-level logs to.
String	getMaxConcurrency() The maximum number of targets this task can be run for, in parallel.
String	getMaxErrors() The maximum number of errors allowed before this task stops being scheduled.
String	getName() An optional name for the task.
Integer	getPriority() The priority of the task in the maintenance window, the lower the number the higher the priority.
String	getServiceRoleArn() The Amazon Resource Name (ARN) of the IAM service role for Amazon Web Services Systems Manager to assume when running a maintenance window task.
List<Target>	getTargets() The targets (either managed nodes or maintenance window targets).
String	getTaskArn() The ARN of the task to run.
MaintenanceWindowTaskInvocationParameters	getTaskInvocationParameters() The parameters that the task should use during execution.
Map<String,MaintenanceWindowTaskParameterValueExpression>	getTaskParameters() The parameters that should be passed to the task when it is run.
String	getTaskType() The type of task being registered.
String	getWindowId() The ID of the maintenance window the task should be added to.
int	hashCode()
void	setAlarmConfiguration(AlarmConfiguration alarmConfiguration) The CloudWatch alarm you want to apply to your maintenance window task.
void	setClientToken(String clientToken) User-provided idempotency token.
void	setCutoffBehavior(MaintenanceWindowTaskCutoffBehavior cutoffBehavior) Indicates whether tasks should continue to run after the cutoff time specified in the maintenance windows is reached.
void	setCutoffBehavior(String cutoffBehavior) Indicates whether tasks should continue to run after the cutoff time specified in the maintenance windows is reached.
void	setDescription(String description) An optional description for the task.
void	setLoggingInfo(LoggingInfo loggingInfo) A structure containing information about an Amazon Simple Storage Service (Amazon S3) bucket to write managed node-level logs to.
void	setMaxConcurrency(String maxConcurrency) The maximum number of targets this task can be run for, in parallel.
void	setMaxErrors(String maxErrors) The maximum number of errors allowed before this task stops being scheduled.
void	setName(String name) An optional name for the task.
void	setPriority(Integer priority) The priority of the task in the maintenance window, the lower the number the higher the priority.
void	setServiceRoleArn(String serviceRoleArn) The Amazon Resource Name (ARN) of the IAM service role for Amazon Web Services Systems Manager to assume when running a maintenance window task.
void	setTargets(Collection<Target> targets) The targets (either managed nodes or maintenance window targets).
void	setTaskArn(String taskArn) The ARN of the task to run.
void	setTaskInvocationParameters(MaintenanceWindowTaskInvocationParameters taskInvocationParameters) The parameters that the task should use during execution.
void	setTaskParameters(Map<String,MaintenanceWindowTaskParameterValueExpression> taskParameters) The parameters that should be passed to the task when it is run.
void	setTaskType(MaintenanceWindowTaskType taskType) The type of task being registered.
void	setTaskType(String taskType) The type of task being registered.
void	setWindowId(String windowId) The ID of the maintenance window the task should be added to.
String	toString() Returns a string representation of this object.
RegisterTaskWithMaintenanceWindowRequest	withAlarmConfiguration(AlarmConfiguration alarmConfiguration) The CloudWatch alarm you want to apply to your maintenance window task.
RegisterTaskWithMaintenanceWindowRequest	withClientToken(String clientToken) User-provided idempotency token.
RegisterTaskWithMaintenanceWindowRequest	withCutoffBehavior(MaintenanceWindowTaskCutoffBehavior cutoffBehavior) Indicates whether tasks should continue to run after the cutoff time specified in the maintenance windows is reached.
RegisterTaskWithMaintenanceWindowRequest	withCutoffBehavior(String cutoffBehavior) Indicates whether tasks should continue to run after the cutoff time specified in the maintenance windows is reached.
RegisterTaskWithMaintenanceWindowRequest	withDescription(String description) An optional description for the task.
RegisterTaskWithMaintenanceWindowRequest	withLoggingInfo(LoggingInfo loggingInfo) A structure containing information about an Amazon Simple Storage Service (Amazon S3) bucket to write managed node-level logs to.
RegisterTaskWithMaintenanceWindowRequest	withMaxConcurrency(String maxConcurrency) The maximum number of targets this task can be run for, in parallel.
RegisterTaskWithMaintenanceWindowRequest	withMaxErrors(String maxErrors) The maximum number of errors allowed before this task stops being scheduled.
RegisterTaskWithMaintenanceWindowRequest	withName(String name) An optional name for the task.
RegisterTaskWithMaintenanceWindowRequest	withPriority(Integer priority) The priority of the task in the maintenance window, the lower the number the higher the priority.
RegisterTaskWithMaintenanceWindowRequest	withServiceRoleArn(String serviceRoleArn) The Amazon Resource Name (ARN) of the IAM service role for Amazon Web Services Systems Manager to assume when running a maintenance window task.
RegisterTaskWithMaintenanceWindowRequest	withTargets(Collection<Target> targets) The targets (either managed nodes or maintenance window targets).
RegisterTaskWithMaintenanceWindowRequest	withTargets(Target... targets) The targets (either managed nodes or maintenance window targets).
RegisterTaskWithMaintenanceWindowRequest	withTaskArn(String taskArn) The ARN of the task to run.
RegisterTaskWithMaintenanceWindowRequest	withTaskInvocationParameters(MaintenanceWindowTaskInvocationParameters taskInvocationParameters) The parameters that the task should use during execution.
RegisterTaskWithMaintenanceWindowRequest	withTaskParameters(Map<String,MaintenanceWindowTaskParameterValueExpression> taskParameters) The parameters that should be passed to the task when it is run.
RegisterTaskWithMaintenanceWindowRequest	withTaskType(MaintenanceWindowTaskType taskType) The type of task being registered.
RegisterTaskWithMaintenanceWindowRequest	withTaskType(String taskType) The type of task being registered.
RegisterTaskWithMaintenanceWindowRequest	withWindowId(String windowId) The ID of the maintenance window the task should be added to.

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

RegisterTaskWithMaintenanceWindowRequest

public RegisterTaskWithMaintenanceWindowRequest()

Method Detail

setWindowId

public void setWindowId(String windowId)

The ID of the maintenance window the task should be added to.

Parameters:

windowId - The ID of the maintenance window the task should be added to.

getWindowId

public String getWindowId()

The ID of the maintenance window the task should be added to.

Returns:

The ID of the maintenance window the task should be added to.

withWindowId

public RegisterTaskWithMaintenanceWindowRequest withWindowId(String windowId)

The ID of the maintenance window the task should be added to.

Parameters:

windowId - The ID of the maintenance window the task should be added to.

Returns:

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

getTargets

public List<Target> getTargets()

The targets (either managed nodes or maintenance window targets).

One or more targets must be specified for maintenance window Run Command-type tasks. Depending on the task, targets are optional for other maintenance window task types (Automation, Lambda, and Step Functions). For more information about running tasks that don't specify targets, see Registering maintenance window tasks without targets in the Amazon Web Services Systems Manager User Guide.

Specify managed nodes using the following format:

Key=InstanceIds,Values=<instance-id-1>,<instance-id-2>

Specify maintenance window targets using the following format:

Key=WindowTargetIds,Values=<window-target-id-1>,<window-target-id-2>

Returns:

The targets (either managed nodes or maintenance window targets).

One or more targets must be specified for maintenance window Run Command-type tasks. Depending on the task, targets are optional for other maintenance window task types (Automation, Lambda, and Step Functions). For more information about running tasks that don't specify targets, see Registering maintenance window tasks without targets in the Amazon Web Services Systems Manager User Guide.

Specify managed nodes using the following format:

Key=InstanceIds,Values=<instance-id-1>,<instance-id-2>

Specify maintenance window targets using the following format:

Key=WindowTargetIds,Values=<window-target-id-1>,<window-target-id-2>

setTargets

public void setTargets(Collection<Target> targets)

The targets (either managed nodes or maintenance window targets).

One or more targets must be specified for maintenance window Run Command-type tasks. Depending on the task, targets are optional for other maintenance window task types (Automation, Lambda, and Step Functions). For more information about running tasks that don't specify targets, see Registering maintenance window tasks without targets in the Amazon Web Services Systems Manager User Guide.

Specify managed nodes using the following format:

Key=InstanceIds,Values=<instance-id-1>,<instance-id-2>

Specify maintenance window targets using the following format:

Key=WindowTargetIds,Values=<window-target-id-1>,<window-target-id-2>

Parameters:

targets - The targets (either managed nodes or maintenance window targets).

One or more targets must be specified for maintenance window Run Command-type tasks. Depending on the task, targets are optional for other maintenance window task types (Automation, Lambda, and Step Functions). For more information about running tasks that don't specify targets, see Registering maintenance window tasks without targets in the Amazon Web Services Systems Manager User Guide.

Specify managed nodes using the following format:

Key=InstanceIds,Values=<instance-id-1>,<instance-id-2>

Specify maintenance window targets using the following format:

Key=WindowTargetIds,Values=<window-target-id-1>,<window-target-id-2>

withTargets

public RegisterTaskWithMaintenanceWindowRequest withTargets(Target... targets)

The targets (either managed nodes or maintenance window targets).

One or more targets must be specified for maintenance window Run Command-type tasks. Depending on the task, targets are optional for other maintenance window task types (Automation, Lambda, and Step Functions). For more information about running tasks that don't specify targets, see Registering maintenance window tasks without targets in the Amazon Web Services Systems Manager User Guide.

Specify managed nodes using the following format:

Key=InstanceIds,Values=<instance-id-1>,<instance-id-2>

Specify maintenance window targets using the following format:

Key=WindowTargetIds,Values=<window-target-id-1>,<window-target-id-2>

NOTE: This method appends the values to the existing list (if any). Use setTargets(java.util.Collection) or withTargets(java.util.Collection) if you want to override the existing values.

Parameters:

targets - The targets (either managed nodes or maintenance window targets).

One or more targets must be specified for maintenance window Run Command-type tasks. Depending on the task, targets are optional for other maintenance window task types (Automation, Lambda, and Step Functions). For more information about running tasks that don't specify targets, see Registering maintenance window tasks without targets in the Amazon Web Services Systems Manager User Guide.

Specify managed nodes using the following format:

Key=InstanceIds,Values=<instance-id-1>,<instance-id-2>

Specify maintenance window targets using the following format:

Key=WindowTargetIds,Values=<window-target-id-1>,<window-target-id-2>

Returns:

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

withTargets

public RegisterTaskWithMaintenanceWindowRequest withTargets(Collection<Target> targets)

The targets (either managed nodes or maintenance window targets).

One or more targets must be specified for maintenance window Run Command-type tasks. Depending on the task, targets are optional for other maintenance window task types (Automation, Lambda, and Step Functions). For more information about running tasks that don't specify targets, see Registering maintenance window tasks without targets in the Amazon Web Services Systems Manager User Guide.

Specify managed nodes using the following format:

Key=InstanceIds,Values=<instance-id-1>,<instance-id-2>

Specify maintenance window targets using the following format:

Key=WindowTargetIds,Values=<window-target-id-1>,<window-target-id-2>

Parameters:

targets - The targets (either managed nodes or maintenance window targets).

One or more targets must be specified for maintenance window Run Command-type tasks. Depending on the task, targets are optional for other maintenance window task types (Automation, Lambda, and Step Functions). For more information about running tasks that don't specify targets, see Registering maintenance window tasks without targets in the Amazon Web Services Systems Manager User Guide.

Specify managed nodes using the following format:

Key=InstanceIds,Values=<instance-id-1>,<instance-id-2>

Specify maintenance window targets using the following format:

Key=WindowTargetIds,Values=<window-target-id-1>,<window-target-id-2>

Returns:

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

setTaskArn

public void setTaskArn(String taskArn)

The ARN of the task to run.

Parameters:

taskArn - The ARN of the task to run.

getTaskArn

public String getTaskArn()

The ARN of the task to run.

Returns:

The ARN of the task to run.

withTaskArn

public RegisterTaskWithMaintenanceWindowRequest withTaskArn(String taskArn)

The ARN of the task to run.

Parameters:

taskArn - The ARN of the task to run.

Returns:

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

setServiceRoleArn

public void setServiceRoleArn(String serviceRoleArn)

The Amazon Resource Name (ARN) of the IAM service role for Amazon Web Services Systems Manager to assume when running a maintenance window task. If you do not specify a service role ARN, Systems Manager uses a service-linked role in your account. If no appropriate service-linked role for Systems Manager exists in your account, it is created when you run RegisterTaskWithMaintenanceWindow.

However, for an improved security posture, we strongly recommend creating a custom policy and custom service role for running your maintenance window tasks. The policy can be crafted to provide only the permissions needed for your particular maintenance window tasks. For more information, see Setting up maintenance windows in the in the Amazon Web Services Systems Manager User Guide.

Parameters:

serviceRoleArn - The Amazon Resource Name (ARN) of the IAM service role for Amazon Web Services Systems Manager to assume when running a maintenance window task. If you do not specify a service role ARN, Systems Manager uses a service-linked role in your account. If no appropriate service-linked role for Systems Manager exists in your account, it is created when you run RegisterTaskWithMaintenanceWindow.

However, for an improved security posture, we strongly recommend creating a custom policy and custom service role for running your maintenance window tasks. The policy can be crafted to provide only the permissions needed for your particular maintenance window tasks. For more information, see Setting up maintenance windows in the in the Amazon Web Services Systems Manager User Guide.

getServiceRoleArn

public String getServiceRoleArn()

The Amazon Resource Name (ARN) of the IAM service role for Amazon Web Services Systems Manager to assume when running a maintenance window task. If you do not specify a service role ARN, Systems Manager uses a service-linked role in your account. If no appropriate service-linked role for Systems Manager exists in your account, it is created when you run RegisterTaskWithMaintenanceWindow.

However, for an improved security posture, we strongly recommend creating a custom policy and custom service role for running your maintenance window tasks. The policy can be crafted to provide only the permissions needed for your particular maintenance window tasks. For more information, see Setting up maintenance windows in the in the Amazon Web Services Systems Manager User Guide.

Returns:

The Amazon Resource Name (ARN) of the IAM service role for Amazon Web Services Systems Manager to assume when running a maintenance window task. If you do not specify a service role ARN, Systems Manager uses a service-linked role in your account. If no appropriate service-linked role for Systems Manager exists in your account, it is created when you run RegisterTaskWithMaintenanceWindow.

However, for an improved security posture, we strongly recommend creating a custom policy and custom service role for running your maintenance window tasks. The policy can be crafted to provide only the permissions needed for your particular maintenance window tasks. For more information, see Setting up maintenance windows in the in the Amazon Web Services Systems Manager User Guide.

withServiceRoleArn

public RegisterTaskWithMaintenanceWindowRequest withServiceRoleArn(String serviceRoleArn)

The Amazon Resource Name (ARN) of the IAM service role for Amazon Web Services Systems Manager to assume when running a maintenance window task. If you do not specify a service role ARN, Systems Manager uses a service-linked role in your account. If no appropriate service-linked role for Systems Manager exists in your account, it is created when you run RegisterTaskWithMaintenanceWindow.

However, for an improved security posture, we strongly recommend creating a custom policy and custom service role for running your maintenance window tasks. The policy can be crafted to provide only the permissions needed for your particular maintenance window tasks. For more information, see Setting up maintenance windows in the in the Amazon Web Services Systems Manager User Guide.

Parameters:

serviceRoleArn - The Amazon Resource Name (ARN) of the IAM service role for Amazon Web Services Systems Manager to assume when running a maintenance window task. If you do not specify a service role ARN, Systems Manager uses a service-linked role in your account. If no appropriate service-linked role for Systems Manager exists in your account, it is created when you run RegisterTaskWithMaintenanceWindow.

However, for an improved security posture, we strongly recommend creating a custom policy and custom service role for running your maintenance window tasks. The policy can be crafted to provide only the permissions needed for your particular maintenance window tasks. For more information, see Setting up maintenance windows in the in the Amazon Web Services Systems Manager User Guide.

Returns:

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

setTaskType

public void setTaskType(String taskType)

The type of task being registered.

Parameters:

taskType - The type of task being registered.

See Also:

MaintenanceWindowTaskType

getTaskType

public String getTaskType()

The type of task being registered.

Returns:

The type of task being registered.

See Also:

MaintenanceWindowTaskType

withTaskType

public RegisterTaskWithMaintenanceWindowRequest withTaskType(String taskType)

The type of task being registered.

Parameters:

taskType - The type of task being registered.

Returns:

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

See Also:

MaintenanceWindowTaskType

setTaskType

public void setTaskType(MaintenanceWindowTaskType taskType)

The type of task being registered.

Parameters:

taskType - The type of task being registered.

See Also:

MaintenanceWindowTaskType

withTaskType

public RegisterTaskWithMaintenanceWindowRequest withTaskType(MaintenanceWindowTaskType taskType)

The type of task being registered.

Parameters:

taskType - The type of task being registered.

Returns:

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

See Also:

MaintenanceWindowTaskType

getTaskParameters

public Map<String,MaintenanceWindowTaskParameterValueExpression> getTaskParameters()

The parameters that should be passed to the task when it is run.

TaskParameters has been deprecated. To specify parameters to pass to a task when it runs, instead use the Parameters option in the TaskInvocationParameters structure. For information about how Systems Manager handles these options for the supported maintenance window task types, see MaintenanceWindowTaskInvocationParameters.

Returns:

The parameters that should be passed to the task when it is run.

TaskParameters has been deprecated. To specify parameters to pass to a task when it runs, instead use the Parameters option in the TaskInvocationParameters structure. For information about how Systems Manager handles these options for the supported maintenance window task types, see MaintenanceWindowTaskInvocationParameters.

setTaskParameters

public void setTaskParameters(Map<String,MaintenanceWindowTaskParameterValueExpression> taskParameters)

The parameters that should be passed to the task when it is run.

TaskParameters has been deprecated. To specify parameters to pass to a task when it runs, instead use the Parameters option in the TaskInvocationParameters structure. For information about how Systems Manager handles these options for the supported maintenance window task types, see MaintenanceWindowTaskInvocationParameters.

Parameters:

taskParameters - The parameters that should be passed to the task when it is run.

TaskParameters has been deprecated. To specify parameters to pass to a task when it runs, instead use the Parameters option in the TaskInvocationParameters structure. For information about how Systems Manager handles these options for the supported maintenance window task types, see MaintenanceWindowTaskInvocationParameters.

withTaskParameters

public RegisterTaskWithMaintenanceWindowRequest withTaskParameters(Map<String,MaintenanceWindowTaskParameterValueExpression> taskParameters)

The parameters that should be passed to the task when it is run.

TaskParameters has been deprecated. To specify parameters to pass to a task when it runs, instead use the Parameters option in the TaskInvocationParameters structure. For information about how Systems Manager handles these options for the supported maintenance window task types, see MaintenanceWindowTaskInvocationParameters.

Parameters:

taskParameters - The parameters that should be passed to the task when it is run.

TaskParameters has been deprecated. To specify parameters to pass to a task when it runs, instead use the Parameters option in the TaskInvocationParameters structure. For information about how Systems Manager handles these options for the supported maintenance window task types, see MaintenanceWindowTaskInvocationParameters.

Returns:

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

addTaskParametersEntry

public RegisterTaskWithMaintenanceWindowRequest addTaskParametersEntry(String key,
                                                                       MaintenanceWindowTaskParameterValueExpression value)

Add a single TaskParameters entry

See Also:

withTaskParameters(java.util.Map<java.lang.String, com.amazonaws.services.simplesystemsmanagement.model.MaintenanceWindowTaskParameterValueExpression>)

clearTaskParametersEntries

public RegisterTaskWithMaintenanceWindowRequest clearTaskParametersEntries()

Removes all the entries added into TaskParameters.

Returns:

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

setTaskInvocationParameters

public void setTaskInvocationParameters(MaintenanceWindowTaskInvocationParameters taskInvocationParameters)

The parameters that the task should use during execution. Populate only the fields that match the task type. All other fields should be empty.

Parameters:

taskInvocationParameters - The parameters that the task should use during execution. Populate only the fields that match the task type. All other fields should be empty.

getTaskInvocationParameters

public MaintenanceWindowTaskInvocationParameters getTaskInvocationParameters()

The parameters that the task should use during execution. Populate only the fields that match the task type. All other fields should be empty.

Returns:

The parameters that the task should use during execution. Populate only the fields that match the task type. All other fields should be empty.

withTaskInvocationParameters

public RegisterTaskWithMaintenanceWindowRequest withTaskInvocationParameters(MaintenanceWindowTaskInvocationParameters taskInvocationParameters)

The parameters that the task should use during execution. Populate only the fields that match the task type. All other fields should be empty.

Parameters:

taskInvocationParameters - The parameters that the task should use during execution. Populate only the fields that match the task type. All other fields should be empty.

Returns:

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

setPriority

public void setPriority(Integer priority)

The priority of the task in the maintenance window, the lower the number the higher the priority. Tasks in a maintenance window are scheduled in priority order with tasks that have the same priority scheduled in parallel.

Parameters:

priority - The priority of the task in the maintenance window, the lower the number the higher the priority. Tasks in a maintenance window are scheduled in priority order with tasks that have the same priority scheduled in parallel.

getPriority

public Integer getPriority()

The priority of the task in the maintenance window, the lower the number the higher the priority. Tasks in a maintenance window are scheduled in priority order with tasks that have the same priority scheduled in parallel.

Returns:

The priority of the task in the maintenance window, the lower the number the higher the priority. Tasks in a maintenance window are scheduled in priority order with tasks that have the same priority scheduled in parallel.

withPriority

public RegisterTaskWithMaintenanceWindowRequest withPriority(Integer priority)

The priority of the task in the maintenance window, the lower the number the higher the priority. Tasks in a maintenance window are scheduled in priority order with tasks that have the same priority scheduled in parallel.

Parameters:

priority - The priority of the task in the maintenance window, the lower the number the higher the priority. Tasks in a maintenance window are scheduled in priority order with tasks that have the same priority scheduled in parallel.

Returns:

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

setMaxConcurrency

public void setMaxConcurrency(String maxConcurrency)

The maximum number of targets this task can be run for, in parallel.

Although this element is listed as "Required: No", a value can be omitted only when you are registering or updating a targetless task You must provide a value in all other cases.

For maintenance window tasks without a target specified, you can't supply a value for this option. Instead, the system inserts a placeholder value of 1. This value doesn't affect the running of your task.

Parameters:

maxConcurrency - The maximum number of targets this task can be run for, in parallel.

Although this element is listed as "Required: No", a value can be omitted only when you are registering or updating a targetless task You must provide a value in all other cases.

For maintenance window tasks without a target specified, you can't supply a value for this option. Instead, the system inserts a placeholder value of 1. This value doesn't affect the running of your task.

getMaxConcurrency

public String getMaxConcurrency()

The maximum number of targets this task can be run for, in parallel.

Although this element is listed as "Required: No", a value can be omitted only when you are registering or updating a targetless task You must provide a value in all other cases.

For maintenance window tasks without a target specified, you can't supply a value for this option. Instead, the system inserts a placeholder value of 1. This value doesn't affect the running of your task.

Returns:

The maximum number of targets this task can be run for, in parallel.

Although this element is listed as "Required: No", a value can be omitted only when you are registering or updating a targetless task You must provide a value in all other cases.

For maintenance window tasks without a target specified, you can't supply a value for this option. Instead, the system inserts a placeholder value of 1. This value doesn't affect the running of your task.

withMaxConcurrency

public RegisterTaskWithMaintenanceWindowRequest withMaxConcurrency(String maxConcurrency)

The maximum number of targets this task can be run for, in parallel.

Although this element is listed as "Required: No", a value can be omitted only when you are registering or updating a targetless task You must provide a value in all other cases.

For maintenance window tasks without a target specified, you can't supply a value for this option. Instead, the system inserts a placeholder value of 1. This value doesn't affect the running of your task.

Parameters:

maxConcurrency - The maximum number of targets this task can be run for, in parallel.

Although this element is listed as "Required: No", a value can be omitted only when you are registering or updating a targetless task You must provide a value in all other cases.

For maintenance window tasks without a target specified, you can't supply a value for this option. Instead, the system inserts a placeholder value of 1. This value doesn't affect the running of your task.

Returns:

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

setMaxErrors

public void setMaxErrors(String maxErrors)

The maximum number of errors allowed before this task stops being scheduled.

Although this element is listed as "Required: No", a value can be omitted only when you are registering or updating a targetless task You must provide a value in all other cases.

For maintenance window tasks without a target specified, you can't supply a value for this option. Instead, the system inserts a placeholder value of 1. This value doesn't affect the running of your task.

Parameters:

maxErrors - The maximum number of errors allowed before this task stops being scheduled.

Although this element is listed as "Required: No", a value can be omitted only when you are registering or updating a targetless task You must provide a value in all other cases.

For maintenance window tasks without a target specified, you can't supply a value for this option. Instead, the system inserts a placeholder value of 1. This value doesn't affect the running of your task.

getMaxErrors

public String getMaxErrors()

The maximum number of errors allowed before this task stops being scheduled.

Although this element is listed as "Required: No", a value can be omitted only when you are registering or updating a targetless task You must provide a value in all other cases.

For maintenance window tasks without a target specified, you can't supply a value for this option. Instead, the system inserts a placeholder value of 1. This value doesn't affect the running of your task.

Returns:

The maximum number of errors allowed before this task stops being scheduled.

Although this element is listed as "Required: No", a value can be omitted only when you are registering or updating a targetless task You must provide a value in all other cases.

For maintenance window tasks without a target specified, you can't supply a value for this option. Instead, the system inserts a placeholder value of 1. This value doesn't affect the running of your task.

withMaxErrors

public RegisterTaskWithMaintenanceWindowRequest withMaxErrors(String maxErrors)

The maximum number of errors allowed before this task stops being scheduled.

Although this element is listed as "Required: No", a value can be omitted only when you are registering or updating a targetless task You must provide a value in all other cases.

For maintenance window tasks without a target specified, you can't supply a value for this option. Instead, the system inserts a placeholder value of 1. This value doesn't affect the running of your task.

Parameters:

maxErrors - The maximum number of errors allowed before this task stops being scheduled.

Although this element is listed as "Required: No", a value can be omitted only when you are registering or updating a targetless task You must provide a value in all other cases.

For maintenance window tasks without a target specified, you can't supply a value for this option. Instead, the system inserts a placeholder value of 1. This value doesn't affect the running of your task.

Returns:

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

setLoggingInfo

public void setLoggingInfo(LoggingInfo loggingInfo)

A structure containing information about an Amazon Simple Storage Service (Amazon S3) bucket to write managed node-level logs to.

LoggingInfo has been deprecated. To specify an Amazon Simple Storage Service (Amazon S3) bucket to contain logs, instead use the OutputS3BucketName and OutputS3KeyPrefix options in the TaskInvocationParameters structure. For information about how Amazon Web Services Systems Manager handles these options for the supported maintenance window task types, see MaintenanceWindowTaskInvocationParameters.

Parameters:

loggingInfo - A structure containing information about an Amazon Simple Storage Service (Amazon S3) bucket to write managed node-level logs to.

LoggingInfo has been deprecated. To specify an Amazon Simple Storage Service (Amazon S3) bucket to contain logs, instead use the OutputS3BucketName and OutputS3KeyPrefix options in the TaskInvocationParameters structure. For information about how Amazon Web Services Systems Manager handles these options for the supported maintenance window task types, see MaintenanceWindowTaskInvocationParameters.

getLoggingInfo

public LoggingInfo getLoggingInfo()

A structure containing information about an Amazon Simple Storage Service (Amazon S3) bucket to write managed node-level logs to.

LoggingInfo has been deprecated. To specify an Amazon Simple Storage Service (Amazon S3) bucket to contain logs, instead use the OutputS3BucketName and OutputS3KeyPrefix options in the TaskInvocationParameters structure. For information about how Amazon Web Services Systems Manager handles these options for the supported maintenance window task types, see MaintenanceWindowTaskInvocationParameters.

Returns:

A structure containing information about an Amazon Simple Storage Service (Amazon S3) bucket to write managed node-level logs to.

LoggingInfo has been deprecated. To specify an Amazon Simple Storage Service (Amazon S3) bucket to contain logs, instead use the OutputS3BucketName and OutputS3KeyPrefix options in the TaskInvocationParameters structure. For information about how Amazon Web Services Systems Manager handles these options for the supported maintenance window task types, see MaintenanceWindowTaskInvocationParameters.

withLoggingInfo

public RegisterTaskWithMaintenanceWindowRequest withLoggingInfo(LoggingInfo loggingInfo)

A structure containing information about an Amazon Simple Storage Service (Amazon S3) bucket to write managed node-level logs to.

LoggingInfo has been deprecated. To specify an Amazon Simple Storage Service (Amazon S3) bucket to contain logs, instead use the OutputS3BucketName and OutputS3KeyPrefix options in the TaskInvocationParameters structure. For information about how Amazon Web Services Systems Manager handles these options for the supported maintenance window task types, see MaintenanceWindowTaskInvocationParameters.

Parameters:

loggingInfo - A structure containing information about an Amazon Simple Storage Service (Amazon S3) bucket to write managed node-level logs to.

LoggingInfo has been deprecated. To specify an Amazon Simple Storage Service (Amazon S3) bucket to contain logs, instead use the OutputS3BucketName and OutputS3KeyPrefix options in the TaskInvocationParameters structure. For information about how Amazon Web Services Systems Manager handles these options for the supported maintenance window task types, see MaintenanceWindowTaskInvocationParameters.

Returns:

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

setName

public void setName(String name)

An optional name for the task.

Parameters:

name - An optional name for the task.

getName

public String getName()

An optional name for the task.

Returns:

An optional name for the task.

withName

public RegisterTaskWithMaintenanceWindowRequest withName(String name)

An optional name for the task.

Parameters:

name - An optional name for the task.

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

Parameters:

description - An optional description for the task.

getDescription

public String getDescription()

An optional description for the task.

Returns:

An optional description for the task.

withDescription

public RegisterTaskWithMaintenanceWindowRequest withDescription(String description)

An optional description for the task.

Parameters:

description - An optional description for the task.

Returns:

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

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

setCutoffBehavior

public void setCutoffBehavior(String cutoffBehavior)

Indicates whether tasks should continue to run after the cutoff time specified in the maintenance windows is reached.

• CONTINUE_TASK: When the cutoff time is reached, any tasks that are running continue. The default value.

• CANCEL_TASK:

  • For Automation, Lambda, Step Functions tasks: When the cutoff time is reached, any task invocations that are already running continue, but no new task invocations are started.

  • For Run Command tasks: When the cutoff time is reached, the system sends a CancelCommand operation that attempts to cancel the command associated with the task. However, there is no guarantee that the command will be terminated and the underlying process stopped.

  The status for tasks that are not completed is TIMED_OUT.

Parameters:

cutoffBehavior - Indicates whether tasks should continue to run after the cutoff time specified in the maintenance windows is reached.

• CONTINUE_TASK: When the cutoff time is reached, any tasks that are running continue. The default value.

• CANCEL_TASK:

  • For Automation, Lambda, Step Functions tasks: When the cutoff time is reached, any task invocations that are already running continue, but no new task invocations are started.

  • For Run Command tasks: When the cutoff time is reached, the system sends a CancelCommand operation that attempts to cancel the command associated with the task. However, there is no guarantee that the command will be terminated and the underlying process stopped.

  The status for tasks that are not completed is TIMED_OUT.

See Also:

MaintenanceWindowTaskCutoffBehavior

getCutoffBehavior

public String getCutoffBehavior()

Indicates whether tasks should continue to run after the cutoff time specified in the maintenance windows is reached.

• CONTINUE_TASK: When the cutoff time is reached, any tasks that are running continue. The default value.

• CANCEL_TASK:

  • For Automation, Lambda, Step Functions tasks: When the cutoff time is reached, any task invocations that are already running continue, but no new task invocations are started.

  • For Run Command tasks: When the cutoff time is reached, the system sends a CancelCommand operation that attempts to cancel the command associated with the task. However, there is no guarantee that the command will be terminated and the underlying process stopped.

  The status for tasks that are not completed is TIMED_OUT.

Returns:

Indicates whether tasks should continue to run after the cutoff time specified in the maintenance windows is reached.

• CONTINUE_TASK: When the cutoff time is reached, any tasks that are running continue. The default value.

• CANCEL_TASK:

  • For Automation, Lambda, Step Functions tasks: When the cutoff time is reached, any task invocations that are already running continue, but no new task invocations are started.

  • For Run Command tasks: When the cutoff time is reached, the system sends a CancelCommand operation that attempts to cancel the command associated with the task. However, there is no guarantee that the command will be terminated and the underlying process stopped.

  The status for tasks that are not completed is TIMED_OUT.

See Also:

MaintenanceWindowTaskCutoffBehavior

withCutoffBehavior

public RegisterTaskWithMaintenanceWindowRequest withCutoffBehavior(String cutoffBehavior)

Indicates whether tasks should continue to run after the cutoff time specified in the maintenance windows is reached.

• CONTINUE_TASK: When the cutoff time is reached, any tasks that are running continue. The default value.

• CANCEL_TASK:

  • For Automation, Lambda, Step Functions tasks: When the cutoff time is reached, any task invocations that are already running continue, but no new task invocations are started.

  • For Run Command tasks: When the cutoff time is reached, the system sends a CancelCommand operation that attempts to cancel the command associated with the task. However, there is no guarantee that the command will be terminated and the underlying process stopped.

  The status for tasks that are not completed is TIMED_OUT.

Parameters:

cutoffBehavior - Indicates whether tasks should continue to run after the cutoff time specified in the maintenance windows is reached.

• CONTINUE_TASK: When the cutoff time is reached, any tasks that are running continue. The default value.

• CANCEL_TASK:

  • For Automation, Lambda, Step Functions tasks: When the cutoff time is reached, any task invocations that are already running continue, but no new task invocations are started.

  • For Run Command tasks: When the cutoff time is reached, the system sends a CancelCommand operation that attempts to cancel the command associated with the task. However, there is no guarantee that the command will be terminated and the underlying process stopped.

  The status for tasks that are not completed is TIMED_OUT.

Returns:

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

See Also:

MaintenanceWindowTaskCutoffBehavior

setCutoffBehavior

public void setCutoffBehavior(MaintenanceWindowTaskCutoffBehavior cutoffBehavior)

Indicates whether tasks should continue to run after the cutoff time specified in the maintenance windows is reached.

• CONTINUE_TASK: When the cutoff time is reached, any tasks that are running continue. The default value.

• CANCEL_TASK:

  • For Automation, Lambda, Step Functions tasks: When the cutoff time is reached, any task invocations that are already running continue, but no new task invocations are started.

  • For Run Command tasks: When the cutoff time is reached, the system sends a CancelCommand operation that attempts to cancel the command associated with the task. However, there is no guarantee that the command will be terminated and the underlying process stopped.

  The status for tasks that are not completed is TIMED_OUT.

Parameters:

cutoffBehavior - Indicates whether tasks should continue to run after the cutoff time specified in the maintenance windows is reached.

• CONTINUE_TASK: When the cutoff time is reached, any tasks that are running continue. The default value.

• CANCEL_TASK:

  • For Automation, Lambda, Step Functions tasks: When the cutoff time is reached, any task invocations that are already running continue, but no new task invocations are started.

  • For Run Command tasks: When the cutoff time is reached, the system sends a CancelCommand operation that attempts to cancel the command associated with the task. However, there is no guarantee that the command will be terminated and the underlying process stopped.

  The status for tasks that are not completed is TIMED_OUT.

See Also:

MaintenanceWindowTaskCutoffBehavior

withCutoffBehavior

public RegisterTaskWithMaintenanceWindowRequest withCutoffBehavior(MaintenanceWindowTaskCutoffBehavior cutoffBehavior)

Indicates whether tasks should continue to run after the cutoff time specified in the maintenance windows is reached.

• CONTINUE_TASK: When the cutoff time is reached, any tasks that are running continue. The default value.

• CANCEL_TASK:

  • For Automation, Lambda, Step Functions tasks: When the cutoff time is reached, any task invocations that are already running continue, but no new task invocations are started.

  • For Run Command tasks: When the cutoff time is reached, the system sends a CancelCommand operation that attempts to cancel the command associated with the task. However, there is no guarantee that the command will be terminated and the underlying process stopped.

  The status for tasks that are not completed is TIMED_OUT.

Parameters:

cutoffBehavior - Indicates whether tasks should continue to run after the cutoff time specified in the maintenance windows is reached.

• CONTINUE_TASK: When the cutoff time is reached, any tasks that are running continue. The default value.

• CANCEL_TASK:

  • For Automation, Lambda, Step Functions tasks: When the cutoff time is reached, any task invocations that are already running continue, but no new task invocations are started.

  • For Run Command tasks: When the cutoff time is reached, the system sends a CancelCommand operation that attempts to cancel the command associated with the task. However, there is no guarantee that the command will be terminated and the underlying process stopped.

  The status for tasks that are not completed is TIMED_OUT.

Returns:

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

See Also:

MaintenanceWindowTaskCutoffBehavior

setAlarmConfiguration

public void setAlarmConfiguration(AlarmConfiguration alarmConfiguration)

The CloudWatch alarm you want to apply to your maintenance window task.

Parameters:

alarmConfiguration - The CloudWatch alarm you want to apply to your maintenance window task.

getAlarmConfiguration

public AlarmConfiguration getAlarmConfiguration()

The CloudWatch alarm you want to apply to your maintenance window task.

Returns:

The CloudWatch alarm you want to apply to your maintenance window task.

withAlarmConfiguration

public RegisterTaskWithMaintenanceWindowRequest withAlarmConfiguration(AlarmConfiguration alarmConfiguration)

The CloudWatch alarm you want to apply to your maintenance window task.

Parameters:

alarmConfiguration - The CloudWatch alarm you want to apply to your maintenance window task.

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 RegisterTaskWithMaintenanceWindowRequest 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()