AWS Fundamentals Logo
AWS Fundamentals
L1 ConstructAWS::Omics::Workflow

CfnWorkflow

Creates a private workflow. Before you create a private workflow, you must create and configure these required resources:. - *Workflow definition file:* A workflow definition file written in WDL, Nextflow, or CWL. The workflow definition specifies the inputs and outputs for runs that use the workflow. It also includes specifications for the runs and run tasks for your workflow, including compute and memory requirements. The workflow definition file must be in `.zip` format. For more information, see [Workflow definition files](https://docs.aws.amazon.com/omics/latest/dev/workflow-definition-files.html) in AWS HealthOmics. - You can use Amazon Q CLI to build and validate your workflow definition files in WDL, Nextflow, and CWL. For more information, see [Example prompts for Amazon Q CLI](https://docs.aws.amazon.com/omics/latest/dev/getting-started.html#omics-q-prompts) and the [AWS HealthOmics Agentic generative AI tutorial](https://docs.aws.amazon.com/https://github.com/aws-samples/aws-healthomics-tutorials/tree/main/generative-ai) on GitHub. - *(Optional) Parameter template file:* A parameter template file written in JSON. Create the file to define the run parameters, or AWS HealthOmics generates the parameter template for you. For more information, see [Parameter template files for HealthOmics workflows](https://docs.aws.amazon.com/omics/latest/dev/parameter-templates.html) . - *ECR container images:* Create container images for the workflow in a private ECR repository, or synchronize images from a supported upstream registry with your Amazon ECR private repository. - *(Optional) Sentieon licenses:* Request a Sentieon license to use the Sentieon software in private workflows. For more information, see [Creating or updating a private workflow in AWS HealthOmics](https://docs.aws.amazon.com/omics/latest/dev/creating-private-workflows.html) in the *AWS HealthOmics User Guide* .

Import

import { CfnWorkflow } from 'aws-cdk-lib/aws-omics';

Or use the module namespace:

import * as omics from 'aws-cdk-lib/aws-omics';
// omics.CfnWorkflow

Properties

Configuration passed to the constructor as CfnWorkflowProps.

acceleratorsOptional
string
containerRegistryMapOptional
IResolvable | ContainerRegistryMapProperty

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](https://docs.aws.amazon.com/omics/latest/dev/workflows-ecr.html) in the *AWS HealthOmics User Guide* .

containerRegistryMapUriOptional
string
definitionRepositoryOptional
IResolvable | DefinitionRepositoryProperty

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

definitionUriOptional
string

The URI of a definition for the workflow.

descriptionOptional
string

The parameter's description.

engineOptional
string

An engine for the workflow.

mainOptional
string

The path of the main definition file for the workflow.

nameOptional
string

The workflow's name.

parameterTemplateOptional
IResolvable | { [key: string]: IResolvable | WorkflowParameterProperty }

The workflow's parameter template.

parameterTemplatePathOptional
string

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

readmeMarkdownOptional
string

The markdown content for the workflow's README file. This provides documentation and usage information for users of the workflow.

readmePathOptional
string

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.

readmeUriOptional
string

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.

storageCapacityOptional
number

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.

storageTypeOptional
string
tagsOptional
{ [key: string]: string }

Tags for the workflow.

workflowBucketOwnerIdOptional
string

Optional workflow bucket owner ID to verify the workflow bucket.

CloudFormation Resource

This L1 construct maps directly to the following CloudFormation resource type.

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter

Quick Facts

LevelL1 (CloudFormation)
Moduleaws-omics
CFN TypeAWS::Omics::Workflow
Properties18

External Links