Class: Aws::Omics::Types::CreateRunCacheRequest

Inherits:

Struct

• Object
• Struct
• Aws::Omics::Types::CreateRunCacheRequest

Includes:

Structure

Defined in:

lib/aws-sdk-omics/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #cache_behavior ⇒ String

  Default cache behavior for runs that use this cache.

• #cache_bucket_owner_id ⇒ String

  The AWS account ID of the expected owner of the S3 bucket for the run cache.

• #cache_s3_location ⇒ String

  Specify the S3 location for storing the cached task outputs.

• #description ⇒ String

  Enter a description of the run cache.

• #name ⇒ String

  Enter a user-friendly name for the run cache.

• #request_id ⇒ String

  A unique request token, to ensure idempotency.

• #tags ⇒ Hash<String,String>

  Specify one or more tags to associate with this run cache.

Instance Attribute Details

#cache_behavior ⇒ String

Default cache behavior for runs that use this cache. Supported values are:

‘CACHE_ON_FAILURE`: Caches task outputs from completed tasks for runs that fail. This setting is useful if you’re debugging a workflow that fails after several tasks completed successfully. The subsequent run uses the cache outputs for previously-completed tasks if the task definition, inputs, and container in ECR are identical to the prior run.

‘CACHE_ALWAYS`: Caches task outputs from completed tasks for all runs. This setting is useful in development mode, but do not use it in a production setting.

If you don’t specify a value, the default behavior is CACHE_ON_FAILURE. When you start a run that uses this cache, you can override the default cache behavior.

For more information, see [Run cache behavior] in the AWS HealthOmics User Guide.

[1]: docs.aws.amazon.com/omics/latest/dev/how-run-cache.html#run-cache-behavior

Returns:

• (String)

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

class CreateRunCacheRequest < Struct.new(
  :cache_behavior,
  :cache_s3_location,
  :description,
  :name,
  :request_id,
  :tags,
  :cache_bucket_owner_id)
  SENSITIVE = []
  include Aws::Structure
end

#cache_bucket_owner_id ⇒ String

The AWS account ID of the expected owner of the S3 bucket for the run cache. If not provided, your account ID is set as the owner of the bucket.

Returns:

• (String)

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

class CreateRunCacheRequest < Struct.new(
  :cache_behavior,
  :cache_s3_location,
  :description,
  :name,
  :request_id,
  :tags,
  :cache_bucket_owner_id)
  SENSITIVE = []
  include Aws::Structure
end

#cache_s3_location ⇒ String

Specify the S3 location for storing the cached task outputs. This data must be immediately accessible (not in an archived state).

Returns:

• (String)

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

class CreateRunCacheRequest < Struct.new(
  :cache_behavior,
  :cache_s3_location,
  :description,
  :name,
  :request_id,
  :tags,
  :cache_bucket_owner_id)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ String

Enter a description of the run cache.

Returns:

• (String)

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

class CreateRunCacheRequest < Struct.new(
  :cache_behavior,
  :cache_s3_location,
  :description,
  :name,
  :request_id,
  :tags,
  :cache_bucket_owner_id)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

Enter a user-friendly name for the run cache.

Returns:

• (String)

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

class CreateRunCacheRequest < Struct.new(
  :cache_behavior,
  :cache_s3_location,
  :description,
  :name,
  :request_id,
  :tags,
  :cache_bucket_owner_id)
  SENSITIVE = []
  include Aws::Structure
end

#request_id ⇒ String

A unique request token, to ensure idempotency. If you don’t specify a token, HealthOmics automatically generates a universally unique identifier (UUID) for the request.

**A suitable default value is auto-generated.** You should normally not need to pass this option.

Returns:

• (String)

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

class CreateRunCacheRequest < Struct.new(
  :cache_behavior,
  :cache_s3_location,
  :description,
  :name,
  :request_id,
  :tags,
  :cache_bucket_owner_id)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Hash<String,String>

Specify one or more tags to associate with this run cache.

Returns:

• (Hash<String,String>)

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

class CreateRunCacheRequest < Struct.new(
  :cache_behavior,
  :cache_s3_location,
  :description,
  :name,
  :request_id,
  :tags,
  :cache_bucket_owner_id)
  SENSITIVE = []
  include Aws::Structure
end