Package software.amazon.awscdk.cfnpropertymixins.services.customerprofiles

Interface CfnDomainPropsMixin.RuleBasedMatchingProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDomainPropsMixin.RuleBasedMatchingProperty.Jsii$Proxy

Enclosing class:

CfnDomainPropsMixin

@Stability(Stable)
public static interface CfnDomainPropsMixin.RuleBasedMatchingProperty
extends software.amazon.jsii.JsiiSerializable

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.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.cfnpropertymixins.services.customerprofiles.*;
 RuleBasedMatchingProperty ruleBasedMatchingProperty = RuleBasedMatchingProperty.builder()
         .attributeTypesSelector(AttributeTypesSelectorProperty.builder()
                 .address(List.of("address"))
                 .attributeMatchingModel("attributeMatchingModel")
                 .emailAddress(List.of("emailAddress"))
                 .phoneNumber(List.of("phoneNumber"))
                 .build())
         .conflictResolution(ConflictResolutionProperty.builder()
                 .conflictResolvingModel("conflictResolvingModel")
                 .sourceName("sourceName")
                 .build())
         .enabled(false)
         .exportingConfig(ExportingConfigProperty.builder()
                 .s3Exporting(S3ExportingConfigProperty.builder()
                         .s3BucketName("s3BucketName")
                         .s3KeyName("s3KeyName")
                         .build())
                 .build())
         .matchingRules(List.of(MatchingRuleProperty.builder()
                 .rule(List.of("rule"))
                 .build()))
         .maxAllowedRuleLevelForMatching(123)
         .maxAllowedRuleLevelForMerging(123)
         .status("status")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnDomainPropsMixin.RuleBasedMatchingProperty.Builder	A builder for CfnDomainPropsMixin.RuleBasedMatchingProperty
static final class	CfnDomainPropsMixin.RuleBasedMatchingProperty.Jsii$Proxy	An implementation for CfnDomainPropsMixin.RuleBasedMatchingProperty

Method Summary

Modifier and Type	Method	Description
static CfnDomainPropsMixin.RuleBasedMatchingProperty.Builder	builder()
default Object	getAttributeTypesSelector()	Configures information about the AttributeTypesSelector where the rule-based identity resolution uses to match profiles.
default Object	getConflictResolution()	Determines how the auto-merging process should resolve conflicts between different profiles.
default Object	getEnabled()	The flag that enables the matching process of duplicate profiles.
default Object	getExportingConfig()	The S3 location where Identity Resolution Jobs write result files.
default Object	getMatchingRules()	Configures how the rule-based matching process should match profiles.
default Number	getMaxAllowedRuleLevelForMatching()	Indicates the maximum allowed rule level for matching.
default Number	getMaxAllowedRuleLevelForMerging()	Indicates the maximum allowed rule level for merging.
default String	getStatus()	The status of rule-based matching rule.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAttributeTypesSelector

@Stability(Stable)
@Nullable
default Object getAttributeTypesSelector()

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

Returns union: either IResolvable or CfnDomainPropsMixin.AttributeTypesSelectorProperty

See Also:

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

getConflictResolution

@Stability(Stable)
@Nullable
default Object getConflictResolution()

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.

Returns union: either IResolvable or CfnDomainPropsMixin.ConflictResolutionProperty

See Also:

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

getEnabled

@Stability(Stable)
@Nullable
default Object getEnabled()

The flag that enables the matching process of duplicate profiles.

Returns union: either Boolean or IResolvable

See Also:

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

getExportingConfig

@Stability(Stable)
@Nullable
default Object getExportingConfig()

The S3 location where Identity Resolution Jobs write result files.

Returns union: either IResolvable or CfnDomainPropsMixin.ExportingConfigProperty

See Also:

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

getMatchingRules

@Stability(Stable)
@Nullable
default Object getMatchingRules()

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

You can have up to 15 MatchingRule in the MatchingRules .

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnDomainPropsMixin.MatchingRuleProperty>

See Also:

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

getMaxAllowedRuleLevelForMatching

@Stability(Stable)
@Nullable
default Number getMaxAllowedRuleLevelForMatching()

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

getMaxAllowedRuleLevelForMerging

@Stability(Stable)
@Nullable
default Number getMaxAllowedRuleLevelForMerging()

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

getStatus

@Stability(Stable)
@Nullable
default String getStatus()

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

builder

@Stability(Stable)
static CfnDomainPropsMixin.RuleBasedMatchingProperty.Builder builder()

Returns:

a CfnDomainPropsMixin.RuleBasedMatchingProperty.Builder of CfnDomainPropsMixin.RuleBasedMatchingProperty