UpdateMaintenanceWindowTaskRequest (AWS SDK for Java

java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.ssm.model.SsmRequest
    - - software.amazon.awssdk.services.ssm.model.UpdateMaintenanceWindowTaskRequest

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<UpdateMaintenanceWindowTaskRequest.Builder,UpdateMaintenanceWindowTaskRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class UpdateMaintenanceWindowTaskRequest
extends SsmRequest
implements ToCopyableBuilder<UpdateMaintenanceWindowTaskRequest.Builder,UpdateMaintenanceWindowTaskRequest>

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface UpdateMaintenanceWindowTaskRequest.Builder

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static UpdateMaintenanceWindowTaskRequest.Builder`	`builder()`
`String`	`description()` The new task description to specify.
`boolean`	`equals(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)` Used to retrieve the value of a field from any class that extends `SdkRequest`.
`int`	`hashCode()`
`LoggingInfo`	`loggingInfo()` The new logging location in Amazon S3 to specify.
`String`	`maxConcurrency()` The new `MaxConcurrency` value you want to specify.
`String`	`maxErrors()` The new `MaxErrors` value to specify.
`String`	`name()` The new task name to specify.
`Integer`	`priority()` The new task priority to specify.
`Boolean`	`replace()` If True, then all fields that are required by the RegisterTaskWithMaintenanceWndow action are also required for this API request.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends UpdateMaintenanceWindowTaskRequest.Builder>`	`serializableBuilderClass()`
`String`	`serviceRoleArn()` The IAM service role ARN to modify.
`List<Target>`	`targets()` The targets (either instances or tags) to modify.
`String`	`taskArn()` The task ARN to modify.
`MaintenanceWindowTaskInvocationParameters`	`taskInvocationParameters()` The parameters that the task should use during execution.
`Map<String,MaintenanceWindowTaskParameterValueExpression>`	`taskParameters()` The parameters to modify.
`UpdateMaintenanceWindowTaskRequest.Builder`	`toBuilder()` Take this object and create a builder that contains all of the current property values of this object.
`String`	`toString()`
`String`	`windowId()` The Maintenance Window ID that contains the task to modify.
`String`	`windowTaskId()` The task ID to modify.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration

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 that contains the task to modify.
    
    Returns:
    
    The Maintenance Window ID that contains the task to modify.
  - windowTaskId
```
public String windowTaskId()
```
    The task ID to modify.
    
    Returns:
    
    The task ID to modify.
  - targets
```
public List<Target> targets()
```
    The targets (either instances or tags) to modify. Instances are specified using Key=instanceids,Values=instanceID_1,instanceID_2. 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) to modify. Instances are specified using Key=instanceids,Values=instanceID_1,instanceID_2. Tags are specified using Key=tag_name,Values=tag_value.
  - taskArn
```
public String taskArn()
```
    The task ARN to modify.
    
    Returns:
    
    The task ARN to modify.
  - serviceRoleArn
```
public String serviceRoleArn()
```
    The IAM service role ARN to modify. The system assumes this role during task execution.
    
    If you do not specify a service role ARN, Systems Manager will use your account's service-linked role for Systems Manager by default. If no service-linked role for Systems Manager exists in your account, it will be created when you run RegisterTaskWithMaintenanceWindow without specifying a service role ARN.
    
    For more information, see Service-Linked Role Permissions for Systems Manager and Should I Use a Service-Linked Role or a Custom Service Role to Run Maintenance Window Tasks? in the AWS Systems Manager User Guide.
    
    Returns:
    
    The IAM service role ARN to modify. The system assumes this role during task execution.
    
    If you do not specify a service role ARN, Systems Manager will use your account's service-linked role for Systems Manager by default. If no service-linked role for Systems Manager exists in your account, it will be created when you run RegisterTaskWithMaintenanceWindow without specifying a service role ARN.
    
    For more information, see Service-Linked Role Permissions for Systems Manager and Should I Use a Service-Linked Role or a Custom Service Role to Run Maintenance Window Tasks? in the AWS Systems Manager User Guide.
  - taskParameters
```
public Map<String,MaintenanceWindowTaskParameterValueExpression> taskParameters()
```
    The parameters to modify.
    
    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.
    
    The map has the following format:
    
    Key: string, between 1 and 255 characters
    
    Value: an array of strings, each string is between 1 and 255 characters
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    Returns:
    
    The parameters to modify.
    
    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.
    
    The map has the following format:
    
    Key: string, between 1 and 255 characters
    
    Value: an array of strings, each string is between 1 and 255 characters
  - taskInvocationParameters
```
public MaintenanceWindowTaskInvocationParameters taskInvocationParameters()
```
    The parameters that the task should use during execution. Populate only the fields that match the task type. All other fields should be empty.
    
    Returns:
    
    The parameters that the task should use during execution. Populate only the fields that match the task type. All other fields should be empty.
  - priority
```
public Integer priority()
```
    The new task priority to specify. The lower the number, the higher the priority. Tasks that have the same priority are scheduled in parallel.
    
    Returns:
    
    The new task priority to specify. The lower the number, the higher the priority. Tasks that have the same priority are scheduled in parallel.
  - maxConcurrency
```
public String maxConcurrency()
```
    The new MaxConcurrency value you want to specify. MaxConcurrency is the number of targets that are allowed to run this task in parallel.
    
    Returns:
    
    The new MaxConcurrency value you want to specify. MaxConcurrency is the number of targets that are allowed to run this task in parallel.
  - maxErrors
```
public String maxErrors()
```
    The new MaxErrors value to specify. MaxErrors is the maximum number of errors that are allowed before the task stops being scheduled.
    
    Returns:
    
    The new MaxErrors value to specify. MaxErrors is the maximum number of errors that are allowed before the task stops being scheduled.
  - loggingInfo
```
public LoggingInfo loggingInfo()
```
    The new logging location in Amazon S3 to specify.
    
    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:
    
    The new logging location in Amazon S3 to specify.
    
    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.
  - name
```
public String name()
```
    The new task name to specify.
    
    Returns:
    
    The new task name to specify.
  - description
```
public String description()
```
    The new task description to specify.
    
    Returns:
    
    The new task description to specify.
  - replace
```
public Boolean replace()
```
    If True, then all fields that are required by the RegisterTaskWithMaintenanceWndow action are also required for this API request. Optional fields that are not specified are set to null.
    
    Returns:
    
    If True, then all fields that are required by the RegisterTaskWithMaintenanceWndow action are also required for this API request. Optional fields that are not specified are set to null.
  - toBuilder
```
public UpdateMaintenanceWindowTaskRequest.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<UpdateMaintenanceWindowTaskRequest.Builder,UpdateMaintenanceWindowTaskRequest>
    
    Specified by:
    
    toBuilder in class SsmRequest
    
    Returns:
    
    a builder for type T
  - builder
```
public static UpdateMaintenanceWindowTaskRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends UpdateMaintenanceWindowTaskRequest.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)
```
    Description copied from class: SdkRequest
    
    Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
    
    Overrides:
    
    getValueForField in class SdkRequest
    
    Parameters:
    
    fieldName - The name of the member to be retrieved.
    
    clazz - The class to cast the returned object to.
    
    Returns:
    
    Optional containing the casted return value
  - sdkFields
```
public 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.

Class UpdateMaintenanceWindowTaskRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

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

Method Detail

windowId

windowTaskId

targets

taskArn

serviceRoleArn

taskParameters

taskInvocationParameters

priority

maxConcurrency

maxErrors

loggingInfo

name

description

replace

toBuilder

builder

serializableBuilderClass

hashCode

equals

toString

getValueForField

sdkFields