MDAA TS Docs
    Preparing search index...

    Interface FunctionOptions

    interface FunctionOptions {
        description?: string;
        environment?: { [key: string]: string };
        ephemeralStorageSizeMB?: number;
        eventBridge?: EventBridgeProps;
        functionName: string;
        generatedLayerNames?: string[];
        layerArns?: { [name: string]: string };
        maxEventAgeSeconds?: number;
        memorySizeMB?: number;
        queueUrlEnvironment?: { [envVarName: string]: string };
        reservedConcurrentExecutions?: number;
        retryAttempts?: number;
        roleArn: string;
        sqsEventSources?: NamedSqsEventSourceProps;
        timeoutSeconds?: number;
        vpcConfig?: VpcConfigProps;
    }

    Hierarchy (View Summary)

    Index

    Properties

    description? environment? ephemeralStorageSizeMB? eventBridge? functionName generatedLayerNames? layerArns? maxEventAgeSeconds? memorySizeMB? queueUrlEnvironment? reservedConcurrentExecutions? retryAttempts? roleArn sqsEventSources? timeoutSeconds? vpcConfig?

    Properties

    description?: string

    Optional function description.

    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.

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

    Existing layer version ARNs mapped by name.

    maxEventAgeSeconds?: number

    Maximum event age in seconds (60-21600).

    memorySizeMB?: number

    Memory allocation in MB (128-10240).

    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.

    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.

    timeoutSeconds?: number

    Function timeout in seconds.

    vpcConfig?: VpcConfigProps

    VPC configuration for network deployment.

    Settings

    Member Visibility

    On This Page

    Properties