# CfnIdMappingWorkflowProps

Properties for defining a `CfnIdMappingWorkflow`.

Extends: CfnIdMappingWorkflowProps
Used as props by: CfnIdMappingWorkflow

- Source: Generated code
- Type last changed: v2.214.0 · 2 Sep 2025

## 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 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',
  }],
};
```

## Properties

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

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

- `idMappingTechniques`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnIdMappingWorkflow.IdMappingTechniquesProperty](/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](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnIdMappingWorkflow.IdMappingWorkflowInputSourceProperty](/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](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnIdMappingWorkflow.IdMappingWorkflowOutputSourceProperty](/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](/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.