aws-cdk-lib.aws_iot.CfnTopicRule.ElasticsearchActionProperty

interface ElasticsearchActionProperty

LanguageType name
.NETAmazon.CDK.AWS.IoT.CfnTopicRule.ElasticsearchActionProperty
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsiot#CfnTopicRule_ElasticsearchActionProperty
Javasoftware.amazon.awscdk.services.iot.CfnTopicRule.ElasticsearchActionProperty
Pythonaws_cdk.aws_iot.CfnTopicRule.ElasticsearchActionProperty
TypeScript aws-cdk-lib » aws_iot » CfnTopicRule » ElasticsearchActionProperty

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

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 .

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_iot as iot } from 'aws-cdk-lib';
const elasticsearchActionProperty: iot.CfnTopicRule.ElasticsearchActionProperty = {
  endpoint: 'endpoint',
  id: 'id',
  index: 'index',
  roleArn: 'roleArn',
  type: 'type',
};

Properties

NameTypeDescription
endpointstringThe endpoint of your OpenSearch domain.
idstringThe unique identifier for the document you are storing.
indexstringThe index where you want to store your data.
roleArnstringThe IAM role ARN that has access to OpenSearch.
typestringThe type of document you are storing.

endpoint

Type: string

The endpoint of your OpenSearch domain.


id

Type: string

The unique identifier for the document you are storing.


index

Type: string

The index where you want to store your data.


roleArn

Type: string

The IAM role ARN that has access to OpenSearch.


type

Type: string

The type of document you are storing.