入門：建立 Amazon EventBridge 管道

為了熟悉管道及其功能，我們將使用 CloudFormation 範本來設定 EventBridge 管道和相關聯的元件。然後，我們可以探索各種管道功能。

提示

如需更全面的實作學習體驗，請嘗試 EventBridge 管道研討會。此互動式研討會會逐步引導您建置管道並進行故障診斷，以 Lambda 擴充將 DynamoDB 連線至 API Gateway。

範本會建立 EventBridge 管道，將串流從 DynamoDB 資料表連線至 Amazon SQS 佇列。每次在資料庫資料表中建立或修改記錄時，管道都會將產生的事件傳送至佇列。

部署的管道包含：

做為管道來源的 DynamoDB 資料表（和串流），以及做為目標的 Amazon SQS 佇列。
授予 EventBridge 存取 DynamoDB 資料表和 Amazon SQS 佇列必要許可的執行角色。
管道本身，其中包含事件篩選條件，只會選取建立（插入）或修改資料表項目時產生的事件。

如需範本的特定技術詳細資訊，請參閱範本詳細資訊。

使用 CloudFormation 建立管道

若要建立管道及其相關資源，我們將建立 CloudFormation 範本，並用它來建立包含範例管道的堆疊，最後加上來源和目標。

重要

如果您從此範本建立堆疊，則會向您收取所使用的 Amazon 資源費用。

首先，建立 CloudFormation 範本。

在範本區段中，按一下 JSON 或 YAML 索引標籤上的複製圖示，以複製範本內容。
在新檔案中貼上範本內容。
在本機儲存檔案。

接下來，使用剛儲存的範本來佈建 CloudFormation 堆疊。

開啟位在 https://console.aws.amazon.com/cloudformation/ 的 CloudFormation 主控台。
在堆疊頁面上，從建立堆疊功能表中選擇使用新資源 (標準)。
指定範本：
1. 在必要條件下，選擇選擇現有範本。
2. 在指定範本下，選擇上傳範本檔案。
3. 選擇選擇檔案，導覽至範本檔案並選取它。
4. 選擇下一步。
指定堆疊詳細資訊：
1. 輸入堆疊名稱。
2. 對於參數，請接受預設值或輸入您自己的值。
3. 選擇下一步。
設定堆疊選項：
1. 在堆疊失敗選項下，選擇刪除所有新建立的資源。
  
  注意
  選擇此選項可避免堆疊建立失敗時，因資源刪除政策指定為保留而可能產生的資源費用。如需詳細資訊，請參閱 CloudFormation 使用者指南中的 DeletionPolicy 屬性。
2. 接受所有其他預設值。
3. 在功能下，勾選方塊以確認 CloudFormation 可能會在帳戶中建立 IAM 資源。
4. 選擇下一步。
檢閱堆疊詳細資訊，然後選擇提交。

使用 CloudFormation 建立堆疊 (AWS CLI)

您也可以使用 AWS CLI 來建立堆疊。

使用 create-stack 命令。

接受預設範本參數值，指定堆疊名稱。使用 template-body 參數傳遞範本內容，或template-url指定 URL 位置。


aws cloudformation create-stack \
  --stack-name eventbridge-rule-tutorial \
  --template-body template-contents \
  --capabilities CAPABILITY_IAM

覆寫一或多個範本參數的預設值 (s)。例如：


aws cloudformation create-stack \
  --stack-name eventbridge-rule-tutorial \
  --template-body template-contents \
  --parameters \
    ParameterKey=SourceTableName,ParameterValue=pipe-example-source \
    ParameterKey=TargetQueueName,ParameterValue=pipe-example-target \
    ParameterKey=PipeName,ParameterValue=pipe-with-filtering-example \
  --capabilities CAPABILITY_IAM

CloudFormation 會建立堆疊。堆疊建立完成後，堆疊資源即可使用。您可以使用堆疊詳細資訊頁面上的資源索引標籤來檢視帳戶中佈建的資源。

探索管道功能

建立管道之後，您可以使用 EventBridge 主控台來觀察管道操作和測試事件交付。

在 https：//？#/ 開啟 EventBridge 主控台 https://console.aws.amazon.com/events/home管道。
選擇您建立的管道。

在管道詳細資訊頁面上，管道元件區段會顯示構成管道的資源，並包含提供每個元件詳細資訊的索引標籤。

您可以在設定索引標籤的許可區段中找到我們為管道建立的執行角色。

檢查管道篩選條件

在我們測試管道操作之前，讓我們來檢查我們指定的篩選條件，以控制哪些事件會傳送到目標。管道只會將符合篩選條件的事件傳送至目標；所有其他事件都會遭到捨棄。在這種情況下，我們只希望在建立或修改資料表項目時產生的事件傳送到 Amazon SQS 佇列。

在管道詳細資訊頁面的管道元件下，選擇篩選索引標籤。

