Package software.amazon.awscdk.services.iot

Interface CfnTopicRule.OpenSearchActionProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnTopicRule.OpenSearchActionProperty.Jsii$Proxy

Enclosing class:

CfnTopicRule

@Stability(Stable)
public static interface CfnTopicRule.OpenSearchActionProperty
extends software.amazon.jsii.JsiiSerializable

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

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.iot.*;
 OpenSearchActionProperty openSearchActionProperty = OpenSearchActionProperty.builder()
         .endpoint("endpoint")
         .id("id")
         .index("index")
         .roleArn("roleArn")
         .type("type")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-opensearchaction.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnTopicRule.OpenSearchActionProperty.Builder	builder()
String	getEndpoint()	The endpoint of your OpenSearch domain.
String	getId()	The unique identifier for the document you are storing.
String	getIndex()	The OpenSearch index where you want to store your data.
String	getRoleArn()	The IAM role ARN that has access to OpenSearch.
String	getType()	The type of document you are storing.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getEndpoint

@Stability(Stable)
@NotNull
String getEndpoint()

The endpoint of your OpenSearch domain.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-opensearchaction.html#cfn-iot-topicrule-opensearchaction-endpoint

getId

@Stability(Stable)
@NotNull
String getId()

The unique identifier for the document you are storing.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-opensearchaction.html#cfn-iot-topicrule-opensearchaction-id

getIndex

@Stability(Stable)
@NotNull
String getIndex()

The OpenSearch index where you want to store your data.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-opensearchaction.html#cfn-iot-topicrule-opensearchaction-index

getRoleArn

@Stability(Stable)
@NotNull
String getRoleArn()

The IAM role ARN that has access to OpenSearch.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-opensearchaction.html#cfn-iot-topicrule-opensearchaction-rolearn

getType

@Stability(Stable)
@NotNull
String getType()

The type of document you are storing.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-opensearchaction.html#cfn-iot-topicrule-opensearchaction-type

builder

@Stability(Stable)
static CfnTopicRule.OpenSearchActionProperty.Builder builder()

Returns:

a CfnTopicRule.OpenSearchActionProperty.Builder of CfnTopicRule.OpenSearchActionProperty