event_buses

Creates, updates, deletes or gets an event_bus resource or lists event_buses in a region

Overview

Name	event_buses
Type	Resource
Description	Resource type definition for AWS::Events::EventBus
Id	aws.events.event_buses

Fields

Name	Datatype	Description
event_source_name	string	If you are creating a partner event bus, this specifies the partner event source that the new event bus will be matched with.
name	string	The name of the event bus.
tags	array	Any tags assigned to the event bus.
description	string	The description of the event bus.
kms_key_identifier	string	Kms Key Identifier used to encrypt events at rest in the event bus.
policy	object	A JSON string that describes the permission policy statement for the event bus.
arn	string	The Amazon Resource Name (ARN) for the event bus.
dead_letter_config	object	Dead Letter Queue for the event bus.
region	string	AWS region.

Methods

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

SELECT
region,
event_source_name,
name,
tags,
description,
kms_key_identifier,
policy,
arn,
dead_letter_config
FROM aws.events.event_buses
WHERE region = 'us-east-1';

Gets all properties from an individual event_bus.

SELECT
region,
event_source_name,
name,
tags,
description,
kms_key_identifier,
policy,
arn,
dead_letter_config
FROM aws.events.event_buses
WHERE region = 'us-east-1' AND data__Identifier = '<Name>';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO aws.events.event_buses (
 Name,
 region
)
SELECT 
'{{ Name }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.events.event_buses (
 EventSourceName,
 Name,
 Tags,
 Description,
 KmsKeyIdentifier,
 Policy,
 DeadLetterConfig,
 region
)
SELECT 
 '{{ EventSourceName }}',
 '{{ Name }}',
 '{{ Tags }}',
 '{{ Description }}',
 '{{ KmsKeyIdentifier }}',
 '{{ Policy }}',
 '{{ DeadLetterConfig }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: event_bus
    props:
      - name: EventSourceName
        value: '{{ EventSourceName }}'
      - name: Name
        value: '{{ Name }}'
      - name: Tags
        value:
          - Value: '{{ Value }}'
            Key: '{{ Key }}'
      - name: Description
        value: '{{ Description }}'
      - name: KmsKeyIdentifier
        value: '{{ KmsKeyIdentifier }}'
      - name: Policy
        value: {}
      - name: DeadLetterConfig
        value:
          Arn: '{{ Arn }}'

DELETE example

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

Permissions

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

Create

events:CreateEventBus,
events:DescribeEventBus,
events:PutPermission,
events:ListTagsForResource,
events:TagResource,
kms:DescribeKey,
kms:GenerateDataKey,
kms:Decrypt

Read

events:DescribeEventBus,
events:ListTagsForResource

Update

events:TagResource,
events:UntagResource,
events:PutPermission,
events:DescribeEventBus,
events:UpdateEventBus,
kms:DescribeKey,
kms:GenerateDataKey,
kms:Decrypt

Delete

events:DescribeEventBus,
events:UpdateEventBus,
events:ListTagsForResource,
events:UntagResource,
events:RemovePermission,
events:DeleteEventBus

List

events:ListEventBuses,
events:ListTagsForResource