You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::IoT::Types::ThingIndexingConfiguration
- Inherits:
-
Struct
- Object
- Struct
- Aws::IoT::Types::ThingIndexingConfiguration
- Defined in:
- (unknown)
Overview
When passing ThingIndexingConfiguration as input to an Aws::Client method, you can use a vanilla Hash:
{
thing_indexing_mode: "OFF", # required, accepts OFF, REGISTRY, REGISTRY_AND_SHADOW
thing_connectivity_indexing_mode: "OFF", # accepts OFF, STATUS
managed_fields: [
{
name: "FieldName",
type: "Number", # accepts Number, String, Boolean
},
],
custom_fields: [
{
name: "FieldName",
type: "Number", # accepts Number, String, Boolean
},
],
}
The thing indexing configuration. For more information, see Managing Thing Indexing.
Returned by:
Instance Attribute Summary collapse
-
#custom_fields ⇒ Array<Types::Field>
Contains custom field names and their data type.
-
#managed_fields ⇒ Array<Types::Field>
Contains fields that are indexed and whose types are already known by the Fleet Indexing service.
-
#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.
#managed_fields ⇒ Array<Types::Field>
Contains fields that are indexed and whose types are already known by the Fleet Indexing service.
#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.
Possible values:
- OFF
- STATUS
#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.
Possible values:
- OFF
- REGISTRY
- REGISTRY_AND_SHADOW