Class: AWSCDK::IoTEvents::CfnDetectorModel::FirehoseProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
io_t_events/cfn_detector_model.rb

Overview

Sends information about the detector model instance and the event that triggered the action to an Amazon Kinesis Data Firehose delivery stream.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(delivery_stream_name:, payload: nil, separator: nil) ⇒ FirehoseProperty

Returns a new instance of FirehoseProperty.

Parameters:

  • delivery_stream_name (String) —

    The name of the Kinesis Data Firehose delivery stream where the data is written.

  • payload (AWSCDK::IResolvable, AWSCDK::IoTEvents::CfnDetectorModel::PayloadProperty, nil) (defaults to: nil) —

    You can configure the action payload when you send a message to an Amazon Data Firehose delivery stream.

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

    A character separator that is used to separate records written to the Kinesis Data Firehose delivery stream.



1354
1355
1356
1357
1358
1359
1360
1361
 
# File 'io_t_events/cfn_detector_model.rb', line 1354

def initialize(delivery_stream_name:, payload: nil, separator: nil)
  @delivery_stream_name = delivery_stream_name
  Jsii::Type.check_type(@delivery_stream_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "deliveryStreamName")
  @payload = payload.is_a?(Hash) ? ::AWSCDK::IoTEvents::CfnDetectorModel::PayloadProperty.new(**payload.transform_keys(&:to_sym)) : payload
  Jsii::Type.check_type(@payload, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19pb3RldmVudHMuQ2ZuRGV0ZWN0b3JNb2RlbC5QYXlsb2FkUHJvcGVydHkifV19fQ==")), "payload") unless @payload.nil?
  @separator = separator
  Jsii::Type.check_type(@separator, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "separator") unless @separator.nil?
end

Instance Attribute Details

#delivery_stream_name ⇒ String (readonly)

The name of the Kinesis Data Firehose delivery stream where the data is written.

Returns:

  • (String)

See Also:



1367
1368
1369
 
# File 'io_t_events/cfn_detector_model.rb', line 1367

def delivery_stream_name
  @delivery_stream_name
end

#payload ⇒ AWSCDK::IResolvable, ... (readonly)

You can configure the action payload when you send a message to an Amazon Data Firehose delivery stream.

Returns:

See Also:



1372
1373
1374
 
# File 'io_t_events/cfn_detector_model.rb', line 1372

def payload
  @payload
end

#separator ⇒ String? (readonly)

A character separator that is used to separate records written to the Kinesis Data Firehose delivery stream.

Valid values are: '\n' (newline), '\t' (tab), '\r\n' (Windows newline), ',' (comma).

Returns:

  • (String, nil)

See Also:



1379
1380
1381
 
# File 'io_t_events/cfn_detector_model.rb', line 1379

def separator
  @separator
end

Class Method Details

.jsii_properties ⇒ Object 



1381
1382
1383
1384
1385
1386
1387
 
# File 'io_t_events/cfn_detector_model.rb', line 1381

def self.jsii_properties
  {
    :delivery_stream_name => "deliveryStreamName",
    :payload => "payload",
    :separator => "separator",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



1389
1390
1391
1392
1393
1394
1395
1396
1397
 
# File 'io_t_events/cfn_detector_model.rb', line 1389

def to_jsii
  result = {}
  result.merge!({
    "deliveryStreamName" => @delivery_stream_name,
    "payload" => @payload,
    "separator" => @separator,
  })
  result.compact
end