interface SchemaInputAttributeProperty

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

A configuration object for defining input data fields in AWS Entity Resolution .

The SchemaInputAttribute specifies how individual fields in your input data should be processed and matched.

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 schemaInputAttributeProperty: entityresolution.CfnSchemaMapping.SchemaInputAttributeProperty = {
  fieldName: 'fieldName',
  type: 'type',

  // the properties below are optional
  groupName: 'groupName',
  hashed: false,
  matchKey: 'matchKey',
  subType: 'subType',
};

Properties

Name	Type	Description
fieldName	`string`	A string containing the field name.
type	`string`	The type of the attribute, selected from a list of values.
groupName?	`string`	A string that instructs AWS Entity Resolution to combine several columns into a unified column with the identical attribute type.
hashed?	`boolean \|` `IResolvable`	Indicates if the column values are hashed in the schema input.
matchKey?	`string`	A key that allows grouping of multiple input attributes into a unified matching group.
subType?	`string`	The subtype of the attribute, selected from a list of values.

fieldName

Type: string

A string containing the field name.

type

Type: string

The type of the attribute, selected from a list of values.

Unified ID 2.0 supports: PHONE_NUMBER | EMAIL_ADDRESS | UNIQUE_ID

Normalization is only supported for NAME , ADDRESS , PHONE , and EMAIL_ADDRESS .

If you want to normalize NAME_FIRST , NAME_MIDDLE , and NAME_LAST , you must group them by assigning them to the NAME groupName .

If you want to normalize ADDRESS_STREET1 , ADDRESS_STREET2 , ADDRESS_STREET3 , ADDRESS_CITY , ADDRESS_STATE , ADDRESS_COUNTRY , and ADDRESS_POSTALCODE , you must group them by assigning them to the ADDRESS groupName .

If you want to normalize PHONE_NUMBER and PHONE_COUNTRYCODE , you must group them by assigning them to the PHONE groupName .

groupName?

Type: string (optional)

A string that instructs AWS Entity Resolution to combine several columns into a unified column with the identical attribute type.

For example, when working with columns such as NAME_FIRST , NAME_MIDDLE , and NAME_LAST , assigning them a common groupName will prompt AWS Entity Resolution to concatenate them into a single value.

hashed?

Type: boolean | IResolvable (optional)

Indicates if the column values are hashed in the schema input.

If the value is set to TRUE , the column values are hashed.

If the value is set to FALSE , the column values are cleartext.

matchKey?

Type: string (optional)

A key that allows grouping of multiple input attributes into a unified matching group.

For example, consider a scenario where the source table contains various addresses, such as business_address and shipping_address . By assigning a matchKey called address to both attributes, AWS Entity Resolution will match records across these fields to create a consolidated matching group.

If no matchKey is specified for a column, it won't be utilized for matching purposes but will still be included in the output table.

subType?

Type: string (optional)

The subtype of the attribute, selected from a list of values.