AWS::Greengrass::LoggerDefinition Logger - 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::LoggerDefinition Logger

A logger represents logging settings for the Amazon IoT Greengrass group, which can be stored in CloudWatch and the local file system of your core device. All log entries include a timestamp, log level, and information about the event. For more information, see Monitoring with Amazon IoT Greengrass Logs in the Amazon IoT Greengrass Version 1 Developer Guide .

In an Amazon CloudFormation template, the Loggers property of the LoggerDefinitionVersion property type contains a list of Logger property types.

Syntax

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

JSON

{
  "Component" : String,
  "Id" : String,
  "Level" : String,
  "Space" : Integer,
  "Type" : String
}

YAML

  Component: String
  Id: String
  Level: String
  Space: Integer
  Type: String

Properties

Component

The source of the log event. Valid values are GreengrassSystem or Lambda. When GreengrassSystem is used, events from Greengrass system components are logged. When Lambda is used, events from user-defined Lambda functions are logged.

Required: Yes

Type: String

Update requires: Replacement

Id

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

Required: Yes

Type: String

Update requires: Replacement

Level

The log-level threshold. Log events below this threshold are filtered out and aren't stored. Valid values are DEBUG, INFO (recommended), WARN, ERROR, or FATAL.

Required: Yes

Type: String

Update requires: Replacement

Space

The amount of file space (in KB) to use when writing logs to the local file system. This property does not apply for CloudWatch Logs.

Required: No

Type: Integer

Update requires: Replacement

Type

The storage mechanism for log events. Valid values are FileSystem or AWSCloudWatch. When AWSCloudWatch is used, log events are sent to CloudWatch Logs. When FileSystem is used, log events are stored on the local file system.

Required: Yes

Type: String

Update requires: Replacement

See also