OpenSearch

OpenSearch （openSearch) アクションは、MQTTメッセージから Amazon OpenSearch Service ドメインにデータを書き込みます。その後、 OpenSearch Dashboards などのツールを使用して、 OpenSearch サービス内のデータをクエリおよび視覚化できます。

要件

このルールアクションには、以下の要件があります。

• es:ESHttpPut オペレーションを実行するために が引き受け AWS IoT ることができる IAMロール。詳細については、「AWS IoT ルールに必要なアクセス許可の付与」を参照してください。

  AWS IoT コンソールでは、 がこのルールアクションを実行することを許可 AWS IoT するロールを選択または作成できます。

• カスタマー管理 AWS KMS key の を使用して OpenSearch サービスに保管中のデータを暗号化する場合、サービスには発信者に代わってKMSキーを使用するアクセス許可が必要です。詳細については、「Amazon OpenSearch Service デベロッパーガイド」の「Amazon Service の保管中のデータの暗号化」を参照してください。 OpenSearch

パラメータ

このアクションで AWS IoT ルールを作成するときは、次の情報を指定する必要があります。

endpoint

Amazon OpenSearch Service ドメインのエンドポイント。

置換テンプレートをサポート: APIおよび AWS CLI のみ

index

データを保存する OpenSearch インデックス。

置換テンプレートをサポート: はい

type

保存するドキュメントのタイプ。

注記

1.0 以降の OpenSearch バージョンでは、 typeパラメータの値は である必要があります_doc。詳細については、OpenSearch のドキュメントを参照してください。

置換テンプレートをサポート: はい

id

各ドキュメントの一意の識別子。

置換テンプレートをサポート: はい

roleARN

OpenSearch サービスドメインへのアクセスを許可するIAMロール。詳細については、「要件」を参照してください。

置換テンプレートをサポート: いいえ

制限

OpenSearch （openSearch) アクションは、Elasticsearch VPC クラスターへのデータの配信には使用できません。

例

次のJSON例では、 AWS IoT ルールで OpenSearch アクションを定義し、OpenSearchアクションのフィールドを指定する方法を示します。詳細については、「OpenSearchAction」を参照してください。

{
    "topicRulePayload": {
        "sql": "SELECT *, timestamp() as timestamp FROM 'iot/test'",
        "ruleDisabled": false,
        "awsIotSqlVersion": "2016-03-23",
        "actions": [
            {
                "openSearch": {
                    "endpoint": "https://my-endpoint",
                    "index": "my-index",
                    "type": "_doc",
                    "id": "${newuuid()}",
                    "roleArn": "arn:aws:iam::123456789012:role/aws_iot_os"
                }
            }
        ]
    }
}

次のJSON例では、 AWS IoT ルールで置換テンプレートを使用して OpenSearch アクションを定義します。

{
    "topicRulePayload": {
        "sql": "SELECT * FROM 'some/topic'",
        "ruleDisabled": false,
        "awsIotSqlVersion": "2016-03-23",
        "actions": [
            {
                "openSearch": {
                    "endpoint": "https://my-endpoint",
                    "index": "${topic()}",
                    "type": "${type}",
                    "id": "${newuuid()}",
                    "roleArn": "arn:aws:iam::123456789012:role/aws_iot_os"
                }
            }
        ]
    }
}

注記

置換されたtypeフィールドは、 OpenSearch バージョン 1.0 で機能します。1.0 以降のバージョンでは、type の値は _doc である必要があります。

関連情報

Amazon OpenSearch Service デベロッパーガイドの「Amazon Service とは OpenSearch 」