RegisterTaskWithMaintenanceWindowRequest.Builder (AWS Java SDK :: Services :: AWS Simple Systems Management (SSM) 2.17.117 API)

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<RegisterTaskWithMaintenanceWindowRequest.Builder,RegisterTaskWithMaintenanceWindowRequest>, SdkBuilder<RegisterTaskWithMaintenanceWindowRequest.Builder,RegisterTaskWithMaintenanceWindowRequest>, SdkPojo, SdkRequest.Builder, SsmRequest.Builder

Enclosing class:

RegisterTaskWithMaintenanceWindowRequest
```
public static interface RegisterTaskWithMaintenanceWindowRequest.Builder
extends SsmRequest.Builder, SdkPojo, CopyableBuilder<RegisterTaskWithMaintenanceWindowRequest.Builder,RegisterTaskWithMaintenanceWindowRequest>
```

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`RegisterTaskWithMaintenanceWindowRequest.Builder`	`clientToken(String clientToken)` User-provided idempotency token.
`RegisterTaskWithMaintenanceWindowRequest.Builder`	`cutoffBehavior(MaintenanceWindowTaskCutoffBehavior cutoffBehavior)` Indicates whether tasks should continue to run after the cutoff time specified in the maintenance windows is reached.
`RegisterTaskWithMaintenanceWindowRequest.Builder`	`cutoffBehavior(String cutoffBehavior)` Indicates whether tasks should continue to run after the cutoff time specified in the maintenance windows is reached.
`RegisterTaskWithMaintenanceWindowRequest.Builder`	`description(String description)` An optional description for the task.
`default RegisterTaskWithMaintenanceWindowRequest.Builder`	`loggingInfo(Consumer<LoggingInfo.Builder> loggingInfo)` A structure containing information about an Amazon Simple Storage Service (Amazon S3) bucket to write managed node-level logs to.
`RegisterTaskWithMaintenanceWindowRequest.Builder`	`loggingInfo(LoggingInfo loggingInfo)` A structure containing information about an Amazon Simple Storage Service (Amazon S3) bucket to write managed node-level logs to.
`RegisterTaskWithMaintenanceWindowRequest.Builder`	`maxConcurrency(String maxConcurrency)` The maximum number of targets this task can be run for in parallel.
`RegisterTaskWithMaintenanceWindowRequest.Builder`	`maxErrors(String maxErrors)` The maximum number of errors allowed before this task stops being scheduled.
`RegisterTaskWithMaintenanceWindowRequest.Builder`	`name(String name)` An optional name for the task.
`RegisterTaskWithMaintenanceWindowRequest.Builder`	`overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)`
`RegisterTaskWithMaintenanceWindowRequest.Builder`	`overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)`
`RegisterTaskWithMaintenanceWindowRequest.Builder`	`priority(Integer priority)` The priority of the task in the maintenance window, the lower the number the higher the priority.
`RegisterTaskWithMaintenanceWindowRequest.Builder`	`serviceRoleArn(String serviceRoleArn)` The Amazon Resource Name (ARN) of the IAM service role for Amazon Web Services Systems Manager to assume when running a maintenance window task.
`RegisterTaskWithMaintenanceWindowRequest.Builder`	`targets(Collection<Target> targets)` The targets (either managed nodes or maintenance window targets).
`RegisterTaskWithMaintenanceWindowRequest.Builder`	`targets(Consumer<Target.Builder>... targets)` The targets (either managed nodes or maintenance window targets).
`RegisterTaskWithMaintenanceWindowRequest.Builder`	`targets(Target... targets)` The targets (either managed nodes or maintenance window targets).
`RegisterTaskWithMaintenanceWindowRequest.Builder`	`taskArn(String taskArn)` The ARN of the task to run.
`default RegisterTaskWithMaintenanceWindowRequest.Builder`	`taskInvocationParameters(Consumer<MaintenanceWindowTaskInvocationParameters.Builder> taskInvocationParameters)` The parameters that the task should use during execution.
`RegisterTaskWithMaintenanceWindowRequest.Builder`	`taskInvocationParameters(MaintenanceWindowTaskInvocationParameters taskInvocationParameters)` The parameters that the task should use during execution.
`RegisterTaskWithMaintenanceWindowRequest.Builder`	`taskParameters(Map<String,MaintenanceWindowTaskParameterValueExpression> taskParameters)` The parameters that should be passed to the task when it is run.
`RegisterTaskWithMaintenanceWindowRequest.Builder`	`taskType(MaintenanceWindowTaskType taskType)` The type of task being registered.
`RegisterTaskWithMaintenanceWindowRequest.Builder`	`taskType(String taskType)` The type of task being registered.
`RegisterTaskWithMaintenanceWindowRequest.Builder`	`windowId(String windowId)` The ID of the maintenance window the task should be added to.

