Función - AWS Serverless Application Model
SintaxisPropiedades

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.

Función

Configura funciones en las API de GraphQL para realizar ciertas operaciones.

Sintaxis

Para declarar esta entidad en tu plantilla de AWS Serverless Application Model (AWS SAM), usa la siguiente sintaxis:

YAML

LogicalId:
  CodeUri: String
  DataSource: String
  Description: String
  Id: String
  InlineCode: String
  MaxBatchSize: Integer
  Name: String
  Runtime: Runtime
  Sync: SyncConfig

Propiedades

CodeUri

Una URL de Amazon Simple Storage Service (Amazon S3) es de código de función o es una ruta de acceso a una carpeta local.

Si especifica una ruta a una carpeta local, AWS CloudFormation requiere que el archivo se cargue primero en Amazon S3 antes de la implementación. Puedes utilizar la AWS SAM CLI para facilitar este proceso. Para obtener más información, consulta Cómo se AWS SAM cargan los archivos locales en el momento de la implementación.

Tipo: cadena

Obligatorio: no

Compatibilidad con AWS CloudFormation: esta propiedad se transfiere directamente a la propiedad CodeS3Location de un recurso AWS::AppSync::FunctionConfiguration.

DataSource

El nombre de origen de datos al que se asociará esta función.

  • Para hacer referencia a un origen de datos dentro del recurso AWS::Serverless::GraphQLApi, especifique su ID lógico.

  • Para hacer referencia a un origen de datos externo al recurso AWS::Serverless::GraphQLApi, proporciona su atributo Name mediante la función intrínseca Fn::GetAtt. Por ejemplo, !GetAtt MyLambdaDataSource.Name.

  • Para hacer referencia a un origen de datos desde una pila diferente, utilice Fn::ImportValue.

Si se especifica una variación de [NONE | None | none], AWS SAM generará un valor None para el objeto AWS::AppSync::DataSource Type.

Tipo: cadena

Obligatorio: sí

Compatibilidad con AWS CloudFormation: esta propiedad se transfiere directamente a la propiedad DataSourceName de un recurso AWS::AppSync::FunctionConfiguration.

Description

La descripción de la función.

Tipo: cadena

Obligatorio: no

Compatibilidad con AWS CloudFormation: esta propiedad se transfiere directamente a la propiedad Description de un recurso AWS::AppSync::FunctionConfiguration.

Id

El identificador de función de una función ubicada fuera del recurso AWS::Serverless::GraphQLApi.

  • Para hacer referencia a una función dentro de la misma plantilla de AWS SAM, utilice la función intrínseca Fn::GetAtt. Por ejemplo, Id: !GetAtt createPostItemFunc.FunctionId.

  • Para hacer referencia a una función desde una pila diferente, utilice Fn::ImportValue.

Cuando se usa Id, no se permiten todas las demás propiedades. AWS SAM pasará automáticamente el ID de función de la función a la que se hace referencia.

Tipo: cadena

Obligatorio: no

Compatibilidad con AWS CloudFormation: esta propiedad es exclusiva de AWS SAM y no tiene un equivalente AWS CloudFormation.

InlineCode

El código de la función que contiene las funciones de solicitud y respuesta.

Tipo: cadena

Obligatorio: no

Compatibilidad con AWS CloudFormation: esta propiedad se transfiere directamente a la propiedad Code de un recurso AWS::AppSync::FunctionConfiguration.

LogicalId

El nombre único de la función.

Tipo: cadena

Obligatorio: sí

Compatibilidad con AWS CloudFormation: esta propiedad se transfiere directamente a la propiedad Name de un recurso AWS::AppSync::FunctionConfiguration.

MaxBatchSize

El número máximo de entradas de solicitud de resolución que se enviarán a una sola función de AWS Lambda en una operación de BatchInvoke.

Tipo: entero

Obligatorio: no

Compatibilidad con AWS CloudFormation: esta propiedad se transfiere directamente a la propiedad MaxBatchSize de un recurso AWS::AppSync::FunctionConfiguration.

Name

El nombre de la función. Especifica si desea anular el valor de LogicalId.

Tipo: cadena

Obligatorio: no

Compatibilidad con AWS CloudFormation: esta propiedad se transfiere directamente a la propiedad Name de un recurso AWS::AppSync::FunctionConfiguration.

Runtime

Describe un tiempo de ejecución utilizado por un solucionador de canalización de AWS AppSync o una función de AWS AppSync. Especifica el nombre y la versión del tiempo de ejecución que se utilizará.

Tipo: tiempo de ejecución

Obligatorio: sí

Compatibilidad con AWS CloudFormation: esta propiedad es exclusiva de AWS SAM y no tiene un equivalente AWS CloudFormation. Es similar a la propiedad Runtime de un recurso AWS::AppSync::FunctionConfiguration.

Sync

Describe una configuración de sincronización para una función.

Especifica la estrategia de detección de conflictos y la estrategia de resolución que se utilizará cuando se invoque la función.

Type: SyncConfig

Obligatorio: no

Compatibilidad con AWS CloudFormation: esta propiedad se transfiere directamente a la propiedad SyncConfig de un recurso AWS::AppSync::FunctionConfiguration.