MaintenanceWindowTask (AWS Java SDK :: Services :: AWS Simple Systems Management (SSM) 2.7.22 API)

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

Nested Classes
Modifier and Type	Class and Description
`static interface`	`MaintenanceWindowTask.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
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)`
`<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.
`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()`
`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
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

- Method Detail
  - windowId
```
public 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 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_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 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 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
  - 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 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.
    
    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 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.
    
    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 Amazon 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 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 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()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<MaintenanceWindowTask.Builder,MaintenanceWindowTask>
  - 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
  - equalsBySdkFields
```
public boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - 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
  - getValueForField
```
public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)
```
  - sdkFields
```
public List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class MaintenanceWindowTask

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

windowId

windowTaskId

taskArn

type

typeAsString

targets

taskParameters

priority

loggingInfo

serviceRoleArn

maxConcurrency

maxErrors

name

description

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields