Package software.amazon.awscdk.services.omics

Interface CfnWorkflowProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnWorkflowProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)",
           date="2025-11-13T16:10:09.919Z")
@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.omics.*;
 CfnWorkflowProps cfnWorkflowProps = CfnWorkflowProps.builder()
         .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")
         .name("name")
         .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-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	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()	The URI of a definition for the workflow.
default String	getDescription()	The parameter's description.
default String	getEngine()	An engine for the workflow.
default String	getMain()	The path of the main definition file for the workflow.
default String	getName()	The workflow's name.
default Object	getParameterTemplate()	The workflow's parameter template.
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()	The default static storage capacity (in gibibytes) for runs that use this workflow or workflow version.
default String	getStorageType()
default Map<String,String>	getTags()	Tags for the workflow.
default String	getWorkflowBucketOwnerId()	Optional workflow bucket owner ID to verify the workflow bucket.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAccelerators

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-omics-workflow.html#cfn-omics-workflow-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 .

Returns union: either IResolvable or CfnWorkflow.ContainerRegistryMapProperty

See Also:

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

getContainerRegistryMapUri

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

See Also:

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

getDefinitionRepository

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

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

Returns union: either IResolvable or CfnWorkflow.DefinitionRepositoryProperty

See Also:

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

getDefinitionUri

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

The URI of a definition for the workflow.

See Also:

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

getDescription

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

The parameter's description.

See Also:

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

getEngine

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

An engine for the workflow.

See Also:

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

getMain

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

The path of the main definition file for the workflow.

See Also:

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

getName

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

The workflow's name.

See Also:

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

getParameterTemplate

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

The workflow's parameter template.

Returns union: either IResolvable or Mapinvalid input: '<'String, either IResolvable or CfnWorkflow.WorkflowParameterProperty>

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-omics-workflow.html#cfn-omics-workflow-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-workflow.html#cfn-omics-workflow-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-workflow.html#cfn-omics-workflow-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-workflow.html#cfn-omics-workflow-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-workflow.html#cfn-omics-workflow-readmeuri

getStorageCapacity

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

The default static storage capacity (in gibibytes) for runs that use this workflow or workflow version.

The storageCapacity can be overwritten at run time. The storage capacity is not required for runs with a DYNAMIC storage type.

See Also:

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

getStorageType

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

See Also:

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

getTags

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

Tags for the workflow.

See Also:

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

getWorkflowBucketOwnerId

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

Optional workflow bucket owner ID to verify the workflow bucket.

See Also:

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

builder

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

Returns:

a CfnWorkflowProps.Builder of CfnWorkflowProps