Propriétés de la section Métadonnées du modèle AWS SAM - AWS Serverless Application Model
PropriétésCas d’utilisationExemple

Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.

Propriétés de la section Métadonnées du modèle AWS SAM

AWS::ServerlessRepo::Application est une clé de métadonnées que vous pouvez utiliser pour spécifier les informations d'application que vous souhaitez publier dans le AWS Serverless Application Repository.

Note

AWS CloudFormation les fonctions intrinsèques ne sont pas prises en charge par la clé de AWS::ServerlessRepo::Application métadonnées.

Propriétés

Ce tableau fournit des informations sur les propriétés de la Metadata section du AWS SAM modèle. Cette section est requise pour publier des applications à l' AWS Serverless Application Repository aide du AWS SAMCLI.

Propriété Type Obligatoire Description
Name Chaîne TRUE

Nom de l'application.

Longueur minimale = 1. Longueur maximale = 140.

Modèle : "[a-zA-Z0-9\\-]+";
Description Chaîne TRUE

Description de l'application.

Longueur minimale = 1. Longueur maximale = 256.
Author Chaîne TRUE

Nom de l'auteur qui publie l'application.

Longueur minimale = 1. Longueur maximale = 127.

Modèle : "^[a-z0-9](([a-z0-9]|-(?!-))*[a-z0-9])?$";
SpdxLicenseId Chaîne FAUX Un identifiant de licence valide. Pour afficher la liste des identifiants de licence valides, veuillez consulter Liste des licences SPDX sur le site web de Data Exchange de packages de progiciels (SPDX).
LicenseUrl Chaîne FAUX

La référence à un fichier de licence local, ou à un lien Amazon S3 vers un fichier de licence, qui correspond à la valeur spdxLicenseID de votre application.

Un fichier AWS SAM modèle qui n'a pas été empaqueté à l'aide de la sam package commande peut contenir une référence à un fichier local pour cette propriété. Toutefois, pour qu'une application soit publiée à l'aide de la commande sam publish, cette propriété doit être une référence à un compartiment Amazon S3.

Taille maximale : 5 Go

Vous devez fournir une valeur pour cette propriété afin de rendre votre application publique. Notez que vous ne pouvez pas mettre à jour cette propriété après la publication de votre application. Ainsi, pour ajouter une licence à une application, vous devez soit la supprimer d'abord, soit publier une nouvelle application avec un nom différent.
ReadmeUrl Chaîne FAUX

La référence à un fichier readme local ou à un lien Amazon S3 vers le fichier readme qui contient une description plus détaillée de l'application et de son fonctionnement.

Un fichier AWS SAM modèle qui n'a pas été empaqueté à l'aide de la sam package commande peut contenir une référence à un fichier local pour cette propriété. Toutefois, pour être publié à l'aide de la commande sam publish, cette propriété doit être une référence à un compartiment Amazon S3.

Taille maximale : 5 Go
Labels Chaîne FAUX

Les étiquettes qui améliorent la découverte d'applications dans les résultats de recherche.

Longueur minimale = 1. Longueur maximale = 127. Nombre maximal d'étiquettes : 10.

Modèle : "^[a-zA-Z0-9+\\-_:\\/@]+$";
HomePageUrl Chaîne FAUX URL contenant des informations supplémentaires sur l'application, par exemple l'emplacement de votre GitHub référentiel pour l'application.
SemanticVersion Chaîne FAUX

Version sémantique de l'application. Pour obtenir la spécification de gestion sémantique des versions, consultez le site web de Gestion sémantique des versions.

Vous devez fournir une valeur pour cette propriété afin de rendre votre application publique.
SourceCodeUrl Chaîne FAUX Lien vers un référentiel public pour le code source de votre application.

Cas d’utilisation

Cette section répertorie les cas d'utilisation pour la publication d'applications, ainsi que les propriétés de Metadata qui sont traitées pour ce cas d'utilisation. Les propriétés qui sont pas répertoriés pour un cas d'utilisation donné sont ignorées.

  • Création d'une nouvelle application — Une nouvelle application est créée si aucune application ne porte le AWS Serverless Application Repository même nom pour un compte.

    • Name

    • SpdxLicenseId

    • LicenseUrl

    • Description

    • Author

    • ReadmeUrl

    • Labels

    • HomePageUrl

    • SourceCodeUrl

    • SemanticVersion

    • Le contenu du AWS SAM modèle (par exemple, toutes les sources d'événements, les ressources et le code de fonction Lambda)

     

  • Création d'une version d'application — Une version d'application est créée s'il existe déjà une application dans le nom correspondant AWS Serverless Application Repository à un compte et qu'elle SemanticVersion est en train de changer.

    • Description

    • Author

    • ReadmeUrl

    • Labels

    • HomePageUrl

    • SourceCodeUrl

    • SemanticVersion

    • Le contenu du AWS SAM modèle (par exemple, toutes les sources d'événements, les ressources et le code de fonction Lambda)

     

  • Mise à jour d'une application — Une application est mise à jour s'il existe déjà une application AWS Serverless Application Repository dont le nom correspond à celui d'un compte et SemanticVersion qu'elle ne change pas.

    • Description

    • Author

    • ReadmeUrl

    • Labels

    • HomePageUrl

Exemple

Voici un exemple de section 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