Package software.amazon.awscdk.services.iot

Class CfnThingType

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.iot.CfnThingType
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:29:57.639Z") @Stability(Stable) public class CfnThingType extends CfnResource implements IInspectable
A CloudFormation AWS::IoT::ThingType.

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()
                 .searchableAttributes(List.of("searchableAttributes"))
                 .thingTypeDescription("thingTypeDescription")
                 .build())
         .build();

  • 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 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 -
      • scoped id of the resource.
      This parameter is required.
      props -
      • resource properties.

    • CfnThingType

      @Stability(Stable) public CfnThingType(@NotNull 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 -
      • scoped id of the resource.
      This parameter is required.

  • Method Details

    • 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()
      Metadata which can be used to manage the thing type.

    • getDeprecateThingType

      @Stability(Stable) @Nullable public Object getDeprecateThingType()
      Deprecates a thing type. You can not associate new things with deprecated thing type.

      Requires permission to access the DeprecateThingType action.

    • setDeprecateThingType

      @Stability(Stable) public void setDeprecateThingType(@Nullable Boolean value)
      Deprecates a thing type. You can not associate new things with deprecated thing type.

      Requires permission to access the DeprecateThingType action.

    • setDeprecateThingType

      @Stability(Stable) public void setDeprecateThingType(@Nullable IResolvable value)
      Deprecates a thing type. You can not associate new things with deprecated thing type.

      Requires permission to access the DeprecateThingType action.

    • 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.

      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 .

    • setThingTypeProperties

      @Stability(Stable) public void setThingTypeProperties(@Nullable IResolvable value)
      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 .

    • setThingTypeProperties

      @Stability(Stable) public void setThingTypeProperties(@Nullable CfnThingType.ThingTypePropertiesProperty value)
      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 .