omics/aws.sdk.kotlin.services.omics.model/CreateWorkflowRequest/Builder

Builder

Properties

The computational accelerator specified to run the workflow.

var definitionRepository: DefinitionRepository?

The repository information for the workflow definition. This allows you to source your workflow definition directly from a code repository.

definitionUri

var definitionUri: String?

The S3 URI of a definition for the workflow. The S3 bucket must be in the same region as the workflow.

definitionZip

var definitionZip: ByteArray?

A ZIP archive containing the main workflow definition file and dependencies that it imports for the workflow. You can use a file with a ://fileb prefix instead of the Base64 string. For more information, see Workflow definition requirements in the Amazon Web Services HealthOmics User Guide.

description

var description: String?

A description for the workflow.

engine

var engine: WorkflowEngine?

The workflow engine for the workflow. This is only required if you have workflow definition files from more than one engine in your zip file. Otherwise, the service can detect the engine automatically from your workflow definition.

main

var main: String?

The path of the main definition file for the workflow. This parameter is not required if the ZIP archive contains only one workflow definition file, or if the main definition file is named “main”. An example path is: workflow-definition/main-file.wdl.

name

var name: String?

Name (optional but highly recommended) for the workflow to locate relevant information in the CloudWatch logs and Amazon Web Services HealthOmics console.

parameterTemplate

var parameterTemplate: Map<String, WorkflowParameter>?

A parameter template for the workflow. If this field is blank, Amazon Web Services HealthOmics will automatically parse the parameter template values from your workflow definition file. To override these service generated default values, provide a parameter template. To view an example of a parameter template, see Parameter template files in the Amazon Web Services HealthOmics User Guide.

parameterTemplatePath

var parameterTemplatePath: String?

The path to the workflow parameter template JSON file within the repository. This file defines the input parameters for runs that use this workflow. If not specified, the workflow will be created without a parameter template.

readmeMarkdown

var readmeMarkdown: String?

The markdown content for the workflow's README file. This provides documentation and usage information for users of the workflow.

readmePath

var 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

var readmeUri: String?

The S3 URI of the README file for the workflow. This file provides documentation and usage information for the workflow. Requirements include:

requestId

var requestId: String?

An idempotency token to ensure that duplicate workflows are not created when Amazon Web Services HealthOmics submits retry requests.

storageCapacity

var storageCapacity: Int?

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

var storageType: StorageType?

The default storage type for runs that use this workflow. The storageType can be overridden at run time. DYNAMIC storage dynamically scales the storage up or down, based on file system utilization. STATIC storage allocates a fixed amount of storage. For more information about dynamic and static storage types, see Run storage types in the Amazon Web Services HealthOmics User Guide.

Functions

definitionRepository

fun definitionRepository(block: DefinitionRepository.Builder.() -> Unit)

construct an aws.sdk.kotlin.services.omics.model.DefinitionRepository inside the given block