aws-cdk-lib.aws_iot.CfnThingGroupProps

interface CfnThingGroupProps

LanguageType name
.NETAmazon.CDK.AWS.IoT.CfnThingGroupProps
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsiot#CfnThingGroupProps
Javasoftware.amazon.awscdk.services.iot.CfnThingGroupProps
Pythonaws_cdk.aws_iot.CfnThingGroupProps
TypeScript aws-cdk-lib » aws_iot » CfnThingGroupProps

Properties for defining a CfnThingGroup.

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

NameTypeDescription
parentGroupName?stringThe parent thing group name.
queryString?stringThe dynamic thing group search query string.
tags?CfnTag[]Metadata which can be used to manage the thing group or dynamic thing group.
thingGroupName?stringThe thing group name.
thingGroupProperties?IResolvable | ThingGroupPropertiesPropertyThing group properties.

parentGroupName?

Type: string (optional)

The parent thing group name.

A Dynamic Thing Group does not have parentGroupName defined.


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 .


tags?

Type: CfnTag[] (optional)

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


thingGroupName?

Type: string (optional)

The thing group name.


thingGroupProperties?

Type: IResolvable | ThingGroupPropertiesProperty (optional)

Thing group properties.