OnFailure - AWS Serverless Application Model
SyntaxEigenschaftenBeispiele

Die vorliegende Übersetzung wurde maschinell erstellt. Im Falle eines Konflikts oder eines Widerspruchs zwischen dieser übersetzten Fassung und der englischen Fassung (einschließlich infolge von Verzögerungen bei der Übersetzung) ist die englische Fassung maßgeblich.

OnFailure

Ein Ziel für Ereignisse, bei denen die Verarbeitung fehlgeschlagen ist.

Syntax

Verwenden Sie die folgende Syntax, um diese Entität in Ihrer Vorlage AWS Serverless Application Model (AWS SAM) zu deklarieren.

YAML

  Destination: String
  Type: String

Eigenschaften

Destination

Der Amazon-Ressourcenname (ARN) der Zielressource.

Typ: Zeichenfolge

Required: Conditional

AWS CloudFormation Kompatibilität: Diese Eigenschaft ähnelt der OnFailure Eigenschaft einer AWS::Lambda::EventInvokeConfig Ressource. SAM fügt der automatisch generierten IAM-Rolle, die mit dieser Funktion verknüpft ist, alle erforderlichen Berechtigungen hinzu, um auf die in dieser Eigenschaft referenzierte Ressource zuzugreifen.

Zusätzliche Hinweise: Wenn der Typ Lambda/ istEventBridge, ist Destination erforderlich.

Type

Typ der Ressource, auf die im Ziel verwiesen wird. Unterstützte Typen sind SQSSNS,Lambda, undEventBridge.

Typ: Zeichenfolge

Required: No

AWS CloudFormation Kompatibilität: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein AWS CloudFormation Äquivalent.

Zusätzliche Hinweise: Wenn der Typ SQS/SNS ist und die Destination Eigenschaft leer gelassen wird, wird die SQS/SNS-Ressource auto von SAM generiert. Um auf die Ressource zu verweisen, verwenden Sie <function-logical-id>.DestinationQueue für SQS oder für SNS. <function-logical-id>.DestinationTopic Wenn der Typ Lambda/ istEventBridge, Destination ist dies erforderlich.

Beispiele

EventInvoke Konfigurationsbeispiel mit SQS- und Lambda-Zielen

In diesem Beispiel wurde kein Ziel für die OnSuccess SQS-Konfiguration angegeben, daher erstellt SAM implizit eine SQS-Warteschlange und fügt alle erforderlichen Berechtigungen hinzu. Auch für dieses Beispiel wird ein Ziel für eine in der Vorlagendatei deklarierte Lambda-Ressource in der OnFailure Konfiguration angegeben, sodass SAM dieser Lambda-Funktion die erforderlichen Berechtigungen zum Aufrufen der Lambda-Zielfunktion hinzufügt.

YAML

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

EventInvoke Konfigurationsbeispiel mit SNS-Ziel

In diesem Beispiel wird ein Ziel für ein SNS-Thema angegeben, das in der Vorlagendatei für die OnSuccess Konfiguration deklariert ist.

YAML

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