AWS SAMProprietà della sezione di metadati template

AWS::ServerlessRepo::Applicationè una chiave di metadati che è possibile utilizzare per specificare le informazioni dell'applicazione che si desidera pubblicare nelAWS Serverless Application Repository.

Nota

AWS CloudFormation funzioni intrinsechenon sono supportati dalAWS::ServerlessRepo::Applicationchiave di metadati.

Proprietà

Questa tabella fornisce informazioni sulle proprietà delMetadataSezione dellaAWS SAMtemplate. Questa sezione è necessaria per pubblicare le applicazioni sulAWS Serverless Application Repositoryutilizzando ilAWS SAMCLI.

Proprietà	Tipo	Campo obbligatorio	Descrizione
Name	Stringa	TRUE	Il nome dell'applicazione. Lunghezza minima = 1. Lunghezza massima = 140. Modello: "[a-zA-Z0-9\\-]+";
Description	Stringa	TRUE	Descrizione dell'applicazione. Lunghezza minima = 1. Lunghezza massima = 256.
Author	Stringa	TRUE	Il nome dell'autore che pubblica l'applicazione. Lunghezza minima = 1. Lunghezza massima = 127. Modello: "^[a-z0-9](([a-z0-9]|-(?!-))*[a-z0-9])?$";
SpdxLicenseId	Stringa	FALSE	Un identificatore di licenza valido. Per visualizzare l'elenco di identificatori di licenza validi, consultaLista di licenze SPDXsulData Exchange pacchetto software (SPDX)sito Web.
LicenseUrl	Stringa	FALSE	Il riferimento a un file di licenza locale o a un collegamento Amazon S3 a un file di licenza, che corrisponde al valore SPDXLicenseID della tua applicazione. Un recordAWS SAMfile modello che non è stato confezionato utilizzando ilsam packageil comando può avere un riferimento a un file locale per questa proprietà. Tuttavia, per la pubblicazione di un'applicazione utilizzando ilsam publishcomando, questa proprietà deve essere un riferimento a un bucket Amazon S3. Dimensione massima: 5 MB. È necessario fornire un valore per questa proprietà per rendere pubblica l'applicazione. Nota che non è possibile aggiornare questa proprietà dopo la pubblicazione dell'applicazione. Pertanto, per aggiungere una licenza a un'applicazione, è necessario eliminarla prima o pubblicare una nuova applicazione con un nome diverso.
ReadmeUrl	Stringa	FALSE	Il riferimento a un file readme locale o ad un collegamento Amazon S3 al file readme che contiene una descrizione più dettagliata dell'applicazione e del suo funzionamento. Un recordAWS SAMfile modello che non è stato confezionato utilizzando ilsam packageil comando può avere un riferimento a un file locale per questa proprietà. Tuttavia, da pubblicare utilizzando ilsam publishcomando, questa proprietà deve essere un riferimento a un bucket Amazon S3. Dimensione massima: 5 MB.
Labels	Stringa	FALSE	Etichette che migliorano l'individuazione delle applicazioni nei risultati di ricerca. Lunghezza minima = 1. Lunghezza massima = 127. Numero massimo di etichette: 10. Modello: "^[a-zA-Z0-9+\\-_:\\/@]+$";
HomePageUrl	Stringa	FALSE	Un URL con ulteriori informazioni sull'applicazione, ad esempio la posizione del repository GitHub per l'applicazione.
SemanticVersion	Stringa	FALSE	La versione semantica dell'applicazione. Per le specifiche Versionamento semantico, consulta laVersionamento semanticosito Web. È necessario fornire un valore per questa proprietà per rendere pubblica l'applicazione.
SourceCodeUrl	Stringa	FALSE	Un collegamento a un repository pubblico per il codice sorgente dell'applicazione.

Casi d'uso

In questa sezione sono elencati i casi d'uso per la pubblicazione di applicazioni, insieme allaMetadataproprietà che vengono elaborate per quel caso d'uso. Proprietà che sonononelencati per un determinato caso d'uso vengono ignorati.

• Creazione di una nuova applicazione— Viene creata una nuova applicazione in caso non esiste applicazione nel file.AWS Serverless Application Repositorycon un nome corrispondente per un account.

  • Name

  • SpdxLicenseId

  • LicenseUrl

  • Description

  • Author

  • ReadmeUrl

  • Labels

  • HomePageUrl

  • SourceCodeUrl

  • SemanticVersion

  • Il contenuto dellaAWS SAMtemplate (ad esempio, fonti di eventi, risorse e codice funzione Lambda)

   

• Creazione di una versione dell'applicazione— Viene creata una versione dell'applicazione se è già presente un'applicazione nelAWS Serverless Application Repositorycon un nome corrispondente per un accountela versione semanticaècambiando.

  • Description

  • Author

  • ReadmeUrl

  • Labels

  • HomePageUrl

  • SourceCodeUrl

  • SemanticVersion

  • Il contenuto dellaAWS SAMtemplate (ad esempio, fonti di eventi, risorse e codice funzione Lambda)

   

• Aggiornamento di un'applicazione— Un'applicazione viene aggiornata se è già presente un'applicazione nelAWS Serverless Application Repositorycon un nome corrispondente per un accountela versione semanticanon ècambiando.

  • Description

  • Author

  • ReadmeUrl

  • Labels

  • HomePageUrl

Esempio

Di seguito è riportato un esempio di:Metadatasezione:

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