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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb

Overview

Note:

When making an API call, you may pass ElasticsearchAction data as a hash:

{
  role_arn: "AwsArn", # required
  endpoint: "ElasticsearchEndpoint", # required
  index: "ElasticsearchIndex", # required
  type: "ElasticsearchType", # required
  id: "ElasticsearchId", # required
}

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.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#endpointString

The endpoint of your OpenSearch domain.

Returns:

  • (String)


8526
8527
8528
8529
8530
8531
8532
8533
8534
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 8526

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

#idString

The unique identifier for the document you are storing.

Returns:

  • (String)


8526
8527
8528
8529
8530
8531
8532
8533
8534
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 8526

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

#indexString

The index where you want to store your data.

Returns:

  • (String)


8526
8527
8528
8529
8530
8531
8532
8533
8534
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 8526

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

#role_arnString

The IAM role ARN that has access to OpenSearch.

Returns:

  • (String)


8526
8527
8528
8529
8530
8531
8532
8533
8534
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 8526

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

#typeString

The type of document you are storing.

Returns:

  • (String)


8526
8527
8528
8529
8530
8531
8532
8533
8534
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 8526

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