Class: AWSCDK::Omics::CfnWorkflowVersionProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
omics/cfn_workflow_version_props.rb

Overview

Properties for defining a CfnWorkflowVersion.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(version_name:, workflow_id:, accelerators: nil, container_registry_map: nil, container_registry_map_uri: nil, definition_repository: nil, definition_uri: nil, description: nil, engine: nil, main: nil, parameter_template: nil, parameter_template_path: nil, readme_markdown: nil, readme_path: nil, readme_uri: nil, storage_capacity: nil, storage_type: nil, tags: nil, workflow_bucket_owner_id: nil) ⇒ CfnWorkflowVersionProps

Returns a new instance of CfnWorkflowVersionProps.

Parameters:

  • version_name (String) —

    The name of the workflow version.

  • workflow_id (String) —

    The workflow's ID.

  • accelerators (String, nil) (defaults to: nil)
  • container_registry_map (AWSCDK::IResolvable, AWSCDK::Omics::CfnWorkflowVersion::ContainerRegistryMapProperty, nil) (defaults to: nil) —

    Use a container registry map to specify mappings between the ECR private repository and one or more upstream registries.

  • container_registry_map_uri (String, nil) (defaults to: nil)
  • definition_repository (AWSCDK::IResolvable, AWSCDK::Omics::CfnWorkflowVersion::DefinitionRepositoryProperty, nil) (defaults to: nil) —

    Contains information about a source code repository that hosts the workflow definition files.

  • definition_uri (String, nil) (defaults to: nil)
  • description (String, nil) (defaults to: nil) —

    The description of the workflow version.

  • engine (String, nil) (defaults to: nil)
  • main (String, nil) (defaults to: nil)
  • parameter_template (AWSCDK::IResolvable, Hash{String => AWSCDK::IResolvable, AWSCDK::Omics::CfnWorkflowVersion::WorkflowParameterProperty}, nil) (defaults to: nil)
  • parameter_template_path (String, nil) (defaults to: nil) —

    Path to the primary workflow parameter template JSON file inside the repository.

  • readme_markdown (String, nil) (defaults to: nil) —

    The markdown content for the workflow's README file.

  • readme_path (String, nil) (defaults to: nil) —

    The path to the workflow README markdown file within the repository.

  • readme_uri (String, nil) (defaults to: nil) —

    The S3 URI of the README file for the workflow.

  • storage_capacity (Numeric, nil) (defaults to: nil)
  • storage_type (String, nil) (defaults to: nil)
  • tags (Hash{String => String}, nil) (defaults to: nil) —

    A map of resource tags.

  • workflow_bucket_owner_id (String, nil) (defaults to: nil) 


28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
 
# File 'omics/cfn_workflow_version_props.rb', line 28

