OnSuccess - AWS Serverless Application Model
SintaxisPropiedadesEjemplos

Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.

OnSuccess

Un destino para eventos que se procesaron correctamente.

Sintaxis

Para declarar esta entidad en tu plantilla de AWS Serverless Application Model (AWS SAM), usa la siguiente sintaxis:

YAML

  Destination: String
  Type: String

Propiedades

Destination

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

Tipo: cadena

Obligatorio: condicional

Compatibilidad con AWS CloudFormation: esta propiedad es similar a la propiedad OnSuccess de un recurso AWS::Lambda::EventInvokeConfig. SAM añadirá 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, es obligatorio un Destino.

Type

Tipo de recurso al que se hace referencia en el destino. Los tipos admitidos son SQS, SNS, Lambda y EventBridge.

Tipo: cadena

Obligatorio: no

Compatibilidad con AWS CloudFormation: esta propiedad es exclusiva de AWS SAM y no tiene un equivalente AWS CloudFormation.

Notas adicionales: si el tipo es SQS/SNS y la propiedad de Destination se dejan en blanco, SAM genera automáticamente el recurso SQS/SNS. Para hacer referencia al recurso, utilice <function-logical-id>.DestinationQueue para SQS o <function-logical-id>.DestinationTopic para SNS. Si el tipo es Lambda/EventBridge, es obligatorio un Destination.

Ejemplos

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

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

YAML

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