Class: AWSCDK::EntityResolution::CfnMatchingWorkflow

Inherits:
CfnResource
  • Object
show all
Includes:
IInspectable, ITaggableV2, Interfaces::AWSEntityresolution::IMatchingWorkflowRef
Defined in:
entity_resolution/cfn_matching_workflow.rb

Overview

Creates a matching workflow that defines the configuration for a data processing job.

The workflow name must be unique. To modify an existing workflow, use UpdateMatchingWorkflow .

For workflows where resolution_type is ML_MATCHING or PROVIDER , incremental processing is not supported.

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ CfnMatchingWorkflow

Create a new AWS::EntityResolution::MatchingWorkflow.

Parameters:



22
23
24
25
26
27
28
# File 'entity_resolution/cfn_matching_workflow.rb', line 22

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

Class Method Details

.arn_for_matching_workflow(resource) ⇒ String

Parameters:

Returns:

  • (String)


85
86
87
88
# File 'entity_resolution/cfn_matching_workflow.rb', line 85

def self.arn_for_matching_workflow(resource)
  Jsii::Type.check_type(resource, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19lbnRpdHlyZXNvbHV0aW9uLklNYXRjaGluZ1dvcmtmbG93UmVmIn0=")), "resource")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_entityresolution.CfnMatchingWorkflow", "arnForMatchingWorkflow", [resource])
end

.CFN_RESOURCE_TYPE_NAMEString

The CloudFormation resource type name for this resource class.

Returns:

  • (String)


205
206
207
# File 'entity_resolution/cfn_matching_workflow.rb', line 205

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

.from_workflow_name(scope, id, workflow_name) ⇒ AWSCDK::Interfaces::AWSEntityresolution::IMatchingWorkflowRef

Creates a new IMatchingWorkflowRef from a workflowName.

Parameters:

  • scope (Constructs::Construct)
  • id (String)
  • workflow_name (String)

Returns:



96
97
98
99
100
101
# File 'entity_resolution/cfn_matching_workflow.rb', line 96

def self.from_workflow_name(scope, id, workflow_name)
  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(workflow_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "workflowName")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_entityresolution.CfnMatchingWorkflow", "fromWorkflowName", [scope, id, workflow_name])
end

.is_cfn_matching_workflow(x) ⇒ Boolean

Checks whether the given object is a CfnMatchingWorkflow.

Parameters:

  • x (Object)

Returns:

  • (Boolean)


107
108
109
110
# File 'entity_resolution/cfn_matching_workflow.rb', line 107

def self.is_cfn_matching_workflow(x)
  Jsii::Type.check_type(x, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "x")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_entityresolution.CfnMatchingWorkflow", "isCfnMatchingWorkflow", [x])
end

