Package software.amazon.awscdk.services.kinesisfirehose

Class EnableLogging

java.lang.Object
software.amazon.jsii.JsiiObject
software.amazon.awscdk.services.kinesisfirehose.EnableLogging
All Implemented Interfaces:
ILoggingConfig, software.amazon.jsii.JsiiSerializable
@Generated(value="jsii-pacmak/1.118.0 (build 02eec31)", date="2025-11-04T09:27:44.134Z") @Stability(Stable) public class EnableLogging extends software.amazon.jsii.JsiiObject implements ILoggingConfig
Enables logging for error logs with an optional custom CloudWatch log group.

When this class is used, logging is enabled (logging: true) and you can optionally provide a CloudWatch log group for storing the error logs.

If no log group is provided, a default one will be created automatically.

Example: 

 import software.amazon.awscdk.services.logs.*;
 Bucket bucket;
 LogGroup logGroup = new LogGroup(this, "Log Group");
 S3Bucket destination = S3Bucket.Builder.create(bucket)
         .loggingConfig(new EnableLogging(logGroup))
         .build();
 DeliveryStream.Builder.create(this, "Delivery Stream")
         .destination(destination)
         .build();

  • Nested Class Summary

    Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

    software.amazon.jsii.JsiiObject.InitializationMode

    Nested classes/interfaces inherited from interface software.amazon.awscdk.services.kinesisfirehose.ILoggingConfig

    ILoggingConfig.Jsii$Default, ILoggingConfig.Jsii$Proxy

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
     
    EnableLogging()
     
     
    EnableLogging(ILogGroup logGroup)
     
    protected
    EnableLogging(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
     
    protected
    EnableLogging(software.amazon.jsii.JsiiObjectRef objRef)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    Boolean
    getLogging()
    If true, log errors when data transformation or data delivery fails.
    ILogGroup
    getLogGroup()
    The CloudWatch log group where log streams will be created to hold error logs.

    Methods inherited from class software.amazon.jsii.JsiiObject

    jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    Methods inherited from interface software.amazon.jsii.JsiiSerializable

    $jsii$toJson

  • Constructor Details

    • EnableLogging

      protected EnableLogging(software.amazon.jsii.JsiiObjectRef objRef)

    • EnableLogging

      protected EnableLogging(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • EnableLogging

      @Stability(Stable) public EnableLogging(@Nullable ILogGroup logGroup)
      Parameters:
      logGroup - The CloudWatch log group where log streams will be created to hold error logs.

    • EnableLogging

      @Stability(Stable) public EnableLogging()

  • Method Details

    • getLogging

      @Stability(Stable) @NotNull public Boolean getLogging()
      If true, log errors when data transformation or data delivery fails.

      true when using EnableLogging, false when using DisableLogging.

      Specified by:
      getLogging in interface ILoggingConfig

    • getLogGroup

      @Stability(Stable) @Nullable public ILogGroup getLogGroup()
      The CloudWatch log group where log streams will be created to hold error logs.
      Specified by:
      getLogGroup in interface ILoggingConfig