Package software.amazon.awscdk.services.lambda.eventsources

Interface S3EventSourceProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

S3EventSourceProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)",
           date="2025-11-17T14:40:55.041Z")
@Stability(Stable)
public interface S3EventSourceProps
extends software.amazon.jsii.JsiiSerializable

Example:

 import software.amazon.awscdk.services.s3.*;
 import software.amazon.awscdk.services.lambda.eventsources.S3EventSource;
 Function fn;
 Bucket bucket = new Bucket(this, "mybucket");
 fn.addEventSource(S3EventSource.Builder.create(bucket)
         .events(List.of(EventType.OBJECT_CREATED, EventType.OBJECT_REMOVED))
         .filters(List.of(NotificationKeyFilter.builder().prefix("subdir/").build()))
         .build());
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	S3EventSourceProps.Builder	A builder for S3EventSourceProps
static final class	S3EventSourceProps.Jsii$Proxy	An implementation for S3EventSourceProps

Method Summary

Modifier and Type	Method	Description
static S3EventSourceProps.Builder	builder()
List<EventType>	getEvents()	The s3 event types that will trigger the notification.
default List<NotificationKeyFilter>	getFilters()	S3 object key filter rules to determine which objects trigger this event.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getEvents

@Stability(Stable)
@NotNull
List<EventType> getEvents()

The s3 event types that will trigger the notification.

getFilters

@Stability(Stable)
@Nullable
default List<NotificationKeyFilter> getFilters()

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.

builder

@Stability(Stable)
static S3EventSourceProps.Builder builder()

Returns:

a S3EventSourceProps.Builder of S3EventSourceProps