API.md

API Reference

Table of Contents

• Classes
  • Bus
  • platform.tfaws.Bus
  • platform.sim.Bus
  • platform.sim.EventBridgeBus
  • platform.awscdk.Bus
  • platform.aws.Util
• Interfaces
  • IBus
• Structs
  • BusProps
  • Event
  • PublishEvent
  • platform.aws.PutEventCommandEntry
  • platform.aws.PutEventCommandInput

Bus (preflight class)

No description

Constructor

new(props: BusProps?): Bus

Properties

No properties

Methods

Signature	Description
onEvent(name: str, handler: inflight (Event): void, pattern: Json): void	No description
inflight putEvents(events: Array): void	No description
subscribeQueue(name: str, queue: Queue, pattern: Json): void	No description

platform.tfaws.Bus (preflight class)

No description

Constructor

new(props: BusProps?): Bus

Properties

No properties

Methods

Signature	Description
onEvent(name: str, handler: inflight (Event): void, pattern: Json): void	No description
inflight putEvents(events: Array): void	No description
subscribeQueue(name: str, queue: Queue, pattern: Json): void	No description

platform.sim.Bus (preflight class)

No description

Constructor

new(props: BusProps?): Bus

Properties

No properties

Methods

Signature	Description
onEvent(name: str, handler: inflight (Event): void, pattern: Json): void	No description
inflight putEvents(events: Array): void	No description
subscribeQueue(name: str, queue: Queue, pattern: Json): void	No description

platform.sim.EventBridgeBus (preflight class)

No description

Constructor

new(props: BusProps?): EventBridgeBus

Properties

No properties

Methods

Signature	Description
inflight putEvents(events: Array): void	No description
subscribe(callback: inflight (Event): void, pattern: Json): Resource	No description

platform.awscdk.Bus (preflight class)

No description

Constructor

new(props: BusProps?): Bus

Properties

No properties

Methods

Signature	Description
static addRulePermission(handler: str, arn: str): void	No description
onEvent(name: str, handler: inflight (Event): void, pattern: Json): void	No description
inflight putEvents(events: Array): void	No description
subscribeQueue(name: str, queue: Queue, pattern: Json): void	No description

platform.aws.Util (preflight class)

No description

Constructor

new(): Util

Properties

No properties

Methods

Signature	Description
static inflight _putEvent(name: str, event: PutEventCommandInput): void	No description
static inflight putEvent(name: str, events: Array): void	No description

IBus (interface)

No description

Properties

Name	Type	Description
node	Node	The tree node.

Methods

Signature	Description
onEvent(name: str, handler: inflight (Event): void, pattern: Json): void	No description
inflight putEvents(events: Array): void	No description
subscribeQueue(name: str, queue: Queue, pattern: Json): void	No description

BusProps (struct)

No description

Properties

Name	Type	Description
debug	bool?	No description
name	str	No description

Event (struct)

No description

Properties

Name	Type	Description
account	str	No description
detail	Json	No description
detailType	str	No description
id	str	No description
region	str	No description
resources	Array	No description
source	str	No description
time	str	No description
version	str	No description

PublishEvent (struct)

No description

Properties

Name	Type	Description
detail	Json	No description
detailType	str	No description
resources	Array	No description
source	str	No description
version	str	No description

platform.aws.PutEventCommandEntry (struct)

No description

Properties

Name	Type	Description
Detail	str	No description
DetailType	str	No description
EventBusName	str	No description
Resources	Array	No description
Source	str	No description

platform.aws.PutEventCommandInput (struct)

No description

Properties

Name	Type	Description
Entries	Array	No description