interface CfnWorkflowVersionProps
| Language | Type name |
|---|---|
 .NET | Amazon.CDK.AWS.Omics.CfnWorkflowVersionProps |
 Go | github.com/aws/aws-cdk-go/awscdk/v2/awsomics#CfnWorkflowVersionProps |
 Java | software.amazon.awscdk.services.omics.CfnWorkflowVersionProps |
 Python | aws_cdk.aws_omics.CfnWorkflowVersionProps |
 TypeScript | aws-cdk-lib » aws_omics » CfnWorkflowVersionProps |
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 { aws_omics as omics } from 'aws-cdk-lib';
const cfnWorkflowVersionProps: omics.CfnWorkflowVersionProps = {
versionName: 'versionName',
workflowId: 'workflowId',
// the properties below are optional
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',
parameterTemplate: {
parameterTemplateKey: {
description: 'description',
optional: false,
},
},
parameterTemplatePath: 'parameterTemplatePath',
readmeMarkdown: 'readmeMarkdown',
readmePath: 'readmePath',
readmeUri: 'readmeUri',
storageCapacity: 123,
storageType: 'storageType',
tags: {
tagsKey: 'tags',
},
workflowBucketOwnerId: 'workflowBucketOwnerId',
};
Properties
| Name | Type | Description |
|---|---|---|
| version | string | The name of the workflow version. |
| workflow | string | The workflow's ID. |
| accelerators? | string | |
| container | IResolvable | Container | Use a container registry map to specify mappings between the ECR private repository and one or more upstream registries. |
| container | string | |
| definition | IResolvable | Definition | Contains information about a source code repository that hosts the workflow definition files. |
| definition | string | |
| description? | string | The description of the workflow version. |
| engine? | string | |
| main? | string | |
| parameter | IResolvable | { [string]: IResolvable | Workflow } | |
| parameter | string | Path to the primary workflow parameter template JSON file inside the repository. |
| readme | string | The markdown content for the workflow's README file. |
| readme | string | The path to the workflow README markdown file within the repository. |
| readme | string | The S3 URI of the README file for the workflow. |
| storage | number | |
| storage | string | |
| tags? | { [string]: string } | A map of resource tags. |
| workflow | string |
versionName
Type:
string
The name of the workflow version.
workflowId
Type:
string
The workflow's ID.
accelerators?
Type:
string
(optional)
containerRegistryMap?
Type:
IResolvable | Container
(optional)
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 .
containerRegistryMapUri?
Type:
string
(optional)
definitionRepository?
Type:
IResolvable | Definition
(optional)
Contains information about a source code repository that hosts the workflow definition files.
definitionUri?
Type:
string
(optional)
description?
Type:
string
(optional)
The description of the workflow version.
engine?
Type:
string
(optional)
main?
Type:
string
(optional)
parameterTemplate?
Type:
IResolvable | { [string]: IResolvable | Workflow }
(optional)
parameterTemplatePath?
Type:
string
(optional)
Path to the primary workflow parameter template JSON file inside the repository.
readmeMarkdown?
Type:
string
(optional)
The markdown content for the workflow's README file.
This provides documentation and usage information for users of the workflow.
readmePath?
Type:
string
(optional)
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?
Type:
string
(optional)
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?
Type:
number
(optional)
storageType?
Type:
string
(optional)
tags?
Type:
{ [string]: string }
(optional)
A map of resource tags.
workflowBucketOwnerId?
Type:
string
(optional)