Class: Aws::Omics::Types::DefaultRunSetting

Inherits:

Struct

Object
Struct
Aws::Omics::Types::DefaultRunSetting

show all

Defined in:: gems/aws-sdk-omics/lib/aws-sdk-omics/types.rb

Overview

Shared configuration applied to all runs in a batch. Fields specified in a per-run InlineSetting entry override the corresponding fields in this object for that run. The parameters and runTags fields are merged rather than replaced — run-specific values take precedence when keys overlap.

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#cache_behavior ⇒ String
The cache behavior for the runs.
#cache_id ⇒ String
The identifier of the run cache to associate with the runs.
#log_level ⇒ String
The verbosity level for CloudWatch Logs emitted during each run.
#name ⇒ String
An optional user-friendly name applied to each workflow run.
#output_bucket_owner_id ⇒ String
The expected AWS account ID of the owner of the output S3 bucket.
#output_uri ⇒ String
The destination S3 URI for workflow outputs.
#parameters ⇒ Hash, ...
Workflow parameter names and values shared across all runs.
#priority ⇒ Integer
An integer priority for the workflow runs.
#retention_mode ⇒ String
The retention behavior for runs after completion.
#role_arn ⇒ String
The IAM role ARN that grants HealthOmics permissions to access required AWS resources such as Amazon S3 and CloudWatch.
#run_group_id ⇒ String
The ID of the run group to contain all workflow runs in the batch.
#run_tags ⇒ Hash<String,String>
AWS tags to associate with each workflow run.
#storage_capacity ⇒ Integer
The filesystem size in gibibytes (GiB) provisioned for each workflow run and shared by all tasks in that run.
#storage_type ⇒ String
The storage type for the workflow runs.
#workflow_id ⇒ String
The identifier of the workflow to run.
#workflow_owner_id ⇒ String
The AWS account ID of the workflow owner, used for cross-account workflow sharing.
#workflow_type ⇒ String
The type of the originating workflow.
#workflow_version_name ⇒ String
The version name of the specified workflow.

Instance Attribute Details

#cache_behavior ⇒ `String`

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

Returns:

(String)

# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/types.rb', line 2130

class DefaultRunSetting < Struct.new(
  :workflow_id,
  :workflow_type,
  :role_arn,
  :name,
  :cache_id,
  :cache_behavior,
  :run_group_id,
  :priority,
  :parameters,
  :storage_capacity,
  :output_uri,
  :log_level,
  :run_tags,
  :retention_mode,
  :storage_type,
  :workflow_owner_id,
  :output_bucket_owner_id,
  :workflow_version_name)
  SENSITIVE = []
  include Aws::Structure
end

#cache_id ⇒ `String`

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

Returns:

(String)

# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/types.rb', line 2130

class DefaultRunSetting < Struct.new(
  :workflow_id,
  :workflow_type,
  :role_arn,
  :name,
  :cache_id,
  :cache_behavior,
  :run_group_id,
  :priority,
  :parameters,
  :storage_capacity,
  :output_uri,
  :log_level,
  :run_tags,
  :retention_mode,
  :storage_type,
  :workflow_owner_id,
  :output_bucket_owner_id,
  :workflow_version_name)
  SENSITIVE = []
  include Aws::Structure
end

#log_level ⇒ `String`

The verbosity level for CloudWatch Logs emitted during each run.

Returns:

(String)

# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/types.rb', line 2130

class DefaultRunSetting < Struct.new(
  :workflow_id,
  :workflow_type,
  :role_arn,
  :name,
  :cache_id,
  :cache_behavior,
  :run_group_id,
  :priority,
  :parameters,
  :storage_capacity,
  :output_uri,
  :log_level,
  :run_tags,
  :retention_mode,
  :storage_type,
  :workflow_owner_id,
  :output_bucket_owner_id,
  :workflow_version_name)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ `String`

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

Returns:

(String)

# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/types.rb', line 2130

class DefaultRunSetting < Struct.new(
  :workflow_id,
  :workflow_type,
  :role_arn,
  :name,
  :cache_id,
  :cache_behavior,
  :run_group_id,
  :priority,
  :parameters,
  :storage_capacity,
  :output_uri,
  :log_level,
  :run_tags,
  :retention_mode,
  :storage_type,
  :workflow_owner_id,
  :output_bucket_owner_id,
  :workflow_version_name)
  SENSITIVE = []
  include Aws::Structure
end

#output_bucket_owner_id ⇒ `String`

The expected AWS account ID of the owner of the output S3 bucket. Can be overridden per run.

Returns:

(String)

# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/types.rb', line 2130

class DefaultRunSetting < Struct.new(
  :workflow_id,
  :workflow_type,
  :role_arn,
  :name,
  :cache_id,
  :cache_behavior,
  :run_group_id,
  :priority,
  :parameters,
  :storage_capacity,
  :output_uri,
  :log_level,
  :run_tags,
  :retention_mode,
  :storage_type,
  :workflow_owner_id,
  :output_bucket_owner_id,
  :workflow_version_name)
  SENSITIVE = []
  include Aws::Structure
