Package software.amazon.awscdk.services.entityresolution

Interface CfnSchemaMapping.SchemaInputAttributeProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnSchemaMapping.SchemaInputAttributeProperty.Jsii$Proxy

Enclosing class:

CfnSchemaMapping

@Stability(Stable)
public static interface CfnSchemaMapping.SchemaInputAttributeProperty
extends software.amazon.jsii.JsiiSerializable

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 software.amazon.awscdk.services.entityresolution.*;
 SchemaInputAttributeProperty schemaInputAttributeProperty = SchemaInputAttributeProperty.builder()
         .fieldName("fieldName")
         .type("type")
         // the properties below are optional
         .groupName("groupName")
         .hashed(false)
         .matchKey("matchKey")
         .subType("subType")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnSchemaMapping.SchemaInputAttributeProperty.Builder	A builder for CfnSchemaMapping.SchemaInputAttributeProperty
static final class	CfnSchemaMapping.SchemaInputAttributeProperty.Jsii$Proxy	An implementation for CfnSchemaMapping.SchemaInputAttributeProperty

Method Summary

Modifier and Type	Method	Description
static CfnSchemaMapping.SchemaInputAttributeProperty.Builder	builder()
String	getFieldName()	A string containing the field name.
default String	getGroupName()	A string that instructs AWS Entity Resolution to combine several columns into a unified column with the identical attribute type.
default Object	getHashed()	Indicates if the column values are hashed in the schema input.
default String	getMatchKey()	A key that allows grouping of multiple input attributes into a unified matching group.
default String	getSubType()	The subtype of the attribute, selected from a list of values.
String	getType()	The type of the attribute, selected from a list of values.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getFieldName

@Stability(Stable)
@NotNull
String getFieldName()

A string containing the field name.

See Also:

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

getType

@Stability(Stable)
@NotNull
String getType()

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

LiveRamp supports: NAME | NAME_FIRST | NAME_MIDDLE | NAME_LAST | ADDRESS | ADDRESS_STREET1 | ADDRESS_STREET2 | ADDRESS_STREET3 | ADDRESS_CITY | ADDRESS_STATE | ADDRESS_COUNTRY | ADDRESS_POSTALCODE | PHONE | PHONE_NUMBER | EMAIL_ADDRESS | UNIQUE_ID | PROVIDER_ID

TransUnion supports: NAME | NAME_FIRST | NAME_LAST | ADDRESS | ADDRESS_CITY | ADDRESS_STATE | ADDRESS_COUNTRY | ADDRESS_POSTALCODE | PHONE_NUMBER | EMAIL_ADDRESS | UNIQUE_ID | IPV4 | IPV6 | MAID

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 .

See Also:

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

getGroupName

@Stability(Stable)
@Nullable
default String getGroupName()

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.

See Also:

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

getHashed

@Stability(Stable)
@Nullable
default Object getHashed()

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.

Returns union: either Boolean or IResolvable

See Also:

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

getMatchKey

@Stability(Stable)
@Nullable
default String getMatchKey()

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.

See Also:

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

getSubType

@Stability(Stable)
@Nullable
default String getSubType()

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

See Also:

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

builder

@Stability(Stable)
static CfnSchemaMapping.SchemaInputAttributeProperty.Builder builder()

Returns:

a CfnSchemaMapping.SchemaInputAttributeProperty.Builder of CfnSchemaMapping.SchemaInputAttributeProperty