Package software.amazon.awscdk.mixins.preview.services.kinesisfirehose.mixins

Interface CfnDeliveryStreamPropsMixin.AmazonOpenSearchServerlessBufferingHintsProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDeliveryStreamPropsMixin.AmazonOpenSearchServerlessBufferingHintsProperty.Jsii$Proxy

Enclosing class:

CfnDeliveryStreamPropsMixin

@Stability(Stable)
public static interface CfnDeliveryStreamPropsMixin.AmazonOpenSearchServerlessBufferingHintsProperty
extends software.amazon.jsii.JsiiSerializable

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

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.mixins.preview.services.kinesisfirehose.mixins.*;
 AmazonOpenSearchServerlessBufferingHintsProperty amazonOpenSearchServerlessBufferingHintsProperty = AmazonOpenSearchServerlessBufferingHintsProperty.builder()
         .intervalInSeconds(123)
         .sizeInMBs(123)
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnDeliveryStreamPropsMixin.AmazonOpenSearchServerlessBufferingHintsProperty.Builder	A builder for CfnDeliveryStreamPropsMixin.AmazonOpenSearchServerlessBufferingHintsProperty
static final class	CfnDeliveryStreamPropsMixin.AmazonOpenSearchServerlessBufferingHintsProperty.Jsii$Proxy	An implementation for CfnDeliveryStreamPropsMixin.AmazonOpenSearchServerlessBufferingHintsProperty

Method Summary

Modifier and Type	Method	Description
static CfnDeliveryStreamPropsMixin.AmazonOpenSearchServerlessBufferingHintsProperty.Builder	builder()
default Number	getIntervalInSeconds()	Buffer incoming data for the specified period of time, in seconds, before delivering it to the destination.
default Number	getSizeInMBs()	Buffer incoming data to the specified size, in MBs, before delivering it to the destination.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getIntervalInSeconds

@Stability(Stable)
@Nullable
default Number getIntervalInSeconds()

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

The default value is 300 (5 minutes).

See Also:

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

getSizeInMBs

@Stability(Stable)
@Nullable
default Number getSizeInMBs()

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.

See Also:

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

builder

@Stability(Stable)
static CfnDeliveryStreamPropsMixin.AmazonOpenSearchServerlessBufferingHintsProperty.Builder builder()

Returns:

a CfnDeliveryStreamPropsMixin.AmazonOpenSearchServerlessBufferingHintsProperty.Builder of CfnDeliveryStreamPropsMixin.AmazonOpenSearchServerlessBufferingHintsProperty