software.amazon.awssdk.services.ssm.model

Interface StepExecution.Builder

All Superinterfaces:

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

Enclosing class:

StepExecution

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

Method Summary

Modifier and Type	Method and Description
StepExecution.Builder	action(String action) The action this step performs.
StepExecution.Builder	executionEndTime(Instant executionEndTime) If a step has finished execution, this contains the time the execution ended.
StepExecution.Builder	executionStartTime(Instant executionStartTime) If a step has begun execution, this contains the time the step started.
default StepExecution.Builder	failureDetails(Consumer<FailureDetails.Builder> failureDetails) Information about the Automation failure.
StepExecution.Builder	failureDetails(FailureDetails failureDetails) Information about the Automation failure.
StepExecution.Builder	failureMessage(String failureMessage) If a step failed, this message explains why the execution failed.
StepExecution.Builder	inputs(Map<String,String> inputs) Fully-resolved values passed into the step before execution.
StepExecution.Builder	isCritical(Boolean isCritical) The flag which can be used to help decide whether the failure of current step leads to the Automation failure.
StepExecution.Builder	isEnd(Boolean isEnd) The flag which can be used to end automation no matter whether the step succeeds or fails.
StepExecution.Builder	maxAttempts(Integer maxAttempts) The maximum number of tries to run the action of the step.
StepExecution.Builder	nextStep(String nextStep) The next step after the step succeeds.
StepExecution.Builder	onFailure(String onFailure) The action to take if the step fails.
StepExecution.Builder	outputs(Map<String,? extends Collection<String>> outputs) Returned values from the execution of the step.
StepExecution.Builder	overriddenParameters(Map<String,? extends Collection<String>> overriddenParameters) A user-specified list of parameters to override when running a step.
StepExecution.Builder	response(String response) A message associated with the response code for an execution.
StepExecution.Builder	responseCode(String responseCode) The response code returned by the execution of the step.
StepExecution.Builder	stepExecutionId(String stepExecutionId) The unique ID of a step execution.
StepExecution.Builder	stepName(String stepName) The name of this execution step.
StepExecution.Builder	stepStatus(AutomationExecutionStatus stepStatus) The execution status for this step.
StepExecution.Builder	stepStatus(String stepStatus) The execution status for this step.
default StepExecution.Builder	targetLocation(Consumer<TargetLocation.Builder> targetLocation) The combination of AWS Regions and accounts targeted by the current Automation execution.
StepExecution.Builder	targetLocation(TargetLocation targetLocation) The combination of AWS Regions and accounts targeted by the current Automation execution.
StepExecution.Builder	targets(Collection<Target> targets) The targets for the step execution.
StepExecution.Builder	targets(Consumer<Target.Builder>... targets) The targets for the step execution.
StepExecution.Builder	targets(Target... targets) The targets for the step execution.
StepExecution.Builder	timeoutSeconds(Long timeoutSeconds) The timeout seconds of the step.
StepExecution.Builder	validNextSteps(Collection<String> validNextSteps) Strategies used when step fails, we support Continue and Abort.
StepExecution.Builder	validNextSteps(String... validNextSteps) Strategies used when step fails, we support Continue and Abort.

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

stepName

StepExecution.Builder stepName(String stepName)

The name of this execution step.

Parameters:

stepName - The name of this execution step.

Returns:

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

action

StepExecution.Builder action(String action)

The action this step performs. The action determines the behavior of the step.

Parameters:

action - The action this step performs. The action determines the behavior of the step.

Returns:

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

timeoutSeconds

StepExecution.Builder timeoutSeconds(Long timeoutSeconds)

The timeout seconds of the step.

Parameters:

timeoutSeconds - The timeout seconds of the step.

Returns:

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

onFailure

StepExecution.Builder onFailure(String onFailure)

The action to take if the step fails. The default value is Abort.

Parameters:

onFailure - The action to take if the step fails. The default value is Abort.

Returns:

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

maxAttempts

StepExecution.Builder maxAttempts(Integer maxAttempts)

The maximum number of tries to run the action of the step. The default value is 1.

Parameters:

maxAttempts - The maximum number of tries to run the action of the step. The default value is 1.

Returns:

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

executionStartTime

StepExecution.Builder executionStartTime(Instant executionStartTime)

If a step has begun execution, this contains the time the step started. If the step is in Pending status, this field is not populated.

Parameters:

executionStartTime - If a step has begun execution, this contains the time the step started. If the step is in Pending status, this field is not populated.

Returns:

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

executionEndTime

StepExecution.Builder executionEndTime(Instant executionEndTime)

If a step has finished execution, this contains the time the execution ended. If the step has not yet concluded, this field is not populated.

Parameters:

executionEndTime - If a step has finished execution, this contains the time the execution ended. If the step has not yet concluded, this field is not populated.

Returns:

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

stepStatus

StepExecution.Builder stepStatus(String stepStatus)

The execution status for this step.

Parameters:

stepStatus - The execution status for this step.

