event_streams

Creates, updates, deletes, gets or lists an event_streams resource.

Overview

Name	event_streams
Type	Resource
Id	aws.customer_profiles.event_streams

Fields

The following fields are returned by SELECT queries:

get_event_stream

Name	Datatype	Description
created_at	string (date-time)	The timestamp of when the export was created.
destination_details	object	Details regarding the Kinesis stream.
domain_name	string	The unique name of the domain. (pattern: <code>^[a-zA-Z0-9_-]+$</code>)
event_stream_arn	string	A unique identifier for the event stream.
state	string	The operational state of destination stream for export. (RUNNING, STOPPED)
stopped_since	string (date-time)	The timestamp when the State changed to STOPPED.
tags	object	The tags used to organize, track, or control access for this resource.

list_event_streams

Name	Datatype	Description
destination_summary	object	Summary information about the Kinesis data stream.
domain_name	string	The unique name of the domain. (pattern: <code>^[a-zA-Z0-9_-]+$</code>)
event_stream_arn	string	A unique identifier for the event stream.
event_stream_name	string	The name of the event stream. (pattern: <code>^[a-zA-Z0-9_-]+$</code>)
state	string	The operational state of destination stream for export. (RUNNING, STOPPED)
stopped_since	string (date-time)	The timestamp when the State changed to STOPPED.
tags	object	The tags used to organize, track, or control access for this resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_event_stream	select	domain_name, event_stream_name, region		Returns information about the specified event stream in a specific domain.
list_event_streams	select	domain_name, region	next-token, max-results	Returns a list of all the event streams in a specific domain.
create_event_stream	insert	domain_name, event_stream_name, region, Uri		Creates an event stream, which is a subscription to real-time events, such as when profiles are created and updated through Connect Customer Customer Profiles. Each event stream can be associated with only one Kinesis Data Stream destination in the same region and Amazon Web Services account as the customer profiles domain
delete_event_stream	delete	domain_name, event_stream_name, region		Disables and deletes the specified event stream.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
domain_name	string	The unique name of the domain.
event_stream_name	string	The name of the event stream
region	string	AWS region (default: us-east-1)
max-results	integer	The maximum number of objects returned per page.
next-token	string	Identifies the next page of results to return.

SELECT examples

get_event_stream

Returns information about the specified event stream in a specific domain.

SELECT
created_at,
destination_details,
domain_name,
event_stream_arn,
state,
stopped_since,
tags
FROM aws.customer_profiles.event_streams
WHERE domain_name = '{{ domain_name }}' -- required
AND event_stream_name = '{{ event_stream_name }}' -- required
AND region = '{{ region }}' -- required
;

list_event_streams

Returns a list of all the event streams in a specific domain.

SELECT
destination_summary,
domain_name,
event_stream_arn,
event_stream_name,
state,
stopped_since,
tags
FROM aws.customer_profiles.event_streams
WHERE domain_name = '{{ domain_name }}' -- required
AND region = '{{ region }}' -- required
AND `next-token` = '{{ next-token }}'
AND `max-results` = '{{ max-results }}'
;

INSERT examples

create_event_stream

Creates an event stream, which is a subscription to real-time events, such as when profiles are created and updated through Connect Customer Customer Profiles. Each event stream can be associated with only one Kinesis Data Stream destination in the same region and Amazon Web Services account as the customer profiles domain

INSERT INTO aws.customer_profiles.event_streams (
Uri,
Tags,
domain_name,
event_stream_name,
region
)
SELECT 
'{{ Uri }}' /* required */,
'{{ Tags }}',
'{{ domain_name }}',
'{{ event_stream_name }}',
'{{ region }}'
RETURNING
event_stream_arn,
tags
;

Manifest

# Description fields are for documentation purposes
- name: event_streams
props:
  - name: domain_name
    value: "{{ domain_name }}"
    description: Required parameter for the event_streams resource.
  - name: event_stream_name
    value: "{{ event_stream_name }}"
    description: Required parameter for the event_streams resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the event_streams resource.
  - name: Uri
    value: "{{ Uri }}"
  - name: Tags
    value: "{{ Tags }}"

DELETE examples

delete_event_stream

Disables and deletes the specified event stream.

DELETE FROM aws.customer_profiles.event_streams
WHERE domain_name = '{{ domain_name }}' --required
AND event_stream_name = '{{ event_stream_name }}' --required
AND region = '{{ region }}' --required
;