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

Interface GetMaintenanceWindowExecutionTaskResponse.Builder

All Superinterfaces:

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

Enclosing class:

GetMaintenanceWindowExecutionTaskResponse

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

Method Summary

Modifier and Type	Method	Description
default GetMaintenanceWindowExecutionTaskResponse.Builder	alarmConfiguration(Consumer<AlarmConfiguration.Builder> alarmConfiguration)	The details for the CloudWatch alarm you applied to your maintenance window task.
GetMaintenanceWindowExecutionTaskResponse.Builder	alarmConfiguration(AlarmConfiguration alarmConfiguration)	The details for the CloudWatch alarm you applied to your maintenance window task.
GetMaintenanceWindowExecutionTaskResponse.Builder	endTime(Instant endTime)	The time the task execution completed.
GetMaintenanceWindowExecutionTaskResponse.Builder	maxConcurrency(String maxConcurrency)	The defined maximum number of task executions that could be run in parallel.
GetMaintenanceWindowExecutionTaskResponse.Builder	maxErrors(String maxErrors)	The defined maximum number of task execution errors allowed before scheduling of the task execution would have been stopped.
GetMaintenanceWindowExecutionTaskResponse.Builder	priority(Integer priority)	The priority of the task.
GetMaintenanceWindowExecutionTaskResponse.Builder	serviceRole(String serviceRole)	The role that was assumed when running the task.
GetMaintenanceWindowExecutionTaskResponse.Builder	startTime(Instant startTime)	The time the task execution started.
GetMaintenanceWindowExecutionTaskResponse.Builder	status(String status)	The status of the task.
GetMaintenanceWindowExecutionTaskResponse.Builder	status(MaintenanceWindowExecutionStatus status)	The status of the task.
GetMaintenanceWindowExecutionTaskResponse.Builder	statusDetails(String statusDetails)	The details explaining the status.
GetMaintenanceWindowExecutionTaskResponse.Builder	taskArn(String taskArn)	The Amazon Resource Name (ARN) of the task that ran.
GetMaintenanceWindowExecutionTaskResponse.Builder	taskExecutionId(String taskExecutionId)	The ID of the specific task execution in the maintenance window task that was retrieved.
GetMaintenanceWindowExecutionTaskResponse.Builder	taskParameters(Collection<? extends Map<String,MaintenanceWindowTaskParameterValueExpression>> taskParameters)	The parameters passed to the task when it was run.
GetMaintenanceWindowExecutionTaskResponse.Builder	taskParameters(Map<String,MaintenanceWindowTaskParameterValueExpression>... taskParameters)	The parameters passed to the task when it was run.
GetMaintenanceWindowExecutionTaskResponse.Builder	triggeredAlarms(Collection<AlarmStateInformation> triggeredAlarms)	The CloudWatch alarms that were invoked by the maintenance window task.
GetMaintenanceWindowExecutionTaskResponse.Builder	triggeredAlarms(Consumer<AlarmStateInformation.Builder>... triggeredAlarms)	The CloudWatch alarms that were invoked by the maintenance window task.
GetMaintenanceWindowExecutionTaskResponse.Builder	triggeredAlarms(AlarmStateInformation... triggeredAlarms)	The CloudWatch alarms that were invoked by the maintenance window task.
GetMaintenanceWindowExecutionTaskResponse.Builder	type(String type)	The type of task that was run.
GetMaintenanceWindowExecutionTaskResponse.Builder	type(MaintenanceWindowTaskType type)	The type of task that was run.
GetMaintenanceWindowExecutionTaskResponse.Builder	windowExecutionId(String windowExecutionId)	The ID of the maintenance window execution that includes the task.

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

windowExecutionId

GetMaintenanceWindowExecutionTaskResponse.Builder windowExecutionId(String windowExecutionId)

The ID of the maintenance window execution that includes the task.

Parameters:

windowExecutionId - The ID of the maintenance window execution that includes the task.

Returns:

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

taskExecutionId

GetMaintenanceWindowExecutionTaskResponse.Builder taskExecutionId(String taskExecutionId)

The ID of the specific task execution in the maintenance window task that was retrieved.

Parameters:

taskExecutionId - The ID of the specific task execution in the maintenance window task that was retrieved.

Returns:

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

taskArn

GetMaintenanceWindowExecutionTaskResponse.Builder taskArn(String taskArn)

The Amazon Resource Name (ARN) of the task that ran.

Parameters:

taskArn - The Amazon Resource Name (ARN) of the task that ran.

Returns:

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

serviceRole

GetMaintenanceWindowExecutionTaskResponse.Builder serviceRole(String serviceRole)

The role that was assumed when running the task.

Parameters:

serviceRole - The role that was assumed when running the task.

Returns:

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

type

