Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi IDP Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. omics
  5. Workflow

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.34.0 published on Friday, Sep 12, 2025 by Pulumi
pulumi/pulumi-aws-native

aws-native.omics.Workflow

Explore with Pulumi AI

aws-native logo

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.34.0 published on Friday, Sep 12, 2025 by Pulumi
pulumi/pulumi-aws-native

    Definition of AWS::Omics::Workflow Resource Type

    Create Workflow Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Workflow(name: string, args?: WorkflowArgs, opts?: CustomResourceOptions);
    @overload
def Workflow(resource_name: str,
             args: Optional[WorkflowArgs] = None,
             opts: Optional[ResourceOptions] = None)

@overload
def Workflow(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             accelerators: Optional[WorkflowAccelerators] = None,
             definition_repository: Optional[WorkflowDefinitionRepositoryArgs] = None,
             definition_uri: Optional[str] = None,
             description: Optional[str] = None,
             engine: Optional[WorkflowEngine] = None,
             main: Optional[str] = None,
             name: Optional[str] = None,
             parameter_template: Optional[Mapping[str, WorkflowParameterArgs]] = None,
             parameter_template_path: Optional[str] = None,
             readme_markdown: Optional[str] = None,
             readme_path: Optional[str] = None,
             readme_uri: Optional[str] = None,
             storage_capacity: Optional[float] = None,
             storage_type: Optional[WorkflowStorageType] = None,
             tags: Optional[Mapping[str, str]] = None,
             workflow_bucket_owner_id: Optional[str] = None)
    func NewWorkflow(ctx *Context, name string, args *WorkflowArgs, opts ...ResourceOption) (*Workflow, error)
    public Workflow(string name, WorkflowArgs? args = null, CustomResourceOptions? opts = null)
    public Workflow(String name, WorkflowArgs args)
