CfnEventSourceMappingProps Struct
Properties for defining a CfnEventSourceMapping.
Example
ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_lambda as lambda } from 'aws-cdk-lib';
const cfnEventSourceMappingProps: lambda.CfnEventSourceMappingProps = {
functionName: 'functionName',
// the properties below are optional
amazonManagedKafkaEventSourceConfig: {
consumerGroupId: 'consumerGroupId',
schemaRegistryConfig: {
accessConfigs: [{
type: 'type',
uri: 'uri',
}],
eventRecordFormat: 'eventRecordFormat',
schemaRegistryUri: 'schemaRegistryUri',
schemaValidationConfigs: [{
attribute: 'attribute',
}],
},
},
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'],
kmsKeyArn: 'kmsKeyArn',
loggingConfig: {
systemLogLevel: 'systemLogLevel',
},
maximumBatchingWindowInSeconds: 123,
maximumRecordAgeInSeconds: 123,
maximumRetryAttempts: 123,
metricsConfig: {
metrics: ['metrics'],
},
parallelizationFactor: 123,
provisionedPollerConfig: {
maximumPollers: 123,
minimumPollers: 123,
pollerGroupName: 'pollerGroupName',
},
queues: ['queues'],
scalingConfig: {
maximumConcurrency: 123,
},
selfManagedEventSource: {
endpoints: {
kafkaBootstrapServers: ['kafkaBootstrapServers'],
},
},
selfManagedKafkaEventSourceConfig: {
consumerGroupId: 'consumerGroupId',
consumptionMode: 'consumptionMode',
schemaRegistryConfig: {
accessConfigs: [{
type: 'type',
uri: 'uri',
}],
eventRecordFormat: 'eventRecordFormat',
schemaRegistryUri: 'schemaRegistryUri',
schemaValidationConfigs: [{
attribute: 'attribute',
}],
},
},
sourceAccessConfigurations: [{
type: 'type',
uri: 'uri',
}],
startingPosition: 'startingPosition',
startingPositionTimestamp: 123,
tags: [{
key: 'key',
value: 'value',
}],
topics: ['topics'],
tumblingWindowInSeconds: 123,
};
Properties
amazonManagedKafkaEventSourceConfigIResolvable | CfnEventSourceMapping.AmazonManagedKafkaEventSourceConfigPropertyamazon_managed_kafka_event_source_configtyping.Union[IResolvable, AmazonManagedKafkaEventSourceConfigProperty]amazonManagedKafkaEventSourceConfigIResolvableAmazonManagedKafkaEventSourceConfigIResolvableAmazonManagedKafkaEventSourceConfiginterface{}#Specific configuration settings for an Amazon Managed Streaming for Apache Kafka (Amazon MSK) event source.
The maximum number of records in each batch that Lambda pulls from your stream or queue and sends to your function.
notes
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.
bisectBatchOnFunctionErrorboolean | IResolvablebisect_batch_on_function_errortyping.Union[bool, IResolvable]bisectBatchOnFunctionErrorBooleanBisectBatchOnFunctionErrorboolBisectBatchOnFunctionErrorinterface{}#(Kinesis and DynamoDB Streams only) If the function returns an error, split the batch in two and retry.
notes
The default value is false.
When using
BisectBatchOnFunctionError, check theBatchSizeparameter in theOnFailuredestination message's metadata. TheBatchSizecould be greater than 1 since Lambda consolidates failed messages metadata when writing to theOnFailuredestination.
destinationConfigIResolvable | CfnEventSourceMapping.DestinationConfigPropertydestination_configtyping.Union[IResolvable, DestinationConfigProperty]destinationConfigIResolvableDestinationConfigIResolvableDestinationConfiginterface{}#(Kinesis, DynamoDB Streams, Amazon MSK, and self-managed Apache Kafka) A configuration object that specifies the destination of an event after Lambda processes it.
documentDbEventSourceConfigIResolvable | CfnEventSourceMapping.DocumentDBEventSourceConfigPropertydocument_db_event_source_configtyping.Union[IResolvable, DocumentDBEventSourceConfigProperty]documentDbEventSourceConfigIResolvableDocumentDbEventSourceConfigIResolvableDocumentDbEventSourceConfiginterface{}#Specific configuration settings for a DocumentDB event source.
enabledboolean | IResolvableenabledtyping.Union[bool, IResolvable]enabledBooleanEnabledboolEnabledinterface{}#When true, the event source mapping is active. When false, Lambda pauses polling and invocation.
Default: True
eventSourceArnstring | IStreamRef | IClusterRef | IQueueRefevent_source_arntyping.Union[str, IStreamRef, IClusterRef, IQueueRef]eventSourceArnStringEventSourceArnstringEventSourceArninterface{}#The Amazon Resource Name (ARN) of the event source.
notes
- 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 or the ARN of the VPC connection (for cross-account event source mappings ).
- Amazon MQ – The ARN of the broker.
- Amazon DocumentDB – The ARN of the DocumentDB change stream.
filterCriteriaIResolvable | CfnEventSourceMapping.FilterCriteriaPropertyfilter_criteriatyping.Union[IResolvable, FilterCriteriaProperty]filterCriteriaIResolvableFilterCriteriaIResolvableFilterCriteriainterface{}#An object that defines the filter criteria that determine whether Lambda should process an event.
For more information, see Lambda event filtering .
functionNamestring | IFunctionRef | IVersionReffunction_nametyping.Union[str, IFunctionRef, IVersionRef]functionNameStringFunctionNamestringFunctionNameinterface{}required#The name or ARN of the Lambda function.
notes
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.
functionResponseTypesstring[]function_response_typestyping.List[str]functionResponseTypesList<String>FunctionResponseTypesstring[]FunctionResponseTypes*[]*string#(Kinesis, DynamoDB Streams, and SQS) A list of current response type enums applied to the event source mapping.
Valid Values: ReportBatchItemFailures
The ARN of the AWS Key Management Service ( AWS ) customer managed key that Lambda uses to encrypt your function's [filter criteria](https://docs.aws.amazon.com/lambda/latest/dg/invocation-eventfiltering.html#filtering-basics) .
loggingConfigIResolvable | CfnEventSourceMapping.LoggingConfigPropertylogging_configtyping.Union[IResolvable, LoggingConfigProperty]loggingConfigIResolvableLoggingConfigIResolvableLoggingConfiginterface{}#The function's Amazon CloudWatch Logs configuration settings.
maximumBatchingWindowInSecondsnumbermaximum_batching_window_in_secondsint | floatmaximumBatchingWindowInSecondsNumberMaximumBatchingWindowInSecondsdoubleMaximumBatchingWindowInSeconds*float64#The maximum amount of time, in seconds, that Lambda spends gathering records before invoking the function.
notes
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.
maximumRecordAgeInSecondsnumbermaximum_record_age_in_secondsint | floatmaximumRecordAgeInSecondsNumberMaximumRecordAgeInSecondsdoubleMaximumRecordAgeInSeconds*float64#(Kinesis, DynamoDB Streams, Amazon MSK, and self-managed Apache Kafka) Discard records older than the specified age.
notes
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
maximumRetryAttemptsnumbermaximum_retry_attemptsint | floatmaximumRetryAttemptsNumberMaximumRetryAttemptsdoubleMaximumRetryAttempts*float64#(Kinesis, DynamoDB Streams, Amazon MSK, and self-managed Apache Kafka) 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.
metricsConfigIResolvable | CfnEventSourceMapping.MetricsConfigPropertymetrics_configtyping.Union[IResolvable, MetricsConfigProperty]metricsConfigIResolvableMetricsConfigIResolvableMetricsConfiginterface{}#The metrics configuration for your event source.
For more information, see Event source mapping metrics .
parallelizationFactornumberparallelization_factorint | floatparallelizationFactorNumberParallelizationFactordoubleParallelizationFactor*float64#(Kinesis and DynamoDB Streams only) The number of batches to process concurrently from each shard.
The default value is 1.
provisionedPollerConfigIResolvable | CfnEventSourceMapping.ProvisionedPollerConfigPropertyprovisioned_poller_configtyping.Union[IResolvable, ProvisionedPollerConfigProperty]provisionedPollerConfigIResolvableProvisionedPollerConfigIResolvableProvisionedPollerConfiginterface{}#(Amazon SQS, Amazon MSK, and self-managed Apache Kafka only) The provisioned mode configuration for the event source.
For more information, see provisioned mode .
(Amazon MQ) The name of the Amazon MQ broker destination queue to consume.
scalingConfigIResolvable | CfnEventSourceMapping.ScalingConfigPropertyscaling_configtyping.Union[IResolvable, ScalingConfigProperty]scalingConfigIResolvableScalingConfigIResolvableScalingConfiginterface{}#This property is for Amazon SQS event sources only.
You cannot use ProvisionedPollerConfig while using ScalingConfig . These options are mutually exclusive. To remove the scaling configuration, pass an empty value.
selfManagedEventSourceIResolvable | CfnEventSourceMapping.SelfManagedEventSourcePropertyself_managed_event_sourcetyping.Union[IResolvable, SelfManagedEventSourceProperty]selfManagedEventSourceIResolvableSelfManagedEventSourceIResolvableSelfManagedEventSourceinterface{}#The self-managed Apache Kafka cluster for your event source.
selfManagedKafkaEventSourceConfigIResolvable | CfnEventSourceMapping.SelfManagedKafkaEventSourceConfigPropertyself_managed_kafka_event_source_configtyping.Union[IResolvable, SelfManagedKafkaEventSourceConfigProperty]selfManagedKafkaEventSourceConfigIResolvableSelfManagedKafkaEventSourceConfigIResolvableSelfManagedKafkaEventSourceConfiginterface{}#Specific configuration settings for a self-managed Apache Kafka event source.
sourceAccessConfigurationsIResolvable | IResolvable | CfnEventSourceMapping.SourceAccessConfigurationProperty[]source_access_configurationstyping.Union[IResolvable, typing.List[typing.Union[IResolvable, SourceAccessConfigurationProperty]]]sourceAccessConfigurationsIResolvableSourceAccessConfigurationsIResolvableSourceAccessConfigurationsinterface{}#An array of the authentication protocol, VPC components, or virtual host to secure and define your event source.
startingPositionstringstarting_positionstrstartingPositionStringStartingPositionstringStartingPosition*string#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.
startingPositionTimestampnumberstarting_position_timestampint | floatstartingPositionTimestampNumberStartingPositionTimestampdoubleStartingPositionTimestamp*float64#With `StartingPosition` set to `AT_TIMESTAMP` , the time from which to start reading, in Unix time seconds.
StartingPositionTimestamp cannot be in the future.
A list of tags to add to the event source mapping.
notes
You must have the
lambda:TagResource,lambda:UntagResource, andlambda:ListTagspermissions for your IAM principal to manage the CloudFormation stack. If you don't have these permissions, there might be unexpected behavior with stack-level tags propagating to the resource during resource creation and update.
The name of the Kafka topic.
tumblingWindowInSecondsnumbertumbling_window_in_secondsint | floattumblingWindowInSecondsNumberTumblingWindowInSecondsdoubleTumblingWindowInSeconds*float64#(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.