AWS::Greengrass::CoreDefinition Core - Amazon CloudFormation
SyntaxPropertiesSee also
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

AWS::Greengrass::CoreDefinition Core

A core is an Amazon IoT device that runs the Amazon IoT Greengrass core software and manages local processes for a Greengrass group. For more information, see What Is Amazon IoT Greengrass? in the Amazon IoT Greengrass Version 1 Developer Guide .

In an Amazon 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 Amazon 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 Amazon IoT and Amazon 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 Amazon IoT device (thing).

Required: Yes

Type: String

Update requires: Replacement

See also