Resource: awsIotIndexingConfiguration
Managing IoT Thing indexing.
Example Usage
/*Provider bindings are generated by running cdktf get.
See https://cdk.tf/provider-generation for more details.*/
import * as aws from "./.gen/providers/aws";
new aws.iotIndexingConfiguration.IotIndexingConfiguration(this, "example", {
thingIndexingConfiguration: {
customField: [
{
name: "shadow.desired.power",
type: "Boolean",
},
{
name: "attributes.version",
type: "Number",
},
{
name: "shadow.name.thing1shadow.desired.DefaultDesired",
type: "String",
},
{
name: "deviceDefender.securityProfile1.NUMBER_VALUE_BEHAVIOR.lastViolationValue.number",
type: "Number",
},
],
deviceDefenderIndexingMode: "VIOLATIONS",
namedShadowIndexingMode: "ON",
thingConnectivityIndexingMode: "STATUS",
thingIndexingMode: "REGISTRY_AND_SHADOW",
},
});
Argument Reference
thingGroupIndexingConfiguration
- (Optional) Thing group indexing configuration. See below.thingIndexingConfiguration
- (Optional) Thing indexing configuration. See below.
thingGroupIndexingConfiguration
The thingGroupIndexingConfiguration
configuration block supports the following:
customField
- (Optional) A list of thing group fields to index. This list cannot contain any managed fields. See below.managedField
- (Optional) Contains fields that are indexed and whose types are already known by the Fleet Indexing service. See below.thingGroupIndexingMode
- (Required) Thing group indexing mode. Valid values:off
,on
.
thingIndexingConfiguration
The thingIndexingConfiguration
configuration block supports the following:
customField
- (Optional) Contains custom field names and their data type. See below.deviceDefenderIndexingMode
- (Optional) Device Defender indexing mode. Valid values:violations
,off
. Default:off
.managedField
- (Optional) Contains fields that are indexed and whose types are already known by the Fleet Indexing service. See below.namedShadowIndexingMode
- (Optional) Named shadow indexing mode. Valid values:on
,off
. Default:off
.thingConnectivityIndexingMode
- (Optional) Thing connectivity indexing mode. Valid values:status
,off
. Default:off
.thingIndexingMode
- (Required) Thing indexing mode. Valid values:registry
,REGISTRY_AND_SHADOW
,off
.
field
The customField
and managedField
configuration blocks supports the following:
name
- (Optional) The name of the field.type
- (Optional) The data type of the field. Valid values:number
,string
,boolean
.
Attributes Reference
No additional attributes are exported.