integrations

Creates, updates, deletes or gets an integration resource or lists integrations in a region

Overview

Name	integrations
Type	Resource
Description	The resource schema for creating an Amazon Connect Customer Profiles Integration.
Id	aws.customerprofiles.integrations

Fields

Name	Datatype	Description
domain_name	string	The unique name of the domain.
uri	string	The URI of the S3 bucket or any other type of data source.
flow_definition	object
object_type_name	string	The name of the ObjectType defined for the 3rd party data in Profile Service
created_at	string	The time of this integration got created
last_updated_at	string	The time of this integration got last updated at
tags	array	The tags (keys and values) associated with the integration
object_type_names	array	The mapping between 3rd party event types and ObjectType names
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	DomainName, 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 integrations in a region.

SELECT
region,
domain_name,
uri,
flow_definition,
object_type_name,
created_at,
last_updated_at,
tags,
object_type_names
FROM aws.customerprofiles.integrations
WHERE region = 'us-east-1';

Gets all properties from an individual integration.

SELECT
region,
domain_name,
uri,
flow_definition,
object_type_name,
created_at,
last_updated_at,
tags,
object_type_names
FROM aws.customerprofiles.integrations
WHERE region = 'us-east-1' AND data__Identifier = '<DomainName>|<Uri>';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO aws.customerprofiles.integrations (
 DomainName,
 region
)
SELECT 
'{{ DomainName }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.customerprofiles.integrations (
 DomainName,
 Uri,
 FlowDefinition,
 ObjectTypeName,
 Tags,
 ObjectTypeNames,
 region
)
SELECT 
 '{{ DomainName }}',
 '{{ Uri }}',
 '{{ FlowDefinition }}',
 '{{ ObjectTypeName }}',
 '{{ Tags }}',
 '{{ ObjectTypeNames }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: integration
    props:
      - name: DomainName
        value: '{{ DomainName }}'
      - name: Uri
        value: '{{ Uri }}'
      - name: FlowDefinition
        value:
          FlowName: '{{ FlowName }}'
          Description: '{{ Description }}'
          KmsArn: '{{ KmsArn }}'
          Tasks:
            - ConnectorOperator:
                Marketo: '{{ Marketo }}'
                S3: '{{ S3 }}'
                Salesforce: '{{ Salesforce }}'
                ServiceNow: '{{ ServiceNow }}'
                Zendesk: '{{ Zendesk }}'
              SourceFields:
                - '{{ SourceFields[0] }}'
              DestinationField: '{{ DestinationField }}'
              TaskType: '{{ TaskType }}'
              TaskProperties:
                - OperatorPropertyKey: '{{ OperatorPropertyKey }}'
                  Property: '{{ Property }}'
          TriggerConfig:
            TriggerType: '{{ TriggerType }}'
            TriggerProperties:
              Scheduled:
                ScheduleExpression: '{{ ScheduleExpression }}'
                DataPullMode: '{{ DataPullMode }}'
                ScheduleStartTime: null
                ScheduleEndTime: null
                Timezone: '{{ Timezone }}'
                ScheduleOffset: '{{ ScheduleOffset }}'
                FirstExecutionFrom: null
          SourceFlowConfig:
            ConnectorType: '{{ ConnectorType }}'
            ConnectorProfileName: '{{ ConnectorProfileName }}'
            IncrementalPullConfig:
              DatetimeTypeFieldName: '{{ DatetimeTypeFieldName }}'
            SourceConnectorProperties:
              Marketo:
                Object: '{{ Object }}'
              S3:
                BucketName: '{{ BucketName }}'
                BucketPrefix: '{{ BucketPrefix }}'
              Salesforce:
                Object: null
                EnableDynamicFieldUpdate: '{{ EnableDynamicFieldUpdate }}'
                IncludeDeletedRecords: '{{ IncludeDeletedRecords }}'
              ServiceNow:
                Object: null
              Zendesk:
                Object: null
      - name: ObjectTypeName
        value: '{{ ObjectTypeName }}'
      - name: Tags
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'
      - name: ObjectTypeNames
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'

DELETE example

/*+ delete */
DELETE FROM aws.customerprofiles.integrations
WHERE data__Identifier = '<DomainName|Uri>'
AND region = 'us-east-1';

Permissions

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

Create

profile:GetIntegration,
profile:PutIntegration,
appflow:CreateFlow,
app-integrations:CreateEventIntegrationAssociation,
app-integrations:GetEventIntegration,
events:ListTargetsByRule,
events:PutRule,
events:PutTargets,
events:PutEvents,
profile:TagResource

Read

profile:GetIntegration

Delete

profile:DeleteIntegration,
appflow:DeleteFlow,
app-integrations:ListEventIntegrationAssociations,
app-integrations:DeleteEventIntegrationAssociation,
events:RemoveTargets,
events:ListTargetsByRule,
events:DeleteRule

Update

profile:PutIntegration,
profile:GetIntegration,
appflow:CreateFlow,
app-integrations:GetEventIntegration,
app-integrations:CreateEventIntegrationAssociation,
app-integrations:ListEventIntegrationAssociations,
app-integrations:DeleteEventIntegrationAssociation,
events:ListTargetsByRule,
events:RemoveTargets,
events:DeleteRule,
events:PutRule,
events:PutTargets,
events:PutEvents,
profile:UntagResource,
profile:TagResource

List

profile:ListIntegrations