Package software.amazon.awscdk.services.iot

Class CfnThing

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.CfnThing
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.630Z") @Stability(Stable) public class CfnThing extends CfnResource implements IInspectable
A CloudFormation AWS::IoT::Thing.

Use the AWS::IoT::Thing resource to declare an AWS IoT thing.

For information about working with things, see How AWS IoT Works and Device Registry for AWS IoT in the AWS IoT Developer Guide .

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.*;
 CfnThing cfnThing = CfnThing.Builder.create(this, "MyCfnThing")
         .attributePayload(AttributePayloadProperty.builder()
                 .attributes(Map.of(
                         "attributesKey", "attributes"))
                 .build())
         .thingName("thingName")
         .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

    • CfnThing

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

    • CfnThing

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

    • CfnThing

      @Stability(Stable) public CfnThing(@NotNull Construct scope, @NotNull String id, @Nullable CfnThingProps props)
      Create a new AWS::IoT::Thing.

      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.

    • CfnThing

      @Stability(Stable) public CfnThing(@NotNull Construct scope, @NotNull String id)
      Create a new AWS::IoT::Thing.

      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()

    • getAttrId

      @Stability(Stable) @NotNull public String getAttrId()

    • getCfnProperties

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

    • getAttributePayload

      @Stability(Stable) @Nullable public Object getAttributePayload()
      A string that contains up to three key value pairs.

      Maximum length of 800. Duplicates not allowed.

    • setAttributePayload

      @Stability(Stable) public void setAttributePayload(@Nullable IResolvable value)
      A string that contains up to three key value pairs.

      Maximum length of 800. Duplicates not allowed.

    • setAttributePayload

      @Stability(Stable) public void setAttributePayload(@Nullable CfnThing.AttributePayloadProperty value)
      A string that contains up to three key value pairs.

      Maximum length of 800. Duplicates not allowed.

    • getThingName

      @Stability(Stable) @Nullable public String getThingName()
      The name of the thing to update.

      You can't change a thing's name. To change a thing's name, you must create a new thing, give it the new name, and then delete the old thing.

    • setThingName

      @Stability(Stable) public void setThingName(@Nullable String value)
      The name of the thing to update.

      You can't change a thing's name. To change a thing's name, you must create a new thing, give it the new name, and then delete the old thing.