# CfnIdMappingWorkflowProps

Properties for defining a `CfnIdMappingWorkflow`.

Used as props by: [CfnIdMappingWorkflow](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_entityresolution.CfnIdMappingWorkflow.html)

- Source: Generated at build time
- Type last changed: v2.214.0 · 2 Sep 2025

## 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 cfnIdMappingWorkflowProps: entityresolution.CfnIdMappingWorkflowProps = {
  idMappingTechniques: {
    idMappingType: 'idMappingType',
    normalizationVersion: 'normalizationVersion',
    providerProperties: {
      providerServiceArn: 'providerServiceArn',

      // the properties below are optional
      intermediateSourceConfiguration: {
        intermediateS3Path: 'intermediateS3Path',
      },
      providerConfiguration: {
        providerConfigurationKey: 'providerConfiguration',
      },
    },
    ruleBasedProperties: {
      attributeMatchingModel: 'attributeMatchingModel',
      recordMatchingModel: 'recordMatchingModel',

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

    // the properties below are optional
    schemaArn: 'schemaArn',
    type: 'type',
  }],
  roleArn: 'roleArn',
  workflowName: 'workflowName',

  // the properties below are optional
  description: 'description',
  idMappingIncrementalRunConfig: {
    incrementalRunType: 'incrementalRunType',
  },
  outputSourceConfig: [{
    outputS3Path: 'outputS3Path',

    // the properties below are optional
    kmsArn: 'kmsArn',
  }],
  tags: [{
    key: 'key',
    value: 'value',
  }],
};
```

Python:

```python
from aws_cdk import CfnTag
# 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

cfn_id_mapping_workflow_props = entityresolution.CfnIdMappingWorkflowProps(
    id_mapping_techniques=entityresolution.CfnIdMappingWorkflow.IdMappingTechniquesProperty(
        id_mapping_type="idMappingType",
        normalization_version="normalizationVersion",
        provider_properties=entityresolution.CfnIdMappingWorkflow.ProviderPropertiesProperty(
            provider_service_arn="providerServiceArn",

            # the properties below are optional
            intermediate_source_configuration=entityresolution.CfnIdMappingWorkflow.IntermediateSourceConfigurationProperty(
                intermediate_s3_path="intermediateS3Path"
            ),
            provider_configuration={
                "provider_configuration_key": "providerConfiguration"
            }
        ),
        rule_based_properties=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"
            )]
        )
    ),
    input_source_config=[entityresolution.CfnIdMappingWorkflow.IdMappingWorkflowInputSourceProperty(
        input_source_arn="inputSourceArn",

        # the properties below are optional
        schema_arn="schemaArn",
        type="type"
    )],
    role_arn="roleArn",
    workflow_name="workflowName",

    # the properties below are optional
    description="description",
    id_mapping_incremental_run_config=entityresolution.CfnIdMappingWorkflow.IdMappingIncrementalRunConfigProperty(
        incremental_run_type="incrementalRunType"
    ),
    output_source_config=[entityresolution.CfnIdMappingWorkflow.IdMappingWorkflowOutputSourceProperty(
        output_s3_path="outputS3Path",

        # the properties below are optional
        kms_arn="kmsArn"
    )],
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)
```

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.*;

CfnIdMappingWorkflowProps cfnIdMappingWorkflowProps = CfnIdMappingWorkflowProps.builder()
        .idMappingTechniques(IdMappingTechniquesProperty.builder()
                .idMappingType("idMappingType")
                .normalizationVersion("normalizationVersion")
                .providerProperties(ProviderPropertiesProperty.builder()
                        .providerServiceArn("providerServiceArn")

                        // the properties below are optional
                        .intermediateSourceConfiguration(IntermediateSourceConfigurationProperty.builder()
                                .intermediateS3Path("intermediateS3Path")
                                .build())
                        .providerConfiguration(Map.of(
                                "providerConfigurationKey", "providerConfiguration"))
                        .build())
                .ruleBasedProperties(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())
                .build())
        .inputSourceConfig(List.of(IdMappingWorkflowInputSourceProperty.builder()
                .inputSourceArn("inputSourceArn")

                // the properties below are optional
                .schemaArn("schemaArn")
                .type("type")
                .build()))
        .roleArn("roleArn")
        .workflowName("workflowName")

        // the properties below are optional
        .description("description")
        .idMappingIncrementalRunConfig(IdMappingIncrementalRunConfigProperty.builder()
                .incrementalRunType("incrementalRunType")
                .build())
        .outputSourceConfig(List.of(IdMappingWorkflowOutputSourceProperty.builder()
                .outputS3Path("outputS3Path")

                // the properties below are optional
                .kmsArn("kmsArn")
                .build()))
        .tags(List.of(CfnTag.builder()
                .key("key")
                .value("value")
                .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 cfnIdMappingWorkflowProps = new CfnIdMappingWorkflowProps {
    IdMappingTechniques = new IdMappingTechniquesProperty {
        IdMappingType = "idMappingType",
        NormalizationVersion = "normalizationVersion",
        ProviderProperties = new ProviderPropertiesProperty {
            ProviderServiceArn = "providerServiceArn",

            // the properties below are optional
            IntermediateSourceConfiguration = new IntermediateSourceConfigurationProperty {
                IntermediateS3Path = "intermediateS3Path"
            },
            ProviderConfiguration = new Dictionary<string, string> {
                { "providerConfigurationKey", "providerConfiguration" }
            }
        },
        RuleBasedProperties = new IdMappingRuleBasedPropertiesProperty {
            AttributeMatchingModel = "attributeMatchingModel",
            RecordMatchingModel = "recordMatchingModel",

            // the properties below are optional
            RuleDefinitionType = "ruleDefinitionType",
            Rules = new [] { new RuleProperty {
                MatchingKeys = new [] { "matchingKeys" },
                RuleName = "ruleName"
            } }
        }
    },
    InputSourceConfig = new [] { new IdMappingWorkflowInputSourceProperty {
        InputSourceArn = "inputSourceArn",

        // the properties below are optional
        SchemaArn = "schemaArn",
        Type = "type"
    } },
    RoleArn = "roleArn",
    WorkflowName = "workflowName",

    // the properties below are optional
    Description = "description",
    IdMappingIncrementalRunConfig = new IdMappingIncrementalRunConfigProperty {
        IncrementalRunType = "incrementalRunType"
    },
    OutputSourceConfig = new [] { new IdMappingWorkflowOutputSourceProperty {
        OutputS3Path = "outputS3Path",

        // the properties below are optional
        KmsArn = "kmsArn"
    } },
    Tags = new [] { new CfnTag {
        Key = "key",
        Value = "value"
    } }
};
```

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"

