events3

Documentation

Index

• Constants
• func NewDequeuer(opts ...Option) (*kernel.Dequeuer, error)
• func Source(q *kernel.Dequeuer) (<-chan swarm.Msg[*events.S3EventRecord], ...)
• type Broker
  • func NewBroker(scope constructs.Construct, id *string, props *BrokerProps) *Broker
  • func (broker *Broker) NewBucket(props *awss3.BucketProps) awss3.Bucket
  • func (broker *Broker) NewSink(props *SinkProps) *Sink
• type BrokerProps
• type Client
• type Option
  • func WithConfig(opts ...swarm.Option) Option
• type S3Event
• type Sink
  • func NewSink(scope constructs.Construct, id *string, props *SinkProps) *Sink
• type SinkProps

Constants

const Category = "S3EventRecord"

const EnvConfigSourceS3 = "CONFIG_SWARM_SOURCE_S3"

Environment variable to config event source

const Version = "broker/events3/v0.20.1"

Functions

func NewDequeuer

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

Create reader from AWS S3 Events

func Source

func Source(q *kernel.Dequeuer) (
	<-chan swarm.Msg[*events.S3EventRecord],
	chan<- swarm.Msg[*events.S3EventRecord],
)

The broker produces only events.S3EventRecord, the function is helper.

Types

type Broker

type Broker struct {
	constructs.Construct
	Bucket awss3.Bucket
	// contains filtered or unexported fields
}

func NewBroker

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

func (*Broker) NewBucket

func (broker *Broker) NewBucket(props *awss3.BucketProps) awss3.Bucket

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
}

type Option

type Option func(*Client)

func WithConfig

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

type S3Event

type S3Event struct {
	Records []json.RawMessage `json:"Records"`
}

Note: events.S3Event decodes all records, the swarm kernel protocol requires bytes.

type Sink

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

func NewSink

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

type SinkProps

type SinkProps struct {
	Bucket      awss3.Bucket
	EventSource *awslambdaeventsources.S3EventSourceProps
	Function    scud.FunctionProps
}