Class: AWSCDK::KinesisFirehose::CfnDeliveryStream::CloudWatchLoggingOptionsProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
kinesis_firehose/cfn_delivery_stream.rb

Overview

The CloudWatchLoggingOptions property type specifies Amazon CloudWatch Logs (CloudWatch Logs) logging options that Amazon Kinesis Data Firehose (Kinesis Data Firehose) uses for the delivery stream.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(enabled: nil, log_group_name: nil, log_stream_name: nil) ⇒ CloudWatchLoggingOptionsProperty

Returns a new instance of CloudWatchLoggingOptionsProperty.

Parameters:

  • enabled (Boolean, AWSCDK::IResolvable, nil) (defaults to: nil) —

    Indicates whether CloudWatch Logs logging is enabled.

  • log_group_name (String, nil) (defaults to: nil) —

    The name of the CloudWatch Logs log group that contains the log stream that Kinesis Data Firehose will use.

  • log_stream_name (String, nil) (defaults to: nil) —

    The name of the CloudWatch Logs log stream that Kinesis Data Firehose uses to send logs about data delivery.



1384
1385
1386
1387
1388
1389
1390
1391
 
# File 'kinesis_firehose/cfn_delivery_stream.rb', line 1384

def initialize(enabled: nil, log_group_name: nil, log_stream_name: nil)
  @enabled = enabled
  Jsii::Type.check_type(@enabled, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "enabled") unless @enabled.nil?
  @log_group_name = log_group_name
  Jsii::Type.check_type(@log_group_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "logGroupName") unless @log_group_name.nil?
  @log_stream_name = log_stream_name
  Jsii::Type.check_type(@log_stream_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "logStreamName") unless @log_stream_name.nil?
end

Instance Attribute Details

#enabled ⇒ Boolean, ... (readonly)

Indicates whether CloudWatch Logs logging is enabled.

Returns:

See Also:



1397
1398
1399
 
# File 'kinesis_firehose/cfn_delivery_stream.rb', line 1397

def enabled
  @enabled
end

#log_group_name ⇒ String? (readonly)

The name of the CloudWatch Logs log group that contains the log stream that Kinesis Data Firehose will use.

Conditional. If you enable logging, you must specify this property.

Returns:

  • (String, nil)

See Also:



1404
1405
1406
 
# File 'kinesis_firehose/cfn_delivery_stream.rb', line 1404

def log_group_name
  @log_group_name
end

#log_stream_name ⇒ String? (readonly)

The name of the CloudWatch Logs log stream that Kinesis Data Firehose uses to send logs about data delivery.

Conditional. If you enable logging, you must specify this property.

Returns:

  • (String, nil)

See Also:



1411
1412
1413
 
# File 'kinesis_firehose/cfn_delivery_stream.rb', line 1411

def log_stream_name
  @log_stream_name
end

Class Method Details

.jsii_properties ⇒ Object 



1413
1414
1415
1416
1417
1418
1419
 
# File 'kinesis_firehose/cfn_delivery_stream.rb', line 1413

def self.jsii_properties
  {
    :enabled => "enabled",
    :log_group_name => "logGroupName",
    :log_stream_name => "logStreamName",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



1421
1422
1423
1424
1425
1426
1427
1428
1429
 
# File 'kinesis_firehose/cfn_delivery_stream.rb', line 1421

def to_jsii
  result = {}
  result.merge!({
    "enabled" => @enabled,
    "logGroupName" => @log_group_name,
    "logStreamName" => @log_stream_name,
  })
  result.compact
end