Class: AWSCDK::Omics::CfnWorkflow

Inherits:
CfnResource
  • Object
show all
Includes:
IInspectable, ITaggable, Interfaces::AWSOmics::IWorkflowRef
Defined in:
omics/cfn_workflow.rb

Overview

Creates a private workflow. Before you create a private workflow, you must create and configure these required resources:.

  • Workflow definition file: A workflow definition file written in WDL, Nextflow, or CWL. The workflow definition specifies the inputs and outputs for runs that use the workflow. It also includes specifications for the runs and run tasks for your workflow, including compute and memory requirements. The workflow definition file must be in .zip format. For more information, see Workflow definition files in AWS HealthOmics.
  • You can use Amazon Q CLI to build and validate your workflow definition files in WDL, Nextflow, and CWL. For more information, see Example prompts for Amazon Q CLI and the AWS HealthOmics Agentic generative AI tutorial on GitHub.
  • (Optional) Parameter template file: A parameter template file written in JSON. Create the file to define the run parameters, or AWS HealthOmics generates the parameter template for you. For more information, see Parameter template files for HealthOmics workflows .
  • ECR container images: Create container images for the workflow in a private ECR repository, or synchronize images from a supported upstream registry with your Amazon ECR private repository.
  • (Optional) Sentieon licenses: Request a Sentieon license to use the Sentieon software in private workflows.

For more information, see Creating or updating a private workflow in AWS HealthOmics in the AWS HealthOmics User Guide .

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props = nil) ⇒ CfnWorkflow

Create a new AWS::Omics::Workflow.

Parameters:

  • scope (Constructs::Construct) —

    Scope in which this resource is defined.

  • id (String) —

    Construct identifier for this resource (unique in its scope).

  • props (AWSCDK::Omics::CfnWorkflowProps, nil) (defaults to: nil) —

    Resource properties.



26
27
28
29
30
31
32
 
# File 'omics/cfn_workflow.rb', line 26

