Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. customerprofiles
  5. ObjectType

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-aws-native

aws-native.customerprofiles.ObjectType

Explore with Pulumi AI

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-aws-native

An ObjectType resource of Amazon Connect Customer Profiles

Create ObjectType Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new ObjectType(name: string, args: ObjectTypeArgs, opts?: CustomResourceOptions);
@overload
def ObjectType(resource_name: str,
               args: ObjectTypeArgs,
               opts: Optional[ResourceOptions] = None)

@overload
def ObjectType(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               description: Optional[str] = None,
               domain_name: Optional[str] = None,
               allow_profile_creation: Optional[bool] = None,
               encryption_key: Optional[str] = None,
               expiration_days: Optional[int] = None,
               fields: Optional[Sequence[ObjectTypeFieldMapArgs]] = None,
               keys: Optional[Sequence[ObjectTypeKeyMapArgs]] = None,
               object_type_name: Optional[str] = None,
               source_last_updated_timestamp_format: Optional[str] = None,
               tags: Optional[Sequence[_root_inputs.TagArgs]] = None,
               template_id: Optional[str] = None)
func NewObjectType(ctx *Context, name string, args ObjectTypeArgs, opts ...ResourceOption) (*ObjectType, error)
public ObjectType(string name, ObjectTypeArgs args, CustomResourceOptions? opts = null)
public ObjectType(String name, ObjectTypeArgs args)
public ObjectType(String name, ObjectTypeArgs args, CustomResourceOptions options)

type: aws-native:customerprofiles:ObjectType
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. ObjectTypeArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. ObjectTypeArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. ObjectTypeArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. ObjectTypeArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. ObjectTypeArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

ObjectType Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The ObjectType resource accepts the following input properties:

Description This property is required. string
Description of the profile object type.
DomainName This property is required. string
The unique name of the domain.
AllowProfileCreation bool
Indicates whether a profile should be created when data is received.
EncryptionKey string
The default encryption key
ExpirationDays int
The default number of days until the data within the domain expires.
Fields List<Pulumi.AwsNative.CustomerProfiles.Inputs.ObjectTypeFieldMap>
A list of the name and ObjectType field.
Keys List<Pulumi.AwsNative.CustomerProfiles.Inputs.ObjectTypeKeyMap>
A list of unique keys that can be used to map data to the profile.
ObjectTypeName string
The name of the profile object type.
SourceLastUpdatedTimestampFormat string
The format of your sourceLastUpdatedTimestamp that was previously set up.
Tags List<Pulumi.AwsNative.Inputs.Tag>
The tags (keys and values) associated with the integration.
TemplateId string
A unique identifier for the object template.
Description This property is required. string
Description of the profile object type.
DomainName This property is required. string
The unique name of the domain.
AllowProfileCreation bool
Indicates whether a profile should be created when data is received.
EncryptionKey string
The default encryption key
ExpirationDays int
The default number of days until the data within the domain expires.
Fields []ObjectTypeFieldMapArgs
A list of the name and ObjectType field.
Keys []ObjectTypeKeyMapArgs
A list of unique keys that can be used to map data to the profile.
ObjectTypeName string
The name of the profile object type.
SourceLastUpdatedTimestampFormat string
The format of your sourceLastUpdatedTimestamp that was previously set up.
Tags TagArgs
The tags (keys and values) associated with the integration.
TemplateId string
A unique identifier for the object template.
description This property is required. String
Description of the profile object type.
domainName This property is required. String
The unique name of the domain.
allowProfileCreation Boolean
Indicates whether a profile should be created when data is received.
encryptionKey String
The default encryption key
expirationDays Integer
The default number of days until the data within the domain expires.
fields List<ObjectTypeFieldMap>
A list of the name and ObjectType field.
keys List<ObjectTypeKeyMap>
A list of unique keys that can be used to map data to the profile.
objectTypeName String
The name of the profile object type.
sourceLastUpdatedTimestampFormat String
The format of your sourceLastUpdatedTimestamp that was previously set up.
tags List<Tag>
The tags (keys and values) associated with the integration.
templateId String
A unique identifier for the object template.
description This property is required. string
Description of the profile object type.
domainName This property is required. string
The unique name of the domain.
allowProfileCreation boolean
Indicates whether a profile should be created when data is received.
encryptionKey string
The default encryption key
expirationDays number
The default number of days until the data within the domain expires.
fields ObjectTypeFieldMap[]
A list of the name and ObjectType field.
keys ObjectTypeKeyMap[]
A list of unique keys that can be used to map data to the profile.
objectTypeName string
The name of the profile object type.
sourceLastUpdatedTimestampFormat string
The format of your sourceLastUpdatedTimestamp that was previously set up.
tags Tag[]
The tags (keys and values) associated with the integration.
templateId string
A unique identifier for the object template.
description This property is required. str
Description of the profile object type.
domain_name This property is required. str
The unique name of the domain.
allow_profile_creation bool
Indicates whether a profile should be created when data is received.
encryption_key str
The default encryption key
expiration_days int
The default number of days until the data within the domain expires.
fields Sequence[ObjectTypeFieldMapArgs]
A list of the name and ObjectType field.
keys Sequence[ObjectTypeKeyMapArgs]
A list of unique keys that can be used to map data to the profile.
object_type_name str
The name of the profile object type.
source_last_updated_timestamp_format str
The format of your sourceLastUpdatedTimestamp that was previously set up.
tags Sequence[TagArgs]
The tags (keys and values) associated with the integration.
template_id str
A unique identifier for the object template.
description This property is required. String
Description of the profile object type.
domainName This property is required. String
The unique name of the domain.
allowProfileCreation Boolean
Indicates whether a profile should be created when data is received.
encryptionKey String
The default encryption key
expirationDays Number
The default number of days until the data within the domain expires.
fields List<Property Map>
A list of the name and ObjectType field.
keys List<Property Map>
A list of unique keys that can be used to map data to the profile.
objectTypeName String
The name of the profile object type.
sourceLastUpdatedTimestampFormat String
The format of your sourceLastUpdatedTimestamp that was previously set up.
tags List<Property Map>
The tags (keys and values) associated with the integration.
templateId String
A unique identifier for the object template.

