对 API Gateway 中的 HTTP API 使用阶段变量 - Amazon API Gateway

对 API Gateway 中的 HTTP API 使用阶段变量

阶段变量是您可以为 HTTP API 的阶段定义的键/值对。它们与环境变量的功能类似,可用于 API 设置。

阶段变量不适用于敏感数据,例如凭证。要将敏感数据传递给集成,请使用 AWS Lambda 授权方。您可以在 Lambda 授权方的输出中将敏感数据传递给集成。要了解更多信息,请参阅“Lambda 授权方响应格式”。

示例 – 使用阶段变量自定义 HTTP 集成端点

例如,您可以定义阶段变量,然后将其值设置为某个 HTTP 代理集成的 HTTP 终端节点。稍后,您可以使用关联的阶段变量名称引用终端节点。通过执行此操作,您可以在各个阶段对不同终端节点使用相同的 API 设置。同样,您可以使用阶段变量,为 API 的各个阶段指定不同的 AWS Lambda 函数集成。

要使用阶段变量自定义 HTTP 集成终端节点,您必须首先设置阶段变量的名称和值(例如 url,值为 example.com)。接下来,设置 HTTP 代理集成。您可以告知 API Gateway 使用阶段变量值 http://${stageVariables.url},而不是输入终端节点的 URL。此值将指示 API Gateway 在运行时替换您的阶段变量 ${},具体取决于 API 所处的阶段。

您可以通过类似的方式引用阶段变量,用于指定 Lambda 函数名称或AWS角色 ARN。

将 Lambda 函数名称指定为阶段变量值时,您必须手动配置对 Lambda 函数的权限。您可以使用以下 AWS CLI 命令来执行此操作。

aws lambda add-permission --function-name arn:aws:lambda:XXXXXX:your-lambda-function-name --source-arn arn:aws:execute-api:us-east-1:YOUR_ACCOUNT_ID:api_id/*/HTTP_METHOD/resource --principal apigateway.amazonaws.com --statement-id apigateway-access --action lambda:InvokeFunction