interface CfnEventSourceMappingProps

Language	Type name
.NET	`Amazon.CDK.AWS.Lambda.CfnEventSourceMappingProps`
Java	`software.amazon.awscdk.services.lambda.CfnEventSourceMappingProps`
Python	`aws_cdk.aws_lambda.CfnEventSourceMappingProps`
TypeScript	`@aws-cdk/aws-lambda` » `CfnEventSourceMappingProps`

Properties for defining a CfnEventSourceMapping.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as lambda from '@aws-cdk/aws-lambda';
const cfnEventSourceMappingProps: lambda.CfnEventSourceMappingProps = {
  functionName: 'functionName',

  // the properties below are optional
  amazonManagedKafkaEventSourceConfig: {
    consumerGroupId: 'consumerGroupId',
  },
  batchSize: 123,
  bisectBatchOnFunctionError: false,
  destinationConfig: {
    onFailure: {
      destination: 'destination',
    },
  },
  documentDbEventSourceConfig: {
    collectionName: 'collectionName',
    databaseName: 'databaseName',
    fullDocument: 'fullDocument',
  },
  enabled: false,
  eventSourceArn: 'eventSourceArn',
  filterCriteria: {
    filters: [{
      pattern: 'pattern',
    }],
  },
  functionResponseTypes: ['functionResponseTypes'],
  maximumBatchingWindowInSeconds: 123,
  maximumRecordAgeInSeconds: 123,
  maximumRetryAttempts: 123,
  parallelizationFactor: 123,
  queues: ['queues'],
  scalingConfig: {
    maximumConcurrency: 123,
  },
  selfManagedEventSource: {
    endpoints: {
      kafkaBootstrapServers: ['kafkaBootstrapServers'],
    },
  },
  selfManagedKafkaEventSourceConfig: {
    consumerGroupId: 'consumerGroupId',
  },
  sourceAccessConfigurations: [{
    type: 'type',
    uri: 'uri',
  }],
  startingPosition: 'startingPosition',
  startingPositionTimestamp: 123,
  topics: ['topics'],
  tumblingWindowInSeconds: 123,
};

Properties

Name	Type	Description
functionName	`string`	The name of the Lambda function.
amazonManagedKafkaEventSourceConfig?	`IResolvable` `\|` `AmazonManagedKafkaEventSourceConfigProperty`	Specific configuration settings for an Amazon Managed Streaming for Apache Kafka (Amazon MSK) event source.
batchSize?	`number`	The maximum number of records in each batch that Lambda pulls from your stream or queue and sends to your function.
bisectBatchOnFunctionError?	`boolean \|` `IResolvable`	(Kinesis and DynamoDB Streams only) If the function returns an error, split the batch in two and retry.
destinationConfig?	`IResolvable` `\|` `DestinationConfigProperty`	(Kinesis and DynamoDB Streams only) An Amazon SQS queue or Amazon SNS topic destination for discarded records.
documentDbEventSourceConfig?	`IResolvable` `\|` `DocumentDBEventSourceConfigProperty`	Specific configuration settings for a DocumentDB event source.
enabled?	`boolean \|` `IResolvable`	When true, the event source mapping is active. When false, Lambda pauses polling and invocation.
eventSourceArn?	`string`	The Amazon Resource Name (ARN) of the event source.
filterCriteria?	`IResolvable` `\|` `FilterCriteriaProperty`	An object that defines the filter criteria that determine whether Lambda should process an event.
functionResponseTypes?	`string[]`	(Streams and SQS) A list of current response type enums applied to the event source mapping.
maximumBatchingWindowInSeconds?	`number`	The maximum amount of time, in seconds, that Lambda spends gathering records before invoking the function.
maximumRecordAgeInSeconds?	`number`	(Kinesis and DynamoDB Streams only) Discard records older than the specified age.
maximumRetryAttempts?	`number`	(Kinesis and DynamoDB Streams only) Discard records after the specified number of retries.
parallelizationFactor?	`number`	(Kinesis and DynamoDB Streams only) The number of batches to process concurrently from each shard.
queues?	`string[]`	(Amazon MQ) The name of the Amazon MQ broker destination queue to consume.
scalingConfig?	`IResolvable` `\|` `ScalingConfigProperty`	(Amazon SQS only) The scaling configuration for the event source.
selfManagedEventSource?	`IResolvable` `\|` `SelfManagedEventSourceProperty`	The self-managed Apache Kafka cluster for your event source.
selfManagedKafkaEventSourceConfig?	`IResolvable` `\|` `SelfManagedKafkaEventSourceConfigProperty`	Specific configuration settings for a self-managed Apache Kafka event source.
sourceAccessConfigurations?	`IResolvable` `\|` `IResolvable` `\|` `SourceAccessConfigurationProperty[]`	An array of the authentication protocol, VPC components, or virtual host to secure and define your event source.
startingPosition?	`string`	The position in a stream from which to start reading. Required for Amazon Kinesis and Amazon DynamoDB.
startingPositionTimestamp?	`number`	With `StartingPosition` set to `AT_TIMESTAMP` , the time from which to start reading, in Unix time seconds.
topics?	`string[]`	The name of the Kafka topic.
tumblingWindowInSeconds?	`number`	(Kinesis and DynamoDB Streams only) The duration in seconds of a processing window for DynamoDB and Kinesis Streams event sources.