public Workflow(String name, WorkflowArgs args, CustomResourceOptions options)

    type: aws-native:omics:Workflow
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 WorkflowArgs
    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 WorkflowArgs
    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 WorkflowArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args WorkflowArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args WorkflowArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Workflow 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 Workflow resource accepts the following input properties:

    Accelerators Pulumi.AwsNative.Omics.WorkflowAccelerators
    DefinitionRepository Pulumi.AwsNative.Omics.Inputs.WorkflowDefinitionRepository
    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 Pulumi.AwsNative.Omics.WorkflowEngine
    An engine for the workflow.
    Main string
    The path of the main definition file for the workflow.
    Name string
    The workflow's name.
    ParameterTemplate Dictionary<string, Pulumi.AwsNative.Omics.Inputs.WorkflowParameterArgs>
    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 double
    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 Pulumi.AwsNative.Omics.WorkflowStorageType
    Tags Dictionary<string, string>
    Tags for the workflow.
    WorkflowBucketOwnerId string
    Optional workflow bucket owner ID to verify the workflow bucket
    Accelerators WorkflowAccelerators
    DefinitionRepository WorkflowDefinitionRepositoryArgs
    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 WorkflowEngine
    An engine for the workflow.
    Main string
    The path of the main definition file for the workflow.
    Name string
    The workflow's name.
    ParameterTemplate map[string]WorkflowParameterArgs
    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 float64
    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 WorkflowStorageType
    Tags map[string]string
    Tags for the workflow.
    WorkflowBucketOwnerId string
    Optional workflow bucket owner ID to verify the workflow bucket
    accelerators WorkflowAccelerators
    definitionRepository WorkflowDefinitionRepository
    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 WorkflowEngine
    An engine for the workflow.
    main String
    The path of the main definition file for the workflow.
    name String
    The workflow's name.
    parameterTemplate Map<String,WorkflowParameterArgs>
    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 Double
    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 WorkflowStorageType
    tags Map<String,String>
    Tags for the workflow.
    workflowBucketOwnerId String
    Optional workflow bucket owner ID to verify the workflow bucket
    accelerators WorkflowAccelerators
    definitionRepository WorkflowDefinitionRepository
    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 WorkflowEngine
    An engine for the workflow.
    main string
    The path of the main definition file for the workflow.
    name string
    The workflow's name.
    parameterTemplate {[key: string]: WorkflowParameterArgs}
    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 WorkflowStorageType
    tags {[key: string]: string}
    Tags for the workflow.
    workflowBucketOwnerId string
    Optional workflow bucket owner ID to verify the workflow bucket
    accelerators WorkflowAccelerators
    definition_repository WorkflowDefinitionRepositoryArgs
    Contains information about a source code repository that hosts the workflow definition files.
    definition_uri str
    The URI of a definition for the workflow.
    description str
    The parameter's description.
    engine WorkflowEngine
    An engine for the workflow.
    main str
    The path of the main definition file for the workflow.
    name str
    The workflow's name.
    parameter_template Mapping[str, WorkflowParameterArgs]
    The workflow's parameter template.
    parameter_template_path str
    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
    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.
    storage_type WorkflowStorageType
    tags Mapping[str, str]
    Tags for the workflow.
    workflow_bucket_owner_id str
    Optional workflow bucket owner ID to verify the workflow bucket
    accelerators "GPU"
    definitionRepository Property Map
    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 "WDL" | "NEXTFLOW" | "CWL"
    An engine for the workflow.
    main String
    The path of the main definition file for the workflow.
    name String
    The workflow's name.
    parameterTemplate Map<Property Map>
    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 "STATIC" | "DYNAMIC"
    tags Map<String>
    Tags for the workflow.
    workflowBucketOwnerId String
    Optional workflow bucket owner ID to verify the workflow bucket

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Workflow resource produces the following output properties:

    Arn string
    The ARN for the workflow.
    AwsId string
    The workflow's ID.
    CreationTime string
    When the workflow was created.
    Id string
    The provider-assigned unique ID for this managed resource.
    Status Pulumi.AwsNative.Omics.WorkflowStatus
    The workflow's status.
    Type Pulumi.AwsNative.Omics.WorkflowType
    The workflow's type.
    Uuid string
    Arn string
    The ARN for the workflow.
    AwsId string
    The workflow's ID.
    CreationTime string
    When the workflow was created.
    Id string
    The provider-assigned unique ID for this managed resource.
    Status WorkflowStatus
    The workflow's status.
    Type WorkflowType
    The workflow's type.
    Uuid string
    arn String
    The ARN for the workflow.
    awsId String
    The workflow's ID.
    creationTime String
    When the workflow was created.
    id String
    The provider-assigned unique ID for this managed resource.
    status WorkflowStatus
    The workflow's status.
    type WorkflowType
    The workflow's type.
    uuid String
    arn string
    The ARN for the workflow.
    awsId string
    The workflow's ID.
    creationTime string
    When the workflow was created.
    id string
    The provider-assigned unique ID for this managed resource.
    status WorkflowStatus
    The workflow's status.
    type WorkflowType
    The workflow's type.
    uuid string
    arn str
    The ARN for the workflow.
    aws_id str
    The workflow's ID.
    creation_time str
    When the workflow was created.
    id str
    The provider-assigned unique ID for this managed resource.
    status WorkflowStatus
    The workflow's status.
    type WorkflowType
    The workflow's type.
    uuid str
    arn String
    The ARN for the workflow.
    awsId String
    The workflow's ID.
    creationTime String
    When the workflow was created.
    id String
    The provider-assigned unique ID for this managed resource.
    status "CREATING" | "ACTIVE" | "UPDATING" | "DELETED" | "FAILED"
    The workflow's status.
    type "PRIVATE"
    The workflow's type.
    uuid String

    Supporting Types

    WorkflowAccelerators, WorkflowAcceleratorsArgs

    Gpu
    GPU
    WorkflowAcceleratorsGpu
    GPU
    Gpu
    GPU
    Gpu
    GPU
    GPU
    GPU
    "GPU"
    GPU

    WorkflowDefinitionRepository, WorkflowDefinitionRepositoryArgs

    ConnectionArn string
    The Amazon Resource Name (ARN) of the connection to the source code repository.
    ExcludeFilePatterns List<string>
    A list of file patterns to exclude when retrieving the workflow definition from the repository.
    FullRepositoryId string
    The full repository identifier, including the repository owner and name. For example, 'repository-owner/repository-name'.
    SourceReference Pulumi.AwsNative.Omics.Inputs.WorkflowSourceReference
    The source reference for the repository, such as a branch name, tag, or commit ID.
    ConnectionArn string
    The Amazon Resource Name (ARN) of the connection to the source code repository.
    ExcludeFilePatterns []string
    A list of file patterns to exclude when retrieving the workflow definition from the repository.
    FullRepositoryId string
    The full repository identifier, including the repository owner and name. For example, 'repository-owner/repository-name'.
    SourceReference WorkflowSourceReference
    The source reference for the repository, such as a branch name, tag, or commit ID.
    connectionArn String
    The Amazon Resource Name (ARN) of the connection to the source code repository.
    excludeFilePatterns List<String>
    A list of file patterns to exclude when retrieving the workflow definition from the repository.
    fullRepositoryId String
    The full repository identifier, including the repository owner and name. For example, 'repository-owner/repository-name'.
    sourceReference WorkflowSourceReference
    The source reference for the repository, such as a branch name, tag, or commit ID.
    connectionArn string
    The Amazon Resource Name (ARN) of the connection to the source code repository.
    excludeFilePatterns string[]
    A list of file patterns to exclude when retrieving the workflow definition from the repository.
    fullRepositoryId string
    The full repository identifier, including the repository owner and name. For example, 'repository-owner/repository-name'.
    sourceReference WorkflowSourceReference
    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_patterns Sequence[str]
    A list of file patterns to exclude when retrieving the workflow definition from the repository.
    full_repository_id str
    The full repository identifier, including the repository owner and name. For example, 'repository-owner/repository-name'.
    source_reference WorkflowSourceReference
    The source reference for the repository, such as a branch name, tag, or commit ID.
    connectionArn String
    The Amazon Resource Name (ARN) of the connection to the source code repository.
    excludeFilePatterns List<String>
    A list of file patterns to exclude when retrieving the workflow definition from the repository.
    fullRepositoryId String
    The full repository identifier, including the repository owner and name. For example, 'repository-owner/repository-name'.
    sourceReference Property Map
    The source reference for the repository, such as a branch name, tag, or commit ID.

    WorkflowEngine, WorkflowEngineArgs

    Wdl
    WDL
    Nextflow
    NEXTFLOW
    Cwl
    CWL
    WorkflowEngineWdl
    WDL
    WorkflowEngineNextflow
    NEXTFLOW
    WorkflowEngineCwl
    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

    WorkflowParameter, WorkflowParameterArgs

    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.

    WorkflowSourceReference, WorkflowSourceReferenceArgs

    Type Pulumi.AwsNative.Omics.WorkflowSourceReferencetype
    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 WorkflowSourceReferencetype
    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 WorkflowSourceReferencetype
    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 WorkflowSourceReferencetype
    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 WorkflowSourceReferencetype
    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.

    WorkflowSourceReferencetype, WorkflowSourceReferencetypeArgs

    Branch
    BRANCH
    Tag
    TAG
    Commit
    COMMIT
    WorkflowSourceReferencetypeBranch
    BRANCH
    WorkflowSourceReferencetypeTag
    TAG
    WorkflowSourceReferencetypeCommit
    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

    WorkflowStatus, WorkflowStatusArgs

    Creating
    CREATING
    Active
    ACTIVE
    Updating
    UPDATING
    Deleted
    DELETED
    Failed
    FAILED
    WorkflowStatusCreating
    CREATING
    WorkflowStatusActive
    ACTIVE
    WorkflowStatusUpdating
    UPDATING
    WorkflowStatusDeleted
    DELETED
    WorkflowStatusFailed
    FAILED
    Creating
    CREATING
    Active
    ACTIVE
    Updating
    UPDATING
    Deleted
    DELETED
    Failed
    FAILED
    Creating
    CREATING
    Active
    ACTIVE
    Updating
    UPDATING
    Deleted
    DELETED
    Failed
    FAILED
    CREATING
    CREATING
    ACTIVE
    ACTIVE
    UPDATING
    UPDATING
    DELETED
    DELETED
    FAILED
    FAILED
    "CREATING"
    CREATING
    "ACTIVE"
    ACTIVE
    "UPDATING"
    UPDATING
    "DELETED"
    DELETED
    "FAILED"
    FAILED

    WorkflowStorageType, WorkflowStorageTypeArgs

    Static
    STATIC
    Dynamic
    DYNAMIC
    WorkflowStorageTypeStatic
    STATIC
    WorkflowStorageTypeDynamic
    DYNAMIC
    Static
    STATIC
    Dynamic
    DYNAMIC
    Static
    STATIC
    Dynamic
    DYNAMIC
    STATIC
    STATIC
    DYNAMIC
    DYNAMIC
    "STATIC"
    STATIC
    "DYNAMIC"
    DYNAMIC

    WorkflowType, WorkflowTypeArgs

    Private
    PRIVATE
    WorkflowTypePrivate
    PRIVATE
    Private
    PRIVATE
    Private
    PRIVATE
    PRIVATE
    PRIVATE
    "PRIVATE"
    PRIVATE

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    We recommend new projects start with resources from the AWS provider.

    AWS Cloud Control v1.34.0 published on Friday, Sep 12, 2025 by Pulumi
    pulumi/pulumi-aws-native