end

#output_uri ⇒ `String`

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.

Returns:

(String)

# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/types.rb', line 2130

class DefaultRunSetting < Struct.new(
  :workflow_id,
  :workflow_type,
  :role_arn,
  :name,
  :cache_id,
  :cache_behavior,
  :run_group_id,
  :priority,
  :parameters,
  :storage_capacity,
  :output_uri,
  :log_level,
  :run_tags,
  :retention_mode,
  :storage_type,
  :workflow_owner_id,
  :output_bucket_owner_id,
  :workflow_version_name)
  SENSITIVE = []
  include Aws::Structure
end

#parameters ⇒ `Hash`, ...

Workflow parameter names and values shared across all runs. Merged with per-run parameters; run-specific values take precedence when keys overlap. Can be overridden per run.

Returns:

(Hash, Array, String, Numeric, Boolean)

# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/types.rb', line 2130

class DefaultRunSetting < Struct.new(
  :workflow_id,
  :workflow_type,
  :role_arn,
  :name,
  :cache_id,
  :cache_behavior,
  :run_group_id,
  :priority,
  :parameters,
  :storage_capacity,
  :output_uri,
  :log_level,
  :run_tags,
  :retention_mode,
  :storage_type,
  :workflow_owner_id,
  :output_bucket_owner_id,
  :workflow_version_name)
  SENSITIVE = []
  include Aws::Structure
end

#priority ⇒ `Integer`

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.

Returns:

(Integer)

# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/types.rb', line 2130

class DefaultRunSetting < Struct.new(
  :workflow_id,
  :workflow_type,
  :role_arn,
  :name,
  :cache_id,
  :cache_behavior,
  :run_group_id,
  :priority,
  :parameters,
  :storage_capacity,
  :output_uri,
  :log_level,
  :run_tags,
  :retention_mode,
  :storage_type,
  :workflow_owner_id,
  :output_bucket_owner_id,
  :workflow_version_name)
  SENSITIVE = []
  include Aws::Structure
end

#retention_mode ⇒ `String`

The retention behavior for runs after completion.

Returns:

(String)

# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/types.rb', line 2130

class DefaultRunSetting < Struct.new(
  :workflow_id,
  :workflow_type,
  :role_arn,
  :name,
  :cache_id,
  :cache_behavior,
  :run_group_id,
  :priority,
  :parameters,
  :storage_capacity,
  :output_uri,
  :log_level,
  :run_tags,
  :retention_mode,
  :storage_type,
  :workflow_owner_id,
  :output_bucket_owner_id,
  :workflow_version_name)
  SENSITIVE = []
  include Aws::Structure
end

#role_arn ⇒ `String`

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.

Returns:

(String)

# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/types.rb', line 2130

class DefaultRunSetting < Struct.new(
  :workflow_id,
  :workflow_type,
  :role_arn,
  :name,
  :cache_id,
  :cache_behavior,
  :run_group_id,
  :priority,
  :parameters,
  :storage_capacity,
  :output_uri,
  :log_level,
  :run_tags,
  :retention_mode,
  :storage_type,
  :workflow_owner_id,
  :output_bucket_owner_id,
  :workflow_version_name)
  SENSITIVE = []
  include Aws::Structure
end

#run_group_id ⇒ `String`

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

Returns:

(String)

# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/types.rb', line 2130

class DefaultRunSetting < Struct.new(
  :workflow_id,
  :workflow_type,
  :role_arn,
  :name,
  :cache_id,
  :cache_behavior,
  :run_group_id,
  :priority,
  :parameters,
  :storage_capacity,
  :output_uri,
  :log_level,
  :run_tags,
  :retention_mode,
  :storage_type,
  :workflow_owner_id,
  :output_bucket_owner_id,
  :workflow_version_name)
  SENSITIVE = []
  include Aws::Structure
end

#run_tags ⇒ `Hash<String,String>`

AWS tags to associate with each workflow run. Merged with per-run runTags; run-specific values take precedence when keys overlap.

Returns:

(Hash<String,String>)

# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/types.rb', line 2130

class DefaultRunSetting < Struct.new(
  :workflow_id,
  :workflow_type,
  :role_arn,
  :name,
  :cache_id,
  :cache_behavior,
  :run_group_id,
  :priority,
  :parameters,
  :storage_capacity,
  :output_uri,
  :log_level,
  :run_tags,
  :retention_mode,
  :storage_type,
  :workflow_owner_id,
  :output_bucket_owner_id,
  :workflow_version_name)
  SENSITIVE = []
  include Aws::Structure
end

#storage_capacity ⇒ `Integer`

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.

Returns:

(Integer)

# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/types.rb', line 2130

