Skip to content
v2.276.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',
  },
};

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.