Interface CfnDomain.RuleBasedMatchingProperty
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnDomain.RuleBasedMatchingProperty.Jsii$Proxy
- Enclosing class:
CfnDomain
@Stability(Stable)
public static interface CfnDomain.RuleBasedMatchingProperty
extends software.amazon.jsii.JsiiSerializable
The process of matching duplicate profiles using the 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.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.customerprofiles.*;
RuleBasedMatchingProperty ruleBasedMatchingProperty = RuleBasedMatchingProperty.builder()
.enabled(false)
// the properties below are optional
.attributeTypesSelector(AttributeTypesSelectorProperty.builder()
.attributeMatchingModel("attributeMatchingModel")
// the properties below are optional
.address(List.of("address"))
.emailAddress(List.of("emailAddress"))
.phoneNumber(List.of("phoneNumber"))
.build())
.conflictResolution(ConflictResolutionProperty.builder()
.conflictResolvingModel("conflictResolvingModel")
// the properties below are optional
.sourceName("sourceName")
.build())
.exportingConfig(ExportingConfigProperty.builder()
.s3Exporting(S3ExportingConfigProperty.builder()
.s3BucketName("s3BucketName")
// the properties below are optional
.s3KeyName("s3KeyName")
.build())
.build())
.matchingRules(List.of(MatchingRuleProperty.builder()
.rule(List.of("rule"))
.build()))
.maxAllowedRuleLevelForMatching(123)
.maxAllowedRuleLevelForMerging(123)
.status("status")
.build();
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final classA builder forCfnDomain.RuleBasedMatchingPropertystatic final classAn implementation forCfnDomain.RuleBasedMatchingProperty -
Method Summary
Modifier and TypeMethodDescriptionbuilder()default ObjectConfigures information about the AttributeTypesSelector where the rule-based identity resolution uses to match profiles.default ObjectHow the auto-merging process should resolve conflicts between different profiles.The flag that enables the rule-based matching process of duplicate profiles.default ObjectConfiguration information for exporting Identity Resolution results, for example, to an S3 bucket.default ObjectConfigures how the rule-based matching process should match profiles.default NumberIndicates the maximum allowed rule level for matching.default NumberIndicates the maximum allowed rule level for merging.default StringMethods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getEnabled
The flag that enables the rule-based matching process of duplicate profiles.- See Also:
-
getAttributeTypesSelector
Configures information about the AttributeTypesSelector where the rule-based identity resolution uses to match profiles.- See Also:
-
getConflictResolution
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 (and that is the matching criteria), which EmailAddress should be used?
- See Also:
-
getExportingConfig
Configuration information for exporting Identity Resolution results, for example, to an S3 bucket.- See Also:
-
getMatchingRules
Configures how the rule-based matching process should match profiles.You can have up to 15 MatchingRule in the MatchingRules.
- See Also:
-
getMaxAllowedRuleLevelForMatching
Indicates the maximum allowed rule level for matching.- See Also:
-
getMaxAllowedRuleLevelForMerging
Indicates the maximum allowed rule level for merging.- See Also:
-
getStatus
- See Also:
-
builder
-