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

Interface Workflow.Builder

All Superinterfaces:

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

Enclosing class:

Workflow

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

Method Summary

Modifier and Type	Method	Description
Workflow.Builder	arn(String arn)	The Amazon Resource Name (ARN) of the workflow resource.
Workflow.Builder	changeDescription(String changeDescription)	Describes what change has been made in this version of the workflow, or what makes this version different from other versions of the workflow.
Workflow.Builder	data(String data)	Contains the YAML document content for the workflow.
Workflow.Builder	dateCreated(String dateCreated)	The timestamp when Image Builder created the workflow resource.
Workflow.Builder	description(String description)	The description of the workflow.
Workflow.Builder	kmsKeyId(String kmsKeyId)	The KMS key identifier used to encrypt the workflow resource.
Workflow.Builder	name(String name)	The name of the workflow resource.
Workflow.Builder	owner(String owner)	The owner of the workflow resource.
Workflow.Builder	parameters(Collection<WorkflowParameterDetail> parameters)	An array of input parameters that that the image workflow uses to control actions or configure settings.
Workflow.Builder	parameters(Consumer<WorkflowParameterDetail.Builder>... parameters)	An array of input parameters that that the image workflow uses to control actions or configure settings.
Workflow.Builder	parameters(WorkflowParameterDetail... parameters)	An array of input parameters that that the image workflow uses to control actions or configure settings.
default Workflow.Builder	state(Consumer<WorkflowState.Builder> state)	Describes the current status of the workflow and the reason for that status.
Workflow.Builder	state(WorkflowState state)	Describes the current status of the workflow and the reason for that status.
Workflow.Builder	tags(Map<String,String> tags)	The tags that apply to the workflow resource
Workflow.Builder	type(String type)	Specifies the image creation stage that the workflow applies to.
Workflow.Builder	type(WorkflowType type)	Specifies the image creation stage that the workflow applies to.
Workflow.Builder	version(String version)	The workflow resource version.

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

arn

Workflow.Builder arn(String arn)

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

Parameters:

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

Returns:

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

name

Workflow.Builder name(String name)

The name of the workflow resource.

Parameters:

name - The name of the workflow resource.

Returns:

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

version

Workflow.Builder version(String version)

The workflow resource version. Workflow resources are immutable. To make a change, you can clone a workflow or create a new version.

Parameters:

version - The workflow resource version. Workflow resources are immutable. To make a change, you can clone a workflow or create a new version.

Returns:

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

description

Workflow.Builder description(String description)

The description of the workflow.

Parameters:

description - The description of the workflow.

Returns:

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

changeDescription

Workflow.Builder changeDescription(String changeDescription)

Describes what change has been made in this version of the workflow, or what makes this version different from other versions of the workflow.

Parameters:

changeDescription - Describes what change has been made in this version of the workflow, or what makes this version different from other versions of the workflow.

Returns:

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

type

Workflow.Builder type(String type)

Specifies the image creation stage that the workflow applies to. Image Builder currently supports build and test workflows.

Parameters:

type - Specifies the image creation stage that the workflow applies to. Image Builder currently supports build and test workflows.

Returns:

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

See Also:

WorkflowType, WorkflowType

type

Workflow.Builder type(WorkflowType type)

Specifies the image creation stage that the workflow applies to. Image Builder currently supports build and test workflows.

Parameters:

type - Specifies the image creation stage that the workflow applies to. Image Builder currently supports build and test workflows.

Returns:

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

See Also:

WorkflowType, WorkflowType

state

Workflow.Builder state(WorkflowState state)

Describes the current status of the workflow and the reason for that status.

Parameters:

state - Describes the current status of the workflow and the reason for that status.

Returns:

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

state

default Workflow.Builder state(Consumer<WorkflowState.Builder> state)

Describes the current status of the workflow and the reason for that status.

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

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to state(WorkflowState).

Parameters:

state - a consumer that will call methods on WorkflowState.Builder

Returns:

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

See Also:

state(WorkflowState)

owner

Workflow.Builder owner(String owner)

The owner of the workflow resource.

Parameters:

owner - The owner of the workflow resource.

Returns:

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

data

Workflow.Builder data(String data)

Contains the YAML document content for the workflow.

Parameters:

data - Contains the YAML document content for the workflow.

Returns:

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

kmsKeyId

Workflow.Builder kmsKeyId(String kmsKeyId)

The KMS key identifier used to encrypt the workflow resource.

Parameters:

kmsKeyId - The KMS key identifier used to encrypt the workflow resource.

Returns:

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

dateCreated

Workflow.Builder dateCreated(String dateCreated)

The timestamp when Image Builder created the workflow resource.

Parameters:

dateCreated - The timestamp when Image Builder created the workflow resource.

Returns:

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

tags

Workflow.Builder tags(Map<String,String> tags)

The tags that apply to the workflow resource

Parameters:

tags - The tags that apply to the workflow resource

Returns:

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

parameters

Workflow.Builder parameters(Collection<WorkflowParameterDetail> parameters)

An array of input parameters that that the image workflow uses to control actions or configure settings.

Parameters:

parameters - An array of input parameters that that the image workflow uses to control actions or configure settings.

Returns:

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

parameters

Workflow.Builder parameters(WorkflowParameterDetail... parameters)

An array of input parameters that that the image workflow uses to control actions or configure settings.

Parameters:

parameters - An array of input parameters that that the image workflow uses to control actions or configure settings.

Returns:

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

parameters

Workflow.Builder parameters(Consumer<WorkflowParameterDetail.Builder>... parameters)

An array of input parameters that that the image workflow uses to control actions or configure settings.

This is a convenience method that creates an instance of the WorkflowParameterDetail.Builder avoiding the need to create one manually via WorkflowParameterDetail.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 WorkflowParameterDetail.Builder

Returns:

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

See Also:

#parameters(java.util.Collection)