interface CfnObjectTypeProps

Language	Type name
.NET	`Amazon.CDK.AWS.CustomerProfiles.CfnObjectTypeProps`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awscustomerprofiles#CfnObjectTypeProps`
Java	`software.amazon.awscdk.services.customerprofiles.CfnObjectTypeProps`
Python	`aws_cdk.aws_customerprofiles.CfnObjectTypeProps`
TypeScript	`aws-cdk-lib` » `aws_customerprofiles` » `CfnObjectTypeProps`

Properties for defining a CfnObjectType.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-objecttype.html

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 cfnObjectTypeProps: customerprofiles.CfnObjectTypeProps = {
  description: 'description',
  domainName: 'domainName',
  objectTypeName: 'objectTypeName',

  // the properties below are optional
  allowProfileCreation: false,
  encryptionKey: 'encryptionKey',
  expirationDays: 123,
  fields: [{
    name: 'name',
    objectTypeField: {
      contentType: 'contentType',
      source: 'source',
      target: 'target',
    },
  }],
  keys: [{
    name: 'name',
    objectTypeKeyList: [{
      fieldNames: ['fieldNames'],
      standardIdentifiers: ['standardIdentifiers'],
    }],
  }],
  sourceLastUpdatedTimestampFormat: 'sourceLastUpdatedTimestampFormat',
  tags: [{
    key: 'key',
    value: 'value',
  }],
  templateId: 'templateId',
};

Properties

Name	Type	Description
description	`string`	The description of the profile object type mapping.
domainName	`string`	The unique name of the domain.
objectTypeName	`string`	The name of the profile object type.
allowProfileCreation?	`boolean \|` `IResolvable`	Indicates whether a profile should be created when data is received if one doesn’t exist for an object of this type.
encryptionKey?	`string`	The customer-provided key to encrypt the profile object that will be created in this profile object type mapping.
expirationDays?	`number`	The number of days until the data of this type expires.
fields?	`IResolvable` `\|` `IResolvable` `\|` `FieldMapProperty[]`	A list of field definitions for the object type mapping.
keys?	`IResolvable` `\|` `IResolvable` `\|` `KeyMapProperty[]`	A list of keys that can be used to map data to the profile or search for the profile.
sourceLastUpdatedTimestampFormat?	`string`	The format of your sourceLastUpdatedTimestamp that was previously set up.
tags?	`CfnTag[]`	The tags used to organize, track, or control access for this resource.
templateId?	`string`	A unique identifier for the template mapping.

description

Type: string

The description of the profile object type mapping.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-objecttype.html#cfn-customerprofiles-objecttype-description

domainName

Type: string

The unique name of the domain.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-objecttype.html#cfn-customerprofiles-objecttype-domainname

objectTypeName

Type: string

The name of the profile object type.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-objecttype.html#cfn-customerprofiles-objecttype-objecttypename

allowProfileCreation?

Type: boolean | IResolvable (optional)

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.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-objecttype.html#cfn-customerprofiles-objecttype-allowprofilecreation