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

Interface UpdateMaintenanceWindowTaskResponse.Builder

All Superinterfaces:

AwsResponse.Builder, Buildable, CopyableBuilder<UpdateMaintenanceWindowTaskResponse.Builder,UpdateMaintenanceWindowTaskResponse>, SdkBuilder<UpdateMaintenanceWindowTaskResponse.Builder,UpdateMaintenanceWindowTaskResponse>, SdkPojo, SdkResponse.Builder, SsmResponse.Builder

Enclosing class:

UpdateMaintenanceWindowTaskResponse

@Mutable
@NotThreadSafe
public static interface UpdateMaintenanceWindowTaskResponse.Builder
extends SsmResponse.Builder, SdkPojo, CopyableBuilder<UpdateMaintenanceWindowTaskResponse.Builder,UpdateMaintenanceWindowTaskResponse>

Method Summary

Modifier and Type	Method	Description
default UpdateMaintenanceWindowTaskResponse.Builder	alarmConfiguration(Consumer<AlarmConfiguration.Builder> alarmConfiguration)	The details for the CloudWatch alarm you applied to your maintenance window task.
UpdateMaintenanceWindowTaskResponse.Builder	alarmConfiguration(AlarmConfiguration alarmConfiguration)	The details for the CloudWatch alarm you applied to your maintenance window task.
UpdateMaintenanceWindowTaskResponse.Builder	cutoffBehavior(String cutoffBehavior)	The specification for whether tasks should continue to run after the cutoff time specified in the maintenance windows is reached.
UpdateMaintenanceWindowTaskResponse.Builder	cutoffBehavior(MaintenanceWindowTaskCutoffBehavior cutoffBehavior)	The specification for whether tasks should continue to run after the cutoff time specified in the maintenance windows is reached.
UpdateMaintenanceWindowTaskResponse.Builder	description(String description)	The updated task description.
default UpdateMaintenanceWindowTaskResponse.Builder	loggingInfo(Consumer<LoggingInfo.Builder> loggingInfo)	The updated logging information in Amazon S3.
UpdateMaintenanceWindowTaskResponse.Builder	loggingInfo(LoggingInfo loggingInfo)	The updated logging information in Amazon S3.
UpdateMaintenanceWindowTaskResponse.Builder	maxConcurrency(String maxConcurrency)	The updated MaxConcurrency value.
UpdateMaintenanceWindowTaskResponse.Builder	maxErrors(String maxErrors)	The updated MaxErrors value.
UpdateMaintenanceWindowTaskResponse.Builder	name(String name)	The updated task name.
UpdateMaintenanceWindowTaskResponse.Builder	priority(Integer priority)	The updated priority value.
UpdateMaintenanceWindowTaskResponse.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.
UpdateMaintenanceWindowTaskResponse.Builder	targets(Collection<Target> targets)	The updated target values.
UpdateMaintenanceWindowTaskResponse.Builder	targets(Consumer<Target.Builder>... targets)	The updated target values.
UpdateMaintenanceWindowTaskResponse.Builder	targets(Target... targets)	The updated target values.
UpdateMaintenanceWindowTaskResponse.Builder	taskArn(String taskArn)	The updated task ARN value.
default UpdateMaintenanceWindowTaskResponse.Builder	taskInvocationParameters(Consumer<MaintenanceWindowTaskInvocationParameters.Builder> taskInvocationParameters)	The updated parameter values.
UpdateMaintenanceWindowTaskResponse.Builder	taskInvocationParameters(MaintenanceWindowTaskInvocationParameters taskInvocationParameters)	The updated parameter values.
UpdateMaintenanceWindowTaskResponse.Builder	taskParameters(Map<String,MaintenanceWindowTaskParameterValueExpression> taskParameters)	The updated parameter values.
UpdateMaintenanceWindowTaskResponse.Builder	windowId(String windowId)	The ID of the maintenance window that was updated.
UpdateMaintenanceWindowTaskResponse.Builder	windowTaskId(String windowTaskId)	The task ID of the maintenance window that was updated.

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

copy

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

applyMutation, build

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

equalsBySdkFields, sdkFieldNameToField, sdkFields

