Elasticsearch

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

警告

Elasticsearchアクションは、既存のルールアクションのみで使用できます。新しいルールアクションを作成したり、既存のルールアクションを更新したりするには、OpenSearchルールアクションを代わりに使用します。詳細については、「OpenSearch」を参照してください。

要件

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

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

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

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

パラメータ

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

endpoint

サービスドメインのエンドポイント。

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

index

データを保存したい インデックス。

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

type

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

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

id

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

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

roleARN

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

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

例

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

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

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

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

以下も参照してください。

• OpenSearch

• Amazon OpenSearch Service とは