event_integrations

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

Overview

Name	event_integrations
Type	Resource
Id	aws.appintegrations.event_integrations

Fields

The following fields are returned by SELECT queries:

get_event_integration

Name	Datatype	Description
description	string	The description of the event integration. (pattern: <code>.*</code>)
event_bridge_bus	string	The EventBridge bus. (pattern: <code>^[a-zA-Z0-9/._-]+$</code>)
event_filter	object	The event filter.
event_integration_arn	string	The Amazon Resource Name (ARN) for the event integration. (pattern: <code>^arn:aws:[A-Za-z0-9][A-Za-z0-9_/.-]{0,62}:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,1023}$</code>)
name	string	The name of the event integration. (pattern: <code>^[a-zA-Z0-9/._-]+$</code>)
tags	object	The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.

list_event_integrations

Name	Datatype	Description
description	string	The event integration description. (pattern: <code>.*</code>)
event_bridge_bus	string	The Amazon EventBridge bus for the event integration. (pattern: <code>^[a-zA-Z0-9/._-]+$</code>)
event_filter	object	The event filter.
event_integration_arn	string	The Amazon Resource Name (ARN) of the event integration. (pattern: <code>^arn:aws:[A-Za-z0-9][A-Za-z0-9_/.-]{0,62}:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,1023}$</code>)
name	string	The name of the event integration. (pattern: <code>^[a-zA-Z0-9/._-]+$</code>)
tags	object	The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_event_integration	select	name, region		Returns information about the event integration.
list_event_integrations	select	region	nextToken, maxResults	Returns a paginated list of event integrations in the account.
create_event_integration	insert	region, EventFilter, EventBridgeBus		Creates an EventIntegration, given a specified name, description, and a reference to an Amazon EventBridge bus in your account and a partner event source that pushes events to that bus. No objects are created in the your account, only metadata that is persisted on the EventIntegration control plane.
update_event_integration	update	name, region		Updates the description of an event integration.
delete_event_integration	delete	name, region		Deletes the specified existing event integration. If the event integration is associated with clients, the request is rejected.

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
name	string	The name of the event integration.
region	string	AWS region (default: us-east-1)
maxResults	integer	The maximum number of results to return per page.
nextToken	string	The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

SELECT examples

get_event_integration

Returns information about the event integration.

SELECT
description,
event_bridge_bus,
event_filter,
event_integration_arn,
name,
tags
FROM aws.appintegrations.event_integrations
WHERE name = '{{ name }}' -- required
AND region = '{{ region }}' -- required
;

list_event_integrations

Returns a paginated list of event integrations in the account.

SELECT
description,
event_bridge_bus,
event_filter,
event_integration_arn,
name,
tags
FROM aws.appintegrations.event_integrations
WHERE region = '{{ region }}' -- required
AND nextToken = '{{ nextToken }}'
AND maxResults = '{{ maxResults }}'
;

INSERT examples

create_event_integration

Creates an EventIntegration, given a specified name, description, and a reference to an Amazon EventBridge bus in your account and a partner event source that pushes events to that bus. No objects are created in the your account, only metadata that is persisted on the EventIntegration control plane.

INSERT INTO aws.appintegrations.event_integrations (
Name,
Description,
EventFilter,
EventBridgeBus,
ClientToken,
Tags,
region
)
SELECT 
'{{ Name }}',
'{{ Description }}',
'{{ EventFilter }}' /* required */,
'{{ EventBridgeBus }}' /* required */,
'{{ ClientToken }}',
'{{ Tags }}',
'{{ region }}'
RETURNING
event_integration_arn
;

Manifest

# Description fields are for documentation purposes
- name: event_integrations
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the event_integrations resource.
  - name: Name
    value: "{{ Name }}"
  - name: Description
    value: "{{ Description }}"
  - name: EventFilter
    description: |
      The event filter.
    value:
      Source: "{{ Source }}"
  - name: EventBridgeBus
    value: "{{ EventBridgeBus }}"
  - name: ClientToken
    value: "{{ ClientToken }}"
  - name: Tags
    value: "{{ Tags }}"

UPDATE examples

update_event_integration

Updates the description of an event integration.

UPDATE aws.appintegrations.event_integrations
SET 
Description = '{{ Description }}'
WHERE 
name = '{{ name }}' --required
AND region = '{{ region }}' --required;

DELETE examples

delete_event_integration

Deletes the specified existing event integration. If the event integration is associated with clients, the request is rejected.

DELETE FROM aws.appintegrations.event_integrations
WHERE name = '{{ name }}' --required
AND region = '{{ region }}' --required
;