EventSourceMapping

lambda.services.k8s.aws/v1alpha1

Metadata#

Spec#

amazonManagedKafkaEventSourceConfig: 
  consumerGroupID: string
  schemaRegistryConfig: 
    accessConfigs:
    - type: string
      uri: string
      uriRef: 
        from: 
          name: string
          namespace: string
    eventRecordFormat: string
    schemaRegistryURI: string
    schemaValidationConfigs:
    - attribute: string
batchSize: integer
bisectBatchOnFunctionError: boolean
destinationConfig: 
  onFailure: 
    destination: string
  onSuccess: 
    destination: string
enabled: boolean
eventSourceARN: string
eventSourceRef: 
  from: 
    name: string
    namespace: string
filterCriteria: 
  filters:
  - pattern: string
functionName: string
functionRef: 
  from: 
    name: string
    namespace: string
functionResponseTypes:
- string
maximumBatchingWindowInSeconds: integer
maximumRecordAgeInSeconds: integer
maximumRetryAttempts: integer
parallelizationFactor: integer
queueRefs:
  from: 
    name: string
    namespace: string
queues:
- string
scalingConfig: 
  maximumConcurrency: integer
selfManagedEventSource: 
  endpoints: {}
selfManagedKafkaEventSourceConfig: 
  consumerGroupID: string
  schemaRegistryConfig: 
    accessConfigs:
    - type: string
      uri: string
      uriRef: 
        from: 
          name: string
          namespace: string
    eventRecordFormat: string
    schemaRegistryURI: string
    schemaValidationConfigs:
    - attribute: string
sourceAccessConfigurations:
- type_: string
  uRI: string
startingPosition: string
startingPositionTimestamp: string
topics:
- string
tumblingWindowInSeconds: integer

If you’re working with an Glue schema registry, don’t provide authentication details in this object. Instead, ensure that your execution role has the required permissions for Lambda to access your cluster.

