Package software.amazon.awssdk.services.imagebuilder.model

Interface WorkflowConfiguration.Builder

All Superinterfaces:

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

Enclosing class:

WorkflowConfiguration

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

Method Summary

Modifier and Type	Method	Description
WorkflowConfiguration.Builder	onFailure(String onFailure)	The action to take if the workflow fails.
WorkflowConfiguration.Builder	onFailure(OnWorkflowFailure onFailure)	The action to take if the workflow fails.
WorkflowConfiguration.Builder	parallelGroup(String parallelGroup)	Test workflows are defined within named runtime groups called parallel groups.
WorkflowConfiguration.Builder	parameters(Collection<WorkflowParameter> parameters)	Contains parameter values for each of the parameters that the workflow document defined for the workflow resource.
WorkflowConfiguration.Builder	parameters(Consumer<WorkflowParameter.Builder>... parameters)	Contains parameter values for each of the parameters that the workflow document defined for the workflow resource.
WorkflowConfiguration.Builder	parameters(WorkflowParameter... parameters)	Contains parameter values for each of the parameters that the workflow document defined for the workflow resource.
WorkflowConfiguration.Builder	workflowArn(String workflowArn)	The Amazon Resource Name (ARN) of the workflow resource.

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, sdkFields

Method Detail

workflowArn

WorkflowConfiguration.Builder workflowArn(String workflowArn)

The Amazon Resource Name (ARN) of the workflow resource.

Parameters:

workflowArn - The Amazon Resource Name (ARN) of the workflow resource.

Returns:

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

parameters

WorkflowConfiguration.Builder parameters(Collection<WorkflowParameter> parameters)

Contains parameter values for each of the parameters that the workflow document defined for the workflow resource.

Parameters:

parameters - Contains parameter values for each of the parameters that the workflow document defined for the workflow resource.

Returns:

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

parameters

WorkflowConfiguration.Builder parameters(WorkflowParameter... parameters)

Contains parameter values for each of the parameters that the workflow document defined for the workflow resource.

Parameters:

parameters - Contains parameter values for each of the parameters that the workflow document defined for the workflow resource.

Returns:

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

parameters

WorkflowConfiguration.Builder parameters(Consumer<WorkflowParameter.Builder>... parameters)

Contains parameter values for each of the parameters that the workflow document defined for the workflow resource.

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

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #parameters(List).

Parameters:

parameters - a consumer that will call methods on WorkflowParameter.Builder

Returns:

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

See Also:

#parameters(java.util.Collection)

parallelGroup

WorkflowConfiguration.Builder parallelGroup(String parallelGroup)

Test workflows are defined within named runtime groups called parallel groups. The parallel group is the named group that contains this test workflow. Test workflows within a parallel group can run at the same time. Image Builder starts up to five test workflows in the group at the same time, and starts additional workflows as others complete, until all workflows in the group have completed. This field only applies for test workflows.

Parameters:

parallelGroup - Test workflows are defined within named runtime groups called parallel groups. The parallel group is the named group that contains this test workflow. Test workflows within a parallel group can run at the same time. Image Builder starts up to five test workflows in the group at the same time, and starts additional workflows as others complete, until all workflows in the group have completed. This field only applies for test workflows.

Returns:

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

onFailure

WorkflowConfiguration.Builder onFailure(String onFailure)

The action to take if the workflow fails.

Parameters:

onFailure - The action to take if the workflow fails.

Returns:

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

See Also:

OnWorkflowFailure, OnWorkflowFailure

onFailure

WorkflowConfiguration.Builder onFailure(OnWorkflowFailure onFailure)

The action to take if the workflow fails.

Parameters:

onFailure - The action to take if the workflow fails.

Returns:

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

See Also:

OnWorkflowFailure, OnWorkflowFailure