# CfnWorkflowProps

Properties for defining a `CfnWorkflow`.

Extends: CfnWorkflowProps
Used as props by: CfnWorkflow

- Source: Generated code
- Type last changed: v2.217.0 · 25 Sep 2025

## Example

```ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_omics as omics } from 'aws-cdk-lib';
const cfnWorkflowProps: omics.CfnWorkflowProps = {
  accelerators: 'accelerators',
  containerRegistryMap: {
    imageMappings: [{
      destinationImage: 'destinationImage',
      sourceImage: 'sourceImage',
    }],
    registryMappings: [{
      ecrAccountId: 'ecrAccountId',
      ecrRepositoryPrefix: 'ecrRepositoryPrefix',
      upstreamRegistryUrl: 'upstreamRegistryUrl',
      upstreamRepositoryPrefix: 'upstreamRepositoryPrefix',
    }],
  },
  containerRegistryMapUri: 'containerRegistryMapUri',
  definitionRepository: {
    connectionArn: 'connectionArn',
    excludeFilePatterns: ['excludeFilePatterns'],
    fullRepositoryId: 'fullRepositoryId',
    sourceReference: {
      type: 'type',
      value: 'value',
    },
  },
  definitionUri: 'definitionUri',
  description: 'description',
  engine: 'engine',
  main: 'main',
  name: 'name',
  parameterTemplate: {
    parameterTemplateKey: {
      description: 'description',
      optional: false,
    },
  },
  parameterTemplatePath: 'parameterTemplatePath',
  readmeMarkdown: 'readmeMarkdown',
  readmePath: 'readmePath',
  readmeUri: 'readmeUri',
  storageCapacity: 123,
  storageType: 'storageType',
  tags: {
    tagsKey: 'tags',
  },
  workflowBucketOwnerId: 'workflowBucketOwnerId',
};
```

## Properties

- `accelerators`: string

- `containerRegistryMap`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnWorkflow.ContainerRegistryMapProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_omics.CfnWorkflow.ContainerRegistryMapProperty.html) — 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* .

- `containerRegistryMapUri`: string

- `definitionRepository`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnWorkflow.DefinitionRepositoryProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_omics.CfnWorkflow.DefinitionRepositoryProperty.html) — Contains information about a source code repository that hosts the workflow definition files.

- `definitionUri`: string — The URI of a definition for the workflow.

- `description`: string — The parameter's description.

- `engine`: string — An engine for the workflow.

- `main`: string — The path of the main definition file for the workflow.

- `name`: string — The workflow's name.

- `parameterTemplate`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | { [key: string]: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnWorkflow.WorkflowParameterProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_omics.CfnWorkflow.WorkflowParameterProperty.html) } — The workflow's parameter template.

- `parameterTemplatePath`: string — Path to the primary workflow parameter template JSON file inside the repository.

- `readmeMarkdown`: string — The markdown content for the workflow's README file.

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

- `readmePath`: 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.

- `readmeUri`: 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.

- `storageCapacity`: 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.

- `storageType`: string

- `tags`: { [key: string]: string } — Tags for the workflow.

- `workflowBucketOwnerId`: string — Optional workflow bucket owner ID to verify the workflow bucket.