Package software.amazon.awscdk.services.iot

Interface CfnThingType.ThingTypePropertiesProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnThingType.ThingTypePropertiesProperty.Jsii$Proxy

Enclosing class:

CfnThingType

@Stability(Stable)
public static interface CfnThingType.ThingTypePropertiesProperty
extends software.amazon.jsii.JsiiSerializable

The ThingTypeProperties contains information about the thing type including: a thing type description, and a list of searchable thing attribute names.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.iot.*;
 ThingTypePropertiesProperty thingTypePropertiesProperty = ThingTypePropertiesProperty.builder()
         .mqtt5Configuration(Mqtt5ConfigurationProperty.builder()
                 .propagatingAttributes(List.of(PropagatingAttributeProperty.builder()
                         .userPropertyKey("userPropertyKey")
                         // the properties below are optional
                         .connectionAttribute("connectionAttribute")
                         .thingAttribute("thingAttribute")
                         .build()))
                 .build())
         .searchableAttributes(List.of("searchableAttributes"))
         .thingTypeDescription("thingTypeDescription")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-thingtype-thingtypeproperties.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnThingType.ThingTypePropertiesProperty.Builder	A builder for CfnThingType.ThingTypePropertiesProperty
static final class	CfnThingType.ThingTypePropertiesProperty.Jsii$Proxy	An implementation for CfnThingType.ThingTypePropertiesProperty

Method Summary

Modifier and Type	Method	Description
static CfnThingType.ThingTypePropertiesProperty.Builder	builder()
default Object	getMqtt5Configuration()	The configuration to add user-defined properties to enrich MQTT 5 messages.
default List<String>	getSearchableAttributes()	A list of searchable thing attribute names.
default String	getThingTypeDescription()	The description of the thing type.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getMqtt5Configuration

@Stability(Stable)
@Nullable
default Object getMqtt5Configuration()

The configuration to add user-defined properties to enrich MQTT 5 messages.

See Also:

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

getSearchableAttributes

@Stability(Stable)
@Nullable
default List<String> getSearchableAttributes()

A list of searchable thing attribute names.

See Also:

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

getThingTypeDescription

@Stability(Stable)
@Nullable
default String getThingTypeDescription()

The description of the thing type.

See Also:

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

builder

@Stability(Stable)
static CfnThingType.ThingTypePropertiesProperty.Builder builder()

Returns:

a CfnThingType.ThingTypePropertiesProperty.Builder of CfnThingType.ThingTypePropertiesProperty