Class CfnThingType
A CloudFormation AWS::IoT::ThingType
.
Inherited Members
Namespace: Amazon.CDK.AWS.IoT
Assembly: Amazon.CDK.AWS.IoT.dll
Syntax (csharp)
public class CfnThingType : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnThingType
Inherits CfnResource
Implements IConstruct, IDependable, IInspectable
Remarks
Creates a new thing type.
CloudformationResource: AWS::IoT::ThingType
Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-thingtype.html
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 cfnThingType = new CfnThingType(this, "MyCfnThingType", new CfnThingTypeProps {
DeprecateThingType = false,
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} },
ThingTypeName = "thingTypeName",
ThingTypeProperties = new ThingTypePropertiesProperty {
SearchableAttributes = new [] { "searchableAttributes" },
ThingTypeDescription = "thingTypeDescription"
}
});
Synopsis
Constructors
CfnThingType(Construct, String, ICfnThingTypeProps) | Create a new |
CfnThingType(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnThingType(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
Properties
AttrArn | The thing type arn. |
AttrId | The thing type id. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
DeprecateThingType | Deprecates a thing type. You can not associate new things with deprecated thing type. |
Tags | Metadata which can be used to manage the thing type. |
ThingTypeName | The name of the thing type. |
ThingTypeProperties | The thing type properties for the thing type to create. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnThingType(Construct, String, ICfnThingTypeProps)
Create a new AWS::IoT::ThingType
.
public CfnThingType(Construct scope, string id, ICfnThingTypeProps props = null)
Parameters
- scope Construct
- scope in which this resource is defined.
- id System.String
- scoped id of the resource.
- props ICfnThingTypeProps
- resource properties.
CfnThingType(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnThingType(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnThingType(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnThingType(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
Properties
AttrArn
The thing type arn.
public virtual string AttrArn { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Arn
AttrId
The thing type id.
public virtual string AttrId { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Id
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
DeprecateThingType
Deprecates a thing type. You can not associate new things with deprecated thing type.
public virtual object DeprecateThingType { get; set; }
Property Value
System.Object
Remarks
Requires permission to access the DeprecateThingType action.
Tags
Metadata which can be used to manage the thing type.
public virtual TagManager Tags { get; }
Property Value
Remarks
ThingTypeName
The name of the thing type.
public virtual string ThingTypeName { get; set; }
Property Value
System.String
Remarks
ThingTypeProperties
The thing type properties for the thing type to create.
public virtual object ThingTypeProperties { get; set; }
Property Value
System.Object
Remarks
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
.
Methods
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.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>