Skip to content
v2.277.0

RuleBasedPropertiesProperty Struct ​

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

Example ​

ts
// 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',
};
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_entityresolution as entityresolution

rule_based_properties_property = entityresolution.CfnMatchingWorkflow.RuleBasedPropertiesProperty(
    attribute_matching_model="attributeMatchingModel",
    rules=[entityresolution.CfnMatchingWorkflow.RuleProperty(
        matching_keys=["matchingKeys"],
        rule_name="ruleName"
    )],

    # the properties below are optional
    match_purpose="matchPurpose"
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.entityresolution.*;

RuleBasedPropertiesProperty ruleBasedPropertiesProperty = RuleBasedPropertiesProperty.builder()
        .attributeMatchingModel("attributeMatchingModel")
        .rules(List.of(RuleProperty.builder()
                .matchingKeys(List.of("matchingKeys"))
                .ruleName("ruleName")
                .build()))

        // the properties below are optional
        .matchPurpose("matchPurpose")
        .build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.EntityResolution;

var ruleBasedPropertiesProperty = new RuleBasedPropertiesProperty {
    AttributeMatchingModel = "attributeMatchingModel",
    Rules = new [] { new RuleProperty {
        MatchingKeys = new [] { "matchingKeys" },
        RuleName = "ruleName"
    } },

    // the properties below are optional
    MatchPurpose = "matchPurpose"
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

ruleBasedPropertiesProperty := &RuleBasedPropertiesProperty{
	AttributeMatchingModel: jsii.String("attributeMatchingModel"),
	Rules: []interface{}{
		&RuleProperty{
			MatchingKeys: []*string{
				jsii.String("matchingKeys"),
			},
			RuleName: jsii.String("ruleName"),
		},
	},

	// the properties below are optional
	MatchPurpose: jsii.String("matchPurpose"),
}

Properties ​

attributeMatchingModelstringattribute_matching_modelstrattributeMatchingModelStringAttributeMatchingModelstringAttributeMatchingModel*string required #
The comparison type. You can choose `ONE_TO_ONE` or `MANY_TO_MANY` as the `attributeMatchingModel` .
notes

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.

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.

matchPurposeoptionalstringmatch_purposeoptionalstrmatchPurposeoptionalStringMatchPurposeoptionalstringMatchPurposeoptional*string #
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.

rulesIResolvable | IResolvable | CfnMatchingWorkflow.RuleProperty[]rulestyping.Union[IResolvable, typing.List[typing.Union[IResolvable, RuleProperty]]]rulesIResolvableRulesIResolvableRulesinterface{} required #
A list of `Rule` objects, each of which have fields `RuleName` and `MatchingKeys` .