{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "#/components/schemas/CreateEventSourceMappingRequest",
"title": "CreateEventSourceMappingRequest",
"type": "object",
"required": [
"FunctionName"
],
"properties": {
"EventSourceArn": {
"allOf": [
{
"$ref": "#/components/schemas/Arn"
},
{
"description": "<p>The Amazon Resource Name (ARN) of the event source.</p> <ul> <li> <p> <b>Amazon Kinesis</b> \u00e2\u20ac\u201c The ARN of the data stream or a stream consumer.</p> </li> <li> <p> <b>Amazon DynamoDB Streams</b> \u00e2\u20ac\u201c The ARN of the stream.</p> </li> <li> <p> <b>Amazon Simple Queue Service</b> \u00e2\u20ac\u201c The ARN of the queue.</p> </li> <li> <p> <b>Amazon Managed Streaming for Apache Kafka</b> \u00e2\u20ac\u201c The ARN of the cluster.</p> </li> <li> <p> <b>Amazon MQ</b> \u00e2\u20ac\u201c The ARN of the broker.</p> </li> <li> <p> <b>Amazon DocumentDB</b> \u00e2\u20ac\u201c The ARN of the DocumentDB change stream.</p> </li> </ul>"
}
]
},
"FunctionName": {
"allOf": [
{
"$ref": "#/components/schemas/FunctionName"
},
{
"description": "<p>The name of the Lambda function.</p> <p class=\"title\"> <b>Name formats</b> </p> <ul> <li> <p> <b>Function name</b> \u00e2\u20ac\u201c <code>MyFunction</code>.</p> </li> <li> <p> <b>Function ARN</b> \u00e2\u20ac\u201c <code>arn:aws:lambda:us-west-2:123456789012:function:MyFunction</code>.</p> </li> <li> <p> <b>Version or Alias ARN</b> \u00e2\u20ac\u201c <code>arn:aws:lambda:us-west-2:123456789012:function:MyFunction:PROD</code>.</p> </li> <li> <p> <b>Partial ARN</b> \u00e2\u20ac\u201c <code>123456789012:function:MyFunction</code>.</p> </li> </ul> <p>The length constraint applies only to the full ARN. If you specify only the function name, it's limited to 64 characters in length.</p>"
}
]
},
"Enabled": {
"allOf": [
{
"$ref": "#/components/schemas/Enabled"
},
{
"description": "<p>When true, the event source mapping is active. When false, Lambda pauses polling and invocation.</p> <p>Default: True</p>"
}
]
},
"BatchSize": {
"allOf": [
{
"$ref": "#/components/schemas/BatchSize"
},
{
"description": "<p>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).</p> <ul> <li> <p> <b>Amazon Kinesis</b> \u00e2\u20ac\u201c Default 100. Max 10,000.</p> </li> <li> <p> <b>Amazon DynamoDB Streams</b> \u00e2\u20ac\u201c Default 100. Max 10,000.</p> </li> <li> <p> <b>Amazon Simple Queue Service</b> \u00e2\u20ac\u201c Default 10. For standard queues the max is 10,000. For FIFO queues the max is 10.</p> </li> <li> <p> <b>Amazon Managed Streaming for Apache Kafka</b> \u00e2\u20ac\u201c Default 100. Max 10,000.</p> </li> <li> <p> <b>Self-managed Apache Kafka</b> \u00e2\u20ac\u201c Default 100. Max 10,000.</p> </li> <li> <p> <b>Amazon MQ (ActiveMQ and RabbitMQ)</b> \u00e2\u20ac\u201c Default 100. Max 10,000.</p> </li> <li> <p> <b>DocumentDB</b> \u00e2\u20ac\u201c Default 100. Max 10,000.</p> </li> </ul>"
}
]
},
"FilterCriteria": {
"allOf": [
{
"$ref": "#/components/schemas/FilterCriteria"
},
{
"description": "An object that defines the filter criteria that determine whether Lambda should process an event. For more information, see <a href=\"https://docs.aws.amazon.com/lambda/latest/dg/invocation-eventfiltering.html\">Lambda event filtering</a>."
}
]
},
"MaximumBatchingWindowInSeconds": {
"allOf": [
{
"$ref": "#/components/schemas/MaximumBatchingWindowInSeconds"
},
{
"description": "<p>The maximum amount of time, in seconds, that Lambda spends gathering records before invoking the function. You can configure <code>MaximumBatchingWindowInSeconds</code> to any value from 0 seconds to 300 seconds in increments of seconds.</p> <p>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 <code>MaximumBatchingWindowInSeconds</code> 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.</p> <p>Related setting: For streams and Amazon SQS event sources, when you set <code>BatchSize</code> to a value greater than 10, you must set <code>MaximumBatchingWindowInSeconds</code> to at least 1.</p>"
}
]
},
"ParallelizationFactor": {
"allOf": [
{
"$ref": "#/components/schemas/ParallelizationFactor"
},
{
"description": "(Kinesis and DynamoDB Streams only) The number of batches to process from each shard concurrently."
}
]
},
"StartingPosition": {
"allOf": [
{
"$ref": "#/components/schemas/EventSourcePosition"
},
{
"description": "The position in a stream from which to start reading. Required for Amazon Kinesis, Amazon DynamoDB, and Amazon MSK Streams sources. <code>AT_TIMESTAMP</code> is supported only for Amazon Kinesis streams and Amazon DocumentDB."
}
]
},
"StartingPositionTimestamp": {
"allOf": [
{
"$ref": "#/components/schemas/Date"
},
{
"description": "With <code>StartingPosition</code> set to <code>AT_TIMESTAMP</code>, the time from which to start reading."
}
]
},
"DestinationConfig": {
"allOf": [
{
"$ref": "#/components/schemas/DestinationConfig"
},
{
"description": "(Kinesis and DynamoDB Streams only) A standard Amazon SQS queue or standard Amazon SNS topic destination for discarded records."
}
]
},
"MaximumRecordAgeInSeconds": {
"allOf": [
{
"$ref": "#/components/schemas/MaximumRecordAgeInSeconds"
},
{
"description": "(Kinesis and DynamoDB Streams only) Discard records older than the specified age. The default value is infinite (-1)."
}
]
},
"BisectBatchOnFunctionError": {
"allOf": [
{
"$ref": "#/components/schemas/BisectBatchOnFunctionError"
},
{
"description": "(Kinesis and DynamoDB Streams only) If the function returns an error, split the batch in two and retry."
}
]
},
"MaximumRetryAttempts": {
"allOf": [
{
"$ref": "#/components/schemas/MaximumRetryAttemptsEventSourceMapping"
},
{
"description": "(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."
}
]
},
"TumblingWindowInSeconds": {
"allOf": [
{
"$ref": "#/components/schemas/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."
}
]
},
"Topics": {
"allOf": [
{
"$ref": "#/components/schemas/Topics"
},
{
"description": "The name of the Kafka topic."
}
]
},
"Queues": {
"allOf": [
{
"$ref": "#/components/schemas/Queues"
},
{
"description": " (MQ) The name of the Amazon MQ broker destination queue to consume. "
}
]
},
"SourceAccessConfigurations": {
"allOf": [
{
"$ref": "#/components/schemas/SourceAccessConfigurations"
},
{
"description": "An array of authentication protocols or VPC components required to secure your event source."
}
]
},
"SelfManagedEventSource": {
"allOf": [
{
"$ref": "#/components/schemas/SelfManagedEventSource"
},
{
"description": "The self-managed Apache Kafka cluster to receive records from."
}
]
},
"FunctionResponseTypes": {
"allOf": [
{
"$ref": "#/components/schemas/FunctionResponseTypeList"
},
{
"description": "(Kinesis, DynamoDB Streams, and Amazon SQS) A list of current response type enums applied to the event source mapping."
}
]
},
"AmazonManagedKafkaEventSourceConfig": {
"allOf": [
{
"$ref": "#/components/schemas/AmazonManagedKafkaEventSourceConfig"
},
{
"description": "Specific configuration settings for an Amazon Managed Streaming for Apache Kafka (Amazon MSK) event source."
}
]
},
"SelfManagedKafkaEventSourceConfig": {
"allOf": [
{
"$ref": "#/components/schemas/SelfManagedKafkaEventSourceConfig"
},
{
"description": "Specific configuration settings for a self-managed Apache Kafka event source."
}
]
},
"ScalingConfig": {
"allOf": [
{
"$ref": "#/components/schemas/ScalingConfig"
},
{
"description": "(Amazon SQS only) The scaling configuration for the event source. For more information, see <a href=\"https://docs.aws.amazon.com/lambda/latest/dg/with-sqs.html#events-sqs-max-concurrency\">Configuring maximum concurrency for Amazon SQS event sources</a>."
}
]
},
"DocumentDBEventSourceConfig": {
"allOf": [
{
"$ref": "#/components/schemas/DocumentDBEventSourceConfig"
},
{
"description": "Specific configuration settings for a DocumentDB event source."
}
]
}
}
}