MaintenanceWindowTask (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.simplesystemsmanagement.model.MaintenanceWindowTask

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class MaintenanceWindowTask
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Information about a task defined for a Maintenance Window.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

MaintenanceWindowTask()

Constructors
Constructor and Description
`MaintenanceWindowTask()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`MaintenanceWindowTask`	`addTaskParametersEntry(String key, MaintenanceWindowTaskParameterValueExpression value)`
`MaintenanceWindowTask`	`clearTaskParametersEntries()` Removes all the entries added into TaskParameters.
`MaintenanceWindowTask`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getDescription()` A description of the task.
`LoggingInfo`	`getLoggingInfo()` Information about an Amazon S3 bucket to write task-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()` The task name.
`Integer`	`getPriority()` The priority of the task in the Maintenance Window.
`String`	`getServiceRoleArn()` The role that should be assumed when executing the task
`List<Target>`	`getTargets()` The targets (either instances or tags).
`String`	`getTaskArn()` The resource that the task uses during execution.
`Map<String,MaintenanceWindowTaskParameterValueExpression>`	`getTaskParameters()` The parameters that should be passed to the task when it is executed.
`String`	`getType()` The type of task.
`String`	`getWindowId()` The Maintenance Window ID where the task is registered.
`String`	`getWindowTaskId()` The task ID.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setDescription(String description)` A description of the task.
`void`	`setLoggingInfo(LoggingInfo loggingInfo)` Information about an Amazon S3 bucket to write task-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)` The task name.
`void`	`setPriority(Integer priority)` The priority of the task in the Maintenance Window.
`void`	`setServiceRoleArn(String serviceRoleArn)` The role that should be assumed when executing the task
`void`	`setTargets(Collection<Target> targets)` The targets (either instances or tags).
`void`	`setTaskArn(String taskArn)` The resource that the task uses during execution.
`void`	`setTaskParameters(Map<String,MaintenanceWindowTaskParameterValueExpression> taskParameters)` The parameters that should be passed to the task when it is executed.
`void`	`setType(MaintenanceWindowTaskType type)` The type of task.
`void`	`setType(String type)` The type of task.
`void`	`setWindowId(String windowId)` The Maintenance Window ID where the task is registered.
`void`	`setWindowTaskId(String windowTaskId)` The task ID.
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`MaintenanceWindowTask`	`withDescription(String description)` A description of the task.
`MaintenanceWindowTask`	`withLoggingInfo(LoggingInfo loggingInfo)` Information about an Amazon S3 bucket to write task-level logs to.
`MaintenanceWindowTask`	`withMaxConcurrency(String maxConcurrency)` The maximum number of targets this task can be run for in parallel.
`MaintenanceWindowTask`	`withMaxErrors(String maxErrors)` The maximum number of errors allowed before this task stops being scheduled.
`MaintenanceWindowTask`	`withName(String name)` The task name.
`MaintenanceWindowTask`	`withPriority(Integer priority)` The priority of the task in the Maintenance Window.
`MaintenanceWindowTask`	`withServiceRoleArn(String serviceRoleArn)` The role that should be assumed when executing the task
`MaintenanceWindowTask`	`withTargets(Collection<Target> targets)` The targets (either instances or tags).
`MaintenanceWindowTask`	`withTargets(Target... targets)` The targets (either instances or tags).
`MaintenanceWindowTask`	`withTaskArn(String taskArn)` The resource that the task uses during execution.
`MaintenanceWindowTask`	`withTaskParameters(Map<String,MaintenanceWindowTaskParameterValueExpression> taskParameters)` The parameters that should be passed to the task when it is executed.
`MaintenanceWindowTask`	`withType(MaintenanceWindowTaskType type)` The type of task.
`MaintenanceWindowTask`	`withType(String type)` The type of task.
`MaintenanceWindowTask`	`withWindowId(String windowId)` The Maintenance Window ID where the task is registered.
`MaintenanceWindowTask`	`withWindowTaskId(String windowTaskId)` The task ID.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - MaintenanceWindowTask
```
public MaintenanceWindowTask()
```
- Method Detail
  - setWindowId
```
public void setWindowId(String windowId)
```
    The Maintenance Window ID where the task is registered.
    
    Parameters:
    
    windowId - The Maintenance Window ID where the task is registered.
  - getWindowId
```
public String getWindowId()
```
    The Maintenance Window ID where the task is registered.
    
    Returns:
    
    The Maintenance Window ID where the task is registered.
  - withWindowId
```
public MaintenanceWindowTask withWindowId(String windowId)
```
    The Maintenance Window ID where the task is registered.
    
    Parameters:
    
    windowId - The Maintenance Window ID where the task is registered.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setWindowTaskId
```
public void setWindowTaskId(String windowTaskId)
```
    The task ID.
    
    Parameters:
    
    windowTaskId - The task ID.
  - getWindowTaskId
```
public String getWindowTaskId()
```
    The task ID.
    
    Returns:
    
    The task ID.
  - withWindowTaskId
```
public MaintenanceWindowTask withWindowTaskId(String windowTaskId)
```
    The task ID.
    
    Parameters:
    
    windowTaskId - The task ID.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTaskArn
```
public void setTaskArn(String taskArn)
```
    The resource that the task uses during execution. For RUN_COMMAND and AUTOMATION task types, TaskArn is the Systems Manager document name or ARN. For LAMBDA tasks, it's the function name or ARN. For STEP_FUNCTION tasks, it's the state machine ARN.
    
    Parameters:
    
    taskArn - The resource that the task uses during execution. For RUN_COMMAND and AUTOMATION task types, TaskArn is the Systems Manager document name or ARN. For LAMBDA tasks, it's the function name or ARN. For STEP_FUNCTION tasks, it's the state machine ARN.
  - getTaskArn
```
public String getTaskArn()
```
    The resource that the task uses during execution. For RUN_COMMAND and AUTOMATION task types, TaskArn is the Systems Manager document name or ARN. For LAMBDA tasks, it's the function name or ARN. For STEP_FUNCTION tasks, it's the state machine ARN.
    
    Returns:
    
    The resource that the task uses during execution. For RUN_COMMAND and AUTOMATION task types, TaskArn is the Systems Manager document name or ARN. For LAMBDA tasks, it's the function name or ARN. For STEP_FUNCTION tasks, it's the state machine ARN.
  - withTaskArn
```
public MaintenanceWindowTask withTaskArn(String taskArn)
```
    The resource that the task uses during execution. For RUN_COMMAND and AUTOMATION task types, TaskArn is the Systems Manager document name or ARN. For LAMBDA tasks, it's the function name or ARN. For STEP_FUNCTION tasks, it's the state machine ARN.
    
    Parameters:
    
    taskArn - The resource that the task uses during execution. For RUN_COMMAND and AUTOMATION task types, TaskArn is the Systems Manager document name or ARN. For LAMBDA tasks, it's the function name or ARN. For STEP_FUNCTION tasks, it's the state machine ARN.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setType
```
public void setType(String type)
```
    The type of task. The type can be one of the following: RUN_COMMAND, AUTOMATION, LAMBDA, or STEP_FUNCTION.
    
    Parameters:
    
    type - The type of task. The type can be one of the following: RUN_COMMAND, AUTOMATION, LAMBDA, or STEP_FUNCTION.
    
    See Also:
    
    MaintenanceWindowTaskType
  - getType
```
public String getType()
```
    The type of task. The type can be one of the following: RUN_COMMAND, AUTOMATION, LAMBDA, or STEP_FUNCTION.
    
    Returns:
    
    The type of task. The type can be one of the following: RUN_COMMAND, AUTOMATION, LAMBDA, or STEP_FUNCTION.
    
    See Also:
    
    MaintenanceWindowTaskType
  - withType
```
public MaintenanceWindowTask withType(String type)
```
    The type of task. The type can be one of the following: RUN_COMMAND, AUTOMATION, LAMBDA, or STEP_FUNCTION.
    
    Parameters:
    
    type - The type of task. The type can be one of the following: RUN_COMMAND, AUTOMATION, LAMBDA, or STEP_FUNCTION.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    MaintenanceWindowTaskType
  - setType
```
public void setType(MaintenanceWindowTaskType type)
```
    The type of task. The type can be one of the following: RUN_COMMAND, AUTOMATION, LAMBDA, or STEP_FUNCTION.
    
    Parameters:
    
    type - The type of task. The type can be one of the following: RUN_COMMAND, AUTOMATION, LAMBDA, or STEP_FUNCTION.
    
    See Also:
    
    MaintenanceWindowTaskType
  - withType
```
public MaintenanceWindowTask withType(MaintenanceWindowTaskType type)
```
    The type of task. The type can be one of the following: RUN_COMMAND, AUTOMATION, LAMBDA, or STEP_FUNCTION.
    
    Parameters:
    
    type - The type of task. The type can be one of the following: RUN_COMMAND, AUTOMATION, LAMBDA, or STEP_FUNCTION.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    MaintenanceWindowTaskType
  - getTargets
```
public List<Target> getTargets()
```
    The targets (either instances or tags). Instances are specified using Key=instanceids,Values=<instanceid1>,<instanceid2>. Tags are specified using Key=<tag name>,Values=<tag value>.
    
    Returns:
    
    The targets (either instances or tags). Instances are specified using Key=instanceids,Values=<instanceid1>,<instanceid2>. Tags are specified using Key=<tag name>,Values=<tag value>.
  - setTargets
```
public void setTargets(Collection<Target> targets)
```
    The targets (either instances or tags). Instances are specified using Key=instanceids,Values=<instanceid1>,<instanceid2>. Tags are specified using Key=<tag name>,Values=<tag value>.
    
    Parameters:
    
    targets - The targets (either instances or tags). Instances are specified using Key=instanceids,Values=<instanceid1>,<instanceid2>. Tags are specified using Key=<tag name>,Values=<tag value>.
  - withTargets
```
public MaintenanceWindowTask withTargets(Target... targets)
```
    The targets (either instances or tags). Instances are specified using Key=instanceids,Values=<instanceid1>,<instanceid2>. Tags are specified using Key=<tag name>,Values=<tag value>.
    
    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 instances or tags). Instances are specified using Key=instanceids,Values=<instanceid1>,<instanceid2>. Tags are specified using Key=<tag name>,Values=<tag value>.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withTargets
```
public MaintenanceWindowTask withTargets(Collection<Target> targets)
```
    The targets (either instances or tags). Instances are specified using Key=instanceids,Values=<instanceid1>,<instanceid2>. Tags are specified using Key=<tag name>,Values=<tag value>.
    
    Parameters:
    
    targets - The targets (either instances or tags). Instances are specified using Key=instanceids,Values=<instanceid1>,<instanceid2>. Tags are specified using Key=<tag name>,Values=<tag value>.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getTaskParameters
```
public Map<String,MaintenanceWindowTaskParameterValueExpression> getTaskParameters()
```
    The parameters that should be passed to the task when it is executed.
    
    Returns:
    
    The parameters that should be passed to the task when it is executed.
  - setTaskParameters
```
public void setTaskParameters(Map<String,MaintenanceWindowTaskParameterValueExpression> taskParameters)
```
    The parameters that should be passed to the task when it is executed.
    
    Parameters:
    
    taskParameters - The parameters that should be passed to the task when it is executed.
  - withTaskParameters
```
public MaintenanceWindowTask withTaskParameters(Map<String,MaintenanceWindowTaskParameterValueExpression> taskParameters)
```
    The parameters that should be passed to the task when it is executed.
    
    Parameters:
    
    taskParameters - The parameters that should be passed to the task when it is executed.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addTaskParametersEntry
```
public MaintenanceWindowTask addTaskParametersEntry(String key,
                                                    MaintenanceWindowTaskParameterValueExpression value)