Returns:

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

See Also:

AutomationExecutionStatus, AutomationExecutionStatus

stepStatus

StepExecution.Builder stepStatus(AutomationExecutionStatus stepStatus)

The execution status for this step.

Parameters:

stepStatus - The execution status for this step.

Returns:

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

See Also:

AutomationExecutionStatus, AutomationExecutionStatus

responseCode

StepExecution.Builder responseCode(String responseCode)

The response code returned by the execution of the step.

Parameters:

responseCode - The response code returned by the execution of the step.

Returns:

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

inputs

StepExecution.Builder inputs(Map<String,String> inputs)

Fully-resolved values passed into the step before execution.

Parameters:

inputs - Fully-resolved values passed into the step before execution.

Returns:

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

outputs

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

Returned values from the execution of the step.

Parameters:

outputs - Returned values from the execution of the step.

Returns:

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

response

StepExecution.Builder response(String response)

A message associated with the response code for an execution.

Parameters:

response - A message associated with the response code for an execution.

Returns:

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

failureMessage

StepExecution.Builder failureMessage(String failureMessage)

If a step failed, this message explains why the execution failed.

Parameters:

failureMessage - If a step failed, this message explains why the execution failed.

Returns:

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

failureDetails

StepExecution.Builder failureDetails(FailureDetails failureDetails)

Information about the Automation failure.

Parameters:

failureDetails - Information about the Automation failure.

Returns:

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

failureDetails

default StepExecution.Builder failureDetails(Consumer<FailureDetails.Builder> failureDetails)

Information about the Automation failure.

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

Parameters:

failureDetails - a consumer that will call methods on FailureDetails.Builder

Returns:

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

See Also:

failureDetails(FailureDetails)

stepExecutionId

StepExecution.Builder stepExecutionId(String stepExecutionId)

The unique ID of a step execution.

Parameters:

stepExecutionId - The unique ID of a step execution.

Returns:

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

overriddenParameters

StepExecution.Builder overriddenParameters(Map<String,? extends Collection<String>> overriddenParameters)

A user-specified list of parameters to override when running a step.

Parameters:

overriddenParameters - A user-specified list of parameters to override when running a step.

Returns:

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

isEnd

StepExecution.Builder isEnd(Boolean isEnd)

The flag which can be used to end automation no matter whether the step succeeds or fails.

Parameters:

isEnd - The flag which can be used to end automation no matter whether the step succeeds or fails.

Returns:

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

nextStep

StepExecution.Builder nextStep(String nextStep)

The next step after the step succeeds.

Parameters:

nextStep - The next step after the step succeeds.

Returns:

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

isCritical

StepExecution.Builder isCritical(Boolean isCritical)

The flag which can be used to help decide whether the failure of current step leads to the Automation failure.

Parameters:

isCritical - The flag which can be used to help decide whether the failure of current step leads to the Automation failure.

Returns:

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

validNextSteps

StepExecution.Builder validNextSteps(Collection<String> validNextSteps)

Strategies used when step fails, we support Continue and Abort. Abort will fail the automation when the step fails. Continue will ignore the failure of current step and allow automation to run the next step. With conditional branching, we add step:stepName to support the automation to go to another specific step.

Parameters:

validNextSteps - Strategies used when step fails, we support Continue and Abort. Abort will fail the automation when the step fails. Continue will ignore the failure of current step and allow automation to run the next step. With conditional branching, we add step:stepName to support the automation to go to another specific step.

Returns:

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

validNextSteps

StepExecution.Builder validNextSteps(String... validNextSteps)

Strategies used when step fails, we support Continue and Abort. Abort will fail the automation when the step fails. Continue will ignore the failure of current step and allow automation to run the next step. With conditional branching, we add step:stepName to support the automation to go to another specific step.

Parameters:

validNextSteps - Strategies used when step fails, we support Continue and Abort. Abort will fail the automation when the step fails. Continue will ignore the failure of current step and allow automation to run the next step. With conditional branching, we add step:stepName to support the automation to go to another specific step.

Returns:

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

targets

StepExecution.Builder targets(Collection<Target> targets)

The targets for the step execution.

Parameters:

targets - The targets for the step execution.

Returns:

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

targets

StepExecution.Builder targets(Target... targets)

The targets for the step execution.

Parameters:

targets - The targets for the step execution.

Returns:

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

targets

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

The targets for the step execution.

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)

targetLocation

StepExecution.Builder targetLocation(TargetLocation targetLocation)

The combination of AWS Regions and accounts targeted by the current Automation execution.

Parameters:

targetLocation - The combination of AWS Regions and accounts targeted by the current Automation execution.

Returns:

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

targetLocation

default StepExecution.Builder targetLocation(Consumer<TargetLocation.Builder> targetLocation)

The combination of AWS Regions and accounts targeted by the current Automation execution.

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

Parameters:

targetLocation - a consumer that will call methods on TargetLocation.Builder

Returns:

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

See Also:

targetLocation(TargetLocation)