Pour commencer : créer un EventBridge canal Amazon - Amazon EventBridge
Création du canalDécouvrez le tuyauSupprimer des ressourcesDétails du modèleModèle

Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.

Pour commencer : créer un EventBridge canal Amazon

Pour nous familiariser avec les tuyaux et leurs fonctionnalités, nous allons utiliser un AWS CloudFormation modèle pour configurer un EventBridge canal et les composants associés. Ensuite, nous pouvons explorer les différentes caractéristiques des tuyaux.

Le modèle crée un EventBridge canal qui connecte un flux provenant d'une table DynamoDB à une file d'attente Amazon SQS. Chaque fois qu'un enregistrement est créé ou modifié dans la table de base de données, le canal envoie l'événement résultant à la file d'attente.

Le tuyau déployé est composé de :

  • Une table DynamoDB (et un flux) servant de source de canal, et une file d'attente Amazon SQS en tant que cible.

  • Rôle d'exécution qui accorde EventBridge les autorisations nécessaires pour accéder à la table DynamoDB et à la file d'attente Amazon SQS.

  • Le canal lui-même, qui contient un filtre d'événements qui sélectionne uniquement les événements générés lorsqu'un élément de table est créé (inséré) ou modifié.

Pour obtenir des informations techniques spécifiques sur le modèle, consultezDétails du modèle.

Les événements de base de données sont mis en correspondance avec un filtre et envoyés vers une file d'attente s'ils correspondent.

Création du tuyau à l'aide de AWS CloudFormation

Pour créer le canal et ses ressources associées, nous allons créer un CloudFormation modèle et l'utiliser pour créer une pile contenant un échantillon de tube, avec la source et la cible.

Important

Les ressources Amazon utilisées vous seront facturées si vous créez une pile à partir de ce modèle.

Création du modèle

Créez d'abord le CloudFormation modèle.

  1. Dans la Modèle section, cliquez sur l'icône de copie dans l'onglet JSON ou YAML pour copier le contenu du modèle.

  2. Collez le contenu du modèle dans un nouveau fichier.

  3. Enregistrez le fichier au niveau local.

Création de la pile

Ensuite, utilisez le modèle que vous avez enregistré pour provisionner une CloudFormation pile.

  1. Ouvrez la AWS CloudFormation console.

  2. Sur la page Stacks, dans le menu Créer une pile, choisissez avec de nouvelles ressources (standard).

  3. Spécifiez le modèle :

    1. Sous Prérequis, choisissez Choisir un modèle existant.

    2. Sous Spécifier le modèle, choisissez Télécharger un fichier modèle.

    3. Choisissez Choisir un fichier, naviguez jusqu'au fichier modèle, puis choisissez-le.

    4. Choisissez Suivant.

  4. Spécifiez les détails de la pile :

    1. Entrez le nom de la pile.

    2. Pour les paramètres, acceptez les valeurs par défaut ou entrez les vôtres.

    3. Choisissez Suivant.

  5. Configurez les options de pile :

    1. Sous Options d'échec de la pile, choisissez Supprimer toutes les ressources nouvellement créées.

      Note

      Le choix de cette option vous évite d'être facturé pour des ressources dont la politique de suppression indique qu'elles doivent être conservées même en cas d'échec de la création de la pile. Pour plus d'informations, consultez la section DeletionPolicyattribut dans le guide de AWS CloudFormation l'utilisateur.

    2. Acceptez toutes les autres valeurs par défaut.

    3. Sous Fonctionnalités, cochez la case pour confirmer que des ressources IAM CloudFormation peuvent être créées dans votre compte.

    4. Choisissez Suivant.

  6. Vérifiez les détails de la pile et choisissez Soumettre.

AWS CloudFormation crée la pile. Une fois la création de la pile terminée, les ressources de la pile sont prêtes à être utilisées. Vous pouvez utiliser l'onglet Ressources de la page détaillée de la pile pour afficher les ressources mises en service dans votre compte.

