OnFailure - AWS Serverless Application Model
SintaxePropriedadesExemplos

As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.

OnFailure

Um destino para eventos que tiveram falha no processamento.

Sintaxe

Para declarar esta entidade no modelo do AWS Serverless Application Model (AWS SAM), use a seguinte sintaxe:

YAML

  Destination: String
  Type: String

Propriedades

Destination

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

Tipo: string

Obrigatório: Condicional

Compatibilidade AWS CloudFormation: essa propriedade é semelhante à propriedade OnFailure de um recurso AWS::Lambda::EventInvokeConfig. 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, 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

Compatibilidade AWS CloudFormation: Essa propriedade é exclusiva do 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, é obrigatório Destination.

Exemplos

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

Neste exemplo, nenhum Destino é fornecido para a configuração do SQS OnSuccess, 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 configuração OnFailure, então o SAM adiciona as permissões necessárias a essa função do Lambda para chamar a função do 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.

Exemplo de configuração do EventInvoke com destino SNS

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

YAML

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