Skip to content
v2.273.0

CfnThingTypeProps Struct ​

Properties for defining a CfnThingType.

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 cfnThingTypeProps: iot.CfnThingTypeProps = {
  deprecateThingType: false,
  tags: [{
    key: 'key',
    value: 'value',
  }],
  thingTypeName: 'thingTypeName',
  thingTypeProperties: {
    mqtt5Configuration: {
      propagatingAttributes: [{
        userPropertyKey: 'userPropertyKey',

        // the properties below are optional
        connectionAttribute: 'connectionAttribute',
        thingAttribute: 'thingAttribute',
      }],
    },
    searchableAttributes: ['searchableAttributes'],
    thingTypeDescription: 'thingTypeDescription',
  },
};

Properties ​

deprecateThingTypeboolean | IResolvabledeprecate_thing_typetyping.Union[bool, IResolvable]deprecateThingTypeBooleanDeprecateThingTypeboolDeprecateThingTypeinterface{}#
Deprecates a thing type. You can not associate new things with deprecated thing type.

Requires permission to access the DeprecateThingType action.

tagsCfnTag[]tagstyping.List[CfnTag]tagsList<CfnTag>TagsCfnTag[]Tags*[]CfnTag#
Metadata which can be used to manage the thing type.
thingTypeNamestringthing_type_namestrthingTypeNameStringThingTypeNamestringThingTypeName*string#
The name of the thing type.
thingTypePropertiesIResolvable | CfnThingType.ThingTypePropertiesPropertything_type_propertiestyping.Union[IResolvable, ThingTypePropertiesProperty]thingTypePropertiesIResolvableThingTypePropertiesIResolvableThingTypePropertiesinterface{}#
The thing type properties for the thing type to create.

It contains information about the new thing type including a description, a list of searchable thing attribute names, and a list of propagating attributes. After a thing type is created, you can only update Mqtt5Configuration .

Used as props by ​