Package software.amazon.awscdk.services.iot

Class CfnThingType

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.iot.CfnThingType
All Implemented Interfaces:
IInspectable, IEnvironmentAware, IThingTypeRef, ITaggable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.126.0 (build 206d44b)", date="2026-02-09T14:39:12.520Z") @Stability(Stable) public class CfnThingType extends CfnResource implements IInspectable, IThingTypeRef, ITaggable
Creates a new thing type.

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.*;
 CfnThingType cfnThingType = CfnThingType.Builder.create(this, "MyCfnThingType")
         .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:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnThingType

      protected CfnThingType(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnThingType

      protected CfnThingType(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnThingType

      @Stability(Stable) public CfnThingType(@NotNull software.constructs.Construct scope, @NotNull String id, @Nullable CfnThingTypeProps props)
      Create a new AWS::IoT::ThingType.

      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties.

    • CfnThingType

      @Stability(Stable) public CfnThingType(@NotNull software.constructs.Construct scope, @NotNull String id)
      Create a new AWS::IoT::ThingType.

      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.

  • Method Details

    • arnForThingType

      @Stability(Stable) @NotNull public static String arnForThingType(@NotNull IThingTypeRef resource)
      Parameters:
      resource - This parameter is required.

    • fromThingTypeArn

      @Stability(Stable) @NotNull public static IThingTypeRef fromThingTypeArn(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String arn)
      Creates a new IThingTypeRef from an ARN.

      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      arn - This parameter is required.

    • fromThingTypeName

      @Stability(Stable) @NotNull public static IThingTypeRef fromThingTypeName(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String thingTypeName)
      Creates a new IThingTypeRef from a thingTypeName.

      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      thingTypeName - This parameter is required.

    • isCfnThingType

      @Stability(Stable) @NotNull public static Boolean isCfnThingType(@NotNull Object x)
      Checks whether the given object is a CfnThingType.

      Parameters:
      x - This parameter is required.

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrArn

      @Stability(Stable) @NotNull public String getAttrArn()
      The thing type arn.

    • getAttrId

      @Stability(Stable) @NotNull public String getAttrId()
      The thing type id.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getTags in interface ITaggable

    • getThingTypeRef

      @Stability(Stable) @NotNull public ThingTypeReference getThingTypeRef()
      A reference to a ThingType resource.
      Specified by:
      getThingTypeRef in interface IThingTypeRef

    • getDeprecateThingType

      @Stability(Stable) @Nullable public Object getDeprecateThingType()
      Deprecates a thing type.

      You can not associate new things with deprecated thing type.

      Returns union: either Boolean or IResolvable

    • setDeprecateThingType

      @Stability(Stable) public void setDeprecateThingType(@Nullable Boolean value)
      Deprecates a thing type.

      You can not associate new things with deprecated thing type.

    • setDeprecateThingType

      @Stability(Stable) public void setDeprecateThingType(@Nullable IResolvable value)
      Deprecates a thing type.

      You can not associate new things with deprecated thing type.

    • getTagsRaw

      @Stability(Stable) @Nullable public List<CfnTag> getTagsRaw()
      Metadata which can be used to manage the thing type.

    • setTagsRaw

      @Stability(Stable) public void setTagsRaw(@Nullable List<CfnTag> value)
      Metadata which can be used to manage the thing type.

    • getThingTypeName

      @Stability(Stable) @Nullable public String getThingTypeName()
      The name of the thing type.

    • setThingTypeName

      @Stability(Stable) public void setThingTypeName(@Nullable String value)
      The name of the thing type.

    • getThingTypeProperties

      @Stability(Stable) @Nullable public Object getThingTypeProperties()
      The thing type properties for the thing type to create.

      Returns union: either IResolvable or CfnThingType.ThingTypePropertiesProperty

    • setThingTypeProperties

      @Stability(Stable) public void setThingTypeProperties(@Nullable IResolvable value)
      The thing type properties for the thing type to create.

    • setThingTypeProperties

      @Stability(Stable) public void setThingTypeProperties(@Nullable CfnThingType.ThingTypePropertiesProperty value)
      The thing type properties for the thing type to create.