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.HttpEndpointBufferingHints

Description

 
Synopsis

Documentation

data HttpEndpointBufferingHints Source #

Describes the buffering options that can be applied before data is delivered to the HTTP endpoint destination. Kinesis Data Firehose treats these options as hints, and it might choose to use more optimal values. 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: newHttpEndpointBufferingHints smart constructor.

Constructors

HttpEndpointBufferingHints' 

Fields

  • sizeInMBs :: Maybe Natural

    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 delivery stream in 10 seconds. For example, if you typically ingest data at 1 MB/sec, the value should be 10 MB 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 (5 minutes).

Instances

Instances details
Eq HttpEndpointBufferingHints Source # 
Instance details

Defined in Amazonka.Firehose.Types.HttpEndpointBufferingHints

Read HttpEndpointBufferingHints Source # 
Instance details

Defined in Amazonka.Firehose.Types.HttpEndpointBufferingHints

Show HttpEndpointBufferingHints Source # 
Instance details

Defined in Amazonka.Firehose.Types.HttpEndpointBufferingHints

Generic HttpEndpointBufferingHints Source # 
Instance details

Defined in Amazonka.Firehose.Types.HttpEndpointBufferingHints

Associated Types

type Rep HttpEndpointBufferingHints :: Type -> Type #

NFData HttpEndpointBufferingHints Source # 
Instance details

Defined in Amazonka.Firehose.Types.HttpEndpointBufferingHints

Hashable HttpEndpointBufferingHints Source # 
Instance details

Defined in Amazonka.Firehose.Types.HttpEndpointBufferingHints

ToJSON HttpEndpointBufferingHints Source # 
Instance details

Defined in Amazonka.Firehose.Types.HttpEndpointBufferingHints

FromJSON HttpEndpointBufferingHints Source # 
Instance details

Defined in Amazonka.Firehose.Types.HttpEndpointBufferingHints

type Rep HttpEndpointBufferingHints Source # 
Instance details

Defined in Amazonka.Firehose.Types.HttpEndpointBufferingHints

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

newHttpEndpointBufferingHints :: HttpEndpointBufferingHints Source #

Create a value of HttpEndpointBufferingHints 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:HttpEndpointBufferingHints', httpEndpointBufferingHints_sizeInMBs - 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 delivery stream in 10 seconds. For example, if you typically ingest data at 1 MB/sec, the value should be 10 MB or higher.

$sel:intervalInSeconds:HttpEndpointBufferingHints', httpEndpointBufferingHints_intervalInSeconds - Buffer incoming data for the specified period of time, in seconds, before delivering it to the destination. The default value is 300 (5 minutes).

httpEndpointBufferingHints_sizeInMBs :: Lens' HttpEndpointBufferingHints (Maybe Natural) Source #

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 delivery stream in 10 seconds. For example, if you typically ingest data at 1 MB/sec, the value should be 10 MB or higher.

httpEndpointBufferingHints_intervalInSeconds :: Lens' HttpEndpointBufferingHints (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 (5 minutes).