AWS SAM Eigenschaften des Vorlagen-Metadatenabschnitts - AWS Serverless Application Model
EigenschaftenAnwendungsfälleBeispiel

Die vorliegende Übersetzung wurde maschinell erstellt. Im Falle eines Konflikts oder eines Widerspruchs zwischen dieser übersetzten Fassung und der englischen Fassung (einschließlich infolge von Verzögerungen bei der Übersetzung) ist die englische Fassung maßgeblich.

AWS SAM Eigenschaften des Vorlagen-Metadatenabschnitts

AWS::ServerlessRepo::Applicationist ein Metadatenschlüssel, mit dem Sie Anwendungsinformationen angeben können, die Sie in der veröffentlichen möchten AWS Serverless Application Repository.

Anmerkung

AWS CloudFormation Systeminterne Funktionen werden vom AWS::ServerlessRepo::Application Metadatenschlüssel nicht unterstützt.

Eigenschaften

Diese Tabelle enthält Informationen zu den Eigenschaften des Metadata Abschnitts der AWS SAM Vorlage. Dieser Abschnitt ist erforderlich, um Anwendungen AWS Serverless Application Repository unter Verwendung von zu veröffentlichen AWS SAMCLI.

Eigenschaft Typ Erforderlich Beschreibung
Name String TRUE

Der Name der Anwendung.

Minimale Länge = 1. Maximale Länge = 140.

Pattern: "[a-zA-Z0-9\\-]+";
Description String TRUE

Die Beschreibung der Anwendung.

Minimale Länge = 1. Maximale Länge = 256.
Author String TRUE

Der Name des Autors, der die Anwendung veröffentlicht.

Minimale Länge = 1. Maximale Länge = 127.

Pattern: "^[a-z0-9](([a-z0-9]|-(?!-))*[a-z0-9])?$";
SpdxLicenseId String FALSE Eine gültige Lizenz-ID. Eine Liste der gültigen Lizenzkennungen finden Sie in der SPDX-Lizenzliste auf der Software Package Data Exchange (SPDX) -Website.
LicenseUrl String FALSE

Der Verweis auf eine lokale Lizenzdatei oder ein Amazon S3 S3-Link zu einer Lizenzdatei, der dem spdxLicenseID-Wert Ihrer Anwendung entspricht.

Eine AWS SAM Vorlagendatei, die nicht mit dem sam package Befehl gepackt wurde, kann einen Verweis auf eine lokale Datei für diese Eigenschaft enthalten. Damit eine Anwendung mit dem sam publish Befehl veröffentlicht werden kann, muss diese Eigenschaft jedoch ein Verweis auf einen Amazon S3 S3-Bucket sein.

Maximale Größe: 5 MB.

Sie müssen einen Wert für diese Eigenschaft angeben, um Ihre Anwendung öffentlich zu machen. Beachten Sie, dass Sie diese Eigenschaft nicht aktualisieren können, nachdem Ihre Anwendung veröffentlicht wurde. Um einer Anwendung eine Lizenz hinzuzufügen, müssen Sie sie entweder zuerst löschen oder eine neue Anwendung mit einem anderen Namen veröffentlichen.
ReadmeUrl String FALSE

Der Verweis auf eine lokale Readme-Datei oder ein Amazon S3 S3-Link zur Readme-Datei, die eine detailliertere Beschreibung der Anwendung und ihrer Funktionsweise enthält.

Eine AWS SAM Vorlagendatei, die nicht mit dem sam package Befehl gepackt wurde, kann einen Verweis auf eine lokale Datei für diese Eigenschaft enthalten. Um mit dem sam publish Befehl veröffentlicht zu werden, muss diese Eigenschaft jedoch ein Verweis auf einen Amazon S3 S3-Bucket sein.

Maximale Größe: 5 MB.
Labels String FALSE

Die Bezeichnungen, die das Auffinden von Anwendungen in den Suchergebnissen verbessern.

Minimale Länge = 1. Maximale Länge = 127. Maximale Anzahl der Etiketten: 10.

Pattern: "^[a-zA-Z0-9+\\-_:\\/@]+$";
HomePageUrl String FALSE Eine URL mit weiteren Informationen über die Anwendung, z. B. den Speicherort Ihres GitHub Repositorys für die Anwendung.
SemanticVersion String FALSE

Die semantische Version der Anwendung. Die Semantic Versioning-Spezifikation finden Sie auf der Semantic Versioning-Website.

Sie müssen einen Wert für diese Eigenschaft angeben, um Ihre Anwendung öffentlich zu machen.
SourceCodeUrl String FALSE Ein Link zu einem öffentlichen Repository für den Quellcode Ihrer Anwendung.

Anwendungsfälle

In diesem Abschnitt werden die Anwendungsfälle für die Veröffentlichung von Anwendungen zusammen mit den Metadata Eigenschaften aufgeführt, die für diesen Anwendungsfall verarbeitet werden. Eigenschaften, die für einen bestimmten Anwendungsfall nicht aufgeführt sind, werden ignoriert.

  • Eine neue Anwendung erstellen — Eine neue Anwendung wird erstellt, wenn in der keine Anwendung AWS Serverless Application Repository mit einem passenden Namen für ein Konto vorhanden ist.

    • Name

    • SpdxLicenseId

    • LicenseUrl

    • Description

    • Author

    • ReadmeUrl

    • Labels

    • HomePageUrl

    • SourceCodeUrl

    • SemanticVersion

    • Der Inhalt der AWS SAM Vorlage (z. B. alle Eventquellen, Ressourcen und Lambda-Funktionscode)

     

  • Anwendungsversion erstellen — Eine Anwendungsversion wird erstellt, wenn in der bereits eine Anwendung AWS Serverless Application Repository mit einem passenden Namen für ein Konto vorhanden SemanticVersion ist und diese sich ändert.

    • Description

    • Author

    • ReadmeUrl

    • Labels

    • HomePageUrl

    • SourceCodeUrl

    • SemanticVersion

    • Der Inhalt der AWS SAM Vorlage (z. B. alle Eventquellen, Ressourcen und Lambda-Funktionscode)

     

  • Aktualisierung einer Anwendung — Eine Anwendung wird aktualisiert, wenn in der bereits eine Anwendung AWS Serverless Application Repository mit einem passenden Namen für ein Konto vorhanden SemanticVersion ist und die sich nicht ändert.

    • Description

    • Author

    • ReadmeUrl

    • Labels

    • HomePageUrl

Beispiel

Im Folgenden finden Sie einen Metadata Beispielabschnitt:

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