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

Inherits:
Struct
  • Object
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.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#cache_behavior ⇒ String

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

Returns:

  • (String) 


1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
 
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/types.rb', line 1988

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) 


1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
 
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/types.rb', line 1988

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) 


1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
 
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/types.rb', line 1988

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) 


1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
 
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/types.rb', line 1988

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) 


1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
 
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/types.rb', line 1988

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) 


1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
 
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/types.rb', line 1988

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) 


1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
 
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/types.rb', line 1988

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) 


1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
 
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/types.rb', line 1988

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) 


1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
 
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/types.rb', line 1988

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) 


1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
 
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/types.rb', line 1988

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) 


1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
 
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/types.rb', line 1988

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>) 


1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
 
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/types.rb', line 1988

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) 


1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
 
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/types.rb', line 1988

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) 


1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
 
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/types.rb', line 1988

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) 


1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
 
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/types.rb', line 1988

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) 


1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
 
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/types.rb', line 1988

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) 


1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
 
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/types.rb', line 1988

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) 


1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
 
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/types.rb', line 1988

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