ThingGroup class

Manages an AWS IoT Thing Group.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const parent = new aws.iot.ThingGroup("parent", {name: "parent"});
const example = new aws.iot.ThingGroup("example", {
    properties: {
        attributePayload: {
            attributes: {
                One: "11111",
                Two: "TwoTwo",
            },
        },
        description: "This is my thing group",
    },
    name: "example",
    parentGroupName: parent.name,
    tags: {
        managed: "true",
    },
});
import pulumi
import pulumi_aws as aws

parent = aws.iot.ThingGroup("parent", name="parent")
example = aws.iot.ThingGroup("example",
    properties={
        "attribute_payload": {
            "attributes": {
                "One": "11111",
                "Two": "TwoTwo",
            },
        },
        "description": "This is my thing group",
    },
    name="example",
    parent_group_name=parent.name,
    tags={
        "managed": "true",
    })
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() =>
{
    var parent = new Aws.Iot.ThingGroup("parent", new()
    {
        Name = "parent",
    });

    var example = new Aws.Iot.ThingGroup("example", new()
    {
        Properties = new Aws.Iot.Inputs.ThingGroupPropertiesArgs
        {
            AttributePayload = new Aws.Iot.Inputs.ThingGroupPropertiesAttributePayloadArgs
            {
                Attributes =
                {
                    { "One", "11111" },
                    { "Two", "TwoTwo" },
                },
            },
            Description = "This is my thing group",
        },
        Name = "example",
        ParentGroupName = parent.Name,
        Tags =
        {
            { "managed", "true" },
        },
    });

});
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 {
		parent, err := iot.NewThingGroup(ctx, "parent", &iot.ThingGroupArgs{
			Name: pulumi.String("parent"),
		})
		if err != nil {
			return err
		}
		_, err = iot.NewThingGroup(ctx, "example", &iot.ThingGroupArgs{
			Properties: &iot.ThingGroupPropertiesArgs{
				AttributePayload: &iot.ThingGroupPropertiesAttributePayloadArgs{
					Attributes: pulumi.StringMap{
						"One": pulumi.String("11111"),
						"Two": pulumi.String("TwoTwo"),
					},
				},
				Description: pulumi.String("This is my thing group"),
			},
			Name:            pulumi.String("example"),
			ParentGroupName: parent.Name,
			Tags: pulumi.StringMap{
				"managed": pulumi.String("true"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_iot_thinggroup" "parent" {
  name = "parent"
}
resource "aws_iot_thinggroup" "example" {
  properties = {
    attribute_payload = {
      attributes = {
        "One" = "11111"
        "Two" = "TwoTwo"
      }
    }
    description = "This is my thing group"
  }
  name              = "example"
  parent_group_name = aws_iot_thinggroup.parent.name
  tags = {
    "managed" = "true"
  }
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.iot.ThingGroup;
import com.pulumi.aws.iot.ThingGroupArgs;
import com.pulumi.aws.iot.inputs.ThingGroupPropertiesArgs;
import com.pulumi.aws.iot.inputs.ThingGroupPropertiesAttributePayloadArgs;
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 parent = new ThingGroup("parent", ThingGroupArgs.builder()
            .name("parent")
            .build());

        var example = new ThingGroup("example", ThingGroupArgs.builder()
            .properties(ThingGroupPropertiesArgs.builder()
                .attributePayload(ThingGroupPropertiesAttributePayloadArgs.builder()
                    .attributes(Map.ofEntries(
                        Map.entry("One", "11111"),
                        Map.entry("Two", "TwoTwo")
                    ))
                    .build())
                .description("This is my thing group")
                .build())
            .name("example")
            .parentGroupName(parent.name())
            .tags(Map.of("managed", "true"))
            .build());

    }
}
resources:
  parent:
    type: aws:iot:ThingGroup
    properties:
      name: parent
  example:
    type: aws:iot:ThingGroup
    properties:
      properties:
        attributePayload:
          attributes:
            One: '11111'
            Two: TwoTwo
        description: This is my thing group
      name: example
      parentGroupName: ${parent.name}
      tags:
        managed: 'true'

Import

Using pulumi import, import IoT Things Groups using the name. For example:

$ pulumi import aws:iot/thingGroup:ThingGroup example example

Constructors

ThingGroup(String name, {ThingGroupArgs? args, CustomResourceOptions? options})
Creates a new ThingGroup. name The Pulumi resource name. args Arguments used to configure this ThingGroup. The set of arguments for ThingGroup. options Resource options controlling this resource's behavior.
ThingGroup.reference(String urn)
Creates a typed reference to an existing ThingGroup resource.

Properties

arn ↔ Output<String>
The ARN of the Thing Group.
latefinal
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
metadatas ↔ Output<List<ThingGroupMetadata>>
latefinal
name ↔ Output<String>
The name of the Thing Group.
latefinal
parentGroupName ↔ Output<String?>
The name of the parent Thing Group.
latefinal
properties ↔ Output<ThingGroupProperties?>
The Thing Group properties. Defined below.
latefinal
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
tags ↔ Output<Map<String, String>?>
Key-value mapping of resource tags
latefinal
tagsAll ↔ Output<Map<String, String>>
latefinal
transformations → List<ResourceTransformation>
Inherited/explicit legacy transformations.
no setterinherited
urn ↔ Output<String>
latefinalinherited
version ↔ Output<int>
The current version of the Thing Group record in the registry.
latefinal

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, {ThingGroupState? state, CustomResourceOptions? options}) → ThingGroup
Gets an existing ThingGroup resource's state with the given name and id.