AWS Native v0.102.0, Apr 16 24

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.102.0 published on Tuesday, Apr 16, 2024 by Pulumi

pulumi/pulumi-aws-native

aws-native.customerprofiles.ObjectType

Explore with Pulumi AI

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.102.0 published on Tuesday, Apr 16, 2024 by Pulumi

pulumi/pulumi-aws-native

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 string: The unique name of the resource.
args ObjectTypeArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
args 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 string: The unique name of the resource.
args ObjectTypeArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args ObjectTypeArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args ObjectTypeArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

Example

The following reference example uses placeholder values for all input properties.

Coming soon!

Coming soon!

Coming soon!

Coming soon!

const objectTypeResource = new aws_native.customerprofiles.ObjectType("objectTypeResource", {
    description: "string",
    domainName: "string",
    allowProfileCreation: false,
    encryptionKey: "string",
    expirationDays: 0,
    fields: [{
        name: "string",
        objectTypeField: {
            contentType: aws_native.customerprofiles.ObjectTypeFieldContentType.String,
            source: "string",
            target: "string",
        },
    }],
    keys: [{
        name: "string",
        objectTypeKeyList: [{
            fieldNames: ["string"],
            standardIdentifiers: [aws_native.customerprofiles.ObjectTypeKeyStandardIdentifiersItem.Profile],
        }],
    }],
    objectTypeName: "string",
    sourceLastUpdatedTimestampFormat: "string",
    tags: [{
        key: "string",
        value: "string",
    }],
    templateId: "string",
});

Coming soon!

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

The ObjectType resource accepts the following input properties:

Description string: Description of the profile object type.
DomainName 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 string: Description of the profile object type.
DomainName 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 String: Description of the profile object type.
domainName 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 string: Description of the profile object type.
domainName 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 str: Description of the profile object type.
domain_name 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 String: Description of the profile object type.
domainName 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
ObjectTypeField Pulumi.AwsNative.CustomerProfiles.Inputs.ObjectTypeField

Name string
ObjectTypeField ObjectTypeField

name String
objectTypeField ObjectTypeField

name string
objectTypeField ObjectTypeField

name str
object_type_field ObjectTypeField

name String
objectTypeField Property Map

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.