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

Question

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

30

API Gateway有阶段的概念（例如：dev，test，prod），通过AWS控制台部署多个阶段非常简单。

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

我尝试过，但目前似乎不可能。以下是一个非常基本的堆栈的摘要示例，用于构建API Gateway 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，因为有一个bug不允许显式定义Deployment，而显式定义Stage是必要的。这种方法需要额外的LambdaIntegration步骤。

这个堆栈运行得足够好——我可以部署一个新的堆栈，并通过环境变量定义API Gateway阶段；例如：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 阶段已经被 预定义，如果您明确为 prod 创建一个 Stage 构造，则 cdk deploy 将失败。

相反，为您想要创建的每个其他阶段创建一个 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 中解决这个问题。

- Darragh Enright

1个回答

网页内容由stack overflow 提供, 点击上面的

可以查看英文原文，
原文链接

- dmahapatro · Accepted Answer

这应该可以解决问题。请注意，我已将资源从test_lambda重命名为my_lambda，以避免与阶段名称混淆。此外，为了简洁起见，我删除了lambda的environment变量。

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'
  };
}