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.97.0 published on Wednesday, Feb 21, 2024 by Pulumi

aws-native.lambda.getEventSourceMapping

Explore with Pulumi AI

aws-native logo

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

AWS Native v0.97.0 published on Wednesday, Feb 21, 2024 by Pulumi

    Resource Type definition for AWS::Lambda::EventSourceMapping

    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
    Event Source Mapping Identifier UUID.
    Id string
    Event Source Mapping Identifier UUID.
    id String
    Event Source Mapping Identifier UUID.
    id string
    Event Source Mapping Identifier UUID.
    id str
    Event Source Mapping Identifier UUID.
    id String
    Event Source Mapping Identifier UUID.

    getEventSourceMapping Result

    The following output properties are available:

    BatchSize int
    The maximum number of items to retrieve in a single batch.
    BisectBatchOnFunctionError bool
    (Streams) If the function returns an error, split the batch in two and retry.
    DestinationConfig Pulumi.AwsNative.Lambda.Outputs.EventSourceMappingDestinationConfig
    (Streams) An Amazon SQS queue or Amazon SNS topic destination for discarded records.
    DocumentDbEventSourceConfig Pulumi.AwsNative.Lambda.Outputs.EventSourceMappingDocumentDbEventSourceConfig
    Document db event source config.
    Enabled bool
    Disables the event source mapping to pause polling and invocation.
    FilterCriteria Pulumi.AwsNative.Lambda.Outputs.EventSourceMappingFilterCriteria
    The filter criteria to control event filtering.
    FunctionName string
    The name of the Lambda function.
    FunctionResponseTypes List<Pulumi.AwsNative.Lambda.EventSourceMappingFunctionResponseTypesItem>
    (Streams) A list of response types supported by the function.
    Id string
    Event Source Mapping Identifier UUID.
    MaximumBatchingWindowInSeconds int
    (Streams) The maximum amount of time to gather records before invoking the function, in seconds.
    MaximumRecordAgeInSeconds int
    (Streams) The maximum age of a record that Lambda sends to a function for processing.
    MaximumRetryAttempts int
    (Streams) The maximum number of times to retry when the function returns an error.
    ParallelizationFactor int
    (Streams) The number of batches to process from each shard concurrently.
    Queues List<string>
    (ActiveMQ) A list of ActiveMQ queues.
    ScalingConfig Pulumi.AwsNative.Lambda.Outputs.EventSourceMappingScalingConfig
    The scaling configuration for the event source.
    SourceAccessConfigurations List<Pulumi.AwsNative.Lambda.Outputs.EventSourceMappingSourceAccessConfiguration>
    A list of SourceAccessConfiguration.
    Topics List<string>
    (Kafka) A list of Kafka topics.
    TumblingWindowInSeconds int
    (Streams) Tumbling window (non-overlapping time window) duration to perform aggregations.
    BatchSize int
    The maximum number of items to retrieve in a single batch.
    BisectBatchOnFunctionError bool
    (Streams) If the function returns an error, split the batch in two and retry.
    DestinationConfig EventSourceMappingDestinationConfig
    (Streams) An Amazon SQS queue or Amazon SNS topic destination for discarded records.
    DocumentDbEventSourceConfig EventSourceMappingDocumentDbEventSourceConfig
    Document db event source config.
    Enabled bool
    Disables the event source mapping to pause polling and invocation.
    FilterCriteria EventSourceMappingFilterCriteria
    The filter criteria to control event filtering.
    FunctionName string
    The name of the Lambda function.
    FunctionResponseTypes []EventSourceMappingFunctionResponseTypesItem
    (Streams) A list of response types supported by the function.
    Id string
    Event Source Mapping Identifier UUID.
    MaximumBatchingWindowInSeconds int
    (Streams) The maximum amount of time to gather records before invoking the function, in seconds.
    MaximumRecordAgeInSeconds int
    (Streams) The maximum age of a record that Lambda sends to a function for processing.
    MaximumRetryAttempts int
    (Streams) The maximum number of times to retry when the function returns an error.
    ParallelizationFactor int
    (Streams) The number of batches to process from each shard concurrently.
    Queues []string
    (ActiveMQ) A list of ActiveMQ queues.
    ScalingConfig EventSourceMappingScalingConfig
    The scaling configuration for the event source.
    SourceAccessConfigurations []EventSourceMappingSourceAccessConfiguration
    A list of SourceAccessConfiguration.
    Topics []string
    (Kafka) A list of Kafka topics.
    TumblingWindowInSeconds int
    (Streams) Tumbling window (non-overlapping time window) duration to perform aggregations.
    batchSize Integer
    The maximum number of items to retrieve in a single batch.
    bisectBatchOnFunctionError Boolean
    (Streams) If the function returns an error, split the batch in two and retry.
    destinationConfig EventSourceMappingDestinationConfig
    (Streams) An Amazon SQS queue or Amazon SNS topic destination for discarded records.
    documentDbEventSourceConfig EventSourceMappingDocumentDbEventSourceConfig
    Document db event source config.
    enabled Boolean
    Disables the event source mapping to pause polling and invocation.
    filterCriteria EventSourceMappingFilterCriteria
    The filter criteria to control event filtering.
    functionName String
    The name of the Lambda function.
    functionResponseTypes List<EventSourceMappingFunctionResponseTypesItem>
    (Streams) A list of response types supported by the function.
    id String
    Event Source Mapping Identifier UUID.
    maximumBatchingWindowInSeconds Integer
    (Streams) The maximum amount of time to gather records before invoking the function, in seconds.
    maximumRecordAgeInSeconds Integer
    (Streams) The maximum age of a record that Lambda sends to a function for processing.
    maximumRetryAttempts Integer
    (Streams) The maximum number of times to retry when the function returns an error.
    parallelizationFactor Integer
    (Streams) The number of batches to process from each shard concurrently.
    queues List<String>
    (ActiveMQ) A list of ActiveMQ queues.
    scalingConfig EventSourceMappingScalingConfig
    The scaling configuration for the event source.
    sourceAccessConfigurations List<EventSourceMappingSourceAccessConfiguration>
    A list of SourceAccessConfiguration.
    topics List<String>
    (Kafka) A list of Kafka topics.
    tumblingWindowInSeconds Integer
    (Streams) Tumbling window (non-overlapping time window) duration to perform aggregations.
    batchSize number
    The maximum number of items to retrieve in a single batch.
    bisectBatchOnFunctionError boolean
    (Streams) If the function returns an error, split the batch in two and retry.
    destinationConfig EventSourceMappingDestinationConfig
    (Streams) An Amazon SQS queue or Amazon SNS topic destination for discarded records.
    documentDbEventSourceConfig EventSourceMappingDocumentDbEventSourceConfig
    Document db event source config.
    enabled boolean
    Disables the event source mapping to pause polling and invocation.
    filterCriteria EventSourceMappingFilterCriteria
    The filter criteria to control event filtering.
    functionName string
    The name of the Lambda function.
    functionResponseTypes EventSourceMappingFunctionResponseTypesItem[]
    (Streams) A list of response types supported by the function.
    id string
    Event Source Mapping Identifier UUID.
    maximumBatchingWindowInSeconds number
    (Streams) The maximum amount of time to gather records before invoking the function, in seconds.
    maximumRecordAgeInSeconds number
    (Streams) The maximum age of a record that Lambda sends to a function for processing.
    maximumRetryAttempts number
    (Streams) The maximum number of times to retry when the function returns an error.
    parallelizationFactor number
    (Streams) The number of batches to process from each shard concurrently.
    queues string[]
    (ActiveMQ) A list of ActiveMQ queues.
    scalingConfig EventSourceMappingScalingConfig
    The scaling configuration for the event source.
    sourceAccessConfigurations EventSourceMappingSourceAccessConfiguration[]
    A list of SourceAccessConfiguration.
    topics string[]
    (Kafka) A list of Kafka topics.
    tumblingWindowInSeconds number
    (Streams) Tumbling window (non-overlapping time window) duration to perform aggregations.
    batch_size int
    The maximum number of items to retrieve in a single batch.
    bisect_batch_on_function_error bool
    (Streams) If the function returns an error, split the batch in two and retry.
    destination_config EventSourceMappingDestinationConfig
    (Streams) An Amazon SQS queue or Amazon SNS topic destination for discarded records.
    document_db_event_source_config EventSourceMappingDocumentDbEventSourceConfig
    Document db event source config.
    enabled bool
    Disables the event source mapping to pause polling and invocation.
    filter_criteria EventSourceMappingFilterCriteria
    The filter criteria to control event filtering.
    function_name str
    The name of the Lambda function.
    function_response_types EventSourceMappingFunctionResponseTypesItem]
    (Streams) A list of response types supported by the function.
    id str
    Event Source Mapping Identifier UUID.
    maximum_batching_window_in_seconds int
    (Streams) The maximum amount of time to gather records before invoking the function, in seconds.
    maximum_record_age_in_seconds int
    (Streams) The maximum age of a record that Lambda sends to a function for processing.
    maximum_retry_attempts int
    (Streams) The maximum number of times to retry when the function returns an error.
    parallelization_factor int
    (Streams) The number of batches to process from each shard concurrently.
    queues Sequence[str]
    (ActiveMQ) A list of ActiveMQ queues.
    scaling_config EventSourceMappingScalingConfig
    The scaling configuration for the event source.
    source_access_configurations EventSourceMappingSourceAccessConfiguration]
    A list of SourceAccessConfiguration.
    topics Sequence[str]
    (Kafka) A list of Kafka topics.
    tumbling_window_in_seconds int
    (Streams) Tumbling window (non-overlapping time window) duration to perform aggregations.
    batchSize Number
    The maximum number of items to retrieve in a single batch.
    bisectBatchOnFunctionError Boolean
    (Streams) If the function returns an error, split the batch in two and retry.
    destinationConfig Property Map
    (Streams) An Amazon SQS queue or Amazon SNS topic destination for discarded records.
    documentDbEventSourceConfig Property Map
    Document db event source config.
    enabled Boolean
    Disables the event source mapping to pause polling and invocation.
    filterCriteria Property Map
    The filter criteria to control event filtering.
    functionName String
    The name of the Lambda function.
    functionResponseTypes List<"ReportBatchItemFailures">
    (Streams) A list of response types supported by the function.
    id String
    Event Source Mapping Identifier UUID.
    maximumBatchingWindowInSeconds Number
    (Streams) The maximum amount of time to gather records before invoking the function, in seconds.
    maximumRecordAgeInSeconds Number
    (Streams) The maximum age of a record that Lambda sends to a function for processing.
    maximumRetryAttempts Number
    (Streams) The maximum number of times to retry when the function returns an error.
    parallelizationFactor Number
    (Streams) The number of batches to process from each shard concurrently.
    queues List<String>
    (ActiveMQ) A list of ActiveMQ queues.
    scalingConfig Property Map
    The scaling configuration for the event source.
    sourceAccessConfigurations List<Property Map>
    A list of SourceAccessConfiguration.
    topics List<String>
    (Kafka) A list of Kafka topics.
    tumblingWindowInSeconds Number
    (Streams) Tumbling window (non-overlapping time window) duration to perform aggregations.

    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 EventSourceMappingOnFailure
    The destination configuration for failed invocations.
    onFailure Property Map
    The destination configuration for failed invocations.

    EventSourceMappingDocumentDbEventSourceConfig

    CollectionName string
    The collection name to connect to.
    DatabaseName string
    The database name to connect to.
    FullDocument Pulumi.AwsNative.Lambda.EventSourceMappingDocumentDbEventSourceConfigFullDocument
    Include full document in change stream response. The default option will only send the changes made to documents to Lambda. If you want the complete document sent to Lambda, set this to UpdateLookup.
    CollectionName string
    The collection name to connect to.
    DatabaseName string
    The database name to connect to.
    FullDocument EventSourceMappingDocumentDbEventSourceConfigFullDocument
    Include full document in change stream response. The default option will only send the changes made to documents to Lambda. If you want the complete document sent to Lambda, set this to UpdateLookup.
    collectionName String
    The collection name to connect to.
    databaseName String
    The database name to connect to.
    fullDocument EventSourceMappingDocumentDbEventSourceConfigFullDocument
    Include full document in change stream response. The default option will only send the changes made to documents to Lambda. If you want the complete document sent to Lambda, set this to UpdateLookup.
    collectionName string
    The collection name to connect to.
    databaseName string
    The database name to connect to.
    fullDocument EventSourceMappingDocumentDbEventSourceConfigFullDocument
    Include full document in change stream response. The default option will only send the changes made to documents to Lambda. If you want the complete document sent to Lambda, set this to UpdateLookup.
    collection_name str
    The collection name to connect to.
    database_name str
    The database name to connect to.
    full_document EventSourceMappingDocumentDbEventSourceConfigFullDocument
    Include full document in change stream response. The default option will only send the changes made to documents to Lambda. If you want the complete document sent to Lambda, set this to UpdateLookup.
    collectionName String
    The collection name to connect to.
    databaseName String
    The database name to connect to.
    fullDocument "UpdateLookup" | "Default"
    Include full document in change stream response. The default option will only send the changes made to documents to Lambda. If you want the complete document sent to Lambda, set this to UpdateLookup.

    EventSourceMappingDocumentDbEventSourceConfigFullDocument

    EventSourceMappingFilter

    Pattern string
    The filter pattern that defines which events should be passed for invocations.
    Pattern string
    The filter pattern that defines which events should be passed for invocations.
    pattern String
    The filter pattern that defines which events should be passed for invocations.
    pattern string
    The filter pattern that defines which events should be passed for invocations.
    pattern str
    The filter pattern that defines which events should be passed for invocations.
    pattern String
    The filter pattern that defines which events should be passed for invocations.

    EventSourceMappingFilterCriteria

    Filters []EventSourceMappingFilter
    List of filters of this FilterCriteria
    filters List<EventSourceMappingFilter>
    List of filters of this FilterCriteria
    filters EventSourceMappingFilter[]
    List of filters of this FilterCriteria
    filters EventSourceMappingFilter]
    List of filters of this FilterCriteria
    filters List<Property Map>
    List of filters of this FilterCriteria

    EventSourceMappingFunctionResponseTypesItem

    EventSourceMappingOnFailure

    Destination string
    The Amazon Resource Name (ARN) of the destination resource.
    Destination string
    The Amazon Resource Name (ARN) of the destination resource.
    destination String
    The Amazon Resource Name (ARN) of the destination resource.
    destination string
    The Amazon Resource Name (ARN) of the destination resource.
    destination str
    The Amazon Resource Name (ARN) of the destination resource.
    destination String
    The Amazon Resource Name (ARN) of the destination resource.

    EventSourceMappingScalingConfig

    MaximumConcurrency int
    The maximum number of concurrent functions that the event source can invoke.
    MaximumConcurrency int
    The maximum number of concurrent functions that the event source can invoke.
    maximumConcurrency Integer
    The maximum number of concurrent functions that the event source can invoke.
    maximumConcurrency number
    The maximum number of concurrent functions that the event source can invoke.
    maximum_concurrency int
    The maximum number of concurrent functions that the event source can invoke.
    maximumConcurrency Number
    The maximum number of concurrent functions that the event source can invoke.

    EventSourceMappingSourceAccessConfiguration

    Type Pulumi.AwsNative.Lambda.EventSourceMappingSourceAccessConfigurationType
    The type of source access configuration.
    Uri string
    The URI for the source access configuration resource.
    Type EventSourceMappingSourceAccessConfigurationType
    The type of source access configuration.
    Uri string
    The URI for the source access configuration resource.
    type EventSourceMappingSourceAccessConfigurationType
    The type of source access configuration.
    uri String
    The URI for the source access configuration resource.
    type EventSourceMappingSourceAccessConfigurationType
    The type of source access configuration.
    uri string
    The URI for the source access configuration resource.
    type EventSourceMappingSourceAccessConfigurationType
    The type of source access configuration.
    uri str
    The URI for the source access configuration resource.

    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.97.0 published on Wednesday, Feb 21, 2024 by Pulumi