Package software.amazon.awssdk.services.ssm.model

Interface UpdateMaintenanceWindowTaskRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<UpdateMaintenanceWindowTaskRequest.Builder,UpdateMaintenanceWindowTaskRequest>, SdkBuilder<UpdateMaintenanceWindowTaskRequest.Builder,UpdateMaintenanceWindowTaskRequest>, SdkPojo, SdkRequest.Builder, SsmRequest.Builder
Enclosing class:
UpdateMaintenanceWindowTaskRequest
public static interface UpdateMaintenanceWindowTaskRequest.Builder extends SsmRequest.Builder, SdkPojo, CopyableBuilder<UpdateMaintenanceWindowTaskRequest.Builder,UpdateMaintenanceWindowTaskRequest>

  • Method Details

    • windowId

      UpdateMaintenanceWindowTaskRequest.Builder windowId(String windowId)

      The maintenance window ID that contains the task to modify.

      Parameters:
      windowId - The maintenance window ID that contains the task to modify.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • windowTaskId

      UpdateMaintenanceWindowTaskRequest.Builder windowTaskId(String windowTaskId)

      The task ID to modify.

      Parameters:
      windowTaskId - The task ID to modify.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • targets

      UpdateMaintenanceWindowTaskRequest.Builder targets(Collection<Target> targets)

      The targets (either managed nodes or tags) to modify. Managed nodes are specified using the format Key=instanceids,Values=instanceID_1,instanceID_2. Tags are specified using the format Key=tag_name,Values=tag_value.

      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.

      Parameters:
      targets - The targets (either managed nodes or tags) to modify. Managed nodes are specified using the format Key=instanceids,Values=instanceID_1,instanceID_2. Tags are specified using the format Key=tag_name,Values=tag_value.

      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • targets

      UpdateMaintenanceWindowTaskRequest.Builder targets(Target... targets)

      The targets (either managed nodes or tags) to modify. Managed nodes are specified using the format Key=instanceids,Values=instanceID_1,instanceID_2. Tags are specified using the format Key=tag_name,Values=tag_value.

      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.

      Parameters:
      targets - The targets (either managed nodes or tags) to modify. Managed nodes are specified using the format Key=instanceids,Values=instanceID_1,instanceID_2. Tags are specified using the format Key=tag_name,Values=tag_value.

      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • targets

      UpdateMaintenanceWindowTaskRequest.Builder targets(Consumer<Target.Builder>... targets)

      The targets (either managed nodes or tags) to modify. Managed nodes are specified using the format Key=instanceids,Values=instanceID_1,instanceID_2. Tags are specified using the format Key=tag_name,Values=tag_value.

      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.

      This is a convenience method that creates an instance of the Target.Builder avoiding the need to create one manually via Target.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to targets(List<Target>).

      Parameters:
      targets - a consumer that will call methods on Target.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • taskArn

      UpdateMaintenanceWindowTaskRequest.Builder taskArn(String taskArn)

      The task ARN to modify.

      Parameters:
      taskArn - The task ARN to modify.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • serviceRoleArn

      UpdateMaintenanceWindowTaskRequest.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 Using service-linked roles for Systems Manager in the in the Amazon Web Services Systems Manager User Guide:

      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 Using service-linked roles for Systems Manager in the in the Amazon Web Services Systems Manager User Guide:

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • taskParameters

      UpdateMaintenanceWindowTaskRequest.Builder taskParameters(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

      Parameters:
      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

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • taskInvocationParameters

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

      When you update a maintenance window task that has options specified in TaskInvocationParameters , you must provide again all the TaskInvocationParameters values that you want to retain. The values you don't specify again are removed. For example, suppose that when you registered a Run Command task, you specified TaskInvocationParameters values for Comment, NotificationConfig, and OutputS3BucketName. If you update the maintenance window task and specify only a different OutputS3BucketName value, the values for Comment and NotificationConfig are removed.

      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.

      When you update a maintenance window task that has options specified in TaskInvocationParameters, you must provide again all the TaskInvocationParameters values that you want to retain. The values you don't specify again are removed. For example, suppose that when you registered a Run Command task, you specified TaskInvocationParameters values for Comment, NotificationConfig , and OutputS3BucketName. If you update the maintenance window task and specify only a different OutputS3BucketName value, the values for Comment and NotificationConfig are removed.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • taskInvocationParameters

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

      When you update a maintenance window task that has options specified in TaskInvocationParameters , you must provide again all the TaskInvocationParameters values that you want to retain. The values you don't specify again are removed. For example, suppose that when you registered a Run Command task, you specified TaskInvocationParameters values for Comment, NotificationConfig, and OutputS3BucketName. If you update the maintenance window task and specify only a different OutputS3BucketName value, the values for Comment and NotificationConfig are removed.

      This is a convenience method 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:

    • priority

      UpdateMaintenanceWindowTaskRequest.Builder priority(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • maxConcurrency

      UpdateMaintenanceWindowTaskRequest.Builder maxConcurrency(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.

      Although this element is listed as "Required: No", a value can be omitted only when you are registering or updating a targetless task You must provide a value in all other cases.

      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 new MaxConcurrency value you want to specify. MaxConcurrency is the number of targets that are allowed to run this task, in parallel.

      Although this element is listed as "Required: No", a value can be omitted only when you are registering or updating a targetless task You must provide a value in all other cases.

      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

      UpdateMaintenanceWindowTaskRequest.Builder maxErrors(String maxErrors)

      The new MaxErrors value to specify. MaxErrors is the maximum number of errors that are allowed before the task stops being scheduled.

      Although this element is listed as "Required: No", a value can be omitted only when you are registering or updating a targetless task You must provide a value in all other cases.

      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 new MaxErrors value to specify. MaxErrors is the maximum number of errors that are allowed before the task stops being scheduled.

      Although this element is listed as "Required: No", a value can be omitted only when you are registering or updating a targetless task You must provide a value in all other cases.

      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

      UpdateMaintenanceWindowTaskRequest.Builder loggingInfo(LoggingInfo loggingInfo)

      The new logging location in Amazon S3 to specify.

      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 - The new logging location in Amazon S3 to specify.

      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 UpdateMaintenanceWindowTaskRequest.Builder loggingInfo(Consumer<LoggingInfo.Builder> loggingInfo)

      The new logging location in Amazon S3 to specify.

      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 method 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:

    • name

      UpdateMaintenanceWindowTaskRequest.Builder name(String name)

      The new task name to specify.

      Parameters:
      name - The new task name to specify.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • description

      UpdateMaintenanceWindowTaskRequest.Builder description(String description)

      The new task description to specify.

      Parameters:
      description - The new task description to specify.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • replace

      UpdateMaintenanceWindowTaskRequest.Builder replace(Boolean replace)

      If True, then all fields that are required by the RegisterTaskWithMaintenanceWindow operation are also required for this API request. Optional fields that aren't specified are set to null.

      Parameters:
      replace - If True, then all fields that are required by the RegisterTaskWithMaintenanceWindow operation are also required for this API request. Optional fields that aren't specified are set to null.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • cutoffBehavior

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

    • cutoffBehavior

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

    • alarmConfiguration

      UpdateMaintenanceWindowTaskRequest.Builder alarmConfiguration(AlarmConfiguration alarmConfiguration)

      The CloudWatch alarm you want to apply to your maintenance window task.

      Parameters:
      alarmConfiguration - The CloudWatch alarm you want to apply to your maintenance window task.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • alarmConfiguration

      default UpdateMaintenanceWindowTaskRequest.Builder alarmConfiguration(Consumer<AlarmConfiguration.Builder> alarmConfiguration)

      The CloudWatch alarm you want to apply to your maintenance window task.

      This is a convenience method that creates an instance of the AlarmConfiguration.Builder avoiding the need to create one manually via AlarmConfiguration.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to alarmConfiguration(AlarmConfiguration).

      Parameters:
      alarmConfiguration - a consumer that will call methods on AlarmConfiguration.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • overrideConfiguration

      UpdateMaintenanceWindowTaskRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      UpdateMaintenanceWindowTaskRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.