interface MatchingProperty

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

The process of matching duplicate profiles.

If Matching = true , Amazon Connect Customer Profiles starts a weekly batch process called Identity Resolution Job . If you do not specify a date and time for the Identity Resolution Job to run, by default it runs every Saturday at 12AM UTC to detect duplicate profiles in your domains. After the Identity Resolution Job completes, use the GetMatches API to return and review the results. Or, if you have configured ExportingConfig in the MatchingRequest , 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 { aws_customerprofiles as customerprofiles } from 'aws-cdk-lib';
const matchingProperty: customerprofiles.CfnDomain.MatchingProperty = {
  enabled: false,

  // the properties below are optional
  autoMerging: {
    enabled: false,

    // the properties below are optional
    conflictResolution: {
      conflictResolvingModel: 'conflictResolvingModel',

      // the properties below are optional
      sourceName: 'sourceName',
    },
    consolidation: {
      matchingAttributesList: [['matchingAttributesList']],
    },
    minAllowedConfidenceScoreForMerging: 123,
  },
  exportingConfig: {
    s3Exporting: {
      s3BucketName: 's3BucketName',

      // the properties below are optional
      s3KeyName: 's3KeyName',
    },
  },
  jobSchedule: {
    dayOfTheWeek: 'dayOfTheWeek',
    time: 'time',
  },
};

Properties

Name	Type	Description
enabled	`boolean \|` `IResolvable`	The flag that enables the matching process of duplicate profiles.
autoMerging?	`IResolvable` `\|` `AutoMergingProperty`	Configuration information about the auto-merging process.
exportingConfig?	`IResolvable` `\|` `ExportingConfigProperty`	The S3 location where Identity Resolution Jobs write result files.
jobSchedule?	`IResolvable` `\|` `JobScheduleProperty`	The day and time when do you want to start the Identity Resolution Job every week.

enabled

Type: boolean | IResolvable

The flag that enables the matching process of duplicate profiles.

autoMerging?

Type: IResolvable | AutoMergingProperty (optional)

Configuration information about the auto-merging process.

exportingConfig?

Type: IResolvable | ExportingConfigProperty (optional)

The S3 location where Identity Resolution Jobs write result files.

jobSchedule?

Type: IResolvable | JobScheduleProperty (optional)

The day and time when do you want to start the Identity Resolution Job every week.