aws_lambda_event_source_mapping

account_id

Type: STRING

amazon_managed_kafka_event_source_config

Type: STRUCT
Provider name: AmazonManagedKafkaEventSourceConfig
Description: Specific configuration settings for an Amazon Managed Streaming for Apache Kafka (Amazon MSK) event source.

• consumer_group_id
  Type: STRING
  Provider name: ConsumerGroupId
  Description: The identifier for the Kafka consumer group to join. The consumer group ID must be unique among all your Kafka event sources. After creating a Kafka event source mapping with the consumer group ID specified, you cannot update this value. For more information, see Customizable consumer group ID.
  

batch_size

Type: INT32
Provider name: BatchSize
Description: 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). Default value: Varies by service. For Amazon SQS, the default is 10. For all other services, the default is 100. Related setting: When you set BatchSize to a value greater than 10, you must set MaximumBatchingWindowInSeconds to at least 1.

bisect_batch_on_function_error

Type: BOOLEAN
Provider name: BisectBatchOnFunctionError
Description: (Kinesis and DynamoDB Streams only) If the function returns an error, split the batch in two and retry. The default value is false.

destination_config

Type: STRUCT
Provider name: DestinationConfig
Description: (Kinesis and DynamoDB Streams only) An Amazon SQS queue or Amazon SNS topic destination for discarded records.

• on_failure
  Type: STRUCT
  Provider name: OnFailure
  Description: The destination configuration for failed invocations.
  
  • destination
    Type: STRING
    Provider name: Destination
    Description: The Amazon Resource Name (ARN) of the destination resource.
    
• on_success
  Type: STRUCT
  Provider name: OnSuccess
  Description: The destination configuration for successful invocations.
  
  • destination
    Type: STRING
    Provider name: Destination
    Description: The Amazon Resource Name (ARN) of the destination resource.
    

document_db_event_source_config

Type: STRUCT
Provider name: DocumentDBEventSourceConfig
Description: Specific configuration settings for a DocumentDB event source.

• collection_name
  Type: STRING
  Provider name: CollectionName
  Description: The name of the collection to consume within the database. If you do not specify a collection, Lambda consumes all collections.
  
• database_name
  Type: STRING
  Provider name: DatabaseName
  Description: The name of the database to consume within the DocumentDB cluster.
  
• full_document
  Type: STRING
  Provider name: FullDocument
  Description: Determines what DocumentDB sends to your event stream during document update operations. If set to UpdateLookup, DocumentDB sends a delta describing the changes, along with a copy of the entire document. Otherwise, DocumentDB sends only a partial document that contains the changes.
  

event_source_arn

Type: STRING
Provider name: EventSourceArn
Description: The Amazon Resource Name (ARN) of the event source.

event_source_mapping_arn

Type: STRING

filter_criteria

Type: STRUCT
Provider name: FilterCriteria
Description: An object that defines the filter criteria that determine whether Lambda should process an event. For more information, see Lambda event filtering.

• filters
  Type: UNORDERED_LIST_STRUCT
  Provider name: Filters
  Description: A list of filters.
  
  • pattern
    Type: STRING
    Provider name: Pattern
    Description: A filter pattern. For more information on the syntax of a filter pattern, see Filter rule syntax.
    

function_arn

Type: STRING
Provider name: FunctionArn
Description: The ARN of the Lambda function.

function_response_types

Type: UNORDERED_LIST_STRING
Provider name: FunctionResponseTypes
Description: (Kinesis, DynamoDB Streams, and Amazon SQS) A list of current response type enums applied to the event source mapping.

last_modified

Type: TIMESTAMP
Provider name: LastModified
Description: The date that the event source mapping was last updated or that its state changed.

last_processing_result

Type: STRING
Provider name: LastProcessingResult
Description: The result of the last Lambda invocation of your function.

maximum_batching_window_in_seconds

Type: INT32
Provider name: MaximumBatchingWindowInSeconds
Description: The maximum amount of time, in seconds, that Lambda spends gathering records before invoking the function. You can configure MaximumBatchingWindowInSeconds to any value from 0 seconds to 300 seconds in increments of seconds. For streams and Amazon SQS event sources, the default batching window is 0 seconds. For Amazon MSK, Self-managed Apache Kafka, Amazon MQ, and DocumentDB event sources, the default batching window is 500 ms. Note that because you can only change MaximumBatchingWindowInSeconds in increments of seconds, you cannot revert back to the 500 ms default batching window after you have changed it. To restore the default batching window, you must create a new event source mapping. Related setting: For streams and Amazon SQS event sources, when you set BatchSize to a value greater than 10, you must set MaximumBatchingWindowInSeconds to at least 1.

maximum_record_age_in_seconds