我們包含的篩選條件只會選取 eventName 設定為 INSERT或的事件MODIFY。
```
{
  "eventName": ["INSERT", "MODIFY"]
}
```

透過管道傳送事件

接下來，我們將在管道來源中產生事件，以測試管道篩選和交付是否正常運作。若要這樣做，我們會在指定為管道來源的 DynamoDB 資料表中建立和編輯項目。

在管道詳細資訊頁面的管道元件下，選擇來源索引標籤。
在來源下，選擇 DynamoDB 串流名稱。

這會在單獨的視窗中開啟 DynamoDB 主控台，並顯示來源資料表詳細資訊。
選擇探索項目。
透過在資料表中建立項目來產生INSERT事件：
1. 選擇 Create item (建立項目)。
2. 新增專輯和藝術家屬性的值。
3. 選擇 Create item (建立項目)。
透過編輯項目來產生 DELETE和 INSERT事件：
1. 從清單中選擇項目，然後從動作功能表中選擇編輯項目。
2. 輸入 Album 或 Artist 屬性的新值。
3. 勾選確認您要變更項目索引鍵值的方塊，然後選擇重新建立項目。
  
  這會導致項目遭到刪除，然後重新建立、產生DELETE事件，然後是新的INSERT事件。
透過將屬性新增至項目來產生MODIFY事件：
1. 從清單中選擇項目，然後從動作功能表中選擇編輯項目。
2. 從新增屬性功能表中，選擇數字。
3. 針對屬性名稱，輸入年份，然後輸入屬性的值。選擇儲存與關閉。

透過管道確認事件交付

最後，我們將確認管道已成功篩選並交付我們在 DynamoDB 中建立和編輯資料表項目所產生的事件。

在管道詳細資訊頁面的管道元件下，選擇目標索引標籤。
在目標下，選擇 Amazon SQS 佇列名稱。

這會在單獨的視窗中開啟 Amazon SQS 主控台，並顯示目標佇列詳細資訊。
選擇傳送及接收訊息。
在接收訊息下，選擇輪詢訊息。

Amazon SQS 會將收到的訊息載入佇列。按一下個別訊息以查看其詳細資訊。

佇列中應該有三個事件訊息：
- 類型的兩個INSERT，一個是在您第一次建立資料表項目時產生的，另一個是在您透過變更索引鍵值重新建立項目時產生的。
- 類型之一MODIFY，當您將屬性新增至資料表項目時產生。
請注意，佇列DELETE中沒有類型的事件訊息，即使您刪除並變更索引鍵值來重新建立資料表項目時，也一樣。我們指定的管道篩選條件只會選取 INSERT和 MODIFY，因此管道會篩選出DELETE事件，而不是將它交付到佇列。

清除：刪除資源

最後一步，我們將刪除堆疊及其包含的資源。

重要

只要堆疊中包含的 Amazon 資源存在，就會向您收取費用。

開啟位在 https://console.aws.amazon.com/cloudformation/ 的 CloudFormation 主控台。
在堆疊頁面上，選擇從範本建立的堆疊，然後選擇刪除，接著確認刪除。

CloudFormation 會啟動刪除堆疊及其包含的所有資源。

CloudFormation 範本詳細資訊

此範本會在您的帳戶中建立資源並授予許可。

Resources

本教學課程的 CloudFormation 範本會在您的帳戶中建立下列資源：

重要

如果您從此範本建立堆疊，則會向您收取所使用的 Amazon 資源費用。

AWS::DynamoDB::Table：做為管道事件來源的 DynamoDB 資料表。
AWS::SQS::Queue：Amazon SQS 佇列，做為流經管道之事件的目標。
AWS::IAM::Role：IAM 執行角色將許可授予您帳戶中的 EventBridge 管道服務。
AWS::Pipes::Pipe：將 DynamoDB 資料表連接至 Amazon SQS 佇列的管道。

許可

範本包含代表執行角色AWS::IAM::Role的資源。此角色會授予 EventBridge 管道服務 (pipes.amazonaws.com) 您帳戶中的下列許可。

下列許可範圍限定於 DynamoDB 資料表，並串流範本建立為管道的事件來源：

dynamodb:DescribeStream
dynamodb:GetRecords
dynamodb:GetShardIterator
dynamodb:ListStreams

下列許可範圍限定為堆疊建立為管道目標的 Amazon SQS 佇列：

sqs:SendMessage

CloudFormation 範本

將下列 JSON 或 YAML 程式碼儲存為個別檔案，以用作本教學課程的 CloudFormation 範本。

JSON


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

 "Description" : "[AWSDocs] EventBridge: pipes-get-started",

  "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: '[AWSDocs] EventBridge: pipes-get-started'
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

您的瀏覽器已停用或無法使用 Javascript。

您必須啟用 Javascript，才能使用 AWS 文件。請參閱您的瀏覽器說明頁以取得說明。

文件慣用形式

管道概念

管道許可