CfnWorkflowProps

class aws_cdk.aws_omics.CfnWorkflowProps(*, accelerators=None, definition_repository=None, definition_uri=None, description=None, engine=None, main=None, name=None, parameter_template=None, parameter_template_path=None, readme_markdown=None, readme_path=None, readme_uri=None, storage_capacity=None, storage_type=None, tags=None, workflow_bucket_owner_id=None)

Bases: object

Properties for defining a CfnWorkflow.

Parameters:

accelerators (Optional[str])
definition_repository (Union[IResolvable, DefinitionRepositoryProperty, Dict[str, Any], None]) – Contains information about a source code repository that hosts the workflow definition files.
definition_uri (Optional[str]) – The URI of a definition for the workflow.
description (Optional[str]) – The parameter’s description.
engine (Optional[str]) – An engine for the workflow.
main (Optional[str]) – The path of the main definition file for the workflow.
name (Optional[str]) – The workflow’s name.
parameter_template (Union[IResolvable, Mapping[str, Union[IResolvable, WorkflowParameterProperty, Dict[str, Any]]], None]) – The workflow’s parameter template.
parameter_template_path (Optional[str]) – Path to the primary workflow parameter template JSON file inside the repository.
readme_markdown (Optional[str]) – The markdown content for the workflow’s README file. This provides documentation and usage information for users of the workflow.
readme_path (Optional[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 (Optional[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 (Union[int, float, None]) – 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 (Optional[str])
tags (Optional[Mapping[str, str]]) – Tags for the workflow.
workflow_bucket_owner_id (Optional[str]) – Optional workflow bucket owner ID to verify the workflow bucket.

See:

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

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_omics as omics

cfn_workflow_props = omics.CfnWorkflowProps(
    accelerators="accelerators",
    definition_repository=omics.CfnWorkflow.DefinitionRepositoryProperty(
        connection_arn="connectionArn",
        exclude_file_patterns=["excludeFilePatterns"],
        full_repository_id="fullRepositoryId",
        source_reference=omics.CfnWorkflow.SourceReferenceProperty(
            type="type",
            value="value"
        )
    ),
    definition_uri="definitionUri",
    description="description",
    engine="engine",
    main="main",
    name="name",
    parameter_template={
        "parameter_template_key": omics.CfnWorkflow.WorkflowParameterProperty(
            description="description",
            optional=False
        )
    },
    parameter_template_path="parameterTemplatePath",
    readme_markdown="readmeMarkdown",
    readme_path="readmePath",
    readme_uri="readmeUri",
    storage_capacity=123,
    storage_type="storageType",
    tags={
        "tags_key": "tags"
    },
    workflow_bucket_owner_id="workflowBucketOwnerId"
)

Attributes

accelerators

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-omics-workflow.html#cfn-omics-workflow-accelerators

Type:: see

definition_repository

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

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

definition_uri

The URI of a definition for the workflow.

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

description

The parameter’s description.

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

engine

An engine for the workflow.

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

main

The path of the main definition file for the workflow.

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

name

The workflow’s name.

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

parameter_template

The workflow’s parameter template.

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

parameter_template_path

Path to the primary workflow parameter template JSON file inside the repository.

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

readme_markdown

The markdown content for the workflow’s README file.

This provides documentation and usage information for users of the workflow.

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

readme_path

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.

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

readme_uri

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.

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

storage_capacity

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.

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

storage_type

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-omics-workflow.html#cfn-omics-workflow-storagetype

Type:: see

tags

Tags for the workflow.

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

workflow_bucket_owner_id

Optional workflow bucket owner ID to verify the workflow bucket.

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