OpenSearch

Die Aktion OpenSearch (openSearch) schreibt Daten aus MQTT-Nachrichten in eine Amazon OpenSearch Service-Domain. Sie können dann Tools wie OpenSearch Dashboards verwenden, um Daten in OpenSearch Service abzufragen und zu visualisieren.

Voraussetzungen

Diese Regelaktion hat die folgenden Anforderungen:

• Eine IAM-Rolle, die die Ausführung des es:ESHttpPut Vorgangs übernehmen AWS IoT kann. Weitere Informationen finden Sie unter Gewähren Sie einer AWS IoT Regel den Zugriff, den sie benötigt.

  In der AWS IoT Konsole können Sie eine Rolle auswählen oder erstellen, um die Ausführung dieser Regelaktion AWS IoT zu ermöglichen.

• Wenn Sie einen Kunden einsetzen, der es geschafft hat, ruhende Daten im OpenSearch Service AWS KMS key zu verschlüsseln, muss der Service über die Erlaubnis verfügen, den KMS-Schlüssel im Namen des Anrufers zu verwenden. Weitere Informationen finden Sie unter Verschlüsselung ruhender Daten für Amazon OpenSearch Service im Amazon OpenSearch Service Developer Guide.

Parameter

Wenn Sie eine AWS IoT Regel mit dieser Aktion erstellen, müssen Sie die folgenden Informationen angeben:

endpoint

Der Endpunkt Ihrer Amazon OpenSearch Service-Domain.

Unterstützt Ersatzvorlagen: API und nur AWS CLI

index

Der OpenSearch Index, in dem Sie Ihre Daten speichern möchten.

Unterstützt Ersatzvorlagen: Ja

type

Der Typ des Dokuments, das Sie speichern

Anmerkung

Für OpenSearch Versionen nach 1.0 muss der Wert des type Parameters sein_doc. Weitere Informationen finden Sie in der OpenSearch Dokumentation.

Unterstützt Ersatzvorlagen: Ja

id

Der eindeutige Bezeichner für jedes Dokument

Unterstützt Ersatzvorlagen: Ja

roleARN

Die IAM-Rolle, die den Zugriff auf die OpenSearch Service-Domäne ermöglicht. Weitere Informationen finden Sie unter Voraussetzungen.

Unterstützt Ersatzvorlagen: Nein

Einschränkungen

Die Aktion OpenSearch (openSearch) kann nicht verwendet werden, um Daten an VPC-Elasticsearch-Cluster zu liefern.

Beispiele

Das folgende JSON-Beispiel definiert eine OpenSearch Aktion in einer AWS IoT Regel und wie Sie die Felder für die OpenSearch Aktion angeben können. Weitere Informationen finden Sie unter OpenSearchAktion.

{
    "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"
                }
            }
        ]
    }
}

Das folgende JSON-Beispiel definiert eine OpenSearch Aktion mit Ersatzvorlagen in einer AWS IoT Regel.

{
    "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"
                }
            }
        ]
    }
}

Anmerkung

Das ersetzte type Feld funktioniert für OpenSearch Version 1.0. Für alle Versionen nach 1.0 type muss der Wert von sein_doc.

Weitere Informationen finden Sie auch unter

Was ist Amazon OpenSearch Service? im Amazon OpenSearch Service Developer Guide