AWS::Greengrass::CoreDefinition Core

A core is an AWS IoT device that runs the AWS IoT Greengrass core software and manages local processes for a Greengrass 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 Cores property of the CoreDefinitionVersion property type contains a list of Core property types. Currently, the list can contain only one core.

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 core. This X.509 certificate is used to authenticate the core with AWS IoT and AWS IoT Greengrass services.

Required: Yes

Type: String

Update requires: Replacement

Id

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

Required: Yes

Type: String

Update requires: Replacement

SyncShadow

Indicates whether the core's local shadow is synced with the cloud automatically. The default is false.

Required: No

Type: Boolean

Update requires: Replacement

ThingArn

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

Required: Yes

Type: String

Update requires: Replacement

See also

• Core in the AWS IoT Greengrass Version 1 API Reference

• AWS IoT Greengrass Version 1 Developer Guide