AWS CDK Typescript Lambda Handler Event Type

Question

I'm using CDK to create my serverless app, and I current have a lambda trigger by an S3 put event, like so:

const function = new NodejsFunction(this, `id-here`, {
            entry: path.join(__dirname, '/../src/lambda/index.ts'),
            ...more props
        });

function.addEventSource(new eventsources.S3EventSource(this.myBucket, {
            events: [ s3.EventType.OBJECT_CREATED ],
            filters: [ ... ]
        }));

I can't seem to find, by looking through the docs, what type I should be using in my typescript handler:

export const handler  = (event: <What goes here?>) => {

    //some stuff

    return someThing
}

Thanks in advance!

fedonev · Accepted Answer · 2022-04-05 13:49:11Z

3

The events your Lambda receives will be of the type S3Event from the @types/aws-lambda package:

export interface S3Event {
    Records: S3EventRecord[];
}

answered Apr 5, 2022 at 13:49

fedonev

26.1k2 gold badges43 silver badges60 bronze badges

Sign up to request clarification or add additional context in comments.

2 Comments

Sam Over a year ago

Thanks @fedonev! I'm new to Typescript and didn't realise it would be in a separate package!

JonTroncoso Over a year ago

How do you know this? How do I look up the one for my use case (state-machine listening to API-Gateway)? How would I look up other use-cases?

Collectives™ on Stack Overflow

AWS CDK Typescript Lambda Handler Event Type

1 Answer 1

2 Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

2 Comments

Your Answer

Sign up or log in

Post as a guest

Related