Skip to content
v2.274.0

CfnIdNamespaceProps Struct ​

Properties for defining a CfnIdNamespace.

Example ​

ts
// 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 ​

descriptionstringdescriptionstrdescriptionStringDescriptionstringDescription*string#
The description of the ID namespace.
idMappingWorkflowPropertiesIResolvable | IResolvable | CfnIdNamespace.IdNamespaceIdMappingWorkflowPropertiesProperty[]id_mapping_workflow_propertiestyping.Union[IResolvable, typing.List[typing.Union[IResolvable, IdNamespaceIdMappingWorkflowPropertiesProperty]]]idMappingWorkflowPropertiesIResolvableIdMappingWorkflowPropertiesIResolvableIdMappingWorkflowPropertiesinterface{}#
Determines the properties of `IdMappingWorflow` where this `IdNamespace` can be used as a `Source` or a `Target` .
idNamespaceNamestringid_namespace_namestridNamespaceNameStringIdNamespaceNamestringIdNamespaceName*stringrequired#
The name of the ID namespace.
inputSourceConfigIResolvable | IResolvable | CfnIdNamespace.IdNamespaceInputSourceProperty[]input_source_configtyping.Union[IResolvable, typing.List[typing.Union[IResolvable, IdNamespaceInputSourceProperty]]]inputSourceConfigIResolvableInputSourceConfigIResolvableInputSourceConfiginterface{}#
A list of `InputSource` objects, which have the fields `InputSourceARN` and `SchemaName` .
roleArnstringrole_arnstrroleArnStringRoleArnstringRoleArn*string#
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.

tagsCfnTag[]tagstyping.List[CfnTag]tagsList<CfnTag>TagsCfnTag[]Tags*[]CfnTag#
The tags used to organize, track, or control access for this resource.
typestringtypestrtypeStringTypestringType*stringrequired#
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.

Used as props by ​