AWS::IoT1Click::Device

The AWS::IoT1Click::Device resource controls the enabled state of an AWS IoT 1-Click compatible device. For more information, see Device in the AWS IoT 1-Click Devices API Reference.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

{
  "Type" : "AWS::IoT1Click::Device",
  "Properties" : {
      "DeviceId" : String,
      "Enabled" : Boolean
    }
}

Type: AWS::IoT1Click::Device
Properties:
  DeviceId: String
  Enabled: Boolean

Properties

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the device ARN, such as arn:aws:iot1click:us-west-2:123456789012:devices/G030PX0312744DWM.

For more information about using the Ref function, see Ref.

Fn::GetAtt

The Fn::GetAtt intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the Fn::GetAtt intrinsic function, see Fn::GetAtt.

Examples

Enable a device

{
  "SampleDevice": {
    "Type": "AWS::IoT1Click::Device",
    "Properties": {
      "DeviceId": "G030PX0312744DWM",
      "Enabled": true
    }
  }
}         

SampleDevice:
  Type: "AWS::IoT1Click::Device"
  Properties:
    DeviceId: G030PX0312744DWM
    Enabled: True
            

See also