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(value="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 and Description
static interface	MaintenanceWindowTask.Builder

Method Summary

Modifier and Type	Method and Description
static MaintenanceWindowTask.Builder	builder()
String	description() A description of the task.
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
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.
String	name() The task name.
Integer	priority() The priority of the task in the Maintenance Window.
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 resource that the task uses during execution.
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()
MaintenanceWindowTaskType	type() The type of task.
String	typeString() 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

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

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

type

public MaintenanceWindowTaskType type()

The type of task. The type can be one of the following: RUN_COMMAND, AUTOMATION, LAMBDA, or STEP_FUNCTION.

If the service returns an enum value that is not available in the current SDK version, type will return MaintenanceWindowTaskType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeString().

Returns:

The type of task. The type can be one of the following: RUN_COMMAND, AUTOMATION, LAMBDA, or STEP_FUNCTION.

See Also:

MaintenanceWindowTaskType

typeString

public String typeString()

The type of task. The type can be one of the following: RUN_COMMAND, AUTOMATION, LAMBDA, or STEP_FUNCTION.

If the service returns an enum value that is not available in the current SDK version, type will return MaintenanceWindowTaskType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeString().

Returns:

The type of task. The type can be one of the following: RUN_COMMAND, AUTOMATION, LAMBDA, or STEP_FUNCTION.

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

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

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.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

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

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.

name

public String name()

The task name.

Returns:

The task name.

description

public String description()

A description of the task.

Returns:

A description of the task.

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

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

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.