We recommend new projects start with resources from the AWS provider.
aws-native.lambda.getEventSourceMapping
Explore with Pulumi AI
We recommend new projects start with resources from the AWS provider.
The AWS::Lambda::EventSourceMapping
resource creates a mapping between an event source and an LAMlong function. LAM reads items from the event source and triggers the function.
For details about each event source type, see the following topics. In particular, each of the topics describes the required and optional parameters for the specific event source.
- Configuring a Dynamo DB stream as an event source
- Configuring a Kinesis stream as an event source
- Configuring an SQS queue as an event source
- Configuring an MQ broker as an event source
- Configuring MSK as an event source
- Configuring Self-Managed Apache Kafka as an event source
- Configuring Amazon DocumentDB as an event source
Using getEventSourceMapping
Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.
function getEventSourceMapping(args: GetEventSourceMappingArgs, opts?: InvokeOptions): Promise<GetEventSourceMappingResult>
function getEventSourceMappingOutput(args: GetEventSourceMappingOutputArgs, opts?: InvokeOptions): Output<GetEventSourceMappingResult>
def get_event_source_mapping(id: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetEventSourceMappingResult
def get_event_source_mapping_output(id: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetEventSourceMappingResult]
func LookupEventSourceMapping(ctx *Context, args *LookupEventSourceMappingArgs, opts ...InvokeOption) (*LookupEventSourceMappingResult, error)
func LookupEventSourceMappingOutput(ctx *Context, args *LookupEventSourceMappingOutputArgs, opts ...InvokeOption) LookupEventSourceMappingResultOutput
> Note: This function is named LookupEventSourceMapping
in the Go SDK.
public static class GetEventSourceMapping
{
public static Task<GetEventSourceMappingResult> InvokeAsync(GetEventSourceMappingArgs args, InvokeOptions? opts = null)
public static Output<GetEventSourceMappingResult> Invoke(GetEventSourceMappingInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetEventSourceMappingResult> getEventSourceMapping(GetEventSourceMappingArgs args, InvokeOptions options)
public static Output<GetEventSourceMappingResult> getEventSourceMapping(GetEventSourceMappingArgs args, InvokeOptions options)
fn::invoke:
function: aws-native:lambda:getEventSourceMapping
arguments:
# arguments dictionary
The following arguments are supported:
- Id string
- The event source mapping's ID.
- Id string
- The event source mapping's ID.
- id String
- The event source mapping's ID.
- id string
- The event source mapping's ID.
- id str
- The event source mapping's ID.
- id String
- The event source mapping's ID.
getEventSourceMapping Result
The following output properties are available:
- Amazon
Managed Pulumi.Kafka Event Source Config Aws Native. Lambda. Outputs. Event Source Mapping Amazon Managed Kafka Event Source Config - Specific configuration settings for an Amazon Managed Streaming for Apache Kafka (Amazon MSK) event source.
- Batch
Size int - 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.
- Bisect
Batch boolOn Function Error - (Kinesis and DynamoDB Streams only) If the function returns an error, split the batch in two and retry. The default value is false.
When using
BisectBatchOnFunctionError
, check theBatchSize
parameter in theOnFailure
destination message's metadata. TheBatchSize
could be greater than 1 since LAM consolidates failed messages metadata when writing to theOnFailure
destination. - Destination
Config Pulumi.Aws Native. Lambda. Outputs. Event Source Mapping Destination Config - (Kinesis, DynamoDB Streams, Amazon MSK, and self-managed Apache Kafka event sources only) A configuration object that specifies the destination of an event after Lambda processes it.
- Document
Db Pulumi.Event Source Config Aws Native. Lambda. Outputs. Event Source Mapping Document Db Event Source Config - Specific configuration settings for a DocumentDB event source.
- Enabled bool
- When true, the event source mapping is active. When false, Lambda pauses polling and invocation. Default: True
- Event
Source stringMapping Arn - The Amazon Resource Name (ARN) of the event source mapping.
- Filter
Criteria Pulumi.Aws Native. Lambda. Outputs. Event Source Mapping Filter Criteria - An object that defines the filter criteria that determine whether Lambda should process an event. For more information, see Lambda event filtering.
- Function
Name 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.
- Function name –
- Function
Response List<Pulumi.Types Aws Native. Lambda. Event Source Mapping Function Response Types Item> - (Kinesis, DynamoDB Streams, and SQS) A list of current response type enums applied to the event source mapping.
Valid Values:
ReportBatchItemFailures
- Id string
- The event source mapping's ID.
- Kms
Key stringArn - The ARN of the KMSlong (KMS) customer managed key that Lambda uses to encrypt your function's filter criteria.
- Maximum
Batching intWindow In Seconds - The maximum amount of time, in seconds, that Lambda spends gathering records before invoking the function.
Default (, , event sources): 0
Default (, Kafka, , event sources): 500 ms
Related setting: For SQS event sources, when you set
BatchSize
to a value greater than 10, you must setMaximumBatchingWindowInSeconds
to at least 1. - Maximum
Record intAge In Seconds - (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 intAttempts - (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.
- Metrics
Config Pulumi.Aws Native. Lambda. Outputs. Event Source Mapping Metrics Config - The metrics configuration for your event source. For more information, see Event source mapping metrics.
- Parallelization
Factor int - (Kinesis and DynamoDB Streams only) The number of batches to process concurrently from each shard. The default value is 1.
- Provisioned
Poller Pulumi.Config Aws Native. Lambda. Outputs. Event Source Mapping Provisioned Poller Config - (Amazon MSK and self-managed Apache Kafka only) The provisioned mode configuration for the event source. For more information, see provisioned mode.
- Queues List<string>
- (Amazon MQ) The name of the Amazon MQ broker destination queue to consume.
- Scaling
Config Pulumi.Aws Native. Lambda. Outputs. Event Source Mapping Scaling Config - (Amazon SQS only) The scaling configuration for the event source. For more information, see Configuring maximum concurrency for Amazon SQS event sources.
- Self
Managed Pulumi.Kafka Event Source Config Aws Native. Lambda. Outputs. Event Source Mapping Self Managed Kafka Event Source Config - Specific configuration settings for a self-managed Apache Kafka event source.
- Source
Access List<Pulumi.Configurations Aws Native. Lambda. Outputs. Event Source Mapping Source Access Configuration> - An array of the authentication protocol, VPC components, or virtual host to secure and define your event source.
- List<Pulumi.
Aws Native. Outputs. Tag> - A list of tags to add to the event source mapping.
You must have the
lambda:TagResource
,lambda:UntagResource
, andlambda:ListTags
permissions for your principal to manage the CFN stack. If you don't have these permissions, there might be unexpected behavior with stack-level tags propagating to the resource during resource creation and update. - Topics List<string>
- The name of the Kafka topic.
- Tumbling
Window intIn Seconds - (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.
- Amazon
Managed EventKafka Event Source Config Source Mapping Amazon Managed Kafka Event Source Config - Specific configuration settings for an Amazon Managed Streaming for Apache Kafka (Amazon MSK) event source.
- Batch
Size int - 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.
- Bisect
Batch boolOn Function Error - (Kinesis and DynamoDB Streams only) If the function returns an error, split the batch in two and retry. The default value is false.
When using
BisectBatchOnFunctionError
, check theBatchSize
parameter in theOnFailure
destination message's metadata. TheBatchSize
could be greater than 1 since LAM consolidates failed messages metadata when writing to theOnFailure
destination. - Destination
Config EventSource Mapping Destination Config - (Kinesis, DynamoDB Streams, Amazon MSK, and self-managed Apache Kafka event sources only) A configuration object that specifies the destination of an event after Lambda processes it.
- Document
Db EventEvent Source Config Source Mapping Document Db Event Source Config - Specific configuration settings for a DocumentDB event source.
- Enabled bool
- When true, the event source mapping is active. When false, Lambda pauses polling and invocation. Default: True
- Event
Source stringMapping Arn - The Amazon Resource Name (ARN) of the event source mapping.
- Filter
Criteria EventSource Mapping Filter Criteria - An object that defines the filter criteria that determine whether Lambda should process an event. For more information, see Lambda event filtering.
- Function
Name 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.
- Function name –
- Function
Response []EventTypes Source Mapping Function Response Types Item - (Kinesis, DynamoDB Streams, and SQS) A list of current response type enums applied to the event source mapping.
Valid Values:
ReportBatchItemFailures
- Id string
- The event source mapping's ID.
- Kms
Key stringArn - The ARN of the KMSlong (KMS) customer managed key that Lambda uses to encrypt your function's filter criteria.
- Maximum
Batching intWindow In Seconds - The maximum amount of time, in seconds, that Lambda spends gathering records before invoking the function.
Default (, , event sources): 0
Default (, Kafka, , event sources): 500 ms
Related setting: For SQS event sources, when you set
BatchSize
to a value greater than 10, you must setMaximumBatchingWindowInSeconds
to at least 1. - Maximum
Record intAge In Seconds - (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 intAttempts - (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.
- Metrics
Config EventSource Mapping Metrics Config - The metrics configuration for your event source. For more information, see Event source mapping metrics.
- Parallelization
Factor int - (Kinesis and DynamoDB Streams only) The number of batches to process concurrently from each shard. The default value is 1.
- Provisioned
Poller EventConfig Source Mapping Provisioned Poller Config - (Amazon MSK and self-managed Apache Kafka only) The provisioned mode configuration for the event source. For more information, see provisioned mode.
- Queues []string
- (Amazon MQ) The name of the Amazon MQ broker destination queue to consume.
- Scaling
Config EventSource Mapping Scaling Config - (Amazon SQS only) The scaling configuration for the event source. For more information, see Configuring maximum concurrency for Amazon SQS event sources.
- Self
Managed EventKafka Event Source Config Source Mapping Self Managed Kafka Event Source Config - Specific configuration settings for a self-managed Apache Kafka event source.
- Source
Access []EventConfigurations Source Mapping Source Access Configuration - An array of the authentication protocol, VPC components, or virtual host to secure and define your event source.
- Tag
- A list of tags to add to the event source mapping.
You must have the
lambda:TagResource
,lambda:UntagResource
, andlambda:ListTags
permissions for your principal to manage the CFN stack. If you don't have these permissions, there might be unexpected behavior with stack-level tags propagating to the resource during resource creation and update. - Topics []string
- The name of the Kafka topic.
- Tumbling
Window intIn Seconds - (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.
- amazon
Managed EventKafka Event Source Config Source Mapping Amazon Managed Kafka Event Source Config - Specific configuration settings for an Amazon Managed Streaming for Apache Kafka (Amazon MSK) event source.
- batch
Size 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.
- bisect
Batch BooleanOn Function Error - (Kinesis and DynamoDB Streams only) If the function returns an error, split the batch in two and retry. The default value is false.
When using
BisectBatchOnFunctionError
, check theBatchSize
parameter in theOnFailure
destination message's metadata. TheBatchSize
could be greater than 1 since LAM consolidates failed messages metadata when writing to theOnFailure
destination. - destination
Config EventSource Mapping Destination Config - (Kinesis, DynamoDB Streams, Amazon MSK, and self-managed Apache Kafka event sources only) A configuration object that specifies the destination of an event after Lambda processes it.
- document
Db EventEvent Source Config Source Mapping Document Db Event Source Config - Specific configuration settings for a DocumentDB event source.
- enabled Boolean
- When true, the event source mapping is active. When false, Lambda pauses polling and invocation. Default: True
- event
Source StringMapping Arn - The Amazon Resource Name (ARN) of the event source mapping.
- filter
Criteria EventSource Mapping Filter Criteria - An object that defines the filter criteria that determine whether Lambda should process an event. For more information, see Lambda event filtering.
- function
Name 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.
- Function name –
- function
Response List<EventTypes Source Mapping Function Response Types Item> - (Kinesis, DynamoDB Streams, and SQS) A list of current response type enums applied to the event source mapping.
Valid Values:
ReportBatchItemFailures
- id String
- The event source mapping's ID.
- kms
Key StringArn - The ARN of the KMSlong (KMS) customer managed key that Lambda uses to encrypt your function's filter criteria.
- maximum
Batching IntegerWindow In Seconds - The maximum amount of time, in seconds, that Lambda spends gathering records before invoking the function.
Default (, , event sources): 0
Default (, Kafka, , event sources): 500 ms
Related setting: For SQS event sources, when you set
BatchSize
to a value greater than 10, you must setMaximumBatchingWindowInSeconds
to at least 1. - maximum
Record IntegerAge In Seconds - (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 IntegerAttempts - (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.
- metrics
Config EventSource Mapping Metrics Config - The metrics configuration for your event source. For more information, see Event source mapping metrics.
- parallelization
Factor Integer - (Kinesis and DynamoDB Streams only) The number of batches to process concurrently from each shard. The default value is 1.
- provisioned
Poller EventConfig Source Mapping Provisioned Poller Config - (Amazon MSK and self-managed Apache Kafka only) The provisioned mode configuration for the event source. For more information, see provisioned mode.
- queues List<String>
- (Amazon MQ) The name of the Amazon MQ broker destination queue to consume.
- scaling
Config EventSource Mapping Scaling Config - (Amazon SQS only) The scaling configuration for the event source. For more information, see Configuring maximum concurrency for Amazon SQS event sources.
- self
Managed EventKafka Event Source Config Source Mapping Self Managed Kafka Event Source Config - Specific configuration settings for a self-managed Apache Kafka event source.
- source
Access List<EventConfigurations Source Mapping Source Access Configuration> - An array of the authentication protocol, VPC components, or virtual host to secure and define your event source.
- List<Tag>
- A list of tags to add to the event source mapping.
You must have the
lambda:TagResource
,lambda:UntagResource
, andlambda:ListTags
permissions for your principal to manage the CFN stack. If you don't have these permissions, there might be unexpected behavior with stack-level tags propagating to the resource during resource creation and update. - topics List<String>
- The name of the Kafka topic.
- tumbling
Window IntegerIn Seconds - (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.
- amazon
Managed EventKafka Event Source Config Source Mapping Amazon Managed Kafka Event Source Config - Specific configuration settings for an Amazon Managed Streaming for Apache Kafka (Amazon MSK) event source.
- batch
Size number - 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.
- bisect
Batch booleanOn Function Error - (Kinesis and DynamoDB Streams only) If the function returns an error, split the batch in two and retry. The default value is false.
When using
BisectBatchOnFunctionError
, check theBatchSize
parameter in theOnFailure
destination message's metadata. TheBatchSize
could be greater than 1 since LAM consolidates failed messages metadata when writing to theOnFailure
destination. - destination
Config EventSource Mapping Destination Config - (Kinesis, DynamoDB Streams, Amazon MSK, and self-managed Apache Kafka event sources only) A configuration object that specifies the destination of an event after Lambda processes it.
- document
Db EventEvent Source Config Source Mapping Document Db Event Source Config - Specific configuration settings for a DocumentDB event source.
- enabled boolean
- When true, the event source mapping is active. When false, Lambda pauses polling and invocation. Default: True
- event
Source stringMapping Arn - The Amazon Resource Name (ARN) of the event source mapping.
- filter
Criteria EventSource Mapping Filter Criteria - An object that defines the filter criteria that determine whether Lambda should process an event. For more information, see Lambda event filtering.
- function
Name 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.
- Function name –
- function
Response EventTypes Source Mapping Function Response Types Item[] - (Kinesis, DynamoDB Streams, and SQS) A list of current response type enums applied to the event source mapping.
Valid Values:
ReportBatchItemFailures
- id string
- The event source mapping's ID.
- kms
Key stringArn - The ARN of the KMSlong (KMS) customer managed key that Lambda uses to encrypt your function's filter criteria.
- maximum
Batching numberWindow In Seconds - The maximum amount of time, in seconds, that Lambda spends gathering records before invoking the function.
Default (, , event sources): 0
Default (, Kafka, , event sources): 500 ms
Related setting: For SQS event sources, when you set
BatchSize
to a value greater than 10, you must setMaximumBatchingWindowInSeconds
to at least 1. - maximum
Record numberAge In Seconds - (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 numberAttempts - (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.
- metrics
Config EventSource Mapping Metrics Config - The metrics configuration for your event source. For more information, see Event source mapping metrics.
- parallelization
Factor number - (Kinesis and DynamoDB Streams only) The number of batches to process concurrently from each shard. The default value is 1.
- provisioned
Poller EventConfig Source Mapping Provisioned Poller Config - (Amazon MSK and self-managed Apache Kafka only) The provisioned mode configuration for the event source. For more information, see provisioned mode.
- queues string[]
- (Amazon MQ) The name of the Amazon MQ broker destination queue to consume.
- scaling
Config EventSource Mapping Scaling Config - (Amazon SQS only) The scaling configuration for the event source. For more information, see Configuring maximum concurrency for Amazon SQS event sources.
- self
Managed EventKafka Event Source Config Source Mapping Self Managed Kafka Event Source Config - Specific configuration settings for a self-managed Apache Kafka event source.
- source
Access EventConfigurations Source Mapping Source Access Configuration[] - An array of the authentication protocol, VPC components, or virtual host to secure and define your event source.
- Tag[]
- A list of tags to add to the event source mapping.
You must have the
lambda:TagResource
,lambda:UntagResource
, andlambda:ListTags
permissions for your principal to manage the CFN stack. If you don't have these permissions, there might be unexpected behavior with stack-level tags propagating to the resource during resource creation and update. - topics string[]
- The name of the Kafka topic.
- tumbling
Window numberIn Seconds - (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.
- amazon_
managed_ Eventkafka_ event_ source_ config Source Mapping Amazon Managed Kafka Event Source Config - Specific configuration settings for an Amazon Managed Streaming for Apache Kafka (Amazon MSK) event source.
- batch_
size int - 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.
- bisect_
batch_ boolon_ function_ error - (Kinesis and DynamoDB Streams only) If the function returns an error, split the batch in two and retry. The default value is false.
When using
BisectBatchOnFunctionError
, check theBatchSize
parameter in theOnFailure
destination message's metadata. TheBatchSize
could be greater than 1 since LAM consolidates failed messages metadata when writing to theOnFailure
destination. - destination_
config EventSource Mapping Destination Config - (Kinesis, DynamoDB Streams, Amazon MSK, and self-managed Apache Kafka event sources only) A configuration object that specifies the destination of an event after Lambda processes it.
- document_
db_ Eventevent_ source_ config Source Mapping Document Db Event Source Config - Specific configuration settings for a DocumentDB event source.
- enabled bool
- When true, the event source mapping is active. When false, Lambda pauses polling and invocation. Default: True
- event_
source_ strmapping_ arn - The Amazon Resource Name (ARN) of the event source mapping.
- filter_
criteria EventSource Mapping Filter Criteria - An object that defines the filter criteria that determine whether Lambda should process an event. For more information, see Lambda event filtering.
- function_
name str 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.
- Function name –
- function_
response_ Sequence[Eventtypes Source Mapping Function Response Types Item] - (Kinesis, DynamoDB Streams, and SQS) A list of current response type enums applied to the event source mapping.
Valid Values:
ReportBatchItemFailures
- id str
- The event source mapping's ID.
- kms_
key_ strarn - The ARN of the KMSlong (KMS) customer managed key that Lambda uses to encrypt your function's filter criteria.
- maximum_
batching_ intwindow_ in_ seconds - The maximum amount of time, in seconds, that Lambda spends gathering records before invoking the function.
Default (, , event sources): 0
Default (, Kafka, , event sources): 500 ms
Related setting: For SQS event sources, when you set
BatchSize
to a value greater than 10, you must setMaximumBatchingWindowInSeconds
to at least 1. - maximum_
record_ intage_ in_ seconds - (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_ intattempts - (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.
- metrics_
config EventSource Mapping Metrics Config - The metrics configuration for your event source. For more information, see Event source mapping metrics.
- parallelization_
factor int - (Kinesis and DynamoDB Streams only) The number of batches to process concurrently from each shard. The default value is 1.
- provisioned_
poller_ Eventconfig Source Mapping Provisioned Poller Config - (Amazon MSK and self-managed Apache Kafka only) The provisioned mode configuration for the event source. For more information, see provisioned mode.
- queues Sequence[str]
- (Amazon MQ) The name of the Amazon MQ broker destination queue to consume.
- scaling_
config EventSource Mapping Scaling Config - (Amazon SQS only) The scaling configuration for the event source. For more information, see Configuring maximum concurrency for Amazon SQS event sources.
- self_
managed_ Eventkafka_ event_ source_ config Source Mapping Self Managed Kafka Event Source Config - Specific configuration settings for a self-managed Apache Kafka event source.
- source_
access_ Sequence[Eventconfigurations Source Mapping Source Access Configuration] - An array of the authentication protocol, VPC components, or virtual host to secure and define your event source.
- Sequence[root_Tag]
- A list of tags to add to the event source mapping.
You must have the
lambda:TagResource
,lambda:UntagResource
, andlambda:ListTags
permissions for your principal to manage the CFN stack. If you don't have these permissions, there might be unexpected behavior with stack-level tags propagating to the resource during resource creation and update. - topics Sequence[str]
- The name of the Kafka topic.
- tumbling_
window_ intin_ seconds - (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.
- amazon
Managed Property MapKafka Event Source Config - Specific configuration settings for an Amazon Managed Streaming for Apache Kafka (Amazon MSK) event source.
- batch
Size Number - 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.
- bisect
Batch BooleanOn Function Error - (Kinesis and DynamoDB Streams only) If the function returns an error, split the batch in two and retry. The default value is false.
When using
BisectBatchOnFunctionError
, check theBatchSize
parameter in theOnFailure
destination message's metadata. TheBatchSize
could be greater than 1 since LAM consolidates failed messages metadata when writing to theOnFailure
destination. - destination
Config Property Map - (Kinesis, DynamoDB Streams, Amazon MSK, and self-managed Apache Kafka event sources only) A configuration object that specifies the destination of an event after Lambda processes it.
- document
Db Property MapEvent Source Config - Specific configuration settings for a DocumentDB event source.
- enabled Boolean
- When true, the event source mapping is active. When false, Lambda pauses polling and invocation. Default: True
- event
Source StringMapping Arn - The Amazon Resource Name (ARN) of the event source mapping.
- filter
Criteria Property Map - An object that defines the filter criteria that determine whether Lambda should process an event. For more information, see Lambda event filtering.
- function
Name 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.
- Function name –
- function
Response List<"ReportTypes Batch Item Failures"> - (Kinesis, DynamoDB Streams, and SQS) A list of current response type enums applied to the event source mapping.
Valid Values:
ReportBatchItemFailures
- id String
- The event source mapping's ID.
- kms
Key StringArn - The ARN of the KMSlong (KMS) customer managed key that Lambda uses to encrypt your function's filter criteria.
- maximum
Batching NumberWindow In Seconds - The maximum amount of time, in seconds, that Lambda spends gathering records before invoking the function.
Default (, , event sources): 0
Default (, Kafka, , event sources): 500 ms
Related setting: For SQS event sources, when you set
BatchSize
to a value greater than 10, you must setMaximumBatchingWindowInSeconds
to at least 1. - maximum
Record NumberAge In Seconds - (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 NumberAttempts - (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.
- metrics
Config Property Map - The metrics configuration for your event source. For more information, see Event source mapping metrics.
- parallelization
Factor Number - (Kinesis and DynamoDB Streams only) The number of batches to process concurrently from each shard. The default value is 1.
- provisioned
Poller Property MapConfig - (Amazon MSK and self-managed Apache Kafka only) The provisioned mode configuration for the event source. For more information, see provisioned mode.
- queues List<String>
- (Amazon MQ) The name of the Amazon MQ broker destination queue to consume.
- scaling
Config Property Map - (Amazon SQS only) The scaling configuration for the event source. For more information, see Configuring maximum concurrency for Amazon SQS event sources.
- self
Managed Property MapKafka Event Source Config - Specific configuration settings for a self-managed Apache Kafka event source.
- source
Access List<Property Map>Configurations - An array of the authentication protocol, VPC components, or virtual host to secure and define your event source.
- List<Property Map>
- A list of tags to add to the event source mapping.
You must have the
lambda:TagResource
,lambda:UntagResource
, andlambda:ListTags
permissions for your principal to manage the CFN stack. If you don't have these permissions, there might be unexpected behavior with stack-level tags propagating to the resource during resource creation and update. - topics List<String>
- The name of the Kafka topic.
- tumbling
Window NumberIn Seconds - (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.
Supporting Types
EventSourceMappingAmazonManagedKafkaEventSourceConfig
- Consumer
Group stringId - 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.
- Schema
Registry Pulumi.Config Aws Native. Lambda. Inputs. Event Source Mapping Schema Registry Config - Specific configuration settings for a Kafka schema registry.
- Consumer
Group stringId - 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.
- Schema
Registry EventConfig Source Mapping Schema Registry Config - Specific configuration settings for a Kafka schema registry.
- consumer
Group StringId - 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.
- schema
Registry EventConfig Source Mapping Schema Registry Config - Specific configuration settings for a Kafka schema registry.
- consumer
Group stringId - 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.
- schema
Registry EventConfig Source Mapping Schema Registry Config - Specific configuration settings for a Kafka schema registry.
- consumer_
group_ strid - 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.
- schema_
registry_ Eventconfig Source Mapping Schema Registry Config - Specific configuration settings for a Kafka schema registry.
- consumer
Group StringId - 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.
- schema
Registry Property MapConfig - Specific configuration settings for a Kafka schema registry.
EventSourceMappingDestinationConfig
- On
Failure Pulumi.Aws Native. Lambda. Inputs. Event Source Mapping On Failure - The destination configuration for failed invocations.
- On
Failure EventSource Mapping On Failure - The destination configuration for failed invocations.
- on
Failure EventSource Mapping On Failure - The destination configuration for failed invocations.
- on
Failure EventSource Mapping On Failure - The destination configuration for failed invocations.
- on_
failure EventSource Mapping On Failure - The destination configuration for failed invocations.
- on
Failure Property Map - The destination configuration for failed invocations.
EventSourceMappingDocumentDbEventSourceConfig
- Collection
Name string - The name of the collection to consume within the database. If you do not specify a collection, Lambda consumes all collections.
- Database
Name string - The name of the database to consume within the DocumentDB cluster.
- Full
Document Pulumi.Aws Native. Lambda. Event Source Mapping Document Db Event Source Config Full Document - 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.
- Collection
Name string - The name of the collection to consume within the database. If you do not specify a collection, Lambda consumes all collections.
- Database
Name string - The name of the database to consume within the DocumentDB cluster.
- Full
Document EventSource Mapping Document Db Event Source Config Full Document - 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.
- collection
Name String - The name of the collection to consume within the database. If you do not specify a collection, Lambda consumes all collections.
- database
Name String - The name of the database to consume within the DocumentDB cluster.
- full
Document EventSource Mapping Document Db Event Source Config Full Document - 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.
- collection
Name string - The name of the collection to consume within the database. If you do not specify a collection, Lambda consumes all collections.
- database
Name string - The name of the database to consume within the DocumentDB cluster.
- full
Document EventSource Mapping Document Db Event Source Config Full Document - 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.
- collection_
name str - The name of the collection to consume within the database. If you do not specify a collection, Lambda consumes all collections.
- database_
name str - The name of the database to consume within the DocumentDB cluster.
- full_
document EventSource Mapping Document Db Event Source Config Full Document - 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.
- collection
Name String - The name of the collection to consume within the database. If you do not specify a collection, Lambda consumes all collections.
- database
Name String - The name of the database to consume within the DocumentDB cluster.
- full
Document "UpdateLookup" | "Default" - 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.
EventSourceMappingDocumentDbEventSourceConfigFullDocument
EventSourceMappingFilter
- Pattern string
- A filter pattern. For more information on the syntax of a filter pattern, see Filter rule syntax.
- Pattern string
- A filter pattern. For more information on the syntax of a filter pattern, see Filter rule syntax.
- pattern String
- A filter pattern. For more information on the syntax of a filter pattern, see Filter rule syntax.
- pattern string
- A filter pattern. For more information on the syntax of a filter pattern, see Filter rule syntax.
- pattern str
- A filter pattern. For more information on the syntax of a filter pattern, see Filter rule syntax.
- pattern String
- A filter pattern. For more information on the syntax of a filter pattern, see Filter rule syntax.
EventSourceMappingFilterCriteria
- Filters
List<Pulumi.
Aws Native. Lambda. Inputs. Event Source Mapping Filter> - A list of filters.
- Filters
[]Event
Source Mapping Filter - A list of filters.
- filters
List<Event
Source Mapping Filter> - A list of filters.
- filters
Event
Source Mapping Filter[] - A list of filters.
- filters
Sequence[Event
Source Mapping Filter] - A list of filters.
- filters List<Property Map>
- A list of filters.
EventSourceMappingFunctionResponseTypesItem
EventSourceMappingMetricsConfig
- Metrics
List<Pulumi.
Aws Native. Lambda. Event Source Mapping Metrics Config Metrics Item> - The metrics you want your event source mapping to produce. Include
EventCount
to receive event source mapping metrics related to the number of events processed by your event source mapping. For more information about these metrics, see Event source mapping metrics.
- Metrics
[]Event
Source Mapping Metrics Config Metrics Item - The metrics you want your event source mapping to produce. Include
EventCount
to receive event source mapping metrics related to the number of events processed by your event source mapping. For more information about these metrics, see Event source mapping metrics.
- metrics
List<Event
Source Mapping Metrics Config Metrics Item> - The metrics you want your event source mapping to produce. Include
EventCount
to receive event source mapping metrics related to the number of events processed by your event source mapping. For more information about these metrics, see Event source mapping metrics.
- metrics
Event
Source Mapping Metrics Config Metrics Item[] - The metrics you want your event source mapping to produce. Include
EventCount
to receive event source mapping metrics related to the number of events processed by your event source mapping. For more information about these metrics, see Event source mapping metrics.
- metrics
Sequence[Event
Source Mapping Metrics Config Metrics Item] - The metrics you want your event source mapping to produce. Include
EventCount
to receive event source mapping metrics related to the number of events processed by your event source mapping. For more information about these metrics, see Event source mapping metrics.
- metrics
List<"Event
Count"> - The metrics you want your event source mapping to produce. Include
EventCount
to receive event source mapping metrics related to the number of events processed by your event source mapping. For more information about these metrics, see Event source mapping metrics.
EventSourceMappingMetricsConfigMetricsItem
EventSourceMappingOnFailure
- Destination string
- The Amazon Resource Name (ARN) of the destination resource. To retain records of unsuccessful asynchronous invocations, you can configure an Amazon SNS topic, Amazon SQS queue, Amazon S3 bucket, Lambda function, or Amazon EventBridge event bus as the destination. To retain records of failed invocations from Kinesis, DynamoDB, self-managed Kafka or Amazon MSK, you can configure an Amazon SNS topic, Amazon SQS queue, or Amazon S3 bucket as the destination.
- Destination string
- The Amazon Resource Name (ARN) of the destination resource. To retain records of unsuccessful asynchronous invocations, you can configure an Amazon SNS topic, Amazon SQS queue, Amazon S3 bucket, Lambda function, or Amazon EventBridge event bus as the destination. To retain records of failed invocations from Kinesis, DynamoDB, self-managed Kafka or Amazon MSK, you can configure an Amazon SNS topic, Amazon SQS queue, or Amazon S3 bucket as the destination.
- destination String
- The Amazon Resource Name (ARN) of the destination resource. To retain records of unsuccessful asynchronous invocations, you can configure an Amazon SNS topic, Amazon SQS queue, Amazon S3 bucket, Lambda function, or Amazon EventBridge event bus as the destination. To retain records of failed invocations from Kinesis, DynamoDB, self-managed Kafka or Amazon MSK, you can configure an Amazon SNS topic, Amazon SQS queue, or Amazon S3 bucket as the destination.
- destination string
- The Amazon Resource Name (ARN) of the destination resource. To retain records of unsuccessful asynchronous invocations, you can configure an Amazon SNS topic, Amazon SQS queue, Amazon S3 bucket, Lambda function, or Amazon EventBridge event bus as the destination. To retain records of failed invocations from Kinesis, DynamoDB, self-managed Kafka or Amazon MSK, you can configure an Amazon SNS topic, Amazon SQS queue, or Amazon S3 bucket as the destination.
- destination str
- The Amazon Resource Name (ARN) of the destination resource. To retain records of unsuccessful asynchronous invocations, you can configure an Amazon SNS topic, Amazon SQS queue, Amazon S3 bucket, Lambda function, or Amazon EventBridge event bus as the destination. To retain records of failed invocations from Kinesis, DynamoDB, self-managed Kafka or Amazon MSK, you can configure an Amazon SNS topic, Amazon SQS queue, or Amazon S3 bucket as the destination.
- destination String
- The Amazon Resource Name (ARN) of the destination resource. To retain records of unsuccessful asynchronous invocations, you can configure an Amazon SNS topic, Amazon SQS queue, Amazon S3 bucket, Lambda function, or Amazon EventBridge event bus as the destination. To retain records of failed invocations from Kinesis, DynamoDB, self-managed Kafka or Amazon MSK, you can configure an Amazon SNS topic, Amazon SQS queue, or Amazon S3 bucket as the destination.
EventSourceMappingProvisionedPollerConfig
- Maximum
Pollers int - The maximum number of event pollers this event source can scale up to.
- Minimum
Pollers int - The minimum number of event pollers this event source can scale down to.
- Maximum
Pollers int - The maximum number of event pollers this event source can scale up to.
- Minimum
Pollers int - The minimum number of event pollers this event source can scale down to.
- maximum
Pollers Integer - The maximum number of event pollers this event source can scale up to.
- minimum
Pollers Integer - The minimum number of event pollers this event source can scale down to.
- maximum
Pollers number - The maximum number of event pollers this event source can scale up to.
- minimum
Pollers number - The minimum number of event pollers this event source can scale down to.
- maximum_
pollers int - The maximum number of event pollers this event source can scale up to.
- minimum_
pollers int - The minimum number of event pollers this event source can scale down to.
- maximum
Pollers Number - The maximum number of event pollers this event source can scale up to.
- minimum
Pollers Number - The minimum number of event pollers this event source can scale down to.
EventSourceMappingScalingConfig
- Maximum
Concurrency int - Limits the number of concurrent instances that the SQS event source can invoke.
- Maximum
Concurrency int - Limits the number of concurrent instances that the SQS event source can invoke.
- maximum
Concurrency Integer - Limits the number of concurrent instances that the SQS event source can invoke.
- maximum
Concurrency number - Limits the number of concurrent instances that the SQS event source can invoke.
- maximum_
concurrency int - Limits the number of concurrent instances that the SQS event source can invoke.
- maximum
Concurrency Number - Limits the number of concurrent instances that the SQS event source can invoke.
EventSourceMappingSchemaRegistryAccessConfig
- Type
Pulumi.
Aws Native. Lambda. Event Source Mapping Schema Registry Access Config Type - The type of authentication Lambda uses to access your schema registry.
- Uri string
- The URI of the secret (Secrets Manager secret ARN) to authenticate with your schema registry.
- Type
Event
Source Mapping Schema Registry Access Config Type - The type of authentication Lambda uses to access your schema registry.
- Uri string
- The URI of the secret (Secrets Manager secret ARN) to authenticate with your schema registry.
- type
Event
Source Mapping Schema Registry Access Config Type - The type of authentication Lambda uses to access your schema registry.
- uri String
- The URI of the secret (Secrets Manager secret ARN) to authenticate with your schema registry.
- type
Event
Source Mapping Schema Registry Access Config Type - The type of authentication Lambda uses to access your schema registry.
- uri string
- The URI of the secret (Secrets Manager secret ARN) to authenticate with your schema registry.
- type
Event
Source Mapping Schema Registry Access Config Type - The type of authentication Lambda uses to access your schema registry.
- uri str
- The URI of the secret (Secrets Manager secret ARN) to authenticate with your schema registry.
- type "BASIC_AUTH" | "CLIENT_CERTIFICATE_TLS_AUTH" | "SERVER_ROOT_CA_CERTIFICATE"
- The type of authentication Lambda uses to access your schema registry.
- uri String
- The URI of the secret (Secrets Manager secret ARN) to authenticate with your schema registry.
EventSourceMappingSchemaRegistryAccessConfigType
EventSourceMappingSchemaRegistryConfig
- Access
Configs List<Pulumi.Aws Native. Lambda. Inputs. Event Source Mapping Schema Registry Access Config> - An array of access configuration objects that tell Lambda how to authenticate with your schema registry.
- Event
Record Pulumi.Format Aws Native. Lambda. Event Source Mapping Schema Registry Config Event Record Format - The record format that Lambda delivers to your function after schema validation.
- Choose
JSON
to have Lambda deliver the record to your function as a standard JSON object. - Choose
SOURCE
to have Lambda deliver the record to your function in its original source format. Lambda removes all schema metadata, such as the schema ID, before sending the record to your function.
- Choose
- Schema
Registry stringUri - The URI for your schema registry. The correct URI format depends on the type of schema registry you're using.
- For AWS Glue schema registries, use the ARN of the registry.
- For Confluent schema registries, use the URL of the registry.
- Schema
Validation List<Pulumi.Configs Aws Native. Lambda. Inputs. Event Source Mapping Schema Validation Config> - An array of schema validation configuration objects, which tell Lambda the message attributes you want to validate and filter using your schema registry.
- Access
Configs []EventSource Mapping Schema Registry Access Config - An array of access configuration objects that tell Lambda how to authenticate with your schema registry.
- Event
Record EventFormat Source Mapping Schema Registry Config Event Record Format - The record format that Lambda delivers to your function after schema validation.
- Choose
JSON
to have Lambda deliver the record to your function as a standard JSON object. - Choose
SOURCE
to have Lambda deliver the record to your function in its original source format. Lambda removes all schema metadata, such as the schema ID, before sending the record to your function.
- Choose
- Schema
Registry stringUri - The URI for your schema registry. The correct URI format depends on the type of schema registry you're using.
- For AWS Glue schema registries, use the ARN of the registry.
- For Confluent schema registries, use the URL of the registry.
- Schema
Validation []EventConfigs Source Mapping Schema Validation Config - An array of schema validation configuration objects, which tell Lambda the message attributes you want to validate and filter using your schema registry.
- access
Configs List<EventSource Mapping Schema Registry Access Config> - An array of access configuration objects that tell Lambda how to authenticate with your schema registry.
- event
Record EventFormat Source Mapping Schema Registry Config Event Record Format - The record format that Lambda delivers to your function after schema validation.
- Choose
JSON
to have Lambda deliver the record to your function as a standard JSON object. - Choose
SOURCE
to have Lambda deliver the record to your function in its original source format. Lambda removes all schema metadata, such as the schema ID, before sending the record to your function.
- Choose
- schema
Registry StringUri - The URI for your schema registry. The correct URI format depends on the type of schema registry you're using.
- For AWS Glue schema registries, use the ARN of the registry.
- For Confluent schema registries, use the URL of the registry.
- schema
Validation List<EventConfigs Source Mapping Schema Validation Config> - An array of schema validation configuration objects, which tell Lambda the message attributes you want to validate and filter using your schema registry.
- access
Configs EventSource Mapping Schema Registry Access Config[] - An array of access configuration objects that tell Lambda how to authenticate with your schema registry.
- event
Record EventFormat Source Mapping Schema Registry Config Event Record Format - The record format that Lambda delivers to your function after schema validation.
- Choose
JSON
to have Lambda deliver the record to your function as a standard JSON object. - Choose
SOURCE
to have Lambda deliver the record to your function in its original source format. Lambda removes all schema metadata, such as the schema ID, before sending the record to your function.
- Choose
- schema
Registry stringUri - The URI for your schema registry. The correct URI format depends on the type of schema registry you're using.
- For AWS Glue schema registries, use the ARN of the registry.
- For Confluent schema registries, use the URL of the registry.
- schema
Validation EventConfigs Source Mapping Schema Validation Config[] - An array of schema validation configuration objects, which tell Lambda the message attributes you want to validate and filter using your schema registry.
- access_
configs Sequence[EventSource Mapping Schema Registry Access Config] - An array of access configuration objects that tell Lambda how to authenticate with your schema registry.
- event_
record_ Eventformat Source Mapping Schema Registry Config Event Record Format - The record format that Lambda delivers to your function after schema validation.
- Choose
JSON
to have Lambda deliver the record to your function as a standard JSON object. - Choose
SOURCE
to have Lambda deliver the record to your function in its original source format. Lambda removes all schema metadata, such as the schema ID, before sending the record to your function.
- Choose
- schema_
registry_ struri - The URI for your schema registry. The correct URI format depends on the type of schema registry you're using.
- For AWS Glue schema registries, use the ARN of the registry.
- For Confluent schema registries, use the URL of the registry.
- schema_
validation_ Sequence[Eventconfigs Source Mapping Schema Validation Config] - An array of schema validation configuration objects, which tell Lambda the message attributes you want to validate and filter using your schema registry.
- access
Configs List<Property Map> - An array of access configuration objects that tell Lambda how to authenticate with your schema registry.
- event
Record "JSON" | "SOURCE"Format - The record format that Lambda delivers to your function after schema validation.
- Choose
JSON
to have Lambda deliver the record to your function as a standard JSON object. - Choose
SOURCE
to have Lambda deliver the record to your function in its original source format. Lambda removes all schema metadata, such as the schema ID, before sending the record to your function.
- Choose
- schema
Registry StringUri - The URI for your schema registry. The correct URI format depends on the type of schema registry you're using.
- For AWS Glue schema registries, use the ARN of the registry.
- For Confluent schema registries, use the URL of the registry.
- schema
Validation List<Property Map>Configs - An array of schema validation configuration objects, which tell Lambda the message attributes you want to validate and filter using your schema registry.
EventSourceMappingSchemaRegistryConfigEventRecordFormat
EventSourceMappingSchemaValidationConfig
- Attribute
Pulumi.
Aws Native. Lambda. Event Source Mapping Schema Validation Config Attribute - The attributes you want your schema registry to validate and filter for. If you selected
JSON
as theEventRecordFormat
, Lambda also deserializes the selected message attributes.
- Attribute
Event
Source Mapping Schema Validation Config Attribute - The attributes you want your schema registry to validate and filter for. If you selected
JSON
as theEventRecordFormat
, Lambda also deserializes the selected message attributes.
- attribute
Event
Source Mapping Schema Validation Config Attribute - The attributes you want your schema registry to validate and filter for. If you selected
JSON
as theEventRecordFormat
, Lambda also deserializes the selected message attributes.
- attribute
Event
Source Mapping Schema Validation Config Attribute - The attributes you want your schema registry to validate and filter for. If you selected
JSON
as theEventRecordFormat
, Lambda also deserializes the selected message attributes.
- attribute
Event
Source Mapping Schema Validation Config Attribute - The attributes you want your schema registry to validate and filter for. If you selected
JSON
as theEventRecordFormat
, Lambda also deserializes the selected message attributes.
- attribute "KEY" | "VALUE"
- The attributes you want your schema registry to validate and filter for. If you selected
JSON
as theEventRecordFormat
, Lambda also deserializes the selected message attributes.
EventSourceMappingSchemaValidationConfigAttribute
EventSourceMappingSelfManagedKafkaEventSourceConfig
- Consumer
Group stringId - 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.
- Schema
Registry Pulumi.Config Aws Native. Lambda. Inputs. Event Source Mapping Schema Registry Config - Specific configuration settings for a Kafka schema registry.
- Consumer
Group stringId - 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.
- Schema
Registry EventConfig Source Mapping Schema Registry Config - Specific configuration settings for a Kafka schema registry.
- consumer
Group StringId - 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.
- schema
Registry EventConfig Source Mapping Schema Registry Config - Specific configuration settings for a Kafka schema registry.
- consumer
Group stringId - 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.
- schema
Registry EventConfig Source Mapping Schema Registry Config - Specific configuration settings for a Kafka schema registry.
- consumer_
group_ strid - 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.
- schema_
registry_ Eventconfig Source Mapping Schema Registry Config - Specific configuration settings for a Kafka schema registry.
- consumer
Group StringId - 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.
- schema
Registry Property MapConfig - Specific configuration settings for a Kafka schema registry.
EventSourceMappingSourceAccessConfiguration
- Type
Pulumi.
Aws Native. Lambda. Event Source Mapping Source Access Configuration Type - 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 ASMlong 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 string
- The value for your chosen configuration in
Type
. For example:"URI": "arn:aws:secretsmanager:us-east-1:01234567890:secret:MyBrokerSecretName"
.
- Type
Event
Source Mapping Source Access Configuration Type - 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 ASMlong 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 string
- The value for your chosen configuration in
Type
. For example:"URI": "arn:aws:secretsmanager:us-east-1:01234567890:secret:MyBrokerSecretName"
.
- type
Event
Source Mapping Source Access Configuration Type - 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 ASMlong 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 String
- The value for your chosen configuration in
Type
. For example:"URI": "arn:aws:secretsmanager:us-east-1:01234567890:secret:MyBrokerSecretName"
.
- type
Event
Source Mapping Source Access Configuration Type - 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 ASMlong 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 string
- The value for your chosen configuration in
Type
. For example:"URI": "arn:aws:secretsmanager:us-east-1:01234567890:secret:MyBrokerSecretName"
.
- type
Event
Source Mapping Source Access Configuration Type - 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 ASMlong 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 str
- The value for your chosen configuration in
Type
. For example:"URI": "arn:aws:secretsmanager:us-east-1:01234567890:secret:MyBrokerSecretName"
.
- type "BASIC_AUTH" | "VPC_SUBNET" | "VPC_SECURITY_GROUP" | "SASL_SCRAM_512_AUTH" | "SASL_SCRAM_256_AUTH" | "VIRTUAL_HOST" | "CLIENT_CERTIFICATE_TLS_AUTH" | "SERVER_ROOT_CA_CERTIFICATE"
- 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 ASMlong 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 String
- The value for your chosen configuration in
Type
. For example:"URI": "arn:aws:secretsmanager:us-east-1:01234567890:secret:MyBrokerSecretName"
.
EventSourceMappingSourceAccessConfigurationType
Tag
Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0
We recommend new projects start with resources from the AWS provider.