Fonction

Configurez les fonctions des API GraphQL pour effectuer certaines opérations.

Syntaxe

Pour déclarer cette entité dans votre modèle AWS Serverless Application Model (AWS SAM), utilisez la syntaxe suivante.

YAML

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

Propriétés

CodeUri

L'URI Amazon Simple Storage Service (Amazon S3) du code de fonction ou le chemin d'accès au dossier local.

Si vous spécifiez un chemin d'accès à un dossier local, le fichier AWS CloudFormation doit d'abord être chargé sur Amazon S3 avant le déploiement. Vous pouvez utiliser la CLI  AWS SAM pour faciliter ce processus. Pour plus d’informations, consultez Comment AWS SAM télécharge les fichiers locaux lors du déploiement.

Type : chaîne

Obligatoire : non

AWS CloudFormation compatibilité : cette propriété est transmise directement à la CodeS3Location propriété d'une AWS::AppSync::FunctionConfiguration ressource.

DataSource

Le nom de source de données que cette fonction va joindre.

• Pour référencer une source de données dans la ressource AWS::Serverless::GraphQLApi, spécifiez son ID logique.

• Pour référencer une source de données en dehors de la ressource AWS::Serverless::GraphQLApi, fournissez son attribut Name à l'aide de la fonction intrinsèque Fn::GetAtt. Par exemple, !GetAtt MyLambdaDataSource.Name.

• Pour référencer une source de données provenant d'une autre pile, utilisez Fn::ImportValue.

Si une variation de [NONE | None | none] est spécifiée, une None valeur AWS SAM sera générée pour l'AWS::AppSync::DataSourceTypeobjet.

Type : chaîne

Obligatoire : oui

AWS CloudFormation compatibilité : cette propriété est transmise directement à la DataSourceName propriété d'une AWS::AppSync::FunctionConfiguration ressource.

Description

La description de votre fonction.

Type : chaîne

Obligatoire : non

AWS CloudFormation compatibilité : cette propriété est transmise directement à la Description propriété d'une AWS::AppSync::FunctionConfiguration ressource.

Id

L'ID de fonction d'une fonction située en dehors de la ressource AWS::Serverless::GraphQLApi.

• Pour référencer une fonction dans le même AWS SAM modèle, utilisez la fonction Fn::GetAtt intrinsèque. Par exemple Id: !GetAtt createPostItemFunc.FunctionId.

• Pour référencer une fonction provenant d'une autre pile, utilisez Fn::ImportValue.

Lors de l'utilisationId, toutes les autres propriétés ne sont pas autorisées. AWS SAM transmettra automatiquement l'ID de fonction de votre fonction référencée.

Type : chaîne

Obligatoire : non

AWS CloudFormation compatibilité : cette propriété est unique AWS SAM et n'a pas d' AWS CloudFormation équivalent.

InlineCode

Le code de fonction contenant les fonctions de demande et de réponse.

Type : chaîne

Obligatoire : non

AWS CloudFormation compatibilité : cette propriété est transmise directement à la Code propriété d'une AWS::AppSync::FunctionConfiguration ressource.

LogicalId

Le nom unique de votre fonction.

Type : chaîne

Obligatoire : oui

AWS CloudFormation compatibilité : cette propriété est transmise directement à la Name propriété d'une AWS::AppSync::FunctionConfiguration ressource.

MaxBatchSize

Le nombre maximal d'entrées de requêtes de résolveur qui seront envoyées à une seule fonction AWS Lambda dans une opération BatchInvoke.

Type : entier

Obligatoire : non

AWS CloudFormation compatibilité : cette propriété est transmise directement à la MaxBatchSizepropriété d'une AWS::AppSync::FunctionConfiguration ressource.

Name

Nom de la fonction. Spécifiez pour remplacer la valeur LogicalId.

Type : chaîne

Obligatoire : non

AWS CloudFormation compatibilité : cette propriété est transmise directement à la Name propriété d'une AWS::AppSync::FunctionConfiguration ressource.

Runtime

Décrit un environnement d'exécution utilisé par une AWS AppSync fonction ou un résolveur de AWS AppSync pipeline. Spécifie le nom et la version d'exécution à utiliser.

Type : temps d'exécution

Obligatoire : oui

AWS CloudFormation compatibilité : cette propriété est unique AWS SAM et n'a pas d' AWS CloudFormation équivalent. Elle est similaire à la propriétéRuntime d'une ressource AWS::AppSync::FunctionConfiguration.

Sync

Décrit une configuration Sync pour une fonction.

Spécifie la stratégie de détection de conflits et de résolution à utiliser lorsque la fonction est appelée.

Type : SyncConfig

Obligatoire : non

AWS CloudFormation compatibilité : cette propriété est transmise directement à la SyncConfig propriété d'une AWS::AppSync::FunctionConfiguration ressource.