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

Inherits:

Struct

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

Includes:

Structure

Defined in:

lib/aws-sdk-iot/types.rb

Overview

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

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

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #custom_fields ⇒ Array<Types::Field>

  Contains custom field names and their data type.

• #device_defender_indexing_mode ⇒ String

  Device Defender indexing mode.

• #filter ⇒ Types::IndexingFilter

  Provides additional selections for named shadows and geolocation data.

• #managed_fields ⇒ Array<Types::Field>

  Contains fields that are indexed and whose types are already known by the Fleet Indexing service.

• #named_shadow_indexing_mode ⇒ String

  Named shadow indexing mode.

• #thing_connectivity_indexing_mode ⇒ String

  Thing connectivity indexing mode.

• #thing_indexing_mode ⇒ String

  Thing indexing mode.

Instance Attribute Details

#custom_fields ⇒ Array<Types::Field>

Contains custom field names and their data type.

Returns:

• (Array<Types::Field>)

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

class ThingIndexingConfiguration < Struct.new(
  :thing_indexing_mode,
  :thing_connectivity_indexing_mode,
  :device_defender_indexing_mode,
  :named_shadow_indexing_mode,
  :managed_fields,
  :custom_fields,
  :filter)
  SENSITIVE = []
  include Aws::Structure
end

#device_defender_indexing_mode ⇒ String

Device Defender indexing mode. Valid values are:

• VIOLATIONS – Your thing index contains Device Defender violations. To enable Device Defender indexing, deviceDefenderIndexingMode must not be set to OFF.

• OFF - Device Defender indexing is disabled.

For more information about Device Defender violations, see [Device Defender Detect.]

[1]: docs.aws.amazon.com/iot/latest/developerguide/device-defender-detect.html

Returns:

• (String)

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

class ThingIndexingConfiguration < Struct.new(
  :thing_indexing_mode,
  :thing_connectivity_indexing_mode,
  :device_defender_indexing_mode,
  :named_shadow_indexing_mode,
  :managed_fields,
  :custom_fields,
  :filter)
  SENSITIVE = []
  include Aws::Structure
end

#filter ⇒ Types::IndexingFilter

Provides additional selections for named shadows and geolocation data.

To add named shadows to your fleet indexing configuration, set ‘namedShadowIndexingMode` to be ON and specify your shadow names in `namedShadowNames` filter.

To add geolocation data to your fleet indexing configuration:

• If you store geolocation data in a class/unnamed shadow, set ‘thingIndexingMode` to be `REGISTRY_AND_SHADOW` and specify your geolocation data in `geoLocations` filter.

• If you store geolocation data in a named shadow, set ‘namedShadowIndexingMode` to be `ON`, add the shadow name in `namedShadowNames` filter, and specify your geolocation data in `geoLocations` filter. For more information, see [Managing fleet indexing].

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

Returns:

• (Types::IndexingFilter)

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

class ThingIndexingConfiguration < Struct.new(
  :thing_indexing_mode,
  :thing_connectivity_indexing_mode,
  :device_defender_indexing_mode,
  :named_shadow_indexing_mode,
  :managed_fields,
  :custom_fields,
  :filter)
  SENSITIVE = []
  include Aws::Structure
end

#managed_fields ⇒ Array<Types::Field>

Contains fields that are indexed and whose types are already known by the Fleet Indexing service. This is an optional field. For more information, see [Managed fields] in the *Amazon Web Services IoT Core Developer Guide*.

<note markdown=“1”> You can’t modify managed fields by updating fleet indexing configuration.

</note>

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

Returns:

• (Array<Types::Field>)

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

class ThingIndexingConfiguration < Struct.new(
  :thing_indexing_mode,
  :thing_connectivity_indexing_mode,
  :device_defender_indexing_mode,
  :named_shadow_indexing_mode,
  :managed_fields,
  :custom_fields,
  :filter)
  SENSITIVE = []
  include Aws::Structure
end

#named_shadow_indexing_mode ⇒ String

Named shadow indexing mode. Valid values are:

• ON – Your thing index contains named shadow. To enable thing named shadow indexing, namedShadowIndexingMode must not be set to OFF.

• OFF - Named shadow indexing is disabled.

For more information about Shadows, see [IoT Device Shadow service.]

[1]: docs.aws.amazon.com/iot/latest/developerguide/iot-device-shadows.html

Returns:

• (String)

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

class ThingIndexingConfiguration < Struct.new(
  :thing_indexing_mode,
  :thing_connectivity_indexing_mode,
  :device_defender_indexing_mode,
  :named_shadow_indexing_mode,
  :managed_fields,
  :custom_fields,
  :filter)
  SENSITIVE = []
  include Aws::Structure
end

#thing_connectivity_indexing_mode ⇒ String

Thing connectivity indexing mode. Valid values are:

• STATUS – Your thing index contains connectivity status. 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 16362

class ThingIndexingConfiguration < Struct.new(
  :thing_indexing_mode,
  :thing_connectivity_indexing_mode,
  :device_defender_indexing_mode,
  :named_shadow_indexing_mode,
  :managed_fields,
  :custom_fields,
  :filter)
  SENSITIVE = []
  include Aws::Structure
end

#thing_indexing_mode ⇒ String

Thing indexing mode. Valid values are:

• REGISTRY – Your thing index contains registry data only.

• REGISTRY_AND_SHADOW - Your thing index contains registry and shadow data.

• OFF - Thing indexing is disabled.

Returns:

• (String)

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

class ThingIndexingConfiguration < Struct.new(
  :thing_indexing_mode,
  :thing_connectivity_indexing_mode,
  :device_defender_indexing_mode,
  :named_shadow_indexing_mode,
  :managed_fields,
  :custom_fields,
  :filter)
  SENSITIVE = []
  include Aws::Structure
end