Package software.amazon.awssdk.services.ssm.model

Class MaintenanceWindowTask

java.lang.Object

software.amazon.awssdk.services.ssm.model.MaintenanceWindowTask

All Implemented Interfaces:

StructuredPojo, ToCopyableBuilder<MaintenanceWindowTask.Builder,MaintenanceWindowTask>

@Generated("software.amazon.awssdk:codegen")
public class MaintenanceWindowTask
extends Object
implements StructuredPojo, ToCopyableBuilder<MaintenanceWindowTask.Builder,MaintenanceWindowTask>

Information about a task defined for a Maintenance Window.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	MaintenanceWindowTask.Builder

Method Summary

Modifier and Type	Method	Description
static MaintenanceWindowTask.Builder	builder()
boolean	equals(Object obj)
int	hashCode()
LoggingInfo	loggingInfo()	Information about an Amazon S3 bucket to write task-level logs to.
void	marshall(ProtocolMarshaller protocolMarshaller)	Marshalls this structured data using the given ProtocolMarshaller.
String	maxConcurrency()	The maximum number of targets this task can be run for in parallel.
String	maxErrors()	The maximum number of errors allowed before this task stops being scheduled.
Integer	priority()	The priority of the task in the Maintenance Window, the lower the number the higher the priority.
static Class<? extends MaintenanceWindowTask.Builder>	serializableBuilderClass()
String	serviceRoleArn()	The role that should be assumed when executing the task
List<Target>	targets()	The targets (either instances or tags).
String	taskArn()	The ARN of the task to execute.
Map<String,MaintenanceWindowTaskParameterValueExpression>	taskParameters()	The parameters that should be passed to the task when it is executed.
MaintenanceWindowTask.Builder	toBuilder()	Take this object and create a builder that contains all of the current property values of this object.
String	toString()
String	type()	The type of task.
String	windowId()	The Maintenance Window ID where the task is registered.
String	windowTaskId()	The task ID.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

windowId

public String windowId()

The Maintenance Window ID where the task is registered.

Returns:

The Maintenance Window ID where the task is registered.

windowTaskId

public String windowTaskId()

The task ID.

Returns:

The task ID.

taskArn

public String taskArn()

The ARN of the task to execute.

Returns:

The ARN of the task to execute.

type

public String type()

The type of task.

Returns:

The type of task.

See Also:

MaintenanceWindowTaskType

targets

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

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

taskParameters

public Map<String,MaintenanceWindowTaskParameterValueExpression> taskParameters()

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.

priority

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

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.

loggingInfo

public LoggingInfo loggingInfo()

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.

serviceRoleArn

public String serviceRoleArn()

The role that should be assumed when executing the task

Returns:

The role that should be assumed when executing the task

maxConcurrency

public String maxConcurrency()

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.

maxErrors

public String maxErrors()

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.

toBuilder

public MaintenanceWindowTask.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<MaintenanceWindowTask.Builder,MaintenanceWindowTask>

Returns:

a builder for type T

builder

public static MaintenanceWindowTask.Builder builder()

serializableBuilderClass

public static Class<? extends MaintenanceWindowTask.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

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