Class CfnDevice
The AWS::IoT1Click::Device
resource controls the enabled state of an AWS IoT 1-Click compatible device.
Implements
Inherited Members
Namespace: Amazon.CDK.AWS.IoT1Click
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnDevice : CfnResource, IInspectable
Syntax (vb)
Public Class CfnDevice
Inherits CfnResource
Implements IInspectable
Remarks
For more information, see Device in the AWS IoT 1-Click Devices API Reference .
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot1click-device.html
CloudformationResource: AWS::IoT1Click::Device
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.IoT1Click;
var cfnDevice = new CfnDevice(this, "MyCfnDevice", new CfnDeviceProps {
DeviceId = "deviceId",
Enabled = false
});
Synopsis
Constructors
CfnDevice(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnDevice(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
CfnDevice(Construct, String, ICfnDeviceProps) |
Properties
AttrArn | The ARN of the device, such as |
AttrDeviceId | The unique identifier of the device. |
AttrEnabled | A Boolean value indicating whether the device is enabled ( |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
DeviceId | The ID of the device, such as |
Enabled | A Boolean value indicating whether the device is enabled ( |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnDevice(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnDevice(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnDevice(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnDevice(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
CfnDevice(Construct, String, ICfnDeviceProps)
public CfnDevice(Construct scope, string id, ICfnDeviceProps props)
Parameters
- scope Constructs.Construct
Scope in which this resource is defined.
- id System.String
Construct identifier for this resource (unique in its scope).
- props ICfnDeviceProps
Resource properties.
Properties
AttrArn
The ARN of the device, such as arn:aws:iot1click:us-west-2:123456789012:devices/G030PX0312744DWM
.
public virtual string AttrArn { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Arn
AttrDeviceId
The unique identifier of the device.
public virtual string AttrDeviceId { get; }
Property Value
System.String
Remarks
CloudformationAttribute: DeviceId
AttrEnabled
A Boolean value indicating whether the device is enabled ( true
) or not ( false
).
public virtual IResolvable AttrEnabled { get; }
Property Value
Remarks
CloudformationAttribute: Enabled
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
DeviceId
The ID of the device, such as G030PX0312744DWM
.
public virtual string DeviceId { get; set; }
Property Value
System.String
Enabled
A Boolean value indicating whether the device is enabled ( true
) or not ( false
).
public virtual object Enabled { get; set; }
Property Value
System.Object
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>