Methods inherited from interface software.amazon.awssdk.core.SdkResponse.Builder

sdkHttpResponse, sdkHttpResponse

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

build, responseMetadata, responseMetadata

Method Details

windowId

UpdateMaintenanceWindowTaskResponse.Builder windowId(String windowId)

The ID of the maintenance window that was updated.

Parameters:

windowId - The ID of the maintenance window that was updated.

Returns:

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

windowTaskId

UpdateMaintenanceWindowTaskResponse.Builder windowTaskId(String windowTaskId)

The task ID of the maintenance window that was updated.

Parameters:

windowTaskId - The task ID of the maintenance window that was updated.

Returns:

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

targets

UpdateMaintenanceWindowTaskResponse.Builder targets(Collection<Target> targets)

The updated target values.

Parameters:

targets - The updated target values.

Returns:

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

targets

UpdateMaintenanceWindowTaskResponse.Builder targets(Target... targets)

The updated target values.

Parameters:

targets - The updated target values.

Returns:

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

targets

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

The updated target values.

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:

• targets(java.util.Collection<Target>)

taskArn

UpdateMaintenanceWindowTaskResponse.Builder taskArn(String taskArn)

The updated task ARN value.

Parameters:

taskArn - The updated task ARN value.

Returns:

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

serviceRoleArn

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

taskParameters

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

The updated parameter values.

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 updated parameter values.

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

UpdateMaintenanceWindowTaskResponse.Builder taskInvocationParameters(MaintenanceWindowTaskInvocationParameters taskInvocationParameters)

The updated parameter values.

Parameters:

taskInvocationParameters - The updated parameter values.

Returns:

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

taskInvocationParameters

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

The updated parameter values.

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:

• taskInvocationParameters(MaintenanceWindowTaskInvocationParameters)

priority

UpdateMaintenanceWindowTaskResponse.Builder priority(Integer priority)

The updated priority value.

Parameters:

priority - The updated priority value.

Returns:

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

maxConcurrency

UpdateMaintenanceWindowTaskResponse.Builder maxConcurrency(String maxConcurrency)

The updated MaxConcurrency value.

Parameters:

maxConcurrency - The updated MaxConcurrency value.

Returns:

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

maxErrors

UpdateMaintenanceWindowTaskResponse.Builder maxErrors(String maxErrors)

The updated MaxErrors value.

Parameters:

maxErrors - The updated MaxErrors value.

Returns:

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

loggingInfo

UpdateMaintenanceWindowTaskResponse.Builder loggingInfo(LoggingInfo loggingInfo)

The updated logging information in Amazon S3.

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 updated logging information in Amazon S3.

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

The updated logging information in Amazon S3.

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:

• loggingInfo(LoggingInfo)

name

UpdateMaintenanceWindowTaskResponse.Builder name(String name)

The updated task name.

Parameters:

name - The updated task name.

Returns:

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

description

UpdateMaintenanceWindowTaskResponse.Builder description(String description)

The updated task description.

Parameters:

description - The updated task description.

Returns:

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

cutoffBehavior

UpdateMaintenanceWindowTaskResponse.Builder cutoffBehavior(String cutoffBehavior)

The specification for whether tasks should continue to run after the cutoff time specified in the maintenance windows is reached.

Parameters:

cutoffBehavior - The specification for whether tasks should continue to run after the cutoff time specified in the maintenance windows is reached.

Returns:

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

See Also:

• MaintenanceWindowTaskCutoffBehavior
• MaintenanceWindowTaskCutoffBehavior

cutoffBehavior

UpdateMaintenanceWindowTaskResponse.Builder cutoffBehavior(MaintenanceWindowTaskCutoffBehavior cutoffBehavior)

The specification for whether tasks should continue to run after the cutoff time specified in the maintenance windows is reached.

Parameters:

cutoffBehavior - The specification for whether tasks should continue to run after the cutoff time specified in the maintenance windows is reached.

Returns:

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

See Also:

• MaintenanceWindowTaskCutoffBehavior
• MaintenanceWindowTaskCutoffBehavior

alarmConfiguration

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

• alarmConfiguration(AlarmConfiguration)