如何在 AWS SAM 中向私有 API 网关添加标签答案

【问题标题】：How to add Tags to Private API Gateways in AWS SAM如何在 AWS SAM 中向私有 API 网关添加标签
【发布时间】：2020-06-22 17:28:55
【问题描述】：

我在 SAM 中使用 AWS::Serverless::API 创建了一个 API 网关，现在我想向网关添加标签，以便对每个具有相同标签的网关实施安全约束。

  Type: AWS::Serverless::Api
  Properties:
    Name: PrivateApi
    StageName: v1
    Tags:
      - Key: TagName
        Value: TagValue
    MethodSettings:
    ...

查看文档后，我想出了上面的代码。正如文档所述，它以上面显示的方式支持标签，但是当我部署时出现以下错误。

samcli.commands.validate.lib.exceptions.InvalidSamDocumentException: [InvalidResourceException('PrivateApi', "Type of property 'Tags' is invalid.")] ('PrivateApi', "Type of property 'Tags' is invalid.")

关于标签的文档链接：https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html

对此的任何帮助将不胜感激！

【问题讨论】：

标签： amazon-web-services yaml aws-sam

【解决方案1】：

我发现AWS::Serverless::API页面上的文档，和Tags页面在使用SAM时略有错误。

在SAM中表示标签的正确方法如下。

  Type: AWS::Serverless::Api
  Properties:
    Name: PrivateApi
    StageName: v1
    Tags:
      TagName: TagValue
    MethodSettings:
    ...

这种细微的差别使 SAM 可以正确部署。顺便说一句，在 API 阶段，您可以验证标签是否已正确部署。

【讨论】：