Package software.amazon.awscdk.services.lambda

Enum LoggingFormat

java.lang.Object

java.lang.Enum<LoggingFormat>

software.amazon.awscdk.services.lambda.LoggingFormat

All Implemented Interfaces:

Serializable, Comparable<LoggingFormat>, java.lang.constant.Constable

@Generated(value="jsii-pacmak/1.103.1 (build bef2dea)",
           date="2024-10-11T15:56:01.148Z")
@Stability(Stable)
public enum LoggingFormat
extends Enum<LoggingFormat>

This field takes in 2 values either Text or JSON.

By setting this value to Text, will result in the current structure of logs format, whereas, by setting this value to JSON, Lambda will print the logs as Structured JSON Logs, with the corresponding timestamp and log level of each event. Selecting ‘JSON’ format will only allow customer’s to have different log level Application log level and the System log level.

Example:

 import software.amazon.awscdk.services.logs.ILogGroup;
 ILogGroup logGroup;
 Function.Builder.create(this, "Lambda")
         .code(new InlineCode("foo"))
         .handler("index.handler")
         .runtime(Runtime.NODEJS_18_X)
         .loggingFormat(LoggingFormat.JSON)
         .systemLogLevelV2(SystemLogLevel.INFO)
         .applicationLogLevelV2(ApplicationLogLevel.INFO)
         .logGroup(logGroup)
         .build();
 

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
JSON	Lambda structured logging in Json format.
TEXT	Lambda Logs text format.

Method Summary

Modifier and Type	Method	Description
static LoggingFormat	valueOf(String name)	Returns the enum constant of this type with the specified name.
static LoggingFormat[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

TEXT

@Stability(Stable)
public static final LoggingFormat TEXT

Lambda Logs text format.

JSON

@Stability(Stable)
public static final LoggingFormat JSON

Lambda structured logging in Json format.

Method Details

values

public static LoggingFormat[] values()

Returns an array containing the constants of this enum type, in the order they are declared.

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static LoggingFormat valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null