Amazonka.Firehose.Types.HttpEndpointBufferingHints

Documentation

data HttpEndpointBufferingHints

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

• 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).

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

Instances

FromJSON HttpEndpointBufferingHints

Defined in Amazonka.Firehose.Types.HttpEndpointBufferingHints

Methods

parseJSON :: Value -> Parser HttpEndpointBufferingHints

parseJSONList :: Value -> Parser [HttpEndpointBufferingHints]

ToJSON HttpEndpointBufferingHints

Defined in Amazonka.Firehose.Types.HttpEndpointBufferingHints

Methods

toJSON :: HttpEndpointBufferingHints -> Value

toEncoding :: HttpEndpointBufferingHints -> Encoding

toJSONList :: [HttpEndpointBufferingHints] -> Value

toEncodingList :: [HttpEndpointBufferingHints] -> Encoding

Generic HttpEndpointBufferingHints

Defined in Amazonka.Firehose.Types.HttpEndpointBufferingHints

Associated Types

type Rep HttpEndpointBufferingHints :: Type -> Type

Methods

from :: HttpEndpointBufferingHints -> Rep HttpEndpointBufferingHints x

to :: Rep HttpEndpointBufferingHints x -> HttpEndpointBufferingHints

Read HttpEndpointBufferingHints

Defined in Amazonka.Firehose.Types.HttpEndpointBufferingHints

Methods

readsPrec :: Int -> ReadS HttpEndpointBufferingHints

readList :: ReadS [HttpEndpointBufferingHints]

readPrec :: ReadPrec HttpEndpointBufferingHints

readListPrec :: ReadPrec [HttpEndpointBufferingHints]

Show HttpEndpointBufferingHints

Defined in Amazonka.Firehose.Types.HttpEndpointBufferingHints

Methods

showsPrec :: Int -> HttpEndpointBufferingHints -> ShowS

show :: HttpEndpointBufferingHints -> String

showList :: [HttpEndpointBufferingHints] -> ShowS

NFData HttpEndpointBufferingHints

Defined in Amazonka.Firehose.Types.HttpEndpointBufferingHints

Methods

rnf :: HttpEndpointBufferingHints -> ()

Eq HttpEndpointBufferingHints

Defined in Amazonka.Firehose.Types.HttpEndpointBufferingHints

Methods

(==) :: HttpEndpointBufferingHints -> HttpEndpointBufferingHints -> Bool

(/=) :: HttpEndpointBufferingHints -> HttpEndpointBufferingHints -> Bool

Hashable HttpEndpointBufferingHints

Defined in Amazonka.Firehose.Types.HttpEndpointBufferingHints

Methods

hashWithSalt :: Int -> HttpEndpointBufferingHints -> Int

hash :: HttpEndpointBufferingHints -> Int

type Rep HttpEndpointBufferingHints

Defined in Amazonka.Firehose.Types.HttpEndpointBufferingHints

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

newHttpEndpointBufferingHints :: HttpEndpointBufferingHints

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: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).

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

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

httpEndpointBufferingHints_sizeInMBs :: Lens' HttpEndpointBufferingHints (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.