Interface S3EventSourceProps

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
S3EventSourceProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.103.1 (build bef2dea)", date="2024-10-25T14:21:17.770Z") @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());
 
  • 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