eventbridge

README

AWS EventBridge Broker

The sub-module implements swarm broker for AWS EventBridge. See the library documentation for details.

Serverless

AWS Event Bridge has a feature that allows to match execution of consumer to the pattern of JSON object. Use it to build reliable matching of incoming events:

/*
enq <- &swarm.Event[User]{
  Meta: &swarm.Meta{Agent: "swarm:example", Participant: "user"},
  Data: &User{ID: "user", Text: "some text"},
}
*/

stack.NewSink(
  &eventbridge.SinkProps{
    EventPattern: eventbridge.Event(
      eventbridge.Type[User](),
      eventbridge.Meta("agent", curie.IRI("swarm:example"))
      eventbridge.Meta("participant", curie.IRI("user"))
    ),
    /* ... */
  },
)

Limitation

AWS EventBridge cannot transmit bytes. They have to be enveloped as JSON object. The library implements automatic encapsulation using built-in kernel/encoding/CodecPacket. Use these codec (WithPacketCodec) if you automatically source events from EventBridge to SQS.

Documentation

Index

• Constants
• func Like(seq ...Expr) *awsevents.EventPattern
• func New(bus string, opts ...Option) (*kernel.Kernel, error)
• func NewDequeuer(bus string, opts ...Option) (*kernel.Dequeuer, error)
• func NewEnqueuer(bus string, opts ...Option) (*kernel.Enqueuer, error)
• type Broker
  • func NewBroker(scope constructs.Construct, id *string, props *BrokerProps) *Broker
  • func (broker *Broker) AddEventBus(eventBusName string) awsevents.IEventBus
  • func (broker *Broker) NewEventBus(props *awsevents.EventBusProps) awsevents.IEventBus
  • func (broker *Broker) NewSink(props *SinkProps) *Sink
• type BrokerProps
• type Client
  • func (cli *Client) Enq(ctx context.Context, bag swarm.Bag) error
• type EventBridge
• type Expr
  • func Category(cats ...string) Expr
  • func EventData(key string, values ...any) Expr
  • func EventMeta(key string, values ...any) Expr
  • func Has(key string, values ...any) Expr
  • func Source(sources ...string) Expr
  • func Type[T any]() Expr
• type Option
  • func WithConfig(opts ...swarm.Option) Option
  • func WithService(service EventBridge) Option
• type Sink
  • func NewSink(scope constructs.Construct, id *string, props *SinkProps) *Sink
• type SinkProps

Constants

const EnvConfigSourceEventBridge = "CONFIG_SWARM_SOURCE_EVENTBRIDGE"

Environment variable to config event source

const Version = "broker/eventbridge/v0.21.0"

Functions

func Like

func Like(seq ...Expr) *awsevents.EventPattern

Like combinator defines DSL to configure awsevents.EventPattern https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-create-pattern.html

func New

func New(bus string, opts ...Option) (*kernel.Kernel, error)

Create enqueue & dequeue routine to AWS EventBridge

func NewDequeuer

func NewDequeuer(bus string, opts ...Option) (*kernel.Dequeuer, error)

Create reader from AWS EventBridge

func NewEnqueuer

func NewEnqueuer(bus string, opts ...Option) (*kernel.Enqueuer, error)

Create writer to AWS EventBridge

Types

type Broker

type Broker struct {
	constructs.Construct
	Bus awsevents.IEventBus
	// contains filtered or unexported fields
}

func NewBroker

func NewBroker(scope constructs.Construct, id *string, props *BrokerProps) *Broker

func (*Broker) AddEventBus

func (broker *Broker) AddEventBus(eventBusName string) awsevents.IEventBus

func (*Broker) NewEventBus

func (broker *Broker) NewEventBus(props *awsevents.EventBusProps) awsevents.IEventBus

func (*Broker) NewSink

func (broker *Broker) NewSink(props *SinkProps) *Sink

type BrokerProps

type BrokerProps struct {
	System string
}

type Client

type Client struct {
	// contains filtered or unexported fields
}

EventBridge client

func (*Client) Enq

func (cli *Client) Enq(ctx context.Context, bag swarm.Bag) error

Enq enqueues message to broker

type EventBridge

type EventBridge interface {
	PutEvents(context.Context, *eventbridge.PutEventsInput, ...func(*eventbridge.Options)) (*eventbridge.PutEventsOutput, error)
}

EventBridge declares the subset of interface from AWS SDK used by the lib.

type Expr

type Expr func(*awsevents.EventPattern)

Event Pattern expression

func Category

func Category(cats ...string) Expr

Configure event pattern to match a category

func EventData

func EventData(key string, values ...any) Expr

Configure event pattern to match Event's Data key

func EventMeta

func EventMeta(key string, values ...any) Expr

Configure event pattern to match Event's Meta key

func Has

func Has(key string, values ...any) Expr

Configure event pattern to match object's key

func Source

func Source(sources ...string) Expr

Configure event pattern to match source(s)

func Type

func Type[T any]() Expr

Configure event pattern to match a type

type Option

type Option func(*Client)

func WithConfig

func WithConfig(opts ...swarm.Option) Option

func WithService

func WithService(service EventBridge) Option

type Sink

type Sink struct {
	constructs.Construct
	Rule    awsevents.Rule
	Handler awslambda.IFunction
}

func NewSink

func NewSink(scope constructs.Construct, id *string, props *SinkProps) *Sink

type SinkProps

type SinkProps struct {
	System       awsevents.IEventBus
	EventPattern *awsevents.EventPattern
	Function     scud.FunctionProps
}

See https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-event-patterns.html