AWS CDK Reference

Appearance

v2.274.0

NamespaceRuleBasedPropertiesProperty Struct ​

The rule-based properties of an ID namespace.

These properties define how the ID namespace can be used in an ID mapping workflow.

Source
Generated code
Type last changed
v2.154.0 · 22 Aug 2024

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_entityresolution as entityresolution } from 'aws-cdk-lib';
const namespaceRuleBasedPropertiesProperty: entityresolution.CfnIdNamespace.NamespaceRuleBasedPropertiesProperty = {
  attributeMatchingModel: 'attributeMatchingModel',
  recordMatchingModels: ['recordMatchingModels'],
  ruleDefinitionTypes: ['ruleDefinitionTypes'],
  rules: [{
    matchingKeys: ['matchingKeys'],
    ruleName: 'ruleName',
  }],
};

Properties ​

attributeMatchingModeloptionalstringattribute_matching_modeloptionalstrattributeMatchingModeloptionalStringAttributeMatchingModeloptionalstringAttributeMatchingModeloptional*string#
The comparison type. You can either choose `ONE_TO_ONE` or `MANY_TO_MANY` as the `attributeMatchingModel` .
notes

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 BusinessEmail field of Profile B, the two profiles are matched on the Email attribute type.

recordMatchingModelsoptionalstring[]record_matching_modelsoptionaltyping.List[str]recordMatchingModelsoptionalList<String>RecordMatchingModelsoptionalstring[]RecordMatchingModelsoptional*[]*string#
The type of matching record that is allowed to be used in an ID mapping workflow.
notes

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

If the value is set to MANY_SOURCE_TO_ONE_TARGET , all matching records in the source are matched to one record in the target.

ruleDefinitionTypesoptionalstring[]rule_definition_typesoptionaltyping.List[str]ruleDefinitionTypesoptionalList<String>RuleDefinitionTypesoptionalstring[]RuleDefinitionTypesoptional*[]*string#
The sets of rules you can use in an ID mapping workflow.

The limitations specified for the source and target must be compatible.

rulesoptionalIResolvable | IResolvable | CfnIdNamespace.RuleProperty[]rulesoptionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, RuleProperty]]]rulesoptionalIResolvableRulesoptionalIResolvableRulesoptionalinterface{}#
The rules for the ID namespace.