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

@Generated(value="jsii-pacmak/1.73.0 (build 6faeda3)",
           date="2023-01-31T18:36:59.896Z")
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.SqsEventSource;
 Function fn;
 Queue queue = new Queue(this, "MyQueue");
 SqsEventSource eventSource = new SqsEventSource(queue);
 fn.addEventSource(eventSource);
 String eventSourceId = eventSource.getEventSourceMappingId();
 

Nested Class Summary

Nested Classes

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

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
	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 and Description
void	bind(IFunction target) Called by `lambda.addEventSource` to allow the event source to bind to this function.
java.lang.String	getEventSourceMappingId() The identifier for this EventSourceMapping.
IQueue	getQueue()

Methods inherited from class java.lang.Object

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

Constructor Detail

SqsEventSource

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

SqsEventSource

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

SqsEventSource

public SqsEventSource(IQueue queue,
                      SqsEventSourceProps props)

Parameters:

queue - This parameter is required.

props -

Method Detail

bind

public void bind(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.

getEventSourceMappingId

public java.lang.String getEventSourceMappingId()

The identifier for this EventSourceMapping.

getQueue

public IQueue getQueue()