interface CfnThingTypeProps
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.IoT.CfnThingTypeProps |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/awsiot#CfnThingTypeProps |
![]() | software.amazon.awscdk.services.iot.CfnThingTypeProps |
![]() | aws_cdk.aws_iot.CfnThingTypeProps |
![]() | aws-cdk-lib » aws_iot » CfnThingTypeProps |
Properties for defining a CfnThingType
.
See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-thingtype.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 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
Name | Type | Description |
---|---|---|
deprecate | boolean | IResolvable | Deprecates a thing type. |
tags? | Cfn [] | Metadata which can be used to manage the thing type. |
thing | string | The name of the thing type. |
thing | IResolvable | Thing | The thing type properties for the thing type to create. |
deprecateThingType?
Type:
boolean |
IResolvable
(optional)
Deprecates a thing type.
You can not associate new things with deprecated thing type. You cannot update ThingTypeProperties
if the thing type is deprecated.
Requires permission to access the DeprecateThingType action.
tags?
Type:
Cfn
[]
(optional)
Metadata which can be used to manage the thing type.
thingTypeName?
Type:
string
(optional)
The name of the thing type.
thingTypeProperties?
Type:
IResolvable
|
Thing
(optional)
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
.