Función

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

Sintaxis

Para declarar esta entidad en tu plantilla 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. Puede utilizar la CLI de AWS SAM para facilitar este proceso. Para obtener más información, consulte Cómo cargar archivos locales durante la implementación con AWS SAMCLI.

Tipo: cadena

Obligatorio: no

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

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, proporcione 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 [NONE | None | none] se especifica una variación de, AWS SAM generará un None valor para el AWS::AppSync::DataSource Type objeto.

Tipo: cadena

Obligatorio: sí

AWS CloudFormation compatibilidad: esta propiedad se pasa directamente a la DataSourceName propiedad de un AWS::AppSync::FunctionConfiguration recurso.

Description

La descripción de la función.

Tipo: cadena

Obligatorio: no

AWS CloudFormation compatibilidad: esta propiedad se pasa directamente a la Description propiedad de un AWS::AppSync::FunctionConfiguration recurso.

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 AWS SAM plantilla, utilice la función Fn::GetAtt intrínseca. Por ejemplo, Id: !GetAtt createPostItemFunc.FunctionId.

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

Cuando se usaId, 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

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

InlineCode

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

Tipo: cadena

Obligatorio: no

AWS CloudFormation compatibilidad: esta propiedad se pasa directamente a la Code propiedad de un AWS::AppSync::FunctionConfiguration recurso.

LogicalId

El nombre único de la función.

Tipo: cadena

Obligatorio: sí

AWS CloudFormation compatibilidad: esta propiedad se pasa directamente a la Name propiedad de un AWS::AppSync::FunctionConfiguration recurso.

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

AWS CloudFormation compatibilidad: esta propiedad se pasa directamente a la MaxBatchSizepropiedad de un AWS::AppSync::FunctionConfiguration recurso.

Name

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

Tipo: cadena

Obligatorio: no

AWS CloudFormation compatibilidad: esta propiedad se pasa directamente a la Name propiedad de un AWS::AppSync::FunctionConfiguration recurso.

Runtime

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

Tipo: tiempo de ejecución

Obligatorio: sí

AWS CloudFormation compatibilidad: esta propiedad es exclusiva de AWS SAM y no tiene un AWS CloudFormation equivalente. 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.

Tipo: SyncConfig

Obligatorio: no

AWS CloudFormation compatibilidad: esta propiedad se pasa directamente a la SyncConfig propiedad de un AWS::AppSync::FunctionConfiguration recurso.