cfnIdMappingWorkflowProps := &CfnIdMappingWorkflowProps{
	IdMappingTechniques: &IdMappingTechniquesProperty{
		IdMappingType: jsii.String("idMappingType"),
		NormalizationVersion: jsii.String("normalizationVersion"),
		ProviderProperties: &ProviderPropertiesProperty{
			ProviderServiceArn: jsii.String("providerServiceArn"),

			// the properties below are optional
			IntermediateSourceConfiguration: &IntermediateSourceConfigurationProperty{
				IntermediateS3Path: jsii.String("intermediateS3Path"),
			},
			ProviderConfiguration: map[string]*string{
				"providerConfigurationKey": jsii.String("providerConfiguration"),
			},
		},
		RuleBasedProperties: &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"),
				},
			},
		},
	},
	InputSourceConfig: []interface{}{
		&IdMappingWorkflowInputSourceProperty{
			InputSourceArn: jsii.String("inputSourceArn"),

			// the properties below are optional
			SchemaArn: jsii.String("schemaArn"),
			Type: jsii.String("type"),
		},
	},
	RoleArn: jsii.String("roleArn"),
	WorkflowName: jsii.String("workflowName"),

	// the properties below are optional
	Description: jsii.String("description"),
	IdMappingIncrementalRunConfig: &IdMappingIncrementalRunConfigProperty{
		IncrementalRunType: jsii.String("incrementalRunType"),
	},
	OutputSourceConfig: []interface{}{
		&IdMappingWorkflowOutputSourceProperty{
			OutputS3Path: jsii.String("outputS3Path"),

			// the properties below are optional
			KmsArn: jsii.String("kmsArn"),
		},
	},
	Tags: []CfnTag{
		&CfnTag{
			Key: jsii.String("key"),
			Value: jsii.String("value"),
		},
	},
}
```

## Properties

- `description`: string — A description of the workflow.

- `idMappingIncrementalRunConfig`: [IResolvable](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnIdMappingWorkflow.IdMappingIncrementalRunConfigProperty](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_entityresolution.CfnIdMappingWorkflow.IdMappingIncrementalRunConfigProperty.html)

- `idMappingTechniques`: [IResolvable](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnIdMappingWorkflow.IdMappingTechniquesProperty](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_entityresolution.CfnIdMappingWorkflow.IdMappingTechniquesProperty.html) (required) — An object which defines the ID mapping technique and any additional configurations.

- `inputSourceConfig`: [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.IdMappingWorkflowInputSourceProperty](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_entityresolution.CfnIdMappingWorkflow.IdMappingWorkflowInputSourceProperty.html)[] (required) — A list of `InputSource` objects, which have the fields `InputSourceARN` and `SchemaName` .

- `outputSourceConfig`: [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.IdMappingWorkflowOutputSourceProperty](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_entityresolution.CfnIdMappingWorkflow.IdMappingWorkflowOutputSourceProperty.html)[] — A list of `IdMappingWorkflowOutputSource` objects, each of which contains fields `outputS3Path` and `KMSArn` .

- `roleArn`: string (required) — The Amazon Resource Name (ARN) of the IAM role.

  AWS Entity Resolution assumes this role to create resources on your behalf as part of workflow execution.

- `tags`: [CfnTag](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.CfnTag.html)[] — The tags used to organize, track, or control access for this resource.

- `workflowName`: string (required) — The name of the workflow.

  There can't be multiple `IdMappingWorkflows` with the same name.
