Package software.amazon.awscdk.services.omics

Interface CfnWorkflowVersionProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnWorkflowVersionProps.Jsii$Proxy

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

Properties for defining a CfnWorkflowVersion.

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.*;
 CfnWorkflowVersionProps cfnWorkflowVersionProps = CfnWorkflowVersionProps.builder()
         .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:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-omics-workflowversion.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnWorkflowVersionProps.Builder	builder()
default String	getAccelerators()
default Object	getContainerRegistryMap()	Use a container registry map to specify mappings between the ECR private repository and one or more upstream registries.
default String	getContainerRegistryMapUri()
default Object	getDefinitionRepository()	Contains information about a source code repository that hosts the workflow definition files.
default String	getDefinitionUri()
default String	getDescription()	The description of the workflow version.
default String	getEngine()
default String	getMain()
default Object	getParameterTemplate()
default String	getParameterTemplatePath()	Path to the primary workflow parameter template JSON file inside the repository.
default String	getReadmeMarkdown()	The markdown content for the workflow's README file.
default String	getReadmePath()	The path to the workflow README markdown file within the repository.
default String	getReadmeUri()	The S3 URI of the README file for the workflow.
default Number	getStorageCapacity()
default String	getStorageType()
default Map<String,String>	getTags()	A map of resource tags.
String	getVersionName()	The name of the workflow version.
default String	getWorkflowBucketOwnerId()
String	getWorkflowId()	The workflow's ID.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getVersionName

@Stability(Stable)
@NotNull
String getVersionName()

The name of the workflow version.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-omics-workflowversion.html#cfn-omics-workflowversion-versionname

getWorkflowId

@Stability(Stable)
@NotNull
String getWorkflowId()

The workflow's ID.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-omics-workflowversion.html#cfn-omics-workflowversion-workflowid

getAccelerators

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-omics-workflowversion.html#cfn-omics-workflowversion-accelerators

getContainerRegistryMap

@Stability(Stable)
@Nullable
default Object getContainerRegistryMap()

Use a container registry map to specify mappings between the ECR private repository and one or more upstream registries.

For more information, see Container images in the AWS HealthOmics User Guide .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-omics-workflowversion.html#cfn-omics-workflowversion-containerregistrymap

getContainerRegistryMapUri

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-omics-workflowversion.html#cfn-omics-workflowversion-containerregistrymapuri

getDefinitionRepository

@Stability(Stable)
@Nullable
default Object getDefinitionRepository()

Contains information about a source code repository that hosts the workflow definition files.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-omics-workflowversion.html#cfn-omics-workflowversion-definitionrepository

getDefinitionUri

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-omics-workflowversion.html#cfn-omics-workflowversion-definitionuri

getDescription

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

The description of the workflow version.

See Also:

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

getEngine

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-omics-workflowversion.html#cfn-omics-workflowversion-engine

getMain

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-omics-workflowversion.html#cfn-omics-workflowversion-main

getParameterTemplate

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-omics-workflowversion.html#cfn-omics-workflowversion-parametertemplate

getParameterTemplatePath

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

Path to the primary workflow parameter template JSON file inside the repository.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-omics-workflowversion.html#cfn-omics-workflowversion-parametertemplatepath

getReadmeMarkdown

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

The markdown content for the workflow's README file.

This provides documentation and usage information for users of the workflow.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-omics-workflowversion.html#cfn-omics-workflowversion-readmemarkdown

getReadmePath

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

The path to the workflow README markdown file within the repository.

This file provides documentation and usage information for the workflow. If not specified, the README.md file from the root directory of the repository will be used.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-omics-workflowversion.html#cfn-omics-workflowversion-readmepath

getReadmeUri

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

The S3 URI of the README file for the workflow.

This file provides documentation and usage information for the workflow. The S3 URI must begin with s3://USER-OWNED-BUCKET/. The requester must have access to the S3 bucket and object. The max README content length is 500 KiB.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-omics-workflowversion.html#cfn-omics-workflowversion-readmeuri

getStorageCapacity

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-omics-workflowversion.html#cfn-omics-workflowversion-storagecapacity

getStorageType

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-omics-workflowversion.html#cfn-omics-workflowversion-storagetype

getTags

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

A map of resource tags.

See Also:

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

getWorkflowBucketOwnerId

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-omics-workflowversion.html#cfn-omics-workflowversion-workflowbucketownerid

builder

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

Returns:

a CfnWorkflowVersionProps.Builder of CfnWorkflowVersionProps