Skip to content
v2.278.0

CfnThingGroupProps Struct ​

Properties for defining a CfnThingGroup.

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_iot as iot } from 'aws-cdk-lib';
const cfnThingGroupProps: iot.CfnThingGroupProps = {
  parentGroupName: 'parentGroupName',
  queryString: 'queryString',
  tags: [{
    key: 'key',
    value: 'value',
  }],
  thingGroupName: 'thingGroupName',
  thingGroupProperties: {
    attributePayload: {
      attributes: {
        attributesKey: 'attributes',
      },
    },
    thingGroupDescription: 'thingGroupDescription',
  },
};
python
from aws_cdk import CfnTag
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_iot as iot

cfn_thing_group_props = iot.CfnThingGroupProps(
    parent_group_name="parentGroupName",
    query_string="queryString",
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    thing_group_name="thingGroupName",
    thing_group_properties=iot.CfnThingGroup.ThingGroupPropertiesProperty(
        attribute_payload=iot.CfnThingGroup.AttributePayloadProperty(
            attributes={
                "attributes_key": "attributes"
            }
        ),
        thing_group_description="thingGroupDescription"
    )
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.iot.*;

CfnThingGroupProps cfnThingGroupProps = CfnThingGroupProps.builder()
        .parentGroupName("parentGroupName")
        .queryString("queryString")
        .tags(List.of(CfnTag.builder()
                .key("key")
                .value("value")
                .build()))
        .thingGroupName("thingGroupName")
        .thingGroupProperties(ThingGroupPropertiesProperty.builder()
                .attributePayload(AttributePayloadProperty.builder()
                        .attributes(Map.of(
                                "attributesKey", "attributes"))
                        .build())
                .thingGroupDescription("thingGroupDescription")
                .build())
        .build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.IoT;

var cfnThingGroupProps = new CfnThingGroupProps {
    ParentGroupName = "parentGroupName",
    QueryString = "queryString",
    Tags = new [] { new CfnTag {
        Key = "key",
        Value = "value"
    } },
    ThingGroupName = "thingGroupName",
    ThingGroupProperties = new ThingGroupPropertiesProperty {
        AttributePayload = new AttributePayloadProperty {
            Attributes = new Dictionary<string, string> {
                { "attributesKey", "attributes" }
            }
        },
        ThingGroupDescription = "thingGroupDescription"
    }
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

cfnThingGroupProps := &CfnThingGroupProps{
	ParentGroupName: jsii.String("parentGroupName"),
	QueryString: jsii.String("queryString"),
	Tags: []CfnTag{
		&CfnTag{
			Key: jsii.String("key"),
			Value: jsii.String("value"),
		},
	},
	ThingGroupName: jsii.String("thingGroupName"),
	ThingGroupProperties: &ThingGroupPropertiesProperty{
		AttributePayload: &AttributePayloadProperty{
			Attributes: map[string]*string{
				"attributesKey": jsii.String("attributes"),
			},
		},
		ThingGroupDescription: jsii.String("thingGroupDescription"),
	},
}

Properties ​

parentGroupNameoptionalstringparent_group_nameoptionalstrparentGroupNameoptionalStringParentGroupNameoptionalstringParentGroupNameoptional*string #
The parent thing group name.

A Dynamic Thing Group does not have parentGroupName defined.

queryStringoptionalstringquery_stringoptionalstrqueryStringoptionalStringQueryStringoptionalstringQueryStringoptional*string #
The dynamic thing group search query string.

The queryString attribute is required for CreateDynamicThingGroup . The queryString attribute is not required for CreateThingGroup .

tagsoptionalCfnTag[]tagsoptionaltyping.List[CfnTag]tagsoptionalList<CfnTag>TagsoptionalCfnTag[]Tagsoptional*[]CfnTag #
Metadata which can be used to manage the thing group or dynamic thing group.
thingGroupNameoptionalstringthing_group_nameoptionalstrthingGroupNameoptionalStringThingGroupNameoptionalstringThingGroupNameoptional*string #
The thing group name.
thingGroupPropertiesoptionalIResolvable | CfnThingGroup.ThingGroupPropertiesPropertything_group_propertiesoptionaltyping.Union[IResolvable, ThingGroupPropertiesProperty]thingGroupPropertiesoptionalIResolvableThingGroupPropertiesoptionalIResolvableThingGroupPropertiesoptionalinterface{} #
Thing group properties.