OnFailure - AWS Serverless Application Model
SyntaxePropriétésExemples

Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.

OnFailure

Destination des événements dont le traitement a échoué.

Syntaxe

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

YAML

  Destination: String
  Type: String

Propriétés

Destination

Amazon Resource Name (ARN) de la ressource de destination.

Type : chaîne

Obligatoire : Conditionnelle

AWS CloudFormation compatibilité : cette propriété est similaire à celle OnFailure d'une AWS::Lambda::EventInvokeConfig ressource. SAM ajoute toutes les autorisations nécessaires au rôle IAM généré automatiquement associé à cette fonction pour accéder à la ressource référencée dans cette propriété.

Remarques supplémentaires : Si le type est Lambda/EventBridge, Destination est obligatoire.

Type

Type de la ressource référencée dans la destination. Les types pris en charge sont SQS, SNS, Lambda, et EventBridge.

Type : chaîne

Obligatoire : non

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

Informations complémentaires : si le type est SQS/SNS et que la propriété Destination est laissée vide, alors la ressource SQS/SNS est générée automatiquement par SAM. Pour référencer la ressource, utilisez <function-logical-id>.DestinationQueue pour SQS ou <function-logical-id>.DestinationTopic pour SNS. Si le type est Lambda/EventBridge, Destination c'est obligatoire.

Exemples

EventInvoke Exemple de configuration avec des destinations SQS et Lambda

Dans cet exemple, aucune destination n'est donnée pour la OnSuccess configuration SQS. SAM crée donc implicitement une file d'attente SQS et ajoute les autorisations nécessaires. Dans cet exemple également, une destination pour une ressource Lambda déclarée dans le fichier modèle est spécifiée dans la OnFailure configuration. SAM ajoute donc les autorisations nécessaires à cette fonction Lambda pour appeler la fonction Lambda de destination.

YAML

EventInvokeConfig:
  DestinationConfig:
    OnSuccess:
      Type: SQS
    OnFailure:
      Type: Lambda
      Destination: !GetAtt DestinationLambda.Arn  # Arn of a Lambda function declared in the template file.

EventInvoke Exemple de configuration avec destination SNS

Dans cet exemple, une destination est donnée pour une rubrique SNS déclarée dans le fichier modèle de OnSuccess configuration.

YAML

EventInvokeConfig:
  DestinationConfig:
    OnSuccess:
      Type: SNS
      Destination:
        Ref: DestinationSNS       # Arn of an SNS topic declared in the tempate file