software.amazon.awscdk.services.iot

Class CfnThing

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

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:39.895Z")
 @Stability(value=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();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CfnThing.AttributePayloadProperty The AttributePayload property specifies up to three attributes for an AWS IoT as key-value pairs.
static class	CfnThing.Builder A fluent builder for CfnThing.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnThing(software.constructs.Construct scope, String id) Create a new `AWS::IoT::Thing`.
	CfnThing(software.constructs.Construct scope, String id, CfnThingProps props) Create a new `AWS::IoT::Thing`.
protected	CfnThing(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnThing(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
Object	getAttributePayload() A string that contains up to three key value pairs.
protected Map<String,Object>	getCfnProperties()
String	getThingName() The name of the thing to update.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setAttributePayload(CfnThing.AttributePayloadProperty value) A string that contains up to three key value pairs.
void	setAttributePayload(IResolvable value) A string that contains up to three key value pairs.
void	setThingName(String value) The name of the thing to update.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnThing

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

CfnThing

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

CfnThing

@Stability(value=Stable)
public CfnThing(@NotNull
                                         software.constructs.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(value=Stable)
public CfnThing(@NotNull
                                         software.constructs.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 Detail

inspect

@Stability(value=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(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getAttributePayload

@Stability(value=Stable)
 @Nullable
public Object getAttributePayload()

A string that contains up to three key value pairs.

Maximum length of 800. Duplicates not allowed.

setAttributePayload

@Stability(value=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.

setAttributePayload

@Stability(value=Stable)
public void setAttributePayload(@Nullable
                                                         IResolvable value)

A string that contains up to three key value pairs.

Maximum length of 800. Duplicates not allowed.

getThingName

@Stability(value=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(value=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.