AWS::CustomerProfiles::Domain RuleBasedMatching
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.
Syntax
To declare this entity in your AWS CloudFormation template, use the following syntax:
JSON
{ "AttributeTypesSelector" :
AttributeTypesSelector
, "ConflictResolution" :ConflictResolution
, "Enabled" :Boolean
, "ExportingConfig" :ExportingConfig
, "MatchingRules" :[ MatchingRule, ... ]
, "MaxAllowedRuleLevelForMatching" :Integer
, "MaxAllowedRuleLevelForMerging" :Integer
, "Status" :String
}
YAML
AttributeTypesSelector:
AttributeTypesSelector
ConflictResolution:ConflictResolution
Enabled:Boolean
ExportingConfig:ExportingConfig
MatchingRules:- MatchingRule
MaxAllowedRuleLevelForMatching:Integer
MaxAllowedRuleLevelForMerging:Integer
Status:String
Properties
AttributeTypesSelector
-
Configures information about the
AttributeTypesSelector
where the rule-based identity resolution uses to match profiles.Required: No
Type: AttributeTypesSelector
Update requires: No interruption
ConflictResolution
-
Determines how the auto-merging process should resolve conflicts between different profiles. For example, if Profile A and Profile B have the same
FirstName
andLastName
,ConflictResolution
specifies whichEmailAddress
should be used.Required: No
Type: ConflictResolution
Update requires: No interruption
Enabled
-
The flag that enables the matching process of duplicate profiles.
Required: Yes
Type: Boolean
Update requires: No interruption
ExportingConfig
-
The S3 location where Identity Resolution Jobs write result files.
Required: No
Type: ExportingConfig
Update requires: No interruption
MatchingRules
-
Configures how the rule-based matching process should match profiles. You can have up to 15
MatchingRule
in theMatchingRules
.Required: No
Type: Array of MatchingRule
Minimum:
1
Maximum:
15
Update requires: No interruption
MaxAllowedRuleLevelForMatching
-
Indicates the maximum allowed rule level for matching.
Required: No
Type: Integer
Minimum:
1
Maximum:
15
Update requires: No interruption
MaxAllowedRuleLevelForMerging
-
Indicates the maximum allowed rule level for merging.
Required: No
Type: Integer
Minimum:
1
Maximum:
15
Update requires: No interruption
Status
-
The status of rule-based matching rule.
Required: No
Type: String
Allowed values:
PENDING | IN_PROGRESS | ACTIVE
Update requires: No interruption