Package software.amazon.awscdk.services.lambda

Class EventSourceMapping

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.Resource
software.amazon.awscdk.services.lambda.EventSourceMapping
All Implemented Interfaces:
IResource, IEventSourceMapping, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.97.0 (build 729de35)", date="2024-04-18T17:54:19.214Z") @Stability(Stable) public class EventSourceMapping extends Resource implements IEventSourceMapping
Defines a Lambda EventSourceMapping resource.

Usually, you won't need to define the mapping yourself. This will usually be done by event sources. For example, to add an SQS event source to a function: 

 import software.amazon.awscdk.services.sqs.*;
 import software.amazon.awscdk.services.lambda.eventsources.*;
 Function handler;
 Queue queue;
 handler.addEventSource(new SqsEventSource(queue));

The SqsEventSource class will automatically create the mapping, and will also modify the Lambda's execution role so it can consume messages from the queue.

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.*;
 import software.amazon.awscdk.services.lambda.*;
 IEventSourceDlq eventSourceDlq;
 Object filters;
 Function function_;
 SourceAccessConfigurationType sourceAccessConfigurationType;
 EventSourceMapping eventSourceMapping = EventSourceMapping.Builder.create(this, "MyEventSourceMapping")
         .target(function_)
         // the properties below are optional
         .batchSize(123)
         .bisectBatchOnError(false)
         .enabled(false)
         .eventSourceArn("eventSourceArn")
         .filters(List.of(Map.of(
                 "filtersKey", filters)))
         .kafkaBootstrapServers(List.of("kafkaBootstrapServers"))
         .kafkaConsumerGroupId("kafkaConsumerGroupId")
         .kafkaTopic("kafkaTopic")
         .maxBatchingWindow(Duration.minutes(30))
         .maxConcurrency(123)
         .maxRecordAge(Duration.minutes(30))
         .onFailure(eventSourceDlq)
         .parallelizationFactor(123)
         .reportBatchItemFailures(false)
         .retryAttempts(123)
         .sourceAccessConfigurations(List.of(SourceAccessConfiguration.builder()
                 .type(sourceAccessConfigurationType)
                 .uri("uri")
                 .build()))
         .startingPosition(StartingPosition.TRIM_HORIZON)
         .startingPositionTimestamp(123)
         .supportS3OnFailureDestination(false)
         .tumblingWindow(Duration.minutes(30))
         .build();

  • Constructor Details

    • EventSourceMapping

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

    • EventSourceMapping

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

    • EventSourceMapping

      @Stability(Stable) public EventSourceMapping(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull EventSourceMappingProps props)
      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      props - This parameter is required.

  • Method Details

    • fromEventSourceMappingId

      @Stability(Stable) @NotNull public static IEventSourceMapping fromEventSourceMappingId(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String eventSourceMappingId)
      Import an event source into this stack from its event source id.

      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      eventSourceMappingId - This parameter is required.

    • getEventSourceMappingArn

      @Stability(Stable) @NotNull public String getEventSourceMappingArn()
      The ARN of the event source mapping (i.e. arn:aws:lambda:region:account-id:event-source-mapping/event-source-mapping-id).
      Specified by:
      getEventSourceMappingArn in interface IEventSourceMapping

    • getEventSourceMappingId

      @Stability(Stable) @NotNull public String getEventSourceMappingId()
      The identifier for this EventSourceMapping.
      Specified by:
      getEventSourceMappingId in interface IEventSourceMapping