def initialize(scope, id, props = nil)
  props = props.is_a?(Hash) ? ::AWSCDK::Omics::CfnWorkflowProps.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(scope, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLkNvbnN0cnVjdCJ9")), "scope")
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfb21pY3MuQ2ZuV29ya2Zsb3dQcm9wcyJ9")), "props") unless props.nil?
  Jsii::Object.instance_method(:initialize).bind(self).call(scope, id, props)
end

Class Method Details

.arn_for_workflow(resource) ⇒ String

Parameters:

Returns:

  • (String) 


102
103
104
105
 
# File 'omics/cfn_workflow.rb', line 102

def self.arn_for_workflow(resource)
  Jsii::Type.check_type(resource, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19vbWljcy5JV29ya2Zsb3dSZWYifQ==")), "resource")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_omics.CfnWorkflow", "arnForWorkflow", [resource])
end

.CFN_RESOURCE_TYPE_NAME ⇒ String

The CloudFormation resource type name for this resource class.

Returns:

  • (String) 


209
210
211
 
# File 'omics/cfn_workflow.rb', line 209

def self.CFN_RESOURCE_TYPE_NAME()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_omics.CfnWorkflow", "CFN_RESOURCE_TYPE_NAME")
end

.is_cfn_workflow(x) ⇒ Boolean

Checks whether the given object is a CfnWorkflow.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


111
112
113
114
 
# File 'omics/cfn_workflow.rb', line 111

def self.is_cfn_workflow(x)
  Jsii::Type.check_type(x, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "x")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_omics.CfnWorkflow", "isCfnWorkflow", [x])
end

.jsii_overridable_methods ⇒ Object 



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
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
 
# File 'omics/cfn_workflow.rb', line 34

def self.jsii_overridable_methods
  {
    :node => { kind: :property, name: "node", is_optional: false },
    :creation_stack => { kind: :property, name: "creationStack", is_optional: false },
    :logical_id => { kind: :property, name: "logicalId", is_optional: false },
    :stack => { kind: :property, name: "stack", is_optional: false },
    :ref => { kind: :property, name: "ref", is_optional: false },
    :cfn_options => { kind: :property, name: "cfnOptions", is_optional: false },
    :cfn_properties => { kind: :property, name: "cfnProperties", is_optional: false },
    :cfn_property_names => { kind: :property, name: "cfnPropertyNames", is_optional: false },
    :cfn_resource_type => { kind: :property, name: "cfnResourceType", is_optional: false },
    :env => { kind: :property, name: "env", is_optional: false },
    :updated_properites => { kind: :property, name: "updatedProperites", is_optional: false },
    :updated_properties => { kind: :property, name: "updatedProperties", is_optional: false },
    :attr_arn => { kind: :property, name: "attrArn", is_optional: false },
    :attr_creation_time => { kind: :property, name: "attrCreationTime", is_optional: false },
    :attr_id => { kind: :property, name: "attrId", is_optional: false },
    :attr_status => { kind: :property, name: "attrStatus", is_optional: false },
    :attr_type => { kind: :property, name: "attrType", is_optional: false },
    :attr_uuid => { kind: :property, name: "attrUuid", is_optional: false },
    :tags => { kind: :property, name: "tags", is_optional: false },
    :workflow_ref => { kind: :property, name: "workflowRef", is_optional: false },
    :accelerators => { kind: :property, name: "accelerators", is_optional: true },
    :container_registry_map => { kind: :property, name: "containerRegistryMap", is_optional: true },
    :container_registry_map_uri => { kind: :property, name: "containerRegistryMapUri", is_optional: true },
    :definition_repository => { kind: :property, name: "definitionRepository", is_optional: true },
    :definition_uri => { kind: :property, name: "definitionUri", is_optional: true },
    :description => { kind: :property, name: "description", is_optional: true },
    :engine => { kind: :property, name: "engine", is_optional: true },
    :main => { kind: :property, name: "main", is_optional: true },
    :name => { kind: :property, name: "name", is_optional: true },
    :parameter_template => { kind: :property, name: "parameterTemplate", is_optional: true },
    :parameter_template_path => { kind: :property, name: "parameterTemplatePath", is_optional: true },
    :readme_markdown => { kind: :property, name: "readmeMarkdown", is_optional: true },
    :readme_path => { kind: :property, name: "readmePath", is_optional: true },
    :readme_uri => { kind: :property, name: "readmeUri", is_optional: true },
    :storage_capacity => { kind: :property, name: "storageCapacity", is_optional: true },
    :storage_type => { kind: :property, name: "storageType", is_optional: true },
    :tags_raw => { kind: :property, name: "tagsRaw", is_optional: true },
    :workflow_bucket_owner_id => { kind: :property, name: "workflowBucketOwnerId", is_optional: true },
    :to_string => { kind: :method, name: "toString", is_optional: false },
    :with => { kind: :method, name: "with", is_optional: false },
    :override_logical_id => { kind: :method, name: "overrideLogicalId", is_optional: false },
    :add_deletion_override => { kind: :method, name: "addDeletionOverride", is_optional: false },
    :add_dependency => { kind: :method, name: "addDependency", is_optional: false },
    :add_depends_on => { kind: :method, name: "addDependsOn", is_optional: false },
    :add_metadata => { kind: :method, name: "addMetadata", is_optional: false },
    :add_override => { kind: :method, name: "addOverride", is_optional: false },
    :add_property_deletion_override => { kind: :method, name: "addPropertyDeletionOverride", is_optional: false },
    :add_property_override => { kind: :method, name: "addPropertyOverride", is_optional: false },
    :apply_cross_stack_reference_strength => { kind: :method, name: "applyCrossStackReferenceStrength", is_optional: false },
    :apply_removal_policy => { kind: :method, name: "applyRemovalPolicy", is_optional: false },
    :cfn_property_name => { kind: :method, name: "cfnPropertyName", is_optional: false },
    :get_att => { kind: :method, name: "getAtt", is_optional: false },
    :get_metadata => { kind: :method, name: "getMetadata", is_optional: false },
    :obtain_dependencies => { kind: :method, name: "obtainDependencies", is_optional: false },
    :obtain_resource_dependencies => { kind: :method, name: "obtainResourceDependencies", is_optional: false },
    :remove_dependency => { kind: :method, name: "removeDependency", is_optional: false },
    :render_properties => { kind: :method, name: "renderProperties", is_optional: false },
    :replace_dependency => { kind: :method, name: "replaceDependency", is_optional: false },
    :should_synthesize => { kind: :method, name: "shouldSynthesize", is_optional: false },
    :validate_properties => { kind: :method, name: "validateProperties", is_optional: false },
    :inspect => { kind: :method, name: "inspect", is_optional: false },
  }
end

Instance Method Details

#accelerators ⇒ String?

Returns:

  • (String, nil) 


268
269
270
 
# File 'omics/cfn_workflow.rb', line 268

def accelerators()
  jsii_get_property("accelerators")
end

#accelerators=(value) ⇒ Object 



272
273
274
275
 
# File 'omics/cfn_workflow.rb', line 272

def accelerators=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "accelerators") unless value.nil?
  jsii_set_property("accelerators", value)
