Amazon EventBridge での AWS AppSync ルールターゲット

AWS AppSync を使用すると、デベロッパーは安全かつサーバーレスで高性能な GraphQL および Pub/Sub API を使用して、アプリケーションやサービスをデータやイベントに接続できます。AWS AppSync を使用すると、GraphQL ミューテーションを使用してリアルタイムのデータ更新をアプリケーションに公開できます。EventBridge は、一致したイベントに対する有効な GraphQL ミューテーション操作の呼び出しをサポートしています。AWS AppSync API ミューテーションをターゲットとして指定すると、AWS AppSync はミューテーション操作によってイベントを処理し、ミューテーションにリンクされたサブスクリプションをトリガーできるようにします。

注記

EventBridge は、AWS AppSync パブリック GraphQL API をサポートしています。EventBridge は現在、AWS AppSync Private API をサポートしていません。

AWS AppSync GraphQL API ターゲットは、以下のユースケースで使用できます。

設定したデータソースへのイベントデータのプッシュ、変換、保存
接続しているアプリケーションクライアントへの通知のリアルタイム送信

注記

AWS AppSync ターゲットは、AWS_IAM 認証タイプを使用した AWS AppSync GraphQL API の呼び出しのみをサポートします。

AWS AppSync GraphQL API の詳細については、「AWS AppSync デベロッパーガイド」の「GraphQL と AWS AppSync アーキテクチャ」を参照してください。

コンソールを使用して EventBridge ルールの AWS AppSync ターゲットを指定するには

ルールを作成または編集します。
[ターゲット] で、[AWS のサービス]、[AWS AppSync] の順に選択してターゲットを指定します。
解析して実行するミューテーション操作を、選択セットと共に指定します。
- AWS AppSync API を選択してから、呼び出す GraphQL API ミューテーションを選択します。
- [パラメータと選択セットの設定] で、選択セットの作成にキーと値のマッピングを使用するか、入力トランスフォーマーを使用するかを選択します。
  Key-value mapping
  
  キーと値のマッピングを使用して選択セットを作成するには:
  
  API パラメータの変数を指定します。各変数は、静的な値でも、イベントペイロードへの動的な JSON パス式でもかまいません。
  
  [選択セット] で、レスポンスに含める変数を選択します。
  
  Input transformer
  
  入力トランスフォーマーを使用して選択セットを作成するには:
  
  使用する変数を定義する入力パスを指定します。
  
  ターゲットに渡す情報を定義およびフォーマットする入力テンプレートを指定します。
  
  詳細については、「EventBridge でルールを作成するときに入力トランスフォーマーを設定する」を参照してください。
[実行ロール] で、新しいロールを作成するか、既存のロールを使用するかを選択します。
ルールの作成または編集を完了します。

例: Amazon EventBridge の AWS AppSync ターゲット

次の例では、イベントを配信用にフォーマットするための入力変換を定義するなど、EventBridge ルールの AWS AppSync ターゲットを指定する方法を示します。

以下のスキーマで定義された AWS AppSync GraphQL API (Ec2EventAPI) があるとします。


type Event {
    id: ID!
    statusCode: String
    instanceId: String
}

type Mutation {
    pushEvent(id: ID!, statusCode: String!, instanceId: String): Event
}

type Query {
    listEvents: [Event]
}

type Subscription {
    subscribeToEvent(id: ID, statusCode: String, instanceId: String): Event
        @aws_subscribe(mutations: ["pushEvent"])
}

この API を使用するアプリケーションクライアントは、pushEvent ミューテーションによってトリガーされる subscribeToEvent サブスクリプションにサブスクライブできます。

pushEvent ミューテーションを介して AppSync API にイベントを送信するターゲットを使用して EventBridge ルールを作成できます。ミューテーションを呼び出すと、サブスクライブしているすべてのクライアントがイベントを受信します。

この API を EventBridge ルールのターゲットとして指定するには、次の操作を行います。

ルールターゲットの Amazon リソースネーム (ARN) を Ec2EventAPI API の GraphQL エンドポイント ARN に設定します。
GraphQL ミューテーション操作をターゲットパラメータとして指定します。
```
mutation CreatePushEvent($id: ID!, $statusCode: String, $instanceId: String) {
  pushEvent(id: $input, statusCode: $statusCode, instanceId: $instanceId) {
    id
    statusCode
    instanceId
  }
}
```
ミューテーション選択セットには、GraphQL サブスクリプションでサブスクライブするすべてのフィールドを含める必要があります。

入力トランスフォーマーを設定して、一致したイベントのデータをどのように操作で使用するかを指定します。

次の “EC2 Instance Launch Successful” サンプルイベントを選択したとします。


{
  "version": "0",
  "id": "3e3c153a-8339-4e30-8c35-687ebef853fe",
  "detail-type": "EC2 Instance Launch Successful",
  "source": "aws.autoscaling",
  "account": "123456789012",
  "time": "2015-11-11T21:31:47Z",
  "region": "us-east-1",
  "resources": ["arn:aws:autoscaling:us-east-1:123456789012:autoScalingGroup:eb56d16b-bbf0-401d-b893-d5978ed4a025:autoScalingGroupName/sampleLuanchSucASG", "arn:aws:ec2:us-east-1:123456789012:instance/i-b188560f"],
  "detail": {
    "StatusCode": "InProgress",
    "AutoScalingGroupName": "sampleLuanchSucASG",
    "ActivityId": "9cabb81f-42de-417d-8aa7-ce16bf026590",
    "Details": {
      "Availability Zone": "us-east-1b",
      "Subnet ID": "subnet-95bfcebe"
    },
    "RequestId": "9cabb81f-42de-417d-8aa7-ce16bf026590",
    "EndTime": "2015-11-11T21:31:47.208Z",
    "EC2InstanceId": "i-b188560f",
    "StartTime": "2015-11-11T21:31:13.671Z",
    "Cause": "At 2015-11-11T21:31:10Z a user request created an AutoScalingGroup changing the desired capacity from 0 to 1.  At 2015-11-11T21:31:11Z an instance was started in response to a difference between desired and actual capacity, increasing the capacity from 0 to 1."
  }
}

ターゲット入力トランスフォーマーの入力パスを使用して、テンプレートで使用する以下の変数を定義できます。


{
  "id": "$.id",
  "statusCode": "$.detail.StatusCode",
  "EC2InstanceId": "$.detail.EC2InstanceId"
}

入力トランスフォーマーのテンプレートを作成して、EventBridge から AWS AppSync ミューテーション操作に渡す変数を定義します。テンプレートは JSON として評価される必要があります。入力パスを指定すると、次のテンプレートを作成できます。


{
  "id": <id>,
  "statusCode": <statusCode>,
  "instanceId": <EC2InstanceId>
}

ブラウザで JavaScript が無効になっているか、使用できません。

AWS ドキュメントを使用するには、JavaScript を有効にする必要があります。手順については、使用するブラウザのヘルプページを参照してください。

ドキュメントの表記規則

API Gateway ターゲット

ターゲットとしてのクロスアカウントイベントバス