AWS::EntityResolution::IdNamespace - AWS CloudFormation
SyntaxProperties

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

AWS::EntityResolution::IdNamespace

Creates an ID namespace object which will help customers provide metadata explaining their dataset and how to use it. Each ID namespace must have a unique name. To modify an existing ID namespace, use the UpdateIdNamespace API.

Syntax

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

JSON

{
  "Type" : "AWS::EntityResolution::IdNamespace",
  "Properties" : {
      "Description" : String,
      "IdMappingWorkflowProperties" : [ IdNamespaceIdMappingWorkflowProperties, ... ],
      "IdNamespaceName" : String,
      "InputSourceConfig" : [ IdNamespaceInputSource, ... ],
      "RoleArn" : String,
      "Tags" : [ Tag, ... ],
      "Type" : String
    }
}

YAML

Type: AWS::EntityResolution::IdNamespace
Properties:
  Description: String
  IdMappingWorkflowProperties: 
    - IdNamespaceIdMappingWorkflowProperties
  IdNamespaceName: String
  InputSourceConfig: 
    - IdNamespaceInputSource
  RoleArn: String
  Tags: 
    - Tag
  Type: String

Properties

Description

The description of the ID namespace.

Required: No

Type: String

Minimum: 0

Maximum: 255

Update requires: No interruption

IdMappingWorkflowProperties

Determines the properties of IdMappingWorflow where this IdNamespace can be used as a Source or a Target.

Required: No

Type: Array of IdNamespaceIdMappingWorkflowProperties

Minimum: 1

Maximum: 1

Update requires: No interruption

IdNamespaceName

The name of the ID namespace.

Required: Yes

Type: String

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

Minimum: 1

Maximum: 255

Update requires: Replacement

InputSourceConfig

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

Required: No

Type: Array of IdNamespaceInputSource

Minimum: 0

Maximum: 20

Update requires: No interruption

RoleArn

The Amazon Resource Name (ARN) of the IAM role. AWS Entity Resolution assumes this role to access the resources defined in this IdNamespace on your behalf as part of the workflow run.

Required: No

Type: String

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

Minimum: 32

Maximum: 512

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

Type

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: Yes

Type: String

Allowed values: SOURCE | TARGET

Update requires: No interruption