software.amazon.awscdk.services.greengrass

Interface CfnLoggerDefinitionVersion.LoggerProperty

All Known Implementing Classes:

CfnLoggerDefinitionVersion.LoggerProperty.Jsii$Proxy

Enclosing class:

CfnLoggerDefinitionVersion

public static interface CfnLoggerDefinitionVersion.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 AWS::Greengrass::LoggerDefinitionVersion resource 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 software.amazon.awscdk.services.greengrass.*;
 LoggerProperty loggerProperty = LoggerProperty.builder()
         .component("component")
         .id("id")
         .level("level")
         .type("type")
         // the properties below are optional
         .space(123)
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CfnLoggerDefinitionVersion.LoggerProperty.Builder A builder for CfnLoggerDefinitionVersion.LoggerProperty
static class	CfnLoggerDefinitionVersion.LoggerProperty.Jsii$Proxy An implementation for CfnLoggerDefinitionVersion.LoggerProperty

Method Summary

Modifier and Type	Method and Description
static CfnLoggerDefinitionVersion.LoggerProperty.Builder	builder()
java.lang.String	getComponent() The source of the log event.
java.lang.String	getId() A descriptive or arbitrary ID for the logger.
java.lang.String	getLevel() The log-level threshold.
default java.lang.Number	getSpace() The amount of file space (in KB) to use when writing logs to the local file system.
java.lang.String	getType() The storage mechanism for log events.

Method Detail

getComponent

java.lang.String getComponent()

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.

getId

java.lang.String getId()

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

getLevel

java.lang.String getLevel()

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 .

getType

java.lang.String getType()

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.

getSpace

default java.lang.Number getSpace()

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 .

builder

static CfnLoggerDefinitionVersion.LoggerProperty.Builder builder()

Returns:

a CfnLoggerDefinitionVersion.LoggerProperty.Builder of CfnLoggerDefinitionVersion.LoggerProperty