1.204.0

interface LoggerProperty

LanguageType name
.NETAmazon.CDK.AWS.Greengrass.CfnLoggerDefinition.LoggerProperty
Javasoftware.amazon.awscdk.services.greengrass.CfnLoggerDefinition.LoggerProperty
Pythonaws_cdk.aws_greengrass.CfnLoggerDefinition.LoggerProperty
TypeScript @aws-cdk/aws-greengrass » CfnLoggerDefinition » LoggerProperty

A logger represents logging settings for the AWS 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 AWS IoT Greengrass Logs in the Developer Guide .

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

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as greengrass from '@aws-cdk/aws-greengrass';
const loggerProperty: greengrass.CfnLoggerDefinition.LoggerProperty = {
  component: 'component',
  id: 'id',
  level: 'level',
  type: 'type',

  // the properties below are optional
  space: 123,
};

Properties

NameTypeDescription
componentstringThe source of the log event.
idstringA descriptive or arbitrary ID for the logger.
levelstringThe log-level threshold.
typestringThe storage mechanism for log events.
space?numberThe amount of file space (in KB) to use when writing logs to the local file system.

component

Type: string

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.

id

Type: string

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:_-]+ .

level

Type: string

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 .

type

Type: string

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.

space?

Type: number (optional)

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 .

← PreviousNext →