Package software.amazon.awscdk.services.imagebuilder

Interface CfnWorkflowProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnWorkflowProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.113.0 (build fc68b25)",
           date="2025-09-02T11:25:32.921Z")
@Stability(Stable)
public interface CfnWorkflowProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnWorkflow.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.imagebuilder.*;
 CfnWorkflowProps cfnWorkflowProps = CfnWorkflowProps.builder()
         .name("name")
         .type("type")
         .version("version")
         // the properties below are optional
         .changeDescription("changeDescription")
         .data("data")
         .description("description")
         .kmsKeyId("kmsKeyId")
         .tags(Map.of(
                 "tagsKey", "tags"))
         .uri("uri")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-workflow.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnWorkflowProps.Builder	A builder for CfnWorkflowProps
static final class	CfnWorkflowProps.Jsii$Proxy	An implementation for CfnWorkflowProps

Method Summary

Modifier and Type	Method	Description
static CfnWorkflowProps.Builder	builder()
default String	getChangeDescription()	Describes what change has been made in this version of the workflow, or what makes this version different from other versions of the workflow.
default String	getData()	Contains the UTF-8 encoded YAML document content for the workflow.
default String	getDescription()	Describes the workflow.
default String	getKmsKeyId()	The Amazon Resource Name (ARN) that uniquely identifies the KMS key used to encrypt this workflow resource.
String	getName()	The name of the workflow to create.
default Map<String,String>	getTags()	Tags that apply to the workflow resource.
String	getType()	The phase in the image build process for which the workflow resource is responsible.
default String	getUri()	The uri of a YAML component document file.
String	getVersion()	The semantic version of this workflow resource.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getName

@Stability(Stable)
@NotNull
String getName()

The name of the workflow to create.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-workflow.html#cfn-imagebuilder-workflow-name

getType

@Stability(Stable)
@NotNull
String getType()

The phase in the image build process for which the workflow resource is responsible.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-workflow.html#cfn-imagebuilder-workflow-type

getVersion

@Stability(Stable)
@NotNull
String getVersion()

The semantic version of this workflow resource. The semantic version syntax adheres to the following rules.

The semantic version has four nodes: ../. 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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-workflow.html#cfn-imagebuilder-workflow-version

getChangeDescription

@Stability(Stable)
@Nullable
default String getChangeDescription()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-workflow.html#cfn-imagebuilder-workflow-changedescription

getData

@Stability(Stable)
@Nullable
default String getData()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-workflow.html#cfn-imagebuilder-workflow-data

getDescription

@Stability(Stable)
@Nullable
default String getDescription()

Describes the workflow.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-workflow.html#cfn-imagebuilder-workflow-description

getKmsKeyId

@Stability(Stable)
@Nullable
default String getKmsKeyId()

The Amazon Resource Name (ARN) that uniquely identifies the KMS key used to encrypt this workflow resource.

This can be either the Key ARN or the Alias ARN. For more information, see Key identifiers (KeyId) in the AWS Key Management Service Developer Guide .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-workflow.html#cfn-imagebuilder-workflow-kmskeyid

getTags

@Stability(Stable)
@Nullable
default Map<String,String> getTags()

Tags that apply to the workflow resource.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-workflow.html#cfn-imagebuilder-workflow-tags

getUri

@Stability(Stable)
@Nullable
default String getUri()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-workflow.html#cfn-imagebuilder-workflow-uri

builder

@Stability(Stable)
static CfnWorkflowProps.Builder builder()

Returns:

a CfnWorkflowProps.Builder of CfnWorkflowProps