Interface CfnSchemaMapping.ISchemaInputAttributeProperty

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

Namespace: Amazon.CDK.AWS.EntityResolution

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface CfnSchemaMapping.ISchemaInputAttributeProperty

Syntax (vb)

Public Interface CfnSchemaMapping.ISchemaInputAttributeProperty

Remarks

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-entityresolution-schemamapping-schemainputattribute.html

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.EntityResolution;

             var schemaInputAttributeProperty = new SchemaInputAttributeProperty {
                 FieldName = "fieldName",
                 Type = "type",

                 // the properties below are optional
                 GroupName = "groupName",
                 Hashed = false,
                 MatchKey = "matchKey",
                 SubType = "subType"
             };

Synopsis

Properties

FieldName	A string containing the field name.
GroupName	A string that instructs AWS Entity Resolution to combine several columns into a unified column with the identical attribute type.
Hashed	Indicates if the column values are hashed in the schema input.
MatchKey	A key that allows grouping of multiple input attributes into a unified matching group.
SubType	The subtype of the attribute, selected from a list of values.
Type	The type of the attribute, selected from a list of values.

Properties

FieldName

A string containing the field name.

string FieldName { get; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-entityresolution-schemamapping-schemainputattribute.html#cfn-entityresolution-schemamapping-schemainputattribute-fieldname

GroupName

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

string? GroupName { get; }

Property Value

string

Remarks

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

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

object? Hashed { get; }

Property Value

object

Remarks

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

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

Type union: either bool or IResolvable

MatchKey

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

string? MatchKey { get; }

Property Value

string

Remarks

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

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

string? SubType { get; }

Property Value

string

Remarks

Type

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

string Type { get; }

Property Value

string

Remarks

Unified ID 2.0 supports: PHONE_NUMBER | EMAIL_ADDRESS | UNIQUE_ID

Normalization is only supported for <code>NAME</code> , <code>ADDRESS</code> , <code>PHONE</code> , and <code>EMAIL_ADDRESS</code> .

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 .