Interface CreateWorkflowRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<CreateWorkflowRequest.Builder,
,CreateWorkflowRequest> ImagebuilderRequest.Builder
,SdkBuilder<CreateWorkflowRequest.Builder,
,CreateWorkflowRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
CreateWorkflowRequest
-
Method Summary
Modifier and TypeMethodDescriptionchangeDescription
(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.clientToken
(String clientToken) Unique, case-sensitive identifier you provide to ensure idempotency of the request.Contains the UTF-8 encoded YAML document content for the workflow.description
(String description) Describes the workflow.The ID of the KMS key that is used to encrypt this workflow resource.The name of the workflow to create.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.semanticVersion
(String semanticVersion) The semantic version of this workflow resource.Tags that apply to the workflow resource.The phase in the image build process for which the workflow resource is responsible.type
(WorkflowType type) The phase in the image build process for which the workflow resource is responsible.Theuri
of a YAML component document file.Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.services.imagebuilder.model.ImagebuilderRequest.Builder
build
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
name
The name of the workflow to create.
- Parameters:
name
- The name of the workflow to create.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
semanticVersion
The semantic version of this workflow resource. The semantic version syntax adheres to the following rules.
The semantic version has four nodes: <major>.<minor>.<patch>/<build>. You can assign values for the first three, and can filter on all of them.
Assignment: For the first three nodes you can assign any positive integer value, including zero, with an upper limit of 2^30-1, or 1073741823 for each node. Image Builder automatically assigns the build number to the fourth node.
Patterns: You can use any numeric pattern that adheres to the assignment requirements for the nodes that you can assign. For example, you might choose a software version pattern, such as 1.0.0, or a date, such as 2021.01.01.
- Parameters:
semanticVersion
- The semantic version of this workflow resource. The semantic version syntax adheres to the following rules.The semantic version has four nodes: <major>.<minor>.<patch>/<build>. You can assign values for the first three, and can filter on all of them.
Assignment: For the first three nodes you can assign any positive integer value, including zero, with an upper limit of 2^30-1, or 1073741823 for each node. Image Builder automatically assigns the build number to the fourth node.
Patterns: You can use any numeric pattern that adheres to the assignment requirements for the nodes that you can assign. For example, you might choose a software version pattern, such as 1.0.0, or a date, such as 2021.01.01.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
description
Describes the workflow.
- Parameters:
description
- Describes 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.
-
data
Contains the UTF-8 encoded YAML document content for the workflow. Alternatively, you can specify the
uri
of a YAML document file stored in Amazon S3. However, you cannot specify both properties.- Parameters:
data
- Contains the UTF-8 encoded YAML document content for the workflow. Alternatively, you can specify theuri
of a YAML document file stored in Amazon S3. However, you cannot specify both properties.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
uri
The
uri
of a YAML component document file. This must be an S3 URL (s3://bucket/key
), and the requester must have permission to access the S3 bucket it points to. If you use Amazon S3, you can specify component content up to your service quota.Alternatively, you can specify the YAML document inline, using the component
data
property. You cannot specify both properties.- Parameters:
uri
- Theuri
of a YAML component document file. This must be an S3 URL (s3://bucket/key
), and the requester must have permission to access the S3 bucket it points to. If you use Amazon S3, you can specify component content up to your service quota.Alternatively, you can specify the YAML document inline, using the component
data
property. You cannot specify both properties.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
kmsKeyId
The ID of the KMS key that is used to encrypt this workflow resource.
- Parameters:
kmsKeyId
- The ID of the KMS key that is used to encrypt this workflow resource.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
tags
Tags that apply to the workflow resource.
- Parameters:
tags
- Tags that apply to the workflow resource.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
clientToken
Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see Ensuring idempotency in the Amazon EC2 API Reference.
- Parameters:
clientToken
- Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see Ensuring idempotency in the Amazon EC2 API Reference.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
type
The phase in the image build process for which the workflow resource is responsible.
- Parameters:
type
- The phase in the image build process for which the workflow resource is responsible.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
type
The phase in the image build process for which the workflow resource is responsible.
- Parameters:
type
- The phase in the image build process for which the workflow resource is responsible.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
overrideConfiguration
CreateWorkflowRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
overrideConfiguration
- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
CreateWorkflowRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-