Class: AWSCDK::Omics::CfnWorkflowVersion

Inherits:
CfnResource
  • Object
show all
Includes:
IInspectable, ITaggableV2, Interfaces::AWSOmics::IWorkflowVersionRef
Defined in:
omics/cfn_workflow_version.rb

Overview

Creates a new workflow version for the workflow that you specify with the workflowId parameter.

When you create a new version of a workflow, you need to specify the configuration for the new version. It doesn't inherit any configuration values from the workflow.

Provide a version name that is unique for this workflow. You cannot change the name after HealthOmics creates the version.

Don't include any personally identifiable information (PII) in the version name. Version names appear in the workflow version ARN.

For more information, see Workflow versioning 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) ⇒ CfnWorkflowVersion

Create a new AWS::Omics::WorkflowVersion.

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::CfnWorkflowVersionProps) —

    Resource properties.



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

def initialize(scope, id, props)
  props = props.is_a?(Hash) ? ::AWSCDK::Omics::CfnWorkflowVersionProps.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("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfb21pY3MuQ2ZuV29ya2Zsb3dWZXJzaW9uUHJvcHMifQ==")), "props")
  Jsii::Object.instance_method(:initialize).bind(self).call(scope, id, props)
end

Class Method Details

.arn_for_workflow_version(resource) ⇒ String

Parameters:

Returns:

  • (String) 


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