.jsii_overridable_methodsObject



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
68
69
70
71
72
73
74
75
76
77
78
79
80
81
# File 'entity_resolution/cfn_matching_workflow.rb', line 30

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_created_at => { kind: :property, name: "attrCreatedAt", is_optional: false },
    :attr_updated_at => { kind: :property, name: "attrUpdatedAt", is_optional: false },
    :attr_workflow_arn => { kind: :property, name: "attrWorkflowArn", is_optional: false },
    :cdk_tag_manager => { kind: :property, name: "cdkTagManager", is_optional: false },
    :matching_workflow_ref => { kind: :property, name: "matchingWorkflowRef", is_optional: false },
    :input_source_config => { kind: :property, name: "inputSourceConfig", is_optional: false },
    :output_source_config => { kind: :property, name: "outputSourceConfig", is_optional: false },
    :resolution_techniques => { kind: :property, name: "resolutionTechniques", is_optional: false },
    :role_arn => { kind: :property, name: "roleArn", is_optional: false },
    :workflow_name => { kind: :property, name: "workflowName", is_optional: false },
    :description => { kind: :property, name: "description", is_optional: true },
    :incremental_run_config => { kind: :property, name: "incrementalRunConfig", is_optional: true },
    :tags => { kind: :property, name: "tags", 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

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



379
380
381
382
# File 'entity_resolution/cfn_matching_workflow.rb', line 379

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:



391
392
393
394
# File 'entity_resolution/cfn_matching_workflow.rb', line 391

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:



401
402
403
404
# File 'entity_resolution/cfn_matching_workflow.rb', line 401

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.



412
413
414
415
416
# File 'entity_resolution/cfn_matching_workflow.rb', line 412

def (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.


469
470
471
472
473
# File 'entity_resolution/cfn_matching_workflow.rb', line 469

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.



479
480
481
482
# File 'entity_resolution/cfn_matching_workflow.rb', line 479

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.



491
492
493
494
495
# File 'entity_resolution/cfn_matching_workflow.rb', line 491

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:



504
505
506
507
# File 'entity_resolution/cfn_matching_workflow.rb', line 504

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:



526
527
528
529
530
531
# File 'entity_resolution/cfn_matching_workflow.rb', line 526

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_created_atString

The time of this MatchingWorkflow got created.

Returns:

  • (String)


212
213
214
# File 'entity_resolution/cfn_matching_workflow.rb', line 212

def attr_created_at()
  jsii_get_property("attrCreatedAt")
end

#attr_updated_atString

The time of this MatchingWorkflow got last updated at.

Returns:

  • (String)


219
220
221
# File 'entity_resolution/cfn_matching_workflow.rb', line 219

def attr_updated_at()
  jsii_get_property("attrUpdatedAt")
end

#attr_workflow_arnString

The default MatchingWorkflow arn.

Returns:

  • (String)


226
227
228
# File 'entity_resolution/cfn_matching_workflow.rb', line 226

def attr_workflow_arn()
  jsii_get_property("attrWorkflowArn")
end

#cdk_tag_managerAWSCDK::TagManager

Tag Manager which manages the tags for this resource.

Returns:



233
234
235
# File 'entity_resolution/cfn_matching_workflow.rb', line 233

def cdk_tag_manager()
  jsii_get_property("cdkTagManager")
end

#cfn_optionsAWSCDK::ICfnResourceOptions

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



158
159
160
# File 'entity_resolution/cfn_matching_workflow.rb', line 158

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_propertiesHash{String => Object}

Returns:

  • (Hash{String => Object})


163
164
165
# File 'entity_resolution/cfn_matching_workflow.rb', line 163

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil)


535
536
537
538
# File 'entity_resolution/cfn_matching_workflow.rb', line 535

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_namesHash{String => String}

Returns:

  • (Hash{String => String})


168
169
170
# File 'entity_resolution/cfn_matching_workflow.rb', line 168

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_typeString

AWS resource type.

Returns:

  • (String)


175
176
177
# File 'entity_resolution/cfn_matching_workflow.rb', line 175

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#creation_stackArray<String>

Returns:

  • (Array<String>)


120
121
122
# File 'entity_resolution/cfn_matching_workflow.rb', line 120

def creation_stack()
  jsii_get_property("creationStack")
end

#descriptionString?

A description of the workflow.

Returns:

  • (String, nil)


308
309
310
# File 'entity_resolution/cfn_matching_workflow.rb', line 308

def description()
  jsii_get_property("description")
end

#description=(value) ⇒ Object



312
313
314
315
# File 'entity_resolution/cfn_matching_workflow.rb', line 312

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

#envAWSCDK::Interfaces::ResourceEnvironment



180
181
182
# File 'entity_resolution/cfn_matching_workflow.rb', line 180

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:



548
549
550
551
552
# File 'entity_resolution/cfn_matching_workflow.rb', line 548

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.



559
560
561
562
# File 'entity_resolution/cfn_matching_workflow.rb', line 559

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

#incremental_run_configAWSCDK::IResolvable, ...

Optional.



320
321
322
# File 'entity_resolution/cfn_matching_workflow.rb', line 320

def incremental_run_config()
  jsii_get_property("incrementalRunConfig")
end

#incremental_run_config=(value) ⇒ Object



324
325
326
327
328
# File 'entity_resolution/cfn_matching_workflow.rb', line 324

def incremental_run_config=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::EntityResolution::CfnMatchingWorkflow::IncrementalRunConfigProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19lbnRpdHlyZXNvbHV0aW9uLkNmbk1hdGNoaW5nV29ya2Zsb3cuSW5jcmVtZW50YWxSdW5Db25maWdQcm9wZXJ0eSJ9XX19")), "incrementalRunConfig") unless value.nil?
  jsii_set_property("incrementalRunConfig", value)
end

#input_source_configAWSCDK::IResolvable, Array<AWSCDK::IResolvable, AWSCDK::EntityResolution::CfnMatchingWorkflow::InputSourceProperty>

A list of InputSource objects, which have the fields InputSourceARN and SchemaName .



247
248
249
# File 'entity_resolution/cfn_matching_workflow.rb', line 247

def input_source_config()
  jsii_get_property("inputSourceConfig")
end

#input_source_config=(value) ⇒ Object



251
252
253
254
# File 'entity_resolution/cfn_matching_workflow.rb', line 251

def input_source_config=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZW50aXR5cmVzb2x1dGlvbi5DZm5NYXRjaGluZ1dvcmtmbG93LklucHV0U291cmNlUHJvcGVydHkifV19fSwia2luZCI6ImFycmF5In19XX19")), "inputSourceConfig")
  jsii_set_property("inputSourceConfig", value)
end

#inspect(inspector) ⇒ void

This method returns an undefined value.

Examines the CloudFormation resource and discloses attributes.

Parameters:



629
630
631
632
# File 'entity_resolution/cfn_matching_workflow.rb', line 629

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

#logical_idString

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)


132
133
134
# File 'entity_resolution/cfn_matching_workflow.rb', line 132

def logical_id()
  jsii_get_property("logicalId")
end

#matching_workflow_refAWSCDK::Interfaces::AWSEntityresolution::MatchingWorkflowReference

A reference to a MatchingWorkflow resource.



240
241
242
# File 'entity_resolution/cfn_matching_workflow.rb', line 240

def matching_workflow_ref()
  jsii_get_property("matchingWorkflowRef")
