software.amazon.awssdk.services.ssm.model

Interface AutomationExecution.Builder

All Superinterfaces:

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

Enclosing class:

AutomationExecution

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

Method Summary

Modifier and Type	Method and Description
AutomationExecution.Builder	automationExecutionId(String automationExecutionId) The execution ID.
AutomationExecution.Builder	automationExecutionStatus(AutomationExecutionStatus automationExecutionStatus) The execution status of the Automation.
AutomationExecution.Builder	automationExecutionStatus(String automationExecutionStatus) The execution status of the Automation.
AutomationExecution.Builder	currentAction(String currentAction) The action of the currently executing step.
AutomationExecution.Builder	currentStepName(String currentStepName) The name of the currently executing step.
AutomationExecution.Builder	documentName(String documentName) The name of the Automation document used during the execution.
AutomationExecution.Builder	documentVersion(String documentVersion) The version of the document to use during execution.
AutomationExecution.Builder	executedBy(String executedBy) The Amazon Resource Name (ARN) of the user who executed the automation.
AutomationExecution.Builder	executionEndTime(Instant executionEndTime) The time the execution finished.
AutomationExecution.Builder	executionStartTime(Instant executionStartTime) The time the execution started.
AutomationExecution.Builder	failureMessage(String failureMessage) A message describing why an execution has failed, if the status is set to Failed.
AutomationExecution.Builder	maxConcurrency(String maxConcurrency) The MaxConcurrency value specified by the user when the execution started.
AutomationExecution.Builder	maxErrors(String maxErrors) The MaxErrors value specified by the user when the execution started.
AutomationExecution.Builder	mode(ExecutionMode mode) The automation execution mode.
AutomationExecution.Builder	mode(String mode) The automation execution mode.
AutomationExecution.Builder	outputs(Map<String,? extends Collection<String>> outputs) The list of execution outputs as defined in the automation document.
AutomationExecution.Builder	parameters(Map<String,? extends Collection<String>> parameters) The key-value map of execution parameters, which were supplied when calling StartAutomationExecution.
AutomationExecution.Builder	parentAutomationExecutionId(String parentAutomationExecutionId) The AutomationExecutionId of the parent automation.
default AutomationExecution.Builder	progressCounters(Consumer<ProgressCounters.Builder> progressCounters) An aggregate of step execution statuses displayed in the AWS Console for a multi-Region and multi-account Automation execution.
AutomationExecution.Builder	progressCounters(ProgressCounters progressCounters) An aggregate of step execution statuses displayed in the AWS Console for a multi-Region and multi-account Automation execution.
default AutomationExecution.Builder	resolvedTargets(Consumer<ResolvedTargets.Builder> resolvedTargets) A list of resolved targets in the rate control execution.
AutomationExecution.Builder	resolvedTargets(ResolvedTargets resolvedTargets) A list of resolved targets in the rate control execution.
AutomationExecution.Builder	stepExecutions(Collection<StepExecution> stepExecutions) A list of details about the current state of all steps that comprise an execution.
AutomationExecution.Builder	stepExecutions(Consumer<StepExecution.Builder>... stepExecutions) A list of details about the current state of all steps that comprise an execution.
AutomationExecution.Builder	stepExecutions(StepExecution... stepExecutions) A list of details about the current state of all steps that comprise an execution.
AutomationExecution.Builder	stepExecutionsTruncated(Boolean stepExecutionsTruncated) A boolean value that indicates if the response contains the full list of the Automation step executions.
AutomationExecution.Builder	target(String target) The target of the execution.
AutomationExecution.Builder	targetLocations(Collection<TargetLocation> targetLocations) The combination of AWS Regions and/or AWS accounts where you want to execute the Automation.
AutomationExecution.Builder	targetLocations(Consumer<TargetLocation.Builder>... targetLocations) The combination of AWS Regions and/or AWS accounts where you want to execute the Automation.
AutomationExecution.Builder	targetLocations(TargetLocation... targetLocations) The combination of AWS Regions and/or AWS accounts where you want to execute the Automation.
AutomationExecution.Builder	targetMaps(Collection<? extends Map<String,? extends Collection<String>>> targetMaps) The specified key-value mapping of document parameters to target resources.
AutomationExecution.Builder	targetMaps(Map<String,? extends Collection<String>>... targetMaps) The specified key-value mapping of document parameters to target resources.
AutomationExecution.Builder	targetParameterName(String targetParameterName) The parameter name.
AutomationExecution.Builder	targets(Collection<Target> targets) The specified targets.
AutomationExecution.Builder	targets(Consumer<Target.Builder>... targets) The specified targets.
AutomationExecution.Builder	targets(Target... targets) The specified targets.

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

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

