IndexingConfiguration class
Managing IoT Thing indexing.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.iot.IndexingConfiguration("example", {thingIndexingConfiguration: {
filter: {
namedShadowNames: ["thing1shadow"],
},
customFields: [
{
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",
},
],
thingIndexingMode: "REGISTRY_AND_SHADOW",
thingConnectivityIndexingMode: "STATUS",
deviceDefenderIndexingMode: "VIOLATIONS",
namedShadowIndexingMode: "ON",
}});
import pulumi
import pulumi_aws as aws
example = aws.iot.IndexingConfiguration("example", thing_indexing_configuration={
"filter": {
"named_shadow_names": ["thing1shadow"],
},
"custom_fields": [
{
"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",
},
],
"thing_indexing_mode": "REGISTRY_AND_SHADOW",
"thing_connectivity_indexing_mode": "STATUS",
"device_defender_indexing_mode": "VIOLATIONS",
"named_shadow_indexing_mode": "ON",
})
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var example = new Aws.Iot.IndexingConfiguration("example", new()
{
ThingIndexingConfiguration = new Aws.Iot.Inputs.IndexingConfigurationThingIndexingConfigurationArgs
{
Filter = new Aws.Iot.Inputs.IndexingConfigurationThingIndexingConfigurationFilterArgs
{
NamedShadowNames = new[]
{
"thing1shadow",
},
},
CustomFields = new[]
{
new Aws.Iot.Inputs.IndexingConfigurationThingIndexingConfigurationCustomFieldArgs
{
Name = "shadow.desired.power",
Type = "Boolean",
},
new Aws.Iot.Inputs.IndexingConfigurationThingIndexingConfigurationCustomFieldArgs
{
Name = "attributes.version",
Type = "Number",
},
new Aws.Iot.Inputs.IndexingConfigurationThingIndexingConfigurationCustomFieldArgs
{
Name = "shadow.name.thing1shadow.desired.DefaultDesired",
Type = "String",
},
new Aws.Iot.Inputs.IndexingConfigurationThingIndexingConfigurationCustomFieldArgs
{
Name = "deviceDefender.securityProfile1.NUMBER_VALUE_BEHAVIOR.lastViolationValue.number",
Type = "Number",
},
},
ThingIndexingMode = "REGISTRY_AND_SHADOW",
ThingConnectivityIndexingMode = "STATUS",
DeviceDefenderIndexingMode = "VIOLATIONS",
NamedShadowIndexingMode = "ON",
},
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/iot"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := iot.NewIndexingConfiguration(ctx, "example", &iot.IndexingConfigurationArgs{
ThingIndexingConfiguration: &iot.IndexingConfigurationThingIndexingConfigurationArgs{
Filter: &iot.IndexingConfigurationThingIndexingConfigurationFilterArgs{
NamedShadowNames: pulumi.StringArray{
pulumi.String("thing1shadow"),
},
},
CustomFields: iot.IndexingConfigurationThingIndexingConfigurationCustomFieldArray{
&iot.IndexingConfigurationThingIndexingConfigurationCustomFieldArgs{
Name: pulumi.String("shadow.desired.power"),
Type: pulumi.String("Boolean"),
},
&iot.IndexingConfigurationThingIndexingConfigurationCustomFieldArgs{
Name: pulumi.String("attributes.version"),
Type: pulumi.String("Number"),
},
&iot.IndexingConfigurationThingIndexingConfigurationCustomFieldArgs{
Name: pulumi.String("shadow.name.thing1shadow.desired.DefaultDesired"),
Type: pulumi.String("String"),
},
&iot.IndexingConfigurationThingIndexingConfigurationCustomFieldArgs{
Name: pulumi.String("deviceDefender.securityProfile1.NUMBER_VALUE_BEHAVIOR.lastViolationValue.number"),
Type: pulumi.String("Number"),
},
},
ThingIndexingMode: pulumi.String("REGISTRY_AND_SHADOW"),
ThingConnectivityIndexingMode: pulumi.String("STATUS"),
DeviceDefenderIndexingMode: pulumi.String("VIOLATIONS"),
NamedShadowIndexingMode: pulumi.String("ON"),
},
})
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "aws_iot_indexingconfiguration" "example" {
thing_indexing_configuration = {
filter = {
named_shadow_names = ["thing1shadow"]
}
custom_fields = [{
"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"
}]
thing_indexing_mode = "REGISTRY_AND_SHADOW"
thing_connectivity_indexing_mode = "STATUS"
device_defender_indexing_mode = "VIOLATIONS"
named_shadow_indexing_mode = "ON"
}
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.iot.IndexingConfiguration;
import com.pulumi.aws.iot.IndexingConfigurationArgs;
import com.pulumi.aws.iot.inputs.IndexingConfigurationThingIndexingConfigurationArgs;
import com.pulumi.aws.iot.inputs.IndexingConfigurationThingIndexingConfigurationFilterArgs;
import com.pulumi.aws.iot.inputs.IndexingConfigurationThingIndexingConfigurationCustomFieldArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var example = new IndexingConfiguration("example", IndexingConfigurationArgs.builder()
.thingIndexingConfiguration(IndexingConfigurationThingIndexingConfigurationArgs.builder()
.filter(IndexingConfigurationThingIndexingConfigurationFilterArgs.builder()
.namedShadowNames("thing1shadow")
.build())
.customFields(
IndexingConfigurationThingIndexingConfigurationCustomFieldArgs.builder()
.name("shadow.desired.power")
.type("Boolean")
.build(),
IndexingConfigurationThingIndexingConfigurationCustomFieldArgs.builder()
.name("attributes.version")
.type("Number")
.build(),
IndexingConfigurationThingIndexingConfigurationCustomFieldArgs.builder()
.name("shadow.name.thing1shadow.desired.DefaultDesired")
.type("String")
.build(),
IndexingConfigurationThingIndexingConfigurationCustomFieldArgs.builder()
.name("deviceDefender.securityProfile1.NUMBER_VALUE_BEHAVIOR.lastViolationValue.number")
.type("Number")
.build())
.thingIndexingMode("REGISTRY_AND_SHADOW")
.thingConnectivityIndexingMode("STATUS")
.deviceDefenderIndexingMode("VIOLATIONS")
.namedShadowIndexingMode("ON")
.build())
.build());
}
}
resources:
example:
type: aws:iot:IndexingConfiguration
properties:
thingIndexingConfiguration:
filter:
namedShadowNames:
- thing1shadow
customFields:
- 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
thingIndexingMode: REGISTRY_AND_SHADOW
thingConnectivityIndexingMode: STATUS
deviceDefenderIndexingMode: VIOLATIONS
namedShadowIndexingMode: ON
Constructors
- IndexingConfiguration(String name, {IndexingConfigurationArgs? args, CustomResourceOptions? options})
-
Creates a new IndexingConfiguration.
nameThe Pulumi resource name.argsArguments used to configure this IndexingConfiguration. The set of arguments for IndexingConfiguration.optionsResource options controlling this resource's behavior. - IndexingConfiguration.reference(String urn)
- Creates a typed reference to an existing IndexingConfiguration resource.
Properties
-
childResources
→ Set<
Resource> -
finalinherited
-
completionSources
↔ Map<
String, IOutputCompletionSource> -
latefinalinherited
- hashCode → int
-
The hash code for this object.
no setterinherited
-
id
↔ Output<
String> -
getter/setter pairinherited
- isCustom → bool
-
Returns whether this resource is provider-managed.
no setterinherited
- isProtected → bool
-
Returns whether this resource is protected from deletion.
no setterinherited
- isRemote → bool
-
Whether this resource is registered as remote.
no setterinherited
- isResourceReference → bool
-
Whether this instance represents a resource value returned over RPC.
finalinherited
-
region
↔ Output<
String> -
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
-
resourceTransforms
→ List<
ResourceTransform> -
Inherited/explicit async transforms.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
thingGroupIndexingConfiguration
↔ Output<
IndexingConfigurationThingGroupIndexingConfiguration> -
Thing group indexing configuration. See below.
latefinal
-
thingIndexingConfiguration
↔ Output<
IndexingConfigurationThingIndexingConfiguration> -
Thing indexing configuration. See below.
latefinal
-
transformations
→ List<
ResourceTransformation> -
Inherited/explicit legacy transformations.
no setterinherited
-
urn
↔ Output<
String> -
latefinalinherited
Methods
-
failId(
Object error) → void -
Completes this resource ID with an error when registration fails.
inherited
-
failOutputs(
Object error) → void -
Completes all output properties with
error.inherited -
failUrn(
Object error) → void -
Completes this resource URN with an error when registration fails.
inherited
-
getProvider(
String moduleMember) → ProviderResource? -
Returns provider for
moduleMember's package, if configured.inherited -
getResourceName(
) → String -
Returns this resource's logical name.
inherited
-
getResourceType(
) → String -
Returns this resource's Pulumi type token.
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
registerOutput<
T> (String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output< T> -
Registers a dynamic output property for this resource.
inherited
-
resolveId(
String? value, {required bool isKnown}) → void -
Resolves the provider-assigned ID for this resource.
inherited
-
resolveOutputs(
Struct outputs) → void -
Resolves all output properties from a monitor response payload.
inherited
-
resolveUrn(
String value) → void -
Resolves this resource's URN once assigned by the engine.
inherited
-
serializeProperties(
Map< String, dynamic> properties) → Future<Struct> -
Serializes resource properties for RPC transmission.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited
Static Methods
-
get(
String name, Input< String> id, {IndexingConfigurationState? state, CustomResourceOptions? options}) → IndexingConfiguration -
Gets an existing IndexingConfiguration resource's state with the given
nameandid.