Class: AWSCDK::KinesisFirehose::EnableLogging

Inherits:
Jsii::Object
  • Object
show all
Includes:
ILoggingConfig
Defined in:
kinesis_firehose/enable_logging.rb

Overview

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.

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(log_group = nil) ⇒ EnableLogging

Returns a new instance of EnableLogging.

Parameters:

  • log_group (AWSCDK::Logs::ILogGroup, nil) (defaults to: nil) —

    The CloudWatch log group where log streams will be created to hold error logs.



15
16
17
18
 
# File 'kinesis_firehose/enable_logging.rb', line 15

def initialize(log_group = nil)
  Jsii::Type.check_type(log_group, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfbG9ncy5JTG9nR3JvdXAifQ==")), "logGroup") unless log_group.nil?
  Jsii::Object.instance_method(:initialize).bind(self).call(log_group)
end

Class Method Details

.jsii_overridable_methods ⇒ Object 



20
21
22
23
24
25
 
# File 'kinesis_firehose/enable_logging.rb', line 20

def self.jsii_overridable_methods
  {
    :logging => { kind: :property, name: "logging", is_optional: false },
    :log_group => { kind: :property, name: "logGroup", is_optional: true },
  }
end

Instance Method Details

#log_group ⇒ AWSCDK::Logs::ILogGroup?

The CloudWatch log group where log streams will be created to hold error logs.

Returns:



39
40
41
 
# File 'kinesis_firehose/enable_logging.rb', line 39

def log_group()
  jsii_get_property("logGroup")
end

#logging ⇒ Boolean

If true, log errors when data transformation or data delivery fails.

true when using EnableLogging, false when using DisableLogging.

Returns:

  • (Boolean) 


32
33
34
 
# File 'kinesis_firehose/enable_logging.rb', line 32

def logging()
  jsii_get_property("logging")
end