AWS SAM anatomía de la plantilla

Un archivo AWS SAM de plantilla sigue de cerca el formato de un archivo de AWS CloudFormation plantilla, que se describe en Anatomía de la plantilla de la Guía del AWS CloudFormation usuario. Las principales diferencias entre los archivos AWS SAM de AWS CloudFormation plantilla y los archivos de plantilla son las siguientes:

• Declaración de transformación. La declaración Transform: AWS::Serverless-2016-10-31 es obligatoria para los archivos de plantilla de AWS SAM . Esta declaración identifica un archivo AWS CloudFormation de plantilla como un archivo AWS SAM de plantilla. Para obtener más información, consulte la Transformación en la AWS CloudFormation Guía del usuario de .

• Sección Globals. La Globals sección es exclusiva de AWS SAM. Define las propiedades que son comunes a todas las funciones y API sin servidor. Todos los recursos AWS::Serverless::Function, AWS::Serverless::Api y AWS::Serverless::SimpleTable heredan las propiedades que se definen en la sección Globals. Para obtener más información, consulte Sección Globals de la plantilla de AWS SAM.

• Sección de recursos. En AWS SAM las plantillas, la Resources sección puede contener una combinación de AWS CloudFormation recursos y AWS SAM recursos. Para obtener más información sobre AWS CloudFormation los recursos, consulte la referencia sobre los tipos de AWS recursos y propiedades en la Guía del AWS CloudFormation usuario. Para obtener más información sobre AWS SAM los recursos, consulteAWS SAM recursos y propiedades.

Todas las demás secciones de un archivo de AWS SAM plantilla corresponden a la sección del archivo de AWS CloudFormation plantilla del mismo nombre.

YAML

El siguiente ejemplo muestra un fragmento de código de plantilla con formato YAML.

Transform: AWS::Serverless-2016-10-31

Globals:
  set of globals

Description:
  String

Metadata:
  template metadata

Parameters:
  set of parameters

Mappings:
  set of mappings

Conditions:
  set of conditions

Resources:
  set of resources

Outputs:
  set of outputs

Secciones de la plantilla

AWS SAM las plantillas pueden incluir varias secciones principales. Solo se requieren las secciones Transform y Resources.

Puede incluir las secciones de la plantilla en cualquier orden. Sin embargo, si usa extensiones de idioma, debe agregarlas AWS::LanguageExtensions antes de la transformación sin servidor (es decir, antesAWS::Serverless-2016-10-31), como se muestra en el siguiente ejemplo:

Transform:
  - AWS::LanguageExtensions
  - AWS::Serverless-2016-10-31

Al crear la plantilla, puede resultar útil utilizar el orden lógico que se muestra en la siguiente lista. Esto se debe a que los valores de una sección pueden hacer referencia a valores de una sección anterior.

Transformar (obligatorio)

En el AWS SAM caso de las plantillas, debes incluir esta sección con un valor deAWS::Serverless-2016-10-31.

Las transformaciones adicionales son opcionales. Para obtener más información, consulte la Transformación en la AWS CloudFormation Guía del usuario de .

Globals (opcional)

Propiedades que son comunes a todas las funciones, tablas simples y API sin servidor. Todos los recursos AWS::Serverless::Function, AWS::Serverless::Api y AWS::Serverless::SimpleTable heredan las propiedades que se definen en la sección Globals.

Esta sección es exclusiva de AWS SAM. No hay una sección correspondiente en las plantillas de AWS CloudFormation .

Descripción (opcional)

Una cadena de texto que describe la plantilla.

Esta sección se corresponde directamente con la Description sección de AWS CloudFormation plantillas.

Metadatos (opcional)

Objetos que proporcionan información adicional acerca de la plantilla.

Esta sección se corresponde directamente con la Metadata sección de AWS CloudFormation plantillas.

Parámetros (opcional)

Valores que se van a pasar a su plantilla en tiempo de ejecución (al crear o actualizar una pila). Puede consultar los parámetros en las secciones Resources y Outputs de la plantilla. Los objetos que se declaran en la sección Parameters hacen que el comando sam deploy --guided presente solicitudes adicionales al usuario.

Los valores que se transfieren mediante el parámetro --parameter-overrides del comando sam deploy (y las entradas del archivo de configuración) tienen prioridad sobre las entradas del archivo de plantilla de AWS SAM . Para obtener más información sobre el comando sam deploy, consulte sam deploy en la referencia de comandos de la CLI de AWS SAM. Para obtener más información sobre el archivo de configuración, consulte Archivo de configuración de la CLI de AWS SAM.

Mapeos (opcional)

Un mapeo de claves y valores asociados que puede utilizar para especificar valores de parámetros condicionales, similar a una tabla de búsqueda. Puede asociar una clave a un valor correspondiente mediante la función intrínseca Fn::FindInMap en las secciones Resources y Outputs.

Esta sección se corresponde directamente con la Mappings sección de AWS CloudFormation plantillas.

Condiciones (opcional)

Condiciones que controlan si determinados recursos se crean o si a determinadas propiedades de recursos se les asigna un valor durante la creación de la pila o la actualización. Por ejemplo, puede crear un recurso condicionalmente que depende de si la pila es para un entorno de prueba o de producción.

Esta sección se corresponde directamente con la Conditions sección de AWS CloudFormation plantillas.

Recursos (obligatorio)

Especifica los recursos de la pila y sus propiedades, como, por ejemplo, una de instancia Amazon Elastic Compute Cloud (Amazon EC2) o un bucket de Amazon Simple Storage Service (Amazon S3). Puede consultar los recursos en las secciones Resources y Outputs de la plantilla.

Esta sección es similar a la sección Resources de plantillas de AWS CloudFormation . En AWS SAM las plantillas, esta sección puede contener AWS SAM recursos además de los AWS CloudFormation recursos.

Salidas (opcional)

Los valores que se devuelven siempre que ve las propiedades de su pila. Por ejemplo, puede declarar un resultado para el nombre de un bucket de S3 y, a continuación, llamar al comando aws cloudformation describe-stacks AWS Command Line Interface (AWS CLI) para ver el nombre.

Esta sección se corresponde directamente con la sección Outputs de plantillas de AWS CloudFormation .

Siguientes pasos

Para descargar e implementar un ejemplo de aplicación sin servidor que contenga un archivo de AWS SAM plantilla, consulta Empezar con AWS SAM y sigue las instrucciones que se indican enTutorial: Implementar una aplicación Hello World.