Amazon SAM模板元数据部分属性 - Amazon Serverless Application Model
Amazon Web Services 文档中描述的 Amazon Web Services 服务或功能可能因区域而异。要查看适用于中国区域的差异,请参阅中国的 Amazon Web Services 服务入门

本文属于机器翻译版本。若本译文内容与英语原文存在差异,则一律以英文原文为准。

Amazon SAM模板元数据部分属性

AWS::ServerlessRepo::Application是一个元数据键,您可以使用它来指定要发布到Amazon Serverless Application Repository.

注意

Amazon CloudFormation 内部函数不支持AWS::ServerlessRepo::Application元数据密钥。

Properties

此表提供了有关Metadata的 部分Amazon SAM模板。此部分需要将应用程序发布到Amazon Serverless Application Repository使用Amazon SAMCLI。

属性 类型 必需 描述
Name 字符串 TRUE

应用程序的名称。

最小长度 = 1。最大长度 = 140。

模式:"[a-zA-Z0-9\\-]+";

Description 字符串 TRUE

关于应用程序的描述。

最小长度 = 1。最大长度 = 256。

Author 字符串 TRUE

发布应用程序的作者的姓名。

最小长度 = 1。最大长度 = 127。

模式:"^[a-z0-9](([a-z0-9]|-(?!-))*[a-z0-9])?$";

SpdxLicenseId 字符串 FALSE 有效的许可证标识符。要查看有效许可证标识符的列表,请参阅SPDX 许可证列表上的软件包 Data Exchange (SPDX)网站。
LicenseUrl 字符串 FALSE

与应用程序的 SPDXLenicseID 值匹配的本地许可证文件或 Amazon S3 许可证文件链接的引用。

网络 ACL 和安全组都允许 (因此可到达您的实例) 的发起 ping 的Amazon SAM模板文件,该文件尚未使用sam package命令可以引用此属性的本地文件。但是,对于要使用sam publish命令,则此属性必须是对 Amazon S3 存储桶的引用。

最大容量:5 MB。

您必须为此属性提供一个值,才能使您的应用程序变为公有的。请注意,在发布应用程序后,您无法更新此属性。因此,要向应用程序添加许可证,必须先删除许可证,或者发布具有不同名称的新应用程序。

ReadmeUrl 字符串 FALSE

对本地自述文件的引用或 Amazon S3 链接,指向包含应用程序及其工作原理的更详细描述的自述文件。

网络 ACL 和安全组都允许 (因此可到达您的实例) 的发起 ping 的Amazon SAM模板文件,该文件尚未使用sam package命令可以引用此属性的本地文件。但是,要使用sam publish命令,则此属性必须是对 Amazon S3 存储桶的引用。

最大容量:5 MB。

Labels 字符串 FALSE

改善在搜索中发现应用程序的结果的标签。

最小长度 = 1。最大长度 = 127。最大标签数量:10.

模式:"^[a-zA-Z0-9+\\-_:\\/@]+$";

HomePageUrl 字符串 FALSE 一个 URL,其中包含有关应用程序的更多信息例如,应用程序的 GitHub 存储库的位置。
SemanticVersion 字符串 FALSE

应用程序的语义版本。有关语义版本控制规范,请参阅语义版本控制网站。

您必须为此属性提供一个值,才能使您的应用程序变为公有的。

SourceCodeUrl 字符串 FALSE 指向应用程序源代码的公共存储库的链接。

使用案例

本节列出了发布应用程序的使用案例,以及Metadata属性为该用例进行处理。属性不是将忽略给定用例列出的。

  • 创建新应用程序— 如果没有应用程序,则创建新的应用程序Amazon Serverless Application Repository与帐户的匹配名称。

    • Name

    • SpdxLicenseId

    • LicenseUrl

    • Description

    • Author

    • ReadmeUrl

    • Labels

    • HomePageUrl

    • SourceCodeUrl

    • SemanticVersion

    • 的内容Amazon SAM模板(例如,任何事件源、资源和 Lambda 函数代码)

     

  • 创建应用程序版本— 创建应用程序版本,如果Amazon Serverless Application Repository与帐户的匹配名称语义版本变化。

    • Description

    • Author

    • ReadmeUrl

    • Labels

    • HomePageUrl

    • SourceCodeUrl

    • SemanticVersion

    • 的内容Amazon SAM模板(例如,任何事件源、资源和 Lambda 函数代码)

     

  • 更新应用程序— 如果应用程序在Amazon Serverless Application Repository与帐户的匹配名称语义版本不是变化。

    • Description

    • Author

    • ReadmeUrl

    • Labels

    • HomePageUrl

Example

以下是示例Metadata部分:

Metadata: AWS::ServerlessRepo::Application: Name: my-app Description: hello world Author: user1 SpdxLicenseId: Apache-2.0 LicenseUrl: LICENSE.txt ReadmeUrl: README.md Labels: ['tests'] HomePageUrl: https://github.com/user1/my-app-project SemanticVersion: 0.0.1 SourceCodeUrl: https://github.com/user1/my-app-project