Package software.amazon.awscdk.services.iot

Interface CfnThingTypeProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnThingTypeProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-11-21T06:34:09.516Z")
@Stability(Stable)
public interface CfnThingTypeProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnThingType.

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.*;
 CfnThingTypeProps cfnThingTypeProps = CfnThingTypeProps.builder()
         .deprecateThingType(false)
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .thingTypeName("thingTypeName")
         .thingTypeProperties(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())
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnThingTypeProps.Builder	builder()
default Object	getDeprecateThingType()	Deprecates a thing type.
default List<CfnTag>	getTags()	Metadata which can be used to manage the thing type.
default String	getThingTypeName()	The name of the thing type.
default Object	getThingTypeProperties()	The thing type properties for the thing type to create.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getDeprecateThingType

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

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

Requires permission to access the DeprecateThingType action.

See Also:

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

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

Metadata which can be used to manage the thing type.

See Also:

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

getThingTypeName

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

The name of the thing type.

See Also:

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

getThingTypeProperties

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

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 .

See Also:

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

builder

@Stability(Stable)
static CfnThingTypeProps.Builder builder()

Returns:

a CfnThingTypeProps.Builder of CfnThingTypeProps