AWS::IoT::TopicRule OpenSearchAction - AWS CloudFormation
SyntaxProperties

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

AWS::IoT::TopicRule OpenSearchAction

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

Syntax

To declare this entity in your AWS 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 OpenSearch 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