使用 AWS CDK 部署多个 API Gateway 阶段

Question

API Gateway 具有阶段的概念（例如：

dev

、

test

、

prod

），通过 AWS 控制台部署多个阶段非常简单。

是否可以使用 AWS CDK 定义和部署多个阶段？

我已经尝试过，但到目前为止似乎不可能。以下是一个非常基本的堆栈的简化示例，该堆栈构建 API 网关

RestApi

来服务 lambda 函数：

export class TestStack extends cdk.Stack {
  constructor(scope: cdk.Construct, id: string, props?: cdk.StackProps) {
    super(scope, id, props);

    // Define stage at deploy time; e.g: STAGE=prod cdk deploy
    const STAGE = process.env.STAGE || 'dev'

    // First, create a test lambda
    const testLambda = new apilambda.Function(this, 'test_lambda', {
      runtime: apilambda.Runtime.NODEJS_10_X,    
      code: apilambda.Code.fromAsset('lambda'),  
      handler: 'test.handler',
      environment: { STAGE }
    })

    // Then, create the API construct, integrate with lambda and define a catch-all method
    const api = new apigw.RestApi(this, 'test_api', { deploy: false });
    const integration = new apigw.LambdaIntegration(testLambda);

    api.root.addMethod('ANY', integration)

    // Then create an explicit Deployment construct
    const deployment  = new apigw.Deployment(this, 'test_deployment', { api });

    // And, a Stage construct
    const stage = new apigw.Stage(this, 'test_stage', { 
      deployment,
      stageName: STAGE
    });

    // There doesn't seem to be a way to add more than one stage...
    api.deploymentStage = stage
  }
}

我没有使用

LambdaRestApi

，因为有一个错误不允许显式

Deployment

，这显然是显式定义

Stage

所必需的。此方法需要额外的

LambdaIntegration

步骤。

这个堆栈运行得很好——我可以部署一个新的堆栈并使用环境变量定义 API 网关阶段；例如：

STAGE=my_stack_name cdk deploy

。

我希望这能让我通过执行以下操作来添加阶段：

STAGE=test cdk deploy
STAGE=prod cdk deploy
# etc.

但是，这不起作用 — 在上面的示例中，

test

阶段被

prod

阶段覆盖。

在尝试上述方法之前，我认为只需创建一个或多个

Stage

构造对象并将它们分配给同一个部署（它已经将

RestApi

作为参数）。

但是，需要通过

api.deploymentStage = stage

显式地为 api 分配一个阶段，而且看起来只能分配一个阶段。

这意味着这是不可能的，相反，您必须为

test

、

prod

等创建不同的堆栈。这意味着同一 API 网关和 Lambda 函数的多个实例。

更新

经过进一步的修改，我发现似乎可以部署多个阶段，尽管我还没有完全走出困境......

首先，恢复

RestApi

的默认行为 — 删除

deploy: false

属性，它会自动创建

Deployment

:

const api = new apigw.RestApi(this, 'test_api');

然后，像以前一样，创建一个显式的

Deployment

构造：

const deployment  = new apigw.Deployment(this, 'test_deployment', { api });

此时，请务必注意，

prod

阶段已定义，如果您显式为

cdk deploy

创建

Stage

构造，则

prod

将会失败。

相反，为您想要创建的每个其他阶段创建一个

Stage

构造；例如：

new apigw.Stage(this, 'stage_test', { deployment, stageName: 'test' });
new apigw.Stage(this, 'stage_dev', { deployment, stageName: 'dev' });
// etc.

此部署并且

prod

按预期工作。但是，

test

和

dev

都会失败，并出现 500 内部服务器错误和以下错误消息：

由于配置错误而执行失败：Lambda 函数的权限无效

在 AWS 控制台中手动重新分配 lambda 可应用权限。我还没想出如何在 CDK 中解决这个问题。

Answer 1

这应该可以解决问题。请注意，我已将资源从

test_lambda

重命名为

my_lambda

以避免与舞台名称混淆。另请注意，为了简洁起见，我已将

environment

变量删除为 lambda。

import * as cdk from '@aws-cdk/core';
import * as apigw from '@aws-cdk/aws-apigateway';
import * as lambda from '@aws-cdk/aws-lambda';
import { ServicePrincipal } from '@aws-cdk/aws-iam';

export class ApigwDemoStack extends cdk.Stack {
  constructor(scope: cdk.Construct, id: string, props?: cdk.StackProps) {
    super(scope, id, props);

    // First, create a test lambda
    const myLambda = new lambda.Function(this, 'my_lambda', {
      runtime: lambda.Runtime.NODEJS_10_X,    
      code: lambda.Code.fromAsset('lambda'),  
      handler: 'test.handler'
    });

    // IMPORTANT: Lambda grant invoke to APIGateway
    myLambda.grantInvoke(new ServicePrincipal('apigateway.amazonaws.com'));

    // Then, create the API construct, integrate with lambda
    const api = new apigw.RestApi(this, 'my_api', { deploy: false });
    const integration = new apigw.LambdaIntegration(myLambda);
    api.root.addMethod('ANY', integration)

    // Then create an explicit Deployment construct
    const deployment  = new apigw.Deployment(this, 'my_deployment', { api });

    // And different stages
    const [devStage, testStage, prodStage] = ['dev', 'test', 'prod'].map(item => 
      new apigw.Stage(this, `${item}_stage`, { deployment, stageName: item }));

    api.deploymentStage = prodStage
  }
}

这里需要注意的重要部分是：

myLambda.grantInvoke(new ServicePrincipal('apigateway.amazonaws.com'));

显式授予对 API Gateway 的调用访问权限允许所有其他阶段（不直接与 API 关联）不会抛出以下错误：

Execution failed due to configuration error: Invalid permissions on Lambda function

我必须通过从控制台显式创建另一个阶段并启用日志跟踪来测试它。 API 和阶段的 API 网关执行日志捕获了此特定错误。

我自己测试过这一点。这应该可以解决您的问题。我建议完全创建一个新堆栈来测试这一点。

我的超级简单的 Lambda 代码：

// lambda/test.ts
export const handler = async (event: any = {}) : Promise <any> => {
  console.log("Inside Lambda");
  return { 
    statusCode: 200, 
    body: 'Successfully Invoked Lambda through API Gateway'
  };
}

Answer 2

我遇到了类似的问题，我重命名了部署堆栈和阶段堆栈的逻辑ID。后修复阶段名称（dev、uat、prod）
请参考这个 AWS CDK 部署到阶段而不删除之前的阶段