automationExecutionId

AutomationExecution.Builder automationExecutionId(String automationExecutionId)

The execution ID.

Parameters:

automationExecutionId - The execution ID.

Returns:

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

documentName

AutomationExecution.Builder documentName(String documentName)

The name of the Automation document used during the execution.

Parameters:

documentName - The name of the Automation document used during the execution.

Returns:

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

documentVersion

AutomationExecution.Builder documentVersion(String documentVersion)

The version of the document to use during execution.

Parameters:

documentVersion - The version of the document to use during execution.

Returns:

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

executionStartTime

AutomationExecution.Builder executionStartTime(Instant executionStartTime)

The time the execution started.

Parameters:

executionStartTime - The time the execution started.

Returns:

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

executionEndTime

AutomationExecution.Builder executionEndTime(Instant executionEndTime)

The time the execution finished.

Parameters:

executionEndTime - The time the execution finished.

Returns:

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

automationExecutionStatus

AutomationExecution.Builder automationExecutionStatus(String automationExecutionStatus)

The execution status of the Automation.

Parameters:

automationExecutionStatus - The execution status of the Automation.

Returns:

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

See Also:

AutomationExecutionStatus, AutomationExecutionStatus

automationExecutionStatus

AutomationExecution.Builder automationExecutionStatus(AutomationExecutionStatus automationExecutionStatus)

The execution status of the Automation.

Parameters:

automationExecutionStatus - The execution status of the Automation.

Returns:

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

See Also:

AutomationExecutionStatus, AutomationExecutionStatus

stepExecutions

AutomationExecution.Builder stepExecutions(Collection<StepExecution> stepExecutions)

A list of details about the current state of all steps that comprise an execution. An Automation document contains a list of steps that are executed in order.

Parameters:

stepExecutions - A list of details about the current state of all steps that comprise an execution. An Automation document contains a list of steps that are executed in order.

Returns:

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

stepExecutions

AutomationExecution.Builder stepExecutions(StepExecution... stepExecutions)

A list of details about the current state of all steps that comprise an execution. An Automation document contains a list of steps that are executed in order.

Parameters:

stepExecutions - A list of details about the current state of all steps that comprise an execution. An Automation document contains a list of steps that are executed in order.

Returns:

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

stepExecutions

AutomationExecution.Builder stepExecutions(Consumer<StepExecution.Builder>... stepExecutions)

A list of details about the current state of all steps that comprise an execution. An Automation document contains a list of steps that are executed in order.

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 #stepExecutions(List).

Parameters:

stepExecutions - 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:

#stepExecutions(List)

stepExecutionsTruncated

AutomationExecution.Builder stepExecutionsTruncated(Boolean stepExecutionsTruncated)

A boolean value that indicates if the response contains the full list of the Automation step executions. If true, use the DescribeAutomationStepExecutions API action to get the full list of step executions.

Parameters:

stepExecutionsTruncated - A boolean value that indicates if the response contains the full list of the Automation step executions. If true, use the DescribeAutomationStepExecutions API action to get the full list of step executions.

Returns:

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

parameters

AutomationExecution.Builder parameters(Map<String,? extends Collection<String>> parameters)

The key-value map of execution parameters, which were supplied when calling StartAutomationExecution.

Parameters:

parameters - The key-value map of execution parameters, which were supplied when calling StartAutomationExecution.

Returns:

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

outputs

AutomationExecution.Builder outputs(Map<String,? extends Collection<String>> outputs)

The list of execution outputs as defined in the automation document.

Parameters:

outputs - The list of execution outputs as defined in the automation document.

Returns:

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

failureMessage

AutomationExecution.Builder failureMessage(String failureMessage)

A message describing why an execution has failed, if the status is set to Failed.

Parameters:

failureMessage - A message describing why an execution has failed, if the status is set to Failed.

Returns:

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

mode

AutomationExecution.Builder mode(String mode)

The automation execution mode.

Parameters:

mode - The automation execution mode.

Returns:

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

See Also:

ExecutionMode, ExecutionMode

mode

AutomationExecution.Builder mode(ExecutionMode mode)

The automation execution mode.

Parameters:

mode - The automation execution mode.

Returns:

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

See Also:

ExecutionMode, ExecutionMode

parentAutomationExecutionId

AutomationExecution.Builder parentAutomationExecutionId(String parentAutomationExecutionId)

The AutomationExecutionId of the parent automation.

Parameters:

parentAutomationExecutionId - The AutomationExecutionId of the parent automation.

Returns:

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

executedBy

AutomationExecution.Builder executedBy(String executedBy)

The Amazon Resource Name (ARN) of the user who executed the automation.

