event_triggers

Creates, updates, deletes or gets an event_trigger resource or lists event_triggers in a region

Overview

Name	event_triggers
Type	Resource
Description	An event trigger resource of Amazon Connect Customer Profiles
Id	aws.customerprofiles.event_triggers

Fields

Name	Datatype	Description
domain_name	string	The unique name of the domain.
event_trigger_name	string	The unique name of the event trigger.
object_type_name	string	The unique name of the object type.
description	string	The description of the event trigger.
event_trigger_conditions	array	A list of conditions that determine when an event should trigger the destination.
event_trigger_limits	object	Defines limits controlling whether an event triggers the destination, based on ingestion latency and the number of invocations per profile over specific time periods.
segment_filter	string	The destination is triggered only for profiles that meet the criteria of a segment definition.
created_at	string	The timestamp of when the event trigger was created.
last_updated_at	string	The timestamp of when the event trigger was most recently updated.
tags	array	An array of key-value pairs to apply to this resource.
region	string	AWS region.

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

Methods

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

SELECT
region,
domain_name,
event_trigger_name,
object_type_name,
description,
event_trigger_conditions,
event_trigger_limits,
segment_filter,
created_at,
last_updated_at,
tags
FROM aws.customerprofiles.event_triggers
WHERE region = 'us-east-1';

Gets all properties from an individual event_trigger.

SELECT
region,
domain_name,
event_trigger_name,
object_type_name,
description,
event_trigger_conditions,
event_trigger_limits,
segment_filter,
created_at,
last_updated_at,
tags
FROM aws.customerprofiles.event_triggers
WHERE region = 'us-east-1' AND data__Identifier = '<DomainName>|<EventTriggerName>';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO aws.customerprofiles.event_triggers (
 DomainName,
 EventTriggerName,
 ObjectTypeName,
 EventTriggerConditions,
 region
)
SELECT 
'{{ DomainName }}',
 '{{ EventTriggerName }}',
 '{{ ObjectTypeName }}',
 '{{ EventTriggerConditions }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.customerprofiles.event_triggers (
 DomainName,
 EventTriggerName,
 ObjectTypeName,
 Description,
 EventTriggerConditions,
 EventTriggerLimits,
 SegmentFilter,
 Tags,
 region
)
SELECT 
 '{{ DomainName }}',
 '{{ EventTriggerName }}',
 '{{ ObjectTypeName }}',
 '{{ Description }}',
 '{{ EventTriggerConditions }}',
 '{{ EventTriggerLimits }}',
 '{{ SegmentFilter }}',
 '{{ Tags }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: event_trigger
    props:
      - name: DomainName
        value: '{{ DomainName }}'
      - name: EventTriggerName
        value: '{{ EventTriggerName }}'
      - name: ObjectTypeName
        value: '{{ ObjectTypeName }}'
      - name: Description
        value: '{{ Description }}'
      - name: EventTriggerConditions
        value:
          - EventTriggerDimensions:
              - ObjectAttributes:
                  - Source: '{{ Source }}'
                    FieldName: '{{ FieldName }}'
                    ComparisonOperator: '{{ ComparisonOperator }}'
                    Values:
                      - '{{ Values[0] }}'
            LogicalOperator: '{{ LogicalOperator }}'
      - name: EventTriggerLimits
        value:
          EventExpiration: '{{ EventExpiration }}'
          Periods:
            - Unit: '{{ Unit }}'
              Value: '{{ Value }}'
              MaxInvocationsPerProfile: '{{ MaxInvocationsPerProfile }}'
              Unlimited: '{{ Unlimited }}'
      - name: SegmentFilter
        value: '{{ SegmentFilter }}'
      - name: Tags
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'

DELETE example

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

Permissions

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

Create

profile:CreateEventTrigger,
profile:TagResource

Read

profile:GetEventTrigger

Update

profile:GetEventTrigger,
profile:UpdateEventTrigger,
profile:UntagResource,
profile:TagResource

Delete

profile:DeleteEventTrigger

List

profile:ListEventTriggers