RegisterTaskWithMaintenanceWindowRequest (AWS Java SDK :: Services :: AWS Simple Systems Management (SSM) 2.15.62 API)

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

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

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

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface RegisterTaskWithMaintenanceWindowRequest.Builder

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static RegisterTaskWithMaintenanceWindowRequest.Builder`	`builder()`
`String`	`clientToken()` User-provided idempotency token.
`String`	`description()` An optional description for the task.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<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()` A structure containing information about an S3 bucket to write instance-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()` An optional name for the task.
`Integer`	`priority()` The priority of the task in the maintenance window, the lower the number the higher the priority.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends RegisterTaskWithMaintenanceWindowRequest.Builder>`	`serializableBuilderClass()`
`String`	`serviceRoleArn()` The ARN of the IAM service role for Systems Manager to assume when running a maintenance window task.
`List<Target>`	`targets()` The targets (either instances or maintenance window targets).
`String`	`taskArn()` The ARN of the task to run.
`MaintenanceWindowTaskInvocationParameters`	`taskInvocationParameters()` The parameters that the task should use during execution.
`Map<String,MaintenanceWindowTaskParameterValueExpression>`	`taskParameters()` The parameters that should be passed to the task when it is run.
`MaintenanceWindowTaskType`	`taskType()` The type of task being registered.
`String`	`taskTypeAsString()` The type of task being registered.
`RegisterTaskWithMaintenanceWindowRequest.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`String`	`windowId()` The ID of the maintenance window the task should be added to.

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

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 final String windowId()
```
    The ID of the maintenance window the task should be added to.
    
    Returns:
    
    The ID of the maintenance window the task should be added to.
  - 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 maintenance window targets).
    
    One or more targets must be specified for maintenance window Run Command-type tasks. Depending on the task, targets are optional for other maintenance window task types (Automation, AWS Lambda, and AWS Step Functions). For more information about running tasks that do not specify targets, see see Registering maintenance window tasks without targets in the AWS Systems Manager User Guide.
    
    Specify instances using the following format:
    
    Key=InstanceIds,Values=<instance-id-1>,<instance-id-2>
    
    Specify maintenance window targets using the following format:
    
    Key=WindowTargetIds,Values=<window-target-id-1>,<window-target-id-2>
    
    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 maintenance window targets).
    
    One or more targets must be specified for maintenance window Run Command-type tasks. Depending on the task, targets are optional for other maintenance window task types (Automation, AWS Lambda, and AWS Step Functions). For more information about running tasks that do not specify targets, see see Registering maintenance window tasks without targets in the AWS Systems Manager User Guide.
    
    Specify instances using the following format:
    
    Key=InstanceIds,Values=<instance-id-1>,<instance-id-2>
    
    Specify maintenance window targets using the following format:
    
    Key=WindowTargetIds,Values=<window-target-id-1>,<window-target-id-2>
  - taskArn
```
public final String taskArn()
```
    The ARN of the task to run.
    
    Returns:
    
    The ARN of the task to run.
  - serviceRoleArn
```
public final String serviceRoleArn()
```
    The ARN of the IAM service role for Systems Manager to assume when running a maintenance window task. If you do not specify a service role ARN, Systems Manager uses your account's service-linked role. If no service-linked role for Systems Manager exists in your account, it is created when you run RegisterTaskWithMaintenanceWindow.
    
    For more information, see the following topics in the in the AWS Systems Manager User Guide:
    - Using service-linked roles for Systems Manager
    - Should I use a service-linked role or a custom service role to run maintenance window tasks?
    Returns:
    The ARN of the IAM service role for Systems Manager to assume when running a maintenance window task. If you do not specify a service role ARN, Systems Manager uses your account's service-linked role. If no service-linked role for Systems Manager exists in your account, it is created when you run RegisterTaskWithMaintenanceWindow.
    
    For more information, see the following topics in the in the AWS Systems Manager User Guide:
    
    Using service-linked roles for Systems Manager
    
    Should I use a service-linked role or a custom service role to run maintenance window tasks?
  - taskType
```
public final MaintenanceWindowTaskType taskType()
```
    The type of task being registered.
    
    If the service returns an enum value that is not available in the current SDK version, taskType will return MaintenanceWindowTaskType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from taskTypeAsString().
    
    Returns:
    
    The type of task being registered.
    
    See Also:
    
    MaintenanceWindowTaskType
  - taskTypeAsString
```
public final String taskTypeAsString()
```
    The type of task being registered.
    
    If the service returns an enum value that is not available in the current SDK version, taskType will return MaintenanceWindowTaskType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from taskTypeAsString().
    
    Returns:
    
    The type of task being registered.
    
    See Also:
    
    MaintenanceWindowTaskType
  - 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.
  - taskInvocationParameters
```
public final 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 final 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.
  - maxConcurrency
```
public final String maxConcurrency()
```
    The maximum number of targets this task can be run for in parallel.
    
    For maintenance window tasks without a target specified, you cannot supply a value for this option. Instead, the system inserts a placeholder value of 1. This value does not affect the running of your task.
    
    Returns:
    
    The maximum number of targets this task can be run for in parallel.
    
    For maintenance window tasks without a target specified, you cannot supply a value for this option. Instead, the system inserts a placeholder value of 1. This value does not affect the running of your task.
  - maxErrors
```
public final String maxErrors()
```
    The maximum number of errors allowed before this task stops being scheduled.
    
    For maintenance window tasks without a target specified, you cannot supply a value for this option. Instead, the system inserts a placeholder value of 1. This value does not affect the running of your task.
    
    Returns:
    
    The maximum number of errors allowed before this task stops being scheduled.
    
    For maintenance window tasks without a target specified, you cannot supply a value for this option. Instead, the system inserts a placeholder value of 1. This value does not affect the running of your task.
  - loggingInfo
```
public final LoggingInfo loggingInfo()
```
    A structure containing information about an S3 bucket to write instance-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:
    
    A structure containing information about an S3 bucket to write instance-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.
  - name
```
public final String name()
```
    An optional name for the task.
    
    Returns:
    
    An optional name for the task.
  - description
```
public final String description()
```
    An optional description for the task.
    
    Returns:
    
    An optional description for the task.
  - clientToken
```
public final String clientToken()
```
    User-provided idempotency token.
    
    Returns:
    
    User-provided idempotency token.
  - toBuilder
```
public RegisterTaskWithMaintenanceWindowRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<RegisterTaskWithMaintenanceWindowRequest.Builder,RegisterTaskWithMaintenanceWindowRequest>
    
    Specified by:
    
    toBuilder in class SsmRequest
  - builder
```
public static RegisterTaskWithMaintenanceWindowRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends RegisterTaskWithMaintenanceWindowRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class AwsRequest
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsRequest
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - 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)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class RegisterTaskWithMaintenanceWindowRequest

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

hasTargets

targets

taskArn

serviceRoleArn

taskType

taskTypeAsString

hasTaskParameters

taskParameters

taskInvocationParameters

priority

maxConcurrency

maxErrors

loggingInfo

name

description

clientToken

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields