AWS Classic

Pulumi Official
Package maintained by Pulumi
v5.10.0 published on Monday, Jul 11, 2022 by Pulumi

IndexingConfiguration

Managing IoT Thing indexing.

Example Usage

using Pulumi;
using Aws = Pulumi.Aws;

class MyStack : Stack
{
    public MyStack()
    {
        var example = new Aws.Iot.IndexingConfiguration("example", new Aws.Iot.IndexingConfigurationArgs
        {
            ThingIndexingConfiguration = new Aws.Iot.Inputs.IndexingConfigurationThingIndexingConfigurationArgs
            {
                CustomFields = 
                {
                    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",
                    },
                },
                DeviceDefenderIndexingMode = "VIOLATIONS",
                NamedShadowIndexingMode = "ON",
                ThingConnectivityIndexingMode = "STATUS",
                ThingIndexingMode = "REGISTRY_AND_SHADOW",
            },
        });
    }

}
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v5/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{
				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"),
					},
				},
				DeviceDefenderIndexingMode:    pulumi.String("VIOLATIONS"),
				NamedShadowIndexingMode:       pulumi.String("ON"),
				ThingConnectivityIndexingMode: pulumi.String("STATUS"),
				ThingIndexingMode:             pulumi.String("REGISTRY_AND_SHADOW"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
package generated_program;

import java.util.*;
import java.io.*;
import java.nio.*;
import com.pulumi.*;

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()
                .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())
                .deviceDefenderIndexingMode("VIOLATIONS")
                .namedShadowIndexingMode("ON")
                .thingConnectivityIndexingMode("STATUS")
                .thingIndexingMode("REGISTRY_AND_SHADOW")
                .build())
            .build());

    }
}
import pulumi
import pulumi_aws as aws

example = aws.iot.IndexingConfiguration("example", thing_indexing_configuration=aws.iot.IndexingConfigurationThingIndexingConfigurationArgs(
    custom_fields=[
        aws.iot.IndexingConfigurationThingIndexingConfigurationCustomFieldArgs(
            name="shadow.desired.power",
            type="Boolean",
        ),
        aws.iot.IndexingConfigurationThingIndexingConfigurationCustomFieldArgs(
            name="attributes.version",
            type="Number",
        ),
        aws.iot.IndexingConfigurationThingIndexingConfigurationCustomFieldArgs(
            name="shadow.name.thing1shadow.desired.DefaultDesired",
            type="String",
        ),
        aws.iot.IndexingConfigurationThingIndexingConfigurationCustomFieldArgs(
            name="deviceDefender.securityProfile1.NUMBER_VALUE_BEHAVIOR.lastViolationValue.number",
            type="Number",
        ),
    ],
    device_defender_indexing_mode="VIOLATIONS",
    named_shadow_indexing_mode="ON",
    thing_connectivity_indexing_mode="STATUS",
    thing_indexing_mode="REGISTRY_AND_SHADOW",
))
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.iot.IndexingConfiguration("example", {
    thingIndexingConfiguration: {
        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",
            },
        ],
        deviceDefenderIndexingMode: "VIOLATIONS",
        namedShadowIndexingMode: "ON",
        thingConnectivityIndexingMode: "STATUS",
        thingIndexingMode: "REGISTRY_AND_SHADOW",
    },
});
resources:
  example:
    type: aws:iot:IndexingConfiguration
    properties:
      thingIndexingConfiguration:
        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
        deviceDefenderIndexingMode: VIOLATIONS
        namedShadowIndexingMode: ON
        thingConnectivityIndexingMode: STATUS
        thingIndexingMode: REGISTRY_AND_SHADOW

Create a IndexingConfiguration Resource

new IndexingConfiguration(name: string, args?: IndexingConfigurationArgs, opts?: CustomResourceOptions);
@overload
def IndexingConfiguration(resource_name: str,
                          opts: Optional[ResourceOptions] = None,
                          thing_group_indexing_configuration: Optional[IndexingConfigurationThingGroupIndexingConfigurationArgs] = None,
                          thing_indexing_configuration: Optional[IndexingConfigurationThingIndexingConfigurationArgs] = None)
