interface CfnThingGroupProps

Language	Type name
.NET	Amazon.CDK.AWS.IoT.CfnThingGroupProps
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsiot#CfnThingGroupProps
Java	software.amazon.awscdk.services.iot.CfnThingGroupProps
Python	aws_cdk.aws_iot.CfnThingGroupProps
TypeScript	aws-cdk-lib » aws_iot » CfnThingGroupProps

Properties for defining a CfnThingGroup.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-thinggroup.html

Example

// 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',
  },
};

Properties

Name	Type	Description
parentGroupName?	string	The parent thing group name.
queryString?	string	The dynamic thing group search query string.
tags?	CfnTag[]	Metadata which can be used to manage the thing group or dynamic thing group.
thingGroupName?	string	The thing group name.
thingGroupProperties?	IResolvable | ThingGroupPropertiesProperty	Thing group properties.

---

parentGroupName?

Type: string (optional)

The parent thing group name.

A Dynamic Thing Group does not have parentGroupName defined.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-thinggroup.html#cfn-iot-thinggroup-parentgroupname

---

queryString?

Type: string (optional)

The dynamic thing group search query string.

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-thinggroup.html#cfn-iot-thinggroup-querystring

---

tags?

Type: CfnTag[] (optional)

Metadata which can be used to manage the thing group or dynamic thing group.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-thinggroup.html#cfn-iot-thinggroup-tags

---

thingGroupName?

Type: string (optional)

The thing group name.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-thinggroup.html#cfn-iot-thinggroup-thinggroupname

---

thingGroupProperties?

Type: IResolvable | ThingGroupPropertiesProperty (optional)

Thing group properties.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-thinggroup.html#cfn-iot-thinggroup-thinggroupproperties