MDAA TS Docs
    Preparing search index...

    Interface MdaaLambdaFunctionProps

    Properties for creating a compliant Lambda function

    interface MdaaLambdaFunctionProps {
        adotInstrumentation?: AdotInstrumentationConfig;
        allowAllOutbound?: boolean;
        allowPublicSubnet?: boolean;
        applicationLogLevel?: string;
        architecture?: Architecture;
        code: Code;
        codeSigningConfig?: ICodeSigningConfig;
        createOutputs?: boolean;
        createParams?: boolean;
        currentVersionOptions?: VersionOptions;
        deadLetterQueue?: IQueue;
        deadLetterQueueEnabled?: boolean;
        deadLetterTopic?: ITopic;
        description?: string;
        environment?: { [key: string]: string };
        environmentEncryption?: IKey;
        ephemeralStorageSize?: Size;
        events?: IEventSource[];
        filesystem?: FileSystem;
        functionName: string;
        handler: string;
        initialPolicy?: PolicyStatement[];
        insightsVersion?: LambdaInsightsVersion;
        layers?: ILayerVersion[];
        logFormat?: string;
        loggingFormat?: LoggingFormat;
        logGroup?: ILogGroup;
        logRetention?: RetentionDays;
        logRetentionRetryOptions?: LogRetentionRetryOptions;
        logRetentionRole?: IRole;
        maxEventAge?: Duration;
        memorySize?: number;
        naming: IMdaaResourceNaming;
        paramsAndSecrets?: ParamsAndSecretsLayerVersion;
        profiling?: boolean;
        profilingGroup?: IProfilingGroup;
        reservedConcurrentExecutions?: number;
        retryAttempts?: number;
        role: IRole;
        runtime: Runtime;
        runtimeManagementMode?: RuntimeManagementMode;
        securityGroups?: ISecurityGroup[];
        snapStart?: SnapStartConf;
        systemLogLevel?: string;
        timeout?: Duration;
        tracing?: Tracing;
        vpc?: IVpc;
        vpcSubnets?: SubnetSelection;
    }

    Hierarchy (View Summary)

    Index

    Properties

    adotInstrumentation? allowAllOutbound? allowPublicSubnet? applicationLogLevel? architecture? code codeSigningConfig? createOutputs? createParams? currentVersionOptions? deadLetterQueue? deadLetterQueueEnabled? deadLetterTopic? description? environment? environmentEncryption? ephemeralStorageSize? events? filesystem? functionName handler initialPolicy? insightsVersion? layers? logFormat? loggingFormat? logGroup? logRetention? logRetentionRetryOptions? logRetentionRole? maxEventAge? memorySize? naming paramsAndSecrets? profiling? profilingGroup? reservedConcurrentExecutions? retryAttempts? role runtime runtimeManagementMode? securityGroups? snapStart? systemLogLevel? timeout? tracing? vpc? vpcSubnets?

    Properties

    adotInstrumentation?: AdotInstrumentationConfig
    allowAllOutbound?: boolean
    allowPublicSubnet?: boolean
    applicationLogLevel?: string
    architecture?: Architecture

    System architecture specification for Lambda function execution environment controlling

    code: Code

    The source code of your Lambda function. You can point to a file in an Amazon Simple Storage Service (Amazon S3) bucket or specify your source code as inline text.

    codeSigningConfig?: ICodeSigningConfig
    createOutputs?: boolean

    Flag controlling CloudFormation output and stack export creation for construct resources

    createParams?: boolean

    Flag controlling SSM parameter creation for construct resource references enabling

    currentVersionOptions?: VersionOptions

    Options for the lambda.Version resource automatically created by the fn.currentVersion method.

    • default options as described in VersionOptions
    deadLetterQueue?: IQueue
    deadLetterQueueEnabled?: boolean
    deadLetterTopic?: ITopic
    description?: string

    Human-readable description of the Lambda function explaining its purpose and functionality

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

    Environment variables for Lambda function configuration and runtime behavior

    environmentEncryption?: IKey
    ephemeralStorageSize?: Size

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

    512 MiB
    events?: IEventSource[]
    filesystem?: FileSystem
    functionName: string

    Name for the Lambda function that will be processed through MDAA naming conventions

    handler: string

    The name of the method within your code that Lambda calls to execute your function. The format includes the file name. It can also include namespaces and other qualifiers, depending on the runtime. For more information, see https://docs.aws.amazon.com/lambda/latest/dg/gettingstarted-features.html#gettingstarted-features-programmingmodel. Use Handler.FROM_IMAGE when defining a function from a Docker image. NOTE: If you specify your source code as inline text by specifying the ZipFile property within the Code property, specify index.function_name as the handler.

    initialPolicy?: PolicyStatement[]
    insightsVersion?: LambdaInsightsVersion
    layers?: ILayerVersion[]

    Array of Lambda layers to add to the function's execution environment for shared code and dependencies

    logFormat?: string
    loggingFormat?: LoggingFormat
    logGroup?: ILogGroup
    logRetention?: RetentionDays
    logRetentionRetryOptions?: LogRetentionRetryOptions

    When log retention is specified, a custom resource attempts to create the CloudWatch log group. These options control the retry policy when interacting with CloudWatch APIs.

    - Default AWS SDK retry options.
    logRetentionRole?: IRole
    maxEventAge?: Duration
    memorySize?: number
    naming: IMdaaResourceNaming

    MDAA naming implementation for consistent resource naming across all MDAA constructs

    paramsAndSecrets?: ParamsAndSecretsLayerVersion
    profiling?: boolean
    profilingGroup?: IProfilingGroup
    reservedConcurrentExecutions?: number
    retryAttempts?: number

    Maximum number of retry attempts when the function returns an error controlling error

    role: IRole

    Lambda execution role providing the function with permissions to access AWS services and resources

    runtime: Runtime

    The runtime environment for the Lambda function that you are uploading. For valid values, see the Runtime property in the AWS Lambda Developer Guide. Use Runtime.FROM_IMAGE when when defining a function from a Docker image.

    runtimeManagementMode?: RuntimeManagementMode
    securityGroups?: ISecurityGroup[]

    Array of security groups for Lambda network interface access control

    snapStart?: SnapStartConf
    systemLogLevel?: string
    timeout?: Duration

    Lambda function timeout duration controlling maximum execution time for data processing operations

    tracing?: Tracing
    vpc?: IVpc

    VPC for placing Lambda network interfaces enabling access to VPC resources

    vpcSubnets?: SubnetSelection

    Settings

    Member Visibility

    On This Page

    Properties