MDAA TS Docs
    Preparing search index...

    Interface FunctionProps

    Lambda function configuration for data processing with S3 event and EventBridge integration.

    Defines Lambda function properties for data processing workflows triggered by S3 object events and EventBridge rules in data lake operations.

    Use cases: S3 event-driven data processing; Data transformation; EventBridge-triggered operations

    AWS: Lambda function configuration with S3 EventBridge notifications and custom event rules

    Validation: srcDir must exist; runtime must be valid Lambda runtime; handler must match code structure

    interface FunctionProps {
        additionalResourcePermissions?: {
            [sid: string]: AdditionalResourcePermission;
        };
        alarms?: AlarmProps[];
        description?: string;
        dockerBuild?: boolean;
        environment?: { [key: string]: string };
        ephemeralStorageSizeMB?: number;
        eventBridge?: EventBridgeProps;
        functionName: string;
        generatedLayerNames?: string[];
        grantInvoke?: string;
        handler?: string;
        layerArns?: { [name: string]: string };
        logInsightsQueries?: LogInsightsQueryProps[];
        maxEventAgeSeconds?: number;
        memorySizeMB?: number;
        metricFilters?: MetricFilterProps[];
        queueUrlEnvironment?: { [envVarName: string]: string };
        reservedConcurrentExecutions?: number;
        retryAttempts?: number;
        roleArn: string;
        runtime?: string;
        sqsEventSources?: NamedSqsEventSourceProps;
        srcDir: string;
        timeoutSeconds?: number;
        vpcConfig?: VpcConfigProps;
    }

    Hierarchy (View Summary)

    Index

    Properties

    additionalResourcePermissions? alarms? description? dockerBuild? environment? ephemeralStorageSizeMB? eventBridge? functionName generatedLayerNames? grantInvoke? handler? layerArns? logInsightsQueries? maxEventAgeSeconds? memorySizeMB? metricFilters? queueUrlEnvironment? reservedConcurrentExecutions? retryAttempts? roleArn runtime? sqsEventSources? srcDir timeoutSeconds? vpcConfig?

    Properties

    additionalResourcePermissions?: { [sid: string]: AdditionalResourcePermission }

    Additional resource permissions mapped by SID.

    alarms?: AlarmProps[]

    CloudWatch alarms for monitoring and alerting. Custom metrics validated against metricFilters.

    description?: string

    Optional function description.

    dockerBuild?: boolean

    When true, srcDir must contain a Dockerfile for container image deployment.

    environment?: { [key: string]: string }

    Environment variables for function configuration.

    ephemeralStorageSizeMB?: number

    The size of the function's /tmp directory in MB.

    512 MiB
    eventBridge?: EventBridgeProps

    EventBridge configuration for event-driven execution.

    functionName: string

    Lambda function name.

    generatedLayerNames?: string[]

    Generated layer names to attach to the function.

    grantInvoke?: string

    Principal ARN granted Lambda invoke permissions.

    handler?: string

    Lambda function handler (e.g., 'index.handler').

    layerArns?: { [name: string]: string }

    Existing layer version ARNs mapped by name.

    logInsightsQueries?: LogInsightsQueryProps[]

    CloudWatch Logs Insights saved queries for log analysis.

    maxEventAgeSeconds?: number

    Maximum event age in seconds (60-21600).

    memorySizeMB?: number

    Memory allocation in MB (128-10240).

    metricFilters?: MetricFilterProps[]

    CloudWatch metric filters for custom metric extraction.

    queueUrlEnvironment?: { [envVarName: string]: string }

    Environment variables to be populated with the URL of a queue declared under the module's queues section, mapped from environment variable name to queue key. Producers need the URL at runtime, and the queue is deployed alongside the function, so the URL is injected directly rather than through an SSM lookup.

    reservedConcurrentExecutions?: number

    Reserved concurrent executions for capacity management.

    retryAttempts?: number

    Maximum retry attempts for failed executions (0-2).

    roleArn: string

    IAM role ARN for Lambda function execution.

    runtime?: string

    Lambda runtime (e.g., python3.13, nodejs22.x).

    sqsEventSources?: NamedSqsEventSourceProps

    SQS event sources which poll a queue declared under the module's queues section and invoke this function with batches of messages, keyed by queue name.

    srcDir: string

    Source code directory path containing Lambda function code.

    timeoutSeconds?: number

    Function timeout in seconds.

    vpcConfig?: VpcConfigProps

    VPC configuration for network deployment.

    Settings

    Member Visibility

    On This Page

    Properties