# SqsEventSource

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

Implements: [IEventSource](/cdk/api/v2/docs/aws-cdk-lib.aws_lambda.IEventSource.html)

- Source: [`aws-lambda-event-sources/lib/sqs.ts`](https://github.com/aws/aws-cdk/blob/v2.277.0/packages/aws-cdk-lib/aws-lambda-event-sources/lib/sqs.ts#L97)
- Type last changed: v2.77.0 · 26 Apr 2023

## Example

TypeScript:

```ts
import * as eventsources from 'aws-cdk-lib/aws-lambda-event-sources';
import * as sqs from 'aws-cdk-lib/aws-sqs';

declare const fn: lambda.Function;
const queue = new sqs.Queue(this, 'Queue');
fn.addEventSource(new eventsources.SqsEventSource(queue));
```

Python:

```python
import aws_cdk.aws_lambda_event_sources as eventsources
import aws_cdk.aws_sqs as sqs

# fn: lambda.Function

queue = sqs.Queue(self, "Queue")
fn.add_event_source(eventsources.SqsEventSource(queue))
```

Java:

```java
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));
```

C# / .NET:

```csharp
// Install: dotnet add package Amazon.CDK.Lib
using Amazon.CDK.AWS.Lambda.EventSources;
using Amazon.CDK.AWS.SQS;

Function fn;

var queue = new Queue(this, "Queue");
fn.AddEventSource(new SqsEventSource(queue));
```

Golang:

```go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
import eventsources "github.com/aws/aws-cdk-go/awscdk"
import sqs "github.com/aws/aws-cdk-go/awscdk"

var fn Function

queue := sqs.NewQueue(this, jsii.String("Queue"))
fn.AddEventSource(eventsources.NewSqsEventSource(queue))
```

## Initializer

TypeScript:

```ts
new SqsEventSource(queue: IQueue, props?: SqsEventSourceProps)
```

Python:

```python
SqsEventSource(queue: IQueue, props: typing.Optional[SqsEventSourceProps] = None)
```

Java:

```java
new SqsEventSource(IQueue queue, SqsEventSourceProps props)
```

C# / .NET:

```csharp
new SqsEventSource(IQueue queue, SqsEventSourceProps? props = null)
```

Golang:

```go
NewSqsEventSource(Queue IQueue, Props SqsEventSourceProps)
```

## Properties

- `eventSourceMappingArn`: string — The ARN for this EventSourceMapping.

- `eventSourceMappingId`: string — The identifier for this EventSourceMapping.

- `queue`: [IQueue](/cdk/api/v2/docs/aws-cdk-lib.aws_sqs.IQueue.html)

## Methods

- `bind(target: IFunction): void` — Called by `lambda.addEventSource` to allow the event source to bind to this function.
