Create AWS Entity Resolution resources with AWS CloudFormation - AWS Entity Resolution
AWS Entity Resolution and AWS CloudFormation templatesLearn more about AWS CloudFormation

Create AWS Entity Resolution resources with AWS CloudFormation

AWS Entity Resolution is integrated with AWS CloudFormation, a service that helps you to model and set up your AWS resources so that you can spend less time creating and managing your resources and infrastructure. You create a template that describes all the AWS resources that you want (such as AWS::EntityResolution::MatchingWorkflow, AWS::EntityResolution::SchemaMapping, AWS::EntityResolution:IdMappingWorkflow, AWS::EntityResolution::IdNamespace and AWS::EntityResolution::PolicyStatement), and AWS CloudFormation provisions and configures those resources for you.

When you use AWS CloudFormation, you can reuse your template to set up your AWS Entity Resolution resources consistently and repeatedly. Describe your resources once, and then provision the same resources over and over in multiple AWS accounts and Regions.

AWS Entity Resolution and AWS CloudFormation templates

To provision and configure resources for AWS Entity Resolution and related services, you must understand AWS CloudFormation templates. Templates are formatted text files in JSON or YAML. These templates describe the resources that you want to provision in your AWS CloudFormation stacks. If you're unfamiliar with JSON or YAML, you can use AWS CloudFormation Designer to help you get started with AWS CloudFormation templates. For more information, see What is AWS CloudFormation Designer? in the AWS CloudFormation User Guide.

AWS Entity Resolution supports creating AWS::EntityResolution::MatchingWorkflow, AWS::EntityResolution::SchemaMapping, AWS::EntityResolution:IdMappingWorkflow, AWS::EntityResolution::IdNamespace and AWS::EntityResolution::PolicyStatement in AWS CloudFormation. For more information, including examples of JSON and YAML templates for AWS::EntityResolution::MatchingWorkflow, AWS::EntityResolution::SchemaMapping, AWS::EntityResolution:IdMappingWorkflow, AWS::EntityResolution::IdNamespace and AWS::EntityResolution::PolicyStatement, see the AWS Entity Resolution resource type reference in the AWS CloudFormation User Guide.

The following templates are available:

  • Matching workflow

    Create a MatchingWorkflow object, which stores the configuration of the data processing job to be run.

    For more information, see the following topics:

    AWS::EntityResolution::MatchingWorkflow in the AWS CloudFormation User Guide

    CreateMatchingWorkflow in the AWS Entity Resolution API Reference

  • Schema mapping

    Create a schema mapping, which defines the schema of the input customer records table.

    For more information, see the following topics:

    AWS::EntityResolution::SchemaMapping in the AWS CloudFormation User Guide

    CreateSchemaMapping in the AWS Entity Resolution API Reference

  • ID mapping workflow

    Create an IdMappingWorkflow object, which stores the configuration of the data processing job to run.

    For more information, see the following topics:

    AWS::EntityResolution::IdMappingWorkflow in the AWS CloudFormation User Guide

    CreateIdMappingWorkflow in the AWS Entity Resolution API Reference

  • ID namespace

    Create an IdNamespace object, which stores the metadata explaining the dataset and how to use it.

    For more information, see the following topics:

    AWS::EntityResolution::IdNamespace in the AWS CloudFormation User Guide

    CreateIdNamespace in the AWS Entity Resolution API Reference

  • PolicyStatement

    Create an PolicyStatement object.

    For more information, see the following topics:

    AWS::EntityResolution::PolicyStatement in the AWS CloudFormation User Guide

    AddPolicyStatement in the AWS Entity Resolution API Reference

Learn more about AWS CloudFormation

To learn more about AWS CloudFormation, see the following resources: