interface S3EventSourceProps

Language	Type name
.NET	Amazon.CDK.AWS.Lambda.EventSources.S3EventSourceProps
Go	github.com/aws/aws-cdk-go/awscdk/v2/awslambdaeventsources#S3EventSourceProps
Java	software.amazon.awscdk.services.lambda.eventsources.S3EventSourceProps
Python	aws_cdk.aws_lambda_event_sources.S3EventSourceProps
TypeScript (source)	aws-cdk-lib » aws_lambda_event_sources » S3EventSourceProps

Example

import * as s3 from 'aws-cdk-lib/aws-s3';
import { S3EventSource } from 'aws-cdk-lib/aws-lambda-event-sources';

const bucket = new s3.Bucket(this, 'mybucket');
declare const fn: lambda.Function;

fn.addEventSource(new S3EventSource(bucket, {
  events: [ s3.EventType.OBJECT_CREATED, s3.EventType.OBJECT_REMOVED ],
  filters: [ { prefix: 'subdir/' } ], // optional
}));

Properties

Name	Type	Description
events	EventType[]	The s3 event types that will trigger the notification.
filters?	NotificationKeyFilter[]	S3 object key filter rules to determine which objects trigger this event.

---

events

Type: EventType[]

The s3 event types that will trigger the notification.

---

filters?

Type: NotificationKeyFilter[] (optional)

S3 object key filter rules to determine which objects trigger this event.

Each filter must include a prefix and/or suffix that will be matched against the s3 object key. Refer to the S3 Developer Guide for details about allowed filter rules.