AWS::IoT::TopicRule ElasticsearchAction - Amazon CloudFormation
SyntaxProperties
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).

This is the new Amazon CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the Amazon CloudFormation User Guide.

AWS::IoT::TopicRule ElasticsearchAction

Describes an action that writes data to an Amazon OpenSearch Service domain.

Note

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 OpenSearchAction.

Syntax

To declare this entity in your Amazon CloudFormation template, use the following syntax:

JSON

{
  "Endpoint" : String,
  "Id" : String,
  "Index" : String,
  "RoleArn" : String,
  "Type" : String
}

YAML

  Endpoint: String
  Id: String
  Index: String
  RoleArn: String
  Type: String

Properties

Endpoint

The endpoint of your OpenSearch domain.

Required: Yes

Type: String

Pattern: https?://.*

Update requires: No interruption

Id

The unique identifier for the document you are storing.

Required: Yes

Type: String

Update requires: No interruption

Index

The index where you want to store your data.

Required: Yes

Type: String

Update requires: No interruption

RoleArn

The IAM role ARN that has access to OpenSearch.

Required: Yes

Type: String

Update requires: No interruption

Type

The type of document you are storing.

Required: Yes

Type: String

Update requires: No interruption