If you’re working with a Confluent schema registry, choose the authentication method in the Type field, and provide the Secrets Manager secret ARN in the URI field. || amazonManagedKafkaEventSourceConfig.schemaRegistryConfig.accessConfigs.[].type
Optional | string
| | amazonManagedKafkaEventSourceConfig.schemaRegistryConfig.accessConfigs.[].uri
Optional | string
| | amazonManagedKafkaEventSourceConfig.schemaRegistryConfig.accessConfigs.[].uriRef
Optional | object
Reference field for URI | | amazonManagedKafkaEventSourceConfig.schemaRegistryConfig.accessConfigs.[].uriRef.from
Optional | object
AWSResourceReference provides all the values necessary to reference another
k8s resource for finding the identifier(Id/ARN/Name) | | amazonManagedKafkaEventSourceConfig.schemaRegistryConfig.accessConfigs.[].uriRef.from.name
Optional | string
| | amazonManagedKafkaEventSourceConfig.schemaRegistryConfig.accessConfigs.[].uriRef.from.namespace
Optional | string
| | amazonManagedKafkaEventSourceConfig.schemaRegistryConfig.eventRecordFormat
Optional | string
| | amazonManagedKafkaEventSourceConfig.schemaRegistryConfig.schemaRegistryURI
Optional | string
| | amazonManagedKafkaEventSourceConfig.schemaRegistryConfig.schemaValidationConfigs
Optional | array
| | amazonManagedKafkaEventSourceConfig.schemaRegistryConfig.schemaValidationConfigs.[]
Required | object
Specific schema validation configuration settings that tell Lambda the message attributes you want to validate and filter using your schema registry. || amazonManagedKafkaEventSourceConfig.schemaRegistryConfig.schemaValidationConfigs.[].attribute
Optional | string
| | batchSize
Optional | integer
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
Optional | boolean
(Kinesis and DynamoDB Streams only) If the function returns an error, split
the batch in two and retry. | | destinationConfig
Optional | object
(Kinesis, DynamoDB Streams, Amazon MSK, and self-managed Kafka only) A configuration
object that specifies the destination of an event after Lambda processes
it. | | destinationConfig.onFailure
Optional | object
A destination for events that failed processing. For more information, see
Adding a destination (https://docs.aws.amazon.com/lambda/latest/dg/invocation-async-retain-records.html#invocation-async-destinations). | | destinationConfig.onFailure.destination
Optional | string
| | destinationConfig.onSuccess
Optional | object
A destination for events that were processed successfully.

To retain records of successful asynchronous invocations (https://docs.aws.amazon.com/lambda/latest/dg/invocation-async.html#invocation-async-destinations),
you can configure an Amazon SNS topic, Amazon SQS queue, Lambda function,
or Amazon EventBridge event bus as the destination.

OnSuccess is not supported in CreateEventSourceMapping or UpdateEventSourceMapping
requests. | | destinationConfig.onSuccess.destination
Optional | string
| | enabled
Optional | boolean
When true, the event source mapping is active. When false, Lambda pauses
polling and invocation.

Default: True | | eventSourceARN
Optional | string
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
or the ARN of the VPC connection (for cross-account event source mappings
(https://docs.aws.amazon.com/lambda/latest/dg/with-msk.html#msk-multi-vpc)).

* Amazon MQ – The ARN of the broker.

* Amazon DocumentDB – The ARN of the DocumentDB change stream.

Regex Pattern: ^arn:(aws[a-zA-Z0-9-]*):([a-zA-Z0-9\-])+:([a-z]{2}(-gov)?-[a-z]+-\d{1})?:(\d{12})?:(.*)$ | | eventSourceRef
Optional | object
AWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference
type to provide more user friendly syntax for references using ‘from’ field
Ex:
APIIDRef:

from:
name: my-api | | eventSourceRef.from
Optional | object
AWSResourceReference provides all the values necessary to reference another
k8s resource for finding the identifier(Id/ARN/Name) | | eventSourceRef.from.name
Optional | string
| | eventSourceRef.from.namespace
Optional | string
| | filterCriteria
Optional | object
An object that defines the filter criteria that determine whether Lambda
should process an event. For more information, see Lambda event filtering
(https://docs.aws.amazon.com/lambda/latest/dg/invocation-eventfiltering.html). | | filterCriteria.filters
Optional | array
| | filterCriteria.filters.[]
Required | object
A structure within a FilterCriteria object that defines an event filtering pattern. || filterCriteria.filters.[].pattern
Optional | string
| | functionName
Optional | string
The name or ARN 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.

Regex Pattern: ^(arn:(aws[a-zA-Z-]*)?:lambda:)?([a-z]{2}(-gov)?-[a-z]+-\d{1}:)?(\d{12}:)?(function:)?([a-zA-Z0-9-_]+)(:(\$LATEST|[a-zA-Z0-9-_]+))?$ | | functionRef
Optional | object
AWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference
type to provide more user friendly syntax for references using ‘from’ field
Ex:
APIIDRef:

from:
name: my-api | | functionRef.from
Optional | object
AWSResourceReference provides all the values necessary to reference another
k8s resource for finding the identifier(Id/ARN/Name) | | functionRef.from.name
Optional | string
| | functionRef.from.namespace
Optional | string
| | functionResponseTypes
Optional | array
(Kinesis, DynamoDB Streams, and Amazon SQS) A list of current response type
enums applied to the event source mapping. | | functionResponseTypes.[]
Required | string
|| maximumBatchingWindowInSeconds
Optional | integer
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 Kinesis, DynamoDB, 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 Kinesis, DynamoDB, and Amazon SQS event sources, when
you set BatchSize to a value greater than 10, you must set MaximumBatchingWindowInSeconds
to at least 1. | | maximumRecordAgeInSeconds
Optional | integer
(Kinesis and DynamoDB Streams only) Discard records older than the specified
age. The default value is infinite (-1). | | maximumRetryAttempts
Optional | integer
(Kinesis and DynamoDB Streams only) Discard records after the specified number
of retries. The default value is infinite (-1). When set to infinite (-1),
failed records are retried until the record expires. | | parallelizationFactor
Optional | integer
(Kinesis and DynamoDB Streams only) The number of batches to process from
each shard concurrently. | | queueRefs
Optional | array
| | queueRefs.[]
Required | object
AWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference type to provide more user friendly syntax for references using ‘from’ field Ex: APIIDRef:

from:
  name: my-api || **queueRefs.[].from**<br/>Optional | **object**<br/>AWSResourceReference provides all the values necessary to reference another<br/>k8s resource for finding the identifier(Id/ARN/Name) |

| queueRefs.[].from.name
Optional | string
| | queueRefs.[].from.namespace
Optional | string
| | queues
Optional | array
(MQ) The name of the Amazon MQ broker destination queue to consume. | | queues.[]
Required | string
|| scalingConfig
Optional | object
(Amazon SQS only) The scaling configuration for the event source. For more
information, see Configuring maximum concurrency for Amazon SQS event sources
(https://docs.aws.amazon.com/lambda/latest/dg/with-sqs.html#events-sqs-max-concurrency). | | scalingConfig.maximumConcurrency
Optional | integer
| | selfManagedEventSource
Optional | object
The self-managed Apache Kafka cluster to receive records from. | | selfManagedEventSource.endpoints
Optional | object
| | selfManagedKafkaEventSourceConfig
Optional | object
Specific configuration settings for a self-managed Apache Kafka event source. | | selfManagedKafkaEventSourceConfig.consumerGroupID
Optional | string
| | selfManagedKafkaEventSourceConfig.schemaRegistryConfig
Optional | object
Specific configuration settings for a Kafka schema registry. | | selfManagedKafkaEventSourceConfig.schemaRegistryConfig.accessConfigs
Optional | array
| | selfManagedKafkaEventSourceConfig.schemaRegistryConfig.accessConfigs.[]
Required | object
Specific access configuration settings that tell Lambda how to authenticate with your schema registry.

If you’re working with an Glue schema registry, don’t provide authentication details in this object. Instead, ensure that your execution role has the required permissions for Lambda to access your cluster.

If you’re working with a Confluent schema registry, choose the authentication method in the Type field, and provide the Secrets Manager secret ARN in the URI field. || selfManagedKafkaEventSourceConfig.schemaRegistryConfig.accessConfigs.[].type
Optional | string
| | selfManagedKafkaEventSourceConfig.schemaRegistryConfig.accessConfigs.[].uri
Optional | string
| | selfManagedKafkaEventSourceConfig.schemaRegistryConfig.accessConfigs.[].uriRef
Optional | object
Reference field for URI | | selfManagedKafkaEventSourceConfig.schemaRegistryConfig.accessConfigs.[].uriRef.from
Optional | object
AWSResourceReference provides all the values necessary to reference another
k8s resource for finding the identifier(Id/ARN/Name) | | selfManagedKafkaEventSourceConfig.schemaRegistryConfig.accessConfigs.[].uriRef.from.name
Optional | string
| | selfManagedKafkaEventSourceConfig.schemaRegistryConfig.accessConfigs.[].uriRef.from.namespace
Optional | string
| | selfManagedKafkaEventSourceConfig.schemaRegistryConfig.eventRecordFormat
Optional | string
| | selfManagedKafkaEventSourceConfig.schemaRegistryConfig.schemaRegistryURI
Optional | string
| | selfManagedKafkaEventSourceConfig.schemaRegistryConfig.schemaValidationConfigs
Optional | array
| | selfManagedKafkaEventSourceConfig.schemaRegistryConfig.schemaValidationConfigs.[]
Required | object
Specific schema validation configuration settings that tell Lambda the message attributes you want to validate and filter using your schema registry. || selfManagedKafkaEventSourceConfig.schemaRegistryConfig.schemaValidationConfigs.[].attribute
Optional | string
| | sourceAccessConfigurations
Optional | array
An array of authentication protocols or VPC components required to secure
your event source. | | sourceAccessConfigurations.[]
Required | object
To secure and define access to your event source, you can specify the authentication protocol, VPC components, or virtual host. || **sourceAccessConfigurations.[].type_**
Optional | **string**
| | **sourceAccessConfigurations.[].uRI**
Optional | **string**
| | **startingPosition**
Optional | **string**
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. | | **startingPositionTimestamp**
Optional | **string**
With StartingPosition set to AT_TIMESTAMP, the time from which to start reading.
StartingPositionTimestamp cannot be in the future. | | **topics**
Optional | **array**
The name of the Kafka topic. | | **topics.[]**
Required | **string**
|| **tumblingWindowInSeconds**
Optional | **integer**
(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. |

Status#

ackResourceMetadata: 
  arn: string
  ownerAccountID: string
  region: string
conditions:
- lastTransitionTime: string
  message: string
  reason: string
  status: string
  type: string
functionARN: string
lastModified: string
lastProcessingResult: string
state: string
stateTransitionReason: string
uuid: string