如何在SAM中的Apigateway专用api的开放api规范中指定VPCENDPOINTID

Question

我有一个SAM模板文件，其中我将Api定义为AWS:：Serverless:：Api资源。api应该具有EndpointConfiguration:PRIVATE与AWS:：ApiGateway:：RestApi不同，AWS:：Serverless:：api仅支持EndpointConfiguration的字符串值。

对于AWS:：ApiGateway:：RestApi：我可以添加2种属性类型：私有vpcEndpointIds:[]

但是对于AWS::Serverless::Api，我只有一个PRIVATE属性

在搜索如何配置vpcEndpointIds时，我发现：

https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-swagger-extensions-endpoint-configuration.html

本文档还指出，VPCENDPOINTID应该在开放式api规范文档中的“x-amazon-apigateway-endpoint-configuration”下定义。

但无论是在AWS文档中还是在OpenAPI文档中，我都找不到任何关于如何准确定义它的示例。

OpenAPIdoc说它应该在我尝试过的服务器对象下定义，但都不起作用。

任何帮助都将不胜感激

Answer 1

谢谢你的回复。

我在SAM中找到了正确的方法。正如您所提到的，它在SAM中不是直接可用的选项。但您可以在api开放api定义文档中的servers对象下实现这一点，如下所示：

        servers:
      - url: "https://apiname.execute-api.region.aws.com/{basePath}"
        variables:
          basePath:
            default: "/stagename"
        x-amazon-apigateway-endpoint-configuration:
          vpcEndpointIds:
            - !Ref vpcEndpointId

对于遇到相同问题的用户，请记住，如果您使用的是swagger 2.0规范，那么属性需要处于不同的级别。在这里找到它-https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-swagger-extensions-endpoint-configuration.html

Answer 2

此选项可用于CloudFormation，但SAM目前不支持在EndpointConfiguration下定义VPCendpoint。

最近添加了关联VPCendpoint的此功能，因此我认为SAM尚未对此进行更新。有对它的功能要求，所以我预计它将很快实现。