AWS::Omics::WorkflowVersion - AWS CloudFormation
SyntaxPropertiesReturn values

This is the new AWS CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the AWS CloudFormation User Guide.

AWS::Omics::WorkflowVersion

Creates a new workflow version for the workflow that you specify with the workflowId parameter.

When you create a new version of a workflow, you need to specify the configuration for the new version. It doesn't inherit any configuration values from the workflow.

Provide a version name that is unique for this workflow. You cannot change the name after HealthOmics creates the version.

Note

Don't include any personally identifiable information (PII) in the version name. Version names appear in the workflow version ARN.

For more information, see Workflow versioning in AWS HealthOmics in the AWS HealthOmics User Guide.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::Omics::WorkflowVersion",
  "Properties" : {
      "Accelerators" : String,
      "ContainerRegistryMap" : ContainerRegistryMap,
      "ContainerRegistryMapUri" : String,
      "DefinitionRepository" : DefinitionRepository,
      "DefinitionUri" : String,
      "Description" : String,
      "Engine" : String,
      "Main" : String,
      "ParameterTemplate" : {Key: Value, ...},
      "ParameterTemplatePath" : String,
      "readmeMarkdown" : String,
      "readmePath" : String,
      "readmeUri" : String,
      "StorageCapacity" : Number,
      "StorageType" : String,
      "Tags" : {Key: Value, ...},
      "VersionName" : String,
      "WorkflowBucketOwnerId" : String,
      "WorkflowId" : String
    }
}

YAML

Type: AWS::Omics::WorkflowVersion
Properties:
  Accelerators: String
  ContainerRegistryMap: 
    ContainerRegistryMap
  ContainerRegistryMapUri: String
  DefinitionRepository: 
    DefinitionRepository
  DefinitionUri: String
  Description: String
  Engine: String
  Main: String
  ParameterTemplate: 
    Key: Value
  ParameterTemplatePath: String
  readmeMarkdown: String
  readmePath: String
  readmeUri: String
  StorageCapacity: Number
  StorageType: String
  Tags: 
    Key: Value
  VersionName: String
  WorkflowBucketOwnerId: String
  WorkflowId: String

Properties

Accelerators

Property description not available.

Required: No

Type: String

Allowed values: GPU

Minimum: 1

Maximum: 64

Update requires: Replacement

ContainerRegistryMap

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.

Required: No

Type: ContainerRegistryMap

Update requires: Replacement

ContainerRegistryMapUri

Property description not available.

Required: No

Type: String

Pattern: ^[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+$

Minimum: 1

Maximum: 750

Update requires: Replacement

DefinitionRepository

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

Required: No

Type: DefinitionRepository

Update requires: Replacement

DefinitionUri

Property description not available.

Required: No

Type: String

Pattern: ^[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+$

Minimum: 1

Maximum: 256

Update requires: Replacement

Description

The description of the workflow version.

Required: No

Type: String

Pattern: ^[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+$

Minimum: 1

Maximum: 256

Update requires: No interruption

Engine

Property description not available.

Required: No

Type: String

Allowed values: WDL | NEXTFLOW | CWL

Minimum: 1

Maximum: 64

Update requires: Replacement

Main

Property description not available.

Required: No

Type: String

Pattern: ^[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+$

Minimum: 1

Maximum: 128

Update requires: Replacement

ParameterTemplate

Property description not available.

Required: No

Type: Object of WorkflowParameter

Update requires: Replacement

ParameterTemplatePath

Property description not available.

Required: No

Type: String

Pattern: ^[\S]+$

Update requires: Replacement

readmeMarkdown

Property description not available.

Required: No

Type: String

Update requires: No interruption

readmePath

Property description not available.

Required: No

Type: String

Pattern: ^[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+$

Minimum: 1

Maximum: 128

Update requires: Replacement

readmeUri

Property description not available.

Required: No

Type: String

Pattern: ^s3://([a-z0-9][a-z0-9-.]{1,61}[a-z0-9])/((.{1,1024}))$

Update requires: Replacement

StorageCapacity

Property description not available.

Required: No

Type: Number

Minimum: 0

Maximum: 100000

Update requires: No interruption

StorageType

Property description not available.

Required: No

Type: String

Allowed values: STATIC | DYNAMIC

Minimum: 1

Maximum: 64

Update requires: No interruption

Tags

Property description not available.

Required: No

Type: Object of String

Pattern: .+

Minimum: 0

Maximum: 256

Update requires: No interruption

VersionName

The name of the workflow version.

Required: Yes

Type: String

Pattern: ^[A-Za-z0-9][A-Za-z0-9\-\._]*$

Minimum: 1

Maximum: 64

Update requires: Replacement

WorkflowBucketOwnerId

Property description not available.

Required: No

Type: String

Pattern: ^[0-9]{12}$

Minimum: 1

Maximum: 12

Update requires: Replacement

WorkflowId

The workflow's ID.

Required: Yes

Type: String

Pattern: ^[0-9]+$

Minimum: 1

Maximum: 18

Update requires: Replacement

Return values

Ref

Fn::GetAtt

Arn

ARN of the workflow version.

CreationTime

The creation time of the workflow version.

Status

The status of the workflow version.

Type

The type of the workflow version.

Uuid

Property description not available.