GradientEdge CDK Utils
    Preparing search index...

    Class LambdaManager

    Provides operations on AWS Lambda

    • A new instance of this class is injected into CommonConstruct constructor.
    • If a custom construct extends CommonConstruct, an instance is available within the context.
    import { CommonConstruct } from '@gradientedge/cdk-utils'

    class CustomConstruct extends CommonConstruct {
      constructor(parent: Construct, id: string, props: common.CommonStackProps) {
        super(parent, id, props)
        this.props = props
        this.lambdaManager.createLambdaFunction('MyFunction', this, role, layers, code)
      }
    }

    [CDK Lambda Module]https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_lambda-readme.html

    Index

    Constructors

    constructor

    Methods

    attachProvisionedConcurrencyToVersion createEdgeFunction createLambdaDockerFunction createLambdaFunction createLambdaFunctionAlias createLambdaLayer createWebAdapterLayer

    Constructors

    Methods

    • Parameters

      • id: string

        scoped id prefix for the PC + scaling resources

      • scope: CommonConstruct

        scope the resources are added to

      • lambdaFunction: Function

        the function whose currentVersion to attach PC to

      • props: { maxCapacity: number; minCapacity: number; utilizationTarget: number }

        the PC + autoscaling props

      Returns ScalableTarget

    • Parameters

      • id: string

        scoped id of the resource

      • scope: CommonConstruct

        scope in which this resource is defined

      • props: LambdaEdgeProps

        lambda@edge properties

      • layers: ILayerVersion[]
      • code: AssetCode
      • role: Role
      • Optionalenvironment: any
      • Optionalvpc: IVpc
      • OptionalsecurityGroups: ISecurityGroup[]
      • OptionalaccessPoint: IAccessPoint
      • OptionalmountPath: string

      Returns EdgeFunction

    • Parameters

      • id: string

        scoped id of the resource

      • scope: CommonConstruct

        scope in which this resource is defined

      • props: LambdaProps

        the Lambda function properties

      • role: Role | CfnRole

        the IAM role for the function execution

      • code: DockerImageCode

        the Docker image code for the function

      • Optionalenvironment: any

        optional environment variables to inject

      • Optionalvpc: IVpc

        optional VPC to place the function in

      • OptionalsecurityGroups: ISecurityGroup[]

        optional security groups when running in a VPC

      • OptionalaccessPoint: IAccessPoint

        optional EFS access point for file system mounting

      • OptionalmountPath: string

        optional mount path for the EFS file system, defaults to '/mnt/msg'

      • OptionalvpcSubnets: SubnetSelection

        optional subnet selection when running in a VPC

      Returns DockerImageFunction

    • Parameters

      • id: string

        scoped id of the resource

      • scope: CommonConstruct

        scope in which this resource is defined

      • props: LambdaProps

        the Lambda function properties

      • role: Role | CfnRole

        the IAM role for the function execution

      • layers: ILayerVersion[]

        the list of Lambda layers to attach

      • code: AssetCode

        the asset code for the function

      • Optionalhandler: string

        optional handler entry point, defaults to 'index.lambda_handler'

      • Optionalenvironment: any

        optional environment variables to inject

      • Optionalvpc: IVpc

        optional VPC to place the function in

      • OptionalsecurityGroups: ISecurityGroup[]

        optional security groups when running in a VPC

      • OptionalaccessPoint: IAccessPoint

        optional EFS access point for file system mounting

      • OptionalmountPath: string

        optional mount path for the EFS file system, defaults to '/mnt/msg'

      • OptionalvpcSubnets: SubnetSelection

        optional subnet selection when running in a VPC

      Returns FunctionWithAliases

    • Parameters

      • id: string

        scoped id of the resource

      • scope: CommonConstruct

        scope in which this resource is defined

      • code: AssetCode

        the asset code for the layer

      • Optionalarchitectures: Architecture[]

        optional list of compatible architectures, defaults to ARM_64

      Returns LayerVersion

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods