software.amazon.awssdk.services.ssm.model

Interface GetMaintenanceWindowTaskResponse.Builder

All Superinterfaces:

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

Enclosing class:

GetMaintenanceWindowTaskResponse

public static interface GetMaintenanceWindowTaskResponse.Builder
extends SsmResponse.Builder, SdkPojo, CopyableBuilder<GetMaintenanceWindowTaskResponse.Builder,GetMaintenanceWindowTaskResponse>

Method Summary

Modifier and Type	Method and Description
GetMaintenanceWindowTaskResponse.Builder	alarmConfiguration(AlarmConfiguration alarmConfiguration) The details for the CloudWatch alarm you applied to your maintenance window task.
default GetMaintenanceWindowTaskResponse.Builder	alarmConfiguration(Consumer<AlarmConfiguration.Builder> alarmConfiguration) The details for the CloudWatch alarm you applied to your maintenance window task.
GetMaintenanceWindowTaskResponse.Builder	cutoffBehavior(MaintenanceWindowTaskCutoffBehavior cutoffBehavior) The action to take on tasks when the maintenance window cutoff time is reached.
GetMaintenanceWindowTaskResponse.Builder	cutoffBehavior(String cutoffBehavior) The action to take on tasks when the maintenance window cutoff time is reached.
GetMaintenanceWindowTaskResponse.Builder	description(String description) The retrieved task description.
default GetMaintenanceWindowTaskResponse.Builder	loggingInfo(Consumer<LoggingInfo.Builder> loggingInfo) The location in Amazon Simple Storage Service (Amazon S3) where the task results are logged.
GetMaintenanceWindowTaskResponse.Builder	loggingInfo(LoggingInfo loggingInfo) The location in Amazon Simple Storage Service (Amazon S3) where the task results are logged.
GetMaintenanceWindowTaskResponse.Builder	maxConcurrency(String maxConcurrency) The maximum number of targets allowed to run this task in parallel.
GetMaintenanceWindowTaskResponse.Builder	maxErrors(String maxErrors) The maximum number of errors allowed before the task stops being scheduled.
GetMaintenanceWindowTaskResponse.Builder	name(String name) The retrieved task name.
GetMaintenanceWindowTaskResponse.Builder	priority(Integer priority) The priority of the task when it runs.
GetMaintenanceWindowTaskResponse.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.
GetMaintenanceWindowTaskResponse.Builder	targets(Collection<Target> targets) The targets where the task should run.
GetMaintenanceWindowTaskResponse.Builder	targets(Consumer<Target.Builder>... targets) The targets where the task should run.
GetMaintenanceWindowTaskResponse.Builder	targets(Target... targets) The targets where the task should run.
GetMaintenanceWindowTaskResponse.Builder	taskArn(String taskArn) The resource that the task used during execution.
default GetMaintenanceWindowTaskResponse.Builder	taskInvocationParameters(Consumer<MaintenanceWindowTaskInvocationParameters.Builder> taskInvocationParameters) The parameters to pass to the task when it runs.
GetMaintenanceWindowTaskResponse.Builder	taskInvocationParameters(MaintenanceWindowTaskInvocationParameters taskInvocationParameters) The parameters to pass to the task when it runs.
GetMaintenanceWindowTaskResponse.Builder	taskParameters(Map<String,MaintenanceWindowTaskParameterValueExpression> taskParameters) The parameters to pass to the task when it runs.
GetMaintenanceWindowTaskResponse.Builder	taskType(MaintenanceWindowTaskType taskType) The type of task to run.
GetMaintenanceWindowTaskResponse.Builder	taskType(String taskType) The type of task to run.
GetMaintenanceWindowTaskResponse.Builder	windowId(String windowId) The retrieved maintenance window ID.
GetMaintenanceWindowTaskResponse.Builder	windowTaskId(String windowTaskId) The retrieved maintenance window task ID.

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

build, responseMetadata, responseMetadata

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

sdkHttpResponse, sdkHttpResponse

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

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

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)

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

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:

MaintenanceWindowTaskType, MaintenanceWindowTaskType

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:

MaintenanceWindowTaskType, MaintenanceWindowTaskType

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:

taskInvocationParameters(MaintenanceWindowTaskInvocationParameters)

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:

loggingInfo(LoggingInfo)

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:

MaintenanceWindowTaskCutoffBehavior, MaintenanceWindowTaskCutoffBehavior

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:

MaintenanceWindowTaskCutoffBehavior, MaintenanceWindowTaskCutoffBehavior

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:

alarmConfiguration(AlarmConfiguration)