libZSservicesZSamazonka-kinesis-firehoseZSamazonka-kinesis-firehose
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.Firehose.Types.BufferingHints

Description

 
Synopsis

Documentation

data BufferingHints Source #

Describes hints for the buffering to perform before delivering data to the destination. These options are treated as hints, and therefore Kinesis Data Firehose might choose to use different values when it is optimal. The SizeInMBs and IntervalInSeconds parameters are optional. However, if specify a value for one of them, you must also provide a value for the other.

See: newBufferingHints smart constructor.

Constructors

BufferingHints' 

Fields

  • sizeInMBs :: Maybe Natural

    Buffer incoming data to the specified size, in MiBs, before delivering it to the destination. The default value is 5. This parameter is optional but if you specify a value for it, you must also specify a value for IntervalInSeconds, and vice versa.

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

  • intervalInSeconds :: Maybe Natural

    Buffer incoming data for the specified period of time, in seconds, before delivering it to the destination. The default value is 300. This parameter is optional but if you specify a value for it, you must also specify a value for SizeInMBs, and vice versa.

Instances

Instances details
Eq BufferingHints Source # 
Instance details

Defined in Amazonka.Firehose.Types.BufferingHints

Read BufferingHints Source # 
Instance details

Defined in Amazonka.Firehose.Types.BufferingHints

Show BufferingHints Source # 
Instance details

Defined in Amazonka.Firehose.Types.BufferingHints

Generic BufferingHints Source # 
Instance details

Defined in Amazonka.Firehose.Types.BufferingHints

Associated Types

type Rep BufferingHints :: Type -> Type #

NFData BufferingHints Source # 
Instance details

Defined in Amazonka.Firehose.Types.BufferingHints

Methods

rnf :: BufferingHints -> () #

Hashable BufferingHints Source # 
Instance details

Defined in Amazonka.Firehose.Types.BufferingHints

ToJSON BufferingHints Source # 
Instance details

Defined in Amazonka.Firehose.Types.BufferingHints

FromJSON BufferingHints Source # 
Instance details

Defined in Amazonka.Firehose.Types.BufferingHints

type Rep BufferingHints Source # 
Instance details

Defined in Amazonka.Firehose.Types.BufferingHints

type Rep BufferingHints = D1 ('MetaData "BufferingHints" "Amazonka.Firehose.Types.BufferingHints" "libZSservicesZSamazonka-kinesis-firehoseZSamazonka-kinesis-firehose" 'False) (C1 ('MetaCons "BufferingHints'" 'PrefixI 'True) (S1 ('MetaSel ('Just "sizeInMBs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "intervalInSeconds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))))

newBufferingHints :: BufferingHints Source #

Create a value of BufferingHints with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:sizeInMBs:BufferingHints', bufferingHints_sizeInMBs - Buffer incoming data to the specified size, in MiBs, before delivering it to the destination. The default value is 5. This parameter is optional but if you specify a value for it, you must also specify a value for IntervalInSeconds, and vice versa.

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

$sel:intervalInSeconds:BufferingHints', bufferingHints_intervalInSeconds - Buffer incoming data for the specified period of time, in seconds, before delivering it to the destination. The default value is 300. This parameter is optional but if you specify a value for it, you must also specify a value for SizeInMBs, and vice versa.

bufferingHints_sizeInMBs :: Lens' BufferingHints (Maybe Natural) Source #

Buffer incoming data to the specified size, in MiBs, before delivering it to the destination. The default value is 5. This parameter is optional but if you specify a value for it, you must also specify a value for IntervalInSeconds, and vice versa.

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

bufferingHints_intervalInSeconds :: Lens' BufferingHints (Maybe Natural) Source #

Buffer incoming data for the specified period of time, in seconds, before delivering it to the destination. The default value is 300. This parameter is optional but if you specify a value for it, you must also specify a value for SizeInMBs, and vice versa.