We recommend new projects start with resources from the AWS provider.
aws-native.omics.WorkflowVersion
Explore with Pulumi AI
We recommend new projects start with resources from the AWS provider.
Definition of AWS::Omics::WorkflowVersion Resource Type.
Create WorkflowVersion Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new WorkflowVersion(name: string, args: WorkflowVersionArgs, opts?: CustomResourceOptions);
@overload
def WorkflowVersion(resource_name: str,
args: WorkflowVersionArgs,
opts: Optional[ResourceOptions] = None)
@overload
def WorkflowVersion(resource_name: str,
opts: Optional[ResourceOptions] = None,
workflow_id: Optional[str] = None,
readme_markdown: Optional[str] = None,
readme_uri: Optional[str] = None,
description: Optional[str] = None,
engine: Optional[WorkflowVersionWorkflowEngine] = None,
main: Optional[str] = None,
parameter_template: Optional[Mapping[str, WorkflowVersionWorkflowParameterArgs]] = None,
definition_uri: Optional[str] = None,
parameter_template_path: Optional[str] = None,
readme_path: Optional[str] = None,
accelerators: Optional[WorkflowVersionAccelerators] = None,
storage_capacity: Optional[float] = None,
storage_type: Optional[WorkflowVersionStorageType] = None,
tags: Optional[Mapping[str, str]] = None,
version_name: Optional[str] = None,
workflow_bucket_owner_id: Optional[str] = None,
definition_repository: Optional[WorkflowVersionDefinitionRepositoryArgs] = None)
func NewWorkflowVersion(ctx *Context, name string, args WorkflowVersionArgs, opts ...ResourceOption) (*WorkflowVersion, error)
public WorkflowVersion(string name, WorkflowVersionArgs args, CustomResourceOptions? opts = null)
public WorkflowVersion(String name, WorkflowVersionArgs args)
public WorkflowVersion(String name, WorkflowVersionArgs args, CustomResourceOptions options)
type: aws-native:omics:WorkflowVersion
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args WorkflowVersionArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args WorkflowVersionArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args WorkflowVersionArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args WorkflowVersionArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args WorkflowVersionArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
WorkflowVersion Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The WorkflowVersion resource accepts the following input properties:
- Workflow
Id string - The workflow's ID.
- Accelerators
Pulumi.
Aws Native. Omics. Workflow Version Accelerators - Definition
Repository Pulumi.Aws Native. Omics. Inputs. Workflow Version Definition Repository - Contains information about a source code repository that hosts the workflow definition files.
- Definition
Uri string - Description string
- The description of the workflow version.
- Engine
Pulumi.
Aws Native. Omics. Workflow Version Workflow Engine - Main string
- Parameter
Template Dictionary<string, Pulumi.Aws Native. Omics. Inputs. Workflow Version Workflow Parameter Args> - Parameter
Template stringPath - Path to the primary workflow parameter template JSON file inside the repository
- Readme
Markdown string - The markdown content for the workflow's README file. This provides documentation and usage information for users of the workflow.
- Readme
Path 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.
- Readme
Uri 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.
- Storage
Capacity double - Storage
Type Pulumi.Aws Native. Omics. Workflow Version Storage Type - Dictionary<string, string>
- Version
Name string - The name of the workflow version.
- Workflow
Bucket stringOwner Id
- Workflow
Id string - The workflow's ID.
- Accelerators
Workflow
Version Accelerators - Definition
Repository WorkflowVersion Definition Repository Args - Contains information about a source code repository that hosts the workflow definition files.
- Definition
Uri string - Description string
- The description of the workflow version.
- Engine
Workflow
Version Workflow Engine - Main string
- Parameter
Template map[string]WorkflowVersion Workflow Parameter Args - Parameter
Template stringPath - Path to the primary workflow parameter template JSON file inside the repository
- Readme
Markdown string - The markdown content for the workflow's README file. This provides documentation and usage information for users of the workflow.
- Readme
Path 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.
- Readme
Uri 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.
- Storage
Capacity float64 - Storage
Type WorkflowVersion Storage Type - map[string]string
- Version
Name string - The name of the workflow version.
- Workflow
Bucket stringOwner Id
- workflow
Id String - The workflow's ID.
- accelerators
Workflow
Version Accelerators - definition
Repository WorkflowVersion Definition Repository - Contains information about a source code repository that hosts the workflow definition files.
- definition
Uri String - description String
- The description of the workflow version.
- engine
Workflow
Version Workflow Engine - main String
- parameter
Template Map<String,WorkflowVersion Workflow Parameter Args> - parameter
Template StringPath - Path to the primary workflow parameter template JSON file inside the repository
- readme
Markdown String - The markdown content for the workflow's README file. This provides documentation and usage information for users of the workflow.
- readme
Path 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.
- readme
Uri 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.
- storage
Capacity Double - storage
Type WorkflowVersion Storage Type - Map<String,String>
- version
Name String - The name of the workflow version.
- workflow
Bucket StringOwner Id
- workflow
Id string - The workflow's ID.
- accelerators
Workflow
Version Accelerators - definition
Repository WorkflowVersion Definition Repository - Contains information about a source code repository that hosts the workflow definition files.
- definition
Uri string - description string
- The description of the workflow version.
- engine
Workflow
Version Workflow Engine - main string
- parameter
Template {[key: string]: WorkflowVersion Workflow Parameter Args} - parameter
Template stringPath - Path to the primary workflow parameter template JSON file inside the repository
- readme
Markdown string - The markdown content for the workflow's README file. This provides documentation and usage information for users of the workflow.
- readme
Path 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.
- readme
Uri 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.
- storage
Capacity number - storage
Type WorkflowVersion Storage Type - {[key: string]: string}
- version
Name string - The name of the workflow version.
- workflow
Bucket stringOwner Id
- workflow_
id str - The workflow's ID.
- accelerators
Workflow
Version Accelerators - definition_
repository WorkflowVersion Definition Repository Args - Contains information about a source code repository that hosts the workflow definition files.
- definition_
uri str - description str
- The description of the workflow version.
- engine
Workflow
Version Workflow Engine - main str
- parameter_
template Mapping[str, WorkflowVersion Workflow Parameter Args] - parameter_
template_ strpath - Path to the primary workflow parameter template JSON file inside the repository
- readme_
markdown str - The markdown content for the workflow's README file. This provides documentation and usage information for users of the workflow.
- readme_
path str - 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.
- readme_
uri str - 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.
- storage_
capacity float - storage_
type WorkflowVersion Storage Type - Mapping[str, str]
- version_
name str - The name of the workflow version.
- workflow_
bucket_ strowner_ id
- workflow
Id String - The workflow's ID.
- accelerators "GPU"
- definition
Repository Property Map - Contains information about a source code repository that hosts the workflow definition files.
- definition
Uri String - description String
- The description of the workflow version.
- engine "WDL" | "NEXTFLOW" | "CWL"
- main String
- parameter
Template Map<Property Map> - parameter
Template StringPath - Path to the primary workflow parameter template JSON file inside the repository
- readme
Markdown String - The markdown content for the workflow's README file. This provides documentation and usage information for users of the workflow.
- readme
Path 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.
- readme
Uri 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.
- storage
Capacity Number - storage
Type "STATIC" | "DYNAMIC" - Map<String>
- version
Name String - The name of the workflow version.
- workflow
Bucket StringOwner Id
Outputs
All input properties are implicitly available as output properties. Additionally, the WorkflowVersion resource produces the following output properties:
- Arn string
- ARN of the workflow version.
- Creation
Time string - The creation time of the workflow version.
- Id string
- The provider-assigned unique ID for this managed resource.
- Status
Pulumi.
Aws Native. Omics. Workflow Version Workflow Status - The status of the workflow version.
- Type
Pulumi.
Aws Native. Omics. Workflow Version Workflow Type - The type of the workflow version.
- Uuid string
- Arn string
- ARN of the workflow version.
- Creation
Time string - The creation time of the workflow version.
- Id string
- The provider-assigned unique ID for this managed resource.
- Status
Workflow
Version Workflow Status - The status of the workflow version.
- Type
Workflow
Version Workflow Type - The type of the workflow version.
- Uuid string
- arn String
- ARN of the workflow version.
- creation
Time String - The creation time of the workflow version.
- id String
- The provider-assigned unique ID for this managed resource.
- status
Workflow
Version Workflow Status - The status of the workflow version.
- type
Workflow
Version Workflow Type - The type of the workflow version.
- uuid String
- arn string
- ARN of the workflow version.
- creation
Time string - The creation time of the workflow version.
- id string
- The provider-assigned unique ID for this managed resource.
- status
Workflow
Version Workflow Status - The status of the workflow version.
- type
Workflow
Version Workflow Type - The type of the workflow version.
- uuid string
- arn str
- ARN of the workflow version.
- creation_
time str - The creation time of the workflow version.
- id str
- The provider-assigned unique ID for this managed resource.
- status
Workflow
Version Workflow Status - The status of the workflow version.
- type
Workflow
Version Workflow Type - The type of the workflow version.
- uuid str
- arn String
- ARN of the workflow version.
- creation
Time String - The creation time of the workflow version.
- id String
- The provider-assigned unique ID for this managed resource.
- status "CREATING" | "ACTIVE" | "UPDATING" | "DELETED" | "FAILED" | "INACTIVE"
- The status of the workflow version.
- type "PRIVATE" | "READY2RUN"
- The type of the workflow version.
- uuid String
Supporting Types
WorkflowVersionAccelerators, WorkflowVersionAcceleratorsArgs
- Gpu
- GPU
- Workflow
Version Accelerators Gpu - GPU
- Gpu
- GPU
- Gpu
- GPU
- GPU
- GPU
- "GPU"
- GPU
WorkflowVersionDefinitionRepository, WorkflowVersionDefinitionRepositoryArgs
- Connection
Arn string - The Amazon Resource Name (ARN) of the connection to the source code repository.
- Exclude
File List<string>Patterns - A list of file patterns to exclude when retrieving the workflow definition from the repository.
- Full
Repository stringId - The full repository identifier, including the repository owner and name. For example, 'repository-owner/repository-name'.
- Source
Reference Pulumi.Aws Native. Omics. Inputs. Workflow Version Source Reference - The source reference for the repository, such as a branch name, tag, or commit ID.
- Connection
Arn string - The Amazon Resource Name (ARN) of the connection to the source code repository.
- Exclude
File []stringPatterns - A list of file patterns to exclude when retrieving the workflow definition from the repository.
- Full
Repository stringId - The full repository identifier, including the repository owner and name. For example, 'repository-owner/repository-name'.
- Source
Reference WorkflowVersion Source Reference - The source reference for the repository, such as a branch name, tag, or commit ID.
- connection
Arn String - The Amazon Resource Name (ARN) of the connection to the source code repository.
- exclude
File List<String>Patterns - A list of file patterns to exclude when retrieving the workflow definition from the repository.
- full
Repository StringId - The full repository identifier, including the repository owner and name. For example, 'repository-owner/repository-name'.
- source
Reference WorkflowVersion Source Reference - The source reference for the repository, such as a branch name, tag, or commit ID.
- connection
Arn string - The Amazon Resource Name (ARN) of the connection to the source code repository.
- exclude
File string[]Patterns - A list of file patterns to exclude when retrieving the workflow definition from the repository.
- full
Repository stringId - The full repository identifier, including the repository owner and name. For example, 'repository-owner/repository-name'.
- source
Reference WorkflowVersion Source Reference - The source reference for the repository, such as a branch name, tag, or commit ID.
- connection_
arn str - The Amazon Resource Name (ARN) of the connection to the source code repository.
- exclude_
file_ Sequence[str]patterns - A list of file patterns to exclude when retrieving the workflow definition from the repository.
- full_
repository_ strid - The full repository identifier, including the repository owner and name. For example, 'repository-owner/repository-name'.
- source_
reference WorkflowVersion Source Reference - The source reference for the repository, such as a branch name, tag, or commit ID.
- connection
Arn String - The Amazon Resource Name (ARN) of the connection to the source code repository.
- exclude
File List<String>Patterns - A list of file patterns to exclude when retrieving the workflow definition from the repository.
- full
Repository StringId - The full repository identifier, including the repository owner and name. For example, 'repository-owner/repository-name'.
- source
Reference Property Map - The source reference for the repository, such as a branch name, tag, or commit ID.
WorkflowVersionSourceReference, WorkflowVersionSourceReferenceArgs
- Type
Pulumi.
Aws Native. Omics. Workflow Version Source Referencetype - The type of source reference, such as branch, tag, or commit.
- Value string
- The value of the source reference, such as the branch name, tag name, or commit ID.
- Type
Workflow
Version Source Referencetype - The type of source reference, such as branch, tag, or commit.
- Value string
- The value of the source reference, such as the branch name, tag name, or commit ID.
- type
Workflow
Version Source Referencetype - The type of source reference, such as branch, tag, or commit.
- value String
- The value of the source reference, such as the branch name, tag name, or commit ID.
- type
Workflow
Version Source Referencetype - The type of source reference, such as branch, tag, or commit.
- value string
- The value of the source reference, such as the branch name, tag name, or commit ID.
- type
Workflow
Version Source Referencetype - The type of source reference, such as branch, tag, or commit.
- value str
- The value of the source reference, such as the branch name, tag name, or commit ID.
- type "BRANCH" | "TAG" | "COMMIT"
- The type of source reference, such as branch, tag, or commit.
- value String
- The value of the source reference, such as the branch name, tag name, or commit ID.
WorkflowVersionSourceReferencetype, WorkflowVersionSourceReferencetypeArgs
- Branch
- BRANCH
- Tag
- TAG
- Commit
- COMMIT
- Workflow
Version Source Referencetype Branch - BRANCH
- Workflow
Version Source Referencetype Tag - TAG
- Workflow
Version Source Referencetype Commit - COMMIT
- Branch
- BRANCH
- Tag
- TAG
- Commit
- COMMIT
- Branch
- BRANCH
- Tag
- TAG
- Commit
- COMMIT
- BRANCH
- BRANCH
- TAG
- TAG
- COMMIT
- COMMIT
- "BRANCH"
- BRANCH
- "TAG"
- TAG
- "COMMIT"
- COMMIT
WorkflowVersionStorageType, WorkflowVersionStorageTypeArgs
- Static
- STATIC
- Dynamic
- DYNAMIC
- Workflow
Version Storage Type Static - STATIC
- Workflow
Version Storage Type Dynamic - DYNAMIC
- Static
- STATIC
- Dynamic
- DYNAMIC
- Static
- STATIC
- Dynamic
- DYNAMIC
- STATIC
- STATIC
- DYNAMIC
- DYNAMIC
- "STATIC"
- STATIC
- "DYNAMIC"
- DYNAMIC
WorkflowVersionWorkflowEngine, WorkflowVersionWorkflowEngineArgs
- Wdl
- WDL
- Nextflow
- NEXTFLOW
- Cwl
- CWL
- Workflow
Version Workflow Engine Wdl - WDL
- Workflow
Version Workflow Engine Nextflow - NEXTFLOW
- Workflow
Version Workflow Engine Cwl - CWL
- Wdl
- WDL
- Nextflow
- NEXTFLOW
- Cwl
- CWL
- Wdl
- WDL
- Nextflow
- NEXTFLOW
- Cwl
- CWL
- WDL
- WDL
- NEXTFLOW
- NEXTFLOW
- CWL
- CWL
- "WDL"
- WDL
- "NEXTFLOW"
- NEXTFLOW
- "CWL"
- CWL
WorkflowVersionWorkflowParameter, WorkflowVersionWorkflowParameterArgs
- Description string
- The parameter's description.
- Optional bool
- Whether the parameter is optional.
- Description string
- The parameter's description.
- Optional bool
- Whether the parameter is optional.
- description String
- The parameter's description.
- optional Boolean
- Whether the parameter is optional.
- description string
- The parameter's description.
- optional boolean
- Whether the parameter is optional.
- description str
- The parameter's description.
- optional bool
- Whether the parameter is optional.
- description String
- The parameter's description.
- optional Boolean
- Whether the parameter is optional.
WorkflowVersionWorkflowStatus, WorkflowVersionWorkflowStatusArgs
- Creating
- CREATING
- Active
- ACTIVE
- Updating
- UPDATING
- Deleted
- DELETED
- Failed
- FAILED
- Inactive
- INACTIVE
- Workflow
Version Workflow Status Creating - CREATING
- Workflow
Version Workflow Status Active - ACTIVE
- Workflow
Version Workflow Status Updating - UPDATING
- Workflow
Version Workflow Status Deleted - DELETED
- Workflow
Version Workflow Status Failed - FAILED
- Workflow
Version Workflow Status Inactive - INACTIVE
- Creating
- CREATING
- Active
- ACTIVE
- Updating
- UPDATING
- Deleted
- DELETED
- Failed
- FAILED
- Inactive
- INACTIVE
- Creating
- CREATING
- Active
- ACTIVE
- Updating
- UPDATING
- Deleted
- DELETED
- Failed
- FAILED
- Inactive
- INACTIVE
- CREATING
- CREATING
- ACTIVE
- ACTIVE
- UPDATING
- UPDATING
- DELETED
- DELETED
- FAILED
- FAILED
- INACTIVE
- INACTIVE
- "CREATING"
- CREATING
- "ACTIVE"
- ACTIVE
- "UPDATING"
- UPDATING
- "DELETED"
- DELETED
- "FAILED"
- FAILED
- "INACTIVE"
- INACTIVE
WorkflowVersionWorkflowType, WorkflowVersionWorkflowTypeArgs
- Private
- PRIVATE
- Ready2run
- READY2RUN
- Workflow
Version Workflow Type Private - PRIVATE
- Workflow
Version Workflow Type Ready2run - READY2RUN
- Private
- PRIVATE
- Ready2run
- READY2RUN
- Private
- PRIVATE
- Ready2run
- READY2RUN
- PRIVATE
- PRIVATE
- READY2RUN
- READY2RUN
- "PRIVATE"
- PRIVATE
- "READY2RUN"
- READY2RUN
Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0
We recommend new projects start with resources from the AWS provider.