Package software.amazon.awscdk.services.customerprofiles

Interface CfnDomain.MatchingProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDomain.MatchingProperty.Jsii$Proxy

Enclosing class:

CfnDomain

@Stability(Stable)
public static interface CfnDomain.MatchingProperty
extends software.amazon.jsii.JsiiSerializable

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 software.amazon.awscdk.services.customerprofiles.*;
 MatchingProperty matchingProperty = MatchingProperty.builder()
         .enabled(false)
         // the properties below are optional
         .autoMerging(AutoMergingProperty.builder()
                 .enabled(false)
                 // the properties below are optional
                 .conflictResolution(ConflictResolutionProperty.builder()
                         .conflictResolvingModel("conflictResolvingModel")
                         // the properties below are optional
                         .sourceName("sourceName")
                         .build())
                 .consolidation(ConsolidationProperty.builder()
                         .matchingAttributesList(List.of(List.of("matchingAttributesList")))
                         .build())
                 .minAllowedConfidenceScoreForMerging(123)
                 .build())
         .exportingConfig(ExportingConfigProperty.builder()
                 .s3Exporting(S3ExportingConfigProperty.builder()
                         .s3BucketName("s3BucketName")
                         // the properties below are optional
                         .s3KeyName("s3KeyName")
                         .build())
                 .build())
         .jobSchedule(JobScheduleProperty.builder()
                 .dayOfTheWeek("dayOfTheWeek")
                 .time("time")
                 .build())
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnDomain.MatchingProperty.Builder	builder()
default Object	getAutoMerging()	Configuration information about the auto-merging process.
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	getJobSchedule()	The day and time when do you want to start the Identity Resolution Job every week.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getEnabled

@Stability(Stable)
@NotNull
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-matching.html#cfn-customerprofiles-domain-matching-enabled

getAutoMerging

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

Configuration information about the auto-merging process.

Returns union: either IResolvable or CfnDomain.AutoMergingProperty

See Also:

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

getExportingConfig

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

The S3 location where Identity Resolution Jobs write result files.

Returns union: either IResolvable or CfnDomain.ExportingConfigProperty

See Also:

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

getJobSchedule

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

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

Returns union: either IResolvable or CfnDomain.JobScheduleProperty

See Also:

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

builder

@Stability(Stable)
static CfnDomain.MatchingProperty.Builder builder()

Returns:

a CfnDomain.MatchingProperty.Builder of CfnDomain.MatchingProperty