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.103.1 (build bef2dea)",
date="2024-10-11T15:56:00.223Z")
@Stability(Stable)
public class CfnThing
extends CfnResource
implements IInspectable
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();
- See Also:
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic interface
The AttributePayload property specifies up to three attributes for an AWS IoT as key-value pairs.static final class
A fluent builder forCfnThing
.Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationMode
Nested classes/interfaces inherited from interface software.constructs.IConstruct
software.constructs.IConstruct.Jsii$Default
Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
The CloudFormation resource type name for this resource class. -
Constructor Summary
ModifierConstructorDescriptionprotected
CfnThing
(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) protected
CfnThing
(software.amazon.jsii.JsiiObjectRef objRef) CfnThing
(software.constructs.Construct scope, String id, CfnThingProps props) -
Method Summary
Modifier and TypeMethodDescriptionThe Amazon Resource Name (ARN) of the AWS IoT thing, such asarn:aws:iot:us-east-2:123456789012:thing/MyThing
.A string that contains up to three key value pairs.The Id of this thing.The name of the thing to update.void
inspect
(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.renderProperties
(Map<String, Object> props) void
setAttributePayload
(IResolvable value) A string that contains up to three key value pairs.void
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, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, 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 Details
-
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 software.constructs.Construct scope, @NotNull String id, @Nullable CfnThingProps props) - 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.
-
CfnThing
@Stability(Stable) public CfnThing(@NotNull software.constructs.Construct scope, @NotNull String id) - 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
-
inspect
Examines the CloudFormation resource and discloses attributes.- Specified by:
inspect
in interfaceIInspectable
- 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 classCfnResource
- Parameters:
props
- This parameter is required.
-
getAttrArn
The Amazon Resource Name (ARN) of the AWS IoT thing, such asarn:aws:iot:us-east-2:123456789012:thing/MyThing
. -
getAttrId
The Id of this thing. -
getCfnProperties
- Overrides:
getCfnProperties
in classCfnResource
-
getAttributePayload
A string that contains up to three key value pairs. -
setAttributePayload
A string that contains up to three key value pairs. -
setAttributePayload
@Stability(Stable) public void setAttributePayload(@Nullable CfnThing.AttributePayloadProperty value) A string that contains up to three key value pairs. -
getThingName
The name of the thing to update. -
setThingName
The name of the thing to update.
-