CfnThingTypeProps

class aws_cdk.aws_iot.CfnThingTypeProps(*, deprecate_thing_type=None, tags=None, thing_type_name=None, thing_type_properties=None)

Bases: object

Properties for defining a CfnThingType.

Parameters:
  • deprecate_thing_type (Union[bool, IResolvable, None]) – Deprecates a thing type. You can not associate new things with deprecated thing type. Requires permission to access the DeprecateThingType action.

  • tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – Metadata which can be used to manage the thing type.

  • thing_type_name (Optional[str]) – The name of the thing type.

  • thing_type_properties (Union[IResolvable, ThingTypePropertiesProperty, Dict[str, Any], None]) – The thing type properties for the thing type to create. It contains information about the new thing type including a description, and a list of searchable thing attribute names. ThingTypeProperties can’t be updated after the initial creation of the ThingType .

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-thingtype.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_iot as iot

cfn_thing_type_props = iot.CfnThingTypeProps(
    deprecate_thing_type=False,
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    thing_type_name="thingTypeName",
    thing_type_properties=iot.CfnThingType.ThingTypePropertiesProperty(
        searchable_attributes=["searchableAttributes"],
        thing_type_description="thingTypeDescription"
    )
)

Attributes

deprecate_thing_type

Deprecates a thing type. You can not associate new things with deprecated thing type.

Requires permission to access the DeprecateThingType action.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-thingtype.html#cfn-iot-thingtype-deprecatethingtype

tags

Metadata which can be used to manage the thing type.

Link:

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

thing_type_name

The name of the thing type.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-thingtype.html#cfn-iot-thingtype-thingtypename

thing_type_properties

The thing type properties for the thing type to create.

It contains information about the new thing type including a description, and a list of searchable thing attribute names. ThingTypeProperties can’t be updated after the initial creation of the ThingType .

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-thingtype.html#cfn-iot-thingtype-thingtypeproperties