@overload
def IndexingConfiguration(resource_name: str,
                          args: Optional[IndexingConfigurationArgs] = None,
                          opts: Optional[ResourceOptions] = None)
func NewIndexingConfiguration(ctx *Context, name string, args *IndexingConfigurationArgs, opts ...ResourceOption) (*IndexingConfiguration, error)
public IndexingConfiguration(string name, IndexingConfigurationArgs? args = null, CustomResourceOptions? opts = null)
public IndexingConfiguration(String name, IndexingConfigurationArgs args)
public IndexingConfiguration(String name, IndexingConfigurationArgs args, CustomResourceOptions options)
type: aws:iot:IndexingConfiguration
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string
The unique name of the resource.
args IndexingConfigurationArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name str
The unique name of the resource.
args IndexingConfigurationArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name string
The unique name of the resource.
args IndexingConfigurationArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args IndexingConfigurationArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args IndexingConfigurationArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

IndexingConfiguration Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The IndexingConfiguration resource accepts the following input properties:

thingGroupIndexingConfiguration Property Map

Thing group indexing configuration. See below.

thingIndexingConfiguration Property Map

Thing indexing configuration. See below.

Outputs

All input properties are implicitly available as output properties. Additionally, the IndexingConfiguration resource produces the following output properties:

Id string

The provider-assigned unique ID for this managed resource.

Id string

The provider-assigned unique ID for this managed resource.

id String

The provider-assigned unique ID for this managed resource.

id string

The provider-assigned unique ID for this managed resource.

id str

The provider-assigned unique ID for this managed resource.

id String

The provider-assigned unique ID for this managed resource.

Look up an Existing IndexingConfiguration Resource

Get an existing IndexingConfiguration resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: IndexingConfigurationState, opts?: CustomResourceOptions): IndexingConfiguration
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        thing_group_indexing_configuration: Optional[IndexingConfigurationThingGroupIndexingConfigurationArgs] = None,
        thing_indexing_configuration: Optional[IndexingConfigurationThingIndexingConfigurationArgs] = None) -> IndexingConfiguration
