Propiedades de la sección de metadatos de la plantilla de AWS SAM - AWS Serverless Application Model
PropiedadesCasos de usoEjemplo

Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.

Propiedades de la sección de metadatos de la plantilla de AWS SAM

AWS::ServerlessRepo::Application es una clave de metadatos que puede usar para especificar la información de la aplicación que desea que se publique en AWS Serverless Application Repository.

nota

La clave de metadatos AWS::ServerlessRepo::Application de AWS CloudFormation no admite funciones intrínsecas.

Propiedades

En esta tabla se proporciona información sobre las propiedades de la sección Metadata de la plantilla de AWS SAM. Esta sección es necesaria para publicar aplicaciones AWS Serverless Application Repository en la CLI de AWS SAM.

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 FALSO Un identificador de licencia válido. Para ver la lista de identificadores de licencia válidos, consulta la Lista de licencias de SPDX en el sitio web Package Data Exchange (SPDX).
LicenseUrl Cadena FALSO

La referencia a un archivo de licencia local, o un enlace de Amazon S3 a un archivo de licencia, que coincide con el valor SPDXLicenseID de su aplicación.

Un archivo de plantilla de AWS SAM que no se haya empaquetado con el comando sam package puede tener una referencia a un archivo local para esta propiedad. Sin embargo, para que una aplicación se publique mediante el comando sam publish, esta propiedad debe hacer 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 una vez publicada la aplicación. Por lo tanto, para añadir una licencia a una aplicación, primero debe eliminarla o publicar una nueva aplicación con un nombre diferente.
ReadmeUrl Cadena FALSO

La referencia a un archivo readme local o un enlace de Amazon S3 al archivo readme que contiene una descripción más detallada de la aplicación y de su funcionamiento.

Un archivo de plantilla de AWS SAM que no se haya empaquetado con el comando sam package puede tener una referencia a un archivo local para esta propiedad. Sin embargo, para que se publique mediante el comando sam publish, esta propiedad debe ser una referencia a un bucket de Amazon S3.

Tamaño máximo: 5 MB.
Labels Cadena FALSO

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 FALSO 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 FALSO

La versión semántica de la aplicación. Para obtener más información sobre el control de versiones semántico, consulta el sitio web Control de versiones semántico.

Debe proporcionar un valor de esta propiedad para que la aplicación sea pública.
SourceCodeUrl Cadena FALSO 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 para publicar aplicaciones, junto con las propiedades Metadata que se procesan para ese caso de uso. Se omiten las propiedades que no aparecen 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 AWS Serverless Application Repository con un nombre coincidente para una cuenta.

    • Name

    • SpdxLicenseId

    • LicenseUrl

    • Description

    • Author

    • ReadmeUrl

    • Labels

    • HomePageUrl

    • SourceCodeUrl

    • SemanticVersion

    • El contenido de la plantilla de AWS SAM (por ejemplo, cualquier fuente de eventos, recursos y código de la función de Lambda)

     

  • Creación de una versión de la aplicación: se crea una versión de la aplicación si ya existe una aplicación AWS Serverless Application Repository con el mismo nombre para una cuenta y la versión semántica está cambiando.

    • Description

    • Author

    • ReadmeUrl

    • Labels

    • HomePageUrl

    • SourceCodeUrl

    • SemanticVersion

    • El contenido de la plantilla de AWS SAM (por ejemplo, cualquier fuente de eventos, recursos y código de la función de Lambda)

     

  • Actualización de una aplicación: una aplicación se actualiza si ya existe una aplicación AWS Serverless Application Repository con un nombre coincidente para una cuenta y la versión semántica no cambia.

    • Description

    • Author

    • ReadmeUrl

    • Labels

    • HomePageUrl

Ejemplo

A continuación, se ofrece un ejemplo de sección 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