def self.arn_for_workflow_version(resource)
  Jsii::Type.check_type(resource, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19vbWljcy5JV29ya2Zsb3dWZXJzaW9uUmVmIn0=")), "resource")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_omics.CfnWorkflowVersion", "arnForWorkflowVersion", [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_version.rb', line 209

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

.is_cfn_workflow_version(x) ⇒ Boolean

Checks whether the given object is a CfnWorkflowVersion.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


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

def self.is_cfn_workflow_version(x)
  Jsii::Type.check_type(x, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "x")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_omics.CfnWorkflowVersion", "isCfnWorkflowVersion", [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_version.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_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 },
    :cdk_tag_manager => { kind: :property, name: "cdkTagManager", is_optional: false },
    :workflow_version_ref => { kind: :property, name: "workflowVersionRef", is_optional: false },
    :version_name => { kind: :property, name: "versionName", is_optional: false },
    :workflow_id => { kind: :property, name: "workflowId", 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 },
    :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 => { kind: :property, name: "tags", 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) 


285
286
287
 
# File 'omics/cfn_workflow_version.rb', line 285

def accelerators()
  jsii_get_property("accelerators")
end

#accelerators=(value) ⇒ Object 



289
290
291
292
 
# File 'omics/cfn_workflow_version.rb', line 289

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.



508
509
510
511
 
# File 'omics/cfn_workflow_version.rb', line 508

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:



520
521
522
523
 
# File 'omics/cfn_workflow_version.rb', line 520

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:



530
531
532
533
 
# File 'omics/cfn_workflow_version.rb', line 530

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:



541
542
543
544
545
 
# File 'omics/cfn_workflow_version.rb', line 541

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.


598
599
600
601
602
 
# File 'omics/cfn_workflow_version.rb', line 598

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.



608
609
610
611
 
# File 'omics/cfn_workflow_version.rb', line 608

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.



620
621
622
623
624
 
# File 'omics/cfn_workflow_version.rb', line 620

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:



633
634
635
636
 
# File 'omics/cfn_workflow_version.rb', line 633

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:



655
656
657
658
659
660
 
# File 'omics/cfn_workflow_version.rb', line 655

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

ARN of the workflow version.

Returns:

  • (String) 


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

def attr_arn()
  jsii_get_property("attrArn")
end

#attr_creation_time ⇒ String

The creation time of the workflow version.

Returns:

  • (String) 


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

def attr_creation_time()
  jsii_get_property("attrCreationTime")
end

#attr_status ⇒ String

The status of the workflow version.

Returns:

  • (String) 


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

def attr_status()
  jsii_get_property("attrStatus")
end

#attr_type ⇒ String

The type of the workflow version.

Returns:

  • (String) 


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

def attr_type()
  jsii_get_property("attrType")
end

#attr_uuid ⇒ String

Returns:

  • (String) 


242
243
244
 
# File 'omics/cfn_workflow_version.rb', line 242

def attr_uuid()
  jsii_get_property("attrUuid")
end

#cdk_tag_manager ⇒ AWSCDK::TagManager

Tag Manager which manages the tags for this resource.

Returns:



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

def cdk_tag_manager()
  jsii_get_property("cdkTagManager")
end

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

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

Returns:



162
163
164
 
# File 'omics/cfn_workflow_version.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_version.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) 


664
665
666
667
 
# File 'omics/cfn_workflow_version.rb', line 664

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_version.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_version.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:



297
298
299
 
# File 'omics/cfn_workflow_version.rb', line 297

def container_registry_map()
  jsii_get_property("containerRegistryMap")
end

#container_registry_map=(value) ⇒ Object 



301
302
303
304
305
 
# File 'omics/cfn_workflow_version.rb', line 301

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

#container_registry_map_uri ⇒ String?

Returns:

  • (String, nil) 


308
309
310
 
# File 'omics/cfn_workflow_version.rb', line 308

def container_registry_map_uri()
  jsii_get_property("containerRegistryMapUri")
end

#container_registry_map_uri=(value) ⇒ Object 



312
313
314
315
 
# File 'omics/cfn_workflow_version.rb', line 312

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_version.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:



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

def definition_repository()
  jsii_get_property("definitionRepository")
end

#definition_repository=(value) ⇒ Object 



324
325
326
327
328
 
# File 'omics/cfn_workflow_version.rb', line 324

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

#definition_uri ⇒ String?

Returns:

  • (String, nil) 


331
332
333
 
# File 'omics/cfn_workflow_version.rb', line 331

def definition_uri()
  jsii_get_property("definitionUri")
end

#definition_uri=(value) ⇒ Object 



335
336
337
338
 
# File 'omics/cfn_workflow_version.rb', line 335

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 description of the workflow version.

Returns:

  • (String, nil) 


343
344
345
 
# File 'omics/cfn_workflow_version.rb', line 343

def description()
  jsii_get_property("description")
end

#description=(value) ⇒ Object 



347
348
349
350
 
# File 'omics/cfn_workflow_version.rb', line 347

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?

Returns:

  • (String, nil) 


353
354
355
 
# File 'omics/cfn_workflow_version.rb', line 353

def engine()
  jsii_get_property("engine")
end

#engine=(value) ⇒ Object 



357
358
359
360
 
# File 'omics/cfn_workflow_version.rb', line 357

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_version.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:



677
678
679
680
681
 
# File 'omics/cfn_workflow_version.rb', line 677

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:



688
689
690
691
 
# File 'omics/cfn_workflow_version.rb', line 688

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:



758
759
760
761
 
# File 'omics/cfn_workflow_version.rb', line 758

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_version.rb', line 136

def logical_id()
  jsii_get_property("logicalId")
end

#main ⇒ String?

Returns:

  • (String, nil) 


363
364
365
 
# File 'omics/cfn_workflow_version.rb', line 363

def main()
  jsii_get_property("main")
end

#main=(value) ⇒ Object 



367
368
369
370
 
# File 'omics/cfn_workflow_version.rb', line 367

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

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


119
120
121
 
# File 'omics/cfn_workflow_version.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:



699
700
701
 
# File 'omics/cfn_workflow_version.rb', line 699

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:



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

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.



499
500
501
502
 
# File 'omics/cfn_workflow_version.rb', line 499

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, ...

Returns:



373
374
375
 
# File 'omics/cfn_workflow_version.rb', line 373

def parameter_template()
  jsii_get_property("parameterTemplate")
end

#parameter_template=(value) ⇒ Object 



377
378
379
380
 
# File 'omics/cfn_workflow_version.rb', line 377

def parameter_template=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfb21pY3MuQ2ZuV29ya2Zsb3dWZXJzaW9uLldvcmtmbG93UGFyYW1ldGVyUHJvcGVydHkifV19fSwia2luZCI6Im1hcCJ9fV19fQ==")), "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) 


385
386
387
 
# File 'omics/cfn_workflow_version.rb', line 385

def parameter_template_path()
  jsii_get_property("parameterTemplatePath")
end

#parameter_template_path=(value) ⇒ Object 



389
390
391
392
 
# File 'omics/cfn_workflow_version.rb', line 389

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) 


