View a markdown version of this page

AWS::EntityResolution::MatchingWorkflow - Amazon CloudFormation
SyntaxProperties
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

This is the new Amazon CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the Amazon CloudFormation User Guide.

AWS::EntityResolution::MatchingWorkflow

Creates a matching workflow that defines the configuration for a data processing job. The workflow name must be unique. To modify an existing workflow, use UpdateMatchingWorkflow.

Important

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

Syntax

To declare this entity in your Amazon CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::EntityResolution::MatchingWorkflow",
  "Properties" : {
      "Description" : String,
      "IncrementalRunConfig" : IncrementalRunConfig,
      "InputSourceConfig" : [ InputSource, ... ],
      "OutputSourceConfig" : [ OutputSource, ... ],
      "ResolutionTechniques" : ResolutionTechniques,
      "RoleArn" : String,
      "Tags" : [ Tag, ... ],
      "WorkflowName" : String
    }
}

Properties

Description

A description of the workflow.

Required: No

Type: String

Minimum: 0

Maximum: 255

Update requires: No interruption

IncrementalRunConfig

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

Important

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

Required: No

Type: IncrementalRunConfig

Update requires: No interruption

InputSourceConfig

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

Required: Yes

Type: Array of InputSource

Minimum: 1

Maximum: 20

Update requires: No interruption

OutputSourceConfig

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

Required: Yes

Type: Array of OutputSource

Minimum: 1

Maximum: 1

Update requires: No interruption

ResolutionTechniques

An object which defines the resolutionType and the ruleBasedProperties.

Required: Yes

Type: ResolutionTechniques

Update requires: No interruption

RoleArn

The Amazon Resource Name (ARN) of the IAM role. Amazon Entity Resolution assumes this role to create resources on your behalf as part of workflow execution.

Required: Yes

Type: String

Pattern: ^arn:(aws|aws-us-gov|aws-cn):iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+$

Update requires: No interruption

Tags

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

Required: No

Type: Array of Tag

Minimum: 0

Maximum: 200

Update requires: No interruption

WorkflowName

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

Required: Yes

Type: String

Pattern: ^[a-zA-Z_0-9-]*$

Minimum: 0

Maximum: 255

Update requires: Replacement