Package software.amazon.awscdk.services.omics

Class CfnWorkflowVersion

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.omics.CfnWorkflowVersion
All Implemented Interfaces:
IInspectable, ITaggableV2, IWorkflowVersionRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.113.0 (build fc68b25)", date="2025-09-25T11:29:12.725Z") @Stability(Stable) public class CfnWorkflowVersion extends CfnResource implements IInspectable, IWorkflowVersionRef, ITaggableV2
Creates a new workflow version for the workflow that you specify with the workflowId parameter.

When you create a new version of a workflow, you need to specify the configuration for the new version. It doesn't inherit any configuration values from the workflow.

Provide a version name that is unique for this workflow. You cannot change the name after HealthOmics creates the version.

Don't include any personally identifiable information (PII) in the version name. Version names appear in the workflow version ARN.

For more information, see Workflow versioning in AWS HealthOmics in the AWS HealthOmics User Guide .

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.omics.*;
 CfnWorkflowVersion cfnWorkflowVersion = CfnWorkflowVersion.Builder.create(this, "MyCfnWorkflowVersion")
         .versionName("versionName")
         .workflowId("workflowId")
         // the properties below are optional
         .accelerators("accelerators")
         .containerRegistryMap(ContainerRegistryMapProperty.builder()
                 .imageMappings(List.of(ImageMappingProperty.builder()
                         .destinationImage("destinationImage")
                         .sourceImage("sourceImage")
                         .build()))
                 .registryMappings(List.of(RegistryMappingProperty.builder()
                         .ecrAccountId("ecrAccountId")
                         .ecrRepositoryPrefix("ecrRepositoryPrefix")
                         .upstreamRegistryUrl("upstreamRegistryUrl")
                         .upstreamRepositoryPrefix("upstreamRepositoryPrefix")
                         .build()))
                 .build())
         .containerRegistryMapUri("containerRegistryMapUri")
         .definitionRepository(DefinitionRepositoryProperty.builder()
                 .connectionArn("connectionArn")
                 .excludeFilePatterns(List.of("excludeFilePatterns"))
                 .fullRepositoryId("fullRepositoryId")
                 .sourceReference(SourceReferenceProperty.builder()
                         .type("type")
                         .value("value")
                         .build())
                 .build())
         .definitionUri("definitionUri")
         .description("description")
         .engine("engine")
         .main("main")
         .parameterTemplate(Map.of(
                 "parameterTemplateKey", WorkflowParameterProperty.builder()
                         .description("description")
                         .optional(false)
                         .build()))
         .parameterTemplatePath("parameterTemplatePath")
         .readmeMarkdown("readmeMarkdown")
         .readmePath("readmePath")
         .readmeUri("readmeUri")
         .storageCapacity(123)
         .storageType("storageType")
         .tags(Map.of(
                 "tagsKey", "tags"))
         .workflowBucketOwnerId("workflowBucketOwnerId")
         .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

    • CfnWorkflowVersion

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

    • CfnWorkflowVersion

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

    • CfnWorkflowVersion

      @Stability(Stable) public CfnWorkflowVersion(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnWorkflowVersionProps 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()
      ARN of the workflow version.

    • getAttrCreationTime

      @Stability(Stable) @NotNull public String getAttrCreationTime()
      The creation time of the workflow version.

    • getAttrStatus

      @Stability(Stable) @NotNull public String getAttrStatus()
      The status of the workflow version.

    • getAttrType

      @Stability(Stable) @NotNull public String getAttrType()
      The type of the workflow version.

    • getAttrUuid

      @Stability(Stable) @NotNull public String getAttrUuid()

    • 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

    • getWorkflowVersionRef

      @Stability(Stable) @NotNull public WorkflowVersionReference getWorkflowVersionRef()
      A reference to a WorkflowVersion resource.
      Specified by:
      getWorkflowVersionRef in interface IWorkflowVersionRef

    • getVersionName

      @Stability(Stable) @NotNull public String getVersionName()
      The name of the workflow version.

    • setVersionName

      @Stability(Stable) public void setVersionName(@NotNull String value)
      The name of the workflow version.

    • getWorkflowId

      @Stability(Stable) @NotNull public String getWorkflowId()
      The workflow's ID.

    • setWorkflowId

      @Stability(Stable) public void setWorkflowId(@NotNull String value)
      The workflow's ID.

    • getAccelerators

      @Stability(Stable) @Nullable public String getAccelerators()

    • setAccelerators

      @Stability(Stable) public void setAccelerators(@Nullable String value)

    • getContainerRegistryMap

      @Stability(Stable) @Nullable public Object getContainerRegistryMap()
      Use a container registry map to specify mappings between the ECR private repository and one or more upstream registries.

    • setContainerRegistryMap

      @Stability(Stable) public void setContainerRegistryMap(@Nullable IResolvable value)
      Use a container registry map to specify mappings between the ECR private repository and one or more upstream registries.

    • setContainerRegistryMap

      @Stability(Stable) public void setContainerRegistryMap(@Nullable CfnWorkflowVersion.ContainerRegistryMapProperty value)
      Use a container registry map to specify mappings between the ECR private repository and one or more upstream registries.

    • getContainerRegistryMapUri

      @Stability(Stable) @Nullable public String getContainerRegistryMapUri()

    • setContainerRegistryMapUri

      @Stability(Stable) public void setContainerRegistryMapUri(@Nullable String value)

    • getDefinitionRepository

      @Stability(Stable) @Nullable public Object getDefinitionRepository()
      Contains information about a source code repository that hosts the workflow definition files.

    • setDefinitionRepository

      @Stability(Stable) public void setDefinitionRepository(@Nullable IResolvable value)
      Contains information about a source code repository that hosts the workflow definition files.

    • setDefinitionRepository

      @Stability(Stable) public void setDefinitionRepository(@Nullable CfnWorkflowVersion.DefinitionRepositoryProperty value)
      Contains information about a source code repository that hosts the workflow definition files.

    • getDefinitionUri

      @Stability(Stable) @Nullable public String getDefinitionUri()

    • setDefinitionUri

      @Stability(Stable) public void setDefinitionUri(@Nullable String value)

    • getDescription

      @Stability(Stable) @Nullable public String getDescription()
      The description of the workflow version.

    • setDescription

      @Stability(Stable) public void setDescription(@Nullable String value)
      The description of the workflow version.

    • getEngine

      @Stability(Stable) @Nullable public String getEngine()

    • setEngine

      @Stability(Stable) public void setEngine(@Nullable String value)

    • getMain

      @Stability(Stable) @Nullable public String getMain()

    • setMain

      @Stability(Stable) public void setMain(@Nullable String value)

    • getParameterTemplate

      @Stability(Stable) @Nullable public Object getParameterTemplate()

    • setParameterTemplate

      @Stability(Stable) public void setParameterTemplate(@Nullable IResolvable value)

    • setParameterTemplate

      @Stability(Stable) public void setParameterTemplate(@Nullable Map<String,Object> value)

    • getParameterTemplatePath

      @Stability(Stable) @Nullable public String getParameterTemplatePath()
      Path to the primary workflow parameter template JSON file inside the repository.

    • setParameterTemplatePath

      @Stability(Stable) public void setParameterTemplatePath(@Nullable String value)
      Path to the primary workflow parameter template JSON file inside the repository.

    • getReadmeMarkdown

      @Stability(Stable) @Nullable public String getReadmeMarkdown()
      The markdown content for the workflow's README file.

    • setReadmeMarkdown

      @Stability(Stable) public void setReadmeMarkdown(@Nullable String value)
      The markdown content for the workflow's README file.

    • getReadmePath

      @Stability(Stable) @Nullable public String getReadmePath()
      The path to the workflow README markdown file within the repository.

    • setReadmePath

      @Stability(Stable) public void setReadmePath(@Nullable String value)
      The path to the workflow README markdown file within the repository.

    • getReadmeUri

      @Stability(Stable) @Nullable public String getReadmeUri()
      The S3 URI of the README file for the workflow.

    • setReadmeUri

      @Stability(Stable) public void setReadmeUri(@Nullable String value)
      The S3 URI of the README file for the workflow.

    • getStorageCapacity

      @Stability(Stable) @Nullable public Number getStorageCapacity()

    • setStorageCapacity

      @Stability(Stable) public void setStorageCapacity(@Nullable Number value)

    • getStorageType

      @Stability(Stable) @Nullable public String getStorageType()

    • setStorageType

      @Stability(Stable) public void setStorageType(@Nullable String value)

    • getTags

      @Stability(Stable) @Nullable public Map<String,String> getTags()
      A map of resource tags.

    • setTags

      @Stability(Stable) public void setTags(@Nullable Map<String,String> value)
      A map of resource tags.

    • getWorkflowBucketOwnerId

      @Stability(Stable) @Nullable public String getWorkflowBucketOwnerId()

    • setWorkflowBucketOwnerId

      @Stability(Stable) public void setWorkflowBucketOwnerId(@Nullable String value)