Interface Workflow.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<Workflow.Builder,
,Workflow> SdkBuilder<Workflow.Builder,
,Workflow> SdkPojo
- Enclosing class:
Workflow
-
Method Summary
Modifier and TypeMethodDescriptionThe Amazon Resource Name (ARN) of the workflow resource.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.Contains the YAML document content for the workflow.dateCreated
(String dateCreated) The timestamp when Image Builder created the workflow resource.description
(String description) The description of the workflow.The KMS key identifier used to encrypt the workflow resource.The name of the workflow resource.The owner of the workflow resource.parameters
(Collection<WorkflowParameterDetail> parameters) An array of input parameters that that the image workflow uses to control actions or configure settings.parameters
(Consumer<WorkflowParameterDetail.Builder>... parameters) An array of input parameters that that the image workflow uses to control actions or configure settings.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.state
(WorkflowState state) Describes the current status of the workflow and the reason for that status.The tags that apply to the workflow resourceSpecifies the image creation stage that the workflow applies to.type
(WorkflowType type) Specifies the image creation stage that the workflow applies to.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, sdkFieldNameToField, sdkFields
-
Method Details
-
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
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
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
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
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
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:
-
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:
-
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
Describes the current status of the workflow and the reason for that status.
This is a convenience method that creates an instance of theWorkflowState.Builder
avoiding the need to create one manually viaWorkflowState.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tostate(WorkflowState)
.- Parameters:
state
- a consumer that will call methods onWorkflowState.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
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
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
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
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
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
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
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 theWorkflowParameterDetail.Builder
avoiding the need to create one manually viaWorkflowParameterDetail.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toparameters(List<WorkflowParameterDetail>)
.- Parameters:
parameters
- a consumer that will call methods onWorkflowParameterDetail.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-