GetMaintenanceWindowExecutionTaskResponse.Builder type(String type)

The type of task that was run.

Parameters:

type - The type of task that was run.

Returns:

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

See Also:

• MaintenanceWindowTaskType
• MaintenanceWindowTaskType

type

GetMaintenanceWindowExecutionTaskResponse.Builder type(MaintenanceWindowTaskType type)

The type of task that was run.

Parameters:

type - The type of task that was run.

Returns:

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

See Also:

• MaintenanceWindowTaskType
• MaintenanceWindowTaskType

taskParameters

GetMaintenanceWindowExecutionTaskResponse.Builder taskParameters(Collection<? extends Map<String,MaintenanceWindowTaskParameterValueExpression>> taskParameters)

The parameters passed to the task when it was 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.

The map has the following format:

• Key: string, between 1 and 255 characters

• Value: an array of strings, each between 1 and 255 characters

Parameters:

taskParameters - The parameters passed to the task when it was 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.

The map has the following format:

• Key: string, between 1 and 255 characters

• Value: an array of strings, each between 1 and 255 characters

Returns:

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

taskParameters

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

The parameters passed to the task when it was 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.

The map has the following format:

• Key: string, between 1 and 255 characters

• Value: an array of strings, each between 1 and 255 characters

Parameters:

taskParameters - The parameters passed to the task when it was 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.

The map has the following format:

• Key: string, between 1 and 255 characters

• Value: an array of strings, each between 1 and 255 characters

Returns:

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

priority

GetMaintenanceWindowExecutionTaskResponse.Builder priority(Integer priority)

The priority of the task.

Parameters:

priority - The priority of the task.

Returns:

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

maxConcurrency

GetMaintenanceWindowExecutionTaskResponse.Builder maxConcurrency(String maxConcurrency)

The defined maximum number of task executions that could be run in parallel.

Parameters:

maxConcurrency - The defined maximum number of task executions that could be run in parallel.

Returns:

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

maxErrors

GetMaintenanceWindowExecutionTaskResponse.Builder maxErrors(String maxErrors)

The defined maximum number of task execution errors allowed before scheduling of the task execution would have been stopped.

Parameters:

maxErrors - The defined maximum number of task execution errors allowed before scheduling of the task execution would have been stopped.

Returns:

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

status

GetMaintenanceWindowExecutionTaskResponse.Builder status(String status)

The status of the task.

Parameters:

status - The status of the task.

Returns:

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

See Also:

• MaintenanceWindowExecutionStatus
• MaintenanceWindowExecutionStatus

status

GetMaintenanceWindowExecutionTaskResponse.Builder status(MaintenanceWindowExecutionStatus status)

The status of the task.

Parameters:

status - The status of the task.

Returns:

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

See Also:

• MaintenanceWindowExecutionStatus
• MaintenanceWindowExecutionStatus

statusDetails

GetMaintenanceWindowExecutionTaskResponse.Builder statusDetails(String statusDetails)

The details explaining the status. Not available for all status values.

Parameters:

statusDetails - The details explaining the status. Not available for all status values.

Returns:

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

startTime

GetMaintenanceWindowExecutionTaskResponse.Builder startTime(Instant startTime)

The time the task execution started.

Parameters:

startTime - The time the task execution started.

Returns:

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

endTime

GetMaintenanceWindowExecutionTaskResponse.Builder endTime(Instant endTime)

The time the task execution completed.

Parameters:

endTime - The time the task execution completed.

Returns:

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

alarmConfiguration

GetMaintenanceWindowExecutionTaskResponse.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 GetMaintenanceWindowExecutionTaskResponse.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)

triggeredAlarms

GetMaintenanceWindowExecutionTaskResponse.Builder triggeredAlarms(Collection<AlarmStateInformation> triggeredAlarms)

The CloudWatch alarms that were invoked by the maintenance window task.

Parameters:

triggeredAlarms - The CloudWatch alarms that were invoked by the maintenance window task.

Returns:

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

triggeredAlarms

GetMaintenanceWindowExecutionTaskResponse.Builder triggeredAlarms(AlarmStateInformation... triggeredAlarms)

The CloudWatch alarms that were invoked by the maintenance window task.

Parameters:

triggeredAlarms - The CloudWatch alarms that were invoked by the maintenance window task.

Returns:

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

triggeredAlarms

GetMaintenanceWindowExecutionTaskResponse.Builder triggeredAlarms(Consumer<AlarmStateInformation.Builder>... triggeredAlarms)

The CloudWatch alarms that were invoked by the maintenance window task.

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

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

Parameters:

triggeredAlarms - a consumer that will call methods on AlarmStateInformation.Builder

Returns:

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

See Also:

• triggeredAlarms(java.util.Collection<AlarmStateInformation>)