interface CfnMatchingWorkflowProps

Language	Type name
.NET	`Amazon.CDK.AWS.EntityResolution.CfnMatchingWorkflowProps`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awsentityresolution#CfnMatchingWorkflowProps`
Java	`software.amazon.awscdk.services.entityresolution.CfnMatchingWorkflowProps`
Python	`aws_cdk.aws_entityresolution.CfnMatchingWorkflowProps`
TypeScript	`aws-cdk-lib` » `aws_entityresolution` » `CfnMatchingWorkflowProps`

Properties for defining a CfnMatchingWorkflow.

Example

// 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 cfnMatchingWorkflowProps: entityresolution.CfnMatchingWorkflowProps = {
  inputSourceConfig: [{
    inputSourceArn: 'inputSourceArn',
    schemaArn: 'schemaArn',

    // the properties below are optional
    applyNormalization: false,
  }],
  outputSourceConfig: [{
    output: [{
      name: 'name',

      // the properties below are optional
      hashed: false,
    }],
    outputS3Path: 'outputS3Path',

    // the properties below are optional
    applyNormalization: false,
    kmsArn: 'kmsArn',
  }],
  resolutionTechniques: {
    providerProperties: {
      providerServiceArn: 'providerServiceArn',

      // the properties below are optional
      intermediateSourceConfiguration: {
        intermediateS3Path: 'intermediateS3Path',
      },
      providerConfiguration: {
        providerConfigurationKey: 'providerConfiguration',
      },
    },
    resolutionType: 'resolutionType',
    ruleBasedProperties: {
      attributeMatchingModel: 'attributeMatchingModel',
      rules: [{
        matchingKeys: ['matchingKeys'],
        ruleName: 'ruleName',
      }],

      // the properties below are optional
      matchPurpose: 'matchPurpose',
    },
    ruleConditionProperties: {
      rules: [{
        condition: 'condition',
        ruleName: 'ruleName',
      }],
    },
  },
  roleArn: 'roleArn',
  workflowName: 'workflowName',

  // the properties below are optional
  description: 'description',
  incrementalRunConfig: {
    incrementalRunType: 'incrementalRunType',
  },
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties

Name	Type	Description
inputSourceConfig	`IResolvable` `\| (IResolvable` `\|` `InputSourceProperty)[]`	A list of `InputSource` objects, which have the fields `InputSourceARN` and `SchemaName` .
outputSourceConfig	`IResolvable` `\| (IResolvable` `\|` `OutputSourceProperty)[]`	A list of `OutputSource` objects, each of which contains fields `outputS3Path` , `applyNormalization` , `KMSArn` , and `output` .
resolutionTechniques	`IResolvable` `\|` `ResolutionTechniquesProperty`	An object which defines the `resolutionType` and the `ruleBasedProperties` .
roleArn	`string`	The Amazon Resource Name (ARN) of the IAM role.
workflowName	`string`	The name of the workflow.
description?	`string`	A description of the workflow.
incrementalRunConfig?	`IResolvable` `\|` `IncrementalRunConfigProperty`	Optional.
tags?	`CfnTag[]`	The tags used to organize, track, or control access for this resource.

inputSourceConfig

Type: IResolvable | (IResolvable | InputSourceProperty)[]

A list of InputSource objects, which have the fields InputSourceARN and SchemaName .

outputSourceConfig

Type: IResolvable | (IResolvable | OutputSourceProperty)[]

A list of OutputSource objects, each of which contains fields outputS3Path , applyNormalization , KMSArn , and output .

resolutionTechniques

Type: IResolvable | ResolutionTechniquesProperty

An object which defines the resolutionType and the ruleBasedProperties .

roleArn

Type: string

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.

workflowName

Type: string

The name of the workflow.

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

description?

Type: string (optional)

A description of the workflow.

incrementalRunConfig?

Type: IResolvable | IncrementalRunConfigProperty (optional)

Optional.

An object that defines the incremental run type. This object contains only the incrementalRunType field, which appears as "Automatic" in the console.

For workflows where resolutionType is ML_MATCHING or PROVIDER , incremental processing is not supported.

tags?

Type: CfnTag[] (optional)

The tags used to organize, track, or control access for this resource.