Class: AWSCDK::EntityResolution::CfnMatchingWorkflowProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
entity_resolution/cfn_matching_workflow_props.rb

Overview

Properties for defining a CfnMatchingWorkflow.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(input_source_config:, output_source_config:, resolution_techniques:, role_arn:, workflow_name:, description: nil, incremental_run_config: nil, tags: nil) ⇒ CfnMatchingWorkflowProps

Returns a new instance of CfnMatchingWorkflowProps.

Parameters:



17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
 
# File 'entity_resolution/cfn_matching_workflow_props.rb', line 17

def initialize(input_source_config:, output_source_config:, resolution_techniques:, role_arn:, workflow_name:, description: nil, incremental_run_config: nil, tags: nil)
  @input_source_config = input_source_config
  Jsii::Type.check_type(@input_source_config, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZW50aXR5cmVzb2x1dGlvbi5DZm5NYXRjaGluZ1dvcmtmbG93LklucHV0U291cmNlUHJvcGVydHkifV19fSwia2luZCI6ImFycmF5In19XX19")), "inputSourceConfig")
  @output_source_config = output_source_config
  Jsii::Type.check_type(@output_source_config, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZW50aXR5cmVzb2x1dGlvbi5DZm5NYXRjaGluZ1dvcmtmbG93Lk91dHB1dFNvdXJjZVByb3BlcnR5In1dfX0sImtpbmQiOiJhcnJheSJ9fV19fQ==")), "outputSourceConfig")
  @resolution_techniques = resolution_techniques.is_a?(Hash) ? ::AWSCDK::EntityResolution::CfnMatchingWorkflow::ResolutionTechniquesProperty.new(**resolution_techniques.transform_keys(&:to_sym)) : resolution_techniques
  Jsii::Type.check_type(@resolution_techniques, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19lbnRpdHlyZXNvbHV0aW9uLkNmbk1hdGNoaW5nV29ya2Zsb3cuUmVzb2x1dGlvblRlY2huaXF1ZXNQcm9wZXJ0eSJ9XX19")), "resolutionTechniques")
  @role_arn = role_arn
  Jsii::Type.check_type(@role_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "roleArn")
  @workflow_name = workflow_name
  Jsii::Type.check_type(@workflow_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "workflowName")
  @description = description
  Jsii::Type.check_type(@description, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "description") unless @description.nil?
  @incremental_run_config = incremental_run_config.is_a?(Hash) ? ::AWSCDK::EntityResolution::CfnMatchingWorkflow::IncrementalRunConfigProperty.new(**incremental_run_config.transform_keys(&:to_sym)) : incremental_run_config
  Jsii::Type.check_type(@incremental_run_config, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19lbnRpdHlyZXNvbHV0aW9uLkNmbk1hdGNoaW5nV29ya2Zsb3cuSW5jcmVtZW50YWxSdW5Db25maWdQcm9wZXJ0eSJ9XX19")), "incrementalRunConfig") unless @incremental_run_config.nil?
  @tags = tags.is_a?(Array) ? tags.map { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::CfnTag.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : tags
  Jsii::Type.check_type(@tags, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLkNmblRhZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "tags") unless @tags.nil?
end

Instance Attribute Details

#description ⇒ String? (readonly)

A description of the workflow.

Returns:

  • (String, nil)

See Also:



69
70
71
 
# File 'entity_resolution/cfn_matching_workflow_props.rb', line 69

def description
  @description
end

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

Optional.

An object that defines the incremental run type. This object contains only the incremental_run_type field, which appears as "Automatic" in the console.

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

Returns:

See Also:



78
79
80
 
# File 'entity_resolution/cfn_matching_workflow_props.rb', line 78

def incremental_run_config
  @incremental_run_config
end

#input_source_config ⇒ AWSCDK::IResolvable, Array<AWSCDK::IResolvable, AWSCDK::EntityResolution::CfnMatchingWorkflow::InputSourceProperty> (readonly)

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

Returns:

See Also:



40
41
42
 
# File 'entity_resolution/cfn_matching_workflow_props.rb', line 40

def input_source_config
  @input_source_config
end

#output_source_config ⇒ AWSCDK::IResolvable, Array<AWSCDK::IResolvable, AWSCDK::EntityResolution::CfnMatchingWorkflow::OutputSourceProperty> (readonly)

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

Returns:

See Also:



45
46
47
 
# File 'entity_resolution/cfn_matching_workflow_props.rb', line 45

def output_source_config
  @output_source_config
end

#resolution_techniques ⇒ AWSCDK::IResolvable, AWSCDK::EntityResolution::CfnMatchingWorkflow::ResolutionTechniquesProperty (readonly)

An object which defines the resolutionType and the ruleBasedProperties .

Returns:

See Also:



50
51
52
 
# File 'entity_resolution/cfn_matching_workflow_props.rb', line 50

def resolution_techniques
  @resolution_techniques
end

#role_arn ⇒ String (readonly)

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

AWS Entity Resolution assumes this role to create resources on your behalf as part of workflow execution.

Returns:

  • (String)

See Also:



57
58
59
 
# File 'entity_resolution/cfn_matching_workflow_props.rb', line 57

def role_arn
  @role_arn
end

#tags ⇒ Array<AWSCDK::CfnTag>? (readonly)

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

Returns:

See Also:



83
84
85
 
# File 'entity_resolution/cfn_matching_workflow_props.rb', line 83

def tags
  @tags
end

#workflow_name ⇒ String (readonly)

The name of the workflow.

There can't be multiple MatchingWorkflows with the same name.

Returns:

  • (String)

See Also:



64
65
66
 
# File 'entity_resolution/cfn_matching_workflow_props.rb', line 64

def workflow_name
  @workflow_name
end

Class Method Details

.jsii_properties ⇒ Object 



85
86
87
88
89
90
91
92
93
94
95
96
 
# File 'entity_resolution/cfn_matching_workflow_props.rb', line 85

def self.jsii_properties
  {
    :input_source_config => "inputSourceConfig",
    :output_source_config => "outputSourceConfig",
    :resolution_techniques => "resolutionTechniques",
    :role_arn => "roleArn",
    :workflow_name => "workflowName",
    :description => "description",
    :incremental_run_config => "incrementalRunConfig",
    :tags => "tags",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



98
99
100
101
102
103
104
105
106
107
108
109
110
111
 
# File 'entity_resolution/cfn_matching_workflow_props.rb', line 98

def to_jsii
  result = {}
  result.merge!({
    "inputSourceConfig" => @input_source_config,
    "outputSourceConfig" => @output_source_config,
    "resolutionTechniques" => @resolution_techniques,
    "roleArn" => @role_arn,
    "workflowName" => @workflow_name,
    "description" => @description,
    "incrementalRunConfig" => @incremental_run_config,
    "tags" => @tags,
  })
  result.compact
end