Docs Packages
  1. Packages
  2. AWS Native
  3. API Docs
  4. lambda
  5. getEventSourceMapping

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.112.0 published on Wednesday, Jul 24, 2024 by Pulumi
pulumi/pulumi-aws-native

aws-native.lambda.getEventSourceMapping

Explore with Pulumi AI

aws-native logo

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.112.0 published on Wednesday, Jul 24, 2024 by Pulumi
pulumi/pulumi-aws-native

    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.

    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)
// Output-based functions aren't available in Java yet

    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:

    BatchSize 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.
    BisectBatchOnFunctionError bool
    (Kinesis and DynamoDB Streams only) If the function returns an error, split the batch in two and retry. The default value is false.
    DestinationConfig Pulumi.AwsNative.Lambda.Outputs.EventSourceMappingDestinationConfig
    (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.
    DocumentDbEventSourceConfig Pulumi.AwsNative.Lambda.Outputs.EventSourceMappingDocumentDbEventSourceConfig
    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
    FilterCriteria Pulumi.AwsNative.Lambda.Outputs.EventSourceMappingFilterCriteria
    An object that defines the filter criteria that determine whether Lambda should process an event. For more information, see Lambda event filtering.
    FunctionName 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.

    FunctionResponseTypes List<Pulumi.AwsNative.Lambda.EventSourceMappingFunctionResponseTypesItem>
    (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.
    MaximumBatchingWindowInSeconds int
    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 set MaximumBatchingWindowInSeconds to at least 1.
    MaximumRecordAgeInSeconds int
    (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
    MaximumRetryAttempts int
    (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.
    ParallelizationFactor int
    (Kinesis and DynamoDB Streams only) The number of batches to process concurrently from each shard. The default value is 1.
    Queues List<string>
    (Amazon MQ) The name of the Amazon MQ broker destination queue to consume.
    ScalingConfig Pulumi.AwsNative.Lambda.Outputs.EventSourceMappingScalingConfig
    (Amazon SQS only) The scaling configuration for the event source. For more information, see Configuring maximum concurrency for Amazon SQS event sources.
    SourceAccessConfigurations List<Pulumi.AwsNative.Lambda.Outputs.EventSourceMappingSourceAccessConfiguration>
    An array of the authentication protocol, VPC components, or virtual host to secure and define your event source.
    Topics List<string>
    The name of the Kafka topic.
    TumblingWindowInSeconds int
    (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.
    BatchSize 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.
    BisectBatchOnFunctionError bool
    (Kinesis and DynamoDB Streams only) If the function returns an error, split the batch in two and retry. The default value is false.
    DestinationConfig EventSourceMappingDestinationConfig
    (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.
    DocumentDbEventSourceConfig EventSourceMappingDocumentDbEventSourceConfig
    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
    FilterCriteria EventSourceMappingFilterCriteria
    An object that defines the filter criteria that determine whether Lambda should process an event. For more information, see Lambda event filtering.
    FunctionName 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.

    FunctionResponseTypes []EventSourceMappingFunctionResponseTypesItem
    (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.
    MaximumBatchingWindowInSeconds int
    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 set MaximumBatchingWindowInSeconds to at least 1.
    MaximumRecordAgeInSeconds int
    (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
    MaximumRetryAttempts int
    (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.
    ParallelizationFactor int
    (Kinesis and DynamoDB Streams only) The number of batches to process concurrently from each shard. The default value is 1.
    Queues []string
    (Amazon MQ) The name of the Amazon MQ broker destination queue to consume.
    ScalingConfig EventSourceMappingScalingConfig
    (Amazon SQS only) The scaling configuration for the event source. For more information, see Configuring maximum concurrency for Amazon SQS event sources.
    SourceAccessConfigurations []EventSourceMappingSourceAccessConfiguration
    An array of the authentication protocol, VPC components, or virtual host to secure and define your event source.
    Topics []string
    The name of the Kafka topic.
    TumblingWindowInSeconds int
    (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.
    batchSize Integer
    The maximum number of records in each batch that Lambda pulls from your stream or queue and sends to your function. Lambda passes all of the records in the batch to the function in a single call, up to the payload limit for synchronous invocation (6 MB).

    • Amazon Kinesis – Default 100. Max 10,000.
    • Amazon DynamoDB Streams – Default 100. Max 10,000.
    • Amazon Simple Queue Service – Default 10. For standard queues the max is 10,000. For FIFO queues the max is 10.
    • Amazon Managed Streaming for Apache Kafka – Default 100. Max 10,000.
    • Self-managed Apache Kafka – Default 100. Max 10,000.
    • Amazon MQ (ActiveMQ and RabbitMQ) – Default 100. Max 10,000.
    • DocumentDB – Default 100. Max 10,000.
    bisectBatchOnFunctionError Boolean
    (Kinesis and DynamoDB Streams only) If the function returns an error, split the batch in two and retry. The default value is false.
    destinationConfig EventSourceMappingDestinationConfig
    (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.
    documentDbEventSourceConfig EventSourceMappingDocumentDbEventSourceConfig
    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
    filterCriteria EventSourceMappingFilterCriteria
    An object that defines the filter criteria that determine whether Lambda should process an event. For more information, see Lambda event filtering.
    functionName 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.

    functionResponseTypes List<EventSourceMappingFunctionResponseTypesItem>
    (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.
    maximumBatchingWindowInSeconds Integer
    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 set MaximumBatchingWindowInSeconds to at least 1.
    maximumRecordAgeInSeconds Integer
    (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
    maximumRetryAttempts Integer
    (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.
    parallelizationFactor Integer
    (Kinesis and DynamoDB Streams only) The number of batches to process concurrently from each shard. The default value is 1.
    queues List<String>
    (Amazon MQ) The name of the Amazon MQ broker destination queue to consume.
    scalingConfig EventSourceMappingScalingConfig
    (Amazon SQS only) The scaling configuration for the event source. For more information, see Configuring maximum concurrency for Amazon SQS event sources.
    sourceAccessConfigurations List<EventSourceMappingSourceAccessConfiguration>
    An array of the authentication protocol, VPC components, or virtual host to secure and define your event source.
    topics List<String>
    The name of the Kafka topic.
    tumblingWindowInSeconds Integer
    (Kinesis and DynamoDB Streams only) The duration in seconds of a processing window for DynamoDB and Kinesis Streams event sources. A value of 0 seconds indicates no tumbling window.
    batchSize 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.
    bisectBatchOnFunctionError boolean
    (Kinesis and DynamoDB Streams only) If the function returns an error, split the batch in two and retry. The default value is false.
    destinationConfig EventSourceMappingDestinationConfig
    (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.
    documentDbEventSourceConfig EventSourceMappingDocumentDbEventSourceConfig
    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
    filterCriteria EventSourceMappingFilterCriteria
    An object that defines the filter criteria that determine whether Lambda should process an event. For more information, see Lambda event filtering.
    functionName 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.

    functionResponseTypes EventSourceMappingFunctionResponseTypesItem[]
    (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.
    maximumBatchingWindowInSeconds number
    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 set MaximumBatchingWindowInSeconds to at least 1.
    maximumRecordAgeInSeconds number
    (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
    maximumRetryAttempts number
    (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.
    parallelizationFactor number
    (Kinesis and DynamoDB Streams only) The number of batches to process concurrently from each shard. The default value is 1.
    queues string[]
    (Amazon MQ) The name of the Amazon MQ broker destination queue to consume.
    scalingConfig EventSourceMappingScalingConfig
    (Amazon SQS only) The scaling configuration for the event source. For more information, see Configuring maximum concurrency for Amazon SQS event sources.
    sourceAccessConfigurations EventSourceMappingSourceAccessConfiguration[]
    An array of the authentication protocol, VPC components, or virtual host to secure and define your event source.
    topics string[]
    The name of the Kafka topic.
    tumblingWindowInSeconds number
    (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.
    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_on_function_error bool
    (Kinesis and DynamoDB Streams only) If the function returns an error, split the batch in two and retry. The default value is false.
    destination_config lambda_.EventSourceMappingDestinationConfig
    (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_event_source_config lambda_.EventSourceMappingDocumentDbEventSourceConfig
    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
    filter_criteria lambda_.EventSourceMappingFilterCriteria
    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_response_types Sequence[lambda_.EventSourceMappingFunctionResponseTypesItem]
    (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.
    maximum_batching_window_in_seconds int
    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 set MaximumBatchingWindowInSeconds to at least 1.
    maximum_record_age_in_seconds int
    (Kinesis and DynamoDB Streams only) Discard records older than the specified age. The default value is -1, which sets the maximum age to infinite. When the value is set to infinite, Lambda never discards old records. The minimum valid value for maximum record age is 60s. Although values less than 60 and greater than -1 fall within the parameter's absolute range, they are not allowed
    maximum_retry_attempts int
    (Kinesis and DynamoDB Streams only) Discard records after the specified number of retries. The default value is -1, which sets the maximum number of retries to infinite. When MaximumRetryAttempts is infinite, Lambda retries failed records until the record expires in the event source.
    parallelization_factor int
    (Kinesis and DynamoDB Streams only) The number of batches to process concurrently from each shard. The default value is 1.
    queues Sequence[str]
    (Amazon MQ) The name of the Amazon MQ broker destination queue to consume.
    scaling_config lambda_.EventSourceMappingScalingConfig
    (Amazon SQS only) The scaling configuration for the event source. For more information, see Configuring maximum concurrency for Amazon SQS event sources.
    source_access_configurations Sequence[lambda_.EventSourceMappingSourceAccessConfiguration]
    An array of the authentication protocol, VPC components, or virtual host to secure and define your event source.
    topics Sequence[str]
    The name of the Kafka topic.
    tumbling_window_in_seconds int
    (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.
    batchSize 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.
    bisectBatchOnFunctionError Boolean
    (Kinesis and DynamoDB Streams only) If the function returns an error, split the batch in two and retry. The default value is false.
    destinationConfig 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.
    documentDbEventSourceConfig Property Map
    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
    filterCriteria Property Map
    An object that defines the filter criteria that determine whether Lambda should process an event. For more information, see Lambda event filtering.
    functionName 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.

    functionResponseTypes List<"ReportBatchItemFailures">
    (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.
    maximumBatchingWindowInSeconds Number
    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 set MaximumBatchingWindowInSeconds to at least 1.
    maximumRecordAgeInSeconds Number
    (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
    maximumRetryAttempts Number
    (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.
    parallelizationFactor Number
    (Kinesis and DynamoDB Streams only) The number of batches to process concurrently from each shard. The default value is 1.
    queues List<String>
    (Amazon MQ) The name of the Amazon MQ broker destination queue to consume.
    scalingConfig Property Map
    (Amazon SQS only) The scaling configuration for the event source. For more information, see Configuring maximum concurrency for Amazon SQS event sources.
    sourceAccessConfigurations List<Property Map>
    An array of the authentication protocol, VPC components, or virtual host to secure and define your event source.
    topics List<String>
    The name of the Kafka topic.
    tumblingWindowInSeconds Number
    (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

    EventSourceMappingDestinationConfig

    OnFailure Pulumi.AwsNative.Lambda.Inputs.EventSourceMappingOnFailure
    The destination configuration for failed invocations.
    OnFailure EventSourceMappingOnFailure
    The destination configuration for failed invocations.
    onFailure EventSourceMappingOnFailure
    The destination configuration for failed invocations.
    onFailure EventSourceMappingOnFailure
    The destination configuration for failed invocations.
    on_failure lambda_.EventSourceMappingOnFailure
    The destination configuration for failed invocations.
    onFailure Property Map
    The destination configuration for failed invocations.

    EventSourceMappingDocumentDbEventSourceConfig

    CollectionName string
    The name of the collection to consume within the database. If you do not specify a collection, Lambda consumes all collections.
    DatabaseName string
    The name of the database to consume within the DocumentDB cluster.
    FullDocument Pulumi.AwsNative.Lambda.EventSourceMappingDocumentDbEventSourceConfigFullDocument
    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.
    CollectionName string
    The name of the collection to consume within the database. If you do not specify a collection, Lambda consumes all collections.
    DatabaseName string
    The name of the database to consume within the DocumentDB cluster.
    FullDocument EventSourceMappingDocumentDbEventSourceConfigFullDocument
    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.
    collectionName String
    The name of the collection to consume within the database. If you do not specify a collection, Lambda consumes all collections.
    databaseName String
    The name of the database to consume within the DocumentDB cluster.
    fullDocument EventSourceMappingDocumentDbEventSourceConfigFullDocument
    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.
    collectionName string
    The name of the collection to consume within the database. If you do not specify a collection, Lambda consumes all collections.
    databaseName string
    The name of the database to consume within the DocumentDB cluster.
    fullDocument EventSourceMappingDocumentDbEventSourceConfigFullDocument
    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 lambda_.EventSourceMappingDocumentDbEventSourceConfigFullDocument
    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.
    collectionName String
    The name of the collection to consume within the database. If you do not specify a collection, Lambda consumes all collections.
    databaseName String
    The name of the database to consume within the DocumentDB cluster.
    fullDocument "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<Property Map>
    A list of filters.

    EventSourceMappingFunctionResponseTypesItem

    EventSourceMappingOnFailure

    Destination string
    The Amazon Resource Name (ARN) of the destination resource. To retain records of asynchronous invocations, you can configure an Amazon SNS topic, Amazon SQS queue, Lambda function, or Amazon EventBridge event bus as the destination. To retain records of failed invocations from Kinesis and DynamoDB event sources, you can configure an Amazon SNS topic or Amazon SQS queue as the destination. To retain records of failed invocations from 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 asynchronous invocations, you can configure an Amazon SNS topic, Amazon SQS queue, Lambda function, or Amazon EventBridge event bus as the destination. To retain records of failed invocations from Kinesis and DynamoDB event sources, you can configure an Amazon SNS topic or Amazon SQS queue as the destination. To retain records of failed invocations from 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 asynchronous invocations, you can configure an Amazon SNS topic, Amazon SQS queue, Lambda function, or Amazon EventBridge event bus as the destination. To retain records of failed invocations from Kinesis and DynamoDB event sources, you can configure an Amazon SNS topic or Amazon SQS queue as the destination. To retain records of failed invocations from 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 asynchronous invocations, you can configure an Amazon SNS topic, Amazon SQS queue, Lambda function, or Amazon EventBridge event bus as the destination. To retain records of failed invocations from Kinesis and DynamoDB event sources, you can configure an Amazon SNS topic or Amazon SQS queue as the destination. To retain records of failed invocations from 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 asynchronous invocations, you can configure an Amazon SNS topic, Amazon SQS queue, Lambda function, or Amazon EventBridge event bus as the destination. To retain records of failed invocations from Kinesis and DynamoDB event sources, you can configure an Amazon SNS topic or Amazon SQS queue as the destination. To retain records of failed invocations from 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 asynchronous invocations, you can configure an Amazon SNS topic, Amazon SQS queue, Lambda function, or Amazon EventBridge event bus as the destination. To retain records of failed invocations from Kinesis and DynamoDB event sources, you can configure an Amazon SNS topic or Amazon SQS queue as the destination. To retain records of failed invocations from self-managed Kafka or Amazon MSK, you can configure an Amazon SNS topic, Amazon SQS queue, or Amazon S3 bucket as the destination.

    EventSourceMappingScalingConfig

    MaximumConcurrency int
    Limits the number of concurrent instances that the SQS event source can invoke.
    MaximumConcurrency int
    Limits the number of concurrent instances that the SQS event source can invoke.
    maximumConcurrency Integer
    Limits the number of concurrent instances that the SQS event source can invoke.
    maximumConcurrency 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.
    maximumConcurrency Number
    Limits the number of concurrent instances that the SQS event source can invoke.

    EventSourceMappingSourceAccessConfiguration

    Type Pulumi.AwsNative.Lambda.EventSourceMappingSourceAccessConfigurationType
    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 EventSourceMappingSourceAccessConfigurationType
    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 EventSourceMappingSourceAccessConfigurationType
    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 EventSourceMappingSourceAccessConfigurationType
    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 lambda_.EventSourceMappingSourceAccessConfigurationType
    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

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    AWS Native is in preview. AWS Classic is fully supported.

    AWS Native v0.112.0 published on Wednesday, Jul 24, 2024 by Pulumi
    pulumi/pulumi-aws-native