Type object
Schema URL https://catalog.lintel.tools/schemas/schemastore/serverless-framework-configuration/_shared/latest--aws-customerprofiles-objecttype.json
Parent schema serverless-framework-configuration
Type: object

An ObjectType resource of Amazon Connect Customer Profiles. Source:- https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-customer-profiles.git

Properties

DomainName string | Aws_CF_FunctionString required

The unique name of the domain.

ObjectTypeName string | Aws_CF_FunctionString

The name of the profile object type.

AllowProfileCreation boolean

Indicates whether a profile should be created when data is received.

Description string | Aws_CF_FunctionString

Description of the profile object type.

EncryptionKey string | Aws_CF_FunctionString

The default encryption key

ExpirationDays integer

The default number of days until the data within the domain expires.

min=1max=1098
Fields FieldMap[]

A list of the name and ObjectType field.

Keys KeyMap[]

A list of unique keys that can be used to map data to the profile.

Tags Tag[]

The tags (keys and values) associated with the integration.

minItems=0maxItems=50
TemplateId string | Aws_CF_FunctionString

A unique identifier for the object template.

Definitions

Tag object
Key string | Aws_CF_FunctionString required
Value string | Aws_CF_FunctionString required
FieldMap object
Name string | Aws_CF_FunctionString
ObjectTypeField object

Represents a field in a ProfileObjectType.

3 nested properties
Source string | Aws_CF_FunctionString

A field of a ProfileObject. For example: _source.FirstName, where "_source" is a ProfileObjectType of a Zendesk user and "FirstName" is a field in that ObjectType.

Target string | Aws_CF_FunctionString

The location of the data in the standard ProfileObject model. For example: _profile.Address.PostalCode.

ContentType string | Aws_CF_FunctionString

The content type of the field. Used for determining equality when searching.

ObjectTypeField object

Represents a field in a ProfileObjectType.

Source string | Aws_CF_FunctionString

A field of a ProfileObject. For example: _source.FirstName, where "_source" is a ProfileObjectType of a Zendesk user and "FirstName" is a field in that ObjectType.

Target string | Aws_CF_FunctionString

The location of the data in the standard ProfileObject model. For example: _profile.Address.PostalCode.

ContentType string | Aws_CF_FunctionString

The content type of the field. Used for determining equality when searching.

KeyMap object
Name string | Aws_CF_FunctionString
ObjectTypeKeyList ObjectTypeKey[]
ObjectTypeKey object

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.

FieldNames string[]

The reference for the key name of the fields map.

StandardIdentifiers string[]

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.