OnFailure

Um destino para eventos que tiveram falha no processamento.

Sintaxe

Para declarar essa entidade em seu modelo AWS Serverless Application Model (AWS SAM), use a sintaxe a seguir.

YAML

  Destination: String
  Type: String

Propriedades

Destination

O nome de recurso da Amazon (ARN) do recurso de destino.

Tipo: string

Obrigatório: Condicional

AWS CloudFormation compatibilidade: essa propriedade é semelhante à OnFailure propriedade de um AWS::Lambda::EventInvokeConfig recurso. O SAM adicionará todas as permissões necessárias ao perfil do IAM gerado automaticamente associado a essa função para acessar o recurso referenciado nessa propriedade.

Notas adicionais: Se o tipo for Lambda/EventBridge, o destino é obrigatório.

Type

Tipo do recurso referenciado no destino. Os tipos suportados são SQS, SNS, Lambda e EventBridge.

Tipo: string

Obrigatório: não

AWS CloudFormation compatibilidade: essa propriedade é exclusiva AWS SAM e não tem AWS CloudFormation equivalente.

Notas adicionais: Se o tipo for SQS/SNS e a propriedade Destination for deixada em branco, o recurso SQS/SNS será gerado automaticamente pelo SAM. Para referenciar o recurso, use <function-logical-id>.DestinationQueue para SQS ou <function-logical-id>.DestinationTopic SNS. Se o tipo for Lambda/EventBridge, Destination é obrigatório.

Exemplos

EventInvoke Exemplo de configuração com destinos SQS e Lambda

Neste exemplo, nenhum Destino é fornecido para a OnSuccess configuração do SQS, então o SAM cria implicitamente uma fila SQS e adiciona todas as permissões necessárias. Além disso, neste exemplo, um Destino para um recurso Lambda declarado no arquivo de modelo é especificado na OnFailure configuração, então o SAM adiciona as permissões necessárias a essa função Lambda para chamar a função Lambda de destino.

YAML

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

EventInvoke Exemplo de configuração com destino SNS

Neste exemplo, um destino é fornecido para um tópico do SNS declarado no arquivo de modelo para a OnSuccess configuração.

YAML

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