Interface GetMaintenanceWindowTaskResponse.Builder

All Superinterfaces:
AwsResponse.Builder, Buildable, CopyableBuilder<GetMaintenanceWindowTaskResponse.Builder,GetMaintenanceWindowTaskResponse>, SdkBuilder<GetMaintenanceWindowTaskResponse.Builder,GetMaintenanceWindowTaskResponse>, SdkPojo, SdkResponse.Builder, SsmResponse.Builder
Enclosing class:
GetMaintenanceWindowTaskResponse
@Mutable @NotThreadSafe public static interface GetMaintenanceWindowTaskResponse.Builder extends SsmResponse.Builder, SdkPojo, CopyableBuilder<GetMaintenanceWindowTaskResponse.Builder,GetMaintenanceWindowTaskResponse>

  • Method Details

    • windowId

      GetMaintenanceWindowTaskResponse.Builder windowId(String windowId)

      The retrieved maintenance window ID.

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

    • windowTaskId

      GetMaintenanceWindowTaskResponse.Builder windowTaskId(String windowTaskId)

      The retrieved maintenance window task ID.

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

    • targets

      GetMaintenanceWindowTaskResponse.Builder targets(Collection<Target> targets)

      The targets where the task should run.

      Parameters:
      targets - The targets where the task should run.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • targets

      GetMaintenanceWindowTaskResponse.Builder targets(Target... targets)

      The targets where the task should run.

      Parameters:
      targets - The targets where the task should run.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • targets

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

      The targets where the task should run.

      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

      GetMaintenanceWindowTaskResponse.Builder taskArn(String taskArn)

      The resource that the task used during execution. For RUN_COMMAND and AUTOMATION task types, the value of TaskArn is the SSM document name/ARN. For LAMBDA tasks, the value is the function name/ARN. For STEP_FUNCTIONS tasks, the value is the state machine ARN.

      Parameters:
      taskArn - The resource that the task used during execution. For RUN_COMMAND and AUTOMATION task types, the value of TaskArn is the SSM document name/ARN. For LAMBDA tasks, the value is the function name/ARN. For STEP_FUNCTIONS tasks, the value is the state machine ARN.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • serviceRoleArn

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

      GetMaintenanceWindowTaskResponse.Builder taskType(String taskType)

      The type of task to run.

      Parameters:
      taskType - The type of task to run.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • taskType

      GetMaintenanceWindowTaskResponse.Builder taskType(MaintenanceWindowTaskType taskType)

      The type of task to run.

      Parameters:
      taskType - The type of task to run.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • taskParameters

      GetMaintenanceWindowTaskResponse.Builder taskParameters(Map<String,MaintenanceWindowTaskParameterValueExpression> taskParameters)

      The parameters to pass to the task when it runs.

      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 to pass to the task when it runs.

      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

      GetMaintenanceWindowTaskResponse.Builder taskInvocationParameters(MaintenanceWindowTaskInvocationParameters taskInvocationParameters)

      The parameters to pass to the task when it runs.

      Parameters:
      taskInvocationParameters - The parameters to pass to the task when it runs.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • taskInvocationParameters

      default GetMaintenanceWindowTaskResponse.Builder taskInvocationParameters(Consumer<MaintenanceWindowTaskInvocationParameters.Builder> taskInvocationParameters)

      The parameters to pass to the task when it runs.

      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

      GetMaintenanceWindowTaskResponse.Builder priority(Integer priority)

      The priority of the task when it runs. The lower the number, the higher the priority. Tasks that have the same priority are scheduled in parallel.

      Parameters:
      priority - The priority of the task when it runs. 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

      GetMaintenanceWindowTaskResponse.Builder maxConcurrency(String maxConcurrency)

      The maximum number of targets allowed to run this task 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, which may be reported in the response to this command. This value doesn't affect the running of your task and can be ignored.

      Parameters:
      maxConcurrency - The maximum number of targets allowed to run this task 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, which may be reported in the response to this command. This value doesn't affect the running of your task and can be ignored.

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

    • maxErrors

      GetMaintenanceWindowTaskResponse.Builder maxErrors(String maxErrors)

      The maximum number of errors allowed before the 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, which may be reported in the response to this command. This value doesn't affect the running of your task and can be ignored.

      Parameters:
      maxErrors - The maximum number of errors allowed before the 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, which may be reported in the response to this command. This value doesn't affect the running of your task and can be ignored.

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

    • loggingInfo

      GetMaintenanceWindowTaskResponse.Builder loggingInfo(LoggingInfo loggingInfo)

      The location in Amazon Simple Storage Service (Amazon S3) where the task results are logged.

      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 location in Amazon Simple Storage Service (Amazon S3) where the task results are logged.

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

      The location in Amazon Simple Storage Service (Amazon S3) where the task results are logged.

      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

      GetMaintenanceWindowTaskResponse.Builder name(String name)

      The retrieved task name.

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

    • description

      GetMaintenanceWindowTaskResponse.Builder description(String description)

      The retrieved task description.

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

    • cutoffBehavior

      GetMaintenanceWindowTaskResponse.Builder cutoffBehavior(String cutoffBehavior)

      The action to take on tasks when the maintenance window cutoff time is reached. CONTINUE_TASK means that tasks continue to run. For Automation, Lambda, Step Functions tasks, CANCEL_TASK means that currently running task invocations continue, but no new task invocations are started. For Run Command tasks, CANCEL_TASK means the system attempts to stop the task by sending a CancelCommand operation.

      Parameters:
      cutoffBehavior - The action to take on tasks when the maintenance window cutoff time is reached. CONTINUE_TASK means that tasks continue to run. For Automation, Lambda, Step Functions tasks, CANCEL_TASK means that currently running task invocations continue, but no new task invocations are started. For Run Command tasks, CANCEL_TASK means the system attempts to stop the task by sending a CancelCommand operation.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • cutoffBehavior

      GetMaintenanceWindowTaskResponse.Builder cutoffBehavior(MaintenanceWindowTaskCutoffBehavior cutoffBehavior)

      The action to take on tasks when the maintenance window cutoff time is reached. CONTINUE_TASK means that tasks continue to run. For Automation, Lambda, Step Functions tasks, CANCEL_TASK means that currently running task invocations continue, but no new task invocations are started. For Run Command tasks, CANCEL_TASK means the system attempts to stop the task by sending a CancelCommand operation.

      Parameters:
      cutoffBehavior - The action to take on tasks when the maintenance window cutoff time is reached. CONTINUE_TASK means that tasks continue to run. For Automation, Lambda, Step Functions tasks, CANCEL_TASK means that currently running task invocations continue, but no new task invocations are started. For Run Command tasks, CANCEL_TASK means the system attempts to stop the task by sending a CancelCommand operation.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • alarmConfiguration

      GetMaintenanceWindowTaskResponse.Builder alarmConfiguration(AlarmConfiguration alarmConfiguration)

      The details for the CloudWatch alarm you applied to your maintenance window task.

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

    • alarmConfiguration

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

      The details for the CloudWatch alarm you applied 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: