# IdMappingRuleBasedPropertiesProperty

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

- Source: Generated at build time
- Type last changed: v2.154.0 · 22 Aug 2024

## Example

TypeScript:

```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 idMappingRuleBasedPropertiesProperty: entityresolution.CfnIdMappingWorkflow.IdMappingRuleBasedPropertiesProperty = {
  attributeMatchingModel: 'attributeMatchingModel',
  recordMatchingModel: 'recordMatchingModel',

  // the properties below are optional
  ruleDefinitionType: 'ruleDefinitionType',
  rules: [{
    matchingKeys: ['matchingKeys'],
    ruleName: 'ruleName',
  }],
};
```

Python:

```python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_entityresolution as entityresolution

id_mapping_rule_based_properties_property = entityresolution.CfnIdMappingWorkflow.IdMappingRuleBasedPropertiesProperty(
    attribute_matching_model="attributeMatchingModel",
    record_matching_model="recordMatchingModel",

    # the properties below are optional
    rule_definition_type="ruleDefinitionType",
    rules=[entityresolution.CfnIdMappingWorkflow.RuleProperty(
        matching_keys=["matchingKeys"],
        rule_name="ruleName"
    )]
)
```

Java:

```java
// 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();
```

C# / .NET:

```csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.EntityResolution;

var idMappingRuleBasedPropertiesProperty = new IdMappingRuleBasedPropertiesProperty {
    AttributeMatchingModel = "attributeMatchingModel",
    RecordMatchingModel = "recordMatchingModel",

    // the properties below are optional
    RuleDefinitionType = "ruleDefinitionType",
    Rules = new [] { new RuleProperty {
        MatchingKeys = new [] { "matchingKeys" },
        RuleName = "ruleName"
    } }
};
```

Golang:

```go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

idMappingRuleBasedPropertiesProperty := &IdMappingRuleBasedPropertiesProperty{
	AttributeMatchingModel: jsii.String("attributeMatchingModel"),
	RecordMatchingModel: jsii.String("recordMatchingModel"),

	// the properties below are optional
	RuleDefinitionType: jsii.String("ruleDefinitionType"),
	Rules: []interface{}{
		&RuleProperty{
			MatchingKeys: []*string{
				jsii.String("matchingKeys"),
			},
			RuleName: jsii.String("ruleName"),
		},
	},
}
```

## Properties

- `attributeMatchingModel`: string (required) — 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.

- `recordMatchingModel`: string (required) — 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.

- `ruleDefinitionType`: string — 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.

- `rules`: [IResolvable](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [IResolvable](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnIdMappingWorkflow.RuleProperty](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_entityresolution.CfnIdMappingWorkflow.RuleProperty.html)[] — The rules that can be used for ID mapping.