def initialize(version_name:, workflow_id:, accelerators: nil, container_registry_map: nil, container_registry_map_uri: nil, definition_repository: nil, definition_uri: nil, description: nil, engine: nil, main: nil, parameter_template: nil, parameter_template_path: nil, readme_markdown: nil, readme_path: nil, readme_uri: nil, storage_capacity: nil, storage_type: nil, tags: nil, workflow_bucket_owner_id: nil)
  @version_name = version_name
  Jsii::Type.check_type(@version_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "versionName")
  @workflow_id = workflow_id
  Jsii::Type.check_type(@workflow_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "workflowId")
  @accelerators = accelerators
  Jsii::Type.check_type(@accelerators, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "accelerators") unless @accelerators.nil?
  @container_registry_map = container_registry_map.is_a?(Hash) ? ::AWSCDK::Omics::CfnWorkflowVersion::ContainerRegistryMapProperty.new(**container_registry_map.transform_keys(&:to_sym)) : container_registry_map
  Jsii::Type.check_type(@container_registry_map, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19vbWljcy5DZm5Xb3JrZmxvd1ZlcnNpb24uQ29udGFpbmVyUmVnaXN0cnlNYXBQcm9wZXJ0eSJ9XX19")), "containerRegistryMap") unless @container_registry_map.nil?
  @container_registry_map_uri = container_registry_map_uri
  Jsii::Type.check_type(@container_registry_map_uri, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "containerRegistryMapUri") unless @container_registry_map_uri.nil?
  @definition_repository = definition_repository.is_a?(Hash) ? ::AWSCDK::Omics::CfnWorkflowVersion::DefinitionRepositoryProperty.new(**definition_repository.transform_keys(&:to_sym)) : definition_repository
  Jsii::Type.check_type(@definition_repository, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19vbWljcy5DZm5Xb3JrZmxvd1ZlcnNpb24uRGVmaW5pdGlvblJlcG9zaXRvcnlQcm9wZXJ0eSJ9XX19")), "definitionRepository") unless @definition_repository.nil?
  @definition_uri = definition_uri
  Jsii::Type.check_type(@definition_uri, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "definitionUri") unless @definition_uri.nil?
  @description = description
  Jsii::Type.check_type(@description, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "description") unless @description.nil?
  @engine = engine
  Jsii::Type.check_type(@engine, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "engine") unless @engine.nil?
  @main = main
  Jsii::Type.check_type(@main, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "main") unless @main.nil?
  @parameter_template = parameter_template
  Jsii::Type.check_type(@parameter_template, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfb21pY3MuQ2ZuV29ya2Zsb3dWZXJzaW9uLldvcmtmbG93UGFyYW1ldGVyUHJvcGVydHkifV19fSwia2luZCI6Im1hcCJ9fV19fQ==")), "parameterTemplate") unless @parameter_template.nil?
  @parameter_template_path = parameter_template_path
  Jsii::Type.check_type(@parameter_template_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "parameterTemplatePath") unless @parameter_template_path.nil?
  @readme_markdown = readme_markdown
  Jsii::Type.check_type(@readme_markdown, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "readmeMarkdown") unless @readme_markdown.nil?
  @readme_path = readme_path
  Jsii::Type.check_type(@readme_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "readmePath") unless @readme_path.nil?
  @readme_uri = readme_uri
  Jsii::Type.check_type(@readme_uri, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "readmeUri") unless @readme_uri.nil?
  @storage_capacity = storage_capacity
  Jsii::Type.check_type(@storage_capacity, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "storageCapacity") unless @storage_capacity.nil?
  @storage_type = storage_type
  Jsii::Type.check_type(@storage_type, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "storageType") unless @storage_type.nil?
  @tags = tags
  Jsii::Type.check_type(@tags, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoibWFwIn19")), "tags") unless @tags.nil?
  @workflow_bucket_owner_id = workflow_bucket_owner_id
  Jsii::Type.check_type(@workflow_bucket_owner_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "workflowBucketOwnerId") unless @workflow_bucket_owner_id.nil?
end

Instance Attribute Details

#accelerators ⇒ String? (readonly)

Returns:

  • (String, nil)

See Also:



81
82
83
 
# File 'omics/cfn_workflow_version_props.rb', line 81

def accelerators
  @accelerators
end

#container_registry_map ⇒ AWSCDK::IResolvable, ... (readonly)

Use a container registry map to specify mappings between the ECR private repository and one or more upstream registries.

For more information, see Container images in the AWS HealthOmics User Guide .

Returns:

See Also:



88
89
90
 
# File 'omics/cfn_workflow_version_props.rb', line 88

def container_registry_map
  @container_registry_map
end

#container_registry_map_uri ⇒ String? (readonly)

Returns:

  • (String, nil)

See Also:



91
92
93
 
# File 'omics/cfn_workflow_version_props.rb', line 91

def container_registry_map_uri
  @container_registry_map_uri
end

#definition_repository ⇒ AWSCDK::IResolvable, ... (readonly)

Contains information about a source code repository that hosts the workflow definition files.

Returns:

See Also:



96
97
98
 
# File 'omics/cfn_workflow_version_props.rb', line 96

def definition_repository
  @definition_repository
end

#definition_uri ⇒ String? (readonly)

Returns:

  • (String, nil)

See Also:



99
100
101
 
# File 'omics/cfn_workflow_version_props.rb', line 99

def definition_uri
  @definition_uri
end

#description ⇒ String? (readonly)

The description of the workflow version.

Returns:

  • (String, nil)

See Also:



104
105
106
 
# File 'omics/cfn_workflow_version_props.rb', line 104

def description
  @description
end

#engine ⇒ String? (readonly)

Returns:

  • (String, nil)

See Also:



107
108
109
 
# File 'omics/cfn_workflow_version_props.rb', line 107

def engine
  @engine
end

#main ⇒ String? (readonly)

Returns:

  • (String, nil)

See Also:



110
111
112
 
# File 'omics/cfn_workflow_version_props.rb', line 110

def main
  @main
end

#parameter_template ⇒ AWSCDK::IResolvable, ... (readonly)

Returns:

See Also:



113
114
115
 
# File 'omics/cfn_workflow_version_props.rb', line 113

def parameter_template
  @parameter_template
end

#parameter_template_path ⇒ String? (readonly)

Path to the primary workflow parameter template JSON file inside the repository.

Returns:

  • (String, nil)

See Also:



118
119
120
 
# File 'omics/cfn_workflow_version_props.rb', line 118

def parameter_template_path
  @parameter_template_path
end

#readme_markdown ⇒ String? (readonly)

The markdown content for the workflow's README file.

This provides documentation and usage information for users of the workflow.

Returns:

  • (String, nil)

See Also:



125
126
127
 
# File 'omics/cfn_workflow_version_props.rb', line 125

def readme_markdown
  @readme_markdown
end

#readme_path ⇒ String? (readonly)

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.

Returns:

  • (String, nil)

See Also:



132
133
134
 
# File 'omics/cfn_workflow_version_props.rb', line 132

def readme_path
  @readme_path
end

#readme_uri ⇒ String? (readonly)

The S3 URI of the README file for the workflow.

This file provides documentation and usage information for the workflow. The S3 URI must begin with s3://USER-OWNED-BUCKET/. The requester must have access to the S3 bucket and object. The max README content length is 500 KiB.

Returns:

  • (String, nil)

See Also:



139
140
141
 
# File 'omics/cfn_workflow_version_props.rb', line 139

def readme_uri
  @readme_uri
end

#storage_capacity ⇒ Numeric? (readonly)

Returns:

  • (Numeric, nil)

See Also:



142
143
144
 
# File 'omics/cfn_workflow_version_props.rb', line 142

def storage_capacity
  @storage_capacity
end

#storage_type ⇒ String? (readonly)

Returns:

  • (String, nil)

See Also:



145
146
147
 
# File 'omics/cfn_workflow_version_props.rb', line 145

def storage_type
  @storage_type
end

#tags ⇒ Hash{String => String}? (readonly)

A map of resource tags.

Returns:

  • (Hash{String => String}, nil)

See Also:



150
151
152
 
# File 'omics/cfn_workflow_version_props.rb', line 150

def tags
  @tags
end

#version_name ⇒ String (readonly)

The name of the workflow version.

Returns:

  • (String)

See Also:



73
74
75
 
# File 'omics/cfn_workflow_version_props.rb', line 73

def version_name
  @version_name
end

#workflow_bucket_owner_id ⇒ String? (readonly)

Returns:

  • (String, nil)

See Also:



153
154
155
 
# File 'omics/cfn_workflow_version_props.rb', line 153

def workflow_bucket_owner_id
  @workflow_bucket_owner_id
end

#workflow_id ⇒ String (readonly)

The workflow's ID.

Returns:

  • (String)

See Also:



78
79
80
 
# File 'omics/cfn_workflow_version_props.rb', line 78

def workflow_id
  @workflow_id
end

Class Method Details

.jsii_properties ⇒ Object 



155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
 
# File 'omics/cfn_workflow_version_props.rb', line 155

def self.jsii_properties
  {
    :version_name => "versionName",
    :workflow_id => "workflowId",
    :accelerators => "accelerators",
    :container_registry_map => "containerRegistryMap",
    :container_registry_map_uri => "containerRegistryMapUri",
    :definition_repository => "definitionRepository",
    :definition_uri => "definitionUri",
    :description => "description",
    :engine => "engine",
    :main => "main",
    :parameter_template => "parameterTemplate",
    :parameter_template_path => "parameterTemplatePath",
    :readme_markdown => "readmeMarkdown",
    :readme_path => "readmePath",
    :readme_uri => "readmeUri",
    :storage_capacity => "storageCapacity",
    :storage_type => "storageType",
    :tags => "tags",
    :workflow_bucket_owner_id => "workflowBucketOwnerId",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
 
# File 'omics/cfn_workflow_version_props.rb', line 179

def to_jsii
  result = {}
  result.merge!({
    "versionName" => @version_name,
    "workflowId" => @workflow_id,
    "accelerators" => @accelerators,
    "containerRegistryMap" => @container_registry_map,
    "containerRegistryMapUri" => @container_registry_map_uri,
    "definitionRepository" => @definition_repository,
    "definitionUri" => @definition_uri,
    "description" => @description,
    "engine" => @engine,
    "main" => @main,
    "parameterTemplate" => @parameter_template,
    "parameterTemplatePath" => @parameter_template_path,
    "readmeMarkdown" => @readme_markdown,
    "readmePath" => @readme_path,
    "readmeUri" => @readme_uri,
    "storageCapacity" => @storage_capacity,
    "storageType" => @storage_type,
    "tags" => @tags,
    "workflowBucketOwnerId" => @workflow_bucket_owner_id,
  })
  result.compact
end