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	awscc.events.event_buses

Fields

get (all properties)

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.
▶log_config	object	The logging configuration settings for vended logs.
region	string	AWS region.

list (identifiers only)

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

For more information, see AWS::Events::EventBus.

Methods

Name	Resource	Accessible by	Required Params
create_resource	event_buses	INSERT	Name, region
delete_resource	event_buses	DELETE	Identifier, region
update_resource	event_buses	UPDATE	Identifier, PatchDocument, region
list_resources	event_buses_list_only	SELECT	region
get_resource	event_buses	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual event_bus.

SELECT
  region,
  event_source_name,
  name,
  tags,
  description,
  kms_key_identifier,
  policy,
  arn,
  dead_letter_config,
  log_config
FROM awscc.events.event_buses
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ name }}';

list (identifiers only)

Lists all event_buses in a region.

SELECT
  region,
  name
FROM awscc.events.event_buses_list_only
WHERE
  region = '{{ region }}';

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

All Properties

/*+ create */
INSERT INTO awscc.events.event_buses (
  EventSourceName,
  Name,
  Tags,
  Description,
  KmsKeyIdentifier,
  Policy,
  DeadLetterConfig,
  LogConfig,
  region
)
SELECT
  '{{ event_source_name }}',
  '{{ name }}',
  '{{ tags }}',
  '{{ description }}',
  '{{ kms_key_identifier }}',
  '{{ policy }}',
  '{{ dead_letter_config }}',
  '{{ log_config }}',
  '{{ 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_bus
  props:
    - name: event_source_name
      value: '{{ event_source_name }}'
    - name: name
      value: '{{ name }}'
    - name: tags
      value:
        - value: '{{ value }}'
          key: '{{ key }}'
    - name: description
      value: '{{ description }}'
    - name: kms_key_identifier
      value: '{{ kms_key_identifier }}'
    - name: policy
      value: {}
    - name: dead_letter_config
      value:
        arn: '{{ arn }}'
    - name: log_config
      value:
        include_detail: '{{ include_detail }}'
        level: '{{ level }}'

UPDATE example

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

/*+ update */
UPDATE awscc.events.event_buses
SET PatchDocument = string('{{ {
    "EventSourceName": event_source_name,
    "Tags": tags,
    "Description": description,
    "KmsKeyIdentifier": kms_key_identifier,
    "Policy": policy,
    "DeadLetterConfig": dead_letter_config,
    "LogConfig": log_config
} | 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.events.event_buses
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_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