interface RuleBasedMatchingProperty

Language	Type name
.NET	Amazon.CDK.AWS.CustomerProfiles.CfnDomain.RuleBasedMatchingProperty
Go	github.com/aws/aws-cdk-go/awscdk/v2/awscustomerprofiles#CfnDomain_RuleBasedMatchingProperty
Java	software.amazon.awscdk.services.customerprofiles.CfnDomain.RuleBasedMatchingProperty
Python	aws_cdk.aws_customerprofiles.CfnDomain.RuleBasedMatchingProperty
TypeScript	aws-cdk-lib » aws_customerprofiles » CfnDomain » RuleBasedMatchingProperty

The process of matching duplicate profiles using Rule-Based matching.

If RuleBasedMatching = true , Amazon Connect Customer Profiles will start to match and merge your profiles according to your configuration in the RuleBasedMatchingRequest . You can use the ListRuleBasedMatches and GetSimilarProfiles API to return and review the results. Also, if you have configured ExportingConfig in the RuleBasedMatchingRequest , you can download the results from S3.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-domain-rulebasedmatching.html

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_customerprofiles as customerprofiles } from 'aws-cdk-lib';
const ruleBasedMatchingProperty: customerprofiles.CfnDomain.RuleBasedMatchingProperty = {
  enabled: false,

  // the properties below are optional
  attributeTypesSelector: {
    attributeMatchingModel: 'attributeMatchingModel',

    // the properties below are optional
    address: ['address'],
    emailAddress: ['emailAddress'],
    phoneNumber: ['phoneNumber'],
  },
  conflictResolution: {
    conflictResolvingModel: 'conflictResolvingModel',

    // the properties below are optional
    sourceName: 'sourceName',
  },
  exportingConfig: {
    s3Exporting: {
      s3BucketName: 's3BucketName',

      // the properties below are optional
      s3KeyName: 's3KeyName',
    },
  },
  matchingRules: [{
    rule: ['rule'],
  }],
  maxAllowedRuleLevelForMatching: 123,
  maxAllowedRuleLevelForMerging: 123,
  status: 'status',
};

Properties

Name	Type	Description
enabled	boolean | IResolvable	The flag that enables the matching process of duplicate profiles.
attributeTypesSelector?	IResolvable | AttributeTypesSelectorProperty	Configures information about the AttributeTypesSelector where the rule-based identity resolution uses to match profiles.
conflictResolution?	IResolvable | ConflictResolutionProperty	Determines how the auto-merging process should resolve conflicts between different profiles.
exportingConfig?	IResolvable | ExportingConfigProperty	The S3 location where Identity Resolution Jobs write result files.
matchingRules?	IResolvable | (IResolvable | MatchingRuleProperty)[]	Configures how the rule-based matching process should match profiles.
maxAllowedRuleLevelForMatching?	number	Indicates the maximum allowed rule level for matching.
maxAllowedRuleLevelForMerging?	number	Indicates the maximum allowed rule level for merging.
status?	string	The status of rule-based matching rule.

---

enabled

Type: boolean | IResolvable

The flag that enables the matching process of duplicate profiles.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-domain-rulebasedmatching.html#cfn-customerprofiles-domain-rulebasedmatching-enabled

---

attributeTypesSelector?

Type: IResolvable | AttributeTypesSelectorProperty (optional)

Configures information about the AttributeTypesSelector where the rule-based identity resolution uses to match profiles.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-domain-rulebasedmatching.html#cfn-customerprofiles-domain-rulebasedmatching-attributetypesselector

---

conflictResolution?

Type: IResolvable | ConflictResolutionProperty (optional)

Determines how the auto-merging process should resolve conflicts between different profiles.

For example, if Profile A and Profile B have the same FirstName and LastName , ConflictResolution specifies which EmailAddress should be used.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-domain-rulebasedmatching.html#cfn-customerprofiles-domain-rulebasedmatching-conflictresolution

---

exportingConfig?

Type: IResolvable | ExportingConfigProperty (optional)

The S3 location where Identity Resolution Jobs write result files.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-domain-rulebasedmatching.html#cfn-customerprofiles-domain-rulebasedmatching-exportingconfig

---

matchingRules?

Type: IResolvable | (IResolvable | MatchingRuleProperty)[] (optional)

Configures how the rule-based matching process should match profiles.

You can have up to 15 MatchingRule in the MatchingRules .

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-domain-rulebasedmatching.html#cfn-customerprofiles-domain-rulebasedmatching-matchingrules

---

maxAllowedRuleLevelForMatching?

Type: number (optional)

Indicates the maximum allowed rule level for matching.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-domain-rulebasedmatching.html#cfn-customerprofiles-domain-rulebasedmatching-maxallowedrulelevelformatching

---

maxAllowedRuleLevelForMerging?

Type: number (optional)

Indicates the maximum allowed rule level for merging.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-domain-rulebasedmatching.html#cfn-customerprofiles-domain-rulebasedmatching-maxallowedrulelevelformerging

---

status?

Type: string (optional)

The status of rule-based matching rule.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-domain-rulebasedmatching.html#cfn-customerprofiles-domain-rulebasedmatching-status