# CfnIdNamespaceProps

Properties for defining a `CfnIdNamespace`.

Extends: CfnIdNamespaceProps
Used as props by: CfnIdNamespace

- Source: Generated code
- Type last changed: v2.138.0 · 18 Apr 2024

## 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

- `description`: string — The description of the ID namespace.

- `idMappingWorkflowProperties`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnIdNamespace.IdNamespaceIdMappingWorkflowPropertiesProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_entityresolution.CfnIdNamespace.IdNamespaceIdMappingWorkflowPropertiesProperty.html)[] — Determines the properties of `IdMappingWorflow` where this `IdNamespace` can be used as a `Source` or a `Target` .

- `idNamespaceName`: string (required) — The name of the ID namespace.

- `inputSourceConfig`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnIdNamespace.IdNamespaceInputSourceProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_entityresolution.CfnIdNamespace.IdNamespaceInputSourceProperty.html)[] — A list of `InputSource` objects, which have the fields `InputSourceARN` and `SchemaName` .

- `roleArn`: 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.

- `tags`: [CfnTag](/cdk/api/v2/docs/aws-cdk-lib.CfnTag.html)[] — The tags used to organize, track, or control access for this resource.

- `type`: string (required) — 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.
