Class: AWSCDK::KinesisFirehose::CfnDeliveryStream::AmazonopensearchserviceRetryOptionsProperty

Inherits:

Jsii::Struct

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

Defined in:

kinesis_firehose/cfn_delivery_stream.rb

Overview

Configures retry behavior in case Kinesis Data Firehose is unable to deliver documents to Amazon OpenSearch Service.

See Also:

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

Instance Attribute Summary

• #duration_in_seconds ⇒ Numeric^? readonly

  After an initial failure to deliver to Amazon OpenSearch Service, the total amount of time during which Kinesis Data Firehose retries delivery (including the first attempt).

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(duration_in_seconds: nil) ⇒ AmazonopensearchserviceRetryOptionsProperty constructor

  A new instance of AmazonopensearchserviceRetryOptionsProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(duration_in_seconds: nil) ⇒ AmazonopensearchserviceRetryOptionsProperty

Returns a new instance of AmazonopensearchserviceRetryOptionsProperty.

Parameters:

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

  After an initial failure to deliver to Amazon OpenSearch Service, the total amount of time during which Kinesis Data Firehose retries delivery (including the first attempt).

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

def initialize(duration_in_seconds: nil)
  @duration_in_seconds = duration_in_seconds
  Jsii::Type.check_type(@duration_in_seconds, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "durationInSeconds") unless @duration_in_seconds.nil?
end

Instance Attribute Details

#duration_in_seconds ⇒ Numeric^? (readonly)

After an initial failure to deliver to Amazon OpenSearch Service, the total amount of time during which Kinesis Data Firehose retries delivery (including the first attempt).

After this time has elapsed, the failed documents are written to Amazon S3. Default value is 300 seconds (5 minutes). A value of 0 (zero) results in no retries.

Returns:

• (Numeric, nil)

See Also:

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

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

def duration_in_seconds
  @duration_in_seconds
end

Class Method Details

.jsii_properties ⇒ Object

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

def self.jsii_properties
  {
    :duration_in_seconds => "durationInSeconds",
  }
end

Instance Method Details

#to_jsii ⇒ Object

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

def to_jsii
  result = {}
  result.merge!({
    "durationInSeconds" => @duration_in_seconds,
  })
  result.compact
end