Class CfnDomain.RuleBasedMatchingProperty

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

Inheritance

object

CfnDomain.RuleBasedMatchingProperty

Implements

CfnDomain.IRuleBasedMatchingProperty

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.AWS.CustomerProfiles

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnDomain.RuleBasedMatchingProperty : CfnDomain.IRuleBasedMatchingProperty

Syntax (vb)

Public Class CfnDomain.RuleBasedMatchingProperty Implements CfnDomain.IRuleBasedMatchingProperty

Remarks

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: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-domain-rulebasedmatching.html

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.CustomerProfiles;

             var ruleBasedMatchingProperty = new RuleBasedMatchingProperty {
                 Enabled = false,

                 // the properties below are optional
                 AttributeTypesSelector = new AttributeTypesSelectorProperty {
                     AttributeMatchingModel = "attributeMatchingModel",

                     // the properties below are optional
                     Address = new [] { "address" },
                     EmailAddress = new [] { "emailAddress" },
                     PhoneNumber = new [] { "phoneNumber" }
                 },
                 ConflictResolution = new ConflictResolutionProperty {
                     ConflictResolvingModel = "conflictResolvingModel",

                     // the properties below are optional
                     SourceName = "sourceName"
                 },
                 ExportingConfig = new ExportingConfigProperty {
                     S3Exporting = new S3ExportingConfigProperty {
                         S3BucketName = "s3BucketName",

                         // the properties below are optional
                         S3KeyName = "s3KeyName"
                     }
                 },
                 MatchingRules = new [] { new MatchingRuleProperty {
                     Rule = new [] { "rule" }
                 } },
                 MaxAllowedRuleLevelForMatching = 123,
                 MaxAllowedRuleLevelForMerging = 123,
                 Status = "status"
             };

Synopsis

Constructors

RuleBasedMatchingProperty()

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

Properties

AttributeTypesSelector	Configures information about the `AttributeTypesSelector` where the rule-based identity resolution uses to match profiles.
ConflictResolution	Determines how the auto-merging process should resolve conflicts between different profiles.
Enabled	The flag that enables the matching process of duplicate profiles.
ExportingConfig	The S3 location where Identity Resolution Jobs write result files.
MatchingRules	Configures how the rule-based matching process should match profiles.
MaxAllowedRuleLevelForMatching	Indicates the maximum allowed rule level for matching.
MaxAllowedRuleLevelForMerging	Indicates the maximum allowed rule level for merging.
Status	The status of rule-based matching rule.

Constructors

RuleBasedMatchingProperty()

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

public RuleBasedMatchingProperty()

Remarks

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

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.CustomerProfiles;

             var ruleBasedMatchingProperty = new RuleBasedMatchingProperty {
                 Enabled = false,

                 // the properties below are optional
                 AttributeTypesSelector = new AttributeTypesSelectorProperty {
                     AttributeMatchingModel = "attributeMatchingModel",

                     // the properties below are optional
                     Address = new [] { "address" },
                     EmailAddress = new [] { "emailAddress" },
                     PhoneNumber = new [] { "phoneNumber" }
                 },
                 ConflictResolution = new ConflictResolutionProperty {
                     ConflictResolvingModel = "conflictResolvingModel",

                     // the properties below are optional
                     SourceName = "sourceName"
                 },
                 ExportingConfig = new ExportingConfigProperty {
                     S3Exporting = new S3ExportingConfigProperty {
                         S3BucketName = "s3BucketName",

                         // the properties below are optional
                         S3KeyName = "s3KeyName"
                     }
                 },
                 MatchingRules = new [] { new MatchingRuleProperty {
                     Rule = new [] { "rule" }
                 } },
                 MaxAllowedRuleLevelForMatching = 123,
                 MaxAllowedRuleLevelForMerging = 123,
                 Status = "status"
             };

Properties

AttributeTypesSelector

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

public object? AttributeTypesSelector { get; set; }

Property Value

object

Remarks

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

Type union: either IResolvable or CfnDomain.IAttributeTypesSelectorProperty

ConflictResolution

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

public object? ConflictResolution { get; set; }

Property Value

object

Remarks

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

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

Type union: either IResolvable or CfnDomain.IConflictResolutionProperty

Enabled

The flag that enables the matching process of duplicate profiles.

public object Enabled { get; set; }

Property Value

object

Remarks

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

Type union: either bool or IResolvable

ExportingConfig

The S3 location where Identity Resolution Jobs write result files.

public object? ExportingConfig { get; set; }

Property Value

object

Remarks

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

Type union: either IResolvable or CfnDomain.IExportingConfigProperty

MatchingRules

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

public object? MatchingRules { get; set; }

Property Value

object

Remarks

You can have up to 15 MatchingRule in the MatchingRules .

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

Type union: either IResolvable or (either IResolvable or CfnDomain.IMatchingRuleProperty)[]

MaxAllowedRuleLevelForMatching

Indicates the maximum allowed rule level for matching.

public double? MaxAllowedRuleLevelForMatching { get; set; }

Property Value

double?

Remarks

MaxAllowedRuleLevelForMerging

Indicates the maximum allowed rule level for merging.

public double? MaxAllowedRuleLevelForMerging { get; set; }

Property Value

double?

Remarks

Status

The status of rule-based matching rule.

public string? Status { get; set; }