class DefaultRunSetting < Struct.new(
  :workflow_id,
  :workflow_type,
  :role_arn,
  :name,
  :cache_id,
  :cache_behavior,
  :run_group_id,
  :priority,
  :parameters,
  :storage_capacity,
  :output_uri,
  :log_level,
  :run_tags,
  :retention_mode,
  :storage_type,
  :workflow_owner_id,
  :output_bucket_owner_id,
  :workflow_version_name)
  SENSITIVE = []
  include Aws::Structure
end

#storage_type ⇒ `String`

The storage type for the workflow runs.

Returns:

(String)

# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/types.rb', line 2130

class DefaultRunSetting < Struct.new(
  :workflow_id,
  :workflow_type,
  :role_arn,
  :name,
  :cache_id,
  :cache_behavior,
  :run_group_id,
  :priority,
  :parameters,
  :storage_capacity,
  :output_uri,
  :log_level,
  :run_tags,
  :retention_mode,
  :storage_type,
  :workflow_owner_id,
  :output_bucket_owner_id,
  :workflow_version_name)
  SENSITIVE = []
  include Aws::Structure
end

#workflow_id ⇒ `String`

The identifier of the workflow to run.

Returns:

(String)

# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/types.rb', line 2130

class DefaultRunSetting < Struct.new(
  :workflow_id,
  :workflow_type,
  :role_arn,
  :name,
  :cache_id,
  :cache_behavior,
  :run_group_id,
  :priority,
  :parameters,
  :storage_capacity,
  :output_uri,
  :log_level,
  :run_tags,
  :retention_mode,
  :storage_type,
  :workflow_owner_id,
  :output_bucket_owner_id,
  :workflow_version_name)
  SENSITIVE = []
  include Aws::Structure
end

#workflow_owner_id ⇒ `String`

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

Returns:

(String)

# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/types.rb', line 2130

class DefaultRunSetting < Struct.new(
  :workflow_id,
  :workflow_type,
  :role_arn,
  :name,
  :cache_id,
  :cache_behavior,
  :run_group_id,
  :priority,
  :parameters,
  :storage_capacity,
  :output_uri,
  :log_level,
  :run_tags,
  :retention_mode,
  :storage_type,
  :workflow_owner_id,
  :output_bucket_owner_id,
  :workflow_version_name)
  SENSITIVE = []
  include Aws::Structure
end

#workflow_type ⇒ `String`

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

Returns:

(String)

# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/types.rb', line 2130

class DefaultRunSetting < Struct.new(
  :workflow_id,
  :workflow_type,
  :role_arn,
  :name,
  :cache_id,
  :cache_behavior,
  :run_group_id,
  :priority,
  :parameters,
  :storage_capacity,
  :output_uri,
  :log_level,
  :run_tags,
  :retention_mode,
  :storage_type,
  :workflow_owner_id,
  :output_bucket_owner_id,
  :workflow_version_name)
  SENSITIVE = []
  include Aws::Structure
end

#workflow_version_name ⇒ `String`

The version name of the specified workflow.

Returns:

(String)

# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/types.rb', line 2130

class DefaultRunSetting < Struct.new(
  :workflow_id,
  :workflow_type,
  :role_arn,
  :name,
  :cache_id,
  :cache_behavior,
  :run_group_id,
  :priority,
  :parameters,
  :storage_capacity,
  :output_uri,
  :log_level,
  :run_tags,
  :retention_mode,
  :storage_type,
  :workflow_owner_id,
  :output_bucket_owner_id,
  :workflow_version_name)
  SENSITIVE = []
  include Aws::Structure
end

Class: Aws::Omics::Types::DefaultRunSetting

Overview

Constant Summary collapse

Instance Attribute Summary collapse

Instance Attribute Details

#cache_behavior ⇒ String

#cache_id ⇒ String

#log_level ⇒ String

#name ⇒ String

#output_bucket_owner_id ⇒ String

#output_uri ⇒ String

#parameters ⇒ Hash, ...

#priority ⇒ Integer

#retention_mode ⇒ String

#role_arn ⇒ String

#run_group_id ⇒ String

#run_tags ⇒ Hash<String,String>

#storage_capacity ⇒ Integer

#storage_type ⇒ String

#workflow_id ⇒ String

#workflow_owner_id ⇒ String

#workflow_type ⇒ String

#workflow_version_name ⇒ String

#cache_behavior ⇒ `String`

#cache_id ⇒ `String`

#log_level ⇒ `String`

#name ⇒ `String`

#output_bucket_owner_id ⇒ `String`

#output_uri ⇒ `String`

#parameters ⇒ `Hash`, ...

#priority ⇒ `Integer`

#retention_mode ⇒ `String`

#role_arn ⇒ `String`

#run_group_id ⇒ `String`

#run_tags ⇒ `Hash<String,String>`

#storage_capacity ⇒ `Integer`

#storage_type ⇒ `String`

#workflow_id ⇒ `String`

#workflow_owner_id ⇒ `String`

#workflow_type ⇒ `String`

#workflow_version_name ⇒ `String`