class CfnWorkflowPropsMixin

Language	Type name
.NET	Amazon.CDK.Mixins.Preview.AWS.Omics.Mixins.CfnWorkflowPropsMixin
Go	github.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awsomics/mixins#CfnWorkflowPropsMixin
Java	software.amazon.awscdk.mixins.preview.services.omics.mixins.CfnWorkflowPropsMixin
Python	aws_cdk.mixins_preview.aws_omics.mixins.CfnWorkflowPropsMixin
TypeScript	@aws-cdk/mixins-preview » aws_omics » mixins » CfnWorkflowPropsMixin

Implements IMixin

Extends Mixin

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 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 and the AWS HealthOmics Agentic generative AI tutorial 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 .

• 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 in the AWS HealthOmics User Guide .

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-omics-workflow.html

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { mixins } from '@aws-cdk/mixins-preview';
import { mixins as omics_mixins } from '@aws-cdk/mixins-preview/aws-omics';
const cfnWorkflowPropsMixin = new omics_mixins.CfnWorkflowPropsMixin({
  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',
}, /* all optional props */ {
  strategy: mixins.PropertyMergeStrategy.OVERRIDE,
});

Initializer

new CfnWorkflowPropsMixin(props: CfnWorkflowMixinProps, options?: CfnPropertyMixinOptions)

Parameters

• props CfnWorkflowMixinProps — L1 properties to apply.
• options CfnPropertyMixinOptions — Mixin options.

Create a mixin to apply properties to AWS::Omics::Workflow.

Properties

Name	Type	Description
props	CfnWorkflowMixinProps
strategy	PropertyMergeStrategy
static CFN_PROPERTY_KEYS	string[]

---

props

Type: CfnWorkflowMixinProps

---

strategy

Type: PropertyMergeStrategy

---

static CFN_PROPERTY_KEYS

Type: string[]

Methods

Name	Description
applyTo(construct)	Apply the mixin properties to the construct.
supports(construct)	Check if this mixin supports the given construct.

---

applyTo(construct)

public applyTo(construct: IConstruct): IConstruct

Parameters

• construct IConstruct

Returns

• IConstruct

Apply the mixin properties to the construct.

---

supports(construct)

public supports(construct: IConstruct): boolean

Parameters

• construct IConstruct

Returns

• boolean

Check if this mixin supports the given construct.