end

#nodeConstructs::Node

The tree node.

Returns:

  • (Constructs::Node)


115
116
117
# File 'entity_resolution/cfn_matching_workflow.rb', line 115

def node()
  jsii_get_property("node")
end

#obtain_dependenciesArray<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:



570
571
572
# File 'entity_resolution/cfn_matching_workflow.rb', line 570

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

#obtain_resource_dependenciesArray<AWSCDK::CfnResource>

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

Returns:



577
578
579
# File 'entity_resolution/cfn_matching_workflow.rb', line 577

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

#output_source_configAWSCDK::IResolvable, Array<AWSCDK::IResolvable, AWSCDK::EntityResolution::CfnMatchingWorkflow::OutputSourceProperty>

A list of OutputSource objects, each of which contains fields outputS3Path , applyNormalization , KMSArn , and output .



259
260
261
# File 'entity_resolution/cfn_matching_workflow.rb', line 259

def output_source_config()
  jsii_get_property("outputSourceConfig")
end

#output_source_config=(value) ⇒ Object



263
264
265
266
# File 'entity_resolution/cfn_matching_workflow.rb', line 263

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



370
371
372
373
# File 'entity_resolution/cfn_matching_workflow.rb', line 370

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

#refString

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)


151
152
153
# File 'entity_resolution/cfn_matching_workflow.rb', line 151

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:



588
589
590
591
# File 'entity_resolution/cfn_matching_workflow.rb', line 588

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


595
596
597
598
# File 'entity_resolution/cfn_matching_workflow.rb', line 595

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:



605
606
607
608
609
# File 'entity_resolution/cfn_matching_workflow.rb', line 605

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

#resolution_techniquesAWSCDK::IResolvable, AWSCDK::EntityResolution::CfnMatchingWorkflow::ResolutionTechniquesProperty

An object which defines the resolutionType and the ruleBasedProperties .



271
272
273
# File 'entity_resolution/cfn_matching_workflow.rb', line 271

def resolution_techniques()
  jsii_get_property("resolutionTechniques")
end

#resolution_techniques=(value) ⇒ Object



275
276
277
278
279
# File 'entity_resolution/cfn_matching_workflow.rb', line 275

def resolution_techniques=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::EntityResolution::CfnMatchingWorkflow::ResolutionTechniquesProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19lbnRpdHlyZXNvbHV0aW9uLkNmbk1hdGNoaW5nV29ya2Zsb3cuUmVzb2x1dGlvblRlY2huaXF1ZXNQcm9wZXJ0eSJ9XX19")), "resolutionTechniques")
  jsii_set_property("resolutionTechniques", value)
end

#role_arnString

The Amazon Resource Name (ARN) of the IAM role.

Returns:

  • (String)


284
285
286
# File 'entity_resolution/cfn_matching_workflow.rb', line 284

def role_arn()
  jsii_get_property("roleArn")
end

#role_arn=(value) ⇒ Object



288
289
290
291
# File 'entity_resolution/cfn_matching_workflow.rb', line 288

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

#should_synthesizeBoolean

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.



614
615
616
# File 'entity_resolution/cfn_matching_workflow.rb', line 614

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

#stackAWSCDK::Stack

The stack in which this element is defined.

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

Returns:



141
142
143
# File 'entity_resolution/cfn_matching_workflow.rb', line 141

def stack()
  jsii_get_property("stack")
end

#tagsArray<AWSCDK::CfnTag>?

The tags used to organize, track, or control access for this resource.

Returns:



333
334
335
# File 'entity_resolution/cfn_matching_workflow.rb', line 333

def tags()
  jsii_get_property("tags")
end

#tags=(value) ⇒ Object



337
338
339
340
341
# File 'entity_resolution/cfn_matching_workflow.rb', line 337

def tags=(value)
  value = value.is_a?(Array) ? value.map { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::CfnTag.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLkNmblRhZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "tags") unless value.nil?
  jsii_set_property("tags", value)
end

#to_stringString

Returns a string representation of this construct.

Returns:

  • (String)

    a string representation of this resource



346
347
348
# File 'entity_resolution/cfn_matching_workflow.rb', line 346

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

#updated_properitesHash{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})


188
189
190
# File 'entity_resolution/cfn_matching_workflow.rb', line 188

def updated_properites()
  jsii_get_property("updatedProperites")
end

#updated_propertiesHash{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})


198
199
200
# File 'entity_resolution/cfn_matching_workflow.rb', line 198

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object)


620
621
622
623
# File 'entity_resolution/cfn_matching_workflow.rb', line 620

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)


359
360
361
362
363
364
# File 'entity_resolution/cfn_matching_workflow.rb', line 359

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_nameString

The name of the workflow.

Returns:

  • (String)


296
297
298
# File 'entity_resolution/cfn_matching_workflow.rb', line 296

def workflow_name()
  jsii_get_property("workflowName")
end

#workflow_name=(value) ⇒ Object



300
301
302
303
# File 'entity_resolution/cfn_matching_workflow.rb', line 300

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