OnFailure

Un destino para eventos que no han podido procesarse.

Sintaxis

Para declarar esta entidad en suAWS Serverless Application Model(AWS SAM), utilice la siguiente sintaxis.

YAML

  Destination: String
  Type: String

Properties

Destination

El nombre de recurso de Amazon (ARN) del recurso de destino.

Type: Cadena

Obligatorio: Condicional

AWS CloudFormationcompatibilidad: Esta propiedad es similar a laOnFailurepropiedad de unAWS::Lambda::EventInvokeConfigrecurso. SAM agregará los permisos necesarios al rol de IAM generado automáticamente asociado a esta función para acceder al recurso al que se hace referencia en esta propiedad.

Notas adicionales: Si el tipo es Lambda/EventBridge, se requiere destino.

Type

Tipo del recurso al que se hace referencia en el destino. Los tipos admitidos sonSQS,SNS,Lambda, yEventBridge.

Type: Cadena

Obligatorio: No

AWS CloudFormationcompatibilidad: Esta propiedad es exclusiva deAWS SAMy no tieneAWS CloudFormationequivalente.

Notas adicionales: Si el tipo es SQS/SNS y elDestinationse deja en blanco y, a continuación, SAM genera automáticamente el recurso SQS/SNS. Para hacer referencia al recurso, utilice<function-logical-id>.DestinationQueuepara SQS o<function-logical-id>.DestinationTopicpara SNS. Si el tipo es Lambda/EventBridge,Destinationes obligatorio.

Ejemplos

Ejemplo de configuración de EventInvoke con destinos SQS y Lambda

En este ejemplo no se proporciona ningún destino para la configuración de SQS onSuccess, por lo que SAM crea implícitamente una cola SQS y agrega los permisos necesarios. También en este ejemplo, en la configuración OnFailure se especifica un Destino para un recurso Lambda declarado en el archivo de plantilla, por lo que SAM agrega los permisos necesarios a esta función Lambda para llamar a la función 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. 

Ejemplo de configuración de EventInvoke con destino SNS

En este ejemplo, se proporciona un destino para un tema SNS declarado en el archivo de plantilla para la configuración OnSuccess.

YAML

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