object_types

Creates, updates, deletes or gets an object_type resource or lists object_types in a region

Overview

Name	object_types
Type	Resource
Description	An ObjectType resource of Amazon Connect Customer Profiles
Id	awscc.customerprofiles.object_types

Fields

Name	Datatype	Description
domain_name	string	The unique name of the domain.
object_type_name	string	The name of the profile object type.
allow_profile_creation	boolean	Indicates whether a profile should be created when data is received.
description	string	Description of the profile object type.
encryption_key	string	The default encryption key
expiration_days	integer	The default number of days until the data within the domain expires.
▶fields	array	A list of the name and ObjectType field.
▶keys	array	A list of unique keys that can be used to map data to the profile.
created_at	string	The time of this integration got created.
last_updated_at	string	The time of this integration got last updated at.
source_last_updated_timestamp_format	string	The format of your sourceLastUpdatedTimestamp that was previously set up.
▶tags	array	The tags (keys and values) associated with the integration.
template_id	string	A unique identifier for the object template.
max_profile_object_count	integer	The maximum number of profile objects for this object type
max_available_profile_object_count	integer	The maximum available number of profile objects
region	string	AWS region.

For more information, see AWS::CustomerProfiles::ObjectType.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	DomainName, ObjectTypeName, Description, region
delete_resource	DELETE	data__Identifier, region
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all properties from an individual object_type.

SELECT
region,
domain_name,
object_type_name,
allow_profile_creation,
description,
encryption_key,
expiration_days,
fields,
keys,
created_at,
last_updated_at,
source_last_updated_timestamp_format,
tags,
template_id,
max_profile_object_count,
max_available_profile_object_count
FROM awscc.customerprofiles.object_types
WHERE region = 'us-east-1' AND data__Identifier = '<DomainName>|<ObjectTypeName>';

INSERT example

Use the following StackQL query and manifest file to create a new object_type resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO awscc.customerprofiles.object_types (
 DomainName,
 ObjectTypeName,
 Description,
 region
)
SELECT 
'{{ DomainName }}',
 '{{ ObjectTypeName }}',
 '{{ Description }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO awscc.customerprofiles.object_types (
 DomainName,
 ObjectTypeName,
 AllowProfileCreation,
 Description,
 EncryptionKey,
 ExpirationDays,
 Fields,
 Keys,
 SourceLastUpdatedTimestampFormat,
 Tags,
 TemplateId,
 MaxProfileObjectCount,
 region
)
SELECT 
 '{{ DomainName }}',
 '{{ ObjectTypeName }}',
 '{{ AllowProfileCreation }}',
 '{{ Description }}',
 '{{ EncryptionKey }}',
 '{{ ExpirationDays }}',
 '{{ Fields }}',
 '{{ Keys }}',
 '{{ SourceLastUpdatedTimestampFormat }}',
 '{{ Tags }}',
 '{{ TemplateId }}',
 '{{ MaxProfileObjectCount }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: object_type
    props:
      - name: DomainName
        value: '{{ DomainName }}'
      - name: ObjectTypeName
        value: '{{ ObjectTypeName }}'
      - name: AllowProfileCreation
        value: '{{ AllowProfileCreation }}'
      - name: Description
        value: '{{ Description }}'
      - name: EncryptionKey
        value: '{{ EncryptionKey }}'
      - name: ExpirationDays
        value: '{{ ExpirationDays }}'
      - name: Fields
        value:
          - Name: '{{ Name }}'
            ObjectTypeField:
              Source: '{{ Source }}'
              Target: '{{ Target }}'
              ContentType: '{{ ContentType }}'
      - name: Keys
        value:
          - Name: '{{ Name }}'
            ObjectTypeKeyList:
              - FieldNames:
                  - '{{ FieldNames[0] }}'
                StandardIdentifiers:
                  - '{{ StandardIdentifiers[0] }}'
      - name: SourceLastUpdatedTimestampFormat
        value: '{{ SourceLastUpdatedTimestampFormat }}'
      - name: Tags
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'
      - name: TemplateId
        value: '{{ TemplateId }}'
      - name: MaxProfileObjectCount
        value: '{{ MaxProfileObjectCount }}'

DELETE example

/*+ delete */
DELETE FROM awscc.customerprofiles.object_types
WHERE data__Identifier = '<DomainName|ObjectTypeName>'
AND region = 'us-east-1';

Permissions

To operate on the object_types resource, the following permissions are required:

Create

profile:GetProfileObjectType,
profile:PutProfileObjectType,
profile:TagResource,
kms:GenerateDataKey,
kms:Decrypt

Read

profile:GetProfileObjectType,
kms:GenerateDataKey,
kms:Decrypt

Update

profile:GetProfileObjectType,
profile:PutProfileObjectType,
profile:UntagResource,
profile:TagResource,
kms:GenerateDataKey,
kms:Decrypt

Delete

profile:DeleteProfileObjectType

List

profile:ListProfileObjectTypes,
kms:GenerateDataKey,
kms:Decrypt