event_streams

Creates, updates, deletes or gets an event_stream resource or lists event_streams in a region

Overview

Name	event_streams
Type	Resource
Description	An Event Stream resource of Amazon Connect Customer Profiles
Id	aws.customerprofiles.event_streams

Fields

Name	Datatype	Description
domain_name	string	The unique name of the domain.
event_stream_name	string	The name of the event stream.
uri	string	The StreamARN of the destination to deliver profile events to. For example, arn:aws:kinesis:region:account-id:stream/stream-name
event_stream_arn	string	A unique identifier for the event stream.
tags	array	The tags used to organize, track, or control access for this resource.
created_at	string	The timestamp of when the export was created.
state	string	The operational state of destination stream for export.
destination_details	object	Details regarding the Kinesis stream.
region	string	AWS region.

Methods

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

SELECT
region,
domain_name,
event_stream_name,
uri,
event_stream_arn,
tags,
created_at,
state,
destination_details
FROM aws.customerprofiles.event_streams
WHERE region = 'us-east-1';

Gets all properties from an individual event_stream.

SELECT
region,
domain_name,
event_stream_name,
uri,
event_stream_arn,
tags,
created_at,
state,
destination_details
FROM aws.customerprofiles.event_streams
WHERE region = 'us-east-1' AND data__Identifier = '<DomainName>|<EventStreamName>';

INSERT example

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

Required Properties

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

All Properties

/*+ create */
INSERT INTO aws.customerprofiles.event_streams (
 DomainName,
 EventStreamName,
 Uri,
 Tags,
 region
)
SELECT 
 '{{ DomainName }}',
 '{{ EventStreamName }}',
 '{{ Uri }}',
 '{{ Tags }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: event_stream
    props:
      - name: DomainName
        value: '{{ DomainName }}'
      - name: EventStreamName
        value: '{{ EventStreamName }}'
      - name: Uri
        value: '{{ Uri }}'
      - name: Tags
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'

DELETE example

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

Permissions

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

Create

profile:CreateEventStream,
iam:PutRolePolicy,
kinesis:DescribeStreamSummary,
profile:TagResource

Read

profile:GetEventStream,
kinesis:DescribeStreamSummary

Update

kinesis:DescribeStreamSummary,
profile:GetEventStream,
profile:UntagResource,
profile:TagResource

Delete

profile:DeleteEventStream,
iam:DeleteRolePolicy

List

profile:ListEventStreams