```
  - clearTaskParametersEntries
```
public MaintenanceWindowTask clearTaskParametersEntries()
```
    Removes all the entries added into TaskParameters.
    
    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 that have the same priority are scheduled in parallel.
    
    Parameters:
    
    priority - The priority of the task in the Maintenance Window. The lower the number, the higher the priority. Tasks that have the same priority are 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 that have the same priority are scheduled in parallel.
    
    Returns:
    
    The priority of the task in the Maintenance Window. The lower the number, the higher the priority. Tasks that have the same priority are scheduled in parallel.
  - withPriority
```
public MaintenanceWindowTask withPriority(Integer priority)
```
    The priority of the task in the Maintenance Window. The lower the number, the higher the priority. Tasks that have the same priority are scheduled in parallel.
    
    Parameters:
    
    priority - The priority of the task in the Maintenance Window. The lower the number, the higher the priority. Tasks that have the same priority are scheduled in parallel.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setLoggingInfo
```
public void setLoggingInfo(LoggingInfo loggingInfo)
```
    Information about an Amazon S3 bucket to write task-level logs to.
    
    Parameters:
    
    loggingInfo - Information about an Amazon S3 bucket to write task-level logs to.
  - getLoggingInfo
```
public LoggingInfo getLoggingInfo()
```
    Information about an Amazon S3 bucket to write task-level logs to.
    
    Returns:
    
    Information about an Amazon S3 bucket to write task-level logs to.
  - withLoggingInfo
```
public MaintenanceWindowTask withLoggingInfo(LoggingInfo loggingInfo)
```
    Information about an Amazon S3 bucket to write task-level logs to.
    
    Parameters:
    
    loggingInfo - Information about an Amazon S3 bucket to write task-level logs to.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setServiceRoleArn
```
public void setServiceRoleArn(String serviceRoleArn)
```
    The role that should be assumed when executing the task
    
    Parameters:
    
    serviceRoleArn - The role that should be assumed when executing the task
  - getServiceRoleArn
```
public String getServiceRoleArn()
```
    The role that should be assumed when executing the task
    
    Returns:
    
    The role that should be assumed when executing the task
  - withServiceRoleArn
```
public MaintenanceWindowTask withServiceRoleArn(String serviceRoleArn)
```
    The role that should be assumed when executing the task
    
    Parameters:
    
    serviceRoleArn - The role that should be assumed when executing the task
    
    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.
    
    Parameters:
    
    maxConcurrency - The maximum number of targets this task can be run for in parallel.
  - getMaxConcurrency
```
public String getMaxConcurrency()
```
    The maximum number of targets this task can be run for in parallel.
    
    Returns:
    
    The maximum number of targets this task can be run for in parallel.
  - withMaxConcurrency
```
public MaintenanceWindowTask withMaxConcurrency(String maxConcurrency)
```
    The maximum number of targets this task can be run for in parallel.
    
    Parameters:
    
    maxConcurrency - The maximum number of targets this task can be run for in parallel.
    
    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.
    
    Parameters:
    
    maxErrors - The maximum number of errors allowed before this task stops being scheduled.
  - getMaxErrors
```
public String getMaxErrors()
```
    The maximum number of errors allowed before this task stops being scheduled.
    
    Returns:
    
    The maximum number of errors allowed before this task stops being scheduled.
  - withMaxErrors
```
public MaintenanceWindowTask withMaxErrors(String maxErrors)
```
    The maximum number of errors allowed before this task stops being scheduled.
    
    Parameters:
    
    maxErrors - The maximum number of errors allowed before this task stops being scheduled.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setName
```
public void setName(String name)
```
    The task name.
    
    Parameters:
    
    name - The task name.
  - getName
```
public String getName()
```
    The task name.
    
    Returns:
    
    The task name.
  - withName
```
public MaintenanceWindowTask withName(String name)
```
    The task name.
    
    Parameters:
    
    name - The task name.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDescription
```
public void setDescription(String description)
```
    A description of the task.
    
    Parameters:
    
    description - A description of the task.
  - getDescription
```
public String getDescription()
```
    A description of the task.
    
    Returns:
    
    A description of the task.
  - withDescription
```
public MaintenanceWindowTask withDescription(String description)
```
    A description of the task.
    
    Parameters:
    
    description - A description of the 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; useful for testing and debugging.
    
    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 MaintenanceWindowTask clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class MaintenanceWindowTask

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

MaintenanceWindowTask

Method Detail

setWindowId

getWindowId

withWindowId

setWindowTaskId

getWindowTaskId

withWindowTaskId

setTaskArn

getTaskArn

withTaskArn

setType

getType

withType

setType

withType

getTargets

setTargets

withTargets

withTargets

getTaskParameters

setTaskParameters

withTaskParameters

addTaskParametersEntry

clearTaskParametersEntries

setPriority

getPriority

withPriority

setLoggingInfo

getLoggingInfo

withLoggingInfo

setServiceRoleArn

getServiceRoleArn

withServiceRoleArn

setMaxConcurrency

getMaxConcurrency

withMaxConcurrency

setMaxErrors

getMaxErrors

withMaxErrors

setName

getName

withName

setDescription

getDescription

withDescription

toString

equals

hashCode

clone

marshall