Methods inherited from interface software.amazon.awssdk.services.ssm.model.SsmRequest.Builder
build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration

Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields

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

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build

- Method Detail
  - windowId
```
RegisterTaskWithMaintenanceWindowRequest.Builder windowId(String windowId)
```
    The ID of the maintenance window the task should be added to.
    
    Parameters:
    
    windowId - The ID of the maintenance window the task should be added to.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - targets
```
RegisterTaskWithMaintenanceWindowRequest.Builder targets(Collection<Target> targets)
```
    The targets (either managed nodes 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, Lambda, and Step Functions). For more information about running tasks that don't specify targets, see Registering maintenance window tasks without targets in the Amazon Web Services Systems Manager User Guide.
    
    Specify managed nodes 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>
    
    Parameters:
    
    targets - The targets (either managed nodes 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, Lambda, and Step Functions). For more information about running tasks that don't specify targets, see Registering maintenance window tasks without targets in the Amazon Web Services Systems Manager User Guide.
    
    Specify managed nodes 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>
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - targets
```
RegisterTaskWithMaintenanceWindowRequest.Builder targets(Target... targets)
```
    The targets (either managed nodes 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, Lambda, and Step Functions). For more information about running tasks that don't specify targets, see Registering maintenance window tasks without targets in the Amazon Web Services Systems Manager User Guide.
    
    Specify managed nodes 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>
    
    Parameters:
    
    targets - The targets (either managed nodes 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, Lambda, and Step Functions). For more information about running tasks that don't specify targets, see Registering maintenance window tasks without targets in the Amazon Web Services Systems Manager User Guide.
    
    Specify managed nodes 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>
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - targets
```
RegisterTaskWithMaintenanceWindowRequest.Builder targets(Consumer<Target.Builder>... targets)
```
    The targets (either managed nodes 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, Lambda, and Step Functions). For more information about running tasks that don't specify targets, see Registering maintenance window tasks without targets in the Amazon Web Services Systems Manager User Guide.
    
    Specify managed nodes 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>
    This is a convenience that creates an instance of the List.Builder avoiding the need to create one manually via List#builder(). When the Consumer completes, List.Builder#build() is called immediately and its result is passed to #targets(List).
    
    Parameters:
    
    targets - a consumer that will call methods on List.Builder
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    #targets(List)
  - taskArn
```
RegisterTaskWithMaintenanceWindowRequest.Builder taskArn(String taskArn)
```
    The ARN of the task to run.
    
    Parameters:
    
    taskArn - The ARN of the task to run.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - serviceRoleArn
```
RegisterTaskWithMaintenanceWindowRequest.Builder serviceRoleArn(String serviceRoleArn)
```
    The Amazon Resource Name (ARN) of the IAM service role for Amazon Web Services 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 Amazon Web Services 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?
    Parameters:
    serviceRoleArn - The Amazon Resource Name (ARN) of the IAM service role for Amazon Web Services 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 Amazon Web Services 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:
    
    Returns a reference to this object so that method calls can be chained together.
  - taskType
```
RegisterTaskWithMaintenanceWindowRequest.Builder taskType(String taskType)
```
    The type of task being registered.
    
    Parameters:
    
    taskType - The type of task being registered.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    MaintenanceWindowTaskType, MaintenanceWindowTaskType
  - taskType
```
RegisterTaskWithMaintenanceWindowRequest.Builder taskType(MaintenanceWindowTaskType taskType)
```
    The type of task being registered.
    
    Parameters:
    
    taskType - The type of task being registered.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    MaintenanceWindowTaskType, MaintenanceWindowTaskType
  - taskParameters
