software.amazon.awssdk.services.ssm.model

Interface MaintenanceWindowTask.Builder

All Superinterfaces:

Buildable, CopyableBuilder<MaintenanceWindowTask.Builder,MaintenanceWindowTask>, SdkBuilder<MaintenanceWindowTask.Builder,MaintenanceWindowTask>, SdkPojo

Enclosing class:

MaintenanceWindowTask

public static interface MaintenanceWindowTask.Builder
extends SdkPojo, CopyableBuilder<MaintenanceWindowTask.Builder,MaintenanceWindowTask>

Method Summary

Modifier and Type	Method and Description
MaintenanceWindowTask.Builder	description(String description) A description of the task.
default MaintenanceWindowTask.Builder	loggingInfo(Consumer<LoggingInfo.Builder> loggingInfo) Information about an S3 bucket to write task-level logs to.
MaintenanceWindowTask.Builder	loggingInfo(LoggingInfo loggingInfo) Information about an S3 bucket to write task-level logs to.
MaintenanceWindowTask.Builder	maxConcurrency(String maxConcurrency) The maximum number of targets this task can be run for, in parallel.
MaintenanceWindowTask.Builder	maxErrors(String maxErrors) The maximum number of errors allowed before this task stops being scheduled.
MaintenanceWindowTask.Builder	name(String name) The task name.
MaintenanceWindowTask.Builder	priority(Integer priority) The priority of the task in the maintenance window.
MaintenanceWindowTask.Builder	serviceRoleArn(String serviceRoleArn) The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) service role to use to publish Amazon Simple Notification Service (Amazon SNS) notifications for maintenance window Run Command tasks.
MaintenanceWindowTask.Builder	targets(Collection<Target> targets) The targets (either instances or tags).
MaintenanceWindowTask.Builder	targets(Consumer<Target.Builder>... targets) The targets (either instances or tags).
MaintenanceWindowTask.Builder	targets(Target... targets) The targets (either instances or tags).
MaintenanceWindowTask.Builder	taskArn(String taskArn) The resource that the task uses during execution.
MaintenanceWindowTask.Builder	taskParameters(Map<String,MaintenanceWindowTaskParameterValueExpression> taskParameters) The parameters that should be passed to the task when it is run.
MaintenanceWindowTask.Builder	type(MaintenanceWindowTaskType type) The type of task.
MaintenanceWindowTask.Builder	type(String type) The type of task.
MaintenanceWindowTask.Builder	windowId(String windowId) The ID of the maintenance window where the task is registered.
MaintenanceWindowTask.Builder	windowTaskId(String windowTaskId) The task ID.

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

MaintenanceWindowTask.Builder windowId(String windowId)

The ID of the maintenance window where the task is registered.

Parameters:

windowId - The ID of the maintenance window where the task is registered.

Returns:

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

windowTaskId

MaintenanceWindowTask.Builder windowTaskId(String windowTaskId)

The task ID.

Parameters:

windowTaskId - The task ID.

Returns:

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

taskArn

MaintenanceWindowTask.Builder taskArn(String taskArn)

The resource that the task uses during execution. For RUN_COMMAND and AUTOMATION task types, TaskArn is the Amazon Web Services Systems Manager (SSM document) name or ARN. For LAMBDA tasks, it's the function name or ARN. For STEP_FUNCTIONS tasks, it's the state machine ARN.

Parameters:

taskArn - The resource that the task uses during execution. For RUN_COMMAND and AUTOMATION task types, TaskArn is the Amazon Web Services Systems Manager (SSM document) name or ARN. For LAMBDA tasks, it's the function name or ARN. For STEP_FUNCTIONS tasks, it's the state machine ARN.

Returns:

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

type

MaintenanceWindowTask.Builder type(String type)

The type of task.

Parameters:

type - The type of task.

Returns:

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

See Also:

MaintenanceWindowTaskType, MaintenanceWindowTaskType

type

MaintenanceWindowTask.Builder type(MaintenanceWindowTaskType type)

The type of task.

Parameters:

type - The type of task.

Returns:

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

See Also:

MaintenanceWindowTaskType, MaintenanceWindowTaskType

targets

MaintenanceWindowTask.Builder targets(Collection<Target> targets)

The targets (either instances or tags). Instances are specified using Key=instanceids,Values=<instanceid1>,<instanceid2>. Tags are specified using Key=<tag name>,Values=<tag value>.

Parameters:

targets - The targets (either instances or tags). Instances are specified using Key=instanceids,Values=<instanceid1>,<instanceid2>. Tags are specified using Key=<tag name>,Values=<tag value>.

Returns:

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

targets

MaintenanceWindowTask.Builder targets(Target... targets)

The targets (either instances or tags). Instances are specified using Key=instanceids,Values=<instanceid1>,<instanceid2>. Tags are specified using Key=<tag name>,Values=<tag value>.

Parameters:

targets - The targets (either instances or tags). Instances are specified using Key=instanceids,Values=<instanceid1>,<instanceid2>. Tags are specified using Key=<tag name>,Values=<tag value>.

Returns:

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

targets

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

The targets (either instances or tags). Instances are specified using Key=instanceids,Values=<instanceid1>,<instanceid2>. Tags are specified using Key=<tag name>,Values=<tag value>.

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)

taskParameters

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

priority

MaintenanceWindowTask.Builder priority(Integer priority)

The priority of the task in the maintenance window. 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 in the maintenance window. 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.

loggingInfo

MaintenanceWindowTask.Builder loggingInfo(LoggingInfo loggingInfo)

Information about an S3 bucket to write task-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 - Information about an S3 bucket to write task-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 MaintenanceWindowTask.Builder loggingInfo(Consumer<LoggingInfo.Builder> loggingInfo)

Information about an S3 bucket to write task-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)

serviceRoleArn

MaintenanceWindowTask.Builder serviceRoleArn(String serviceRoleArn)

The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) service role to use to publish Amazon Simple Notification Service (Amazon SNS) notifications for maintenance window Run Command tasks.

Parameters:

serviceRoleArn - The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) service role to use to publish Amazon Simple Notification Service (Amazon SNS) notifications for maintenance window Run Command tasks.

Returns:

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

maxConcurrency

MaintenanceWindowTask.Builder maxConcurrency(String maxConcurrency)

The maximum number of targets this task can be run for, in parallel.

Parameters:

maxConcurrency - The maximum number of targets this task can be run for, in parallel.

Returns:

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

maxErrors

MaintenanceWindowTask.Builder maxErrors(String maxErrors)

The maximum number of errors allowed before this task stops being scheduled.

Parameters:

maxErrors - The maximum number of errors allowed before this task stops being scheduled.

Returns:

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

name

MaintenanceWindowTask.Builder name(String name)

The task name.

Parameters:

name - The task name.

Returns:

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

description

MaintenanceWindowTask.Builder description(String description)

A description of the task.

Parameters:

description - A description of the task.

Returns:

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