Outputs

All input properties are implicitly available as output properties. Additionally, the ObjectType resource produces the following output properties:

CreatedAt string
The time of this integration got created.
Id string
The provider-assigned unique ID for this managed resource.
LastUpdatedAt string
The time of this integration got last updated at.
CreatedAt string
The time of this integration got created.
Id string
The provider-assigned unique ID for this managed resource.
LastUpdatedAt string
The time of this integration got last updated at.
createdAt String
The time of this integration got created.
id String
The provider-assigned unique ID for this managed resource.
lastUpdatedAt String
The time of this integration got last updated at.
createdAt string
The time of this integration got created.
id string
The provider-assigned unique ID for this managed resource.
lastUpdatedAt string
The time of this integration got last updated at.
created_at str
The time of this integration got created.
id str
The provider-assigned unique ID for this managed resource.
last_updated_at str
The time of this integration got last updated at.
createdAt String
The time of this integration got created.
id String
The provider-assigned unique ID for this managed resource.
lastUpdatedAt String
The time of this integration got last updated at.

Supporting Types

ObjectTypeField
, ObjectTypeFieldArgs

ContentType Pulumi.AwsNative.CustomerProfiles.ObjectTypeFieldContentType
The content type of the field. Used for determining equality when searching.
Source string
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
The location of the data in the standard ProfileObject model. For example: _profile.Address.PostalCode.
ContentType ObjectTypeFieldContentType
The content type of the field. Used for determining equality when searching.
Source string
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
The location of the data in the standard ProfileObject model. For example: _profile.Address.PostalCode.
contentType ObjectTypeFieldContentType
The content type of the field. Used for determining equality when searching.
source String
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
The location of the data in the standard ProfileObject model. For example: _profile.Address.PostalCode.
contentType ObjectTypeFieldContentType
The content type of the field. Used for determining equality when searching.
source string
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
The location of the data in the standard ProfileObject model. For example: _profile.Address.PostalCode.
content_type ObjectTypeFieldContentType
The content type of the field. Used for determining equality when searching.
source str
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 str
The location of the data in the standard ProfileObject model. For example: _profile.Address.PostalCode.
contentType "STRING" | "NUMBER" | "PHONE_NUMBER" | "EMAIL_ADDRESS" | "NAME"
The content type of the field. Used for determining equality when searching.
source String
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
The location of the data in the standard ProfileObject model. For example: _profile.Address.PostalCode.

ObjectTypeFieldContentType
, ObjectTypeFieldContentTypeArgs

String
STRING
Number
NUMBER
PhoneNumber
PHONE_NUMBER
EmailAddress
EMAIL_ADDRESS
Name
NAME
ObjectTypeFieldContentTypeString
STRING
ObjectTypeFieldContentTypeNumber
NUMBER
ObjectTypeFieldContentTypePhoneNumber
PHONE_NUMBER
ObjectTypeFieldContentTypeEmailAddress
EMAIL_ADDRESS
ObjectTypeFieldContentTypeName
NAME
String
STRING
Number
NUMBER
PhoneNumber
PHONE_NUMBER
EmailAddress
EMAIL_ADDRESS
Name
NAME
String
STRING
Number
NUMBER
PhoneNumber
PHONE_NUMBER
EmailAddress
EMAIL_ADDRESS
Name
NAME
STRING
STRING
NUMBER
NUMBER
PHONE_NUMBER
PHONE_NUMBER
EMAIL_ADDRESS
EMAIL_ADDRESS
NAME
NAME
"STRING"
STRING
"NUMBER"
NUMBER
"PHONE_NUMBER"
PHONE_NUMBER
"EMAIL_ADDRESS"
EMAIL_ADDRESS
"NAME"
NAME

ObjectTypeFieldMap
, ObjectTypeFieldMapArgs

