software.amazon.awssdk.services.ssm.model

Class MaintenanceWindowTask

java.lang.Object

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

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<MaintenanceWindowTask.Builder,MaintenanceWindowTask>

@Generated(value="software.amazon.awssdk:codegen")
public final class MaintenanceWindowTask
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<MaintenanceWindowTask.Builder,MaintenanceWindowTask>

Information about a task defined for a maintenance window.

See Also:

Serialized Form

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)
boolean	equalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasTargets() Returns true if the Targets property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
boolean	hasTaskParameters() Returns true if the TaskParameters property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
LoggingInfo	loggingInfo() Information about an S3 bucket to write task-level logs to.
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.
List<SdkField<?>>	sdkFields()
static Class<? extends MaintenanceWindowTask.Builder>	serializableBuilderClass()
String	serviceRoleArn() The ARN of the IAM service role to use to publish Amazon Simple Notification Service (Amazon SNS) notifications for maintenance window Run Command tasks.
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 run.
MaintenanceWindowTask.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString() Returns a string representation of this object.
MaintenanceWindowTaskType	type() The type of task.
String	typeAsString() The type of task.
String	windowId() The ID of the maintenance window 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 final String windowId()

The ID of the maintenance window where the task is registered.

Returns:

The ID of the maintenance window where the task is registered.

windowTaskId

public final String windowTaskId()

The task ID.

Returns:

The task ID.

taskArn

public final 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_FUNCTIONS 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_FUNCTIONS tasks, it's the state machine ARN.

type

public final MaintenanceWindowTaskType type()

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

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

Returns:

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

See Also:

MaintenanceWindowTaskType

typeAsString

public final String typeAsString()

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

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

Returns:

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

See Also:

MaintenanceWindowTaskType

hasTargets

public final boolean hasTargets()

Returns true if the Targets property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

targets

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

You can use hasTargets() to see if a value was sent in this field.

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

hasTaskParameters

public final boolean hasTaskParameters()

Returns true if the TaskParameters property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

taskParameters

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

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

You can use hasTaskParameters() to see if a value was sent in this field.

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.

priority

public final 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 final LoggingInfo loggingInfo()

Information about an S3 bucket to write task-level logs to.

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

Returns:

Information about an S3 bucket to write task-level logs to.

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

serviceRoleArn

public final String serviceRoleArn()

The ARN of the IAM service role to use to publish Amazon Simple Notification Service (Amazon SNS) notifications for maintenance window Run Command tasks.

Returns:

The ARN of the IAM service role to use to publish Amazon Simple Notification Service (Amazon SNS) notifications for maintenance window Run Command tasks.

maxConcurrency

public final 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 final 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 final String name()

The task name.

Returns:

The task name.

description

public final 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 final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Description copied from interface: SdkPojo

Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

Specified by:

equalsBySdkFields in interface SdkPojo

Parameters:

obj - the object to be compared with

Returns:

true if the other object equals to this object by sdk fields, false otherwise.

toString

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

getValueForField

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

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.