GradientEdge CDK Utils
    Preparing search index...

    Interface SQSEventSourceProps

    interface SQSEventSourceProps {
        batchSize?: number;
        enabled?: boolean;
        filterEncryption?: IKey;
        filters?: { [key: string]: any }[];
        maxBatchingWindow?: Duration;
        maxBatchingWindowInSecs: number;
        maxConcurrency?: number;
        metricsConfig?: MetricsConfig;
        reportBatchItemFailures?: boolean;
    }

    Hierarchy

    • SqsEventSourceProps
      • SQSEventSourceProps
    Index

    Properties

    batchSize? enabled? filterEncryption? filters? maxBatchingWindow? maxBatchingWindowInSecs maxConcurrency? metricsConfig? reportBatchItemFailures?

    Properties

    batchSize?: number

    The largest number of records that AWS Lambda will retrieve from your event source at the time of invoking your function. Your function receives an event with all the retrieved records.

    Valid Range: Minimum value of 1. Maximum value of 10. If maxBatchingWindow is configured, this value can go up to 10,000.

    10
    enabled?: boolean

    If the SQS event source mapping should be enabled.

    true
    filterEncryption?: IKey

    Add Customer managed KMS key to encrypt Filter Criteria.

    - none
    filters?: { [key: string]: any }[]

    Add filter criteria option

    - None
    maxBatchingWindow?: Duration

    The maximum amount of time to gather records before invoking the function.

    Valid Range: Minimum value of 0 minutes. Maximum value of 5 minutes.

    - no batching window. The lambda function will be invoked immediately with the records that are available.
    maxBatchingWindowInSecs: number
    maxConcurrency?: number

    The maximum concurrency setting limits the number of concurrent instances of the function that an Amazon SQS event source can invoke.

    https://docs.aws.amazon.com/lambda/latest/dg/with-sqs.html#events-sqs-max-concurrency

    Valid Range: Minimum value of 2. Maximum value of 1000.

    - No specific limit.
    metricsConfig?: MetricsConfig

    Configuration for enhanced monitoring metrics collection When specified, enables collection of additional metrics for the stream event source

    - Enhanced monitoring is disabled
    reportBatchItemFailures?: boolean

    Allow functions to return partially successful responses for a batch of records.

    https://docs.aws.amazon.com/lambda/latest/dg/with-sqs.html#services-sqs-batchfailurereporting

    false

    Settings

    Member Visibility

    On This Page

    Properties