Class: AWSCDK::KinesisFirehose::CfnDeliveryStream::AmazonOpenSearchServerlessBufferingHintsProperty

Inherits:

Jsii::Struct

• Object
• Jsii::Struct
• AWSCDK::KinesisFirehose::CfnDeliveryStream::AmazonOpenSearchServerlessBufferingHintsProperty

Defined in:

kinesis_firehose/cfn_delivery_stream.rb

Overview

Describes the buffering to perform before delivering data to the Serverless offering for Amazon OpenSearch Service destination.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-amazonopensearchserverlessbufferinghints.html

Instance Attribute Summary

• #interval_in_seconds ⇒ Numeric^? readonly

  Buffer incoming data for the specified period of time, in seconds, before delivering it to the destination.

• #size_in_m_bs ⇒ Numeric^? readonly

  Buffer incoming data to the specified size, in MBs, before delivering it to the destination.

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(interval_in_seconds: nil, size_in_m_bs: nil) ⇒ AmazonOpenSearchServerlessBufferingHintsProperty constructor

  A new instance of AmazonOpenSearchServerlessBufferingHintsProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(interval_in_seconds: nil, size_in_m_bs: nil) ⇒ AmazonOpenSearchServerlessBufferingHintsProperty

Returns a new instance of AmazonOpenSearchServerlessBufferingHintsProperty.

Parameters:

• interval_in_seconds (Numeric, nil) (defaults to: nil) —

  Buffer incoming data for the specified period of time, in seconds, before delivering it to the destination.

• size_in_m_bs (Numeric, nil) (defaults to: nil) —

  Buffer incoming data to the specified size, in MBs, before delivering it to the destination.

# File 'kinesis_firehose/cfn_delivery_stream.rb', line 784

def initialize(interval_in_seconds: nil, size_in_m_bs: nil)
  @interval_in_seconds = interval_in_seconds
  Jsii::Type.check_type(@interval_in_seconds, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "intervalInSeconds") unless @interval_in_seconds.nil?
  @size_in_m_bs = size_in_m_bs
  Jsii::Type.check_type(@size_in_m_bs, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "sizeInMBs") unless @size_in_m_bs.nil?
end

Instance Attribute Details

#interval_in_seconds ⇒ Numeric^? (readonly)

Buffer incoming data for the specified period of time, in seconds, before delivering it to the destination.

The default value is 300 (5 minutes).

Returns:

• (Numeric, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-amazonopensearchserverlessbufferinghints.html#cfn-kinesisfirehose-deliverystream-amazonopensearchserverlessbufferinghints-intervalinseconds

# File 'kinesis_firehose/cfn_delivery_stream.rb', line 797

def interval_in_seconds
  @interval_in_seconds
end

#size_in_m_bs ⇒ Numeric^? (readonly)

Buffer incoming data to the specified size, in MBs, before delivering it to the destination.

The default value is 5.

We recommend setting this parameter to a value greater than the amount of data you typically ingest into the Firehose stream in 10 seconds. For example, if you typically ingest data at 1 MB/sec, the value should be 10 MB or higher.

Returns:

• (Numeric, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-amazonopensearchserverlessbufferinghints.html#cfn-kinesisfirehose-deliverystream-amazonopensearchserverlessbufferinghints-sizeinmbs

# File 'kinesis_firehose/cfn_delivery_stream.rb', line 806

def size_in_m_bs
  @size_in_m_bs
end

Class Method Details

.jsii_properties ⇒ Object

# File 'kinesis_firehose/cfn_delivery_stream.rb', line 808

def self.jsii_properties
  {
    :interval_in_seconds => "intervalInSeconds",
    :size_in_m_bs => "sizeInMBs",
  }
end

Instance Method Details

#to_jsii ⇒ Object

# File 'kinesis_firehose/cfn_delivery_stream.rb', line 815

def to_jsii
  result = {}
  result.merge!({
    "intervalInSeconds" => @interval_in_seconds,
    "sizeInMBs" => @size_in_m_bs,
  })
  result.compact
end