interface RuleBasedPropertiesProperty

Language	Type name
.NET	`Amazon.CDK.aws_entityresolution.CfnMatchingWorkflow.RuleBasedPropertiesProperty`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awsentityresolution#CfnMatchingWorkflow_RuleBasedPropertiesProperty`
Java	`software.amazon.awscdk.services.entityresolution.CfnMatchingWorkflow.RuleBasedPropertiesProperty`
Python	`aws_cdk.aws_entityresolution.CfnMatchingWorkflow.RuleBasedPropertiesProperty`
TypeScript	`aws-cdk-lib` » `aws_entityresolution` » `CfnMatchingWorkflow` » `RuleBasedPropertiesProperty`

An object which defines the list of matching rules to run in a matching workflow.

RuleBasedProperties contain a Rules field, which is a list of rule objects.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_entityresolution as entityresolution } from 'aws-cdk-lib';
const ruleBasedPropertiesProperty: entityresolution.CfnMatchingWorkflow.RuleBasedPropertiesProperty = {
  attributeMatchingModel: 'attributeMatchingModel',
  rules: [{
    matchingKeys: ['matchingKeys'],
    ruleName: 'ruleName',
  }],

  // the properties below are optional
  matchPurpose: 'matchPurpose',
};

Properties

Name	Type	Description
attributeMatchingModel	`string`	The comparison type. You can either choose `ONE_TO_ONE` or `MANY_TO_MANY` as the `attributeMatchingModel` .
rules	`IResolvable` `\|` `IResolvable` `\|` `RuleProperty[]`	A list of `Rule` objects, each of which have fields `RuleName` and `MatchingKeys` .
matchPurpose?	`string`	An indicator of whether to generate IDs and index the data or not.

attributeMatchingModel

Type: string

The comparison type. You can either choose ONE_TO_ONE or MANY_TO_MANY as the attributeMatchingModel .

If you choose MANY_TO_MANY , the system can match attributes across the sub-types of an attribute type. For example, if the value of the Email field of Profile A and the value of BusinessEmail field of Profile B matches, the two profiles are matched on the Email attribute type.

If you choose ONE_TO_ONE , the system can only match attributes if the sub-types are an exact match. For example, for the Email attribute type, the system will only consider it a match if the value of the Email field of Profile A matches the value of the Email field of Profile B.

rules

Type: IResolvable | IResolvable | RuleProperty[]

A list of Rule objects, each of which have fields RuleName and MatchingKeys .

matchPurpose?

Type: string (optional)

An indicator of whether to generate IDs and index the data or not.

If you choose IDENTIFIER_GENERATION , the process generates IDs and indexes the data.

If you choose INDEXING , the process indexes the data without generating IDs.