Class Endpoint

A construct that creates an API Gateway HTTP API and integrates it with an existing AWS Lambda function.

The Endpoint construct simplifies the process of exposing a Lambda function as an HTTP API endpoint. It allows you to configure the API Gateway with a custom name, path, and HTTP method.

Example

import { Stack, Duration, CfnOutput } from 'aws-cdk-lib';
import { Construct } from 'constructs';
import { lambda } from '@reuters-graphics/structs';
import * as apigateway from 'aws-cdk-lib/aws-apigatewayv2';

export class MyLambdaStack extends Stack {
  constructor(scope: Construct, id: string) {
    super(scope, id);

    // Create a Lambda function
    const myLambda = new lambda.NodeJsLambda(this, 'my-lambda', {
      entry: './src/index.ts',
      handler: 'handle',
    });

    // Create an API Gateway endpoint for the Lambda function
    const myApiEndpoint = new lambda.api.Endpoint(this, 'my-api', {
      lambdaFunction: myLambda.lambda,
      apiPath: '/my-endpoint',
      apiMethod: apigateway.HttpMethod.GET,
    });

    // Access new API's URL and add it to CDK outputs
    new CfnOutput(this, 'ApiUrl', {
      value: myApiEndpoint.api.url!,
    });

    // Create another Lambda function
    const myOtherLambda = new lambda.NodeJsLambda(/* ... */);

    // Add a new lambda integration as another route to the endpoint
    myApiEndpoint.addLambdaRoute({
      lambdaFunction: myOtherLambda.lambda,
      apiPath: '/my-other-endpoint',
      apiMethod: apigateway.HttpMethod.GET,
    });
  }
}
Copy