Exploration des capacités des canalisations

Une fois le canal créé, vous pouvez utiliser la EventBridge console pour observer le fonctionnement du canal et tester le déroulement des événements.

  1. Vous voulez ouvrir la EventBridge console à la https://console.aws.amazon.com/events/maison ? #/tuyaux.

  2. Choisissez le tube que vous avez créé.

    Sur la page détaillée du canal, la section Composants du canal affiche les ressources qui le composent et contient des onglets fournissant plus de détails sur chaque composant.

    La page détaillée du tuyau affiche graphiquement les composants source, filtre et cible du canal.

    Vous trouverez le rôle d'exécution que nous avons créé pour le canal dans l'onglet Paramètres, dans la section Autorisations.

Examen du filtre à tuyau

Avant de tester le fonctionnement du tube, examinons le filtre que nous avons spécifié pour contrôler les événements envoyés à la cible. Le canal envoie uniquement les événements correspondant aux critères du filtre à la cible ; tous les autres sont ignorés. Dans ce cas, nous voulons uniquement que les événements générés lorsque des entrées de table sont créées ou modifiées soient envoyés à la file d'attente Amazon SQS.

  • Sur la page détaillée du tuyau, sous Composants du tuyau, choisissez l'onglet Filtrage.

    Nous avons inclus un filtre qui sélectionne uniquement les événements pour lesquels le eventName paramètre est défini sur INSERT ouMODIFY. 

    {
  "eventName": ["INSERT", "MODIFY"]
}

Envoyer des événements par le biais du canal

Ensuite, nous allons générer des événements dans la source du canal pour vérifier que le filtrage et la distribution du canal fonctionnent correctement. Pour ce faire, nous allons créer et modifier un élément dans la table DynamoDB que nous avons spécifiée comme source du canal.

  1. Sur la page détaillée du tuyau, sous Composants du tuyau, choisissez l'onglet Source.

  2. Sous Source, choisissez le nom du flux DynamoDB.

    Cela ouvre la console DynamoDB dans une fenêtre séparée, avec les détails de la table source affichés.

  3. Sélectionnez Explore table items (Explorer les éléments de la table).

  4. Générez un INSERT événement en créant un élément dans le tableau :

    1. Choisissez Créer un élément.

    2. Ajoutez des valeurs pour les attributs Album et Artist.

    3. Choisissez Créer un élément.

  5. Générez un événement DELETE et un INSERT événement en modifiant l'élément :

    1. Choisissez l'élément dans la liste, puis dans le menu Actions, choisissez Modifier l'élément.

    2. Entrez une nouvelle valeur pour l'attribut Album ou Artiste.

    3. Cochez la case qui confirme que vous modifiez la valeur des clés d'article, puis choisissez Recréer l'article.

      Cela entraîne la suppression puis la recréation de l'élément, générant un DELETE événement, puis un nouvel INSERT événement.

  6. Générez un MODIFY événement en ajoutant un attribut à l'élément :

    1. Choisissez l'élément dans la liste, puis dans le menu Actions, choisissez Modifier l'élément.

    2. Dans le menu Ajouter un nouvel attribut, choisissez Numéro.

    3. Pour le nom de l'attribut, entrez Année, puis entrez une valeur pour l'attribut. Choisissez Enregistrer et fermer.

Confirmation de la diffusion de l'événement par le biais du canal

