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

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 ThingIndexingConfiguration data as a hash:

{
  thing_indexing_mode: "OFF", # required, accepts OFF, REGISTRY, REGISTRY_AND_SHADOW
  thing_connectivity_indexing_mode: "OFF", # accepts OFF, STATUS
  device_defender_indexing_mode: "OFF", # accepts OFF, VIOLATIONS
  named_shadow_indexing_mode: "OFF", # accepts OFF, ON
  managed_fields: [
    {
      name: "FieldName",
      type: "Number", # accepts Number, String, Boolean
    },
  ],
  custom_fields: [
    {
      name: "FieldName",
      type: "Number", # accepts Number, String, Boolean
    },
  ],
  filter: {
    named_shadow_names: ["ShadowName"],
  },
}

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

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#custom_fieldsArray<Types::Field>

Contains custom field names and their data type.

Returns:



17894
17895
17896
17897
17898
17899
17900
17901
17902
17903
17904
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 17894

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_modeString

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.

Returns:

  • (String)


17894
17895
17896
17897
17898
17899
17900
17901
17902
17903
17904
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 17894

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

#filterTypes::IndexingFilter

Provides additional filters for specific data sources. Named shadow is the only data source that currently supports and requires a filter. To add named shadows to your fleet indexing configuration, set namedShadowIndexingMode to be ON and specify your shadow names in filter.



17894
17895
17896
17897
17898
17899
17900
17901
17902
17903
17904
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 17894

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_fieldsArray<Types::Field>

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

Returns:



17894
17895
17896
17897
17898
17899
17900
17901
17902
17903
17904
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 17894

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_modeString

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.

Returns:

  • (String)


17894
17895
17896
17897
17898
17899
17900
17901
17902
17903
17904
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 17894

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_modeString

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)


17894
17895
17896
17897
17898
17899
17900
17901
17902
17903
17904
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 17894

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_modeString

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)


17894
17895
17896
17897
17898
17899
17900
17901
17902
17903
17904
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 17894

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