Skip to content
v2.277.0

ObjectTypeKeyProperty Struct ​

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 ​

ts
// 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'],
};
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_customerprofiles as customerprofiles

object_type_key_property = customerprofiles.CfnObjectType.ObjectTypeKeyProperty(
    field_names=["fieldNames"],
    standard_identifiers=["standardIdentifiers"]
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.customerprofiles.*;

ObjectTypeKeyProperty objectTypeKeyProperty = ObjectTypeKeyProperty.builder()
        .fieldNames(List.of("fieldNames"))
        .standardIdentifiers(List.of("standardIdentifiers"))
        .build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.CustomerProfiles;

var objectTypeKeyProperty = new ObjectTypeKeyProperty {
    FieldNames = new [] { "fieldNames" },
    StandardIdentifiers = new [] { "standardIdentifiers" }
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

objectTypeKeyProperty := &ObjectTypeKeyProperty{
	FieldNames: []*string{
		jsii.String("fieldNames"),
	},
	StandardIdentifiers: []*string{
		jsii.String("standardIdentifiers"),
	},
}

Properties ​

fieldNamesoptionalstring[]field_namesoptionaltyping.List[str]fieldNamesoptionalList<String>FieldNamesoptionalstring[]FieldNamesoptional*[]*string #
The reference for the key name of the fields map.
standardIdentifiersoptionalstring[]standard_identifiersoptionaltyping.List[str]standardIdentifiersoptionalList<String>StandardIdentifiersoptionalstring[]StandardIdentifiersoptional*[]*string #
The types of keys that a ProfileObject can have.
notes

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.