software.amazon.awscdk.services.lambda.eventsources

Class S3EventSource

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.lambda.eventsources.S3EventSource

All Implemented Interfaces:

IEventSource, software.amazon.jsii.JsiiSerializable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:40.513Z")
 @Stability(value=Stable)
public class S3EventSource
extends software.amazon.jsii.JsiiObject
implements IEventSource

Use S3 bucket notifications as an event source for AWS Lambda.

Example:

 import software.amazon.awscdk.services.lambda.eventsources.*;
 import software.amazon.awscdk.services.s3.*;
 Function fn;
 Bucket bucket = new Bucket(this, "Bucket");
 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	Class and Description
static class	S3EventSource.Builder A fluent builder for S3EventSource.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.lambda.IEventSource

IEventSource.Jsii$Default, IEventSource.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor and Description
	S3EventSource(Bucket bucket, S3EventSourceProps props)
protected	S3EventSource(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	S3EventSource(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
void	bind(IFunction target) Called by `lambda.addEventSource` to allow the event source to bind to this function.
Bucket	getBucket()

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Detail

S3EventSource

protected S3EventSource(software.amazon.jsii.JsiiObjectRef objRef)

S3EventSource

protected S3EventSource(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

S3EventSource

@Stability(value=Stable)
public S3EventSource(@NotNull
                                              Bucket bucket,
                                              @NotNull
                                              S3EventSourceProps props)

Parameters:

bucket - This parameter is required.

props - This parameter is required.

Method Detail

bind

@Stability(value=Stable)
public void bind(@NotNull
                                          IFunction target)

Called by `lambda.addEventSource` to allow the event source to bind to this function.

Specified by:

bind in interface IEventSource

Parameters:

target - This parameter is required.

getBucket

@Stability(value=Stable)
 @NotNull
public Bucket getBucket()