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.

Example

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)
  }
}

See

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

Index

Constructors

constructor

Methods

createEdgeFunction createLambdaDockerFunction createLambdaFunction createLambdaFunctionAlias createLambdaLayer createWebAdapterLayer

Constructors

constructor

new LambdaManager(): LambdaManager
Returns LambdaManager

Methods

createEdgeFunction

createEdgeFunction(
    id: string,
    scope: CommonConstruct,
    props: LambdaEdgeProps,
    layers: ILayerVersion[],
    code: AssetCode,
    role: Role,
    environment?: any,
    vpc?: IVpc,
    securityGroups?: ISecurityGroup[],
    accessPoint?: IAccessPoint,
    mountPath?: string,
): EdgeFunction
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
- Defined in packages/aws/src/services/lambda/main.ts:221

createLambdaDockerFunction

createLambdaDockerFunction(
    id: string,
    scope: CommonConstruct,
    props: LambdaProps,
    role: Role | CfnRole,
    code: DockerImageCode,
    environment?: any,
    vpc?: IVpc,
    securityGroups?: ISecurityGroup[],
    accessPoint?: IAccessPoint,
    mountPath?: string,
    vpcSubnets?: SubnetSelection,
): 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
- 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
- Defined in packages/aws/src/services/lambda/main.ts:263

createLambdaFunction

createLambdaFunction(
    id: string,
    scope: CommonConstruct,
    props: LambdaProps,
    role: Role | CfnRole,
    layers: ILayerVersion[],
    code: AssetCode,
    handler?: string,
    environment?: any,
    vpc?: IVpc,
    securityGroups?: ISecurityGroup[],
    accessPoint?: IAccessPoint,
    mountPath?: string,
    vpcSubnets?: SubnetSelection,
): Function
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 Function
- Defined in packages/aws/src/services/lambda/main.ts:102

createLambdaFunctionAlias

createLambdaFunctionAlias(
    id: string,
    scope: CommonConstruct,
    props: LambdaAliasProps,
    lambdaVersion: IVersion,
): Alias
Parameters
- id: string
  scoped id of the resource
- scope: CommonConstruct
  scope in which this resource is defined
- props: LambdaAliasProps
  the Lambda alias properties
- lambdaVersion: IVersion
  the Lambda function version to point the alias to
Returns Alias
- Defined in packages/aws/src/services/lambda/main.ts:340

createLambdaLayer

createLambdaLayer(
    id: string,
    scope: CommonConstruct,
    code: AssetCode,
    architectures?: Architecture[],
): LayerVersion
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
- Defined in packages/aws/src/services/lambda/main.ts:52

createWebAdapterLayer

createWebAdapterLayer(id: string, scope: CommonConstruct): ILayerVersion[]
Parameters
- id: string
  scoped id of the resource
- scope: CommonConstruct
  scope in which this resource is defined
Returns ILayerVersion[]
- Defined in packages/aws/src/services/lambda/main.ts:71

Class LambdaManager

Example

See

Index

Constructors

Methods

Constructors

constructor

Returns LambdaManager

Methods

createEdgeFunction

Parameters

Returns EdgeFunction

createLambdaDockerFunction

Parameters

Returns DockerImageFunction

createLambdaFunction

Parameters

Returns Function

createLambdaFunctionAlias

Parameters

Returns Alias

createLambdaLayer

Parameters

Returns LayerVersion

createWebAdapterLayer

Parameters

Returns ILayerVersion[]

Settings

On This Page