

This is the new *CloudFormation Template Reference Guide*. Please update your bookmarks and links. For help getting started with CloudFormation, see the [AWS CloudFormation User Guide](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/Welcome.html).

# AWS::EntityResolution::IdMappingWorkflow
<a name="aws-resource-entityresolution-idmappingworkflow"></a>

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
<a name="aws-resource-entityresolution-idmappingworkflow-syntax"></a>

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

### JSON
<a name="aws-resource-entityresolution-idmappingworkflow-syntax.json"></a>

```
{
  "Type" : "AWS::EntityResolution::IdMappingWorkflow",
  "Properties" : {
      "[Description](#cfn-entityresolution-idmappingworkflow-description)" : String,
      "[IdMappingIncrementalRunConfig](#cfn-entityresolution-idmappingworkflow-idmappingincrementalrunconfig)" : IdMappingIncrementalRunConfig,
      "[IdMappingTechniques](#cfn-entityresolution-idmappingworkflow-idmappingtechniques)" : IdMappingTechniques,
      "[InputSourceConfig](#cfn-entityresolution-idmappingworkflow-inputsourceconfig)" : [ IdMappingWorkflowInputSource, ... ],
      "[OutputSourceConfig](#cfn-entityresolution-idmappingworkflow-outputsourceconfig)" : [ IdMappingWorkflowOutputSource, ... ],
      "[RoleArn](#cfn-entityresolution-idmappingworkflow-rolearn)" : String,
      "[Tags](#cfn-entityresolution-idmappingworkflow-tags)" : [ Tag, ... ],
      "[WorkflowName](#cfn-entityresolution-idmappingworkflow-workflowname)" : String
    }
}
```

### YAML
<a name="aws-resource-entityresolution-idmappingworkflow-syntax.yaml"></a>

```
Type: AWS::EntityResolution::IdMappingWorkflow
Properties:
  [Description](#cfn-entityresolution-idmappingworkflow-description): String
  [IdMappingIncrementalRunConfig](#cfn-entityresolution-idmappingworkflow-idmappingincrementalrunconfig): 
    IdMappingIncrementalRunConfig
  [IdMappingTechniques](#cfn-entityresolution-idmappingworkflow-idmappingtechniques): 
    IdMappingTechniques
  [InputSourceConfig](#cfn-entityresolution-idmappingworkflow-inputsourceconfig): 
    - IdMappingWorkflowInputSource
  [OutputSourceConfig](#cfn-entityresolution-idmappingworkflow-outputsourceconfig): 
    - IdMappingWorkflowOutputSource
  [RoleArn](#cfn-entityresolution-idmappingworkflow-rolearn): String
  [Tags](#cfn-entityresolution-idmappingworkflow-tags): 
    - Tag
  [WorkflowName](#cfn-entityresolution-idmappingworkflow-workflowname): String
```

## Properties
<a name="aws-resource-entityresolution-idmappingworkflow-properties"></a>

