Package software.amazon.awscdk.services.entityresolution

Interface CfnIdMappingWorkflow.IdMappingRuleBasedPropertiesProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnIdMappingWorkflow.IdMappingRuleBasedPropertiesProperty.Jsii$Proxy

Enclosing class:

CfnIdMappingWorkflow

@Stability(Stable)
public static interface CfnIdMappingWorkflow.IdMappingRuleBasedPropertiesProperty
extends software.amazon.jsii.JsiiSerializable

An object that defines the list of matching rules to run in an ID mapping workflow.

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.entityresolution.*;
 IdMappingRuleBasedPropertiesProperty idMappingRuleBasedPropertiesProperty = IdMappingRuleBasedPropertiesProperty.builder()
         .attributeMatchingModel("attributeMatchingModel")
         .recordMatchingModel("recordMatchingModel")
         // the properties below are optional
         .ruleDefinitionType("ruleDefinitionType")
         .rules(List.of(RuleProperty.builder()
                 .matchingKeys(List.of("matchingKeys"))
                 .ruleName("ruleName")
                 .build()))
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-entityresolution-idmappingworkflow-idmappingrulebasedproperties.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnIdMappingWorkflow.IdMappingRuleBasedPropertiesProperty.Builder	builder()
String	getAttributeMatchingModel()	The comparison type.
String	getRecordMatchingModel()	The type of matching record that is allowed to be used in an ID mapping workflow.
default String	getRuleDefinitionType()	The set of rules you can use in an ID mapping workflow.
default Object	getRules()	The rules that can be used for ID mapping.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAttributeMatchingModel

@Stability(Stable)
@NotNull
String getAttributeMatchingModel()

The comparison type. You can either choose ONE_TO_ONE or MANY_TO_MANY as the attributeMatchingModel .

If you choose ONE_TO_ONE , the system can only match attributes if the sub-types are an exact match. For example, for the Email attribute type, the system will only consider it a match if the value of the Email field of Profile A matches the value of the Email field of Profile B.

If you choose MANY_TO_MANY , the system can match attributes across the sub-types of an attribute type. For example, if the value of the Email field of Profile A matches the value of the BusinessEmail field of Profile B, the two profiles are matched on the Email attribute type.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-entityresolution-idmappingworkflow-idmappingrulebasedproperties.html#cfn-entityresolution-idmappingworkflow-idmappingrulebasedproperties-attributematchingmodel

getRecordMatchingModel

@Stability(Stable)
@NotNull
String getRecordMatchingModel()

The type of matching record that is allowed to be used in an ID mapping workflow.

If the value is set to ONE_SOURCE_TO_ONE_TARGET , only one record in the source can be matched to the same record in the target.

If the value is set to MANY_SOURCE_TO_ONE_TARGET , multiple records in the source can be matched to one record in the target.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-entityresolution-idmappingworkflow-idmappingrulebasedproperties.html#cfn-entityresolution-idmappingworkflow-idmappingrulebasedproperties-recordmatchingmodel

getRuleDefinitionType

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

The set of rules you can use in an ID mapping workflow.

The limitations specified for the source or target to define the match rules must be compatible.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-entityresolution-idmappingworkflow-idmappingrulebasedproperties.html#cfn-entityresolution-idmappingworkflow-idmappingrulebasedproperties-ruledefinitiontype

getRules

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

The rules that can be used for ID mapping.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnIdMappingWorkflow.RuleProperty>

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-entityresolution-idmappingworkflow-idmappingrulebasedproperties.html#cfn-entityresolution-idmappingworkflow-idmappingrulebasedproperties-rules

builder

@Stability(Stable)
static CfnIdMappingWorkflow.IdMappingRuleBasedPropertiesProperty.Builder builder()

Returns:

a CfnIdMappingWorkflow.IdMappingRuleBasedPropertiesProperty.Builder of CfnIdMappingWorkflow.IdMappingRuleBasedPropertiesProperty