aws-cdk-lib.aws_entityresolution.CfnMatchingWorkflowProps

CfnMatchingWorkflowProps Struct

Properties for defining a CfnMatchingWorkflow.

CfnMatchingWorkflowProps

used as props by

• CfnMatchingWorkflow

Source

Generated code

Type last changed

v2.157.0 · 10 Sep 2024

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,
    }],

    // the properties below are optional
    applyNormalization: false,
    customerProfilesIntegrationConfig: {
      domainArn: 'domainArn',
      objectTypeArn: 'objectTypeArn',
    },
    kmsArn: 'kmsArn',
    outputS3Path: 'outputS3Path',
  }],
  resolutionTechniques: {
    enableRealTimeMatching: false,
    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',
      }],

      // the properties below are optional
      matchingConfig: {
        enableTransitiveMatching: false,
      },
    },
  },
  roleArn: 'roleArn',
  workflowName: 'workflowName',

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

Properties

descriptionstringdescriptionstrdescriptionStringDescriptionstringDescription*string#

A description of the workflow.

incrementalRunConfigIResolvable | CfnMatchingWorkflow.IncrementalRunConfigPropertyincremental_run_configtyping.Union[IResolvable, IncrementalRunConfigProperty]incrementalRunConfigIResolvableIncrementalRunConfigIResolvableIncrementalRunConfiginterface{}#

Optional.

notes

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.

inputSourceConfigIResolvable | IResolvable | CfnMatchingWorkflow.InputSourceProperty[]input_source_configtyping.Union[IResolvable, typing.List[typing.Union[IResolvable, InputSourceProperty]]]inputSourceConfigIResolvableInputSourceConfigIResolvableInputSourceConfiginterface{}required#

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

outputSourceConfigIResolvable | IResolvable | CfnMatchingWorkflow.OutputSourceProperty[]output_source_configtyping.Union[IResolvable, typing.List[typing.Union[IResolvable, OutputSourceProperty]]]outputSourceConfigIResolvableOutputSourceConfigIResolvableOutputSourceConfiginterface{}required#

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

resolutionTechniquesIResolvable | CfnMatchingWorkflow.ResolutionTechniquesPropertyresolution_techniquestyping.Union[IResolvable, ResolutionTechniquesProperty]resolutionTechniquesIResolvableResolutionTechniquesIResolvableResolutionTechniquesinterface{}required#

An object which defines the `resolutionType` and the `ruleBasedProperties` .

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.

tagsCfnTag[]tagstyping.List[CfnTag]tagsList<CfnTag>TagsCfnTag[]Tags*[]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 MatchingWorkflows with the same name.