如何在AWS SAM中将标签添加到专用API网关

Question

我已经使用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

如有任何帮助，我们将不胜感激！

Answer 1

我发现当使用SAM.时，AWS:：Serverless:：API页面和Tags页面上的文档有点错误

SAM中标记的正确表示方式如下。

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

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