View a markdown version of this page

AWS::Omics::Run - AWS CloudFormation
SyntaxPropertiesReturn values

This is the new CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the AWS CloudFormation User Guide.

AWS::Omics::Run

Creates a run group to limit the compute resources for the runs that are added to the group. Returns an ARN, ID, and tags for the run group.

Syntax

To declare this entity in your CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::Omics::Run",
  "Properties" : {
      "CacheBehavior" : String,
      "CacheId" : String,
      "LogLevel" : String,
      "Name" : String,
      "NetworkingMode" : String,
      "OutputUri" : String,
      "Priority" : Integer,
      "RetentionMode" : String,
      "RoleArn" : String,
      "RunGroupId" : String,
      "StorageCapacity" : Integer,
      "StorageType" : String,
      "Tags" : [ Tag, ... ],
      "WorkflowId" : String,
      "WorkflowOwnerId" : String,
      "WorkflowType" : String
    }
}

YAML

Type: AWS::Omics::Run
Properties:
  CacheBehavior: String
  CacheId: String
  LogLevel: String
  Name: String
  NetworkingMode: String
  OutputUri: String
  Priority: Integer
  RetentionMode: String
  RoleArn: String
  RunGroupId: String
  StorageCapacity: Integer
  StorageType: String
  Tags: 
    - Tag
  WorkflowId: String
  WorkflowOwnerId: String
  WorkflowType: String

Properties

CacheBehavior

The cache behavior for the runs. Requires cacheId to be set.

Required: No

Type: String

Allowed values: CACHE_ON_FAILURE | CACHE_ALWAYS

Update requires: Replacement

CacheId

The identifier of the run cache to associate with the runs.

Required: No

Type: String

Pattern: ^[0-9]+$

Minimum: 1

Maximum: 18

Update requires: Replacement

LogLevel

The verbosity level for CloudWatch Logs emitted during each run.

Required: No

Type: String

Allowed values: OFF | FATAL | ERROR | ALL

Update requires: Replacement

Name

An optional user-friendly name applied to each workflow run. Can be overridden per run.

Required: No

Type: String

Minimum: 1

Maximum: 128

Update requires: Replacement

NetworkingMode

Optional configuration for run networking behavior. If not specified, this will default to RESTRICTED.

Required: No

Type: String

Allowed values: RESTRICTED | VPC

Update requires: Replacement

OutputUri

The destination S3 URI for workflow outputs. Must begin with s3://. The roleArn must grant write permissions to this bucket. Can be overridden per run.

Required: Yes

Type: String

Minimum: 1

Maximum: 750

Update requires: Replacement

Priority

An integer priority for the workflow runs. Higher values correspond to higher priority. A value of 0 corresponds to the lowest priority. Can be overridden per run.

Required: No

Type: Integer

Minimum: 0

Maximum: 100000

Update requires: Replacement

RetentionMode

The retention behavior for runs after completion.

Required: No

Type: String

Allowed values: RETAIN | REMOVE

Update requires: Replacement

RoleArn

The IAM role ARN that grants HealthOmics permissions to access required AWS resources such as Amazon S3 and CloudWatch. The role must have the same permissions required for individual StartRun calls.

Required: Yes

Type: String

Pattern: ^arn:.+$

Minimum: 1

Maximum: 128

Update requires: Replacement

RunGroupId

The ID of the run group to contain all workflow runs in the batch.

Required: No

Type: String

Pattern: ^[0-9]+$

Minimum: 1

Maximum: 18

Update requires: Replacement

StorageCapacity

The filesystem size in gibibytes (GiB) provisioned for each workflow run and shared by all tasks in that run. Defaults to 1200 GiB if not specified.

Required: No

Type: Integer

Minimum: 0

Maximum: 100000

Update requires: Replacement

StorageType

The storage type for the workflow runs.

Required: No

Type: String

Allowed values: STATIC | DYNAMIC

Update requires: Replacement

Tags

Property description not available.

Required: No

Type: Array of Tag

Update requires: Replacement

WorkflowId

The identifier of the workflow to run.

Required: No

Type: String

Pattern: ^[0-9]+$

Minimum: 1

Maximum: 18

Update requires: Replacement

WorkflowOwnerId

The AWS account ID of the workflow owner, used for cross-account workflow sharing.

Required: No

Type: String

Pattern: ^[0-9]{12}$

Update requires: Replacement

WorkflowType

The type of the originating workflow. Batch runs are not supported with READY2RUN workflows.

Required: No

Type: String

Allowed values: PRIVATE | READY2RUN

Update requires: Replacement

Return values

Ref

Fn::GetAtt

Arn

The run's ARN.

CreationTime

When the run was created.

Id

The run's ID.

RunOutputUri

Property description not available.

StartedBy

Property description not available.

StartTime

When the run started.

Status

The run's status.

Uuid

Property description not available.