Struct aws_sdk_iot::types::ThingIndexingConfiguration

#[non_exhaustive]
pub struct ThingIndexingConfiguration {
    pub thing_indexing_mode: ThingIndexingMode,
    pub thing_connectivity_indexing_mode: Option<ThingConnectivityIndexingMode>,
    pub device_defender_indexing_mode: Option<DeviceDefenderIndexingMode>,
    pub named_shadow_indexing_mode: Option<NamedShadowIndexingMode>,
    pub managed_fields: Option<Vec<Field>>,
    pub custom_fields: Option<Vec<Field>>,
    pub filter: Option<IndexingFilter>,
}

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

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

thing_indexing_mode: ThingIndexingMode

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.

thing_connectivity_indexing_mode: Option<ThingConnectivityIndexingMode>

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.

device_defender_indexing_mode: Option<DeviceDefenderIndexingMode>

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.

named_shadow_indexing_mode: Option<NamedShadowIndexingMode>

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.

managed_fields: Option<Vec<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.

You can't modify managed fields by updating fleet indexing configuration.

custom_fields: Option<Vec<Field>>

Contains custom field names and their data type.

filter: Option<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.

Implementations

impl ThingIndexingConfiguration

pub fn thing_indexing_mode(&self) -> &ThingIndexingMode

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.

pub fn thing_connectivity_indexing_mode( &self ) -> Option<&ThingConnectivityIndexingMode>

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.

pub fn device_defender_indexing_mode( &self ) -> Option<&DeviceDefenderIndexingMode>

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.

pub fn named_shadow_indexing_mode(&self) -> Option<&NamedShadowIndexingMode>

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.

pub fn managed_fields(&self) -> &[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.

You can't modify managed fields by updating fleet indexing configuration.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .managed_fields.is_none().

pub fn custom_fields(&self) -> &[Field]

Contains custom field names and their data type.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .custom_fields.is_none().

pub fn filter(&self) -> Option<&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.

impl ThingIndexingConfiguration

pub fn builder() -> ThingIndexingConfigurationBuilder

Creates a new builder-style object to manufacture ThingIndexingConfiguration.

Trait Implementations

impl Clone for ThingIndexingConfiguration

fn clone(&self) -> ThingIndexingConfiguration

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ThingIndexingConfiguration

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for ThingIndexingConfiguration

fn eq(&self, other: &ThingIndexingConfiguration) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for ThingIndexingConfiguration