end

#add_deletion_override(path) ⇒ void

This method returns an undefined value.

Syntactic sugar for addOverride(path, undefined).

Parameters:

  • path (String) —

    The path of the value to delete.



515
516
517
518
 
# File 'omics/cfn_workflow.rb', line 515

def add_deletion_override(path)
  Jsii::Type.check_type(path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "path")
  jsii_call_method("addDeletionOverride", [path])
end

#add_dependency(target) ⇒ void

This method returns an undefined value.

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Parameters:



527
528
529
530
 
# File 'omics/cfn_workflow.rb', line 527

def add_dependency(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("addDependency", [target])
end

#add_depends_on(target) ⇒ void

Deprecated.

use addDependency

This method returns an undefined value.

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

Parameters:



537
538
539
540
 
# File 'omics/cfn_workflow.rb', line 537

def add_depends_on(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("addDependsOn", [target])
end

#add_metadata(key, value) ⇒ void

This method returns an undefined value.

Add a value to the CloudFormation Resource Metadata.

Parameters:

  • key (String)
  • value (Object)

See Also:



548
549
550
551
552
 
# File 'omics/cfn_workflow.rb', line 548

def add_metadata(key, value)
  Jsii::Type.check_type(key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "key")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addMetadata", [key, value])
end

#add_override(path, value) ⇒ void

This method returns an undefined value.

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use add_property_override or prefix path with "Properties." (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example,

# Example automatically generated from non-compiling source. May contain errors.
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to add_override will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

Parameters:

  • path (String) —
    • The path of the property, you can use dot notation to override values in complex types.
  • value (Object) —
    • The value.


605
606
607
608
609
 
# File 'omics/cfn_workflow.rb', line 605

def add_override(path, value)
  Jsii::Type.check_type(path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "path")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addOverride", [path, value])
end

#add_property_deletion_override(property_path) ⇒ void

This method returns an undefined value.

Adds an override that deletes the value of a property from the resource definition.

Parameters:

  • property_path (String) —

    The path to the property.



615
616
617
618
 
# File 'omics/cfn_workflow.rb', line 615

def add_property_deletion_override(property_path)
  Jsii::Type.check_type(property_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "propertyPath")
  jsii_call_method("addPropertyDeletionOverride", [property_path])
end

#add_property_override(property_path, value) ⇒ void

This method returns an undefined value.

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters:

  • property_path (String) —

    The path of the property.

  • value (Object) —

    The value.



627
628
629
630
631
 
# File 'omics/cfn_workflow.rb', line 627

def add_property_override(property_path, value)
  Jsii::Type.check_type(property_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "propertyPath")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addPropertyOverride", [property_path, value])
end

#apply_cross_stack_reference_strength(strength) ⇒ void

This method returns an undefined value.

Sets the cross-stack reference strength for this resource.

When set, any cross-stack reference to this resource will use the specified strength instead of the global default from the consuming stack's context.

Parameters:



640
641
642
643
 
# File 'omics/cfn_workflow.rb', line 640

def apply_cross_stack_reference_strength(strength)
  Jsii::Type.check_type(strength, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZWZlcmVuY2VTdHJlbmd0aCJ9")), "strength")
  jsii_call_method("applyCrossStackReferenceStrength", [strength])
end

#apply_removal_policy(policy = nil, options = nil) ⇒ void

This method returns an undefined value.

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

Parameters:

See Also:



662
663
664
665
666
667
 
# File 'omics/cfn_workflow.rb', line 662

def apply_removal_policy(policy = nil, options = nil)
  Jsii::Type.check_type(policy, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5In0=")), "policy") unless policy.nil?
  options = options.is_a?(Hash) ? ::AWSCDK::RemovalPolicyOptions.new(**options.transform_keys(&:to_sym)) : options
  Jsii::Type.check_type(options, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5T3B0aW9ucyJ9")), "options") unless options.nil?
  jsii_call_method("applyRemovalPolicy", [policy, options])
end

#attr_arn ⇒ String

The ARN for the workflow.

Returns:

  • (String) 


216
217
218
 
# File 'omics/cfn_workflow.rb', line 216

def attr_arn()
  jsii_get_property("attrArn")
end

#attr_creation_time ⇒ String

When the workflow was created.

Returns:

  • (String) 


223
224
225
 
# File 'omics/cfn_workflow.rb', line 223

def attr_creation_time()
  jsii_get_property("attrCreationTime")
end

#attr_id ⇒ String

The workflow's ID.

Returns:

  • (String) 


230
231
232
 
# File 'omics/cfn_workflow.rb', line 230

def attr_id()
  jsii_get_property("attrId")
end

#attr_status ⇒ String

The workflow's status.

Returns:

  • (String) 


237
238
239
 
# File 'omics/cfn_workflow.rb', line 237

def attr_status()
  jsii_get_property("attrStatus")
end

#attr_type ⇒ String

The workflow's type.

Returns:

  • (String) 


244
245
246
 
# File 'omics/cfn_workflow.rb', line 244

def attr_type()
  jsii_get_property("attrType")
end

#attr_uuid ⇒ String

Returns:

  • (String) 


249
250
251
 
# File 'omics/cfn_workflow.rb', line 249

def attr_uuid()
  jsii_get_property("attrUuid")
end

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

Options for this resource, such as condition, update policy etc.

Returns:



162
163
164
 
# File 'omics/cfn_workflow.rb', line 162

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


167
168
169
 
# File 'omics/cfn_workflow.rb', line 167

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


671
672
673
674
 
# File 'omics/cfn_workflow.rb', line 671

def cfn_property_name(cdk_property_name)
  Jsii::Type.check_type(cdk_property_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "cdkPropertyName")
  jsii_call_method("cfnPropertyName", [cdk_property_name])
end

#cfn_property_names ⇒ Hash{String => String}

Returns:

  • (Hash{String => String}) 


172
173
174
 
# File 'omics/cfn_workflow.rb', line 172

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


179
180
181
 
# File 'omics/cfn_workflow.rb', line 179

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#container_registry_map ⇒ AWSCDK::IResolvable, ...

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

Returns:



280
281
282
 
# File 'omics/cfn_workflow.rb', line 280

def container_registry_map()
  jsii_get_property("containerRegistryMap")
end

#container_registry_map=(value) ⇒ Object 



284
285
286
287
288
 
# File 'omics/cfn_workflow.rb', line 284

def container_registry_map=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::Omics::CfnWorkflow::ContainerRegistryMapProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19vbWljcy5DZm5Xb3JrZmxvdy5Db250YWluZXJSZWdpc3RyeU1hcFByb3BlcnR5In1dfX0=")), "containerRegistryMap") unless value.nil?
  jsii_set_property("containerRegistryMap", value)
end

#container_registry_map_uri ⇒ String?

Returns:

  • (String, nil) 


291
292
293
 
# File 'omics/cfn_workflow.rb', line 291

def container_registry_map_uri()
  jsii_get_property("containerRegistryMapUri")
end

#container_registry_map_uri=(value) ⇒ Object 



295
296
297
298
 
# File 'omics/cfn_workflow.rb', line 295

def container_registry_map_uri=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "containerRegistryMapUri") unless value.nil?
  jsii_set_property("containerRegistryMapUri", value)
end

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


124
125
126
 
# File 'omics/cfn_workflow.rb', line 124

def creation_stack()
  jsii_get_property("creationStack")
end

#definition_repository ⇒ AWSCDK::IResolvable, ...

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

Returns:



303
304
305
 
# File 'omics/cfn_workflow.rb', line 303

def definition_repository()
  jsii_get_property("definitionRepository")
end

#definition_repository=(value) ⇒ Object 



307
308
309
310
311
 
# File 'omics/cfn_workflow.rb', line 307

def definition_repository=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::Omics::CfnWorkflow::DefinitionRepositoryProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19vbWljcy5DZm5Xb3JrZmxvdy5EZWZpbml0aW9uUmVwb3NpdG9yeVByb3BlcnR5In1dfX0=")), "definitionRepository") unless value.nil?
  jsii_set_property("definitionRepository", value)
end

#definition_uri ⇒ String?

The URI of a definition for the workflow.

Returns:

  • (String, nil) 


316
317
318
 
# File 'omics/cfn_workflow.rb', line 316

def definition_uri()
  jsii_get_property("definitionUri")
end

#definition_uri=(value) ⇒ Object 



320
321
322
323
 
# File 'omics/cfn_workflow.rb', line 320

def definition_uri=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "definitionUri") unless value.nil?
  jsii_set_property("definitionUri", value)
end

#description ⇒ String?

The parameter's description.

Returns:

  • (String, nil) 


328
329
330
 
# File 'omics/cfn_workflow.rb', line 328

def description()
  jsii_get_property("description")
end

#description=(value) ⇒ Object 



332
333
334
335
 
# File 'omics/cfn_workflow.rb', line 332

def description=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "description") unless value.nil?
  jsii_set_property("description", value)
end

#engine ⇒ String?

An engine for the workflow.

Returns:

  • (String, nil) 


340
341
342
 
# File 'omics/cfn_workflow.rb', line 340

def engine()
  jsii_get_property("engine")
end

#engine=(value) ⇒ Object 



344
345
346
347
 
# File 'omics/cfn_workflow.rb', line 344

def engine=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "engine") unless value.nil?
  jsii_set_property("engine", value)
end

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



184
185
186
 
# File 'omics/cfn_workflow.rb', line 184

def env()
  jsii_get_property("env")
end

#get_att(attribute_name, type_hint = nil) ⇒ AWSCDK::Reference

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters:

Returns:



684
685
686
687
688
 
# File 'omics/cfn_workflow.rb', line 684

def get_att(attribute_name, type_hint = nil)
  Jsii::Type.check_type(attribute_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "attributeName")
  Jsii::Type.check_type(type_hint, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZXNvbHV0aW9uVHlwZUhpbnQifQ==")), "typeHint") unless type_hint.nil?
  jsii_call_method("getAtt", [attribute_name, type_hint])
end

#get_metadata(key) ⇒ Object

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters:

  • key (String)

Returns:

  • (Object)

See Also:



695
696
697
698
 
# File 'omics/cfn_workflow.rb', line 695

def get_metadata(key)
  Jsii::Type.check_type(key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "key")
  jsii_call_method("getMetadata", [key])
end

#inspect(inspector) ⇒ void

This method returns an undefined value.

Examines the CloudFormation resource and discloses attributes.

Parameters:



765
766
767
768
 
# File 'omics/cfn_workflow.rb', line 765

def inspect(inspector)
  Jsii::Type.check_type(inspector, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5UcmVlSW5zcGVjdG9yIn0=")), "inspector")
  jsii_call_method("inspect", [inspector])
end

#logical_id ⇒ String

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use override_logical_id(new_logical_id).

Returns:

  • (String) 


136
137
138
 
# File 'omics/cfn_workflow.rb', line 136

def logical_id()
  jsii_get_property("logicalId")
end

#main ⇒ String?

The path of the main definition file for the workflow.

Returns:

  • (String, nil) 


352
353
354
 
# File 'omics/cfn_workflow.rb', line 352

def main()
  jsii_get_property("main")
end

#main=(value) ⇒ Object 



356
357
358
359
 
# File 'omics/cfn_workflow.rb', line 356

def main=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "main") unless value.nil?
  jsii_set_property("main", value)
end

#name ⇒ String?

The workflow's name.

Returns:

  • (String, nil) 


364
365
366
 
# File 'omics/cfn_workflow.rb', line 364

def name()
  jsii_get_property("name")
end

#name=(value) ⇒ Object 



368
369
370
371
 
# File 'omics/cfn_workflow.rb', line 368

def name=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "name") unless value.nil?
  jsii_set_property("name", value)
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


119
120
121
 
# File 'omics/cfn_workflow.rb', line 119

def node()
  jsii_get_property("node")
end

#obtain_dependencies ⇒ Array<AWSCDK::CfnResource, AWSCDK::Stack>

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

Returns:



706
707
708
 
# File 'omics/cfn_workflow.rb', line 706

def obtain_dependencies()
  jsii_call_method("obtainDependencies", [])
end

#obtain_resource_dependencies ⇒ Array<AWSCDK::CfnResource>

Get a shallow copy of dependencies between this resource and other resources in the same stack.

Returns:



713
714
715
 
# File 'omics/cfn_workflow.rb', line 713

def obtain_resource_dependencies()
  jsii_call_method("obtainResourceDependencies", [])
end

#override_logical_id(new_logical_id) ⇒ void

This method returns an undefined value.

Overrides the auto-generated logical ID with a specific ID.

Parameters:

  • new_logical_id (String) —

    The new logical ID to use for this stack element.



506
507
508
509
 
# File 'omics/cfn_workflow.rb', line 506

def override_logical_id(new_logical_id)
  Jsii::Type.check_type(new_logical_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "newLogicalId")
  jsii_call_method("overrideLogicalId", [new_logical_id])
end

#parameter_template ⇒ AWSCDK::IResolvable, ...

The workflow's parameter template.

Returns:



376
377
378
 
# File 'omics/cfn_workflow.rb', line 376

def parameter_template()
  jsii_get_property("parameterTemplate")
end

#parameter_template=(value) ⇒ Object 



380
381
382
383
 
# File 'omics/cfn_workflow.rb', line 380

def parameter_template=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfb21pY3MuQ2ZuV29ya2Zsb3cuV29ya2Zsb3dQYXJhbWV0ZXJQcm9wZXJ0eSJ9XX19LCJraW5kIjoibWFwIn19XX19")), "parameterTemplate") unless value.nil?
  jsii_set_property("parameterTemplate", value)
end

#parameter_template_path ⇒ String?

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

Returns:

  • (String, nil) 


388
389
390
 
# File 'omics/cfn_workflow.rb', line 388

def parameter_template_path()
  jsii_get_property("parameterTemplatePath")
end

#parameter_template_path=(value) ⇒ Object 



392
393
394
395
 
# File 'omics/cfn_workflow.rb', line 392

def parameter_template_path=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "parameterTemplatePath") unless value.nil?
  jsii_set_property("parameterTemplatePath", value)
end

#readme_markdown ⇒ String?

The markdown content for the workflow's README file.

Returns:

  • (String, nil) 


400
401
402
 
# File 'omics/cfn_workflow.rb', line 400

def readme_markdown()
  jsii_get_property("readmeMarkdown")
end

#readme_markdown=(value) ⇒ Object 



404
405
406
407
 
# File 'omics/cfn_workflow.rb', line 404

def readme_markdown=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "readmeMarkdown") unless value.nil?
  jsii_set_property("readmeMarkdown", value)
