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

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

Amazon SAM元数据部分属性

AWS::ServerlessRepo::Application是元数据密钥，可用于指定要发布到Amazon Serverless Application Repository.

注意

Amazon CloudFormation 内部函数不支持AWS::ServerlessRepo::Application元数据键

属性

此表提供有关的属性的信息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

对本地许可证文件的引用，或指向许可证文件的 Amazon S3 链接，该文件与应用程序的 spdxLicSseID 值匹配。

网络 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

示例

以下是示例：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