```
RegisterTaskWithMaintenanceWindowRequest.Builder taskParameters(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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - taskInvocationParameters
```
RegisterTaskWithMaintenanceWindowRequest.Builder taskInvocationParameters(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - taskInvocationParameters
```
default RegisterTaskWithMaintenanceWindowRequest.Builder taskInvocationParameters(Consumer<MaintenanceWindowTaskInvocationParameters.Builder> 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.
    This is a convenience that creates an instance of the MaintenanceWindowTaskInvocationParameters.Builder avoiding the need to create one manually via MaintenanceWindowTaskInvocationParameters.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to taskInvocationParameters(MaintenanceWindowTaskInvocationParameters).
    
    Parameters:
    
    taskInvocationParameters - a consumer that will call methods on MaintenanceWindowTaskInvocationParameters.Builder
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    taskInvocationParameters(MaintenanceWindowTaskInvocationParameters)
  - priority
```
RegisterTaskWithMaintenanceWindowRequest.Builder priority(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - maxConcurrency
```
RegisterTaskWithMaintenanceWindowRequest.Builder maxConcurrency(String maxConcurrency)
```
    The maximum number of targets this task can be run for in parallel.
    
    For maintenance window tasks without a target specified, you can't supply a value for this option. Instead, the system inserts a placeholder value of 1. This value doesn't affect the running of your task.
    
    Parameters:
    
    maxConcurrency - The maximum number of targets this task can be run for in parallel.
    
    For maintenance window tasks without a target specified, you can't supply a value for this option. Instead, the system inserts a placeholder value of 1. This value doesn't affect the running of your task.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - maxErrors
```
RegisterTaskWithMaintenanceWindowRequest.Builder maxErrors(String maxErrors)
```
    The maximum number of errors allowed before this task stops being scheduled.
    
    For maintenance window tasks without a target specified, you can't supply a value for this option. Instead, the system inserts a placeholder value of 1. This value doesn't affect the running of your task.
    
    Parameters:
    
    maxErrors - The maximum number of errors allowed before this task stops being scheduled.
    
    For maintenance window tasks without a target specified, you can't supply a value for this option. Instead, the system inserts a placeholder value of 1. This value doesn't affect the running of your task.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - loggingInfo
```
RegisterTaskWithMaintenanceWindowRequest.Builder loggingInfo(LoggingInfo loggingInfo)
```
    A structure containing information about an Amazon Simple Storage Service (Amazon S3) bucket to write managed node-level logs to.
    
    LoggingInfo has been deprecated. To specify an Amazon Simple Storage Service (Amazon S3) bucket to contain logs, instead use the OutputS3BucketName and OutputS3KeyPrefix options in the TaskInvocationParameters structure. For information about how Amazon Web Services Systems Manager handles these options for the supported maintenance window task types, see MaintenanceWindowTaskInvocationParameters.
    
    Parameters:
    
    loggingInfo - A structure containing information about an Amazon Simple Storage Service (Amazon S3) bucket to write managed node-level logs to.
    
    LoggingInfo has been deprecated. To specify an Amazon Simple Storage Service (Amazon S3) bucket to contain logs, instead use the OutputS3BucketName and OutputS3KeyPrefix options in the TaskInvocationParameters structure. For information about how Amazon Web Services Systems Manager handles these options for the supported maintenance window task types, see MaintenanceWindowTaskInvocationParameters.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - loggingInfo
```
default RegisterTaskWithMaintenanceWindowRequest.Builder loggingInfo(Consumer<LoggingInfo.Builder> loggingInfo)
```
    A structure containing information about an Amazon Simple Storage Service (Amazon S3) bucket to write managed node-level logs to.
    
    LoggingInfo has been deprecated. To specify an Amazon Simple Storage Service (Amazon S3) bucket to contain logs, instead use the OutputS3BucketName and OutputS3KeyPrefix options in the TaskInvocationParameters structure. For information about how Amazon Web Services Systems Manager handles these options for the supported maintenance window task types, see MaintenanceWindowTaskInvocationParameters.
    This is a convenience that creates an instance of the LoggingInfo.Builder avoiding the need to create one manually via LoggingInfo.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to loggingInfo(LoggingInfo).
    
    Parameters:
    
    loggingInfo - a consumer that will call methods on LoggingInfo.Builder
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    loggingInfo(LoggingInfo)
  - name
```
RegisterTaskWithMaintenanceWindowRequest.Builder name(String name)
```
    An optional name for the task.
    
    Parameters:
    
    name - An optional name for the task.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - description
```
RegisterTaskWithMaintenanceWindowRequest.Builder description(String description)
```
    An optional description for the task.
    
    Parameters:
    
    description - An optional description for the task.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - clientToken
```
RegisterTaskWithMaintenanceWindowRequest.Builder clientToken(String clientToken)
```
    User-provided idempotency token.
    
    Parameters:
    
    clientToken - User-provided idempotency token.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - cutoffBehavior
```
RegisterTaskWithMaintenanceWindowRequest.Builder cutoffBehavior(String cutoffBehavior)
```
    Indicates whether tasks should continue to run after the cutoff time specified in the maintenance windows is reached.
    - CONTINUE_TASK: When the cutoff time is reached, any tasks that are running continue. The default value.
    - CANCEL_TASK:
      
      For Automation, Lambda, Step Functions tasks: When the cutoff time is reached, any task invocations that are already running continue, but no new task invocations are started.
      
      For Run Command tasks: When the cutoff time is reached, the system sends a CancelCommand operation that attempts to cancel the command associated with the task. However, there is no guarantee that the command will be terminated and the underlying process stopped.
      
      The status for tasks that are not completed is TIMED_OUT.
    Parameters:
    cutoffBehavior - Indicates whether tasks should continue to run after the cutoff time specified in the maintenance windows is reached.
    
    CONTINUE_TASK: When the cutoff time is reached, any tasks that are running continue. The default value.
    
    CANCEL_TASK:
    
    For Automation, Lambda, Step Functions tasks: When the cutoff time is reached, any task invocations that are already running continue, but no new task invocations are started.
    
    For Run Command tasks: When the cutoff time is reached, the system sends a CancelCommand operation that attempts to cancel the command associated with the task. However, there is no guarantee that the command will be terminated and the underlying process stopped.
    
    The status for tasks that are not completed is TIMED_OUT.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    MaintenanceWindowTaskCutoffBehavior, MaintenanceWindowTaskCutoffBehavior
  - cutoffBehavior
```
RegisterTaskWithMaintenanceWindowRequest.Builder cutoffBehavior(MaintenanceWindowTaskCutoffBehavior cutoffBehavior)
```
    Indicates whether tasks should continue to run after the cutoff time specified in the maintenance windows is reached.
    - CONTINUE_TASK: When the cutoff time is reached, any tasks that are running continue. The default value.
    - CANCEL_TASK:
      
      For Automation, Lambda, Step Functions tasks: When the cutoff time is reached, any task invocations that are already running continue, but no new task invocations are started.
      
      For Run Command tasks: When the cutoff time is reached, the system sends a CancelCommand operation that attempts to cancel the command associated with the task. However, there is no guarantee that the command will be terminated and the underlying process stopped.
      
      The status for tasks that are not completed is TIMED_OUT.
    Parameters:
    cutoffBehavior - Indicates whether tasks should continue to run after the cutoff time specified in the maintenance windows is reached.
    
    CONTINUE_TASK: When the cutoff time is reached, any tasks that are running continue. The default value.
    
    CANCEL_TASK:
    
    For Automation, Lambda, Step Functions tasks: When the cutoff time is reached, any task invocations that are already running continue, but no new task invocations are started.
    
    For Run Command tasks: When the cutoff time is reached, the system sends a CancelCommand operation that attempts to cancel the command associated with the task. However, there is no guarantee that the command will be terminated and the underlying process stopped.
    
    The status for tasks that are not completed is TIMED_OUT.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    MaintenanceWindowTaskCutoffBehavior, MaintenanceWindowTaskCutoffBehavior
  - overrideConfiguration
```
RegisterTaskWithMaintenanceWindowRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
```
    Specified by:
    
    overrideConfiguration in interface AwsRequest.Builder
  - overrideConfiguration
```
RegisterTaskWithMaintenanceWindowRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
```
    Specified by:
    
    overrideConfiguration in interface AwsRequest.Builder

Interface RegisterTaskWithMaintenanceWindowRequest.Builder

Method Summary

Methods inherited from interface software.amazon.awssdk.services.ssm.model.SsmRequest.Builder

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

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

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

Method Detail

windowId

targets

targets

targets

taskArn

serviceRoleArn

taskType

taskType

taskParameters

taskInvocationParameters

taskInvocationParameters

priority

maxConcurrency

maxErrors

loggingInfo

loggingInfo

name

description

clientToken

cutoffBehavior

cutoffBehavior

overrideConfiguration

overrideConfiguration