Elasticsearch - Amazon IoT Core
RequirementsParametersExamplesSee also
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

Elasticsearch

The Elasticsearch (elasticsearch) action writes data from MQTT messages to an Amazon OpenSearch Service domain. You can then use tools like OpenSearch Dashboards to query and visualize data in OpenSearch Service.

Warning

The Elasticsearch action can only be used by existing rule actions. To create a new rule action or to update an existing rule action, use the OpenSearch rule action instead. For more information, see OpenSearch.

Requirements

This rule action has the following requirements:

  • An IAM role that Amazon IoT can assume to perform the es:ESHttpPut operation. For more information, see Granting an Amazon IoT rule the access it requires.

    In the Amazon IoT console, you can choose or create a role to allow Amazon IoT to perform this rule action.

  • If you use a customer managed Amazon KMS key (KMS key) to encrypt data at rest in OpenSearch, the service must have permission to use the KMS key on the caller's behalf. For more information, see Encryption of data at rest for Amazon OpenSearch Service in the Amazon OpenSearch Service Developer Guide.

Parameters

When you create an Amazon IoT rule with this action, you must specify the following information:

endpoint

The endpoint of your service domain.

Supports substitution templates: API and Amazon CLI only

index

The index where you want to store your data.

Supports substitution templates: Yes

type

The type of document you are storing.

Supports substitution templates: Yes

id

The unique identifier for each document.

Supports substitution templates: Yes

roleARN

The IAM role that allows access to the OpenSearch Service domain. For more information, see Requirements.

Supports substitution templates: No

Examples

The following JSON example defines an Elasticsearch action in an Amazon IoT rule and how you can specify the fields for the elasticsearch action. For more information, see 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"
                }
            }
        ]
    }
}

The following JSON example defines an Elasticsearch action with substitution templates in an Amazon IoT rule.

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

See also