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	awscc.appintegrations.event_integrations

Fields

get (all properties)

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.

list (identifiers only)

Name	Datatype	Description
name	string	The name of the event integration.
region	string	AWS region.

For more information, see AWS::AppIntegrations::EventIntegration.

Methods

Name	Resource	Accessible by	Required Params
create_resource	event_integrations	INSERT	Name, EventBridgeBus, EventFilter, region
delete_resource	event_integrations	DELETE	Identifier, region
update_resource	event_integrations	UPDATE	Identifier, PatchDocument, region
list_resources	event_integrations_list_only	SELECT	region
get_resource	event_integrations	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual event_integration.

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

list (identifiers only)

Lists all event_integrations in a region.

SELECT
  region,
  name
FROM awscc.appintegrations.event_integrations_list_only
WHERE
  region = '{{ region }}';

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 awscc.appintegrations.event_integrations (
  Name,
  EventBridgeBus,
  EventFilter,
  region
)
SELECT
  '{{ name }}',
  '{{ event_bridge_bus }}',
  '{{ event_filter }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.appintegrations.event_integrations (
  Description,
  Name,
  EventBridgeBus,
  EventFilter,
  Tags,
  region
)
SELECT
  '{{ description }}',
  '{{ name }}',
  '{{ event_bridge_bus }}',
  '{{ event_filter }}',
  '{{ tags }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

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: event_bridge_bus
      value: '{{ event_bridge_bus }}'
    - name: event_filter
      value:
        source: '{{ source }}'
    - name: tags
      value:
        - key: '{{ key }}'
          value: '{{ value }}'

UPDATE example

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

/*+ update */
UPDATE awscc.appintegrations.event_integrations
SET PatchDocument = string('{{ {
    "Description": description,
    "Tags": tags
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ name }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

/*+ delete */
DELETE FROM awscc.appintegrations.event_integrations
WHERE
  Identifier = '{{ name }}' AND
  region = '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Additional Parameters

Mutable resources in the Cloud Control provider support additional optional parameters which can be supplied with INSERT, UPDATE, or DELETE operations. These include:

Parameter	Description
ClientToken	A unique identifier to ensure the idempotency of the resource request. This allows the provider to accurately distinguish between retries and new requests. A client token is valid for 36 hours once used. After that, a resource request with the same client token is treated as a new request. If you do not specify a client token, one is generated for inclusion in the request.
RoleArn	The ARN of the IAM role used to perform this resource operation. The role specified must have the permissions required for this operation. If you do not specify a role, a temporary session is created using your AWS user credentials.
TypeVersionId	For private resource types, the type version to use in this resource operation. If you do not specify a resource version, the default version is used.

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