397
398
399
 
# File 'omics/cfn_workflow_version.rb', line 397

def readme_markdown()
  jsii_get_property("readmeMarkdown")
end

#readme_markdown=(value) ⇒ Object 



401
402
403
404
 
# File 'omics/cfn_workflow_version.rb', line 401

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) 


409
410
411
 
# File 'omics/cfn_workflow_version.rb', line 409

def readme_path()
  jsii_get_property("readmePath")
end

#readme_path=(value) ⇒ Object 



413
414
415
416
 
# File 'omics/cfn_workflow_version.rb', line 413

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) 


421
422
423
 
# File 'omics/cfn_workflow_version.rb', line 421

def readme_uri()
  jsii_get_property("readmeUri")
end

#readme_uri=(value) ⇒ Object 



425
426
427
428
 
# File 'omics/cfn_workflow_version.rb', line 425

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_version.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:



717
718
719
720
 
# File 'omics/cfn_workflow_version.rb', line 717

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


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

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:



734
735
736
737
738
 
# File 'omics/cfn_workflow_version.rb', line 734

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.



743
744
745
 
# File 'omics/cfn_workflow_version.rb', line 743

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_version.rb', line 145

def stack()
  jsii_get_property("stack")
end

#storage_capacity ⇒ Numeric?

Returns:

  • (Numeric, nil) 


431
432
433
 
# File 'omics/cfn_workflow_version.rb', line 431

def storage_capacity()
  jsii_get_property("storageCapacity")
end

#storage_capacity=(value) ⇒ Object 



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

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) 


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

def storage_type()
  jsii_get_property("storageType")
end

#storage_type=(value) ⇒ Object 



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

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 ⇒ Hash{String => String}?

A map of resource tags.

Returns:

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


453
454
455
 
# File 'omics/cfn_workflow_version.rb', line 453

def tags()
  jsii_get_property("tags")
end

#tags=(value) ⇒ Object 



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

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

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) —

    a string representation of this resource



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

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_version.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_version.rb', line 202

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


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

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

#version_name ⇒ String

The name of the workflow version.

Returns:

  • (String) 


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

def version_name()
  jsii_get_property("versionName")
end

#version_name=(value) ⇒ Object 



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

def version_name=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "versionName")
  jsii_set_property("versionName", value)
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) 


488
489
490
491
492
493
 
# File 'omics/cfn_workflow_version.rb', line 488

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?

Returns:

  • (String, nil) 


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

def workflow_bucket_owner_id()
  jsii_get_property("workflowBucketOwnerId")
end

#workflow_bucket_owner_id=(value) ⇒ Object 



467
468
469
470
 
# File 'omics/cfn_workflow_version.rb', line 467

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_id ⇒ String

The workflow's ID.

Returns:

  • (String) 


275
276
277
 
# File 'omics/cfn_workflow_version.rb', line 275

def workflow_id()
  jsii_get_property("workflowId")
end

#workflow_id=(value) ⇒ Object 



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

def workflow_id=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "workflowId")
  jsii_set_property("workflowId", value)
end

#workflow_version_ref ⇒ AWSCDK::Interfaces::AWSOmics::WorkflowVersionReference

A reference to a WorkflowVersion resource.

Returns:



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

def workflow_version_ref()
  jsii_get_property("workflowVersionRef")
end