Class: Aws::IoT::Types::ThingIndexingConfiguration

Inherits:

Struct

• Object
• Struct
• Aws::IoT::Types::ThingIndexingConfiguration

Includes:

Structure

Defined in:

lib/aws-sdk-iot/types.rb

Overview

Note:

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

{
  thing_indexing_mode: "OFF", # required, accepts OFF, REGISTRY, REGISTRY_AND_SHADOW
  thing_connectivity_indexing_mode: "OFF", # accepts OFF, STATUS
}

The thing indexing configuration. For more information, see [Managing Thing Indexing].

[1]: docs.aws.amazon.com/iot/latest/developerguide/managing-index.html

Instance Attribute Summary

• #thing_connectivity_indexing_mode ⇒ String

  Thing connectivity indexing mode.

• #thing_indexing_mode ⇒ String

  Thing indexing mode.

Instance Attribute Details

#thing_connectivity_indexing_mode ⇒ String

Thing connectivity indexing mode. Valid values are:

• STATUS – Your thing index will contain connectivity status. In order to enable thing connectivity indexing, thingIndexMode must not be set to OFF.

• OFF - Thing connectivity status indexing is disabled.

Returns:

• (String)

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

class ThingIndexingConfiguration < Struct.new(
  :thing_indexing_mode,
  :thing_connectivity_indexing_mode)
  include Aws::Structure
end

#thing_indexing_mode ⇒ String

Thing indexing mode. Valid values are:

• REGISTRY – Your thing index will contain only registry data.

• REGISTRY_AND_SHADOW - Your thing index will contain registry and shadow data.

• OFF - Thing indexing is disabled.

Returns:

• (String)

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

class ThingIndexingConfiguration < Struct.new(
  :thing_indexing_mode,
  :thing_connectivity_indexing_mode)
  include Aws::Structure
end