Enfin, nous confirmerons que le canal a correctement filtré et diffusé les événements que nous avons générés en créant et en modifiant l'élément de table dans DynamoDB.

  1. Sur la page détaillée du tuyau, sous Composants du tuyau, choisissez l'onglet Target.

  2. Sous Target, choisissez le nom de la file d'attente Amazon SQS.

    Cela ouvre la console Amazon SQS dans une fenêtre séparée, avec les détails de la file d'attente cible affichés.

  3. Choisissez Envoyer et recevoir des messages.

  4. Sous Recevoir des messages, choisissez Sondage pour les messages.

    Amazon SQS charge les messages reçus dans la file d'attente. Cliquez sur un message individuel pour en voir les détails.

    La file d'attente doit contenir trois messages d'événement :

    • Deux typesINSERT, l'un généré lorsque vous avez créé l'élément de table pour la première fois, et l'autre généré lorsque vous avez recréé l'élément en modifiant une valeur clé.

    • Un de typeMODIFY, généré lorsque vous avez ajouté un attribut à l'élément de table.

    Notez qu'il n'y a aucun message d'événement de ce type DELETE dans la file d'attente, même s'il a été généré lorsque vous avez supprimé et recréé l'élément du tableau en modifiant une valeur clé. Le filtre de canal que nous avons spécifié sélectionne uniquement sur INSERT etMODIFY, par conséquent, le canal a filtré l'DELETEévénement au lieu de le transmettre à la file d'attente.

Nettoyage : suppression de ressources

Enfin, nous supprimerons la pile et les ressources qu'elle contient.

Important

Les ressources Amazon contenues dans la pile vous seront facturées tant qu'elle existera.

  1. Ouvrez la AWS CloudFormation console.

  2. Sur la page Stacks, choisissez la pile créée à partir du modèle, choisissez Supprimer, puis confirmez Supprimer.

    CloudFormation initie la suppression de la pile et de toutes les ressources qu'elle contient.

CloudFormation détails du modèle

Ce modèle crée des ressources et accorde des autorisations sur votre compte.

Ressources

Le AWS CloudFormation modèle de ce didacticiel créera les ressources suivantes dans votre compte :

Important

Les ressources Amazon utilisées vous seront facturées si vous créez une pile à partir de ce modèle.

  • AWS::DynamoDB::Table: table DynamoDB qui sert de source d'événements pour le canal.

  • AWS::SQS::Queue: une file d'attente Amazon SQS qui sert de cible aux événements circulant dans le canal.

  • AWS::IAM::Role: rôle d'exécution IAM octroyant des autorisations au service EventBridge Pipes dans votre compte.

  • AWS::Pipes::Pipe: canal reliant la table DynamoDB à la file d'attente Amazon SQS.

Autorisations

Le modèle inclut une AWS::IAM::Role ressource qui représente un rôle d'exécution. Ce rôle accorde au service EventBridge Pipes (pipes.amazonaws.com) les autorisations suivantes sur votre compte.

Les autorisations suivantes sont étendues à la table DynamoDB et au flux créés par le modèle en tant que source d'événements pour le canal :

  • dynamodb:DescribeStream

  • dynamodb:GetRecords

  • dynamodb:GetShardIterator

  • dynamodb:ListStreams

L'autorisation suivante s'applique à la file d'attente Amazon SQS créée par la pile en tant que cible du canal :

  • sqs:SendMessage

CloudFormation modèle

Enregistrez le code JSON ou YAML suivant dans un fichier distinct à utiliser comme CloudFormation modèle pour ce didacticiel.

