AWS SAM 樣板中繼資料區段性 - AWS Serverless Application Model
屬性使用案例範例

本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。

AWS SAM 樣板中繼資料區段性

AWS::ServerlessRepo::Application是中繼資料索引鍵，可用來指定您要發佈至的應用程式資訊 AWS Serverless Application Repository。

注意

AWS CloudFormation AWS::ServerlessRepo::Application中繼資料金鑰不支援內建函式。

屬性

此表格提供樣 AWS SAM 板Metadata段落特性的相關資訊。若要將應用程式發行到 AWS Serverless Application Repository 使用，需要本節 AWS SAMCLI。

屬性 Type 必要 描述
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 有效的授權識別碼。若要檢視有效的授權識別碼清單，請參閱軟體 Package 件 Data Exchange (SPDX) 網站上的 SPDX 授權清單。
LicenseUrl 字串 FALSE

本機授權檔案或授權檔案的 Amazon S3 連結的參考，符合您應用程式的 SPDxLicenseID 值。

尚未使用sam package指令封裝的 AWS SAM 範本檔案可以具有此屬性的本機檔案參考。不過，若要使用sam publish命令發佈應用程式，此屬性必須是 Amazon S3 儲存貯體的參考。

最大尺寸：5 MB。

您必須為此屬性提供值，才能將您的應用程式公開。請注意，您無法在應用程式發佈之後更新此屬性。因此，若要將授權新增至應用程式，您必須先將其刪除，或使用不同名稱發佈新的應用程式。
ReadmeUrl 字串 FALSE

本機讀我檔案的參考或 Amazon S3 連結至 Readme 檔案，其中包含應用程式及其運作方式的更詳細說明。

尚未使用sam package指令封裝的 AWS SAM 範本檔案可以具有此屬性的本機檔案參考。不過，若要使用sam publish命令發佈，此屬性必須是 Amazon S3 儲存貯體的參考。

最大尺寸：5 MB。
Labels 字串 FALSE

改善搜尋結果中應用程式探索的標籤。

最小長度 = 1。最大長度 = 127。最大標籤數量：10。

模式："^[a-zA-Z0-9+\\-_:\\/@]+$";
HomePageUrl 字串 FALSE 一個 URL，其中包含有關應用程式的詳細資訊，例如應用程式 GitHub 存放庫的位置。
SemanticVersion 字串 FALSE

應用程式的語義版本。如需語意版本設定規格，請參閱語意版本控制網站。

您必須為此屬性提供值，才能將您的應用程式公開。
SourceCodeUrl 字串 FALSE 應用程式原始程式碼的公有儲存庫連結。

使用案例

本節列出發佈應用程式的使用案例，以及針對該使用案例處理的Metadata屬性。系統會忽略未針對指定使用案例列出的屬性。

  • 建立新應用程式 — 如果中沒有 AWS Serverless Application Repository 與帳戶名稱相符的應用程式，則會建立新應用程式。

    • Name

    • SpdxLicenseId

    • LicenseUrl

    • Description

    • Author

    • ReadmeUrl

    • Labels

    • HomePageUrl

    • SourceCodeUrl

    • SemanticVersion

    • AWS SAM 範本的內容 (例如，任何事件來源、資源和 Lambda 函數程式碼)

     

  • 建立應用程式版本 — 如果中已有 AWS Serverless Application Repository 與帳戶相符名稱的應用程式，且正在變更，則會建立應用程 SemanticVersion式版本。

    • Description

    • Author

    • ReadmeUrl

    • Labels

    • HomePageUrl

    • SourceCodeUrl

    • SemanticVersion

    • AWS SAM 範本的內容 (例如，任何事件來源、資源和 Lambda 函數程式碼)

     

  • 更新應用程式 — 如果中已有 AWS Serverless Application Repository 與帳戶相符名稱的應用程式，且未變更應用程式， SemanticVersion則會更新應用程式。

    • 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