Package software.amazon.awscdk.cfnpropertymixins.services.iot

Interface CfnTopicRulePropsMixin.OpenSearchActionProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnTopicRulePropsMixin.OpenSearchActionProperty.Jsii$Proxy

Enclosing class:

CfnTopicRulePropsMixin

@Stability(Stable)
public static interface CfnTopicRulePropsMixin.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.cfnpropertymixins.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	CfnTopicRulePropsMixin.OpenSearchActionProperty.Builder	A builder for CfnTopicRulePropsMixin.OpenSearchActionProperty
static final class	CfnTopicRulePropsMixin.OpenSearchActionProperty.Jsii$Proxy	An implementation for CfnTopicRulePropsMixin.OpenSearchActionProperty

Method Summary

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getEndpoint

@Stability(Stable)
@Nullable
default 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)
@Nullable
default 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)
@Nullable
default 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)
@Nullable
default 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)
@Nullable
default 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 CfnTopicRulePropsMixin.OpenSearchActionProperty.Builder builder()

Returns:

a CfnTopicRulePropsMixin.OpenSearchActionProperty.Builder of CfnTopicRulePropsMixin.OpenSearchActionProperty