AWS::EntityResolution::MatchingWorkflow - AWS CloudFormation (original) (raw)

Creates a MatchingWorkflow object which stores the configuration of the data processing job to be run. It is important to note that there should not be a pre-existing MatchingWorkflow with the same name. To modify an existing workflow, utilize the UpdateMatchingWorkflow API.

Syntax

To declare this entity in your AWS 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

An object which defines an incremental run type and has onlyincrementalRunType as a field.

Required: No

Type: IncrementalRunConfig

Update requires: No interruption

InputSourceConfig

A list of InputSource objects, which have the fieldsInputSourceARN 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 fieldsOutputS3Path, ApplyNormalization, andOutput.

Required: Yes

Type: Array of OutputSource

Minimum: 1

Maximum: 1

Update requires: No interruption

ResolutionTechniques

An object which defines the resolutionType and theruleBasedProperties.

Required: Yes

Type: ResolutionTechniques

Update requires: No interruption

RoleArn

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.

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

Did this page help you? - Yes

Thanks for letting us know we're doing a good job!

If you've got a moment, please tell us what we did right so we can do more of it.

Did this page help you? - No

Thanks for letting us know this page needs work. We're sorry we let you down.

If you've got a moment, please tell us how we can make the documentation better.