Interface RegisterTaskWithMaintenanceWindowRequest.Builder

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

  • Method Details

    • 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 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

      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 a service-linked role in your account. If no appropriate service-linked role for Systems Manager exists in your account, it is created when you run RegisterTaskWithMaintenanceWindow.

      However, for an improved security posture, we strongly recommend creating a custom policy and custom service role for running your maintenance window tasks. The policy can be crafted to provide only the permissions needed for your particular maintenance window tasks. For more information, see Setting up Maintenance Windows 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 a service-linked role in your account. If no appropriate service-linked role for Systems Manager exists in your account, it is created when you run RegisterTaskWithMaintenanceWindow.

      However, for an improved security posture, we strongly recommend creating a custom policy and custom service role for running your maintenance window tasks. The policy can be crafted to provide only the permissions needed for your particular maintenance window tasks. For more information, see Setting up Maintenance Windows 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.

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

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

    • 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 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

      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.

      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 maximum number of targets this task can be run for, 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

      RegisterTaskWithMaintenanceWindowRequest.Builder maxErrors(String maxErrors)

      The maximum number of errors allowed before this 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 maximum number of errors allowed before this 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

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

      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:

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

    • alarmConfiguration

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

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

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