func GetIndexingConfiguration(ctx *Context, name string, id IDInput, state *IndexingConfigurationState, opts ...ResourceOption) (*IndexingConfiguration, error)
public static IndexingConfiguration Get(string name, Input<string> id, IndexingConfigurationState? state, CustomResourceOptions? opts = null)
public static IndexingConfiguration get(String name, Output<String> id, IndexingConfigurationState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
thingGroupIndexingConfiguration Property Map

Thing group indexing configuration. See below.

thingIndexingConfiguration Property Map

Thing indexing configuration. See below.

Supporting Types

IndexingConfigurationThingGroupIndexingConfiguration

ThingGroupIndexingMode string

Thing group indexing mode. Valid values: OFF, ON.

CustomFields List<IndexingConfigurationThingGroupIndexingConfigurationCustomField>

A list of thing group fields to index. This list cannot contain any managed fields. See below.

ManagedFields List<IndexingConfigurationThingGroupIndexingConfigurationManagedField>

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

ThingGroupIndexingMode string

Thing group indexing mode. Valid values: OFF, ON.

CustomFields []IndexingConfigurationThingGroupIndexingConfigurationCustomField

A list of thing group fields to index. This list cannot contain any managed fields. See below.

ManagedFields []IndexingConfigurationThingGroupIndexingConfigurationManagedField

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

thingGroupIndexingMode String

Thing group indexing mode. Valid values: OFF, ON.

customFields List<IndexingConfigurationThingGroupIndexingConfigurationCustomField>

A list of thing group fields to index. This list cannot contain any managed fields. See below.

managedFields List<IndexingConfigurationThingGroupIndexingConfigurationManagedField>

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

thingGroupIndexingMode string

Thing group indexing mode. Valid values: OFF, ON.

customFields IndexingConfigurationThingGroupIndexingConfigurationCustomField[]

A list of thing group fields to index. This list cannot contain any managed fields. See below.

managedFields IndexingConfigurationThingGroupIndexingConfigurationManagedField[]

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

thing_group_indexing_mode str

Thing group indexing mode. Valid values: OFF, ON.

custom_fields Sequence[IndexingConfigurationThingGroupIndexingConfigurationCustomField]

A list of thing group fields to index. This list cannot contain any managed fields. See below.

managed_fields Sequence[IndexingConfigurationThingGroupIndexingConfigurationManagedField]

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

thingGroupIndexingMode String

Thing group indexing mode. Valid values: OFF, ON.

customFields List<Property Map>

A list of thing group fields to index. This list cannot contain any managed fields. See below.

managedFields List<Property Map>

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

IndexingConfigurationThingGroupIndexingConfigurationCustomField

Name string

The name of the field.

Type string

The data type of the field. Valid values: Number, String, Boolean.

Name string

The name of the field.

Type string

The data type of the field. Valid values: Number, String, Boolean.

name String

The name of the field.

type String

The data type of the field. Valid values: Number, String, Boolean.

name string

The name of the field.

type string

The data type of the field. Valid values: Number, String, Boolean.

name str

The name of the field.

type str

The data type of the field. Valid values: Number, String, Boolean.

name String

The name of the field.

type String

The data type of the field. Valid values: Number, String, Boolean.

IndexingConfigurationThingGroupIndexingConfigurationManagedField

Name string

The name of the field.

Type string

The data type of the field. Valid values: Number, String, Boolean.

Name string

The name of the field.

Type string

The data type of the field. Valid values: Number, String, Boolean.

name String

The name of the field.

type String

The data type of the field. Valid values: Number, String, Boolean.

name string

The name of the field.

type string

The data type of the field. Valid values: Number, String, Boolean.

name str

The name of the field.

type str

The data type of the field. Valid values: Number, String, Boolean.

name String

The name of the field.

type String

The data type of the field. Valid values: Number, String, Boolean.

IndexingConfigurationThingIndexingConfiguration

ThingIndexingMode string

Thing indexing mode. Valid values: REGISTRY, REGISTRY_AND_SHADOW, OFF.

CustomFields List<IndexingConfigurationThingIndexingConfigurationCustomField>

Contains custom field names and their data type. See below.

DeviceDefenderIndexingMode string

Device Defender indexing mode. Valid values: VIOLATIONS, OFF. Default: OFF.

ManagedFields List<IndexingConfigurationThingIndexingConfigurationManagedField>

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

NamedShadowIndexingMode string

Named shadow indexing mode. Valid values: ON, OFF. Default: OFF.

ThingConnectivityIndexingMode string

Thing connectivity indexing mode. Valid values: STATUS, OFF. Default: OFF.

ThingIndexingMode string

Thing indexing mode. Valid values: REGISTRY, REGISTRY_AND_SHADOW, OFF.

CustomFields []IndexingConfigurationThingIndexingConfigurationCustomField

Contains custom field names and their data type. See below.

DeviceDefenderIndexingMode string

Device Defender indexing mode. Valid values: VIOLATIONS, OFF. Default: OFF.

ManagedFields []IndexingConfigurationThingIndexingConfigurationManagedField

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

NamedShadowIndexingMode string

Named shadow indexing mode. Valid values: ON, OFF. Default: OFF.

ThingConnectivityIndexingMode string

Thing connectivity indexing mode. Valid values: STATUS, OFF. Default: OFF.

thingIndexingMode String

Thing indexing mode. Valid values: REGISTRY, REGISTRY_AND_SHADOW, OFF.

customFields List<IndexingConfigurationThingIndexingConfigurationCustomField>

Contains custom field names and their data type. See below.

deviceDefenderIndexingMode String

Device Defender indexing mode. Valid values: VIOLATIONS, OFF. Default: OFF.

managedFields List<IndexingConfigurationThingIndexingConfigurationManagedField>

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

namedShadowIndexingMode String

Named shadow indexing mode. Valid values: ON, OFF. Default: OFF.

thingConnectivityIndexingMode String

Thing connectivity indexing mode. Valid values: STATUS, OFF. Default: OFF.

thingIndexingMode string

Thing indexing mode. Valid values: REGISTRY, REGISTRY_AND_SHADOW, OFF.

customFields IndexingConfigurationThingIndexingConfigurationCustomField[]

Contains custom field names and their data type. See below.

deviceDefenderIndexingMode string

Device Defender indexing mode. Valid values: VIOLATIONS, OFF. Default: OFF.

managedFields IndexingConfigurationThingIndexingConfigurationManagedField[]

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

namedShadowIndexingMode string

Named shadow indexing mode. Valid values: ON, OFF. Default: OFF.

thingConnectivityIndexingMode string

Thing connectivity indexing mode. Valid values: STATUS, OFF. Default: OFF.

thing_indexing_mode str

Thing indexing mode. Valid values: REGISTRY, REGISTRY_AND_SHADOW, OFF.

custom_fields Sequence[IndexingConfigurationThingIndexingConfigurationCustomField]

Contains custom field names and their data type. See below.

device_defender_indexing_mode str

Device Defender indexing mode. Valid values: VIOLATIONS, OFF. Default: OFF.

managed_fields Sequence[IndexingConfigurationThingIndexingConfigurationManagedField]

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

named_shadow_indexing_mode str

Named shadow indexing mode. Valid values: ON, OFF. Default: OFF.

thing_connectivity_indexing_mode str

Thing connectivity indexing mode. Valid values: STATUS, OFF. Default: OFF.

thingIndexingMode String

Thing indexing mode. Valid values: REGISTRY, REGISTRY_AND_SHADOW, OFF.

customFields List<Property Map>

Contains custom field names and their data type. See below.

deviceDefenderIndexingMode String

Device Defender indexing mode. Valid values: VIOLATIONS, OFF. Default: OFF.

managedFields List<Property Map>

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

namedShadowIndexingMode String

Named shadow indexing mode. Valid values: ON, OFF. Default: OFF.

thingConnectivityIndexingMode String

Thing connectivity indexing mode. Valid values: STATUS, OFF. Default: OFF.

IndexingConfigurationThingIndexingConfigurationCustomField

Name string

The name of the field.

Type string

The data type of the field. Valid values: Number, String, Boolean.

Name string

The name of the field.

Type string

The data type of the field. Valid values: Number, String, Boolean.

name String

The name of the field.

type String

The data type of the field. Valid values: Number, String, Boolean.

name string

The name of the field.

type string

The data type of the field. Valid values: Number, String, Boolean.

name str

The name of the field.

type str

The data type of the field. Valid values: Number, String, Boolean.

name String

The name of the field.

type String

The data type of the field. Valid values: Number, String, Boolean.

IndexingConfigurationThingIndexingConfigurationManagedField

Name string

The name of the field.

Type string

The data type of the field. Valid values: Number, String, Boolean.

Name string

The name of the field.

Type string

The data type of the field. Valid values: Number, String, Boolean.

name String

The name of the field.

type String

The data type of the field. Valid values: Number, String, Boolean.

name string

The name of the field.

type string

The data type of the field. Valid values: Number, String, Boolean.

name str

The name of the field.

type str

The data type of the field. Valid values: Number, String, Boolean.

name String

The name of the field.

type String

The data type of the field. Valid values: Number, String, Boolean.

Package Details

Repository
https://github.com/pulumi/pulumi-aws
License
Apache-2.0
Notes

This Pulumi package is based on the aws Terraform Provider.