Package software.amazon.awssdk.services.lambda.model

Class LoggingConfig

java.lang.Object
software.amazon.awssdk.services.lambda.model.LoggingConfig
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<LoggingConfig.Builder,LoggingConfig>
@Generated("software.amazon.awssdk:codegen") public final class LoggingConfig extends Object implements SdkPojo, Serializable, ToCopyableBuilder<LoggingConfig.Builder,LoggingConfig>

The function's Amazon CloudWatch Logs configuration settings.

See Also:

  • Method Details

    • logFormat

      public final LogFormat logFormat()

      The format in which Lambda sends your function's application and system logs to CloudWatch. Select between plain text and structured JSON.

      If the service returns an enum value that is not available in the current SDK version, logFormat will return LogFormat.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from logFormatAsString().

      Returns:
      The format in which Lambda sends your function's application and system logs to CloudWatch. Select between plain text and structured JSON.
      See Also:

    • logFormatAsString

      public final String logFormatAsString()

      The format in which Lambda sends your function's application and system logs to CloudWatch. Select between plain text and structured JSON.

      If the service returns an enum value that is not available in the current SDK version, logFormat will return LogFormat.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from logFormatAsString().

      Returns:
      The format in which Lambda sends your function's application and system logs to CloudWatch. Select between plain text and structured JSON.
      See Also:

    • applicationLogLevel

      public final ApplicationLogLevel applicationLogLevel()

      Set this property to filter the application logs for your function that Lambda sends to CloudWatch. Lambda only sends application logs at the selected level of detail and lower, where TRACE is the highest level and FATAL is the lowest.

      If the service returns an enum value that is not available in the current SDK version, applicationLogLevel will return ApplicationLogLevel.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from applicationLogLevelAsString().

      Returns:
      Set this property to filter the application logs for your function that Lambda sends to CloudWatch. Lambda only sends application logs at the selected level of detail and lower, where TRACE is the highest level and FATAL is the lowest.
      See Also:

    • applicationLogLevelAsString

      public final String applicationLogLevelAsString()

      Set this property to filter the application logs for your function that Lambda sends to CloudWatch. Lambda only sends application logs at the selected level of detail and lower, where TRACE is the highest level and FATAL is the lowest.

      If the service returns an enum value that is not available in the current SDK version, applicationLogLevel will return ApplicationLogLevel.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from applicationLogLevelAsString().

      Returns:
      Set this property to filter the application logs for your function that Lambda sends to CloudWatch. Lambda only sends application logs at the selected level of detail and lower, where TRACE is the highest level and FATAL is the lowest.
      See Also:

    • systemLogLevel

      public final SystemLogLevel systemLogLevel()

      Set this property to filter the system logs for your function that Lambda sends to CloudWatch. Lambda only sends system logs at the selected level of detail and lower, where DEBUG is the highest level and WARN is the lowest.

      If the service returns an enum value that is not available in the current SDK version, systemLogLevel will return SystemLogLevel.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from systemLogLevelAsString().

      Returns:
      Set this property to filter the system logs for your function that Lambda sends to CloudWatch. Lambda only sends system logs at the selected level of detail and lower, where DEBUG is the highest level and WARN is the lowest.
      See Also:

    • systemLogLevelAsString

      public final String systemLogLevelAsString()

      Set this property to filter the system logs for your function that Lambda sends to CloudWatch. Lambda only sends system logs at the selected level of detail and lower, where DEBUG is the highest level and WARN is the lowest.

      If the service returns an enum value that is not available in the current SDK version, systemLogLevel will return SystemLogLevel.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from systemLogLevelAsString().

      Returns:
      Set this property to filter the system logs for your function that Lambda sends to CloudWatch. Lambda only sends system logs at the selected level of detail and lower, where DEBUG is the highest level and WARN is the lowest.
      See Also:

    • logGroup

      public final String logGroup()

      The name of the Amazon CloudWatch log group the function sends logs to. By default, Lambda functions send logs to a default log group named /aws/lambda/<function name>. To use a different log group, enter an existing log group or enter a new log group name.

      Returns:
      The name of the Amazon CloudWatch log group the function sends logs to. By default, Lambda functions send logs to a default log group named /aws/lambda/<function name>. To use a different log group, enter an existing log group or enter a new log group name.

    • toBuilder

      public LoggingConfig.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<LoggingConfig.Builder,LoggingConfig>
      Returns:
      a builder for type T

    • builder

      public static LoggingConfig.Builder builder()

    • serializableBuilderClass

      public static Class<? extends LoggingConfig.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.