JSON
{
  "AWSTemplateFormatVersion": "2010-09-09",

 "Description" : "EventBridge Pipe template example. Provisions a pipe, along with a DynamoDB stream as the pipe source and an SQS queue as the pipe target. Also provisions an execution role that contains the necessary permissions to access both the source and target. Once provisioned, the pipe receives events from the DynamoDB data stream, applies a filter, and sends matching events on to an SQS Queue. You will be billed for the Amazon resources used if you create a stack from this template.",

  "Parameters" : {
    "SourceTableName" : {
      "Type" : "String",
      "Default" : "pipe-example-source",
      "Description" : "Specify the name of the table to provision as the pipe source, or accept the default."
    },
  "TargetQueueName" : {
    "Type" : "String",
    "Default" : "pipe-example-target",
    "Description" : "Specify the name of the queue to provision as the pipe target, or accept the default."
  },
    "PipeName" : {
      "Type" : "String",
      "Default" : "pipe-with-filtering-example",
      "Description" : "Specify the name of the table to provision as the pipe source, or accept the default."
    }
},
  "Resources": {
    "PipeSourceDynamoDBTable": {
      "Type": "AWS::DynamoDB::Table",
      "Properties": {
        "AttributeDefinitions": [{
            "AttributeName": "Album",
            "AttributeType": "S"
          },
          {
            "AttributeName": "Artist",
            "AttributeType": "S"
          }

        ],
        "KeySchema": [{
            "AttributeName": "Album",
            "KeyType": "HASH"

          },
          {
            "AttributeName": "Artist",
            "KeyType": "RANGE"
          }
        ],
        "ProvisionedThroughput": {
          "ReadCapacityUnits": 10,
          "WriteCapacityUnits": 10
        },
        "StreamSpecification": {
          "StreamViewType": "NEW_AND_OLD_IMAGES"
        },
        "TableName": { "Ref" : "SourceTableName" }
      }
    },
    "PipeTargetQueue": {
      "Type": "AWS::SQS::Queue",
      "Properties": {
        "QueueName": { "Ref" : "TargetQueueName" }
      }
    },
    "PipeTutorialPipeRole": {
      "Type": "AWS::IAM::Role",
      "Properties": {
        "AssumeRolePolicyDocument": {
          "Version": "2012-10-17",
          "Statement": [{
            "Effect": "Allow",
            "Principal": {
              "Service": "pipes.amazonaws.com"
            },
            "Action": "sts:AssumeRole",
            "Condition": {
              "StringLike": {
                "aws:SourceArn": {
	"Fn::Join": [
		"", 
                [
                  "arn:",
                  { "Ref": "AWS::Partition" },
                  ":pipes:",
                  { "Ref": "AWS::Region" },
                  ":",
                  { "Ref": "AWS::AccountId" },
                  ":pipe/",
                  { "Ref": "PipeName" }
               ]
	]
       },
                "aws:SourceAccount": { "Ref" : "AWS::AccountId" }
              }
            }
          }]
        },
        "Description" : "EventBridge Pipe template example. Execution role that grants the pipe the permissions necessary to send events to the specified pipe.",
        "Path": "/",
        "Policies": [{
            "PolicyName": "SourcePermissions",
            "PolicyDocument": {
              "Version": "2012-10-17",
              "Statement": [{
                "Effect": "Allow",
                "Action": [
                  "dynamodb:DescribeStream",
                  "dynamodb:GetRecords",
                  "dynamodb:GetShardIterator",
                  "dynamodb:ListStreams"
                ],
                "Resource": [
                  { "Fn::GetAtt" : [ "PipeSourceDynamoDBTable", "StreamArn" ] }
                ]
              }]
            }
          },
          {
            "PolicyName": "TargetPermissions",
            "PolicyDocument": {
              "Version": "2012-10-17",
              "Statement": [{
                "Effect": "Allow",
                "Action": [
                  "sqs:SendMessage"
                ],
                "Resource": [
                  { "Fn::GetAtt" : [ "PipeTargetQueue", "Arn" ] }
                ]
              }]
            }
          }
        ]
      }
  },
    "PipeWithFiltering": {
      "Type": "AWS::Pipes::Pipe",
      "Properties": {
        "Description" : "EventBridge Pipe template example. Pipe that receives events from a DynamoDB stream, applies a filter, and sends matching events on to an SQS Queue.",
        "Name": { "Ref" : "PipeName" },
        "RoleArn": {"Fn::GetAtt" : ["PipeTutorialPipeRole", "Arn"] },
        "Source": { "Fn::GetAtt" : [ "PipeSourceDynamoDBTable", "StreamArn" ] },
        "SourceParameters": {
          "DynamoDBStreamParameters" : {
            "StartingPosition" : "LATEST"
         },
        "FilterCriteria" : {
          "Filters" : [ {
            "Pattern" : "{ \"eventName\": [\"INSERT\", \"MODIFY\"] }"
         }]
        }
        },
        "Target": { "Fn::GetAtt" : [ "PipeTargetQueue", "Arn" ] }
      }
    }
  }
}
YAML
AWSTemplateFormatVersion: '2010-09-09'
Description: EventBridge Pipe template example. Provisions a pipe, along with a DynamoDB stream as the pipe source and an SQS queue as the pipe target. Also provisions an execution role that contains the necessary permissions to access both the source and target. Once provisioned, the pipe receives events from the DynamoDB data stream, applies a filter, and sends matching events on to an SQS Queue. You will be billed for the Amazon resources used if you create a stack from this template.
Parameters:
  SourceTableName:
    Type: String
    Default: pipe-example-source
    Description: Specify the name of the table to provision as the pipe source, or accept the default.
  TargetQueueName:
    Type: String
    Default: pipe-example-target
    Description: Specify the name of the queue to provision as the pipe target, or accept the default.
  PipeName:
    Type: String
    Default: pipe-with-filtering-example
    Description: Specify the name of the table to provision as the pipe source, or accept the default.
