AWS::EntityResolution::IdMappingWorkflow - 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::IdMappingWorkflow

Creates an IdMappingWorkflow object which stores the configuration of the data processing job to be run. Each IdMappingWorkflow must have a unique workflow name. To modify an existing workflow, use the UpdateIdMappingWorkflow API.

Important

Incremental processing is not supported for ID mapping workflows.

Syntax

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

JSON

{
  "Type" : "AWS::EntityResolution::IdMappingWorkflow",
  "Properties" : {
      "Description" : String,
      "IdMappingTechniques" : IdMappingTechniques,
      "InputSourceConfig" : [ IdMappingWorkflowInputSource, ... ],
      "OutputSourceConfig" : [ IdMappingWorkflowOutputSource, ... ],
      "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

IdMappingTechniques

An object which defines the ID mapping technique and any additional configurations.

Required: Yes

Type: IdMappingTechniques

Update requires: No interruption

InputSourceConfig

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

Required: Yes

Type: Array of IdMappingWorkflowInputSource

Minimum: 1

Maximum: 20

Update requires: No interruption

OutputSourceConfig

A list of IdMappingWorkflowOutputSource objects, each of which contains fields outputS3Path and KMSArn.

Required: No

Type: Array of IdMappingWorkflowOutputSource

Minimum: 1

Maximum: 1

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 IdMappingWorkflows with the same name.

Required: Yes

Type: String

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

Minimum: 0

Maximum: 255

Update requires: Replacement