AWS SAM proprietà della sezione Metadati del modello - AWS Serverless Application Model
ProprietàCasi d'usoEsempio

Le traduzioni sono generate tramite traduzione automatica. In caso di conflitto tra il contenuto di una traduzione e la versione originale in Inglese, quest'ultima prevarrà.

AWS SAM proprietà della sezione Metadati del modello

AWS::ServerlessRepo::Applicationè una chiave di metadati che potete utilizzare per specificare le informazioni sull'applicazione che desiderate pubblicare su. AWS Serverless Application Repository

Nota

AWS CloudFormation le funzioni intrinseche non sono supportate dalla chiave dei AWS::ServerlessRepo::Application metadati.

Proprietà

Questa tabella fornisce informazioni sulle proprietà della Metadata sezione del modello. AWS SAM Questa sezione è necessaria per pubblicare applicazioni AWS Serverless Application Repository che utilizzano AWS SAMCLI.

Proprietà Type 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 degli identificatori di licenza validi, vedere l'elenco delle licenze SPDX sul sito Web Software Package Data Exchange (SPDX).
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 dell'applicazione.

Un file AWS SAM modello che non è stato impacchettato utilizzando il sam package comando può avere un riferimento a un file locale per questa proprietà. Tuttavia, affinché un'applicazione possa essere pubblicata utilizzando il sam publish comando, 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. Tieni presente che non puoi aggiornare questa proprietà dopo la pubblicazione dell'applicazione. Pertanto, per aggiungere una licenza a un'applicazione, è necessario prima eliminarla o pubblicare una nuova applicazione con un nome diverso.
ReadmeUrl Stringa FALSE

Il riferimento a un file readme locale o un collegamento Amazon S3 al file readme che contiene una descrizione più dettagliata dell'applicazione e del suo funzionamento.

Un file AWS SAM modello che non è stato impacchettato utilizzando il sam package comando può avere un riferimento a un file locale per questa proprietà. Tuttavia, per essere pubblicata utilizzando il sam publish comando, questa proprietà deve essere un riferimento a un bucket Amazon S3.

Dimensione massima: 5 MB.
Labels Stringa FALSE

Le etichette che migliorano la scoperta 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 GitHub repository dell'applicazione.
SemanticVersion Stringa FALSE

La versione semantica dell'applicazione. Per le specifiche di Semantic Versioning, consultate il sito Web Semantic Versioning.

È 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

Questa sezione elenca i casi d'uso per le applicazioni di pubblicazione, insieme alle Metadata proprietà elaborate per tale caso d'uso. Le proprietà che non sono elencate per un determinato caso d'uso vengono ignorate.

  • Creazione di una nuova applicazione: viene creata una nuova applicazione se non è presente alcuna applicazione AWS Serverless Application Repository con un nome corrispondente per un account.

    • Name

    • SpdxLicenseId

    • LicenseUrl

    • Description

    • Author

    • ReadmeUrl

    • Labels

    • HomePageUrl

    • SourceCodeUrl

    • SemanticVersion

    • Il contenuto del AWS SAM modello (ad esempio, eventuali fonti di eventi, risorse e codice funzione Lambda)

     

  • Creazione di una versione dell'applicazione: viene creata una versione dell'applicazione se esiste già un'applicazione AWS Serverless Application Repository con un nome corrispondente per un account e questa SemanticVersion è in corso di modifica.

    • Description

    • Author

    • ReadmeUrl

    • Labels

    • HomePageUrl

    • SourceCodeUrl

    • SemanticVersion

    • Il contenuto del AWS SAM modello (ad esempio, eventuali fonti di eventi, risorse e codice funzione Lambda)

     

  • Aggiornamento di un'applicazione: un'applicazione viene aggiornata se esiste già un'applicazione AWS Serverless Application Repository con un nome corrispondente per un account e non SemanticVersion viene modificata.

    • Description

    • Author

    • ReadmeUrl

    • Labels

    • HomePageUrl

Esempio

Di seguito è riportata una Metadata sezione di esempio:

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