OpenSearch - Amazon IoT Core
要求参数限制示例另请参阅
Amazon Web Services 文档中描述的 Amazon Web Services 服务或功能可能因区域而异。要查看适用于中国区域的差异，请参阅 中国的 Amazon Web Services 服务入门 (PDF)。

OpenSearch

OpenSearch (openSearch) 操作可将 MQTT 消息中的数据写入 Amazon OpenSearch Service 域。然后，您可以使用像 OpenSearch Dashboards 这样的工具来查询和可视化 OpenSearch Service 中的数据。

要求

此规则操作具有以下要求：

  • Amazon IoT 可以承担以执行 es:ESHttpPut 操作的 IAM 角色。有关更多信息，请参阅 向 Amazon IoT 规则授予所需的访问权限。

    在 Amazon IoT 控制台中，您可以选择或创建一个角色以允许 Amazon IoT 执行此规则操作。

  • 如果您使用客户自主管理型 Amazon KMS key 加密 OpenSearch Service 中的静态数据，服务必须具有代表调用方使用 KMS 密钥的权限。有关更多信息，请参阅《Amazon OpenSearch Service 开发人员指南》中的为 Amazon OpenSearch Service 静态加密数据。

参数

使用此操作创建 Amazon IoT 规则时，您必须指定以下信息：

endpoint

Amazon OpenSearch Service 域的端点。

支持替换模板：仅限 API 和 Amazon CLI

index

您要在其中存储数据的 OpenSearch 索引。

支持替换模板：是

type

您存储的文档类型。

注意

对于 1.0 之后的 OpenSearch 版本，type 参数的值必须为 _doc。有关更多信息，请参阅 OpenSearch 文档。

支持替换模板：是

id

每个文档的唯一标识符。

支持替换模板：是

roleARN

允许访问 OpenSearch Service 域的 IAM 角色。有关更多信息，请参阅 要求。

支持替换模板：否

限制

OpenSearch (openSearch) 操作不能用于向 VPC Elasticsearch 集群传送数据。

示例

下面的 JSON 示例定义了 Amazon 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 示例定义了 Amazon 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？