View a markdown version of this page

OpenSearch - AWS IoT Core
RequisitosParametersLimitacionesEjemplosVéase también

Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.

OpenSearch

La acción OpenSearch (openSearch) escribe datos de los mensajes MQTT en un dominio de Amazon OpenSearch Service. A continuación, puede utilizar herramientas como los OpenSearch paneles de control para consultar y visualizar datos en el OpenSearch Servicio.

Requisitos

Esta regla tiene los siguientes requisitos:

  • Una función de IAM que AWS IoT puede asumir para realizar la es:ESHttpPut operación. Para obtener más información, consulte Otorgar un AWS IoT reglamentar el acceso que requiere.

    En la AWS IoT consola, puede elegir o crear un rol que permita AWS IoT realizar esta acción de regla.

  • Si utilizas un cliente que ha conseguido AWS KMS key cifrar datos inactivos en el OpenSearch Servicio, el servicio debe tener permiso para usar la clave de KMS en nombre de la persona que llama. Para obtener más información, consulta el artículo Cifrado de datos en reposo para Amazon OpenSearch Service en la Guía para desarrolladores de Amazon OpenSearch Service.

Parameters

Al crear una AWS IoT regla con esta acción, debes especificar la siguiente información:

endpoint

El punto final de tu dominio OpenSearch de Amazon Service.

Soporta plantillas de sustitución: AWS CLI solo con API

index

El OpenSearch índice en el que desea almacenar sus datos.

Admite plantillas de sustitución: Sí

type

Tipo de documento que está almacenando.

nota

Para OpenSearch las versiones posteriores a la 1.0, el valor del type parámetro debe ser_doc. Para obtener más información, consulte la Documentación de OpenSearch .

Admite plantillas de sustitución: Sí

id

Identificador único de cada documento.

Admite plantillas de sustitución: Sí

roleARN

La función de IAM que permite el acceso al dominio del OpenSearch servicio. Para obtener más información, consulte Requisitos.

Admite plantillas de sustitución: No

Limitaciones

La acción OpenSearch (openSearch) no se puede usar para entregar datos a los clústeres de Elasticsearch de la VPC.

Ejemplos

El siguiente ejemplo de JSON define una OpenSearch acción en una AWS IoT regla y cómo puedes especificar los campos de la acción. OpenSearch Para obtener más información, consulte 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"
                }
            }
        ]
    }
}

El siguiente ejemplo de JSON define una OpenSearch acción con plantillas de sustitución en una AWS IoT regla.

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

El type campo sustituido funciona en la OpenSearch versión 1.0. Para cualquier versión posterior a la 1.0, el valor de type debe ser _doc.

Véase también

¿Qué es Amazon OpenSearch Service? en la Guía para desarrolladores OpenSearch de Amazon Service