class Aws::Lambda::Types::CreateEventSourceMappingRequest

@see docs.aws.amazon.com/goto/WebAPI/lambda-2015-03-31/CreateEventSourceMappingRequest AWS API Documentation
@return [Types::ProvisionedPollerConfig] : docs.aws.amazon.com/lambda/latest/dg/invocation-eventsourcemapping.html#invocation-eventsourcemapping-provisioned-mode [provisioned mode].
configuration for the event source. For more information, see
(Amazon MSK and self-managed Apache Kafka only) The provisioned mode
@!attribute [rw] provisioned_poller_config
@return [Types::EventSourceMappingMetricsConfig] : docs.aws.amazon.com/lambda/latest/dg/monitoring-metrics-types.html#event-source-mapping-metrics information, see [Event source mapping metrics].
The metrics configuration for your event source. For more
@!attribute [rw] metrics_config
@return [String] : docs.aws.amazon.com/lambda/latest/dg/invocation-eventfiltering.html#filtering-basics managed key.
Specify this property to encrypt data using your own customer
By default, Lambda does not encrypt your filter criteria object.
that Lambda uses to encrypt your function’s [filter criteria].
The ARN of the Key Management Service (KMS) customer managed key
@!attribute [rw] kms_key_arn
@return [Types::DocumentDBEventSourceConfig]
Specific configuration settings for a DocumentDB event source.
@!attribute [rw] document_db_event_source_config
@return [Types::ScalingConfig] : docs.aws.amazon.com/lambda/latest/dg/with-sqs.html#events-sqs-max-concurrency Amazon SQS event sources].
For more information, see [Configuring maximum concurrency for
(Amazon SQS only) The scaling configuration for the event source.
@!attribute [rw] scaling_config
@return [Types::SelfManagedKafkaEventSourceConfig]
event source.
Specific configuration settings for a self-managed Apache Kafka
@!attribute [rw] self_managed_kafka_event_source_config
@return [Types::AmazonManagedKafkaEventSourceConfig]
Apache Kafka (Amazon MSK) event source.
Specific configuration settings for an Amazon Managed Streaming for
@!attribute [rw] amazon_managed_kafka_event_source_config
@return [Array<String>]
response type enums applied to the event source mapping.
(Kinesis, DynamoDB Streams, and Amazon SQS) A list of current
@!attribute [rw] function_response_types
@return [Types::SelfManagedEventSource]
The self-managed Apache Kafka cluster to receive records from.
@!attribute [rw] self_managed_event_source
@return [Array<Types::SourceAccessConfiguration>]
secure your event source.
An array of authentication protocols or VPC components required to
@!attribute [rw] source_access_configurations
@return [Array<String>]
(MQ) The name of the Amazon MQ broker destination queue to consume.
@!attribute [rw] queues
@return [Array<String>]
The name of the Kafka topic.
@!attribute [rw] topics
@return [Integer]
value of 0 seconds indicates no tumbling window.
processing window for DynamoDB and Kinesis Streams event sources. A
(Kinesis and DynamoDB Streams only) The duration in seconds of a
@!attribute [rw] tumbling_window_in_seconds
@return [Hash<String,String>]
A list of tags to apply to the event source mapping.
@!attribute [rw] tags
@return [Integer]
record expires.
When set to infinite (-1), failed records are retried until the
specified number of retries. The default value is infinite (-1).
(Kinesis and DynamoDB Streams only) Discard records after the
@!attribute [rw] maximum_retry_attempts
@return [Boolean]
error, split the batch in two and retry.
(Kinesis and DynamoDB Streams only) If the function returns an
@!attribute [rw] bisect_batch_on_function_error
@return [Integer]
specified age. The default value is infinite (-1).
(Kinesis and DynamoDB Streams only) Discard records older than the
@!attribute [rw] maximum_record_age_in_seconds
@return [Types::DestinationConfig]
after Lambda processes it.
A configuration object that specifies the destination of an event
(Kinesis, DynamoDB Streams, Amazon MSK, and self-managed Kafka only)
@!attribute [rw] destination_config
@return [Time]
future.
to start reading. ‘StartingPositionTimestamp` cannot be in the
With `StartingPosition` set to `AT_TIMESTAMP`, the time from which
@!attribute [rw] starting_position_timestamp
@return [String]
DocumentDB, Amazon MSK, and self-managed Apache Kafka.
`AT_TIMESTAMP` is supported only for Amazon Kinesis streams, Amazon
Amazon Kinesis and Amazon DynamoDB Stream event sources.
The position in a stream from which to start reading. Required for
@!attribute [rw] starting_position
@return [Integer]
from each shard concurrently.
(Kinesis and DynamoDB Streams only) The number of batches to process
@!attribute [rw] parallelization_factor
@return [Integer]
must set `MaximumBatchingWindowInSeconds` to at least 1.
sources, when you set `BatchSize` to a value greater than 10, you
Related setting: For Kinesis, DynamoDB, and Amazon SQS event
create a new event source mapping.
have changed it. To restore the default batching window, you must
cannot revert back to the 500 ms default batching window after you
`MaximumBatchingWindowInSeconds` in increments of seconds, you
window is 500 ms. Note that because you can only change
Kafka, Amazon MQ, and DocumentDB event sources, the default batching
batching window is 0 seconds. For Amazon MSK, Self-managed Apache
For Kinesis, DynamoDB, and Amazon SQS event sources, the default
seconds in increments of seconds.
`MaximumBatchingWindowInSeconds` to any value from 0 seconds to 300
records before invoking the function. You can configure
The maximum amount of time, in seconds, that Lambda spends gathering
@!attribute [rw] maximum_batching_window_in_seconds
@return [Types::FilterCriteria] : docs.aws.amazon.com/lambda/latest/dg/invocation-eventfiltering.html event filtering].
Lambda should process an event. For more information, see [Lambda
An object that defines the filter criteria that determine whether
@!attribute [rw] filter_criteria
@return [Integer]
* DocumentDB – Default 100. Max 10,000.
* **Amazon MQ (ActiveMQ and RabbitMQ)** – Default 100. Max 10,000.
* **Self-managed Apache Kafka** – Default 100. Max 10,000.
10,000.
* **Amazon Managed Streaming for Apache Kafka** – Default 100. Max
the max is 10,000. For FIFO queues the max is 10.
* **Amazon Simple Queue Service** – Default 10. For standard queues
* **Amazon DynamoDB Streams** – Default 100. Max 10,000.
* **Amazon Kinesis** – Default 100. Max 10,000.
the payload limit for synchronous invocation (6 MB).
of the records in the batch to the function in a single call, up to
your stream or queue and sends to your function. Lambda passes all
The maximum number of records in each batch that Lambda pulls from
@!attribute [rw] batch_size
@return [Boolean]
Default: True
pauses polling and invocation.
When true, the event source mapping is active. When false, Lambda
@!attribute [rw] enabled
@return [String]
only the function name, it’s limited to 64 characters in length.
The length constraint applies only to the full ARN. If you specify
* **Partial ARN** – ‘123456789012:function:MyFunction`.
`arn:aws:lambda:us-west-2:123456789012:function:MyFunction:PROD`.
* **Version or Alias ARN** –
`arn:aws:lambda:us-west-2:123456789012:function:MyFunction`.
* **Function ARN** –
* **Function name** – `MyFunction`.
**Name formats**
The name or ARN of the Lambda function.
@!attribute [rw] function_name
@return [String] : docs.aws.amazon.com/lambda/latest/dg/with-msk.html#msk-multi-vpc * **Amazon DocumentDB** – The ARN of the DocumentDB change stream.
* **Amazon MQ** – The ARN of the broker.
source mappings]).
cluster or the ARN of the VPC connection (for [cross-account event
* **Amazon Managed Streaming for Apache Kafka** – The ARN of the
* **Amazon Simple Queue Service** – The ARN of the queue.
* **Amazon DynamoDB Streams** – The ARN of the stream.
consumer.
* **Amazon Kinesis** – The ARN of the data stream or a stream
The Amazon Resource Name (ARN) of the event source.
@!attribute [rw] event_source_arn

class Aws::Lambda::Types::CreateEventSourceMappingRequest

Namespace

Included Modules

Defined in