Type: INT32
Provider name: MaximumRecordAgeInSeconds
Description: (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

maximum_retry_attempts

Type: INT32
Provider name: MaximumRetryAttempts
Description: (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.

parallelization_factor

Type: INT32
Provider name: ParallelizationFactor
Description: (Kinesis and DynamoDB Streams only) The number of batches to process concurrently from each shard. The default value is 1.

queues

Type: UNORDERED_LIST_STRING
Provider name: Queues
Description: (Amazon MQ) The name of the Amazon MQ broker destination queue to consume.

scaling_config

Type: STRUCT
Provider name: ScalingConfig
Description: (Amazon SQS only) The scaling configuration for the event source. For more information, see Configuring maximum concurrency for Amazon SQS event sources.

• maximum_concurrency
  Type: INT32
  Provider name: MaximumConcurrency
  Description: Limits the number of concurrent instances that the Amazon SQS event source can invoke.
  

self_managed_event_source

Type: STRUCT
Provider name: SelfManagedEventSource
Description: The self-managed Apache Kafka cluster for your event source.

• endpoints
  Type: STRING
  Provider name: Endpoints
  Description: The list of bootstrap servers for your Kafka brokers in the following format: “KAFKA_BOOTSTRAP_SERVERS”: [“abc.xyz.com:xxxx”,“abc2.xyz.com:xxxx”].
  

self_managed_kafka_event_source_config

Type: STRUCT
Provider name: SelfManagedKafkaEventSourceConfig
Description: Specific configuration settings for a self-managed Apache Kafka event source.

• consumer_group_id
  Type: STRING
  Provider name: ConsumerGroupId
  Description: The identifier for the Kafka consumer group to join. The consumer group ID must be unique among all your Kafka event sources. After creating a Kafka event source mapping with the consumer group ID specified, you cannot update this value. For more information, see Customizable consumer group ID.
  

source_access_configurations

Type: UNORDERED_LIST_STRUCT
Provider name: SourceAccessConfigurations
Description: An array of the authentication protocol, VPC components, or virtual host to secure and define your event source.

• type
  Type: STRING
  Provider name: Type
  Description: The type of authentication protocol, VPC components, or virtual host for your event source. For example: “Type”:“SASL_SCRAM_512_AUTH”.
  • BASIC_AUTH – (Amazon MQ) The Secrets Manager secret that stores your broker credentials.
  • BASIC_AUTH – (Self-managed Apache Kafka) The Secrets Manager ARN of your secret key used for SASL/PLAIN authentication of your Apache Kafka brokers.
  • VPC_SUBNET – (Self-managed Apache Kafka) The subnets associated with your VPC. Lambda connects to these subnets to fetch data from your self-managed Apache Kafka cluster.
  • VPC_SECURITY_GROUP – (Self-managed Apache Kafka) The VPC security group used to manage access to your self-managed Apache Kafka brokers.
  • SASL_SCRAM_256_AUTH – (Self-managed Apache Kafka) The Secrets Manager ARN of your secret key used for SASL SCRAM-256 authentication of your self-managed Apache Kafka brokers.
  • SASL_SCRAM_512_AUTH – (Amazon MSK, Self-managed Apache Kafka) The Secrets Manager ARN of your secret key used for SASL SCRAM-512 authentication of your self-managed Apache Kafka brokers.
  • VIRTUAL_HOST –- (RabbitMQ) The name of the virtual host in your RabbitMQ broker. Lambda uses this RabbitMQ host as the event source. This property cannot be specified in an UpdateEventSourceMapping API call.
  • CLIENT_CERTIFICATE_TLS_AUTH – (Amazon MSK, self-managed Apache Kafka) The Secrets Manager ARN of your secret key containing the certificate chain (X.509 PEM), private key (PKCS#8 PEM), and private key password (optional) used for mutual TLS authentication of your MSK/Apache Kafka brokers.
  • SERVER_ROOT_CA_CERTIFICATE – (Self-managed Apache Kafka) The Secrets Manager ARN of your secret key containing the root CA certificate (X.509 PEM) used for TLS encryption of your Apache Kafka brokers.
• uri
  Type: STRING
  Provider name: URI
  Description: The value for your chosen configuration in Type. For example: “URI”: “arn:aws:secretsmanager:us-east-1:01234567890:secret:MyBrokerSecretName”.
  

starting_position

Type: STRING
Provider name: StartingPosition
Description: The position in a stream from which to start reading. Required for Amazon Kinesis and Amazon DynamoDB Stream event sources. AT_TIMESTAMP is supported only for Amazon Kinesis streams, Amazon DocumentDB, Amazon MSK, and self-managed Apache Kafka.

starting_position_timestamp

Type: TIMESTAMP
Provider name: StartingPositionTimestamp
Description: With StartingPosition set to AT_TIMESTAMP, the time from which to start reading. StartingPositionTimestamp cannot be in the future.

state

Type: STRING
Provider name: State
Description: The state of the event source mapping. It can be one of the following: Creating, Enabling, Enabled, Disabling, Disabled, Updating, or Deleting.

state_transition_reason

Type: STRING
Provider name: StateTransitionReason
Description: Indicates whether a user or Lambda made the last change to the event source mapping.

tags

Type: UNORDERED_LIST_STRING

topics

Type: UNORDERED_LIST_STRING
Provider name: Topics
Description: The name of the Kafka topic.

tumbling_window_in_seconds

Type: INT32
Provider name: TumblingWindowInSeconds
Description: (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.

uuid

Type: STRING
Provider name: UUID
Description: The identifier of the event source mapping.