Class CfnThing

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

Inheritance

object

CfnElement

CfnRefElement

CfnResource

CfnThing

Implements

IInspectable

IThingRef

IConstruct

IDependable

IEnvironmentAware

Inherited Members

CfnResource.IsCfnResource(object)

CfnResource.AddDeletionOverride(string)

CfnResource.AddDependency(CfnResource)

CfnResource.AddDependsOn(CfnResource)

CfnResource.AddMetadata(string, object)

CfnResource.AddOverride(string, object)

CfnResource.AddPropertyDeletionOverride(string)

CfnResource.AddPropertyOverride(string, object)

CfnResource.ApplyRemovalPolicy(RemovalPolicy?, IRemovalPolicyOptions)

CfnResource.GetAtt(string, ResolutionTypeHint?)

CfnResource.GetMetadata(string)

CfnResource.ObtainDependencies()

CfnResource.ObtainResourceDependencies()

CfnResource.RemoveDependency(CfnResource)

CfnResource.ReplaceDependency(CfnResource, CfnResource)

CfnResource.ShouldSynthesize()

CfnResource.ToString()

CfnResource.ValidateProperties(object)

CfnResource.CfnOptions

CfnResource.CfnResourceType

CfnResource.Env

CfnResource.UpdatedProperites

CfnResource.UpdatedProperties

CfnRefElement.Ref

CfnElement.IsCfnElement(object)

CfnElement.OverrideLogicalId(string)

CfnElement.CreationStack

CfnElement.LogicalId

CfnElement.Stack

Namespace: Amazon.CDK.AWS.IoT

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnThing : CfnResource, IInspectable, IThingRef, IConstruct, IDependable, IEnvironmentAware

Syntax (vb)

Public Class CfnThing Inherits CfnResource Implements IInspectable, IThingRef, IConstruct, IDependable, IEnvironmentAware

Remarks

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-thing.html

CloudformationResource: AWS::IoT::Thing

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.IoT;

             var cfnThing = new CfnThing(this, "MyCfnThing", new CfnThingProps {
                 AttributePayload = new AttributePayloadProperty {
                     Attributes = new Dictionary<string, string> {
                         { "attributesKey", "attributes" }
                     }
                 },
                 ThingName = "thingName"
             });

Synopsis

Constructors

CfnThing(Construct, string, ICfnThingProps?)

Create a new AWS::IoT::Thing.

Properties

AttrArn	The Amazon Resource Name (ARN) of the AWS IoT thing, such as arn:aws:iot:us-east-2:123456789012:thing/MyThing .
AttrId	The Id of this thing.
AttributePayload	A string that contains up to three key value pairs.
CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.
CfnProperties	Use the AWS::IoT::Thing resource to declare an AWS IoT thing.
ThingName	The name of the thing to update.
ThingRef	A reference to a Thing resource.

Methods

ArnForThing(IThingRef)	Use the AWS::IoT::Thing resource to declare an AWS IoT thing.
FromThingArn(Construct, string, string)	Creates a new IThingRef from an ARN.
FromThingName(Construct, string, string)	Creates a new IThingRef from a thingName.
Inspect(TreeInspector)	Examines the CloudFormation resource and discloses attributes.
IsCfnThing(object)	Checks whether the given object is a CfnThing.
RenderProperties(IDictionary<string, object>)	Use the AWS::IoT::Thing resource to declare an AWS IoT thing.

Constructors

CfnThing(Construct, string, ICfnThingProps?)

Create a new AWS::IoT::Thing.

public CfnThing(Construct scope, string id, ICfnThingProps? props = null)

Parameters

scope Construct

Scope in which this resource is defined.

id string

Construct identifier for this resource (unique in its scope).

props ICfnThingProps

Resource properties.

Remarks

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-thing.html

CloudformationResource: AWS::IoT::Thing

ExampleMetadata: fixture=_generated

Properties

AttrArn

The Amazon Resource Name (ARN) of the AWS IoT thing, such as arn:aws:iot:us-east-2:123456789012:thing/MyThing .

public virtual string AttrArn { get; }

Property Value

string

Remarks

CloudformationAttribute: Arn

AttrId

The Id of this thing.

public virtual string AttrId { get; }

Property Value

string

Remarks

CloudformationAttribute: Id

AttributePayload

A string that contains up to three key value pairs.

public virtual object? AttributePayload { get; set; }

Property Value

object

Remarks

Type union: either IResolvable or CfnThing.IAttributePayloadProperty

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

public static string CFN_RESOURCE_TYPE_NAME { get; }

Property Value

string

Remarks

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-thing.html

CloudformationResource: AWS::IoT::Thing

ExampleMetadata: fixture=_generated

CfnProperties

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

protected override IDictionary<string, object> CfnProperties { get; }

Property Value

IDictionary<string, object>

Overrides

CfnResource.CfnProperties

Remarks

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-thing.html

CloudformationResource: AWS::IoT::Thing

ExampleMetadata: fixture=_generated

ThingName

The name of the thing to update.

public virtual string? ThingName { get; set; }

Property Value

string

Remarks

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-thing.html

CloudformationResource: AWS::IoT::Thing

ExampleMetadata: fixture=_generated

ThingRef

A reference to a Thing resource.

public virtual IThingReference ThingRef { get; }

Property Value

IThingReference

Remarks

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-thing.html

CloudformationResource: AWS::IoT::Thing

ExampleMetadata: fixture=_generated

Methods

ArnForThing(IThingRef)

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

public static string ArnForThing(IThingRef resource)

Parameters

resource IThingRef

Returns

string

Remarks

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-thing.html

CloudformationResource: AWS::IoT::Thing

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.IoT;

             var cfnThing = new CfnThing(this, "MyCfnThing", new CfnThingProps {
                 AttributePayload = new AttributePayloadProperty {
                     Attributes = new Dictionary<string, string> {
                         { "attributesKey", "attributes" }
                     }
                 },
                 ThingName = "thingName"
             });

FromThingArn(Construct, string, string)

Creates a new IThingRef from an ARN.

public static IThingRef FromThingArn(Construct scope, string id, string arn)

Parameters

scope Construct

id string

arn string

Returns

IThingRef

Remarks

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-thing.html

CloudformationResource: AWS::IoT::Thing

ExampleMetadata: fixture=_generated

FromThingName(Construct, string, string)

Creates a new IThingRef from a thingName.

public static IThingRef FromThingName(Construct scope, string id, string thingName)

Parameters

scope Construct

id string

thingName string

Returns

IThingRef

Remarks

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-thing.html

CloudformationResource: AWS::IoT::Thing

ExampleMetadata: fixture=_generated

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.

public virtual void Inspect(TreeInspector inspector)

Parameters

inspector TreeInspector

tree inspector to collect and process attributes.

Remarks

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-thing.html

CloudformationResource: AWS::IoT::Thing

ExampleMetadata: fixture=_generated

IsCfnThing(object)

Checks whether the given object is a CfnThing.

public static bool IsCfnThing(object x)

Parameters

x object

Returns

bool

Remarks

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-thing.html

CloudformationResource: AWS::IoT::Thing

ExampleMetadata: fixture=_generated

RenderProperties(IDictionary<string, object>)

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

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)

Parameters

props IDictionary<string, object>

Returns

IDictionary<string, object>

Overrides

CfnResource.RenderProperties(IDictionary<string, object>)

Remarks

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-thing.html

CloudformationResource: AWS::IoT::Thing

ExampleMetadata: fixture=_generated

Implements

IInspectable

IThingRef

Constructs.IConstruct

Constructs.IDependable

IEnvironmentAware