end

#readme_path ⇒ String?

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

Returns:

  • (String, nil) 


412
413
414
 
# File 'omics/cfn_workflow.rb', line 412

def readme_path()
  jsii_get_property("readmePath")
end

#readme_path=(value) ⇒ Object 



416
417
418
419
 
# File 'omics/cfn_workflow.rb', line 416

def readme_path=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "readmePath") unless value.nil?
  jsii_set_property("readmePath", value)
end

#readme_uri ⇒ String?

The S3 URI of the README file for the workflow.

Returns:

  • (String, nil) 


424
425
426
 
# File 'omics/cfn_workflow.rb', line 424

def readme_uri()
  jsii_get_property("readmeUri")
end

#readme_uri=(value) ⇒ Object 



428
429
430
431
 
# File 'omics/cfn_workflow.rb', line 428

def readme_uri=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "readmeUri") unless value.nil?
  jsii_set_property("readmeUri", value)
end

#ref ⇒ String

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

Returns:

  • (String) 


155
156
157
 
# File 'omics/cfn_workflow.rb', line 155

def ref()
  jsii_get_property("ref")
end

#remove_dependency(target) ⇒ void

This method returns an undefined value.

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

Parameters:



724
725
726
727
 
# File 'omics/cfn_workflow.rb', line 724

