Amazonka.Firehose.Types.BufferingHints

Documentation

data BufferingHints

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

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

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

Instances

FromJSON BufferingHints

Defined in Amazonka.Firehose.Types.BufferingHints

Methods

parseJSON :: Value -> Parser BufferingHints

parseJSONList :: Value -> Parser [BufferingHints]

ToJSON BufferingHints

Defined in Amazonka.Firehose.Types.BufferingHints

Methods

toJSON :: BufferingHints -> Value

toEncoding :: BufferingHints -> Encoding

toJSONList :: [BufferingHints] -> Value

toEncodingList :: [BufferingHints] -> Encoding

Generic BufferingHints

Defined in Amazonka.Firehose.Types.BufferingHints

Associated Types

type Rep BufferingHints :: Type -> Type

Methods

from :: BufferingHints -> Rep BufferingHints x

to :: Rep BufferingHints x -> BufferingHints

Read BufferingHints

Defined in Amazonka.Firehose.Types.BufferingHints

Methods

readsPrec :: Int -> ReadS BufferingHints

readList :: ReadS [BufferingHints]

readPrec :: ReadPrec BufferingHints

readListPrec :: ReadPrec [BufferingHints]

Show BufferingHints

Defined in Amazonka.Firehose.Types.BufferingHints

Methods

showsPrec :: Int -> BufferingHints -> ShowS

show :: BufferingHints -> String

showList :: [BufferingHints] -> ShowS

NFData BufferingHints

Defined in Amazonka.Firehose.Types.BufferingHints

Methods

rnf :: BufferingHints -> ()

Eq BufferingHints

Defined in Amazonka.Firehose.Types.BufferingHints

Methods

(==) :: BufferingHints -> BufferingHints -> Bool

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

Hashable BufferingHints

Defined in Amazonka.Firehose.Types.BufferingHints

Methods

hashWithSalt :: Int -> BufferingHints -> Int

hash :: BufferingHints -> Int

type Rep BufferingHints

Defined in Amazonka.Firehose.Types.BufferingHints

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

newBufferingHints :: BufferingHints

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

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

bufferingHints_intervalInSeconds :: Lens' BufferingHints (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.

bufferingHints_sizeInMBs :: Lens' BufferingHints (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.