AWS SAMPropiedades de la sección de metadatos de plantilla

AWS::ServerlessRepo::Applicationes una clave de metadatos que puede utilizar para especificar la información de la aplicación que desea publicar en elAWS Serverless Application Repository.

nota

AWS CloudFormation funciones intrínsecasno están soportados por elAWS::ServerlessRepo::Applicationclave de metadatos.

Properties

En esta tabla se proporciona información sobre las propiedades delMetadataSección sobre de laAWS SAMplantilla. Esta sección es necesaria para publicar aplicaciones en elAWS Serverless Application RepositoryUsando lasAWS SAMCLI.

Propiedad	Tipo	Obligatorio	Descripción
Name	Cadena	TRUE	Nombre de la aplicación. Longitud mínima = 1. Longitud máxima = 140. Patrón: "[a-zA-Z0-9\\-]+";
Description	Cadena	TRUE	La descripción de la aplicación. Longitud mínima = 1. Longitud máxima = 256.
Author	Cadena	TRUE	El nombre del autor que publica la aplicación. Longitud mínima = 1. Longitud máxima = 127. Patrón: "^[a-z0-9](([a-z0-9]|-(?!-))*[a-z0-9])?$";
SpdxLicenseId	Cadena	FALSE	Un identificador de licencia válido. Para ver las lista de identificadores de licencia válidos, consulteLista de licencias SPDXen elData Exchange de paquetes de software (SPDX)Sitio web.
LicenseUrl	Cadena	FALSE	La referencia a un archivo de licencia local, o un vínculo de Amazon S3 a un archivo de licencia, que coincide con el valor SPDXLicenseID de su aplicación. UnAWS SAMarchivo de plantilla que no se ha empaquetado mediante elsam packagepuede tener una referencia a un archivo local para esta propiedad. Sin embargo, para que una aplicación se publique mediante elsam publish, esta propiedad debe ser una referencia a un bucket de Amazon S3. Tamaño máximo: 5 MB. Debe proporcionar un valor de esta propiedad para que la aplicación sea pública. Tenga en cuenta que no puede actualizar esta propiedad después de publicar la aplicación. Por lo tanto, para agregar una licencia a una aplicación, debe eliminarla primero o publicar una nueva aplicación con otro nombre.
ReadmeUrl	Cadena	FALSE	Referencia a un archivo léame local o a un enlace de Amazon S3 al archivo léame que contiene una descripción más detallada de la aplicación y cómo funciona. UnAWS SAMarchivo de plantilla que no se ha empaquetado mediante elsam packagepuede tener una referencia a un archivo local para esta propiedad. Sin embargo, se publicará utilizando elsam publish, esta propiedad debe ser una referencia a un bucket de Amazon S3. Tamaño máximo: 5 MB.
Labels	Cadena	FALSE	Las etiquetas que mejoran la detección de las aplicaciones en los resultados de búsqueda. Longitud mínima = 1. Longitud máxima = 127. Número máximo de etiquetas: 10. Patrón: "^[a-zA-Z0-9+\\-_:\\/@]+$";
HomePageUrl	Cadena	FALSE	Una URL con más información sobre la aplicación por ejemplo, la ubicación del repositorio de GitHub para la aplicación.
SemanticVersion	Cadena	FALSE	La versión semántica de la aplicación. Para ver las especificaciones de Semantic Versioning, consulte laVersioning semánticoSitio web. Debe proporcionar un valor de esta propiedad para que la aplicación sea pública.
SourceCodeUrl	Cadena	FALSE	Un enlace a un repositorio público para el código fuente de la aplicación.

Casos de uso

En esta sección se enumeran los casos de uso de las aplicaciones de publicación, junto con elMetadatapropiedades que se procesan para ese caso de uso. Propiedades que sonnose ignoran en la lista para un caso de uso determinado.

• Creación de una nueva aplicación— Se crea una nueva aplicación si no hay ninguna aplicación en elAWS Serverless Application Repositorycon un nombre coincidente para una cuenta.

  • Name

  • SpdxLicenseId

  • LicenseUrl

  • Description

  • Author

  • ReadmeUrl

  • Labels

  • HomePageUrl

  • SourceCodeUrl

  • SemanticVersion

  • El contenido delAWS SAMplantilla (por ejemplo, cualquier fuente de eventos, recursos y código de función Lambda)

   

• Creación de una versión de la aplicación— Se crea una versión de aplicación si ya hay una aplicación en elAWS Serverless Application Repositorycon un nombre coincidente para una cuentayla versión semánticaescambiando.

  • Description

  • Author

  • ReadmeUrl

  • Labels

  • HomePageUrl

  • SourceCodeUrl

  • SemanticVersion

  • El contenido delAWS SAMplantilla (por ejemplo, cualquier fuente de eventos, recursos y código de función Lambda)

   

• Actualización de una aplicación— Se actualiza una aplicación si ya hay una aplicación en elAWS Serverless Application Repositorycon un nombre coincidente para una cuentayla versión semánticano escambiando.

  • Description

  • Author

  • ReadmeUrl

  • Labels

  • HomePageUrl

Ejemplo

A continuación se muestra un ejemplo deMetadatasección :

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