def remove_dependency(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("removeDependency", [target])
end

#render_properties(props) ⇒ Hash{String => Object}

Parameters:

  • props (Hash{String => Object})

Returns:

  • (Hash{String => Object}) 


731
732
733
734
 
# File 'omics/cfn_workflow.rb', line 731

def render_properties(props)
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6ImFueSJ9LCJraW5kIjoibWFwIn19")), "props")
  jsii_call_method("renderProperties", [props])
end

#replace_dependency(target, new_target) ⇒ void

This method returns an undefined value.

Replaces one dependency with another.

Parameters:



741
742
743
744
745
 
# File 'omics/cfn_workflow.rb', line 741

def replace_dependency(target, new_target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  Jsii::Type.check_type(new_target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "newTarget")
  jsii_call_method("replaceDependency", [target, new_target])
end

#should_synthesize ⇒ Boolean

Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.

Returns:

  • (Boolean) —

    true if the resource should be included or false is the resource should be omitted.



750
751
752
 
# File 'omics/cfn_workflow.rb', line 750

def should_synthesize()
  jsii_call_method("shouldSynthesize", [])
end

#stack ⇒ AWSCDK::Stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

Returns:



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

def stack()
  jsii_get_property("stack")
end

#storage_capacity ⇒ Numeric?

The default static storage capacity (in gibibytes) for runs that use this workflow or workflow version.

Returns:

  • (Numeric, nil) 


436
437
438
 
# File 'omics/cfn_workflow.rb', line 436

def storage_capacity()
  jsii_get_property("storageCapacity")
end

#storage_capacity=(value) ⇒ Object 



440
441
442
443
 
# File 'omics/cfn_workflow.rb', line 440

def storage_capacity=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "storageCapacity") unless value.nil?
  jsii_set_property("storageCapacity", value)
end

#storage_type ⇒ String?

Returns:

  • (String, nil) 


446
447
448
 
# File 'omics/cfn_workflow.rb', line 446

def storage_type()
  jsii_get_property("storageType")
end

#storage_type=(value) ⇒ Object 



450
451
452
453
 
# File 'omics/cfn_workflow.rb', line 450

def storage_type=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "storageType") unless value.nil?
  jsii_set_property("storageType", value)
