Skip to content
v2.274.0

CfnIdMappingWorkflowProps Struct ​

Properties for defining a CfnIdMappingWorkflow.

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 ​

descriptionoptionalstringdescriptionoptionalstrdescriptionoptionalStringDescriptionoptionalstringDescriptionoptional*string#
A description of the workflow.
idMappingIncrementalRunConfigoptionalIResolvable | CfnIdMappingWorkflow.IdMappingIncrementalRunConfigPropertyid_mapping_incremental_run_configoptionaltyping.Union[IResolvable, IdMappingIncrementalRunConfigProperty]idMappingIncrementalRunConfigoptionalIResolvableIdMappingIncrementalRunConfigoptionalIResolvableIdMappingIncrementalRunConfigoptionalinterface{}#
idMappingTechniquesIResolvable | CfnIdMappingWorkflow.IdMappingTechniquesPropertyid_mapping_techniquestyping.Union[IResolvable, IdMappingTechniquesProperty]idMappingTechniquesIResolvableIdMappingTechniquesIResolvableIdMappingTechniquesinterface{}required#
An object which defines the ID mapping technique and any additional configurations.
inputSourceConfigIResolvable | IResolvable | CfnIdMappingWorkflow.IdMappingWorkflowInputSourceProperty[]input_source_configtyping.Union[IResolvable, typing.List[typing.Union[IResolvable, IdMappingWorkflowInputSourceProperty]]]inputSourceConfigIResolvableInputSourceConfigIResolvableInputSourceConfiginterface{}required#
A list of `InputSource` objects, which have the fields `InputSourceARN` and `SchemaName` .
outputSourceConfigoptionalIResolvable | IResolvable | CfnIdMappingWorkflow.IdMappingWorkflowOutputSourceProperty[]output_source_configoptionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, IdMappingWorkflowOutputSourceProperty]]]outputSourceConfigoptionalIResolvableOutputSourceConfigoptionalIResolvableOutputSourceConfigoptionalinterface{}#
A list of `IdMappingWorkflowOutputSource` objects, each of which contains fields `outputS3Path` and `KMSArn` .
roleArnstringrole_arnstrroleArnStringRoleArnstringRoleArn*stringrequired#
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.

tagsoptionalCfnTag[]tagsoptionaltyping.List[CfnTag]tagsoptionalList<CfnTag>TagsoptionalCfnTag[]Tagsoptional*[]CfnTag#
The tags used to organize, track, or control access for this resource.
workflowNamestringworkflow_namestrworkflowNameStringWorkflowNamestringWorkflowName*stringrequired#
The name of the workflow.

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