event_integrations

Creates, updates, deletes or gets an event_integration resource or lists event_integrations in a region

Overview

Name	event_integrations
Type	Resource
Description	Resource Type definition for AWS::AppIntegrations::EventIntegration
Id	aws.appintegrations.event_integrations

Fields

Name	Datatype	Description
description	string	The event integration description.
event_integration_arn	string	The Amazon Resource Name (ARN) of the event integration.
name	string	The name of the event integration.
event_bridge_bus	string	The Amazon Eventbridge bus for the event integration.
event_filter	object	The EventFilter (source) associated with the event integration.
tags	array	The tags (keys and values) associated with the event integration.
region	string	AWS region.

Methods

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

SELECT
region,
description,
event_integration_arn,
name,
event_bridge_bus,
event_filter,
tags
FROM aws.appintegrations.event_integrations
WHERE region = 'us-east-1';

Gets all properties from an individual event_integration.

SELECT
region,
description,
event_integration_arn,
name,
event_bridge_bus,
event_filter,
tags
FROM aws.appintegrations.event_integrations
WHERE region = 'us-east-1' AND data__Identifier = '<Name>';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO aws.appintegrations.event_integrations (
 Name,
 EventBridgeBus,
 EventFilter,
 region
)
SELECT 
'{{ Name }}',
 '{{ EventBridgeBus }}',
 '{{ EventFilter }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.appintegrations.event_integrations (
 Description,
 Name,
 EventBridgeBus,
 EventFilter,
 Tags,
 region
)
SELECT 
 '{{ Description }}',
 '{{ Name }}',
 '{{ EventBridgeBus }}',
 '{{ EventFilter }}',
 '{{ Tags }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: event_integration
    props:
      - name: Description
        value: '{{ Description }}'
      - name: Name
        value: '{{ Name }}'
      - name: EventBridgeBus
        value: '{{ EventBridgeBus }}'
      - name: EventFilter
        value:
          Source: '{{ Source }}'
      - name: Tags
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'

DELETE example

/*+ delete */
DELETE FROM aws.appintegrations.event_integrations
WHERE data__Identifier = '<Name>'
AND region = 'us-east-1';

Permissions

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

Create

app-integrations:CreateEventIntegration,
app-integrations:TagResource

Read

app-integrations:GetEventIntegration,
app-integrations:ListTagsForResource

List

app-integrations:ListEventIntegrations

Update

app-integrations:GetEventIntegration,
app-integrations:UpdateEventIntegration,
app-integrations:TagResource,
app-integrations:UntagResource

Delete

app-integrations:DeleteEventIntegration