CfnWorkflowVersionProps

class aws_cdk.aws_omics.CfnWorkflowVersionProps(*, version_name, workflow_id, accelerators=None, container_registry_map=None, container_registry_map_uri=None, definition_repository=None, definition_uri=None, description=None, engine=None, main=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 CfnWorkflowVersion.

Parameters:

version_name (str) – The name of the workflow version.
workflow_id (str) – The workflow’s ID.
accelerators (Optional[str])
container_registry_map (Union[IResolvable, ContainerRegistryMapProperty, Dict[str, Any], None]) – 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 .
container_registry_map_uri (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])
description (Optional[str]) – The description of the workflow version.
engine (Optional[str])
main (Optional[str])
parameter_template (Union[IResolvable, Mapping[str, Union[IResolvable, WorkflowParameterProperty, Dict[str, Any]]], None])
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])
storage_type (Optional[str])
tags (Optional[Mapping[str, str]]) – A map of resource tags.
workflow_bucket_owner_id (Optional[str])

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-omics-workflowversion.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_version_props = omics.CfnWorkflowVersionProps(
    version_name="versionName",
    workflow_id="workflowId",

    # the properties below are optional
    accelerators="accelerators",
    container_registry_map=omics.CfnWorkflowVersion.ContainerRegistryMapProperty(
        image_mappings=[omics.CfnWorkflowVersion.ImageMappingProperty(
            destination_image="destinationImage",
            source_image="sourceImage"
        )],
        registry_mappings=[omics.CfnWorkflowVersion.RegistryMappingProperty(
            ecr_account_id="ecrAccountId",
            ecr_repository_prefix="ecrRepositoryPrefix",
            upstream_registry_url="upstreamRegistryUrl",
            upstream_repository_prefix="upstreamRepositoryPrefix"
        )]
    ),
    container_registry_map_uri="containerRegistryMapUri",
    definition_repository=omics.CfnWorkflowVersion.DefinitionRepositoryProperty(
        connection_arn="connectionArn",
        exclude_file_patterns=["excludeFilePatterns"],
        full_repository_id="fullRepositoryId",
        source_reference=omics.CfnWorkflowVersion.SourceReferenceProperty(
            type="type",
            value="value"
        )
    ),
    definition_uri="definitionUri",
    description="description",
    engine="engine",
    main="main",
    parameter_template={
        "parameter_template_key": omics.CfnWorkflowVersion.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-workflowversion.html#cfn-omics-workflowversion-accelerators

Type:: see

container_registry_map

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 .

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

container_registry_map_uri

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

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-workflowversion.html#cfn-omics-workflowversion-definitionrepository

definition_uri

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

Type:: see

description

The description of the workflow version.

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

engine

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

Type:: see

main

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

Type:: see

parameter_template

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

Type:: see

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-workflowversion.html#cfn-omics-workflowversion-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-workflowversion.html#cfn-omics-workflowversion-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-workflowversion.html#cfn-omics-workflowversion-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.