Package software.amazon.awscdk.services.customerprofiles

Interface CfnObjectType.ObjectTypeKeyProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnObjectType.ObjectTypeKeyProperty.Jsii$Proxy

Enclosing class:

CfnObjectType

@Stability(Stable)
public static interface CfnObjectType.ObjectTypeKeyProperty
extends software.amazon.jsii.JsiiSerializable

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 software.amazon.awscdk.services.customerprofiles.*;
 ObjectTypeKeyProperty objectTypeKeyProperty = ObjectTypeKeyProperty.builder()
         .fieldNames(List.of("fieldNames"))
         .standardIdentifiers(List.of("standardIdentifiers"))
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-objecttype-objecttypekey.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnObjectType.ObjectTypeKeyProperty.Builder	builder()
default List<String>	getFieldNames()	The reference for the key name of the fields map.
default List<String>	getStandardIdentifiers()	The types of keys that a ProfileObject can have.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getFieldNames

@Stability(Stable)
@Nullable
default List<String> getFieldNames()

The reference for the key name of the fields map.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-objecttype-objecttypekey.html#cfn-customerprofiles-objecttype-objecttypekey-fieldnames

getStandardIdentifiers

@Stability(Stable)
@Nullable
default List<String> getStandardIdentifiers()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-objecttype-objecttypekey.html#cfn-customerprofiles-objecttype-objecttypekey-standardidentifiers

builder

@Stability(Stable)
static CfnObjectType.ObjectTypeKeyProperty.Builder builder()

Returns:

a CfnObjectType.ObjectTypeKeyProperty.Builder of CfnObjectType.ObjectTypeKeyProperty