functionName

Type: string

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.

amazonManagedKafkaEventSourceConfig?

Type: IResolvable | AmazonManagedKafkaEventSourceConfigProperty (optional)

Specific configuration settings for an Amazon Managed Streaming for Apache Kafka (Amazon MSK) event source.

batchSize?

Type: number (optional)

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.

bisectBatchOnFunctionError?

Type: boolean | IResolvable (optional)

(Kinesis and DynamoDB Streams only) If the function returns an error, split the batch in two and retry.

The default value is false.

destinationConfig?

Type: IResolvable | DestinationConfigProperty (optional)

(Kinesis and DynamoDB Streams only) An Amazon SQS queue or Amazon SNS topic destination for discarded records.

documentDbEventSourceConfig?

Type: IResolvable | DocumentDBEventSourceConfigProperty (optional)

Specific configuration settings for a DocumentDB event source.

enabled?

Type: boolean | IResolvable (optional)

When true, the event source mapping is active. When false, Lambda pauses polling and invocation.

Default: True

eventSourceArn?

Type: string (optional)

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.

filterCriteria?

Type: IResolvable | FilterCriteriaProperty (optional)

An object that defines the filter criteria that determine whether Lambda should process an event.

For more information, see Lambda event filtering .

functionResponseTypes?

Type: string[] (optional)

(Streams and SQS) A list of current response type enums applied to the event source mapping.

Valid Values: ReportBatchItemFailures

maximumBatchingWindowInSeconds?

Type: number (optional)

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.

maximumRecordAgeInSeconds?

Type: number (optional)

(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

maximumRetryAttempts?

Type: number (optional)

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

parallelizationFactor?

Type: number (optional)

(Kinesis and DynamoDB Streams only) The number of batches to process concurrently from each shard.

The default value is 1.

queues?

Type: string[] (optional)

(Amazon MQ) The name of the Amazon MQ broker destination queue to consume.

scalingConfig?

Type: IResolvable | ScalingConfigProperty (optional)

(Amazon SQS only) The scaling configuration for the event source.

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

selfManagedEventSource?

Type: IResolvable | SelfManagedEventSourceProperty (optional)

The self-managed Apache Kafka cluster for your event source.

selfManagedKafkaEventSourceConfig?

Type: IResolvable | SelfManagedKafkaEventSourceConfigProperty (optional)

Specific configuration settings for a self-managed Apache Kafka event source.

sourceAccessConfigurations?

Type: IResolvable | IResolvable | SourceAccessConfigurationProperty[] (optional)

An array of the authentication protocol, VPC components, or virtual host to secure and define your event source.

startingPosition?

Type: string (optional)

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.

startingPositionTimestamp?

Type: number (optional)

With StartingPosition set to AT_TIMESTAMP , the time from which to start reading, in Unix time seconds.

topics?

Type: string[] (optional)

The name of the Kafka topic.

tumblingWindowInSeconds?

Type: number (optional)

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