OpenSearch - AWS IoT Core
要件パラメータ制限例関連情報

翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

OpenSearch

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

要件

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

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

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

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

パラメータ

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

endpoint

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

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

index

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

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

type

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

注記

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

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

id

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

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

roleARN

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

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

制限

OpenSearch (openSearch) アクションを使用して VPC Elasticsearch クラスターにデータを配信することはできません。

例

次の 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 OpenSearch Service とは?」