ThingGroupMembership class
Adds an IoT Thing to an IoT Thing Group.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.iot.ThingGroupMembership("example", {
thingName: "example-thing",
thingGroupName: "example-group",
overrideDynamicGroup: true,
});
import pulumi
import pulumi_aws as aws
example = aws.iot.ThingGroupMembership("example",
thing_name="example-thing",
thing_group_name="example-group",
override_dynamic_group=True)
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var example = new Aws.Iot.ThingGroupMembership("example", new()
{
ThingName = "example-thing",
ThingGroupName = "example-group",
OverrideDynamicGroup = 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 {
_, err := iot.NewThingGroupMembership(ctx, "example", &iot.ThingGroupMembershipArgs{
ThingName: pulumi.String("example-thing"),
ThingGroupName: pulumi.String("example-group"),
OverrideDynamicGroup: pulumi.Bool(true),
})
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "aws_iot_thinggroupmembership" "example" {
thing_name = "example-thing"
thing_group_name = "example-group"
override_dynamic_group = true
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.iot.ThingGroupMembership;
import com.pulumi.aws.iot.ThingGroupMembershipArgs;
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 ThingGroupMembership("example", ThingGroupMembershipArgs.builder()
.thingName("example-thing")
.thingGroupName("example-group")
.overrideDynamicGroup(true)
.build());
}
}
resources:
example:
type: aws:iot:ThingGroupMembership
properties:
thingName: example-thing
thingGroupName: example-group
overrideDynamicGroup: true
Import
Using pulumi import, import IoT Thing Group Membership using the thing group name and thing name. For example:
$ pulumi import aws:iot/thingGroupMembership:ThingGroupMembership example thing_group_name/thing_name
Constructors
- ThingGroupMembership(String name, {ThingGroupMembershipArgs? args, CustomResourceOptions? options})
-
Creates a new ThingGroupMembership.
nameThe Pulumi resource name.argsArguments used to configure this ThingGroupMembership. The set of arguments for ThingGroupMembership.optionsResource options controlling this resource's behavior. - ThingGroupMembership.reference(String urn)
- Creates a typed reference to an existing ThingGroupMembership 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
-
overrideDynamicGroup
↔ Output<
bool?> -
Override dynamic thing groups with static thing groups when 10-group limit is reached. If a thing belongs to 10 thing groups, and one or more of those groups are dynamic thing groups, adding a thing to a static group removes the thing from the last dynamic group.
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
-
thingGroupName
↔ Output<
String> -
The name of the group to which you are adding a thing.
latefinal
-
thingName
↔ Output<
String> -
The name of the thing to add to a group.
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, {ThingGroupMembershipState? state, CustomResourceOptions? options}) → ThingGroupMembership -
Gets an existing ThingGroupMembership resource's state with the given
nameandid.