AWS::Greengrass::DeviceDefinition Device - AWS CloudFormation
SyntaxPropertiesSee also

This is the new AWS CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the AWS CloudFormation User Guide.

AWS::Greengrass::DeviceDefinition Device

A device is an AWS IoT device (thing) that's added to a Greengrass group. Greengrass devices can communicate with the Greengrass core in the same group. For more information, see What Is AWS IoT Greengrass? in the AWS IoT Greengrass Version 1 Developer Guide .

In an AWS CloudFormation template, the Devices property of the DeviceDefinitionVersion property type contains a list of Device property types.

Syntax

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

JSON

{
  "CertificateArn" : String,
  "Id" : String,
  "SyncShadow" : Boolean,
  "ThingArn" : String
}

YAML

  CertificateArn: String
  Id: String
  SyncShadow: Boolean
  ThingArn: String

Properties

CertificateArn

The Amazon Resource Name (ARN) of the device certificate for the device. This X.509 certificate is used to authenticate the device with AWS IoT and AWS IoT Greengrass services.

Required: Yes

Type: String

Update requires: Replacement

Id

A descriptive or arbitrary ID for the device. This value must be unique within the device definition version. Maximum length is 128 characters with pattern [a-zA-Z0-9:_-]+.

Required: Yes

Type: String

Update requires: Replacement

SyncShadow

Indicates whether the device's local shadow is synced with the cloud automatically.

Required: No

Type: Boolean

Update requires: Replacement

ThingArn

The ARN of the device, which is an AWS IoT device (thing).

Required: Yes

Type: String

Update requires: Replacement

See also