end

#tags ⇒ AWSCDK::TagManager

Tag Manager which manages the tags for this resource.

Returns:



256
257
258
 
# File 'omics/cfn_workflow.rb', line 256

def tags()
  jsii_get_property("tags")
end

#tags_raw ⇒ Hash{String => String}?

Tags for the workflow.

Returns:

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


458
459
460
 
# File 'omics/cfn_workflow.rb', line 458

def tags_raw()
  jsii_get_property("tagsRaw")
end

#tags_raw=(value) ⇒ Object 



462
463
464
465
 
# File 'omics/cfn_workflow.rb', line 462

def tags_raw=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoibWFwIn19")), "tagsRaw") unless value.nil?
  jsii_set_property("tagsRaw", value)
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) —

    a string representation of this resource



482
483
484
 
# File 'omics/cfn_workflow.rb', line 482

def to_string()
  jsii_call_method("toString", [])
end

#updated_properites ⇒ Hash{String => Object}

Deprecated.

use updatedProperties Return properties modified after initiation Resources that expose mutable properties should override this function to collect and return the properties object for this resource.

Deprecated.

Returns:

  • (Hash{String => Object}) 


192
193
194
 
# File 'omics/cfn_workflow.rb', line 192

def updated_properites()
  jsii_get_property("updatedProperites")
