serverless/docs/guide/overview-of-event-sources.md

Overview of event sources

Here's a list of all available event sources grouped by provider.

Note: This list will be updated constantly as we're adding more and more event sources in the future. Just open up an issue if you have any wishes regarding event support.

The examples will show you how you can use the different event definitions.

Amazon Web Services (AWS)

S3

Simple event definition

This will create a photos bucket which fires the resize function when an object is added or modified inside the bucket.

functions:
    resize:
        handler: resize
        events:
            - s3: photos

Extended event definition

This will create a bucket photos. The users function is called whenever an object is removed from the bucket.

functions:
    users:
        handler: users.handler
        events:
            - s3:
                bucket: photos
                event: s3:ObjectRemoved:*

Schedule

Simple event definition

This will attach a schedule event and causes the function crawl to be called every 2 hours.

functions:
    crawl:
        handler: crawl
        events:
            - schedule: rate(2 hours)

Extended event definition

This will create and attach a schedule event for the aggregate function which is disabled. If enabled it will call the aggregate function every 10 minutes.

functions:
    aggregate:
        handler: statistics.handler
        events:
            - schedule:
                rate: rate(10 minutes)
                enabled: false

HTTP endpoint

Simple event definition

This will create a new HTTP endpoint which is accessible at users/show via a GET request. show will be called whenever the endpoint is accessed.

functions:
    show:
        handler: users.show
        events:
            - http: GET users/show

Extended event definition

This will create a new HTTP endpoint which is accessible at posts/create with the help of the HTTP POST method. The function create is called every time someone visits this endpoint.

functions:
    create:
        handler: posts.create
        events:
            - http:
                path: posts/create
                method: POST