aws-cdk-lib.aws_lambda_event_sources.S3EventSourceProps

S3EventSourceProps Struct

S3EventSourceProps

used as props by

• S3EventSource,
• S3EventSourceV2

Source

aws-lambda-event-sources/lib/s3.ts

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

eventsEventType[]eventstyping.List[EventType]eventsList<EventType>EventsEventType[]Events*[]EventTyperequired#

The s3 event types that will trigger the notification.

filters?optionalNotificationKeyFilter[]filters?optionaltyping.List[NotificationKeyFilter]filters?optionalList<NotificationKeyFilter>Filters?optionalNotificationKeyFilter[]Filters?optional*[]NotificationKeyFilter#

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.