end

#updated_properties ⇒ Hash{String => Object}

Return properties modified after initiation.

Resources that expose mutable properties should override this function to collect and return the properties object for this resource.

Returns:

  • (Hash{String => Object}) 


202
203
204
 
# File 'omics/cfn_workflow.rb', line 202

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


756
757
758
759
 
# File 'omics/cfn_workflow.rb', line 756

def validate_properties(_properties)
  Jsii::Type.check_type(_properties, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "_properties")
  jsii_call_method("validateProperties", [_properties])
end

#with(*mixins) ⇒ Constructs::IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

Parameters:

  • mixins (Array<Constructs::IMixin>)

Returns:

  • (Constructs::IConstruct) 


495
496
497
498
499
500
 
# File 'omics/cfn_workflow.rb', line 495

def with(*mixins)
  mixins.each_with_index do |item, index|
    Jsii::Type.check_type(item, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLklNaXhpbiJ9")), "mixins[#{index}]")
  end
  jsii_call_method("with", [*mixins])
end

#workflow_bucket_owner_id ⇒ String?

Optional workflow bucket owner ID to verify the workflow bucket.

Returns:

  • (String, nil) 


470
471
472
 
# File 'omics/cfn_workflow.rb', line 470

def workflow_bucket_owner_id()
  jsii_get_property("workflowBucketOwnerId")
end

#workflow_bucket_owner_id=(value) ⇒ Object 



474
475
476
477
 
# File 'omics/cfn_workflow.rb', line 474

def workflow_bucket_owner_id=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "workflowBucketOwnerId") unless value.nil?
  jsii_set_property("workflowBucketOwnerId", value)
end

#workflow_ref ⇒ AWSCDK::Interfaces::AWSOmics::WorkflowReference

A reference to a Workflow resource.

Returns:



263
264
265
 
# File 'omics/cfn_workflow.rb', line 263

def workflow_ref()
  jsii_get_property("workflowRef")
end