SNS

El objeto que describe un tipo de fuente de evento de SNS.

SAM genera recursos de AWS::SNS::Subscription cuando se establece este tipo de evento

Sintaxis

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

YAML

  FilterPolicy: SnsFilterPolicy
  FilterPolicyScope: String
  RedrivePolicy: Json
  Region: String
  SqsSubscription: Boolean | SqsSubscriptionObject
  Topic: String

Propiedades

FilterPolicy

El JSON de la política de filtro asignada a la suscripción. Para obtener más información, consulte la referencia GetSubscriptionAttributesde la API de Amazon Simple Notification Service.

Tipo: SnsFilterPolicy

Obligatorio: no

Compatibilidad con AWS CloudFormation: esta propiedad se transfiere directamente a la propiedad FilterPolicy de un recurso AWS::SNS::Subscription.

FilterPolicyScope

Este atributo permite elegir el alcance de filtrado mediante uno de los siguientes tipos de valores de cadena:

• MessageAttributes: el filtro se aplica a los atributos del mensaje.

• MessageBody: el filtro se aplica al cuerpo del mensaje.

Tipo: cadena

Obligatorio: no

Valor predeterminado: MessageAttributes

Compatibilidad con AWS CloudFormation: esta propiedad se transfiere directamente a la propiedad FilterPolicyScope de un recurso AWS::SNS::Subscription.

RedrivePolicy

Cuando se especifica, envía mensajes que no se pueden entregar en la cola de mensajes sin procesar de Amazon SQS especificada. Los mensajes que no se pueden entregar debido a errores del cliente (por ejemplo, cuando no se puede acceder al punto de conexión) o errores del servidor (por ejemplo, cuando el servicio que alimenta el punto de conexión suscrito deja de estar disponible) se mantienen en la cola de mensajes fallidos para su posterior análisis o reprocesamiento.

Para obtener más información sobre la política de redireccionamiento y las colas de mensajes fallidos, consulte Uso de colas de mensajes fallidos en Amazon SQS en la Guía para desarrolladores de Amazon Simple Queue Service.

Tipo: Json

Obligatorio: no

Compatibilidad con AWS CloudFormation: esta propiedad se transfiere directamente a la propiedad RedrivePolicy de un recurso AWS::SNS::Subscription.

Region

Para suscripciones entre regiones, la región en la que reside el tema.

Si no se especifica ninguna región, CloudFormation utiliza la región de la persona que llama como predeterminada.

Tipo: cadena

Obligatorio: no

Compatibilidad con AWS CloudFormation: esta propiedad se transfiere directamente a la propiedad Region de un recurso AWS::SNS::Subscription.

SqsSubscription

Establezca esta propiedad en true o especifique SqsSubscriptionObject para habilitar la agrupación por lotes de notificaciones de temas de SNS en una cola de SQS. Si se establece esta propiedad para que true cree una nueva cola de SQS, mientras si se especifica SqsSubscriptionObject utiliza una cola de SQS existente.

Tipo: booleano | SqsSubscriptionObject

Obligatorio: no

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

Topic

El ARN del tema al que se suscribe.

Tipo: cadena

Obligatorio: sí

Compatibilidad con AWS CloudFormation: esta propiedad se transfiere directamente a la propiedad TopicArn de un recurso AWS::SNS::Subscription.

Ejemplos

Ejemplo de orígenes de eventos de SNS

Ejemplo de orígenes de eventos de SNS

YAML

Events:
  SNSEvent:
    Type: SNS
    Properties:
      Topic: arn:aws:sns:us-east-1:123456789012:my_topic
      SqsSubscription: true
      FilterPolicy:
        store:
          - example_corp
        price_usd:
          - numeric:
              - ">="
              - 100