Package software.amazon.awscdk.services.lambda

Class CfnEventSourceMapping

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.lambda.CfnEventSourceMapping
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:40.581Z") @Stability(Stable) public class CfnEventSourceMapping extends CfnResource implements IInspectable
A CloudFormation AWS::Lambda::EventSourceMapping.

The AWS::Lambda::EventSourceMapping resource creates a mapping between an event source and an AWS Lambda function. Lambda reads items from the event source and triggers the function.

For details about each event source type, see the following topics. In particular, each of the topics describes the required and optional parameters for the specific event source.

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.lambda.*;
 CfnEventSourceMapping cfnEventSourceMapping = CfnEventSourceMapping.Builder.create(this, "MyCfnEventSourceMapping")
         .functionName("functionName")
         // the properties below are optional
         .amazonManagedKafkaEventSourceConfig(AmazonManagedKafkaEventSourceConfigProperty.builder()
                 .consumerGroupId("consumerGroupId")
                 .build())
         .batchSize(123)
         .bisectBatchOnFunctionError(false)
         .destinationConfig(DestinationConfigProperty.builder()
                 .onFailure(OnFailureProperty.builder()
                         .destination("destination")
                         .build())
                 .build())
         .documentDbEventSourceConfig(DocumentDBEventSourceConfigProperty.builder()
                 .collectionName("collectionName")
                 .databaseName("databaseName")
                 .fullDocument("fullDocument")
                 .build())
         .enabled(false)
         .eventSourceArn("eventSourceArn")
         .filterCriteria(FilterCriteriaProperty.builder()
                 .filters(List.of(FilterProperty.builder()
                         .pattern("pattern")
                         .build()))
                 .build())
         .functionResponseTypes(List.of("functionResponseTypes"))
         .maximumBatchingWindowInSeconds(123)
         .maximumRecordAgeInSeconds(123)
         .maximumRetryAttempts(123)
         .parallelizationFactor(123)
         .queues(List.of("queues"))
         .scalingConfig(ScalingConfigProperty.builder()
                 .maximumConcurrency(123)
                 .build())
         .selfManagedEventSource(SelfManagedEventSourceProperty.builder()
                 .endpoints(EndpointsProperty.builder()
                         .kafkaBootstrapServers(List.of("kafkaBootstrapServers"))
                         .build())
                 .build())
         .selfManagedKafkaEventSourceConfig(SelfManagedKafkaEventSourceConfigProperty.builder()
                 .consumerGroupId("consumerGroupId")
                 .build())
         .sourceAccessConfigurations(List.of(SourceAccessConfigurationProperty.builder()
                 .type("type")
                 .uri("uri")
                 .build()))
         .startingPosition("startingPosition")
         .startingPositionTimestamp(123)
         .topics(List.of("topics"))
         .tumblingWindowInSeconds(123)
         .build();

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnEventSourceMapping

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

    • CfnEventSourceMapping

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

    • CfnEventSourceMapping

      @Stability(Stable) public CfnEventSourceMapping(@NotNull Construct scope, @NotNull String id, @NotNull CfnEventSourceMappingProps props)
      Create a new AWS::Lambda::EventSourceMapping.

      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      This parameter is required.
      props -
      • resource properties.
      This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector -
      • tree inspector to collect and process attributes.
      This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrId

      @Stability(Stable) @NotNull public String getAttrId()
      The event source mapping's ID.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getFunctionName

      @Stability(Stable) @NotNull public String getFunctionName()
      The name of the Lambda function.

      Name formats - Function name – MyFunction .

      • Function ARN – arn:aws:lambda:us-west-2:123456789012:function:MyFunction .
      • Version or Alias ARN – arn:aws:lambda:us-west-2:123456789012:function:MyFunction:PROD .
      • Partial ARN – 123456789012:function:MyFunction .

      The length constraint applies only to the full ARN. If you specify only the function name, it's limited to 64 characters in length.

    • setFunctionName

      @Stability(Stable) public void setFunctionName(@NotNull String value)
      The name of the Lambda function.

      Name formats - Function name – MyFunction .

      • Function ARN – arn:aws:lambda:us-west-2:123456789012:function:MyFunction .
      • Version or Alias ARN – arn:aws:lambda:us-west-2:123456789012:function:MyFunction:PROD .
      • Partial ARN – 123456789012:function:MyFunction .

      The length constraint applies only to the full ARN. If you specify only the function name, it's limited to 64 characters in length.

    • getAmazonManagedKafkaEventSourceConfig

      @Stability(Stable) @Nullable public Object getAmazonManagedKafkaEventSourceConfig()
      Specific configuration settings for an Amazon Managed Streaming for Apache Kafka (Amazon MSK) event source.

    • setAmazonManagedKafkaEventSourceConfig

      @Stability(Stable) public void setAmazonManagedKafkaEventSourceConfig(@Nullable IResolvable value)
      Specific configuration settings for an Amazon Managed Streaming for Apache Kafka (Amazon MSK) event source.

    • setAmazonManagedKafkaEventSourceConfig

      @Stability(Stable) public void setAmazonManagedKafkaEventSourceConfig(@Nullable CfnEventSourceMapping.AmazonManagedKafkaEventSourceConfigProperty value)
      Specific configuration settings for an Amazon Managed Streaming for Apache Kafka (Amazon MSK) event source.

    • getBatchSize

      @Stability(Stable) @Nullable public Number getBatchSize()
      The maximum number of records in each batch that Lambda pulls from your stream or queue and sends to your function.

      Lambda passes all of the records in the batch to the function in a single call, up to the payload limit for synchronous invocation (6 MB).

      • Amazon Kinesis – Default 100. Max 10,000.
      • Amazon DynamoDB Streams – Default 100. Max 10,000.
      • Amazon Simple Queue Service – Default 10. For standard queues the max is 10,000. For FIFO queues the max is 10.
      • Amazon Managed Streaming for Apache Kafka – Default 100. Max 10,000.
      • Self-managed Apache Kafka – Default 100. Max 10,000.
      • Amazon MQ (ActiveMQ and RabbitMQ) – Default 100. Max 10,000.
      • DocumentDB – Default 100. Max 10,000.

    • setBatchSize

      @Stability(Stable) public void setBatchSize(@Nullable Number value)
      The maximum number of records in each batch that Lambda pulls from your stream or queue and sends to your function.

      Lambda passes all of the records in the batch to the function in a single call, up to the payload limit for synchronous invocation (6 MB).

      • Amazon Kinesis – Default 100. Max 10,000.
      • Amazon DynamoDB Streams – Default 100. Max 10,000.
      • Amazon Simple Queue Service – Default 10. For standard queues the max is 10,000. For FIFO queues the max is 10.
      • Amazon Managed Streaming for Apache Kafka – Default 100. Max 10,000.
      • Self-managed Apache Kafka – Default 100. Max 10,000.
      • Amazon MQ (ActiveMQ and RabbitMQ) – Default 100. Max 10,000.
      • DocumentDB – Default 100. Max 10,000.

    • getBisectBatchOnFunctionError

      @Stability(Stable) @Nullable public Object getBisectBatchOnFunctionError()
      (Kinesis and DynamoDB Streams only) If the function returns an error, split the batch in two and retry.

      The default value is false.

    • setBisectBatchOnFunctionError

      @Stability(Stable) public void setBisectBatchOnFunctionError(@Nullable Boolean value)
      (Kinesis and DynamoDB Streams only) If the function returns an error, split the batch in two and retry.

      The default value is false.

    • setBisectBatchOnFunctionError

      @Stability(Stable) public void setBisectBatchOnFunctionError(@Nullable IResolvable value)
      (Kinesis and DynamoDB Streams only) If the function returns an error, split the batch in two and retry.

      The default value is false.

    • getDestinationConfig

      @Stability(Stable) @Nullable public Object getDestinationConfig()
      (Kinesis and DynamoDB Streams only) An Amazon SQS queue or Amazon SNS topic destination for discarded records.

    • setDestinationConfig

      @Stability(Stable) public void setDestinationConfig(@Nullable IResolvable value)
      (Kinesis and DynamoDB Streams only) An Amazon SQS queue or Amazon SNS topic destination for discarded records.

    • setDestinationConfig

      @Stability(Stable) public void setDestinationConfig(@Nullable CfnEventSourceMapping.DestinationConfigProperty value)
      (Kinesis and DynamoDB Streams only) An Amazon SQS queue or Amazon SNS topic destination for discarded records.

    • getDocumentDbEventSourceConfig

      @Stability(Stable) @Nullable public Object getDocumentDbEventSourceConfig()
      Specific configuration settings for a DocumentDB event source.

    • setDocumentDbEventSourceConfig

      @Stability(Stable) public void setDocumentDbEventSourceConfig(@Nullable IResolvable value)
      Specific configuration settings for a DocumentDB event source.

    • setDocumentDbEventSourceConfig

      @Stability(Stable) public void setDocumentDbEventSourceConfig(@Nullable CfnEventSourceMapping.DocumentDBEventSourceConfigProperty value)
      Specific configuration settings for a DocumentDB event source.

    • getEnabled

      @Stability(Stable) @Nullable public Object getEnabled()
      When true, the event source mapping is active. When false, Lambda pauses polling and invocation.

      Default: True

    • setEnabled

      @Stability(Stable) public void setEnabled(@Nullable Boolean value)
      When true, the event source mapping is active. When false, Lambda pauses polling and invocation.

      Default: True

    • setEnabled

      @Stability(Stable) public void setEnabled(@Nullable IResolvable value)
      When true, the event source mapping is active. When false, Lambda pauses polling and invocation.

      Default: True

    • getEventSourceArn

      @Stability(Stable) @Nullable public String getEventSourceArn()
      The Amazon Resource Name (ARN) of the event source.

      • Amazon Kinesis – The ARN of the data stream or a stream consumer.
      • Amazon DynamoDB Streams – The ARN of the stream.
      • Amazon Simple Queue Service – The ARN of the queue.
      • Amazon Managed Streaming for Apache Kafka – The ARN of the cluster.
      • Amazon MQ – The ARN of the broker.
      • Amazon DocumentDB – The ARN of the DocumentDB change stream.

    • setEventSourceArn

      @Stability(Stable) public void setEventSourceArn(@Nullable String value)
      The Amazon Resource Name (ARN) of the event source.

      • Amazon Kinesis – The ARN of the data stream or a stream consumer.
      • Amazon DynamoDB Streams – The ARN of the stream.
      • Amazon Simple Queue Service – The ARN of the queue.
      • Amazon Managed Streaming for Apache Kafka – The ARN of the cluster.
      • Amazon MQ – The ARN of the broker.
      • Amazon DocumentDB – The ARN of the DocumentDB change stream.

    • getFilterCriteria

      @Stability(Stable) @Nullable public Object getFilterCriteria()
      An object that defines the filter criteria that determine whether Lambda should process an event.

      For more information, see Lambda event filtering .

    • setFilterCriteria

      @Stability(Stable) public void setFilterCriteria(@Nullable IResolvable value)
      An object that defines the filter criteria that determine whether Lambda should process an event.

      For more information, see Lambda event filtering .

    • setFilterCriteria

      @Stability(Stable) public void setFilterCriteria(@Nullable CfnEventSourceMapping.FilterCriteriaProperty value)
      An object that defines the filter criteria that determine whether Lambda should process an event.

      For more information, see Lambda event filtering .

    • getFunctionResponseTypes

      @Stability(Stable) @Nullable public List<String> getFunctionResponseTypes()
      (Streams and SQS) A list of current response type enums applied to the event source mapping.

      Valid Values: ReportBatchItemFailures

    • setFunctionResponseTypes

      @Stability(Stable) public void setFunctionResponseTypes(@Nullable List<String> value)
      (Streams and SQS) A list of current response type enums applied to the event source mapping.

      Valid Values: ReportBatchItemFailures

    • getMaximumBatchingWindowInSeconds

      @Stability(Stable) @Nullable public Number getMaximumBatchingWindowInSeconds()
      The maximum amount of time, in seconds, that Lambda spends gathering records before invoking the function.

      Default ( Kinesis , DynamoDB , Amazon SQS event sources) : 0

      Default ( Amazon MSK , Kafka, Amazon MQ , Amazon DocumentDB event sources) : 500 ms

      Related setting: For Amazon SQS event sources, when you set BatchSize to a value greater than 10, you must set MaximumBatchingWindowInSeconds to at least 1.

    • setMaximumBatchingWindowInSeconds

      @Stability(Stable) public void setMaximumBatchingWindowInSeconds(@Nullable Number value)
      The maximum amount of time, in seconds, that Lambda spends gathering records before invoking the function.

      Default ( Kinesis , DynamoDB , Amazon SQS event sources) : 0

      Default ( Amazon MSK , Kafka, Amazon MQ , Amazon DocumentDB event sources) : 500 ms

      Related setting: For Amazon SQS event sources, when you set BatchSize to a value greater than 10, you must set MaximumBatchingWindowInSeconds to at least 1.

    • getMaximumRecordAgeInSeconds

      @Stability(Stable) @Nullable public Number getMaximumRecordAgeInSeconds()
      (Kinesis and DynamoDB Streams only) Discard records older than the specified age.

      The default value is -1, which sets the maximum age to infinite. When the value is set to infinite, Lambda never discards old records.

      The minimum valid value for maximum record age is 60s. Although values less than 60 and greater than -1 fall within the parameter's absolute range, they are not allowed

    • setMaximumRecordAgeInSeconds

      @Stability(Stable) public void setMaximumRecordAgeInSeconds(@Nullable Number value)
      (Kinesis and DynamoDB Streams only) Discard records older than the specified age.

      The default value is -1, which sets the maximum age to infinite. When the value is set to infinite, Lambda never discards old records.

      The minimum valid value for maximum record age is 60s. Although values less than 60 and greater than -1 fall within the parameter's absolute range, they are not allowed

    • getMaximumRetryAttempts

      @Stability(Stable) @Nullable public Number getMaximumRetryAttempts()
      (Kinesis and DynamoDB Streams only) Discard records after the specified number of retries.

      The default value is -1, which sets the maximum number of retries to infinite. When MaximumRetryAttempts is infinite, Lambda retries failed records until the record expires in the event source.

    • setMaximumRetryAttempts

      @Stability(Stable) public void setMaximumRetryAttempts(@Nullable Number value)
      (Kinesis and DynamoDB Streams only) Discard records after the specified number of retries.

      The default value is -1, which sets the maximum number of retries to infinite. When MaximumRetryAttempts is infinite, Lambda retries failed records until the record expires in the event source.

    • getParallelizationFactor

      @Stability(Stable) @Nullable public Number getParallelizationFactor()
      (Kinesis and DynamoDB Streams only) The number of batches to process concurrently from each shard.

      The default value is 1.

    • setParallelizationFactor

      @Stability(Stable) public void setParallelizationFactor(@Nullable Number value)
      (Kinesis and DynamoDB Streams only) The number of batches to process concurrently from each shard.

      The default value is 1.

    • getQueues

      @Stability(Stable) @Nullable public List<String> getQueues()
      (Amazon MQ) The name of the Amazon MQ broker destination queue to consume.

    • setQueues

      @Stability(Stable) public void setQueues(@Nullable List<String> value)
      (Amazon MQ) The name of the Amazon MQ broker destination queue to consume.

    • getScalingConfig

      @Stability(Stable) @Nullable public Object getScalingConfig()
      (Amazon SQS only) The scaling configuration for the event source.

      For more information, see Configuring maximum concurrency for Amazon SQS event sources .

    • setScalingConfig

      @Stability(Stable) public void setScalingConfig(@Nullable IResolvable value)
      (Amazon SQS only) The scaling configuration for the event source.

      For more information, see Configuring maximum concurrency for Amazon SQS event sources .

    • setScalingConfig

      @Stability(Stable) public void setScalingConfig(@Nullable CfnEventSourceMapping.ScalingConfigProperty value)
      (Amazon SQS only) The scaling configuration for the event source.

      For more information, see Configuring maximum concurrency for Amazon SQS event sources .

    • getSelfManagedEventSource

      @Stability(Stable) @Nullable public Object getSelfManagedEventSource()
      The self-managed Apache Kafka cluster for your event source.

    • setSelfManagedEventSource

      @Stability(Stable) public void setSelfManagedEventSource(@Nullable IResolvable value)
      The self-managed Apache Kafka cluster for your event source.

    • setSelfManagedEventSource

      @Stability(Stable) public void setSelfManagedEventSource(@Nullable CfnEventSourceMapping.SelfManagedEventSourceProperty value)
      The self-managed Apache Kafka cluster for your event source.

    • getSelfManagedKafkaEventSourceConfig

      @Stability(Stable) @Nullable public Object getSelfManagedKafkaEventSourceConfig()
      Specific configuration settings for a self-managed Apache Kafka event source.

    • setSelfManagedKafkaEventSourceConfig

      @Stability(Stable) public void setSelfManagedKafkaEventSourceConfig(@Nullable IResolvable value)
      Specific configuration settings for a self-managed Apache Kafka event source.

    • setSelfManagedKafkaEventSourceConfig

      @Stability(Stable) public void setSelfManagedKafkaEventSourceConfig(@Nullable CfnEventSourceMapping.SelfManagedKafkaEventSourceConfigProperty value)
      Specific configuration settings for a self-managed Apache Kafka event source.

    • getSourceAccessConfigurations

      @Stability(Stable) @Nullable public Object getSourceAccessConfigurations()
      An array of the authentication protocol, VPC components, or virtual host to secure and define your event source.

    • setSourceAccessConfigurations

      @Stability(Stable) public void setSourceAccessConfigurations(@Nullable IResolvable value)
      An array of the authentication protocol, VPC components, or virtual host to secure and define your event source.

    • setSourceAccessConfigurations

      @Stability(Stable) public void setSourceAccessConfigurations(@Nullable List<Object> value)
      An array of the authentication protocol, VPC components, or virtual host to secure and define your event source.

    • getStartingPosition

      @Stability(Stable) @Nullable public String getStartingPosition()
      The position in a stream from which to start reading. Required for Amazon Kinesis and Amazon DynamoDB.

      • LATEST - Read only new records.
      • TRIM_HORIZON - Process all available records.
      • AT_TIMESTAMP - Specify a time from which to start reading records.

    • setStartingPosition

      @Stability(Stable) public void setStartingPosition(@Nullable String value)
      The position in a stream from which to start reading. Required for Amazon Kinesis and Amazon DynamoDB.

      • LATEST - Read only new records.
      • TRIM_HORIZON - Process all available records.
      • AT_TIMESTAMP - Specify a time from which to start reading records.

    • getStartingPositionTimestamp

      @Stability(Stable) @Nullable public Number getStartingPositionTimestamp()
      With StartingPosition set to AT_TIMESTAMP , the time from which to start reading, in Unix time seconds.

    • setStartingPositionTimestamp

      @Stability(Stable) public void setStartingPositionTimestamp(@Nullable Number value)
      With StartingPosition set to AT_TIMESTAMP , the time from which to start reading, in Unix time seconds.

    • getTopics

      @Stability(Stable) @Nullable public List<String> getTopics()
      The name of the Kafka topic.

    • setTopics

      @Stability(Stable) public void setTopics(@Nullable List<String> value)
      The name of the Kafka topic.

    • getTumblingWindowInSeconds

      @Stability(Stable) @Nullable public Number getTumblingWindowInSeconds()
      (Kinesis and DynamoDB Streams only) The duration in seconds of a processing window for DynamoDB and Kinesis Streams event sources.

      A value of 0 seconds indicates no tumbling window.

    • setTumblingWindowInSeconds

      @Stability(Stable) public void setTumblingWindowInSeconds(@Nullable Number value)
      (Kinesis and DynamoDB Streams only) The duration in seconds of a processing window for DynamoDB and Kinesis Streams event sources.

      A value of 0 seconds indicates no tumbling window.