SNS

L'objet décrivant un type de source d'événement SNS.

SAM génère une ressource AWS::SNS::Subscription lorsque ce type d'événement est défini.

Syntaxe

Pour déclarer cette entité dans votre modèle AWS Serverless Application Model (AWS SAM), utilisez la syntaxe suivante.

YAML

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

Propriétés

FilterPolicy

Politique de filtre JSON attribuée à l’abonnement. Pour plus d'informations, consultez GetSubscriptionAttributesle manuel Amazon Simple Notification Service API Reference.

Type : SnsFilterPolicy

Obligatoire : non

AWS CloudFormation compatibilité : cette propriété est transmise directement à la FilterPolicy propriété d'une AWS::SNS::Subscription ressource.

FilterPolicyScope

Cet attribut vous permet de choisir l'étendue du filtrage en utilisant l'un des types de valeurs de chaîne suivants :

• MessageAttributes : le filtre est appliqué aux attributs du message.

• MessageBody : le filtre est appliqué sur le corps du message.

Type : chaîne

Obligatoire : non

Par défaut : MessageAttributes

AWS CloudFormation compatibilité : cette propriété est transmise directement à la FilterPolicyScope propriété d'une AWS::SNS::Subscription ressource.

RedrivePolicy

Lorsque ce paramètre est spécifié, envoie des messages non livrables à la file d'attente de lettres mortes Amazon SQS spécifiée. Les messages qui ne peuvent pas être remis en raison d'erreurs client (par exemple, lorsque le point de terminaison abonné est inaccessible) ou d'erreurs de serveur (par exemple, lorsque le service qui alimente le point de terminaison abonné devient indisponible) sont conservés dans la file d'attente des lettres mortes pour une analyse ou un retraitement ultérieurs.

Pour de plus amples informations sur la stratégie de redirection et les files d'attente de lettres mortes, veuillez consulter Files d'attente de lettres mortes Amazon SQS dans le Manuel du développeur Amazon Simple Queue Service.

Type : Json

Obligatoire : non

AWS CloudFormation compatibilité : cette propriété est transmise directement à la RedrivePolicy propriété d'une AWS::SNS::Subscription ressource.

Region

Pour les abonnements entre régions, la région dans laquelle le topic réside.

Si aucune région n'est spécifiée, CloudFormation utilise la région de l'appelant par défaut.

Type : chaîne

Obligatoire : non

AWS CloudFormation compatibilité : cette propriété est transmise directement à la Region propriété d'une AWS::SNS::Subscription ressource.

SqsSubscription

Définissez cette propriété sur VRAI ou spécifiez SqsSubscriptionObject pour activer le traitement par lots des notifications de rubrique SNS dans une file d'attente SQS. Le fait de définir cette propriété sur true crée une nouvelle file d'attente SQS, alors que la spécification d'un SqsSubscriptionObject utilise une file d'attente SQS existante.

Type : Booléen | SqsSubscriptionObject

Obligatoire : non

AWS CloudFormation compatibilité : cette propriété est unique AWS SAM et n'a pas d' AWS CloudFormation équivalent.

Topic

ARN de la rubrique à laquelle s'abonner.

Type : chaîne

Obligatoire : oui

AWS CloudFormation compatibilité : cette propriété est transmise directement à la TopicArn propriété d'une AWS::SNS::Subscription ressource.

Exemples

Exemple de source d'événement SNS

Exemple de source d'événement 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