Class: Aws::IoT::Types::ThingGroupIndexingConfiguration

Inherits:

Struct

• Object
• Struct
• Aws::IoT::Types::ThingGroupIndexingConfiguration

Includes:

Structure

Defined in:

lib/aws-sdk-iot/types.rb

Overview

Thing group indexing configuration.

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #custom_fields ⇒ Array<Types::Field>

  A list of thing group fields to index.

• #managed_fields ⇒ Array<Types::Field>

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

• #thing_group_indexing_mode ⇒ String

  Thing group indexing mode.

Instance Attribute Details

#custom_fields ⇒ Array<Types::Field>

A list of thing group fields to index. This list cannot contain any managed fields. Use the GetIndexingConfiguration API to get a list of managed fields.

Contains custom field names and their data type.

Returns:

• (Array<Types::Field>)

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

class ThingGroupIndexingConfiguration < Struct.new(
  :thing_group_indexing_mode,
  :managed_fields,
  :custom_fields)
  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 16168

class ThingGroupIndexingConfiguration < Struct.new(
  :thing_group_indexing_mode,
  :managed_fields,
  :custom_fields)
  SENSITIVE = []
  include Aws::Structure
end

#thing_group_indexing_mode ⇒ String

Thing group indexing mode.

Returns:

• (String)

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

class ThingGroupIndexingConfiguration < Struct.new(
  :thing_group_indexing_mode,
  :managed_fields,
  :custom_fields)
  SENSITIVE = []
  include Aws::Structure
end