aws-cdk-lib.aws_customerprofiles.CfnObjectType.ObjectTypeKeyProperty

interface ObjectTypeKeyProperty

LanguageType name
.NETAmazon.CDK.AWS.CustomerProfiles.CfnObjectType.ObjectTypeKeyProperty
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awscustomerprofiles#CfnObjectType_ObjectTypeKeyProperty
Javasoftware.amazon.awscdk.services.customerprofiles.CfnObjectType.ObjectTypeKeyProperty
Pythonaws_cdk.aws_customerprofiles.CfnObjectType.ObjectTypeKeyProperty
TypeScript aws-cdk-lib » aws_customerprofiles » CfnObjectType » ObjectTypeKeyProperty

An object that defines the Key element of a ProfileObject.

A Key is a special element that can be used to search for a customer profile.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_customerprofiles as customerprofiles } from 'aws-cdk-lib';
const objectTypeKeyProperty: customerprofiles.CfnObjectType.ObjectTypeKeyProperty = {
  fieldNames: ['fieldNames'],
  standardIdentifiers: ['standardIdentifiers'],
};

Properties

NameTypeDescription
fieldNames?string[]The reference for the key name of the fields map.
standardIdentifiers?string[]The types of keys that a ProfileObject can have.

fieldNames?

Type: string[] (optional)

The reference for the key name of the fields map.


standardIdentifiers?

Type: string[] (optional)

The types of keys that a ProfileObject can have.

Each ProfileObject can have only 1 UNIQUE key but multiple PROFILE keys. PROFILE means that this key can be used to tie an object to a PROFILE. UNIQUE means that it can be used to uniquely identify an object. If a key a is marked as SECONDARY, it will be used to search for profiles after all other PROFILE keys have been searched. A LOOKUP_ONLY key is only used to match a profile but is not persisted to be used for searching of the profile. A NEW_ONLY key is only used if the profile does not already exist before the object is ingested, otherwise it is only used for matching objects to profiles.