Parameters:

executedBy - The Amazon Resource Name (ARN) of the user who executed the automation.

Returns:

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

currentStepName

AutomationExecution.Builder currentStepName(String currentStepName)

The name of the currently executing step.

Parameters:

currentStepName - The name of the currently executing step.

Returns:

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

currentAction

AutomationExecution.Builder currentAction(String currentAction)

The action of the currently executing step.

Parameters:

currentAction - The action of the currently executing step.

Returns:

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

targetParameterName

AutomationExecution.Builder targetParameterName(String targetParameterName)

The parameter name.

Parameters:

targetParameterName - The parameter name.

Returns:

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

targets

AutomationExecution.Builder targets(Collection<Target> targets)

The specified targets.

Parameters:

targets - The specified targets.

Returns:

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

targets

AutomationExecution.Builder targets(Target... targets)

The specified targets.

Parameters:

targets - The specified targets.

Returns:

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

targets

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

The specified targets.

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)

targetMaps

AutomationExecution.Builder targetMaps(Collection<? extends Map<String,? extends Collection<String>>> targetMaps)

The specified key-value mapping of document parameters to target resources.

Parameters:

targetMaps - The specified key-value mapping of document parameters to target resources.

Returns:

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

targetMaps

AutomationExecution.Builder targetMaps(Map<String,? extends Collection<String>>... targetMaps)

The specified key-value mapping of document parameters to target resources.

Parameters:

targetMaps - The specified key-value mapping of document parameters to target resources.

Returns:

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

resolvedTargets

AutomationExecution.Builder resolvedTargets(ResolvedTargets resolvedTargets)

A list of resolved targets in the rate control execution.

Parameters:

resolvedTargets - A list of resolved targets in the rate control execution.

Returns:

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

resolvedTargets

default AutomationExecution.Builder resolvedTargets(Consumer<ResolvedTargets.Builder> resolvedTargets)

A list of resolved targets in the rate control execution.

This is a convenience that creates an instance of the ResolvedTargets.Builder avoiding the need to create one manually via ResolvedTargets.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to resolvedTargets(ResolvedTargets).

Parameters:

resolvedTargets - a consumer that will call methods on ResolvedTargets.Builder

Returns:

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

See Also:

resolvedTargets(ResolvedTargets)

maxConcurrency

AutomationExecution.Builder maxConcurrency(String maxConcurrency)

The MaxConcurrency value specified by the user when the execution started.

Parameters:

maxConcurrency - The MaxConcurrency value specified by the user when the execution started.

Returns:

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

maxErrors

AutomationExecution.Builder maxErrors(String maxErrors)

The MaxErrors value specified by the user when the execution started.

Parameters:

maxErrors - The MaxErrors value specified by the user when the execution started.

Returns:

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

target

AutomationExecution.Builder target(String target)

The target of the execution.

Parameters:

target - The target of the execution.

Returns:

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

targetLocations

AutomationExecution.Builder targetLocations(Collection<TargetLocation> targetLocations)

The combination of AWS Regions and/or AWS accounts where you want to execute the Automation.

Parameters:

targetLocations - The combination of AWS Regions and/or AWS accounts where you want to execute the Automation.

Returns:

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

targetLocations

AutomationExecution.Builder targetLocations(TargetLocation... targetLocations)

The combination of AWS Regions and/or AWS accounts where you want to execute the Automation.

Parameters:

targetLocations - The combination of AWS Regions and/or AWS accounts where you want to execute the Automation.

Returns:

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

targetLocations

AutomationExecution.Builder targetLocations(Consumer<TargetLocation.Builder>... targetLocations)

The combination of AWS Regions and/or AWS accounts where you want to execute the Automation.

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 #targetLocations(List).

Parameters:

targetLocations - 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:

#targetLocations(List)

progressCounters

AutomationExecution.Builder progressCounters(ProgressCounters progressCounters)

An aggregate of step execution statuses displayed in the AWS Console for a multi-Region and multi-account Automation execution.

Parameters:

progressCounters - An aggregate of step execution statuses displayed in the AWS Console for a multi-Region and multi-account Automation execution.

Returns:

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

progressCounters

default AutomationExecution.Builder progressCounters(Consumer<ProgressCounters.Builder> progressCounters)

An aggregate of step execution statuses displayed in the AWS Console for a multi-Region and multi-account Automation execution.

This is a convenience that creates an instance of the ProgressCounters.Builder avoiding the need to create one manually via ProgressCounters.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to progressCounters(ProgressCounters).

Parameters:

progressCounters - a consumer that will call methods on ProgressCounters.Builder

Returns:

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

See Also:

progressCounters(ProgressCounters)