EventSourceMapping

class aws_cdk.aws_lambda.EventSourceMapping(scope, id, *, target, batch_size=None, bisect_batch_on_error=None, enabled=None, event_source_arn=None, kafka_bootstrap_servers=None, kafka_topic=None, max_batching_window=None, max_record_age=None, on_failure=None, parallelization_factor=None, report_batch_item_failures=None, retry_attempts=None, source_access_configurations=None, starting_position=None, tumbling_window=None)

Bases: Resource

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 { SqsEventSource } from '@aws-cdk/aws-lambda-event-sources';
lambda.addEventSource(new SqsEventSource(sqs));

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.

ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_lambda as lambda_
import aws_cdk.core as cdk

# event_source_dlq: lambda.IEventSourceDlq
# function_: lambda.Function
# source_access_configuration_type: lambda.SourceAccessConfigurationType

event_source_mapping = lambda_.EventSourceMapping(self, "MyEventSourceMapping",
    target=function_,

    # the properties below are optional
    batch_size=123,
    bisect_batch_on_error=False,
    enabled=False,
    event_source_arn="eventSourceArn",
    kafka_bootstrap_servers=["kafkaBootstrapServers"],
    kafka_topic="kafkaTopic",
    max_batching_window=cdk.Duration.minutes(30),
    max_record_age=cdk.Duration.minutes(30),
    on_failure=event_source_dlq,
    parallelization_factor=123,
    report_batch_item_failures=False,
    retry_attempts=123,
    source_access_configurations=[lambda.SourceAccessConfiguration(
        type=source_access_configuration_type,
        uri="uri"
    )],
    starting_position=lambda_.StartingPosition.TRIM_HORIZON,
    tumbling_window=cdk.Duration.minutes(30)
)

Parameters:

scope (Construct)
id (str)
target (IFunction) – The target AWS Lambda function.
batch_size (Union[int, float, None]) – The largest number of records that AWS Lambda will retrieve from your event source at the time of invoking your function. Your function receives an event with all the retrieved records. Valid Range: Minimum value of 1. Maximum value of 10000. Default: - Amazon Kinesis, Amazon DynamoDB, and Amazon MSK is 100 records. The default for Amazon SQS is 10 messages. For standard SQS queues, the maximum is 10,000. For FIFO SQS queues, the maximum is 10.
bisect_batch_on_error (Optional[bool]) – If the function returns an error, split the batch in two and retry. Default: false
enabled (Optional[bool]) – Set to false to disable the event source upon creation. Default: true
event_source_arn (Optional[str]) – The Amazon Resource Name (ARN) of the event source. Any record added to this stream can invoke the Lambda function. Default: - not set if using a self managed Kafka cluster, throws an error otherwise
kafka_bootstrap_servers (Optional[Sequence[str]]) – A list of host and port pairs that are the addresses of the Kafka brokers in a self managed “bootstrap” Kafka cluster that a Kafka client connects to initially to bootstrap itself. They are in the format abc.example.com:9096. Default: - none
kafka_topic (Optional[str]) – The name of the Kafka topic. Default: - no topic
max_batching_window (Optional[Duration]) – The maximum amount of time to gather records before invoking the function. Maximum of Duration.minutes(5) Default: Duration.seconds(0)
max_record_age (Optional[Duration]) – The maximum age of a record that Lambda sends to a function for processing. Valid Range: - Minimum value of 60 seconds - Maximum value of 7 days Default: - infinite or until the record expires.
on_failure (Optional[IEventSourceDlq]) – An Amazon SQS queue or Amazon SNS topic destination for discarded records. Default: discarded records are ignored
parallelization_factor (Union[int, float, None]) – The number of batches to process from each shard concurrently. Valid Range: - Minimum value of 1 - Maximum value of 10 Default: 1
report_batch_item_failures (Optional[bool]) – Allow functions to return partially successful responses for a batch of records. Default: false
retry_attempts (Union[int, float, None]) – The maximum number of times to retry when the function returns an error. Set to undefined if you want lambda to keep retrying infinitely or until the record expires. Valid Range: - Minimum value of 0 - Maximum value of 10000 Default: - infinite or until the record expires.
source_access_configurations (Optional[Sequence[Union[SourceAccessConfiguration, Dict[str, Any]]]]) – Specific settings like the authentication protocol or the VPC components to secure access to your event source. Default: - none
starting_position (Optional[StartingPosition]) – The position in the DynamoDB, Kinesis or MSK stream where AWS Lambda should start reading. Default: - Required for Amazon Kinesis, Amazon DynamoDB, and Amazon MSK Streams sources.
tumbling_window (Optional[Duration]) – The size of the tumbling windows to group records sent to DynamoDB or Kinesis. Default: - None

Methods

apply_removal_policy(policy)

Apply the given removal policy to this resource.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

Parameters:: policy (RemovalPolicy)
Return type:: None

to_string()

Returns a string representation of this construct.

Return type:: str

Attributes

env

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

event_source_mapping_id: The identifier for this EventSourceMapping.

node: The construct tree node associated with this construct.

stack: The stack in which this resource is defined.

Static Methods

classmethod from_event_source_mapping_id(scope, id, event_source_mapping_id)

Import an event source into this stack from its event source id.

Parameters:

scope (Construct)
id (str)
event_source_mapping_id (str)

Return type:

IEventSourceMapping

classmethod is_construct(x)

Return whether the given object is a Construct.

Parameters:: x (Any)
Return type:: bool

classmethod is_resource(construct)

Check whether the given construct is a Resource.

Parameters:: construct (IConstruct)
Return type:: bool