CfnSchemaMappingPropsMixin

class aws_cdk.mixins_preview.aws_entityresolution.mixins.CfnSchemaMappingPropsMixin(props, *, strategy=None)

Bases: Mixin

Creates a schema mapping, which defines the schema of the input customer records table.

The SchemaMapping also provides AWS Entity Resolution with some metadata about the table, such as the attribute types of the columns and which columns to match on.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-entityresolution-schemamapping.html
CloudformationResource:: AWS::EntityResolution::SchemaMapping
Mixin:: true
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview import mixins
from aws_cdk.mixins_preview.aws_entityresolution import mixins as entityresolution_mixins

cfn_schema_mapping_props_mixin = entityresolution_mixins.CfnSchemaMappingPropsMixin(entityresolution_mixins.CfnSchemaMappingMixinProps(
    description="description",
    mapped_input_fields=[entityresolution_mixins.CfnSchemaMappingPropsMixin.SchemaInputAttributeProperty(
        field_name="fieldName",
        group_name="groupName",
        hashed=False,
        match_key="matchKey",
        sub_type="subType",
        type="type"
    )],
    schema_name="schemaName",
    tags=[CfnTag(
        key="key",
        value="value"
    )]
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::EntityResolution::SchemaMapping.

Parameters:

props (Union[CfnSchemaMappingMixinProps, Dict[str, Any]]) – L1 properties to apply.
strategy (Optional[PropertyMergeStrategy]) – (experimental) Strategy for merging nested properties. Default: - PropertyMergeStrategy.MERGE

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:: construct (IConstruct)
Return type:: IConstruct

supports(construct)

Check if this mixin supports the given construct.

Parameters:: construct (IConstruct)
Return type:: bool

Attributes

CFN_PROPERTY_KEYS = ['description', 'mappedInputFields', 'schemaName', 'tags']

Static Methods

classmethod is_mixin(x)

(experimental) Checks if x is a Mixin.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Mixin.
Stability:: experimental

SchemaInputAttributeProperty

class CfnSchemaMappingPropsMixin.SchemaInputAttributeProperty(*, field_name=None, group_name=None, hashed=None, match_key=None, sub_type=None, type=None)

Bases: object

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.

Parameters:

field_name (Optional[str]) – A string containing the field name.
group_name (Optional[str]) – 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 (Union[bool, IResolvable, None]) – 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.
match_key (Optional[str]) – 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.
sub_type (Optional[str]) – The subtype of the attribute, selected from a list of values.
type (Optional[str]) – 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 .. epigraph:: 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:

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

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_entityresolution import mixins as entityresolution_mixins

schema_input_attribute_property = entityresolution_mixins.CfnSchemaMappingPropsMixin.SchemaInputAttributeProperty(
    field_name="fieldName",
    group_name="groupName",
    hashed=False,
    match_key="matchKey",
    sub_type="subType",
    type="type"
)

Attributes

field_name

A string containing the field name.

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

group_name

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:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-entityresolution-schemamapping-schemainputattribute.html#cfn-entityresolution-schemamapping-schemainputattribute-groupname

hashed

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.

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

match_key

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:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-entityresolution-schemamapping-schemainputattribute.html#cfn-entityresolution-schemamapping-schemainputattribute-matchkey

sub_type

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

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

type

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

Unified ID 2.0 supports: PHONE_NUMBER | EMAIL_ADDRESS | UNIQUE_ID .. epigraph:

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:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-entityresolution-schemamapping-schemainputattribute.html#cfn-entityresolution-schemamapping-schemainputattribute-type