Package software.amazon.awscdk.services.greengrass

Interface CfnLoggerDefinition.LoggerProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnLoggerDefinition.LoggerProperty.Jsii$Proxy

Enclosing class:

CfnLoggerDefinition

@Stability(Stable)
public static interface CfnLoggerDefinition.LoggerProperty
extends software.amazon.jsii.JsiiSerializable

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 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();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-loggerdefinition-logger.html

Nested Class Summary

Nested Classes

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

Method Summary

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getComponent

@Stability(Stable)
@NotNull
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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-loggerdefinition-logger.html#cfn-greengrass-loggerdefinition-logger-component

getId

@Stability(Stable)
@NotNull
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:_-]+ .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-loggerdefinition-logger.html#cfn-greengrass-loggerdefinition-logger-id

getLevel

@Stability(Stable)
@NotNull
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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-loggerdefinition-logger.html#cfn-greengrass-loggerdefinition-logger-level

getType

@Stability(Stable)
@NotNull
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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-loggerdefinition-logger.html#cfn-greengrass-loggerdefinition-logger-type

getSpace

@Stability(Stable)
@Nullable
default 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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-loggerdefinition-logger.html#cfn-greengrass-loggerdefinition-logger-space

builder

@Stability(Stable)
static CfnLoggerDefinition.LoggerProperty.Builder builder()

Returns:

a CfnLoggerDefinition.LoggerProperty.Builder of CfnLoggerDefinition.LoggerProperty