`Description`  <a name="cfn-entityresolution-idmappingworkflow-description"></a>
A description of the workflow.  
*Required*: No  
*Type*: String  
*Minimum*: `0`  
*Maximum*: `255`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`IdMappingIncrementalRunConfig`  <a name="cfn-entityresolution-idmappingworkflow-idmappingincrementalrunconfig"></a>
Property description not available.  
*Required*: No  
*Type*: [IdMappingIncrementalRunConfig](aws-properties-entityresolution-idmappingworkflow-idmappingincrementalrunconfig.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`IdMappingTechniques`  <a name="cfn-entityresolution-idmappingworkflow-idmappingtechniques"></a>
An object which defines the ID mapping technique and any additional configurations.  
*Required*: Yes  
*Type*: [IdMappingTechniques](aws-properties-entityresolution-idmappingworkflow-idmappingtechniques.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`InputSourceConfig`  <a name="cfn-entityresolution-idmappingworkflow-inputsourceconfig"></a>
A list of `InputSource` objects, which have the fields `InputSourceARN` and `SchemaName`.  
*Required*: Yes  
*Type*: Array of [IdMappingWorkflowInputSource](aws-properties-entityresolution-idmappingworkflow-idmappingworkflowinputsource.md)  
*Minimum*: `1`  
*Maximum*: `20`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`OutputSourceConfig`  <a name="cfn-entityresolution-idmappingworkflow-outputsourceconfig"></a>
A list of `IdMappingWorkflowOutputSource` objects, each of which contains fields `outputS3Path` and `KMSArn`.  
*Required*: No  
*Type*: Array of [IdMappingWorkflowOutputSource](aws-properties-entityresolution-idmappingworkflow-idmappingworkflowoutputsource.md)  
*Minimum*: `1`  
*Maximum*: `1`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`RoleArn`  <a name="cfn-entityresolution-idmappingworkflow-rolearn"></a>
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](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Tags`  <a name="cfn-entityresolution-idmappingworkflow-tags"></a>
The tags used to organize, track, or control access for this resource.  
*Required*: No  
*Type*: Array of [Tag](aws-properties-entityresolution-idmappingworkflow-tag.md)  
*Minimum*: `0`  
*Maximum*: `200`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`WorkflowName`  <a name="cfn-entityresolution-idmappingworkflow-workflowname"></a>
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](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

# AWS::EntityResolution::IdMappingWorkflow IdMappingIncrementalRunConfig
<a name="aws-properties-entityresolution-idmappingworkflow-idmappingincrementalrunconfig"></a>

<a name="aws-properties-entityresolution-idmappingworkflow-idmappingincrementalrunconfig-description"></a>The `IdMappingIncrementalRunConfig` property type specifies Property description not available. for an [AWS::EntityResolution::IdMappingWorkflow](aws-resource-entityresolution-idmappingworkflow.md).

## Syntax
<a name="aws-properties-entityresolution-idmappingworkflow-idmappingincrementalrunconfig-syntax"></a>

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

### JSON
<a name="aws-properties-entityresolution-idmappingworkflow-idmappingincrementalrunconfig-syntax.json"></a>

```
{
  "[IncrementalRunType](#cfn-entityresolution-idmappingworkflow-idmappingincrementalrunconfig-incrementalruntype)" : String
}
```

### YAML
<a name="aws-properties-entityresolution-idmappingworkflow-idmappingincrementalrunconfig-syntax.yaml"></a>

```
  [IncrementalRunType](#cfn-entityresolution-idmappingworkflow-idmappingincrementalrunconfig-incrementalruntype): String
```

## Properties
<a name="aws-properties-entityresolution-idmappingworkflow-idmappingincrementalrunconfig-properties"></a>

`IncrementalRunType`  <a name="cfn-entityresolution-idmappingworkflow-idmappingincrementalrunconfig-incrementalruntype"></a>
Property description not available.  
*Required*: Yes  
*Type*: String  
*Allowed values*: `ON_DEMAND`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::EntityResolution::IdMappingWorkflow IdMappingRuleBasedProperties
<a name="aws-properties-entityresolution-idmappingworkflow-idmappingrulebasedproperties"></a>

 An object that defines the list of matching rules to run in an ID mapping workflow.

## Syntax
<a name="aws-properties-entityresolution-idmappingworkflow-idmappingrulebasedproperties-syntax"></a>

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

### JSON
<a name="aws-properties-entityresolution-idmappingworkflow-idmappingrulebasedproperties-syntax.json"></a>

```
{
  "[AttributeMatchingModel](#cfn-entityresolution-idmappingworkflow-idmappingrulebasedproperties-attributematchingmodel)" : String,
  "[RecordMatchingModel](#cfn-entityresolution-idmappingworkflow-idmappingrulebasedproperties-recordmatchingmodel)" : String,
  "[RuleDefinitionType](#cfn-entityresolution-idmappingworkflow-idmappingrulebasedproperties-ruledefinitiontype)" : String,
  "[Rules](#cfn-entityresolution-idmappingworkflow-idmappingrulebasedproperties-rules)" : [ Rule, ... ]
}
```

### YAML
<a name="aws-properties-entityresolution-idmappingworkflow-idmappingrulebasedproperties-syntax.yaml"></a>

```
  [AttributeMatchingModel](#cfn-entityresolution-idmappingworkflow-idmappingrulebasedproperties-attributematchingmodel): String
  [RecordMatchingModel](#cfn-entityresolution-idmappingworkflow-idmappingrulebasedproperties-recordmatchingmodel): String
  [RuleDefinitionType](#cfn-entityresolution-idmappingworkflow-idmappingrulebasedproperties-ruledefinitiontype): String
  [Rules](#cfn-entityresolution-idmappingworkflow-idmappingrulebasedproperties-rules): 
    - Rule
```

## Properties
<a name="aws-properties-entityresolution-idmappingworkflow-idmappingrulebasedproperties-properties"></a>

`AttributeMatchingModel`  <a name="cfn-entityresolution-idmappingworkflow-idmappingrulebasedproperties-attributematchingmodel"></a>
The comparison type. You can either choose `ONE_TO_ONE` or `MANY_TO_MANY` as the `attributeMatchingModel`.   
If you choose `ONE_TO_ONE`, the system can only match attributes if the sub-types are an exact match. For example, for the `Email` attribute type, the system will only consider it a match if the value of the `Email` field of Profile A matches the value of the `Email` field of Profile B.  
If you choose `MANY_TO_MANY`, the system can match attributes across the sub-types of an attribute type. For example, if the value of the `Email` field of Profile A matches the value of the `BusinessEmail` field of Profile B, the two profiles are matched on the `Email` attribute type.   
*Required*: Yes  
*Type*: String  
*Allowed values*: `ONE_TO_ONE | MANY_TO_MANY`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`RecordMatchingModel`  <a name="cfn-entityresolution-idmappingworkflow-idmappingrulebasedproperties-recordmatchingmodel"></a>
 The type of matching record that is allowed to be used in an ID mapping workflow.   
If the value is set to `ONE_SOURCE_TO_ONE_TARGET`, only one record in the source can be matched to the same record in the target.  
If the value is set to `MANY_SOURCE_TO_ONE_TARGET`, multiple records in the source can be matched to one record in the target.  
*Required*: Yes  
*Type*: String  
*Allowed values*: `ONE_SOURCE_TO_ONE_TARGET | MANY_SOURCE_TO_ONE_TARGET`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`RuleDefinitionType`  <a name="cfn-entityresolution-idmappingworkflow-idmappingrulebasedproperties-ruledefinitiontype"></a>
 The set of rules you can use in an ID mapping workflow. The limitations specified for the source or target to define the match rules must be compatible.  
*Required*: No  
*Type*: String  
*Allowed values*: `SOURCE | TARGET`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Rules`  <a name="cfn-entityresolution-idmappingworkflow-idmappingrulebasedproperties-rules"></a>
 The rules that can be used for ID mapping.  
*Required*: No  
*Type*: Array of [Rule](aws-properties-entityresolution-idmappingworkflow-rule.md)  
*Minimum*: `1`  
*Maximum*: `25`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::EntityResolution::IdMappingWorkflow IdMappingTechniques
<a name="aws-properties-entityresolution-idmappingworkflow-idmappingtechniques"></a>

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

## Syntax
<a name="aws-properties-entityresolution-idmappingworkflow-idmappingtechniques-syntax"></a>

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

### JSON
<a name="aws-properties-entityresolution-idmappingworkflow-idmappingtechniques-syntax.json"></a>

```
{
  "[IdMappingType](#cfn-entityresolution-idmappingworkflow-idmappingtechniques-idmappingtype)" : String,
  "[NormalizationVersion](#cfn-entityresolution-idmappingworkflow-idmappingtechniques-normalizationversion)" : String,
  "[ProviderProperties](#cfn-entityresolution-idmappingworkflow-idmappingtechniques-providerproperties)" : ProviderProperties,
  "[RuleBasedProperties](#cfn-entityresolution-idmappingworkflow-idmappingtechniques-rulebasedproperties)" : IdMappingRuleBasedProperties
}
```

### YAML
<a name="aws-properties-entityresolution-idmappingworkflow-idmappingtechniques-syntax.yaml"></a>

```
  [IdMappingType](#cfn-entityresolution-idmappingworkflow-idmappingtechniques-idmappingtype): String
  [NormalizationVersion](#cfn-entityresolution-idmappingworkflow-idmappingtechniques-normalizationversion): String
  [ProviderProperties](#cfn-entityresolution-idmappingworkflow-idmappingtechniques-providerproperties): 
    ProviderProperties
  [RuleBasedProperties](#cfn-entityresolution-idmappingworkflow-idmappingtechniques-rulebasedproperties): 
    IdMappingRuleBasedProperties
```

## Properties
<a name="aws-properties-entityresolution-idmappingworkflow-idmappingtechniques-properties"></a>

`IdMappingType`  <a name="cfn-entityresolution-idmappingworkflow-idmappingtechniques-idmappingtype"></a>
The type of ID mapping.  
*Required*: No  
*Type*: String  
*Allowed values*: `PROVIDER | RULE_BASED`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`NormalizationVersion`  <a name="cfn-entityresolution-idmappingworkflow-idmappingtechniques-normalizationversion"></a>
Property description not available.  
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ProviderProperties`  <a name="cfn-entityresolution-idmappingworkflow-idmappingtechniques-providerproperties"></a>
An object which defines any additional configurations required by the provider service.  
*Required*: No  
*Type*: [ProviderProperties](aws-properties-entityresolution-idmappingworkflow-providerproperties.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`RuleBasedProperties`  <a name="cfn-entityresolution-idmappingworkflow-idmappingtechniques-rulebasedproperties"></a>
 An object which defines any additional configurations required by rule-based matching.  
*Required*: No  
*Type*: [IdMappingRuleBasedProperties](aws-properties-entityresolution-idmappingworkflow-idmappingrulebasedproperties.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::EntityResolution::IdMappingWorkflow IdMappingWorkflowInputSource
<a name="aws-properties-entityresolution-idmappingworkflow-idmappingworkflowinputsource"></a>

An object containing `inputSourceARN`, `schemaName`, and `type`.

## Syntax
<a name="aws-properties-entityresolution-idmappingworkflow-idmappingworkflowinputsource-syntax"></a>

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

### JSON
<a name="aws-properties-entityresolution-idmappingworkflow-idmappingworkflowinputsource-syntax.json"></a>

```
{
  "[InputSourceARN](#cfn-entityresolution-idmappingworkflow-idmappingworkflowinputsource-inputsourcearn)" : String,
  "[SchemaArn](#cfn-entityresolution-idmappingworkflow-idmappingworkflowinputsource-schemaarn)" : String,
  "[Type](#cfn-entityresolution-idmappingworkflow-idmappingworkflowinputsource-type)" : String
}
```

### YAML
<a name="aws-properties-entityresolution-idmappingworkflow-idmappingworkflowinputsource-syntax.yaml"></a>

```
  [InputSourceARN](#cfn-entityresolution-idmappingworkflow-idmappingworkflowinputsource-inputsourcearn): String
  [SchemaArn](#cfn-entityresolution-idmappingworkflow-idmappingworkflowinputsource-schemaarn): String
  [Type](#cfn-entityresolution-idmappingworkflow-idmappingworkflowinputsource-type): String
```

## Properties
<a name="aws-properties-entityresolution-idmappingworkflow-idmappingworkflowinputsource-properties"></a>

`InputSourceARN`  <a name="cfn-entityresolution-idmappingworkflow-idmappingworkflowinputsource-inputsourcearn"></a>
An AWS Glue table Amazon Resource Name (ARN) or a matching workflow ARN for the input source table.  
*Required*: Yes  
*Type*: String  
*Pattern*: `^arn:(aws|aws-us-gov|aws-cn):entityresolution:[a-z]{2}-[a-z]{1,10}-[0-9]:[0-9]{12}:(idnamespace/[a-zA-Z_0-9-]{1,255})$|^arn:(aws|aws-us-gov|aws-cn):entityresolution:[a-z]{2}-[a-z]{1,10}-[0-9]:[0-9]{12}:(matchingworkflow/[a-zA-Z_0-9-]{1,255})$|^arn:(aws|aws-us-gov|aws-cn):glue:[a-z]{2}-[a-z]{1,10}-[0-9]:[0-9]{12}:(table/[a-zA-Z_0-9-]{1,255}/[a-zA-Z_0-9-]{1,255})$`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`SchemaArn`  <a name="cfn-entityresolution-idmappingworkflow-idmappingworkflowinputsource-schemaarn"></a>
The ARN (Amazon Resource Name) that AWS Entity Resolution generated for the `SchemaMapping`.  
*Required*: No  
*Type*: String  
*Pattern*: `^arn:(aws|aws-us-gov|aws-cn):entityresolution:.*:[0-9]+:(schemamapping/.*)$`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Type`  <a name="cfn-entityresolution-idmappingworkflow-idmappingworkflowinputsource-type"></a>
The type of ID namespace. There are two types: `SOURCE` and `TARGET`.   
The `SOURCE` contains configurations for `sourceId` data that will be processed in an ID mapping workflow.   
The `TARGET` contains a configuration of `targetId` which all `sourceIds` will resolve to.  
*Required*: No  
*Type*: String  
*Allowed values*: `SOURCE | TARGET`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::EntityResolution::IdMappingWorkflow IdMappingWorkflowOutputSource
<a name="aws-properties-entityresolution-idmappingworkflow-idmappingworkflowoutputsource"></a>

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

## Syntax
<a name="aws-properties-entityresolution-idmappingworkflow-idmappingworkflowoutputsource-syntax"></a>

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

### JSON
<a name="aws-properties-entityresolution-idmappingworkflow-idmappingworkflowoutputsource-syntax.json"></a>

```
{
  "[KMSArn](#cfn-entityresolution-idmappingworkflow-idmappingworkflowoutputsource-kmsarn)" : String,
  "[OutputS3Path](#cfn-entityresolution-idmappingworkflow-idmappingworkflowoutputsource-outputs3path)" : String
}
```

### YAML
<a name="aws-properties-entityresolution-idmappingworkflow-idmappingworkflowoutputsource-syntax.yaml"></a>

```
  [KMSArn](#cfn-entityresolution-idmappingworkflow-idmappingworkflowoutputsource-kmsarn): String
  [OutputS3Path](#cfn-entityresolution-idmappingworkflow-idmappingworkflowoutputsource-outputs3path): String
```

## Properties
<a name="aws-properties-entityresolution-idmappingworkflow-idmappingworkflowoutputsource-properties"></a>

`KMSArn`  <a name="cfn-entityresolution-idmappingworkflow-idmappingworkflowoutputsource-kmsarn"></a>
Customer AWS KMS ARN for encryption at rest. If not provided, system will use an AWS Entity Resolution managed KMS key.  
*Required*: No  
*Type*: String  
*Pattern*: `^arn:(aws|aws-us-gov|aws-cn):kms:.*:[0-9]+:.*$`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`OutputS3Path`  <a name="cfn-entityresolution-idmappingworkflow-idmappingworkflowoutputsource-outputs3path"></a>
The S3 path to which AWS Entity Resolution will write the output table.  
*Required*: Yes  
*Type*: String  
*Pattern*: `^s3://([^/]+)/?(.*?([^/]+)/?)$`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::EntityResolution::IdMappingWorkflow IntermediateSourceConfiguration
<a name="aws-properties-entityresolution-idmappingworkflow-intermediatesourceconfiguration"></a>

The Amazon S3 location that temporarily stores your data while it processes. Your information won't be saved permanently.

## Syntax
<a name="aws-properties-entityresolution-idmappingworkflow-intermediatesourceconfiguration-syntax"></a>

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

### JSON
<a name="aws-properties-entityresolution-idmappingworkflow-intermediatesourceconfiguration-syntax.json"></a>

```
{
  "[IntermediateS3Path](#cfn-entityresolution-idmappingworkflow-intermediatesourceconfiguration-intermediates3path)" : String
}
```

### YAML
<a name="aws-properties-entityresolution-idmappingworkflow-intermediatesourceconfiguration-syntax.yaml"></a>

```
  [IntermediateS3Path](#cfn-entityresolution-idmappingworkflow-intermediatesourceconfiguration-intermediates3path): String
```

## Properties
<a name="aws-properties-entityresolution-idmappingworkflow-intermediatesourceconfiguration-properties"></a>

`IntermediateS3Path`  <a name="cfn-entityresolution-idmappingworkflow-intermediatesourceconfiguration-intermediates3path"></a>
The Amazon S3 location (bucket and prefix). For example: `s3://provider_bucket/DOC-EXAMPLE-BUCKET`  
*Required*: Yes  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::EntityResolution::IdMappingWorkflow ProviderProperties
<a name="aws-properties-entityresolution-idmappingworkflow-providerproperties"></a>

An object containing the `providerServiceARN`, `intermediateSourceConfiguration`, and `providerConfiguration`.

## Syntax
<a name="aws-properties-entityresolution-idmappingworkflow-providerproperties-syntax"></a>

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

### JSON
<a name="aws-properties-entityresolution-idmappingworkflow-providerproperties-syntax.json"></a>

```
{
  "[IntermediateSourceConfiguration](#cfn-entityresolution-idmappingworkflow-providerproperties-intermediatesourceconfiguration)" : IntermediateSourceConfiguration,
  "[ProviderConfiguration](#cfn-entityresolution-idmappingworkflow-providerproperties-providerconfiguration)" : {Key: Value, ...},
  "[ProviderServiceArn](#cfn-entityresolution-idmappingworkflow-providerproperties-providerservicearn)" : String
}
```

### YAML
<a name="aws-properties-entityresolution-idmappingworkflow-providerproperties-syntax.yaml"></a>

```
  [IntermediateSourceConfiguration](#cfn-entityresolution-idmappingworkflow-providerproperties-intermediatesourceconfiguration): 
    IntermediateSourceConfiguration
  [ProviderConfiguration](#cfn-entityresolution-idmappingworkflow-providerproperties-providerconfiguration): 
    Key: Value
  [ProviderServiceArn](#cfn-entityresolution-idmappingworkflow-providerproperties-providerservicearn): String
```

## Properties
<a name="aws-properties-entityresolution-idmappingworkflow-providerproperties-properties"></a>

`IntermediateSourceConfiguration`  <a name="cfn-entityresolution-idmappingworkflow-providerproperties-intermediatesourceconfiguration"></a>
The Amazon S3 location that temporarily stores your data while it processes. Your information won't be saved permanently.  
*Required*: No  
*Type*: [IntermediateSourceConfiguration](aws-properties-entityresolution-idmappingworkflow-intermediatesourceconfiguration.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ProviderConfiguration`  <a name="cfn-entityresolution-idmappingworkflow-providerproperties-providerconfiguration"></a>
The required configuration fields to use with the provider service.  
*Required*: No  
*Type*: Object of String  
*Pattern*: `^.+$`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ProviderServiceArn`  <a name="cfn-entityresolution-idmappingworkflow-providerproperties-providerservicearn"></a>
The ARN of the provider service.  
*Required*: Yes  
*Type*: String  
*Pattern*: `^arn:(aws|aws-us-gov|aws-cn):(entityresolution):([a-z]{2}-[a-z]{1,10}-[0-9])::providerservice/([a-zA-Z0-9_-]{1,255})/([a-zA-Z0-9_-]{1,255})$`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::EntityResolution::IdMappingWorkflow Rule
<a name="aws-properties-entityresolution-idmappingworkflow-rule"></a>

An object containing the `ruleName` and `matchingKeys`.

## Syntax
<a name="aws-properties-entityresolution-idmappingworkflow-rule-syntax"></a>

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

### JSON
<a name="aws-properties-entityresolution-idmappingworkflow-rule-syntax.json"></a>

```
{
  "[MatchingKeys](#cfn-entityresolution-idmappingworkflow-rule-matchingkeys)" : [ String, ... ],
  "[RuleName](#cfn-entityresolution-idmappingworkflow-rule-rulename)" : String
}
```

### YAML
<a name="aws-properties-entityresolution-idmappingworkflow-rule-syntax.yaml"></a>

```
  [MatchingKeys](#cfn-entityresolution-idmappingworkflow-rule-matchingkeys): 
    - String
  [RuleName](#cfn-entityresolution-idmappingworkflow-rule-rulename): String
```

## Properties
<a name="aws-properties-entityresolution-idmappingworkflow-rule-properties"></a>

`MatchingKeys`  <a name="cfn-entityresolution-idmappingworkflow-rule-matchingkeys"></a>
A list of `MatchingKeys`. The `MatchingKeys` must have been defined in the `SchemaMapping`. Two records are considered to match according to this rule if all of the `MatchingKeys` match.  
*Required*: Yes  
*Type*: Array of String  
*Minimum*: `1`  
*Maximum*: `15`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`RuleName`  <a name="cfn-entityresolution-idmappingworkflow-rule-rulename"></a>
A name for the matching rule.  
*Required*: Yes  
*Type*: String  
*Pattern*: `^[a-zA-Z_0-9- \t]*$`  
*Minimum*: `0`  
*Maximum*: `255`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::EntityResolution::IdMappingWorkflow Tag
<a name="aws-properties-entityresolution-idmappingworkflow-tag"></a>

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

## Syntax
<a name="aws-properties-entityresolution-idmappingworkflow-tag-syntax"></a>

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

### JSON
<a name="aws-properties-entityresolution-idmappingworkflow-tag-syntax.json"></a>

```
{
  "[Key](#cfn-entityresolution-idmappingworkflow-tag-key)" : String,
  "[Value](#cfn-entityresolution-idmappingworkflow-tag-value)" : String
}
```

### YAML
<a name="aws-properties-entityresolution-idmappingworkflow-tag-syntax.yaml"></a>

```
  [Key](#cfn-entityresolution-idmappingworkflow-tag-key): String
  [Value](#cfn-entityresolution-idmappingworkflow-tag-value): String
```

## Properties
<a name="aws-properties-entityresolution-idmappingworkflow-tag-properties"></a>

`Key`  <a name="cfn-entityresolution-idmappingworkflow-tag-key"></a>
The key of the tag.  
*Required*: Yes  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `128`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Value`  <a name="cfn-entityresolution-idmappingworkflow-tag-value"></a>
The value of the tag.  
*Required*: Yes  
*Type*: String  
*Minimum*: `0`  
*Maximum*: `256`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)