Class: Aws::IoT::Types::ElasticsearchAction

Inherits:

Struct

• Object
• Struct
• Aws::IoT::Types::ElasticsearchAction

Includes:

Structure

Defined in:

lib/aws-sdk-iot/types.rb

Overview

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

<note markdown=“1”> 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].

</note>

[1]: docs.aws.amazon.com/iot/latest/apireference/API_OpenSearchAction.html

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #endpoint ⇒ String

  The endpoint of your OpenSearch domain.

• #id ⇒ String

  The unique identifier for the document you are storing.

• #index ⇒ String

  The index where you want to store your data.

• #role_arn ⇒ String

  The IAM role ARN that has access to OpenSearch.

• #type ⇒ String

  The type of document you are storing.

Instance Attribute Details

#endpoint ⇒ String

The endpoint of your OpenSearch domain.

Returns:

• (String)

# File 'lib/aws-sdk-iot/types.rb', line 7656

class ElasticsearchAction < Struct.new(
  :role_arn,
  :endpoint,
  :index,
  :type,
  :id)
  SENSITIVE = []
  include Aws::Structure
end

#id ⇒ String

The unique identifier for the document you are storing.

Returns:

• (String)

# File 'lib/aws-sdk-iot/types.rb', line 7656

class ElasticsearchAction < Struct.new(
  :role_arn,
  :endpoint,
  :index,
  :type,
  :id)
  SENSITIVE = []
  include Aws::Structure
end

#index ⇒ String

The index where you want to store your data.

Returns:

• (String)

# File 'lib/aws-sdk-iot/types.rb', line 7656

class ElasticsearchAction < Struct.new(
  :role_arn,
  :endpoint,
  :index,
  :type,
  :id)
  SENSITIVE = []
  include Aws::Structure
end

#role_arn ⇒ String

The IAM role ARN that has access to OpenSearch.

Returns:

• (String)

# File 'lib/aws-sdk-iot/types.rb', line 7656

class ElasticsearchAction < Struct.new(
  :role_arn,
  :endpoint,
  :index,
  :type,
  :id)
  SENSITIVE = []
  include Aws::Structure
end

#type ⇒ String

The type of document you are storing.

Returns:

• (String)

# File 'lib/aws-sdk-iot/types.rb', line 7656

class ElasticsearchAction < Struct.new(
  :role_arn,
  :endpoint,
  :index,
  :type,
  :id)
  SENSITIVE = []
  include Aws::Structure
end