OpenSearch

A ação OpenSearch (openSearch) grava dados de mensagens MQTT em um domínio da Amazon OpenSearch Service. Em seguida, você pode usar ferramentas como OpenSearch painéis para consultar e visualizar dados no OpenSearch Service.

Requisitos

Esta ação de regra tem os seguintes requisitos:

• Uma função do IAM que AWS IoT você pode assumir para realizar a es:ESHttpPut operação. Para ter mais informações, consulte Conceder a uma AWS IoT regra o acesso necessário.

  No AWS IoT console, você pode escolher ou criar uma função para permitir AWS IoT a execução dessa ação de regra.

• Se você usa um cliente gerenciado AWS KMS key para criptografar dados em repouso no OpenSearch Service, o serviço deve ter permissão para usar a chave KMS em nome do chamador. Para obter mais informações, consulte Criptografia de dados em repouso para o Amazon OpenSearch Service no Amazon OpenSearch Service Developer Guide.

Parâmetros

Ao criar uma AWS IoT regra com essa ação, você deve especificar as seguintes informações:

endpoint

O endpoint do seu domínio do Amazon OpenSearch Service.

Suporta modelos de substituição: API e somente AWS CLI

index

O OpenSearch índice em que você deseja armazenar seus dados.

Compatível com modelos de substituição: Sim

type

O tipo de documento que você está armazenando.

nota

Para OpenSearch versões posteriores à 1.0, o valor do type parâmetro deve ser_doc. Para obter mais informações, consulte a OpenSearch documentação.

Compatível com modelos de substituição: Sim

id

O identificador exclusivo de cada documento.

Compatível com modelos de substituição: Sim

roleARN

A função do IAM que permite acesso ao domínio do OpenSearch Serviço. Para ter mais informações, consulte Requisitos.

Compatível com modelos de substituição: Não

Limitações

A ação OpenSearch (openSearch) não pode ser usada para entregar dados aos clusters do VPC Elasticsearch.

Exemplos

O exemplo de JSON a seguir define uma OpenSearch ação em uma AWS IoT regra e como você pode especificar os campos para a OpenSearch ação. Para obter mais informações, 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"
                }
            }
        ]
    }
}

O exemplo de JSON a seguir define uma OpenSearch ação com modelos de substituição em uma AWS IoT regra.

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

O type campo substituído funciona para a OpenSearch versão 1.0. Para qualquer versão posterior à 1.0, o valor de type deve ser_doc.

Consulte também

O que é o Amazon OpenSearch Service? no Amazon OpenSearch Service Developer Guide