interface CfnIdNamespaceProps

Language	Type name
.NET	`Amazon.CDK.aws_entityresolution.CfnIdNamespaceProps`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awsentityresolution#CfnIdNamespaceProps`
Java	`software.amazon.awscdk.services.entityresolution.CfnIdNamespaceProps`
Python	`aws_cdk.aws_entityresolution.CfnIdNamespaceProps`
TypeScript	`aws-cdk-lib` » `aws_entityresolution` » `CfnIdNamespaceProps`

Properties for defining a CfnIdNamespace.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_entityresolution as entityresolution } from 'aws-cdk-lib';
const cfnIdNamespaceProps: entityresolution.CfnIdNamespaceProps = {
  idNamespaceName: 'idNamespaceName',
  type: 'type',

  // the properties below are optional
  description: 'description',
  idMappingWorkflowProperties: [{
    idMappingType: 'idMappingType',

    // the properties below are optional
    providerProperties: {
      providerServiceArn: 'providerServiceArn',

      // the properties below are optional
      providerConfiguration: {
        providerConfigurationKey: 'providerConfiguration',
      },
    },
    ruleBasedProperties: {
      attributeMatchingModel: 'attributeMatchingModel',
      recordMatchingModels: ['recordMatchingModels'],
      ruleDefinitionTypes: ['ruleDefinitionTypes'],
      rules: [{
        matchingKeys: ['matchingKeys'],
        ruleName: 'ruleName',
      }],
    },
  }],
  inputSourceConfig: [{
    inputSourceArn: 'inputSourceArn',

    // the properties below are optional
    schemaName: 'schemaName',
  }],
  roleArn: 'roleArn',
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties

Name	Type	Description
idNamespaceName	`string`	The name of the ID namespace.
type	`string`	The type of ID namespace. There are two types: `SOURCE` and `TARGET` .
description?	`string`	The description of the ID namespace.
idMappingWorkflowProperties?	`IResolvable` `\| (IResolvable` `\|` `IdNamespaceIdMappingWorkflowPropertiesProperty)[]`	Determines the properties of `IdMappingWorflow` where this `IdNamespace` can be used as a `Source` or a `Target` .
inputSourceConfig?	`IResolvable` `\| (IResolvable` `\|` `IdNamespaceInputSourceProperty)[]`	A list of `InputSource` objects, which have the fields `InputSourceARN` and `SchemaName` .
roleArn?	`string`	The Amazon Resource Name (ARN) of the IAM role.
tags?	`CfnTag[]`	The tags used to organize, track, or control access for this resource.

idNamespaceName

Type: string

The name of the ID namespace.

type

Type: string

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.

description?

Type: string (optional)

The description of the ID namespace.

idMappingWorkflowProperties?

Type: IResolvable | (IResolvable | IdNamespaceIdMappingWorkflowPropertiesProperty)[] (optional)

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

inputSourceConfig?

Type: IResolvable | (IResolvable | IdNamespaceInputSourceProperty)[] (optional)

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

roleArn?

Type: string (optional)

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.

tags?

Type: CfnTag[] (optional)

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