Package software.amazon.awscdk.services.iot.actions.alpha

Interface OpenSearchActionProps

All Superinterfaces:

CommonActionProps, software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

OpenSearchActionProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.118.0 (build 02eec31)",
           date="2025-11-04T09:27:53.827Z")
@Stability(Experimental)
public interface OpenSearchActionProps
extends software.amazon.jsii.JsiiSerializable, CommonActionProps

(experimental) Configuration properties of an action for Open Search.

Example:

 import software.amazon.awscdk.services.opensearchservice.*;
 Domain domain;
 TopicRule topicRule = TopicRule.Builder.create(this, "TopicRule")
         .sql(IotSql.fromStringAsVer20160323("SELECT topic(2) as device_id, year, month, day FROM 'device/+/data'"))
         .build();
 topicRule.addAction(OpenSearchAction.Builder.create(domain)
         .id("my-id")
         .index("my-index")
         .type("my-type")
         .build());
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	OpenSearchActionProps.Builder	A builder for OpenSearchActionProps
static final class	OpenSearchActionProps.Jsii$Proxy	An implementation for OpenSearchActionProps

Method Summary

Modifier and Type	Method	Description
static OpenSearchActionProps.Builder	builder()
String	getId()	(experimental) The unique identifier for the document you are storing.
String	getIndex()	(experimental) The OpenSearch index where you want to store your data.
String	getType()	(experimental) The type of document you are storing.

Methods inherited from interface software.amazon.awscdk.services.iot.actions.alpha.CommonActionProps

getRole

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getId

@Stability(Experimental)
@NotNull
String getId()

(experimental) The unique identifier for the document you are storing.

getIndex

@Stability(Experimental)
@NotNull
String getIndex()

(experimental) The OpenSearch index where you want to store your data.

getType

@Stability(Experimental)
@NotNull
String getType()

(experimental) The type of document you are storing.

builder

@Stability(Experimental)
static OpenSearchActionProps.Builder builder()

Returns:

a OpenSearchActionProps.Builder of OpenSearchActionProps