すべてのプロダクト
Search

このプロダクト

    EventBridge:イベント変換

    ドキュメントセンター

    EventBridge:イベント変換

    最終更新日:Jan 11, 2025

    EventBridge はイベントコンテンツの変換をサポートしています。具体的には、EventBridge は、標準の CloudEvents 形式のイベントを、イベントターゲットが受信できるイベントタイプに変換してから、イベントターゲットにルーティングできます。このトピックでは、EventBridge が提供するイベント変換方法について説明します。

    背景情報

    EventBridge は、以下のイベント変換方法をサポートしています。

    完全なイベント

    変換方法として [完全なイベント] を指定した場合、EventBridge はイベントを変換せず、CloudEvents 形式の完全なイベントをイベントターゲットにルーティングします。次の表は、[完全なイベント] 変換方法が使用されるサンプルイベントを示しています。

    説明

    CloudEvents については、「CloudEvents 1.0」をご参照ください。

    変換前のイベント

    変換方法

    変換後のイベント

    {
    "id":"7adc8c1a-645d-4476-bdef-5d6fb57f****",
    "source":"acs.oss",
    "specversion":"1.0",
    "type":"oss:ObjectCreated:PostObject",
    "datacontenttype":"application/json",
    "dataschema":"http://example.com/test.json",
    "subject":"acs:oss:cn-hangzhou:1234567:xls-papk/game_apk/123.jpg",
    "time":"2020-08-17T16:04:46.149Asia/Shanghai",
    "aliyuneventbusname":"demo-bus",
    "aliyunregionid":"Shanghai",
    "data":{
        "name":"test",
        "scope":100
    }
}

    完全なイベント

    {
    "id":"7adc8c1a-645d-4476-bdef-5d6fb57f****",
    "source":"acs.oss",
    "specversion":"1.0",
    "type":"oss:ObjectCreated:PostObject",
    "datacontenttype":"application/json",
    "dataschema":"http://example.com/test.json",
    "subject":"acs:oss:cn-hangzhou:1234567:xls-papk/game_apk/123.jpg",
    "time":"2020-08-17T16:04:46.149Asia/Shanghai",
    "aliyuneventbusname":"demo-bus",
    "aliyunregionid":"Shanghai",
    "data":{
        "name":"test",
        "scope":100
    }
}

    部分イベント

    [部分イベント] を変換方法として指定した場合、EventBridge は JSONPath を使用して CloudEvents 形式のイベントからフィールドを抽出し、イベントの指定されたコンテンツをイベントターゲットにルーティングします。次の表は、[部分イベント] 変換方法が使用されるサンプルイベントを示しています。

    変換前のイベント

    変換方法

    変換後のイベント

    {
    "id":"7adc8c1a-645d-4476-bdef-5d6fb57f****",
    "source":"acs.oss",
    "specversion":"1.0",
    "type":"oss:ObjectCreated:PostObject",
    "datacontenttype":"application/json",
    "dataschema":"http://example.com/test.json",
    "subject":"acs:oss:cn-hangzhou:1234567:xls-papk/game_apk/123.jpg",
    "time":"2020-08-17T16:04:46.149Asia/Shanghai",
    "aliyuneventbusname":"demo-bus",
    "aliyunregionid":"Shanghai",
    "data":{
        "name":"test",
        "scope":100
    }
}

    部分イベント

    $.data.name
    説明

    • [部分イベント] 変換方法を使用する場合は、変数を 1 つだけ定義できます。

    • 値: 値の長さは最大 10,240 文字です。

    test

    定数

    [定数] を変換方法として指定した場合、EventBridge は、イベントに含まれるコンテンツに関係なく、イベント内の定数をイベントターゲットにルーティングします。この場合、イベントはトリガーとして使用されます。次の表は、[定数] 変換方法が使用されるサンプルイベントを示しています。

    変換前のイベント

    変換方法

    変換後のイベント

    {
    "id":"7adc8c1a-645d-4476-bdef-5d6fb57f****",
    "source":"acs.oss",
    "specversion":"1.0",
    "type":"oss:ObjectCreated:PostObject",
    "datacontenttype":"application/json",
    "dataschema":"http://example.com/test.json",
    "subject":"acs:oss:cn-hangzhou:1234567:xls-papk/game_apk/123.jpg",
    "time":"2020-08-17T16:04:46.149Asia/Shanghai",
    "aliyuneventbusname":"demo-bus",
    "aliyunregionid":"Shanghai",
    "data":{
        "name":"test",
        "scope":100
    }
}

    定数

    test1
    説明

    値: 値の長さは最大 10,240 文字です。

    test1

    テンプレート

    [テンプレート] を変換方法として指定した場合、EventBridge は JSONPath を使用して CloudEvents 形式のイベントからフィールドを抽出し、値を変数に格納してから、テンプレートで定義された形式のイベントをイベントターゲットにルーティングします。次の表は、[テンプレート] 変換方法が使用されるサンプルイベントを示しています。

    変換前のイベント

    変換方法

    変換後のイベント

    {
    "id":"7adc8c1a-645d-4476-bdef-5d6fb57f****",
    "source":"acs.oss",
    "specversion":"1.0",
    "type":"oss:ObjectCreated:PostObject",
    "datacontenttype":"application/json",
    "dataschema":"http://example.com/test.json",
    "subject":"acs:oss:cn-hangzhou:1234567:xls-papk/game_apk/123.jpg",
    "time":"2020-08-17T16:04:46.149Asia/Shanghai",
    "aliyuneventbusname":"demo-bus",
    "aliyunregionid":"Shanghai",
    "data":{
        "name":"test",
        "scope":100
    }
}

    テンプレート

    • 変数

      {
    "name":"$.data.name",
    "constant":"Please deal with it timely." // 適時に対処してください。
}
      説明

      • JSONPath を使用して抽出される値は、パラメーターまたは固定値です。

      • パラメーターを定義する場合、ネストされた構造はサポートされていません。

      • 値: 値の長さは最大 10,240 文字です。

    • テンプレート

      The instance is broken, which name is ${name}, ${constant} // インスタンスが壊れています。名前は ${name}、${constant} です。
      説明

      テンプレート: 値の長さは最大 10,240 文字です。

    The instance is broken, which name is test, Please deal with it timely.

    文字列または JSON 形式でカスタムテンプレートを指定し、テンプレートに基づいてイベントを変換し、イベントをイベントターゲットにルーティングできます。EventBridge は、以下のタイプのテンプレートをサポートしています。

    表 1. 単純な文字列

    変換前のイベント

    変換方法

    変換後のイベント

    {
    "id":"7adc8c1a-645d-4476-bdef-5d6fb57f****",
    "source":"acs.oss",
    "specversion":"1.0",
    "type":"oss:ObjectCreated:PostObject",
    "datacontenttype":"application/json",
    "dataschema":"http://example.com/test.json",
    "subject":"acs:oss:cn-hangzhou:1234567:xls-papk/game_apk/123.jpg",
    "time":"2020-08-17T16:04:46.149Asia/Shanghai",
    "aliyuneventbusname":"demo-bus",
    "aliyunregionid":"Shanghai",
    "data":{
        "name":"test",
        "state":"RUNNING"
    }
}

    テンプレート

    • 変数

      {
    "name":"$.data.name",
    "state":"$.data.state"
}

    • テンプレート

      "name ${name} is in ${state}" // name ${name} は ${state} です。

    "name test is in RUNNING"

    表 2. 単純な JSON

    変換前のイベント

    変換方法

    変換後のイベント

    {
    "id":"7adc8c1a-645d-4476-bdef-5d6fb57f****",
    "source":"acs.oss",
    "specversion":"1.0",
    "type":"oss:ObjectCreated:PostObject",
    "datacontenttype":"application/json",
    "dataschema":"http://example.com/test.json",
    "subject":"acs:oss:cn-hangzhou:1234567:xls-papk/game_apk/123.jpg",
    "time":"2020-08-17T16:04:46.149Asia/Shanghai",
    "aliyuneventbusname":"demo-bus",
    "aliyunregionid":"Shanghai",
    "data":{
        "name":"test",
        "state":"RUNNING"
    }
}

    テンプレート

    • 変数

      {
    "name":"$.data.name",
    "state":"$.data.state"
}

    • テンプレート

      {
    "name":"${name}",
    "state":"${state}"
}
    {
    "name":"test",
    "state":"RUNNING"
}

    表 3. 変数と定数を含む JSON

    変換前のイベント

    変換方法

    変換後のイベント

    {
    "id":"7adc8c1a-645d-4476-bdef-5d6fb57f****",
    "source":"acs.oss",
    "specversion":"1.0",
    "type":"oss:ObjectCreated:PostObject",
    "datacontenttype":"application/json",
    "dataschema":"http://example.com/test.json",
    "subject":"acs:oss:cn-hangzhou:1234567:xls-papk/game_apk/123.jpg",
    "time":"2020-08-17T16:04:46.149Asia/Shanghai",
    "aliyuneventbusname":"demo-bus",
    "aliyunregionid":"Shanghai",
    "data":{
        "name":"test",
        "state":"RUNNING"
    }
}

    テンプレート

    • 変数

      {
    "name":"$.data.name",
    "state":"$.data.state"
}

    • テンプレート

      {
    "name":"${name}",
    "state":[
        9,
        "${state}",
        true
    ],
    "Transformed":"Yes" // 変換済み:"はい"
}
    {
    "name":"test",
    "state":[
        9,
        "RUNNING",
        true
    ],
    "Transformed":"Yes"
}

    表 4. ネストされた JSON

    変換前のイベント

    変換方法

    変換後のイベント

    {
    "id": "45ef4dewdwe1-7c35-447a-bd93-fab****",
    "source": "acs.imm",
    "specversion": "1.0",
    "subject": "acs.imm:cn-hangzhou:123456789098****:215672",
    "time": "2020-11-19T21:04:41+08:00",
    "type": "imm:FileMeta:Index",
    "aliyunaccountid": "123456789098****",
    "aliyunpublishtime": "2020-11-19T21:04:42.179PRC",
    "aliyuneventbusname": "default",
    "aliyunregionid": "cn-hangzhou",
    "aliyunpublishaddr": "172.25.XX.XX",
    "data": {
        "ProjectName": "test_project",
        "DatasetName": "test_dataset",
        "RequestId": "D2A3AE88-D17C-4CCC-B149-6651115C****",
        "StartTime": "2021-07-22T14:03:15.489885+08:00",
        "EndTime": "2021-07-22T14:05:15.489885+08:00",
        "Message": "InvalidParameter",
        "Success": false,
        "Files": [
            {
                "URI": "oss://bucket/file",
                "CustomId": "defaultId",
                "CustomLabels": {
                    "Key1": "Val1",
                    "Key2": "Val2"
                },
                "Error": "InternalError"
            }
        ]
    }
}

    テンプレート

    • 変数

      {   
    "ProjectName":"$.data.ProjectName",
    "Files":"$.data.Files"
}

    • テンプレート

      {
    "ProjectName":"${ProjectName}",
    "Files":${Files}
}
    {  
    "ProjectName":"test_project",
  "Files": [
        {
            "URI": "oss://bucket/file",
            "CustomId": "defaultId",
            "CustomLabels": {
                "Key1": "Val1",
                "Key2": "Val2"
            },
            "Error": "InternalError"
        }
    ]
}

    特殊文字の処理をサポートする関数の名前は、jsonEscape と htmlEscape です。

    • jsonEscape 関数は、JSON 文字列内の特殊文字をエスケープして、埋め込まれた特殊文字が JSON 形式を破損するのを防ぐために使用されます。

      次のサンプルコードは、二重引用符 ("") を含む変数の例を示しています。

      {
  "var" : "\"abc\""
}

      次のコードは、テンプレートで jsonEscape 関数を使用する方法を示しています。

      {
  "text": "var is ${jsonEscape(var)}" // var は ${jsonEscape(var)} です。
}

      エスケープされた出力:

      {
  "text": "var is \"abc\""
}

    • htmlEscape 関数は、HTML 内の特殊文字をエスケープするために使用されます。特殊文字がエスケープされると、通常の文字列として出力されます。これにより、悪意のあるスクリプトの挿入によるセキュリティリスクを防ぎます。

      次のサンプルコードは、HTML コンテンツを含む変数の例を示しています。

      {
  "var" : "<script>alert('unsafe');</script>"
}

      次のコードは、テンプレートで htmlEscape 関数を使用する方法を示しています。

      <p>User Input: ${htmlEscape(var)}</p>

      エスケープされた出力:

      <p>User Input: &lt;script&gt;alert('unsafe');&lt;/script&gt;</p>