AWS Fundamentals Logo
AWS Fundamentals
L1 ConstructAWS::CustomerProfiles::ObjectType

CfnObjectType

Specifies an Amazon Connect Customer Profiles Object Type Mapping.

Import

import { CfnObjectType } from 'aws-cdk-lib/aws-customerprofiles';

Or use the module namespace:

import * as customerprofiles from 'aws-cdk-lib/aws-customerprofiles';
// customerprofiles.CfnObjectType

Properties

Configuration passed to the constructor as CfnObjectTypeProps.

descriptionRequired
string

The description of the profile object type mapping.

domainNameRequired
string

The unique name of the domain.

objectTypeNameRequired
string

The name of the profile object type.

allowProfileCreationOptional
boolean | IResolvable

Indicates whether a profile should be created when data is received if one doesn’t exist for an object of this type. The default is `FALSE` . If the AllowProfileCreation flag is set to `FALSE` , then the service tries to fetch a standard profile and associate this object with the profile. If it is set to `TRUE` , and if no match is found, then the service creates a new standard profile.

encryptionKeyOptional
string

The customer-provided key to encrypt the profile object that will be created in this profile object type mapping. If not specified the system will use the encryption key of the domain.

expirationDaysOptional
number

The number of days until the data of this type expires.

fieldsOptional
IResolvable | IResolvable | FieldMapProperty[]

A list of field definitions for the object type mapping.

keysOptional
IResolvable | IResolvable | KeyMapProperty[]

A list of keys that can be used to map data to the profile or search for the profile.

maxProfileObjectCountOptional
number

The amount of profile object max count assigned to the object type.

sourceLastUpdatedTimestampFormatOptional
string

The format of your sourceLastUpdatedTimestamp that was previously set up.

sourcePriorityOptional
number

Defines the priority order of object types. Lower value indicates higher priority.

tagsOptional
CfnTag[]

The tags used to organize, track, or control access for this resource.

templateIdOptional
string

A unique identifier for the template mapping. This can be used instead of specifying the Keys and Fields properties directly.

CloudFormation Resource

This L1 construct maps directly to the following CloudFormation resource type.

AWS::CustomerProfiles::ObjectTypeView in CloudFormation Explorer

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter

Quick Facts

LevelL1 (CloudFormation)
Moduleaws-customerprofiles
CFN TypeAWS::CustomerProfiles::ObjectType
Properties13

Related Constructs

Explore This Service

External Links