Resources:
  PipeSourceDynamoDBTable:
    Type: AWS::DynamoDB::Table
    Properties:
      AttributeDefinitions:
        - AttributeName: Album
          AttributeType: S
        - AttributeName: Artist
          AttributeType: S
      KeySchema:
        - AttributeName: Album
          KeyType: HASH
        - AttributeName: Artist
          KeyType: RANGE
      ProvisionedThroughput:
        ReadCapacityUnits: 10
        WriteCapacityUnits: 10
      StreamSpecification:
        StreamViewType: NEW_AND_OLD_IMAGES
      TableName: !Ref SourceTableName
  PipeTargetQueue:
    Type: AWS::SQS::Queue
    Properties:
      QueueName: !Ref TargetQueueName
  PipeTutorialPipeRole:
    Type: AWS::IAM::Role
    Properties:
      AssumeRolePolicyDocument:
        Version: '2012-10-17'
        Statement:
          - Effect: Allow
            Principal:
              Service: pipes.amazonaws.com
            Action: sts:AssumeRole
            Condition:
              StringLike:
                aws:SourceArn: !Join
                  - ''
                  - - 'arn:'
                    - !Ref AWS::Partition
                    - ':pipes:'
                    - !Ref AWS::Region
                    - ':'
                    - !Ref AWS::AccountId
                    - ':pipe/'
                    - !Ref PipeName
                aws:SourceAccount: !Ref AWS::AccountId
      Description: EventBridge Pipe template example. Execution role that grants the pipe the permissions necessary to send events to the specified pipe.
      Path: /
      Policies:
        - PolicyName: SourcePermissions
          PolicyDocument:
            Version: '2012-10-17'
            Statement:
              - Effect: Allow
                Action:
                  - dynamodb:DescribeStream
                  - dynamodb:GetRecords
                  - dynamodb:GetShardIterator
                  - dynamodb:ListStreams
                Resource:
                  - !GetAtt PipeSourceDynamoDBTable.StreamArn
        - PolicyName: TargetPermissions
          PolicyDocument:
            Version: '2012-10-17'
            Statement:
              - Effect: Allow
                Action:
                  - sqs:SendMessage
                Resource:
                  - !GetAtt PipeTargetQueue.Arn
  PipeWithFiltering:
    Type: AWS::Pipes::Pipe
    Properties:
      Description: EventBridge Pipe template example. Pipe that receives events from a DynamoDB stream, applies a filter, and sends matching events on to an SQS Queue.
      Name: !Ref PipeName
      RoleArn: !GetAtt PipeTutorialPipeRole.Arn
      Source: !GetAtt PipeSourceDynamoDBTable.StreamArn
      SourceParameters:
        DynamoDBStreamParameters:
          StartingPosition: LATEST
        FilterCriteria:
          Filters:
            - Pattern: '{ "eventName": ["INSERT", "MODIFY"] }'
      Target: !GetAtt PipeTargetQueue.Arn