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

Class SqsEventSource

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.lambda.eventsources.SqsEventSource

All Implemented Interfaces:

IEventSource, software.amazon.jsii.JsiiSerializable

@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)",
           date="2025-11-17T14:40:55.046Z")
@Stability(Stable)
public class SqsEventSource
extends software.amazon.jsii.JsiiObject
implements IEventSource

Use an Amazon SQS queue as an event source for AWS Lambda.

Example:

 import software.amazon.awscdk.services.lambda.eventsources.*;
 import software.amazon.awscdk.services.sqs.*;
 Function fn;
 Queue queue = new Queue(this, "Queue");
 fn.addEventSource(new SqsEventSource(queue));
 

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	SqsEventSource.Builder	A fluent builder for SqsEventSource.

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	Description
	SqsEventSource(IQueue queue)
	SqsEventSource(IQueue queue, SqsEventSourceProps props)
protected	SqsEventSource(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	SqsEventSource(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method	Description
void	bind(IFunction target)	Called by lambda.addEventSource to allow the event source to bind to this function.
String	getEventSourceMappingArn()	The ARN for this EventSourceMapping.
String	getEventSourceMappingId()	The identifier for this EventSourceMapping.
IQueue	getQueue()

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 Details

SqsEventSource

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

SqsEventSource

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

SqsEventSource

@Stability(Stable)
public SqsEventSource(@NotNull
 IQueue queue,
 @Nullable
 SqsEventSourceProps props)

Parameters:

queue - This parameter is required.

props -

SqsEventSource

@Stability(Stable)
public SqsEventSource(@NotNull
 IQueue queue)

Parameters:

queue - This parameter is required.

Method Details

bind

@Stability(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.

getEventSourceMappingArn

@Stability(Stable)
@NotNull
public String getEventSourceMappingArn()

The ARN for this EventSourceMapping.

getEventSourceMappingId

@Stability(Stable)
@NotNull
public String getEventSourceMappingId()

The identifier for this EventSourceMapping.

getQueue

@Stability(Stable)
@NotNull
public IQueue getQueue()