Package software.amazon.awscdk.services.imagebuilder

Class CfnWorkflow

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.imagebuilder.CfnWorkflow
All Implemented Interfaces:
IEnvironmentAware, IInspectable, ITaggableV2, IWorkflowRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.118.0 (build 02eec31)", date="2025-11-10T13:40:07.460Z") @Stability(Stable) public class CfnWorkflow extends CfnResource implements IInspectable, IWorkflowRef, ITaggableV2
Create a new workflow or a new version of an existing workflow.

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.*;
 CfnWorkflow cfnWorkflow = CfnWorkflow.Builder.create(this, "MyCfnWorkflow")
         .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:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnWorkflow

      protected CfnWorkflow(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnWorkflow

      protected CfnWorkflow(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnWorkflow

      @Stability(Stable) public CfnWorkflow(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnWorkflowProps props)
      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrArn

      @Stability(Stable) @NotNull public String getAttrArn()
      The Amazon Resource Name (ARN) of the workflow resource.

    • getAttrLatestVersion

      @Stability(Stable) @NotNull public IResolvable getAttrLatestVersion()
      The latest version references of the workflow.

    • getAttrLatestVersionArn

      @Stability(Stable) @NotNull public String getAttrLatestVersionArn()
      The Amazon Resource Name (ARN) of the workflow resource.

    • getAttrLatestVersionMajor

      @Stability(Stable) @NotNull public String getAttrLatestVersionMajor()
      The latest version ARN of the created workflow, with the same major version.

    • getAttrLatestVersionMinor

      @Stability(Stable) @NotNull public String getAttrLatestVersionMinor()
      The latest version ARN of the created workflow, with the same minor version.

    • getAttrLatestVersionPatch

      @Stability(Stable) @NotNull public String getAttrLatestVersionPatch()
      The latest version ARN of the created workflow, with the same patch version.

    • getCdkTagManager

      @Stability(Stable) @NotNull public TagManager getCdkTagManager()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getCdkTagManager in interface ITaggableV2

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getWorkflowRef

      @Stability(Stable) @NotNull public WorkflowReference getWorkflowRef()
      A reference to a Workflow resource.
      Specified by:
      getWorkflowRef in interface IWorkflowRef

    • getName

      @Stability(Stable) @NotNull public String getName()
      The name of the workflow to create.

    • setName

      @Stability(Stable) public void setName(@NotNull String value)
      The name of the workflow to create.

    • getType

      @Stability(Stable) @NotNull public String getType()
      The phase in the image build process for which the workflow resource is responsible.

    • setType

      @Stability(Stable) public void setType(@NotNull String value)
      The phase in the image build process for which the workflow resource is responsible.

    • getVersion

      @Stability(Stable) @NotNull public String getVersion()
      The semantic version of this workflow resource.

      The semantic version syntax adheres to the following rules.

    • setVersion

      @Stability(Stable) public void setVersion(@NotNull String value)
      The semantic version of this workflow resource.

      The semantic version syntax adheres to the following rules.

    • getChangeDescription

      @Stability(Stable) @Nullable public 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.

    • setChangeDescription

      @Stability(Stable) public void setChangeDescription(@Nullable String value)
      Describes what change has been made in this version of the workflow, or what makes this version different from other versions of the workflow.

    • getData

      @Stability(Stable) @Nullable public String getData()
      Contains the UTF-8 encoded YAML document content for the workflow.

    • setData

      @Stability(Stable) public void setData(@Nullable String value)
      Contains the UTF-8 encoded YAML document content for the workflow.

    • getDescription

      @Stability(Stable) @Nullable public String getDescription()
      Describes the workflow.

    • setDescription

      @Stability(Stable) public void setDescription(@Nullable String value)
      Describes the workflow.

    • getKmsKeyId

      @Stability(Stable) @Nullable public String getKmsKeyId()
      The Amazon Resource Name (ARN) that uniquely identifies the KMS key used to encrypt this workflow resource.

    • setKmsKeyId

      @Stability(Stable) public void setKmsKeyId(@Nullable String value)
      The Amazon Resource Name (ARN) that uniquely identifies the KMS key used to encrypt this workflow resource.

    • getTags

      @Stability(Stable) @Nullable public Map<String,String> getTags()
      Tags that apply to the workflow resource.

    • setTags

      @Stability(Stable) public void setTags(@Nullable Map<String,String> value)
      Tags that apply to the workflow resource.

    • getUri

      @Stability(Stable) @Nullable public String getUri()
      The uri of a YAML component document file.

    • setUri

      @Stability(Stable) public void setUri(@Nullable String value)
      The uri of a YAML component document file.