Name string
Name of the field.
ObjectTypeField Pulumi.AwsNative.CustomerProfiles.Inputs.ObjectTypeField
Represents a field in a ProfileObjectType.
Name string
Name of the field.
ObjectTypeField ObjectTypeField
Represents a field in a ProfileObjectType.
name String
Name of the field.
objectTypeField ObjectTypeField
Represents a field in a ProfileObjectType.
name string
Name of the field.
objectTypeField ObjectTypeField
Represents a field in a ProfileObjectType.
name str
Name of the field.
object_type_field ObjectTypeField
Represents a field in a ProfileObjectType.
name String
Name of the field.
objectTypeField Property Map
Represents a field in a ProfileObjectType.

ObjectTypeKey
, ObjectTypeKeyArgs

FieldNames List<string>
The reference for the key name of the fields map.
StandardIdentifiers List<Pulumi.AwsNative.CustomerProfiles.ObjectTypeKeyStandardIdentifiersItem>
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.
FieldNames []string
The reference for the key name of the fields map.
StandardIdentifiers []ObjectTypeKeyStandardIdentifiersItem
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.
fieldNames List<String>
The reference for the key name of the fields map.
standardIdentifiers List<ObjectTypeKeyStandardIdentifiersItem>
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.
fieldNames string[]
The reference for the key name of the fields map.
standardIdentifiers ObjectTypeKeyStandardIdentifiersItem[]
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.
field_names Sequence[str]
The reference for the key name of the fields map.
standard_identifiers Sequence[ObjectTypeKeyStandardIdentifiersItem]
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.
fieldNames List<String>
The reference for the key name of the fields map.
standardIdentifiers List<"PROFILE" | "UNIQUE" | "SECONDARY" | "LOOKUP_ONLY" | "NEW_ONLY" | "ASSET" | "CASE" | "ORDER">
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.

ObjectTypeKeyMap
, ObjectTypeKeyMapArgs

Name string
Name of the key.
ObjectTypeKeyList []ObjectTypeKey
A list of ObjectTypeKey.
name String
Name of the key.
objectTypeKeyList List<ObjectTypeKey>
A list of ObjectTypeKey.
name string
Name of the key.
objectTypeKeyList ObjectTypeKey[]
A list of ObjectTypeKey.
name str
Name of the key.
object_type_key_list Sequence[ObjectTypeKey]
A list of ObjectTypeKey.
name String
Name of the key.
objectTypeKeyList List<Property Map>
A list of ObjectTypeKey.

ObjectTypeKeyStandardIdentifiersItem
, ObjectTypeKeyStandardIdentifiersItemArgs

Profile
PROFILE
Unique
UNIQUE
Secondary
SECONDARY
LookupOnly
LOOKUP_ONLY
NewOnly
NEW_ONLY
Asset
ASSET
Case
CASE
Order
ORDER
ObjectTypeKeyStandardIdentifiersItemProfile
PROFILE
ObjectTypeKeyStandardIdentifiersItemUnique
UNIQUE
ObjectTypeKeyStandardIdentifiersItemSecondary
SECONDARY
ObjectTypeKeyStandardIdentifiersItemLookupOnly
LOOKUP_ONLY
ObjectTypeKeyStandardIdentifiersItemNewOnly
NEW_ONLY
ObjectTypeKeyStandardIdentifiersItemAsset
ASSET
ObjectTypeKeyStandardIdentifiersItemCase
CASE
ObjectTypeKeyStandardIdentifiersItemOrder
ORDER
Profile
PROFILE
Unique
UNIQUE
Secondary
SECONDARY
LookupOnly
LOOKUP_ONLY
NewOnly
NEW_ONLY
Asset
ASSET
Case
CASE
Order
ORDER
Profile
PROFILE
Unique
UNIQUE
Secondary
SECONDARY
LookupOnly
LOOKUP_ONLY
NewOnly
NEW_ONLY
Asset
ASSET
Case
CASE
Order
ORDER
PROFILE
PROFILE
UNIQUE
UNIQUE
SECONDARY
SECONDARY
LOOKUP_ONLY
LOOKUP_ONLY
NEW_ONLY
NEW_ONLY
ASSET
ASSET
CASE
CASE
ORDER
ORDER
"PROFILE"
PROFILE
"UNIQUE"
UNIQUE
"SECONDARY"
SECONDARY
"LOOKUP_ONLY"
LOOKUP_ONLY
"NEW_ONLY"
NEW_ONLY
"ASSET"
ASSET
"CASE"
CASE
"ORDER"
ORDER

Tag
, TagArgs

Key This property is required. string
The key name of the tag
Value This property is required. string
The value of the tag
Key This property is required. string
The key name of the tag
Value This property is required. string
The value of the tag
key This property is required. String
The key name of the tag
value This property is required. String
The value of the tag
key This property is required. string
The key name of the tag
value This property is required. string
The value of the tag
key This property is required. str
The key name of the tag
value This property is required. str
The value of the tag
key This property is required. String
The key name of the tag
value This property is required. String
The value of the tag

Package Details

Repository
AWS Native pulumi/pulumi-aws-native
License
Apache-2.0

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-aws-native