amazonka-kinesis-firehose-2.0: Amazon Kinesis Firehose SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.Firehose.Types

Contents

Description

 
Synopsis

Service Configuration

defaultService :: Service Source #

API version 2015-08-04 of the Amazon Kinesis Firehose SDK configuration.

Errors

_ConcurrentModificationException :: AsError a => Fold a ServiceError Source #

Another modification has already happened. Fetch VersionId again and use it to update the destination.

_InvalidArgumentException :: AsError a => Fold a ServiceError Source #

The specified input parameter has a value that is not valid.

_InvalidKMSResourceException :: AsError a => Fold a ServiceError Source #

Kinesis Data Firehose throws this exception when an attempt to put records or to start or stop delivery stream encryption fails. This happens when the KMS service throws one of the following exception types: AccessDeniedException, InvalidStateException, DisabledException, or NotFoundException.

_LimitExceededException :: AsError a => Fold a ServiceError Source #

You have already reached the limit for a requested resource.

_ResourceInUseException :: AsError a => Fold a ServiceError Source #

The resource is already in use and not available for this operation.

_ResourceNotFoundException :: AsError a => Fold a ServiceError Source #

The specified resource could not be found.

_ServiceUnavailableException :: AsError a => Fold a ServiceError Source #

The service is unavailable. Back off and retry the operation. If you continue to see the exception, throughput limits for the delivery stream may have been exceeded. For more information about limits and how to request an increase, see Amazon Kinesis Data Firehose Limits.

AmazonOpenSearchServerlessS3BackupMode

newtype AmazonOpenSearchServerlessS3BackupMode Source #

Instances

Instances details
FromJSON AmazonOpenSearchServerlessS3BackupMode Source # 
Instance details

Defined in Amazonka.Firehose.Types.AmazonOpenSearchServerlessS3BackupMode

FromJSONKey AmazonOpenSearchServerlessS3BackupMode Source # 
Instance details

Defined in Amazonka.Firehose.Types.AmazonOpenSearchServerlessS3BackupMode

ToJSON AmazonOpenSearchServerlessS3BackupMode Source # 
Instance details

Defined in Amazonka.Firehose.Types.AmazonOpenSearchServerlessS3BackupMode

ToJSONKey AmazonOpenSearchServerlessS3BackupMode Source # 
Instance details

Defined in Amazonka.Firehose.Types.AmazonOpenSearchServerlessS3BackupMode

ToByteString AmazonOpenSearchServerlessS3BackupMode Source # 
Instance details

Defined in Amazonka.Firehose.Types.AmazonOpenSearchServerlessS3BackupMode

ToHeader AmazonOpenSearchServerlessS3BackupMode Source # 
Instance details

Defined in Amazonka.Firehose.Types.AmazonOpenSearchServerlessS3BackupMode

ToLog AmazonOpenSearchServerlessS3BackupMode Source # 
Instance details

Defined in Amazonka.Firehose.Types.AmazonOpenSearchServerlessS3BackupMode

ToQuery AmazonOpenSearchServerlessS3BackupMode Source # 
Instance details

Defined in Amazonka.Firehose.Types.AmazonOpenSearchServerlessS3BackupMode

FromText AmazonOpenSearchServerlessS3BackupMode Source # 
Instance details

Defined in Amazonka.Firehose.Types.AmazonOpenSearchServerlessS3BackupMode

ToText AmazonOpenSearchServerlessS3BackupMode Source # 
Instance details

Defined in Amazonka.Firehose.Types.AmazonOpenSearchServerlessS3BackupMode

FromXML AmazonOpenSearchServerlessS3BackupMode Source # 
Instance details

Defined in Amazonka.Firehose.Types.AmazonOpenSearchServerlessS3BackupMode

ToXML AmazonOpenSearchServerlessS3BackupMode Source # 
Instance details

Defined in Amazonka.Firehose.Types.AmazonOpenSearchServerlessS3BackupMode

Generic AmazonOpenSearchServerlessS3BackupMode Source # 
Instance details

Defined in Amazonka.Firehose.Types.AmazonOpenSearchServerlessS3BackupMode

Read AmazonOpenSearchServerlessS3BackupMode Source # 
Instance details

Defined in Amazonka.Firehose.Types.AmazonOpenSearchServerlessS3BackupMode

Show AmazonOpenSearchServerlessS3BackupMode Source # 
Instance details

Defined in Amazonka.Firehose.Types.AmazonOpenSearchServerlessS3BackupMode

NFData AmazonOpenSearchServerlessS3BackupMode Source # 
Instance details

Defined in Amazonka.Firehose.Types.AmazonOpenSearchServerlessS3BackupMode

Eq AmazonOpenSearchServerlessS3BackupMode Source # 
Instance details

Defined in Amazonka.Firehose.Types.AmazonOpenSearchServerlessS3BackupMode

Ord AmazonOpenSearchServerlessS3BackupMode Source # 
Instance details

Defined in Amazonka.Firehose.Types.AmazonOpenSearchServerlessS3BackupMode

Hashable AmazonOpenSearchServerlessS3BackupMode Source # 
Instance details

Defined in Amazonka.Firehose.Types.AmazonOpenSearchServerlessS3BackupMode

type Rep AmazonOpenSearchServerlessS3BackupMode Source # 
Instance details

Defined in Amazonka.Firehose.Types.AmazonOpenSearchServerlessS3BackupMode

type Rep AmazonOpenSearchServerlessS3BackupMode = D1 ('MetaData "AmazonOpenSearchServerlessS3BackupMode" "Amazonka.Firehose.Types.AmazonOpenSearchServerlessS3BackupMode" "amazonka-kinesis-firehose-2.0-6l1hHmh2UnHBvolxuQFkWB" 'True) (C1 ('MetaCons "AmazonOpenSearchServerlessS3BackupMode'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromAmazonOpenSearchServerlessS3BackupMode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

AmazonopensearchserviceIndexRotationPeriod

newtype AmazonopensearchserviceIndexRotationPeriod Source #

Instances

Instances details
FromJSON AmazonopensearchserviceIndexRotationPeriod Source # 
Instance details

Defined in Amazonka.Firehose.Types.AmazonopensearchserviceIndexRotationPeriod

FromJSONKey AmazonopensearchserviceIndexRotationPeriod Source # 
Instance details

Defined in Amazonka.Firehose.Types.AmazonopensearchserviceIndexRotationPeriod

ToJSON AmazonopensearchserviceIndexRotationPeriod Source # 
Instance details

Defined in Amazonka.Firehose.Types.AmazonopensearchserviceIndexRotationPeriod

ToJSONKey AmazonopensearchserviceIndexRotationPeriod Source # 
Instance details

Defined in Amazonka.Firehose.Types.AmazonopensearchserviceIndexRotationPeriod

ToByteString AmazonopensearchserviceIndexRotationPeriod Source # 
Instance details

Defined in Amazonka.Firehose.Types.AmazonopensearchserviceIndexRotationPeriod

ToHeader AmazonopensearchserviceIndexRotationPeriod Source # 
Instance details

Defined in Amazonka.Firehose.Types.AmazonopensearchserviceIndexRotationPeriod

ToLog AmazonopensearchserviceIndexRotationPeriod Source # 
Instance details

Defined in Amazonka.Firehose.Types.AmazonopensearchserviceIndexRotationPeriod

ToQuery AmazonopensearchserviceIndexRotationPeriod Source # 
Instance details

Defined in Amazonka.Firehose.Types.AmazonopensearchserviceIndexRotationPeriod

FromText AmazonopensearchserviceIndexRotationPeriod Source # 
Instance details

Defined in Amazonka.Firehose.Types.AmazonopensearchserviceIndexRotationPeriod

ToText AmazonopensearchserviceIndexRotationPeriod Source # 
Instance details

Defined in Amazonka.Firehose.Types.AmazonopensearchserviceIndexRotationPeriod

FromXML AmazonopensearchserviceIndexRotationPeriod Source # 
Instance details

Defined in Amazonka.Firehose.Types.AmazonopensearchserviceIndexRotationPeriod

ToXML AmazonopensearchserviceIndexRotationPeriod Source # 
Instance details

Defined in Amazonka.Firehose.Types.AmazonopensearchserviceIndexRotationPeriod

Generic AmazonopensearchserviceIndexRotationPeriod Source # 
Instance details

Defined in Amazonka.Firehose.Types.AmazonopensearchserviceIndexRotationPeriod

Read AmazonopensearchserviceIndexRotationPeriod Source # 
Instance details

Defined in Amazonka.Firehose.Types.AmazonopensearchserviceIndexRotationPeriod

Show AmazonopensearchserviceIndexRotationPeriod Source # 
Instance details

Defined in Amazonka.Firehose.Types.AmazonopensearchserviceIndexRotationPeriod

NFData AmazonopensearchserviceIndexRotationPeriod Source # 
Instance details

Defined in Amazonka.Firehose.Types.AmazonopensearchserviceIndexRotationPeriod

Eq AmazonopensearchserviceIndexRotationPeriod Source # 
Instance details

Defined in Amazonka.Firehose.Types.AmazonopensearchserviceIndexRotationPeriod

Ord AmazonopensearchserviceIndexRotationPeriod Source # 
Instance details

Defined in Amazonka.Firehose.Types.AmazonopensearchserviceIndexRotationPeriod

Hashable AmazonopensearchserviceIndexRotationPeriod Source # 
Instance details

Defined in Amazonka.Firehose.Types.AmazonopensearchserviceIndexRotationPeriod

type Rep AmazonopensearchserviceIndexRotationPeriod Source # 
Instance details

Defined in Amazonka.Firehose.Types.AmazonopensearchserviceIndexRotationPeriod

type Rep AmazonopensearchserviceIndexRotationPeriod = D1 ('MetaData "AmazonopensearchserviceIndexRotationPeriod" "Amazonka.Firehose.Types.AmazonopensearchserviceIndexRotationPeriod" "amazonka-kinesis-firehose-2.0-6l1hHmh2UnHBvolxuQFkWB" 'True) (C1 ('MetaCons "AmazonopensearchserviceIndexRotationPeriod'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromAmazonopensearchserviceIndexRotationPeriod") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

AmazonopensearchserviceS3BackupMode

newtype AmazonopensearchserviceS3BackupMode Source #

Instances

Instances details
FromJSON AmazonopensearchserviceS3BackupMode Source # 
Instance details

Defined in Amazonka.Firehose.Types.AmazonopensearchserviceS3BackupMode

FromJSONKey AmazonopensearchserviceS3BackupMode Source # 
Instance details

Defined in Amazonka.Firehose.Types.AmazonopensearchserviceS3BackupMode

ToJSON AmazonopensearchserviceS3BackupMode Source # 
Instance details

Defined in Amazonka.Firehose.Types.AmazonopensearchserviceS3BackupMode

ToJSONKey AmazonopensearchserviceS3BackupMode Source # 
Instance details

Defined in Amazonka.Firehose.Types.AmazonopensearchserviceS3BackupMode

ToByteString AmazonopensearchserviceS3BackupMode Source # 
Instance details

Defined in Amazonka.Firehose.Types.AmazonopensearchserviceS3BackupMode

ToHeader AmazonopensearchserviceS3BackupMode Source # 
Instance details

Defined in Amazonka.Firehose.Types.AmazonopensearchserviceS3BackupMode

ToLog AmazonopensearchserviceS3BackupMode Source # 
Instance details

Defined in Amazonka.Firehose.Types.AmazonopensearchserviceS3BackupMode

ToQuery AmazonopensearchserviceS3BackupMode Source # 
Instance details

Defined in Amazonka.Firehose.Types.AmazonopensearchserviceS3BackupMode

FromText AmazonopensearchserviceS3BackupMode Source # 
Instance details

Defined in Amazonka.Firehose.Types.AmazonopensearchserviceS3BackupMode

ToText AmazonopensearchserviceS3BackupMode Source # 
Instance details

Defined in Amazonka.Firehose.Types.AmazonopensearchserviceS3BackupMode

FromXML AmazonopensearchserviceS3BackupMode Source # 
Instance details

Defined in Amazonka.Firehose.Types.AmazonopensearchserviceS3BackupMode

ToXML AmazonopensearchserviceS3BackupMode Source # 
Instance details

Defined in Amazonka.Firehose.Types.AmazonopensearchserviceS3BackupMode

Generic AmazonopensearchserviceS3BackupMode Source # 
Instance details

Defined in Amazonka.Firehose.Types.AmazonopensearchserviceS3BackupMode

Read AmazonopensearchserviceS3BackupMode Source # 
Instance details

Defined in Amazonka.Firehose.Types.AmazonopensearchserviceS3BackupMode

Show AmazonopensearchserviceS3BackupMode Source # 
Instance details

Defined in Amazonka.Firehose.Types.AmazonopensearchserviceS3BackupMode

NFData AmazonopensearchserviceS3BackupMode Source # 
Instance details

Defined in Amazonka.Firehose.Types.AmazonopensearchserviceS3BackupMode

Eq AmazonopensearchserviceS3BackupMode Source # 
Instance details

Defined in Amazonka.Firehose.Types.AmazonopensearchserviceS3BackupMode

Ord AmazonopensearchserviceS3BackupMode Source # 
Instance details

Defined in Amazonka.Firehose.Types.AmazonopensearchserviceS3BackupMode

Hashable AmazonopensearchserviceS3BackupMode Source # 
Instance details

Defined in Amazonka.Firehose.Types.AmazonopensearchserviceS3BackupMode

type Rep AmazonopensearchserviceS3BackupMode Source # 
Instance details

Defined in Amazonka.Firehose.Types.AmazonopensearchserviceS3BackupMode

type Rep AmazonopensearchserviceS3BackupMode = D1 ('MetaData "AmazonopensearchserviceS3BackupMode" "Amazonka.Firehose.Types.AmazonopensearchserviceS3BackupMode" "amazonka-kinesis-firehose-2.0-6l1hHmh2UnHBvolxuQFkWB" 'True) (C1 ('MetaCons "AmazonopensearchserviceS3BackupMode'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromAmazonopensearchserviceS3BackupMode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

CompressionFormat

newtype CompressionFormat Source #

Instances

Instances details
FromJSON CompressionFormat Source # 
Instance details

Defined in Amazonka.Firehose.Types.CompressionFormat

FromJSONKey CompressionFormat Source # 
Instance details

Defined in Amazonka.Firehose.Types.CompressionFormat

ToJSON CompressionFormat Source # 
Instance details

Defined in Amazonka.Firehose.Types.CompressionFormat

ToJSONKey CompressionFormat Source # 
Instance details

Defined in Amazonka.Firehose.Types.CompressionFormat

ToByteString CompressionFormat Source # 
Instance details

Defined in Amazonka.Firehose.Types.CompressionFormat

ToHeader CompressionFormat Source # 
Instance details

Defined in Amazonka.Firehose.Types.CompressionFormat

ToLog CompressionFormat Source # 
Instance details

Defined in Amazonka.Firehose.Types.CompressionFormat

ToQuery CompressionFormat Source # 
Instance details

Defined in Amazonka.Firehose.Types.CompressionFormat

FromText CompressionFormat Source # 
Instance details

Defined in Amazonka.Firehose.Types.CompressionFormat

ToText CompressionFormat Source # 
Instance details

Defined in Amazonka.Firehose.Types.CompressionFormat

FromXML CompressionFormat Source # 
Instance details

Defined in Amazonka.Firehose.Types.CompressionFormat

ToXML CompressionFormat Source # 
Instance details

Defined in Amazonka.Firehose.Types.CompressionFormat

Generic CompressionFormat Source # 
Instance details

Defined in Amazonka.Firehose.Types.CompressionFormat

Associated Types

type Rep CompressionFormat :: Type -> Type #

Read CompressionFormat Source # 
Instance details

Defined in Amazonka.Firehose.Types.CompressionFormat

Show CompressionFormat Source # 
Instance details

Defined in Amazonka.Firehose.Types.CompressionFormat

NFData CompressionFormat Source # 
Instance details

Defined in Amazonka.Firehose.Types.CompressionFormat

Methods

rnf :: CompressionFormat -> () #

Eq CompressionFormat Source # 
Instance details

Defined in Amazonka.Firehose.Types.CompressionFormat

Ord CompressionFormat Source # 
Instance details

Defined in Amazonka.Firehose.Types.CompressionFormat

Hashable CompressionFormat Source # 
Instance details

Defined in Amazonka.Firehose.Types.CompressionFormat

type Rep CompressionFormat Source # 
Instance details

Defined in Amazonka.Firehose.Types.CompressionFormat

type Rep CompressionFormat = D1 ('MetaData "CompressionFormat" "Amazonka.Firehose.Types.CompressionFormat" "amazonka-kinesis-firehose-2.0-6l1hHmh2UnHBvolxuQFkWB" 'True) (C1 ('MetaCons "CompressionFormat'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromCompressionFormat") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

ContentEncoding

newtype ContentEncoding Source #

Constructors

ContentEncoding' 

Instances

Instances details
FromJSON ContentEncoding Source # 
Instance details

Defined in Amazonka.Firehose.Types.ContentEncoding

FromJSONKey ContentEncoding Source # 
Instance details

Defined in Amazonka.Firehose.Types.ContentEncoding

ToJSON ContentEncoding Source # 
Instance details

Defined in Amazonka.Firehose.Types.ContentEncoding

ToJSONKey ContentEncoding Source # 
Instance details

Defined in Amazonka.Firehose.Types.ContentEncoding

ToByteString ContentEncoding Source # 
Instance details

Defined in Amazonka.Firehose.Types.ContentEncoding

ToHeader ContentEncoding Source # 
Instance details

Defined in Amazonka.Firehose.Types.ContentEncoding

ToLog ContentEncoding Source # 
Instance details

Defined in Amazonka.Firehose.Types.ContentEncoding

ToQuery ContentEncoding Source # 
Instance details

Defined in Amazonka.Firehose.Types.ContentEncoding

FromText ContentEncoding Source # 
Instance details

Defined in Amazonka.Firehose.Types.ContentEncoding

ToText ContentEncoding Source # 
Instance details

Defined in Amazonka.Firehose.Types.ContentEncoding

FromXML ContentEncoding Source # 
Instance details

Defined in Amazonka.Firehose.Types.ContentEncoding

ToXML ContentEncoding Source # 
Instance details

Defined in Amazonka.Firehose.Types.ContentEncoding

Methods

toXML :: ContentEncoding -> XML #

Generic ContentEncoding Source # 
Instance details

Defined in Amazonka.Firehose.Types.ContentEncoding

Associated Types

type Rep ContentEncoding :: Type -> Type #

Read ContentEncoding Source # 
Instance details

Defined in Amazonka.Firehose.Types.ContentEncoding

Show ContentEncoding Source # 
Instance details

Defined in Amazonka.Firehose.Types.ContentEncoding

NFData ContentEncoding Source # 
Instance details

Defined in Amazonka.Firehose.Types.ContentEncoding

Methods

rnf :: ContentEncoding -> () #

Eq ContentEncoding Source # 
Instance details

Defined in Amazonka.Firehose.Types.ContentEncoding

Ord ContentEncoding Source # 
Instance details

Defined in Amazonka.Firehose.Types.ContentEncoding

Hashable ContentEncoding Source # 
Instance details

Defined in Amazonka.Firehose.Types.ContentEncoding

type Rep ContentEncoding Source # 
Instance details

Defined in Amazonka.Firehose.Types.ContentEncoding

type Rep ContentEncoding = D1 ('MetaData "ContentEncoding" "Amazonka.Firehose.Types.ContentEncoding" "amazonka-kinesis-firehose-2.0-6l1hHmh2UnHBvolxuQFkWB" 'True) (C1 ('MetaCons "ContentEncoding'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromContentEncoding") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

DeliveryStreamEncryptionStatus

newtype DeliveryStreamEncryptionStatus Source #

Instances

Instances details
FromJSON DeliveryStreamEncryptionStatus Source # 
Instance details

Defined in Amazonka.Firehose.Types.DeliveryStreamEncryptionStatus

FromJSONKey DeliveryStreamEncryptionStatus Source # 
Instance details

Defined in Amazonka.Firehose.Types.DeliveryStreamEncryptionStatus

ToJSON DeliveryStreamEncryptionStatus Source # 
Instance details

Defined in Amazonka.Firehose.Types.DeliveryStreamEncryptionStatus

ToJSONKey DeliveryStreamEncryptionStatus Source # 
Instance details

Defined in Amazonka.Firehose.Types.DeliveryStreamEncryptionStatus

ToByteString DeliveryStreamEncryptionStatus Source # 
Instance details

Defined in Amazonka.Firehose.Types.DeliveryStreamEncryptionStatus

ToHeader DeliveryStreamEncryptionStatus Source # 
Instance details

Defined in Amazonka.Firehose.Types.DeliveryStreamEncryptionStatus

ToLog DeliveryStreamEncryptionStatus Source # 
Instance details

Defined in Amazonka.Firehose.Types.DeliveryStreamEncryptionStatus

ToQuery DeliveryStreamEncryptionStatus Source # 
Instance details

Defined in Amazonka.Firehose.Types.DeliveryStreamEncryptionStatus

FromText DeliveryStreamEncryptionStatus Source # 
Instance details

Defined in Amazonka.Firehose.Types.DeliveryStreamEncryptionStatus

ToText DeliveryStreamEncryptionStatus Source # 
Instance details

Defined in Amazonka.Firehose.Types.DeliveryStreamEncryptionStatus

FromXML DeliveryStreamEncryptionStatus Source # 
Instance details

Defined in Amazonka.Firehose.Types.DeliveryStreamEncryptionStatus

ToXML DeliveryStreamEncryptionStatus Source # 
Instance details

Defined in Amazonka.Firehose.Types.DeliveryStreamEncryptionStatus

Generic DeliveryStreamEncryptionStatus Source # 
Instance details

Defined in Amazonka.Firehose.Types.DeliveryStreamEncryptionStatus

Associated Types

type Rep DeliveryStreamEncryptionStatus :: Type -> Type #

Read DeliveryStreamEncryptionStatus Source # 
Instance details

Defined in Amazonka.Firehose.Types.DeliveryStreamEncryptionStatus

Show DeliveryStreamEncryptionStatus Source # 
Instance details

Defined in Amazonka.Firehose.Types.DeliveryStreamEncryptionStatus

NFData DeliveryStreamEncryptionStatus Source # 
Instance details

Defined in Amazonka.Firehose.Types.DeliveryStreamEncryptionStatus

Eq DeliveryStreamEncryptionStatus Source # 
Instance details

Defined in Amazonka.Firehose.Types.DeliveryStreamEncryptionStatus

Ord DeliveryStreamEncryptionStatus Source # 
Instance details

Defined in Amazonka.Firehose.Types.DeliveryStreamEncryptionStatus

Hashable DeliveryStreamEncryptionStatus Source # 
Instance details

Defined in Amazonka.Firehose.Types.DeliveryStreamEncryptionStatus

type Rep DeliveryStreamEncryptionStatus Source # 
Instance details

Defined in Amazonka.Firehose.Types.DeliveryStreamEncryptionStatus

type Rep DeliveryStreamEncryptionStatus = D1 ('MetaData "DeliveryStreamEncryptionStatus" "Amazonka.Firehose.Types.DeliveryStreamEncryptionStatus" "amazonka-kinesis-firehose-2.0-6l1hHmh2UnHBvolxuQFkWB" 'True) (C1 ('MetaCons "DeliveryStreamEncryptionStatus'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromDeliveryStreamEncryptionStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

DeliveryStreamFailureType

newtype DeliveryStreamFailureType Source #

Instances

Instances details
FromJSON DeliveryStreamFailureType Source # 
Instance details

Defined in Amazonka.Firehose.Types.DeliveryStreamFailureType

FromJSONKey DeliveryStreamFailureType Source # 
Instance details

Defined in Amazonka.Firehose.Types.DeliveryStreamFailureType

ToJSON DeliveryStreamFailureType Source # 
Instance details

Defined in Amazonka.Firehose.Types.DeliveryStreamFailureType

ToJSONKey DeliveryStreamFailureType Source # 
Instance details

Defined in Amazonka.Firehose.Types.DeliveryStreamFailureType

ToByteString DeliveryStreamFailureType Source # 
Instance details

Defined in Amazonka.Firehose.Types.DeliveryStreamFailureType

ToHeader DeliveryStreamFailureType Source # 
Instance details

Defined in Amazonka.Firehose.Types.DeliveryStreamFailureType

ToLog DeliveryStreamFailureType Source # 
Instance details

Defined in Amazonka.Firehose.Types.DeliveryStreamFailureType

ToQuery DeliveryStreamFailureType Source # 
Instance details

Defined in Amazonka.Firehose.Types.DeliveryStreamFailureType

FromText DeliveryStreamFailureType Source # 
Instance details

Defined in Amazonka.Firehose.Types.DeliveryStreamFailureType

ToText DeliveryStreamFailureType Source # 
Instance details

Defined in Amazonka.Firehose.Types.DeliveryStreamFailureType

FromXML DeliveryStreamFailureType Source # 
Instance details

Defined in Amazonka.Firehose.Types.DeliveryStreamFailureType

ToXML DeliveryStreamFailureType Source # 
Instance details

Defined in Amazonka.Firehose.Types.DeliveryStreamFailureType

Generic DeliveryStreamFailureType Source # 
Instance details

Defined in Amazonka.Firehose.Types.DeliveryStreamFailureType

Associated Types

type Rep DeliveryStreamFailureType :: Type -> Type #

Read DeliveryStreamFailureType Source # 
Instance details

Defined in Amazonka.Firehose.Types.DeliveryStreamFailureType

Show DeliveryStreamFailureType Source # 
Instance details

Defined in Amazonka.Firehose.Types.DeliveryStreamFailureType

NFData DeliveryStreamFailureType Source # 
Instance details

Defined in Amazonka.Firehose.Types.DeliveryStreamFailureType

Eq DeliveryStreamFailureType Source # 
Instance details

Defined in Amazonka.Firehose.Types.DeliveryStreamFailureType

Ord DeliveryStreamFailureType Source # 
Instance details

Defined in Amazonka.Firehose.Types.DeliveryStreamFailureType

Hashable DeliveryStreamFailureType Source # 
Instance details

Defined in Amazonka.Firehose.Types.DeliveryStreamFailureType

type Rep DeliveryStreamFailureType Source # 
Instance details

Defined in Amazonka.Firehose.Types.DeliveryStreamFailureType

type Rep DeliveryStreamFailureType = D1 ('MetaData "DeliveryStreamFailureType" "Amazonka.Firehose.Types.DeliveryStreamFailureType" "amazonka-kinesis-firehose-2.0-6l1hHmh2UnHBvolxuQFkWB" 'True) (C1 ('MetaCons "DeliveryStreamFailureType'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromDeliveryStreamFailureType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

DeliveryStreamStatus

newtype DeliveryStreamStatus Source #

Instances

Instances details
FromJSON DeliveryStreamStatus Source # 
Instance details

Defined in Amazonka.Firehose.Types.DeliveryStreamStatus

FromJSONKey DeliveryStreamStatus Source # 
Instance details

Defined in Amazonka.Firehose.Types.DeliveryStreamStatus

ToJSON DeliveryStreamStatus Source # 
Instance details

Defined in Amazonka.Firehose.Types.DeliveryStreamStatus

ToJSONKey DeliveryStreamStatus Source # 
Instance details

Defined in Amazonka.Firehose.Types.DeliveryStreamStatus

ToByteString DeliveryStreamStatus Source # 
Instance details

Defined in Amazonka.Firehose.Types.DeliveryStreamStatus

ToHeader DeliveryStreamStatus Source # 
Instance details

Defined in Amazonka.Firehose.Types.DeliveryStreamStatus

ToLog DeliveryStreamStatus Source # 
Instance details

Defined in Amazonka.Firehose.Types.DeliveryStreamStatus

ToQuery DeliveryStreamStatus Source # 
Instance details

Defined in Amazonka.Firehose.Types.DeliveryStreamStatus

FromText DeliveryStreamStatus Source # 
Instance details

Defined in Amazonka.Firehose.Types.DeliveryStreamStatus

ToText DeliveryStreamStatus Source # 
Instance details

Defined in Amazonka.Firehose.Types.DeliveryStreamStatus

FromXML DeliveryStreamStatus Source # 
Instance details

Defined in Amazonka.Firehose.Types.DeliveryStreamStatus

ToXML DeliveryStreamStatus Source # 
Instance details

Defined in Amazonka.Firehose.Types.DeliveryStreamStatus

Generic DeliveryStreamStatus Source # 
Instance details

Defined in Amazonka.Firehose.Types.DeliveryStreamStatus

Associated Types

type Rep DeliveryStreamStatus :: Type -> Type #

Read DeliveryStreamStatus Source # 
Instance details

Defined in Amazonka.Firehose.Types.DeliveryStreamStatus

Show DeliveryStreamStatus Source # 
Instance details

Defined in Amazonka.Firehose.Types.DeliveryStreamStatus

NFData DeliveryStreamStatus Source # 
Instance details

Defined in Amazonka.Firehose.Types.DeliveryStreamStatus

Methods

rnf :: DeliveryStreamStatus -> () #

Eq DeliveryStreamStatus Source # 
Instance details

Defined in Amazonka.Firehose.Types.DeliveryStreamStatus

Ord DeliveryStreamStatus Source # 
Instance details

Defined in Amazonka.Firehose.Types.DeliveryStreamStatus

Hashable DeliveryStreamStatus Source # 
Instance details

Defined in Amazonka.Firehose.Types.DeliveryStreamStatus

type Rep DeliveryStreamStatus Source # 
Instance details

Defined in Amazonka.Firehose.Types.DeliveryStreamStatus

type Rep DeliveryStreamStatus = D1 ('MetaData "DeliveryStreamStatus" "Amazonka.Firehose.Types.DeliveryStreamStatus" "amazonka-kinesis-firehose-2.0-6l1hHmh2UnHBvolxuQFkWB" 'True) (C1 ('MetaCons "DeliveryStreamStatus'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromDeliveryStreamStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

DeliveryStreamType

newtype DeliveryStreamType Source #

Instances

Instances details
FromJSON DeliveryStreamType Source # 
Instance details

Defined in Amazonka.Firehose.Types.DeliveryStreamType

FromJSONKey DeliveryStreamType Source # 
Instance details

Defined in Amazonka.Firehose.Types.DeliveryStreamType

ToJSON DeliveryStreamType Source # 
Instance details

Defined in Amazonka.Firehose.Types.DeliveryStreamType

ToJSONKey DeliveryStreamType Source # 
Instance details

Defined in Amazonka.Firehose.Types.DeliveryStreamType

ToByteString DeliveryStreamType Source # 
Instance details

Defined in Amazonka.Firehose.Types.DeliveryStreamType

ToHeader DeliveryStreamType Source # 
Instance details

Defined in Amazonka.Firehose.Types.DeliveryStreamType

ToLog DeliveryStreamType Source # 
Instance details

Defined in Amazonka.Firehose.Types.DeliveryStreamType

ToQuery DeliveryStreamType Source # 
Instance details

Defined in Amazonka.Firehose.Types.DeliveryStreamType

FromText DeliveryStreamType Source # 
Instance details

Defined in Amazonka.Firehose.Types.DeliveryStreamType

ToText DeliveryStreamType Source # 
Instance details

Defined in Amazonka.Firehose.Types.DeliveryStreamType

FromXML DeliveryStreamType Source # 
Instance details

Defined in Amazonka.Firehose.Types.DeliveryStreamType

ToXML DeliveryStreamType Source # 
Instance details

Defined in Amazonka.Firehose.Types.DeliveryStreamType

Generic DeliveryStreamType Source # 
Instance details

Defined in Amazonka.Firehose.Types.DeliveryStreamType

Associated Types

type Rep DeliveryStreamType :: Type -> Type #

Read DeliveryStreamType Source # 
Instance details

Defined in Amazonka.Firehose.Types.DeliveryStreamType

Show DeliveryStreamType Source # 
Instance details

Defined in Amazonka.Firehose.Types.DeliveryStreamType

NFData DeliveryStreamType Source # 
Instance details

Defined in Amazonka.Firehose.Types.DeliveryStreamType

Methods

rnf :: DeliveryStreamType -> () #

Eq DeliveryStreamType Source # 
Instance details

Defined in Amazonka.Firehose.Types.DeliveryStreamType

Ord DeliveryStreamType Source # 
Instance details

Defined in Amazonka.Firehose.Types.DeliveryStreamType

Hashable DeliveryStreamType Source # 
Instance details

Defined in Amazonka.Firehose.Types.DeliveryStreamType

type Rep DeliveryStreamType Source # 
Instance details

Defined in Amazonka.Firehose.Types.DeliveryStreamType

type Rep DeliveryStreamType = D1 ('MetaData "DeliveryStreamType" "Amazonka.Firehose.Types.DeliveryStreamType" "amazonka-kinesis-firehose-2.0-6l1hHmh2UnHBvolxuQFkWB" 'True) (C1 ('MetaCons "DeliveryStreamType'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromDeliveryStreamType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

ElasticsearchIndexRotationPeriod

newtype ElasticsearchIndexRotationPeriod Source #

Instances

Instances details
FromJSON ElasticsearchIndexRotationPeriod Source # 
Instance details

Defined in Amazonka.Firehose.Types.ElasticsearchIndexRotationPeriod

FromJSONKey ElasticsearchIndexRotationPeriod Source # 
Instance details

Defined in Amazonka.Firehose.Types.ElasticsearchIndexRotationPeriod

ToJSON ElasticsearchIndexRotationPeriod Source # 
Instance details

Defined in Amazonka.Firehose.Types.ElasticsearchIndexRotationPeriod

ToJSONKey ElasticsearchIndexRotationPeriod Source # 
Instance details

Defined in Amazonka.Firehose.Types.ElasticsearchIndexRotationPeriod

ToByteString ElasticsearchIndexRotationPeriod Source # 
Instance details

Defined in Amazonka.Firehose.Types.ElasticsearchIndexRotationPeriod

ToHeader ElasticsearchIndexRotationPeriod Source # 
Instance details

Defined in Amazonka.Firehose.Types.ElasticsearchIndexRotationPeriod

ToLog ElasticsearchIndexRotationPeriod Source # 
Instance details

Defined in Amazonka.Firehose.Types.ElasticsearchIndexRotationPeriod

ToQuery ElasticsearchIndexRotationPeriod Source # 
Instance details

Defined in Amazonka.Firehose.Types.ElasticsearchIndexRotationPeriod

FromText ElasticsearchIndexRotationPeriod Source # 
Instance details

Defined in Amazonka.Firehose.Types.ElasticsearchIndexRotationPeriod

ToText ElasticsearchIndexRotationPeriod Source # 
Instance details

Defined in Amazonka.Firehose.Types.ElasticsearchIndexRotationPeriod

FromXML ElasticsearchIndexRotationPeriod Source # 
Instance details

Defined in Amazonka.Firehose.Types.ElasticsearchIndexRotationPeriod

ToXML ElasticsearchIndexRotationPeriod Source # 
Instance details

Defined in Amazonka.Firehose.Types.ElasticsearchIndexRotationPeriod

Generic ElasticsearchIndexRotationPeriod Source # 
Instance details

Defined in Amazonka.Firehose.Types.ElasticsearchIndexRotationPeriod

Associated Types

type Rep ElasticsearchIndexRotationPeriod :: Type -> Type #

Read ElasticsearchIndexRotationPeriod Source # 
Instance details

Defined in Amazonka.Firehose.Types.ElasticsearchIndexRotationPeriod

Show ElasticsearchIndexRotationPeriod Source # 
Instance details

Defined in Amazonka.Firehose.Types.ElasticsearchIndexRotationPeriod

NFData ElasticsearchIndexRotationPeriod Source # 
Instance details

Defined in Amazonka.Firehose.Types.ElasticsearchIndexRotationPeriod

Eq ElasticsearchIndexRotationPeriod Source # 
Instance details

Defined in Amazonka.Firehose.Types.ElasticsearchIndexRotationPeriod

Ord ElasticsearchIndexRotationPeriod Source # 
Instance details

Defined in Amazonka.Firehose.Types.ElasticsearchIndexRotationPeriod

Hashable ElasticsearchIndexRotationPeriod Source # 
Instance details

Defined in Amazonka.Firehose.Types.ElasticsearchIndexRotationPeriod

type Rep ElasticsearchIndexRotationPeriod Source # 
Instance details

Defined in Amazonka.Firehose.Types.ElasticsearchIndexRotationPeriod

type Rep ElasticsearchIndexRotationPeriod = D1 ('MetaData "ElasticsearchIndexRotationPeriod" "Amazonka.Firehose.Types.ElasticsearchIndexRotationPeriod" "amazonka-kinesis-firehose-2.0-6l1hHmh2UnHBvolxuQFkWB" 'True) (C1 ('MetaCons "ElasticsearchIndexRotationPeriod'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromElasticsearchIndexRotationPeriod") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

ElasticsearchS3BackupMode

newtype ElasticsearchS3BackupMode Source #

Instances

Instances details
FromJSON ElasticsearchS3BackupMode Source # 
Instance details

Defined in Amazonka.Firehose.Types.ElasticsearchS3BackupMode

FromJSONKey ElasticsearchS3BackupMode Source # 
Instance details

Defined in Amazonka.Firehose.Types.ElasticsearchS3BackupMode

ToJSON ElasticsearchS3BackupMode Source # 
Instance details

Defined in Amazonka.Firehose.Types.ElasticsearchS3BackupMode

ToJSONKey ElasticsearchS3BackupMode Source # 
Instance details

Defined in Amazonka.Firehose.Types.ElasticsearchS3BackupMode

ToByteString ElasticsearchS3BackupMode Source # 
Instance details

Defined in Amazonka.Firehose.Types.ElasticsearchS3BackupMode

ToHeader ElasticsearchS3BackupMode Source # 
Instance details

Defined in Amazonka.Firehose.Types.ElasticsearchS3BackupMode

ToLog ElasticsearchS3BackupMode Source # 
Instance details

Defined in Amazonka.Firehose.Types.ElasticsearchS3BackupMode

ToQuery ElasticsearchS3BackupMode Source # 
Instance details

Defined in Amazonka.Firehose.Types.ElasticsearchS3BackupMode

FromText ElasticsearchS3BackupMode Source # 
Instance details

Defined in Amazonka.Firehose.Types.ElasticsearchS3BackupMode

ToText ElasticsearchS3BackupMode Source # 
Instance details

Defined in Amazonka.Firehose.Types.ElasticsearchS3BackupMode

FromXML ElasticsearchS3BackupMode Source # 
Instance details

Defined in Amazonka.Firehose.Types.ElasticsearchS3BackupMode

ToXML ElasticsearchS3BackupMode Source # 
Instance details

Defined in Amazonka.Firehose.Types.ElasticsearchS3BackupMode

Generic ElasticsearchS3BackupMode Source # 
Instance details

Defined in Amazonka.Firehose.Types.ElasticsearchS3BackupMode

Associated Types

type Rep ElasticsearchS3BackupMode :: Type -> Type #

Read ElasticsearchS3BackupMode Source # 
Instance details

Defined in Amazonka.Firehose.Types.ElasticsearchS3BackupMode

Show ElasticsearchS3BackupMode Source # 
Instance details

Defined in Amazonka.Firehose.Types.ElasticsearchS3BackupMode

NFData ElasticsearchS3BackupMode Source # 
Instance details

Defined in Amazonka.Firehose.Types.ElasticsearchS3BackupMode

Eq ElasticsearchS3BackupMode Source # 
Instance details

Defined in Amazonka.Firehose.Types.ElasticsearchS3BackupMode

Ord ElasticsearchS3BackupMode Source # 
Instance details

Defined in Amazonka.Firehose.Types.ElasticsearchS3BackupMode

Hashable ElasticsearchS3BackupMode Source # 
Instance details

Defined in Amazonka.Firehose.Types.ElasticsearchS3BackupMode

type Rep ElasticsearchS3BackupMode Source # 
Instance details

Defined in Amazonka.Firehose.Types.ElasticsearchS3BackupMode

type Rep ElasticsearchS3BackupMode = D1 ('MetaData "ElasticsearchS3BackupMode" "Amazonka.Firehose.Types.ElasticsearchS3BackupMode" "amazonka-kinesis-firehose-2.0-6l1hHmh2UnHBvolxuQFkWB" 'True) (C1 ('MetaCons "ElasticsearchS3BackupMode'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromElasticsearchS3BackupMode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

HECEndpointType

newtype HECEndpointType Source #

Constructors

HECEndpointType' 

Instances

Instances details
FromJSON HECEndpointType Source # 
Instance details

Defined in Amazonka.Firehose.Types.HECEndpointType

FromJSONKey HECEndpointType Source # 
Instance details

Defined in Amazonka.Firehose.Types.HECEndpointType

ToJSON HECEndpointType Source # 
Instance details

Defined in Amazonka.Firehose.Types.HECEndpointType

ToJSONKey HECEndpointType Source # 
Instance details

Defined in Amazonka.Firehose.Types.HECEndpointType

ToByteString HECEndpointType Source # 
Instance details

Defined in Amazonka.Firehose.Types.HECEndpointType

ToHeader HECEndpointType Source # 
Instance details

Defined in Amazonka.Firehose.Types.HECEndpointType

ToLog HECEndpointType Source # 
Instance details

Defined in Amazonka.Firehose.Types.HECEndpointType

ToQuery HECEndpointType Source # 
Instance details

Defined in Amazonka.Firehose.Types.HECEndpointType

FromText HECEndpointType Source # 
Instance details

Defined in Amazonka.Firehose.Types.HECEndpointType

ToText HECEndpointType Source # 
Instance details

Defined in Amazonka.Firehose.Types.HECEndpointType

FromXML HECEndpointType Source # 
Instance details

Defined in Amazonka.Firehose.Types.HECEndpointType

ToXML HECEndpointType Source # 
Instance details

Defined in Amazonka.Firehose.Types.HECEndpointType

Methods

toXML :: HECEndpointType -> XML #

Generic HECEndpointType Source # 
Instance details

Defined in Amazonka.Firehose.Types.HECEndpointType

Associated Types

type Rep HECEndpointType :: Type -> Type #

Read HECEndpointType Source # 
Instance details

Defined in Amazonka.Firehose.Types.HECEndpointType

Show HECEndpointType Source # 
Instance details

Defined in Amazonka.Firehose.Types.HECEndpointType

NFData HECEndpointType Source # 
Instance details

Defined in Amazonka.Firehose.Types.HECEndpointType

Methods

rnf :: HECEndpointType -> () #

Eq HECEndpointType Source # 
Instance details

Defined in Amazonka.Firehose.Types.HECEndpointType

Ord HECEndpointType Source # 
Instance details

Defined in Amazonka.Firehose.Types.HECEndpointType

Hashable HECEndpointType Source # 
Instance details

Defined in Amazonka.Firehose.Types.HECEndpointType

type Rep HECEndpointType Source # 
Instance details

Defined in Amazonka.Firehose.Types.HECEndpointType

type Rep HECEndpointType = D1 ('MetaData "HECEndpointType" "Amazonka.Firehose.Types.HECEndpointType" "amazonka-kinesis-firehose-2.0-6l1hHmh2UnHBvolxuQFkWB" 'True) (C1 ('MetaCons "HECEndpointType'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromHECEndpointType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

HttpEndpointS3BackupMode

newtype HttpEndpointS3BackupMode Source #

Instances

Instances details
FromJSON HttpEndpointS3BackupMode Source # 
Instance details

Defined in Amazonka.Firehose.Types.HttpEndpointS3BackupMode

FromJSONKey HttpEndpointS3BackupMode Source # 
Instance details

Defined in Amazonka.Firehose.Types.HttpEndpointS3BackupMode

ToJSON HttpEndpointS3BackupMode Source # 
Instance details

Defined in Amazonka.Firehose.Types.HttpEndpointS3BackupMode

ToJSONKey HttpEndpointS3BackupMode Source # 
Instance details

Defined in Amazonka.Firehose.Types.HttpEndpointS3BackupMode

ToByteString HttpEndpointS3BackupMode Source # 
Instance details

Defined in Amazonka.Firehose.Types.HttpEndpointS3BackupMode

ToHeader HttpEndpointS3BackupMode Source # 
Instance details

Defined in Amazonka.Firehose.Types.HttpEndpointS3BackupMode

ToLog HttpEndpointS3BackupMode Source # 
Instance details

Defined in Amazonka.Firehose.Types.HttpEndpointS3BackupMode

ToQuery HttpEndpointS3BackupMode Source # 
Instance details

Defined in Amazonka.Firehose.Types.HttpEndpointS3BackupMode

FromText HttpEndpointS3BackupMode Source # 
Instance details

Defined in Amazonka.Firehose.Types.HttpEndpointS3BackupMode

ToText HttpEndpointS3BackupMode Source # 
Instance details

Defined in Amazonka.Firehose.Types.HttpEndpointS3BackupMode

FromXML HttpEndpointS3BackupMode Source # 
Instance details

Defined in Amazonka.Firehose.Types.HttpEndpointS3BackupMode

ToXML HttpEndpointS3BackupMode Source # 
Instance details

Defined in Amazonka.Firehose.Types.HttpEndpointS3BackupMode

Generic HttpEndpointS3BackupMode Source # 
Instance details

Defined in Amazonka.Firehose.Types.HttpEndpointS3BackupMode

Associated Types

type Rep HttpEndpointS3BackupMode :: Type -> Type #

Read HttpEndpointS3BackupMode Source # 
Instance details

Defined in Amazonka.Firehose.Types.HttpEndpointS3BackupMode

Show HttpEndpointS3BackupMode Source # 
Instance details

Defined in Amazonka.Firehose.Types.HttpEndpointS3BackupMode

NFData HttpEndpointS3BackupMode Source # 
Instance details

Defined in Amazonka.Firehose.Types.HttpEndpointS3BackupMode

Eq HttpEndpointS3BackupMode Source # 
Instance details

Defined in Amazonka.Firehose.Types.HttpEndpointS3BackupMode

Ord HttpEndpointS3BackupMode Source # 
Instance details

Defined in Amazonka.Firehose.Types.HttpEndpointS3BackupMode

Hashable HttpEndpointS3BackupMode Source # 
Instance details

Defined in Amazonka.Firehose.Types.HttpEndpointS3BackupMode

type Rep HttpEndpointS3BackupMode Source # 
Instance details

Defined in Amazonka.Firehose.Types.HttpEndpointS3BackupMode

type Rep HttpEndpointS3BackupMode = D1 ('MetaData "HttpEndpointS3BackupMode" "Amazonka.Firehose.Types.HttpEndpointS3BackupMode" "amazonka-kinesis-firehose-2.0-6l1hHmh2UnHBvolxuQFkWB" 'True) (C1 ('MetaCons "HttpEndpointS3BackupMode'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromHttpEndpointS3BackupMode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

KeyType

newtype KeyType Source #

Constructors

KeyType' 

Fields

Bundled Patterns

pattern KeyType_AWS_OWNED_CMK :: KeyType 
pattern KeyType_CUSTOMER_MANAGED_CMK :: KeyType 

Instances

Instances details
FromJSON KeyType Source # 
Instance details

Defined in Amazonka.Firehose.Types.KeyType

FromJSONKey KeyType Source # 
Instance details

Defined in Amazonka.Firehose.Types.KeyType

ToJSON KeyType Source # 
Instance details

Defined in Amazonka.Firehose.Types.KeyType

ToJSONKey KeyType Source # 
Instance details

Defined in Amazonka.Firehose.Types.KeyType

ToByteString KeyType Source # 
Instance details

Defined in Amazonka.Firehose.Types.KeyType

Methods

toBS :: KeyType -> ByteString #

ToHeader KeyType Source # 
Instance details

Defined in Amazonka.Firehose.Types.KeyType

Methods

toHeader :: HeaderName -> KeyType -> [Header] #

ToLog KeyType Source # 
Instance details

Defined in Amazonka.Firehose.Types.KeyType

ToQuery KeyType Source # 
Instance details

Defined in Amazonka.Firehose.Types.KeyType

FromText KeyType Source # 
Instance details

Defined in Amazonka.Firehose.Types.KeyType

ToText KeyType Source # 
Instance details

Defined in Amazonka.Firehose.Types.KeyType

Methods

toText :: KeyType -> Text #

FromXML KeyType Source # 
Instance details

Defined in Amazonka.Firehose.Types.KeyType

ToXML KeyType Source # 
Instance details

Defined in Amazonka.Firehose.Types.KeyType

Methods

toXML :: KeyType -> XML #

Generic KeyType Source # 
Instance details

Defined in Amazonka.Firehose.Types.KeyType

Associated Types

type Rep KeyType :: Type -> Type #

Methods

from :: KeyType -> Rep KeyType x #

to :: Rep KeyType x -> KeyType #

Read KeyType Source # 
Instance details

Defined in Amazonka.Firehose.Types.KeyType

Show KeyType Source # 
Instance details

Defined in Amazonka.Firehose.Types.KeyType

NFData KeyType Source # 
Instance details

Defined in Amazonka.Firehose.Types.KeyType

Methods

rnf :: KeyType -> () #

Eq KeyType Source # 
Instance details

Defined in Amazonka.Firehose.Types.KeyType

Methods

(==) :: KeyType -> KeyType -> Bool #

(/=) :: KeyType -> KeyType -> Bool #

Ord KeyType Source # 
Instance details

Defined in Amazonka.Firehose.Types.KeyType

Hashable KeyType Source # 
Instance details

Defined in Amazonka.Firehose.Types.KeyType

Methods

hashWithSalt :: Int -> KeyType -> Int #

hash :: KeyType -> Int #

type Rep KeyType Source # 
Instance details

Defined in Amazonka.Firehose.Types.KeyType

type Rep KeyType = D1 ('MetaData "KeyType" "Amazonka.Firehose.Types.KeyType" "amazonka-kinesis-firehose-2.0-6l1hHmh2UnHBvolxuQFkWB" 'True) (C1 ('MetaCons "KeyType'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromKeyType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

NoEncryptionConfig

newtype NoEncryptionConfig Source #

Instances

Instances details
FromJSON NoEncryptionConfig Source # 
Instance details

Defined in Amazonka.Firehose.Types.NoEncryptionConfig

FromJSONKey NoEncryptionConfig Source # 
Instance details

Defined in Amazonka.Firehose.Types.NoEncryptionConfig

ToJSON NoEncryptionConfig Source # 
Instance details

Defined in Amazonka.Firehose.Types.NoEncryptionConfig

ToJSONKey NoEncryptionConfig Source # 
Instance details

Defined in Amazonka.Firehose.Types.NoEncryptionConfig

ToByteString NoEncryptionConfig Source # 
Instance details

Defined in Amazonka.Firehose.Types.NoEncryptionConfig

ToHeader NoEncryptionConfig Source # 
Instance details

Defined in Amazonka.Firehose.Types.NoEncryptionConfig

ToLog NoEncryptionConfig Source # 
Instance details

Defined in Amazonka.Firehose.Types.NoEncryptionConfig

ToQuery NoEncryptionConfig Source # 
Instance details

Defined in Amazonka.Firehose.Types.NoEncryptionConfig

FromText NoEncryptionConfig Source # 
Instance details

Defined in Amazonka.Firehose.Types.NoEncryptionConfig

ToText NoEncryptionConfig Source # 
Instance details

Defined in Amazonka.Firehose.Types.NoEncryptionConfig

FromXML NoEncryptionConfig Source # 
Instance details

Defined in Amazonka.Firehose.Types.NoEncryptionConfig

ToXML NoEncryptionConfig Source # 
Instance details

Defined in Amazonka.Firehose.Types.NoEncryptionConfig

Generic NoEncryptionConfig Source # 
Instance details

Defined in Amazonka.Firehose.Types.NoEncryptionConfig

Associated Types

type Rep NoEncryptionConfig :: Type -> Type #

Read NoEncryptionConfig Source # 
Instance details

Defined in Amazonka.Firehose.Types.NoEncryptionConfig

Show NoEncryptionConfig Source # 
Instance details

Defined in Amazonka.Firehose.Types.NoEncryptionConfig

NFData NoEncryptionConfig Source # 
Instance details

Defined in Amazonka.Firehose.Types.NoEncryptionConfig

Methods

rnf :: NoEncryptionConfig -> () #

Eq NoEncryptionConfig Source # 
Instance details

Defined in Amazonka.Firehose.Types.NoEncryptionConfig

Ord NoEncryptionConfig Source # 
Instance details

Defined in Amazonka.Firehose.Types.NoEncryptionConfig

Hashable NoEncryptionConfig Source # 
Instance details

Defined in Amazonka.Firehose.Types.NoEncryptionConfig

type Rep NoEncryptionConfig Source # 
Instance details

Defined in Amazonka.Firehose.Types.NoEncryptionConfig

type Rep NoEncryptionConfig = D1 ('MetaData "NoEncryptionConfig" "Amazonka.Firehose.Types.NoEncryptionConfig" "amazonka-kinesis-firehose-2.0-6l1hHmh2UnHBvolxuQFkWB" 'True) (C1 ('MetaCons "NoEncryptionConfig'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromNoEncryptionConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

OrcCompression

newtype OrcCompression Source #

Constructors

OrcCompression' 

Instances

Instances details
FromJSON OrcCompression Source # 
Instance details

Defined in Amazonka.Firehose.Types.OrcCompression

FromJSONKey OrcCompression Source # 
Instance details

Defined in Amazonka.Firehose.Types.OrcCompression

ToJSON OrcCompression Source # 
Instance details

Defined in Amazonka.Firehose.Types.OrcCompression

ToJSONKey OrcCompression Source # 
Instance details

Defined in Amazonka.Firehose.Types.OrcCompression

ToByteString OrcCompression Source # 
Instance details

Defined in Amazonka.Firehose.Types.OrcCompression

ToHeader OrcCompression Source # 
Instance details

Defined in Amazonka.Firehose.Types.OrcCompression

ToLog OrcCompression Source # 
Instance details

Defined in Amazonka.Firehose.Types.OrcCompression

ToQuery OrcCompression Source # 
Instance details

Defined in Amazonka.Firehose.Types.OrcCompression

FromText OrcCompression Source # 
Instance details

Defined in Amazonka.Firehose.Types.OrcCompression

ToText OrcCompression Source # 
Instance details

Defined in Amazonka.Firehose.Types.OrcCompression

FromXML OrcCompression Source # 
Instance details

Defined in Amazonka.Firehose.Types.OrcCompression

ToXML OrcCompression Source # 
Instance details

Defined in Amazonka.Firehose.Types.OrcCompression

Methods

toXML :: OrcCompression -> XML #

Generic OrcCompression Source # 
Instance details

Defined in Amazonka.Firehose.Types.OrcCompression

Associated Types

type Rep OrcCompression :: Type -> Type #

Read OrcCompression Source # 
Instance details

Defined in Amazonka.Firehose.Types.OrcCompression

Show OrcCompression Source # 
Instance details

Defined in Amazonka.Firehose.Types.OrcCompression

NFData OrcCompression Source # 
Instance details

Defined in Amazonka.Firehose.Types.OrcCompression

Methods

rnf :: OrcCompression -> () #

Eq OrcCompression Source # 
Instance details

Defined in Amazonka.Firehose.Types.OrcCompression

Ord OrcCompression Source # 
Instance details

Defined in Amazonka.Firehose.Types.OrcCompression

Hashable OrcCompression Source # 
Instance details

Defined in Amazonka.Firehose.Types.OrcCompression

type Rep OrcCompression Source # 
Instance details

Defined in Amazonka.Firehose.Types.OrcCompression

type Rep OrcCompression = D1 ('MetaData "OrcCompression" "Amazonka.Firehose.Types.OrcCompression" "amazonka-kinesis-firehose-2.0-6l1hHmh2UnHBvolxuQFkWB" 'True) (C1 ('MetaCons "OrcCompression'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromOrcCompression") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

OrcFormatVersion

newtype OrcFormatVersion Source #

Instances

Instances details
FromJSON OrcFormatVersion Source # 
Instance details

Defined in Amazonka.Firehose.Types.OrcFormatVersion

FromJSONKey OrcFormatVersion Source # 
Instance details

Defined in Amazonka.Firehose.Types.OrcFormatVersion

ToJSON OrcFormatVersion Source # 
Instance details

Defined in Amazonka.Firehose.Types.OrcFormatVersion

ToJSONKey OrcFormatVersion Source # 
Instance details

Defined in Amazonka.Firehose.Types.OrcFormatVersion

ToByteString OrcFormatVersion Source # 
Instance details

Defined in Amazonka.Firehose.Types.OrcFormatVersion

ToHeader OrcFormatVersion Source # 
Instance details

Defined in Amazonka.Firehose.Types.OrcFormatVersion

ToLog OrcFormatVersion Source # 
Instance details

Defined in Amazonka.Firehose.Types.OrcFormatVersion

ToQuery OrcFormatVersion Source # 
Instance details

Defined in Amazonka.Firehose.Types.OrcFormatVersion

FromText OrcFormatVersion Source # 
Instance details

Defined in Amazonka.Firehose.Types.OrcFormatVersion

ToText OrcFormatVersion Source # 
Instance details

Defined in Amazonka.Firehose.Types.OrcFormatVersion

FromXML OrcFormatVersion Source # 
Instance details

Defined in Amazonka.Firehose.Types.OrcFormatVersion

ToXML OrcFormatVersion Source # 
Instance details

Defined in Amazonka.Firehose.Types.OrcFormatVersion

Generic OrcFormatVersion Source # 
Instance details

Defined in Amazonka.Firehose.Types.OrcFormatVersion

Associated Types

type Rep OrcFormatVersion :: Type -> Type #

Read OrcFormatVersion Source # 
Instance details

Defined in Amazonka.Firehose.Types.OrcFormatVersion

Show OrcFormatVersion Source # 
Instance details

Defined in Amazonka.Firehose.Types.OrcFormatVersion

NFData OrcFormatVersion Source # 
Instance details

Defined in Amazonka.Firehose.Types.OrcFormatVersion

Methods

rnf :: OrcFormatVersion -> () #

Eq OrcFormatVersion Source # 
Instance details

Defined in Amazonka.Firehose.Types.OrcFormatVersion

Ord OrcFormatVersion Source # 
Instance details

Defined in Amazonka.Firehose.Types.OrcFormatVersion

Hashable OrcFormatVersion Source # 
Instance details

Defined in Amazonka.Firehose.Types.OrcFormatVersion

type Rep OrcFormatVersion Source # 
Instance details

Defined in Amazonka.Firehose.Types.OrcFormatVersion

type Rep OrcFormatVersion = D1 ('MetaData "OrcFormatVersion" "Amazonka.Firehose.Types.OrcFormatVersion" "amazonka-kinesis-firehose-2.0-6l1hHmh2UnHBvolxuQFkWB" 'True) (C1 ('MetaCons "OrcFormatVersion'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromOrcFormatVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

ParquetCompression

newtype ParquetCompression Source #

Instances

Instances details
FromJSON ParquetCompression Source # 
Instance details

Defined in Amazonka.Firehose.Types.ParquetCompression

FromJSONKey ParquetCompression Source # 
Instance details

Defined in Amazonka.Firehose.Types.ParquetCompression

ToJSON ParquetCompression Source # 
Instance details

Defined in Amazonka.Firehose.Types.ParquetCompression

ToJSONKey ParquetCompression Source # 
Instance details

Defined in Amazonka.Firehose.Types.ParquetCompression

ToByteString ParquetCompression Source # 
Instance details

Defined in Amazonka.Firehose.Types.ParquetCompression

ToHeader ParquetCompression Source # 
Instance details

Defined in Amazonka.Firehose.Types.ParquetCompression

ToLog ParquetCompression Source # 
Instance details

Defined in Amazonka.Firehose.Types.ParquetCompression

ToQuery ParquetCompression Source # 
Instance details

Defined in Amazonka.Firehose.Types.ParquetCompression

FromText ParquetCompression Source # 
Instance details

Defined in Amazonka.Firehose.Types.ParquetCompression

ToText ParquetCompression Source # 
Instance details

Defined in Amazonka.Firehose.Types.ParquetCompression

FromXML ParquetCompression Source # 
Instance details

Defined in Amazonka.Firehose.Types.ParquetCompression

ToXML ParquetCompression Source # 
Instance details

Defined in Amazonka.Firehose.Types.ParquetCompression

Generic ParquetCompression Source # 
Instance details

Defined in Amazonka.Firehose.Types.ParquetCompression

Associated Types

type Rep ParquetCompression :: Type -> Type #

Read ParquetCompression Source # 
Instance details

Defined in Amazonka.Firehose.Types.ParquetCompression

Show ParquetCompression Source # 
Instance details

Defined in Amazonka.Firehose.Types.ParquetCompression

NFData ParquetCompression Source # 
Instance details

Defined in Amazonka.Firehose.Types.ParquetCompression

Methods

rnf :: ParquetCompression -> () #

Eq ParquetCompression Source # 
Instance details

Defined in Amazonka.Firehose.Types.ParquetCompression

Ord ParquetCompression Source # 
Instance details

Defined in Amazonka.Firehose.Types.ParquetCompression

Hashable ParquetCompression Source # 
Instance details

Defined in Amazonka.Firehose.Types.ParquetCompression

type Rep ParquetCompression Source # 
Instance details

Defined in Amazonka.Firehose.Types.ParquetCompression

type Rep ParquetCompression = D1 ('MetaData "ParquetCompression" "Amazonka.Firehose.Types.ParquetCompression" "amazonka-kinesis-firehose-2.0-6l1hHmh2UnHBvolxuQFkWB" 'True) (C1 ('MetaCons "ParquetCompression'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromParquetCompression") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

ParquetWriterVersion

newtype ParquetWriterVersion Source #

Instances

Instances details
FromJSON ParquetWriterVersion Source # 
Instance details

Defined in Amazonka.Firehose.Types.ParquetWriterVersion

FromJSONKey ParquetWriterVersion Source # 
Instance details

Defined in Amazonka.Firehose.Types.ParquetWriterVersion

ToJSON ParquetWriterVersion Source # 
Instance details

Defined in Amazonka.Firehose.Types.ParquetWriterVersion

ToJSONKey ParquetWriterVersion Source # 
Instance details

Defined in Amazonka.Firehose.Types.ParquetWriterVersion

ToByteString ParquetWriterVersion Source # 
Instance details

Defined in Amazonka.Firehose.Types.ParquetWriterVersion

ToHeader ParquetWriterVersion Source # 
Instance details

Defined in Amazonka.Firehose.Types.ParquetWriterVersion

ToLog ParquetWriterVersion Source # 
Instance details

Defined in Amazonka.Firehose.Types.ParquetWriterVersion

ToQuery ParquetWriterVersion Source # 
Instance details

Defined in Amazonka.Firehose.Types.ParquetWriterVersion

FromText ParquetWriterVersion Source # 
Instance details

Defined in Amazonka.Firehose.Types.ParquetWriterVersion

ToText ParquetWriterVersion Source # 
Instance details

Defined in Amazonka.Firehose.Types.ParquetWriterVersion

FromXML ParquetWriterVersion Source # 
Instance details

Defined in Amazonka.Firehose.Types.ParquetWriterVersion

ToXML ParquetWriterVersion Source # 
Instance details

Defined in Amazonka.Firehose.Types.ParquetWriterVersion

Generic ParquetWriterVersion Source # 
Instance details

Defined in Amazonka.Firehose.Types.ParquetWriterVersion

Associated Types

type Rep ParquetWriterVersion :: Type -> Type #

Read ParquetWriterVersion Source # 
Instance details

Defined in Amazonka.Firehose.Types.ParquetWriterVersion

Show ParquetWriterVersion Source # 
Instance details

Defined in Amazonka.Firehose.Types.ParquetWriterVersion

NFData ParquetWriterVersion Source # 
Instance details

Defined in Amazonka.Firehose.Types.ParquetWriterVersion

Methods

rnf :: ParquetWriterVersion -> () #

Eq ParquetWriterVersion Source # 
Instance details

Defined in Amazonka.Firehose.Types.ParquetWriterVersion

Ord ParquetWriterVersion Source # 
Instance details

Defined in Amazonka.Firehose.Types.ParquetWriterVersion

Hashable ParquetWriterVersion Source # 
Instance details

Defined in Amazonka.Firehose.Types.ParquetWriterVersion

type Rep ParquetWriterVersion Source # 
Instance details

Defined in Amazonka.Firehose.Types.ParquetWriterVersion

type Rep ParquetWriterVersion = D1 ('MetaData "ParquetWriterVersion" "Amazonka.Firehose.Types.ParquetWriterVersion" "amazonka-kinesis-firehose-2.0-6l1hHmh2UnHBvolxuQFkWB" 'True) (C1 ('MetaCons "ParquetWriterVersion'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromParquetWriterVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

ProcessorParameterName

newtype ProcessorParameterName Source #

Instances

Instances details
FromJSON ProcessorParameterName Source # 
Instance details

Defined in Amazonka.Firehose.Types.ProcessorParameterName

FromJSONKey ProcessorParameterName Source # 
Instance details

Defined in Amazonka.Firehose.Types.ProcessorParameterName

ToJSON ProcessorParameterName Source # 
Instance details

Defined in Amazonka.Firehose.Types.ProcessorParameterName

ToJSONKey ProcessorParameterName Source # 
Instance details

Defined in Amazonka.Firehose.Types.ProcessorParameterName

ToByteString ProcessorParameterName Source # 
Instance details

Defined in Amazonka.Firehose.Types.ProcessorParameterName

ToHeader ProcessorParameterName Source # 
Instance details

Defined in Amazonka.Firehose.Types.ProcessorParameterName

ToLog ProcessorParameterName Source # 
Instance details

Defined in Amazonka.Firehose.Types.ProcessorParameterName

ToQuery ProcessorParameterName Source # 
Instance details

Defined in Amazonka.Firehose.Types.ProcessorParameterName

FromText ProcessorParameterName Source # 
Instance details

Defined in Amazonka.Firehose.Types.ProcessorParameterName

ToText ProcessorParameterName Source # 
Instance details

Defined in Amazonka.Firehose.Types.ProcessorParameterName

FromXML ProcessorParameterName Source # 
Instance details

Defined in Amazonka.Firehose.Types.ProcessorParameterName

ToXML ProcessorParameterName Source # 
Instance details

Defined in Amazonka.Firehose.Types.ProcessorParameterName

Generic ProcessorParameterName Source # 
Instance details

Defined in Amazonka.Firehose.Types.ProcessorParameterName

Associated Types

type Rep ProcessorParameterName :: Type -> Type #

Read ProcessorParameterName Source # 
Instance details

Defined in Amazonka.Firehose.Types.ProcessorParameterName

Show ProcessorParameterName Source # 
Instance details

Defined in Amazonka.Firehose.Types.ProcessorParameterName

NFData ProcessorParameterName Source # 
Instance details

Defined in Amazonka.Firehose.Types.ProcessorParameterName

Methods

rnf :: ProcessorParameterName -> () #

Eq ProcessorParameterName Source # 
Instance details

Defined in Amazonka.Firehose.Types.ProcessorParameterName

Ord ProcessorParameterName Source # 
Instance details

Defined in Amazonka.Firehose.Types.ProcessorParameterName

Hashable ProcessorParameterName Source # 
Instance details

Defined in Amazonka.Firehose.Types.ProcessorParameterName

type Rep ProcessorParameterName Source # 
Instance details

Defined in Amazonka.Firehose.Types.ProcessorParameterName

type Rep ProcessorParameterName = D1 ('MetaData "ProcessorParameterName" "Amazonka.Firehose.Types.ProcessorParameterName" "amazonka-kinesis-firehose-2.0-6l1hHmh2UnHBvolxuQFkWB" 'True) (C1 ('MetaCons "ProcessorParameterName'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromProcessorParameterName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

ProcessorType

newtype ProcessorType Source #

Constructors

ProcessorType' 

Instances

Instances details
FromJSON ProcessorType Source # 
Instance details

Defined in Amazonka.Firehose.Types.ProcessorType

FromJSONKey ProcessorType Source # 
Instance details

Defined in Amazonka.Firehose.Types.ProcessorType

ToJSON ProcessorType Source # 
Instance details

Defined in Amazonka.Firehose.Types.ProcessorType

ToJSONKey ProcessorType Source # 
Instance details

Defined in Amazonka.Firehose.Types.ProcessorType

ToByteString ProcessorType Source # 
Instance details

Defined in Amazonka.Firehose.Types.ProcessorType

ToHeader ProcessorType Source # 
Instance details

Defined in Amazonka.Firehose.Types.ProcessorType

ToLog ProcessorType Source # 
Instance details

Defined in Amazonka.Firehose.Types.ProcessorType

ToQuery ProcessorType Source # 
Instance details

Defined in Amazonka.Firehose.Types.ProcessorType

FromText ProcessorType Source # 
Instance details

Defined in Amazonka.Firehose.Types.ProcessorType

ToText ProcessorType Source # 
Instance details

Defined in Amazonka.Firehose.Types.ProcessorType

Methods

toText :: ProcessorType -> Text #

FromXML ProcessorType Source # 
Instance details

Defined in Amazonka.Firehose.Types.ProcessorType

ToXML ProcessorType Source # 
Instance details

Defined in Amazonka.Firehose.Types.ProcessorType

Methods

toXML :: ProcessorType -> XML #

Generic ProcessorType Source # 
Instance details

Defined in Amazonka.Firehose.Types.ProcessorType

Associated Types

type Rep ProcessorType :: Type -> Type #

Read ProcessorType Source # 
Instance details

Defined in Amazonka.Firehose.Types.ProcessorType

Show ProcessorType Source # 
Instance details

Defined in Amazonka.Firehose.Types.ProcessorType

NFData ProcessorType Source # 
Instance details

Defined in Amazonka.Firehose.Types.ProcessorType

Methods

rnf :: ProcessorType -> () #

Eq ProcessorType Source # 
Instance details

Defined in Amazonka.Firehose.Types.ProcessorType

Ord ProcessorType Source # 
Instance details

Defined in Amazonka.Firehose.Types.ProcessorType

Hashable ProcessorType Source # 
Instance details

Defined in Amazonka.Firehose.Types.ProcessorType

type Rep ProcessorType Source # 
Instance details

Defined in Amazonka.Firehose.Types.ProcessorType

type Rep ProcessorType = D1 ('MetaData "ProcessorType" "Amazonka.Firehose.Types.ProcessorType" "amazonka-kinesis-firehose-2.0-6l1hHmh2UnHBvolxuQFkWB" 'True) (C1 ('MetaCons "ProcessorType'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromProcessorType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

RedshiftS3BackupMode

newtype RedshiftS3BackupMode Source #

Instances

Instances details
FromJSON RedshiftS3BackupMode Source # 
Instance details

Defined in Amazonka.Firehose.Types.RedshiftS3BackupMode

FromJSONKey RedshiftS3BackupMode Source # 
Instance details

Defined in Amazonka.Firehose.Types.RedshiftS3BackupMode

ToJSON RedshiftS3BackupMode Source # 
Instance details

Defined in Amazonka.Firehose.Types.RedshiftS3BackupMode

ToJSONKey RedshiftS3BackupMode Source # 
Instance details

Defined in Amazonka.Firehose.Types.RedshiftS3BackupMode

ToByteString RedshiftS3BackupMode Source # 
Instance details

Defined in Amazonka.Firehose.Types.RedshiftS3BackupMode

ToHeader RedshiftS3BackupMode Source # 
Instance details

Defined in Amazonka.Firehose.Types.RedshiftS3BackupMode

ToLog RedshiftS3BackupMode Source # 
Instance details

Defined in Amazonka.Firehose.Types.RedshiftS3BackupMode

ToQuery RedshiftS3BackupMode Source # 
Instance details

Defined in Amazonka.Firehose.Types.RedshiftS3BackupMode

FromText RedshiftS3BackupMode Source # 
Instance details

Defined in Amazonka.Firehose.Types.RedshiftS3BackupMode

ToText RedshiftS3BackupMode Source # 
Instance details

Defined in Amazonka.Firehose.Types.RedshiftS3BackupMode

FromXML RedshiftS3BackupMode Source # 
Instance details

Defined in Amazonka.Firehose.Types.RedshiftS3BackupMode

ToXML RedshiftS3BackupMode Source # 
Instance details

Defined in Amazonka.Firehose.Types.RedshiftS3BackupMode

Generic RedshiftS3BackupMode Source # 
Instance details

Defined in Amazonka.Firehose.Types.RedshiftS3BackupMode

Associated Types

type Rep RedshiftS3BackupMode :: Type -> Type #

Read RedshiftS3BackupMode Source # 
Instance details

Defined in Amazonka.Firehose.Types.RedshiftS3BackupMode

Show RedshiftS3BackupMode Source # 
Instance details

Defined in Amazonka.Firehose.Types.RedshiftS3BackupMode

NFData RedshiftS3BackupMode Source # 
Instance details

Defined in Amazonka.Firehose.Types.RedshiftS3BackupMode

Methods

rnf :: RedshiftS3BackupMode -> () #

Eq RedshiftS3BackupMode Source # 
Instance details

Defined in Amazonka.Firehose.Types.RedshiftS3BackupMode

Ord RedshiftS3BackupMode Source # 
Instance details

Defined in Amazonka.Firehose.Types.RedshiftS3BackupMode

Hashable RedshiftS3BackupMode Source # 
Instance details

Defined in Amazonka.Firehose.Types.RedshiftS3BackupMode

type Rep RedshiftS3BackupMode Source # 
Instance details

Defined in Amazonka.Firehose.Types.RedshiftS3BackupMode

type Rep RedshiftS3BackupMode = D1 ('MetaData "RedshiftS3BackupMode" "Amazonka.Firehose.Types.RedshiftS3BackupMode" "amazonka-kinesis-firehose-2.0-6l1hHmh2UnHBvolxuQFkWB" 'True) (C1 ('MetaCons "RedshiftS3BackupMode'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromRedshiftS3BackupMode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

S3BackupMode

newtype S3BackupMode Source #

Constructors

S3BackupMode' 

Bundled Patterns

pattern S3BackupMode_Disabled :: S3BackupMode 
pattern S3BackupMode_Enabled :: S3BackupMode 

Instances

Instances details
FromJSON S3BackupMode Source # 
Instance details

Defined in Amazonka.Firehose.Types.S3BackupMode

FromJSONKey S3BackupMode Source # 
Instance details

Defined in Amazonka.Firehose.Types.S3BackupMode

ToJSON S3BackupMode Source # 
Instance details

Defined in Amazonka.Firehose.Types.S3BackupMode

ToJSONKey S3BackupMode Source # 
Instance details

Defined in Amazonka.Firehose.Types.S3BackupMode

ToByteString S3BackupMode Source # 
Instance details

Defined in Amazonka.Firehose.Types.S3BackupMode

ToHeader S3BackupMode Source # 
Instance details

Defined in Amazonka.Firehose.Types.S3BackupMode

ToLog S3BackupMode Source # 
Instance details

Defined in Amazonka.Firehose.Types.S3BackupMode

ToQuery S3BackupMode Source # 
Instance details

Defined in Amazonka.Firehose.Types.S3BackupMode

FromText S3BackupMode Source # 
Instance details

Defined in Amazonka.Firehose.Types.S3BackupMode

ToText S3BackupMode Source # 
Instance details

Defined in Amazonka.Firehose.Types.S3BackupMode

Methods

toText :: S3BackupMode -> Text #

FromXML S3BackupMode Source # 
Instance details

Defined in Amazonka.Firehose.Types.S3BackupMode

ToXML S3BackupMode Source # 
Instance details

Defined in Amazonka.Firehose.Types.S3BackupMode

Methods

toXML :: S3BackupMode -> XML #

Generic S3BackupMode Source # 
Instance details

Defined in Amazonka.Firehose.Types.S3BackupMode

Associated Types

type Rep S3BackupMode :: Type -> Type #

Read S3BackupMode Source # 
Instance details

Defined in Amazonka.Firehose.Types.S3BackupMode

Show S3BackupMode Source # 
Instance details

Defined in Amazonka.Firehose.Types.S3BackupMode

NFData S3BackupMode Source # 
Instance details

Defined in Amazonka.Firehose.Types.S3BackupMode

Methods

rnf :: S3BackupMode -> () #

Eq S3BackupMode Source # 
Instance details

Defined in Amazonka.Firehose.Types.S3BackupMode

Ord S3BackupMode Source # 
Instance details

Defined in Amazonka.Firehose.Types.S3BackupMode

Hashable S3BackupMode Source # 
Instance details

Defined in Amazonka.Firehose.Types.S3BackupMode

type Rep S3BackupMode Source # 
Instance details

Defined in Amazonka.Firehose.Types.S3BackupMode

type Rep S3BackupMode = D1 ('MetaData "S3BackupMode" "Amazonka.Firehose.Types.S3BackupMode" "amazonka-kinesis-firehose-2.0-6l1hHmh2UnHBvolxuQFkWB" 'True) (C1 ('MetaCons "S3BackupMode'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromS3BackupMode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

SplunkS3BackupMode

newtype SplunkS3BackupMode Source #

Instances

Instances details
FromJSON SplunkS3BackupMode Source # 
Instance details

Defined in Amazonka.Firehose.Types.SplunkS3BackupMode

FromJSONKey SplunkS3BackupMode Source # 
Instance details

Defined in Amazonka.Firehose.Types.SplunkS3BackupMode

ToJSON SplunkS3BackupMode Source # 
Instance details

Defined in Amazonka.Firehose.Types.SplunkS3BackupMode

ToJSONKey SplunkS3BackupMode Source # 
Instance details

Defined in Amazonka.Firehose.Types.SplunkS3BackupMode

ToByteString SplunkS3BackupMode Source # 
Instance details

Defined in Amazonka.Firehose.Types.SplunkS3BackupMode

ToHeader SplunkS3BackupMode Source # 
Instance details

Defined in Amazonka.Firehose.Types.SplunkS3BackupMode

ToLog SplunkS3BackupMode Source # 
Instance details

Defined in Amazonka.Firehose.Types.SplunkS3BackupMode

ToQuery SplunkS3BackupMode Source # 
Instance details

Defined in Amazonka.Firehose.Types.SplunkS3BackupMode

FromText SplunkS3BackupMode Source # 
Instance details

Defined in Amazonka.Firehose.Types.SplunkS3BackupMode

ToText SplunkS3BackupMode Source # 
Instance details

Defined in Amazonka.Firehose.Types.SplunkS3BackupMode

FromXML SplunkS3BackupMode Source # 
Instance details

Defined in Amazonka.Firehose.Types.SplunkS3BackupMode

ToXML SplunkS3BackupMode Source # 
Instance details

Defined in Amazonka.Firehose.Types.SplunkS3BackupMode

Generic SplunkS3BackupMode Source # 
Instance details

Defined in Amazonka.Firehose.Types.SplunkS3BackupMode

Associated Types

type Rep SplunkS3BackupMode :: Type -> Type #

Read SplunkS3BackupMode Source # 
Instance details

Defined in Amazonka.Firehose.Types.SplunkS3BackupMode

Show SplunkS3BackupMode Source # 
Instance details

Defined in Amazonka.Firehose.Types.SplunkS3BackupMode

NFData SplunkS3BackupMode Source # 
Instance details

Defined in Amazonka.Firehose.Types.SplunkS3BackupMode

Methods

rnf :: SplunkS3BackupMode -> () #

Eq SplunkS3BackupMode Source # 
Instance details

Defined in Amazonka.Firehose.Types.SplunkS3BackupMode

Ord SplunkS3BackupMode Source # 
Instance details

Defined in Amazonka.Firehose.Types.SplunkS3BackupMode

Hashable SplunkS3BackupMode Source # 
Instance details

Defined in Amazonka.Firehose.Types.SplunkS3BackupMode

type Rep SplunkS3BackupMode Source # 
Instance details

Defined in Amazonka.Firehose.Types.SplunkS3BackupMode

type Rep SplunkS3BackupMode = D1 ('MetaData "SplunkS3BackupMode" "Amazonka.Firehose.Types.SplunkS3BackupMode" "amazonka-kinesis-firehose-2.0-6l1hHmh2UnHBvolxuQFkWB" 'True) (C1 ('MetaCons "SplunkS3BackupMode'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromSplunkS3BackupMode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

AmazonOpenSearchServerlessBufferingHints

data AmazonOpenSearchServerlessBufferingHints Source #

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

See: newAmazonOpenSearchServerlessBufferingHints smart constructor.

Constructors

AmazonOpenSearchServerlessBufferingHints' 

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

Instances details
FromJSON AmazonOpenSearchServerlessBufferingHints Source # 
Instance details

Defined in Amazonka.Firehose.Types.AmazonOpenSearchServerlessBufferingHints

ToJSON AmazonOpenSearchServerlessBufferingHints Source # 
Instance details

Defined in Amazonka.Firehose.Types.AmazonOpenSearchServerlessBufferingHints

Generic AmazonOpenSearchServerlessBufferingHints Source # 
Instance details

Defined in Amazonka.Firehose.Types.AmazonOpenSearchServerlessBufferingHints

Read AmazonOpenSearchServerlessBufferingHints Source # 
Instance details

Defined in Amazonka.Firehose.Types.AmazonOpenSearchServerlessBufferingHints

Show AmazonOpenSearchServerlessBufferingHints Source # 
Instance details

Defined in Amazonka.Firehose.Types.AmazonOpenSearchServerlessBufferingHints

NFData AmazonOpenSearchServerlessBufferingHints Source # 
Instance details

Defined in Amazonka.Firehose.Types.AmazonOpenSearchServerlessBufferingHints

Eq AmazonOpenSearchServerlessBufferingHints Source # 
Instance details

Defined in Amazonka.Firehose.Types.AmazonOpenSearchServerlessBufferingHints

Hashable AmazonOpenSearchServerlessBufferingHints Source # 
Instance details

Defined in Amazonka.Firehose.Types.AmazonOpenSearchServerlessBufferingHints

type Rep AmazonOpenSearchServerlessBufferingHints Source # 
Instance details

Defined in Amazonka.Firehose.Types.AmazonOpenSearchServerlessBufferingHints

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

newAmazonOpenSearchServerlessBufferingHints :: AmazonOpenSearchServerlessBufferingHints Source #

Create a value of AmazonOpenSearchServerlessBufferingHints 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:AmazonOpenSearchServerlessBufferingHints', amazonOpenSearchServerlessBufferingHints_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:AmazonOpenSearchServerlessBufferingHints', amazonOpenSearchServerlessBufferingHints_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.

amazonOpenSearchServerlessBufferingHints_intervalInSeconds :: Lens' AmazonOpenSearchServerlessBufferingHints (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).

amazonOpenSearchServerlessBufferingHints_sizeInMBs :: Lens' AmazonOpenSearchServerlessBufferingHints (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.

AmazonOpenSearchServerlessDestinationConfiguration

data AmazonOpenSearchServerlessDestinationConfiguration Source #

Describes the configuration of a destination in the Serverless offering for Amazon OpenSearch Service.

See: newAmazonOpenSearchServerlessDestinationConfiguration smart constructor.

Constructors

AmazonOpenSearchServerlessDestinationConfiguration' 

Fields

Instances

Instances details
ToJSON AmazonOpenSearchServerlessDestinationConfiguration Source # 
Instance details

Defined in Amazonka.Firehose.Types.AmazonOpenSearchServerlessDestinationConfiguration

Generic AmazonOpenSearchServerlessDestinationConfiguration Source # 
Instance details

Defined in Amazonka.Firehose.Types.AmazonOpenSearchServerlessDestinationConfiguration

Read AmazonOpenSearchServerlessDestinationConfiguration Source # 
Instance details

Defined in Amazonka.Firehose.Types.AmazonOpenSearchServerlessDestinationConfiguration

Show AmazonOpenSearchServerlessDestinationConfiguration Source # 
Instance details

Defined in Amazonka.Firehose.Types.AmazonOpenSearchServerlessDestinationConfiguration

NFData AmazonOpenSearchServerlessDestinationConfiguration Source # 
Instance details

Defined in Amazonka.Firehose.Types.AmazonOpenSearchServerlessDestinationConfiguration

Eq AmazonOpenSearchServerlessDestinationConfiguration Source # 
Instance details

Defined in Amazonka.Firehose.Types.AmazonOpenSearchServerlessDestinationConfiguration

Hashable AmazonOpenSearchServerlessDestinationConfiguration Source # 
Instance details

Defined in Amazonka.Firehose.Types.AmazonOpenSearchServerlessDestinationConfiguration

type Rep AmazonOpenSearchServerlessDestinationConfiguration Source # 
Instance details

Defined in Amazonka.Firehose.Types.AmazonOpenSearchServerlessDestinationConfiguration

type Rep AmazonOpenSearchServerlessDestinationConfiguration = D1 ('MetaData "AmazonOpenSearchServerlessDestinationConfiguration" "Amazonka.Firehose.Types.AmazonOpenSearchServerlessDestinationConfiguration" "amazonka-kinesis-firehose-2.0-6l1hHmh2UnHBvolxuQFkWB" 'False) (C1 ('MetaCons "AmazonOpenSearchServerlessDestinationConfiguration'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "bufferingHints") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AmazonOpenSearchServerlessBufferingHints)) :*: S1 ('MetaSel ('Just "cloudWatchLoggingOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CloudWatchLoggingOptions))) :*: (S1 ('MetaSel ('Just "collectionEndpoint") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "processingConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ProcessingConfiguration)) :*: S1 ('MetaSel ('Just "retryOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AmazonOpenSearchServerlessRetryOptions))))) :*: ((S1 ('MetaSel ('Just "s3BackupMode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AmazonOpenSearchServerlessS3BackupMode)) :*: S1 ('MetaSel ('Just "vpcConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe VpcConfiguration))) :*: (S1 ('MetaSel ('Just "roleARN") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "indexName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "s3Configuration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 S3DestinationConfiguration))))))

newAmazonOpenSearchServerlessDestinationConfiguration Source #

Create a value of AmazonOpenSearchServerlessDestinationConfiguration 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:

AmazonOpenSearchServerlessDestinationConfiguration, amazonOpenSearchServerlessDestinationConfiguration_bufferingHints - The buffering options. If no value is specified, the default values for AmazonopensearchserviceBufferingHints are used.

AmazonOpenSearchServerlessDestinationConfiguration, amazonOpenSearchServerlessDestinationConfiguration_cloudWatchLoggingOptions - Undocumented member.

$sel:collectionEndpoint:AmazonOpenSearchServerlessDestinationConfiguration', amazonOpenSearchServerlessDestinationConfiguration_collectionEndpoint - The endpoint to use when communicating with the collection in the Serverless offering for Amazon OpenSearch Service.

$sel:processingConfiguration:AmazonOpenSearchServerlessDestinationConfiguration', amazonOpenSearchServerlessDestinationConfiguration_processingConfiguration - Undocumented member.

$sel:retryOptions:AmazonOpenSearchServerlessDestinationConfiguration', amazonOpenSearchServerlessDestinationConfiguration_retryOptions - The retry behavior in case Kinesis Data Firehose is unable to deliver documents to the Serverless offering for Amazon OpenSearch Service. The default value is 300 (5 minutes).

$sel:s3BackupMode:AmazonOpenSearchServerlessDestinationConfiguration', amazonOpenSearchServerlessDestinationConfiguration_s3BackupMode - Defines how documents should be delivered to Amazon S3. When it is set to FailedDocumentsOnly, Kinesis Data Firehose writes any documents that could not be indexed to the configured Amazon S3 destination, with AmazonOpenSearchService-failed/ appended to the key prefix. When set to AllDocuments, Kinesis Data Firehose delivers all incoming records to Amazon S3, and also writes failed documents with AmazonOpenSearchService-failed/ appended to the prefix.

$sel:vpcConfiguration:AmazonOpenSearchServerlessDestinationConfiguration', amazonOpenSearchServerlessDestinationConfiguration_vpcConfiguration - Undocumented member.

AmazonOpenSearchServerlessDestinationConfiguration, amazonOpenSearchServerlessDestinationConfiguration_roleARN - The Amazon Resource Name (ARN) of the IAM role to be assumed by Kinesis Data Firehose for calling the Serverless offering for Amazon OpenSearch Service Configuration API and for indexing documents.

$sel:indexName:AmazonOpenSearchServerlessDestinationConfiguration', amazonOpenSearchServerlessDestinationConfiguration_indexName - The Serverless offering for Amazon OpenSearch Service index name.

$sel:s3Configuration:AmazonOpenSearchServerlessDestinationConfiguration', amazonOpenSearchServerlessDestinationConfiguration_s3Configuration - Undocumented member.

amazonOpenSearchServerlessDestinationConfiguration_bufferingHints :: Lens' AmazonOpenSearchServerlessDestinationConfiguration (Maybe AmazonOpenSearchServerlessBufferingHints) Source #

The buffering options. If no value is specified, the default values for AmazonopensearchserviceBufferingHints are used.

amazonOpenSearchServerlessDestinationConfiguration_collectionEndpoint :: Lens' AmazonOpenSearchServerlessDestinationConfiguration (Maybe Text) Source #

The endpoint to use when communicating with the collection in the Serverless offering for Amazon OpenSearch Service.

amazonOpenSearchServerlessDestinationConfiguration_retryOptions :: Lens' AmazonOpenSearchServerlessDestinationConfiguration (Maybe AmazonOpenSearchServerlessRetryOptions) Source #

The retry behavior in case Kinesis Data Firehose is unable to deliver documents to the Serverless offering for Amazon OpenSearch Service. The default value is 300 (5 minutes).

amazonOpenSearchServerlessDestinationConfiguration_s3BackupMode :: Lens' AmazonOpenSearchServerlessDestinationConfiguration (Maybe AmazonOpenSearchServerlessS3BackupMode) Source #

Defines how documents should be delivered to Amazon S3. When it is set to FailedDocumentsOnly, Kinesis Data Firehose writes any documents that could not be indexed to the configured Amazon S3 destination, with AmazonOpenSearchService-failed/ appended to the key prefix. When set to AllDocuments, Kinesis Data Firehose delivers all incoming records to Amazon S3, and also writes failed documents with AmazonOpenSearchService-failed/ appended to the prefix.

amazonOpenSearchServerlessDestinationConfiguration_roleARN :: Lens' AmazonOpenSearchServerlessDestinationConfiguration Text Source #

The Amazon Resource Name (ARN) of the IAM role to be assumed by Kinesis Data Firehose for calling the Serverless offering for Amazon OpenSearch Service Configuration API and for indexing documents.

AmazonOpenSearchServerlessDestinationDescription

data AmazonOpenSearchServerlessDestinationDescription Source #

The destination description in the Serverless offering for Amazon OpenSearch Service.

See: newAmazonOpenSearchServerlessDestinationDescription smart constructor.

Constructors

AmazonOpenSearchServerlessDestinationDescription' 

Fields

Instances

Instances details
FromJSON AmazonOpenSearchServerlessDestinationDescription Source # 
Instance details

Defined in Amazonka.Firehose.Types.AmazonOpenSearchServerlessDestinationDescription

Generic AmazonOpenSearchServerlessDestinationDescription Source # 
Instance details

Defined in Amazonka.Firehose.Types.AmazonOpenSearchServerlessDestinationDescription

Read AmazonOpenSearchServerlessDestinationDescription Source # 
Instance details

Defined in Amazonka.Firehose.Types.AmazonOpenSearchServerlessDestinationDescription

Show AmazonOpenSearchServerlessDestinationDescription Source # 
Instance details

Defined in Amazonka.Firehose.Types.AmazonOpenSearchServerlessDestinationDescription

NFData AmazonOpenSearchServerlessDestinationDescription Source # 
Instance details

Defined in Amazonka.Firehose.Types.AmazonOpenSearchServerlessDestinationDescription

Eq AmazonOpenSearchServerlessDestinationDescription Source # 
Instance details

Defined in Amazonka.Firehose.Types.AmazonOpenSearchServerlessDestinationDescription

Hashable AmazonOpenSearchServerlessDestinationDescription Source # 
Instance details

Defined in Amazonka.Firehose.Types.AmazonOpenSearchServerlessDestinationDescription

type Rep AmazonOpenSearchServerlessDestinationDescription Source # 
Instance details

Defined in Amazonka.Firehose.Types.AmazonOpenSearchServerlessDestinationDescription

type Rep AmazonOpenSearchServerlessDestinationDescription = D1 ('MetaData "AmazonOpenSearchServerlessDestinationDescription" "Amazonka.Firehose.Types.AmazonOpenSearchServerlessDestinationDescription" "amazonka-kinesis-firehose-2.0-6l1hHmh2UnHBvolxuQFkWB" 'False) (C1 ('MetaCons "AmazonOpenSearchServerlessDestinationDescription'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "bufferingHints") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AmazonOpenSearchServerlessBufferingHints)) :*: S1 ('MetaSel ('Just "cloudWatchLoggingOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CloudWatchLoggingOptions))) :*: (S1 ('MetaSel ('Just "collectionEndpoint") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "indexName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "processingConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ProcessingConfiguration))))) :*: ((S1 ('MetaSel ('Just "retryOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AmazonOpenSearchServerlessRetryOptions)) :*: S1 ('MetaSel ('Just "roleARN") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "s3BackupMode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AmazonOpenSearchServerlessS3BackupMode)) :*: (S1 ('MetaSel ('Just "s3DestinationDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe S3DestinationDescription)) :*: S1 ('MetaSel ('Just "vpcConfigurationDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe VpcConfigurationDescription)))))))

newAmazonOpenSearchServerlessDestinationDescription :: AmazonOpenSearchServerlessDestinationDescription Source #

Create a value of AmazonOpenSearchServerlessDestinationDescription 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:

AmazonOpenSearchServerlessDestinationDescription, amazonOpenSearchServerlessDestinationDescription_bufferingHints - The buffering options.

AmazonOpenSearchServerlessDestinationDescription, amazonOpenSearchServerlessDestinationDescription_cloudWatchLoggingOptions - Undocumented member.

$sel:collectionEndpoint:AmazonOpenSearchServerlessDestinationDescription', amazonOpenSearchServerlessDestinationDescription_collectionEndpoint - The endpoint to use when communicating with the collection in the Serverless offering for Amazon OpenSearch Service.

$sel:indexName:AmazonOpenSearchServerlessDestinationDescription', amazonOpenSearchServerlessDestinationDescription_indexName - The Serverless offering for Amazon OpenSearch Service index name.

$sel:processingConfiguration:AmazonOpenSearchServerlessDestinationDescription', amazonOpenSearchServerlessDestinationDescription_processingConfiguration - Undocumented member.

$sel:retryOptions:AmazonOpenSearchServerlessDestinationDescription', amazonOpenSearchServerlessDestinationDescription_retryOptions - The Serverless offering for Amazon OpenSearch Service retry options.

AmazonOpenSearchServerlessDestinationDescription, amazonOpenSearchServerlessDestinationDescription_roleARN - The Amazon Resource Name (ARN) of the AWS credentials.

$sel:s3BackupMode:AmazonOpenSearchServerlessDestinationDescription', amazonOpenSearchServerlessDestinationDescription_s3BackupMode - The Amazon S3 backup mode.

$sel:s3DestinationDescription:AmazonOpenSearchServerlessDestinationDescription', amazonOpenSearchServerlessDestinationDescription_s3DestinationDescription - Undocumented member.

$sel:vpcConfigurationDescription:AmazonOpenSearchServerlessDestinationDescription', amazonOpenSearchServerlessDestinationDescription_vpcConfigurationDescription - Undocumented member.

amazonOpenSearchServerlessDestinationDescription_collectionEndpoint :: Lens' AmazonOpenSearchServerlessDestinationDescription (Maybe Text) Source #

The endpoint to use when communicating with the collection in the Serverless offering for Amazon OpenSearch Service.

AmazonOpenSearchServerlessDestinationUpdate

data AmazonOpenSearchServerlessDestinationUpdate Source #

Describes an update for a destination in the Serverless offering for Amazon OpenSearch Service.

See: newAmazonOpenSearchServerlessDestinationUpdate smart constructor.

Constructors

AmazonOpenSearchServerlessDestinationUpdate' 

Fields

Instances

Instances details
ToJSON AmazonOpenSearchServerlessDestinationUpdate Source # 
Instance details

Defined in Amazonka.Firehose.Types.AmazonOpenSearchServerlessDestinationUpdate

Generic AmazonOpenSearchServerlessDestinationUpdate Source # 
Instance details

Defined in Amazonka.Firehose.Types.AmazonOpenSearchServerlessDestinationUpdate

Read AmazonOpenSearchServerlessDestinationUpdate Source # 
Instance details

Defined in Amazonka.Firehose.Types.AmazonOpenSearchServerlessDestinationUpdate

Show AmazonOpenSearchServerlessDestinationUpdate Source # 
Instance details

Defined in Amazonka.Firehose.Types.AmazonOpenSearchServerlessDestinationUpdate

NFData AmazonOpenSearchServerlessDestinationUpdate Source # 
Instance details

Defined in Amazonka.Firehose.Types.AmazonOpenSearchServerlessDestinationUpdate

Eq AmazonOpenSearchServerlessDestinationUpdate Source # 
Instance details

Defined in Amazonka.Firehose.Types.AmazonOpenSearchServerlessDestinationUpdate

Hashable AmazonOpenSearchServerlessDestinationUpdate Source # 
Instance details

Defined in Amazonka.Firehose.Types.AmazonOpenSearchServerlessDestinationUpdate

type Rep AmazonOpenSearchServerlessDestinationUpdate Source # 
Instance details

Defined in Amazonka.Firehose.Types.AmazonOpenSearchServerlessDestinationUpdate

type Rep AmazonOpenSearchServerlessDestinationUpdate = D1 ('MetaData "AmazonOpenSearchServerlessDestinationUpdate" "Amazonka.Firehose.Types.AmazonOpenSearchServerlessDestinationUpdate" "amazonka-kinesis-firehose-2.0-6l1hHmh2UnHBvolxuQFkWB" 'False) (C1 ('MetaCons "AmazonOpenSearchServerlessDestinationUpdate'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "bufferingHints") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AmazonOpenSearchServerlessBufferingHints)) :*: S1 ('MetaSel ('Just "cloudWatchLoggingOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CloudWatchLoggingOptions))) :*: (S1 ('MetaSel ('Just "collectionEndpoint") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "indexName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "processingConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ProcessingConfiguration)) :*: S1 ('MetaSel ('Just "retryOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AmazonOpenSearchServerlessRetryOptions))) :*: (S1 ('MetaSel ('Just "roleARN") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "s3Update") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe S3DestinationUpdate))))))

newAmazonOpenSearchServerlessDestinationUpdate :: AmazonOpenSearchServerlessDestinationUpdate Source #

Create a value of AmazonOpenSearchServerlessDestinationUpdate 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:

AmazonOpenSearchServerlessDestinationUpdate, amazonOpenSearchServerlessDestinationUpdate_bufferingHints - The buffering options. If no value is specified, AmazonopensearchBufferingHints object default values are used.

AmazonOpenSearchServerlessDestinationUpdate, amazonOpenSearchServerlessDestinationUpdate_cloudWatchLoggingOptions - Undocumented member.

$sel:collectionEndpoint:AmazonOpenSearchServerlessDestinationUpdate', amazonOpenSearchServerlessDestinationUpdate_collectionEndpoint - The endpoint to use when communicating with the collection in the Serverless offering for Amazon OpenSearch Service.

$sel:indexName:AmazonOpenSearchServerlessDestinationUpdate', amazonOpenSearchServerlessDestinationUpdate_indexName - The Serverless offering for Amazon OpenSearch Service index name.

$sel:processingConfiguration:AmazonOpenSearchServerlessDestinationUpdate', amazonOpenSearchServerlessDestinationUpdate_processingConfiguration - Undocumented member.

$sel:retryOptions:AmazonOpenSearchServerlessDestinationUpdate', amazonOpenSearchServerlessDestinationUpdate_retryOptions - The retry behavior in case Kinesis Data Firehose is unable to deliver documents to the Serverless offering for Amazon OpenSearch Service. The default value is 300 (5 minutes).

AmazonOpenSearchServerlessDestinationUpdate, amazonOpenSearchServerlessDestinationUpdate_roleARN - The Amazon Resource Name (ARN) of the IAM role to be assumed by Kinesis Data Firehose for calling the Serverless offering for Amazon OpenSearch Service Configuration API and for indexing documents.

$sel:s3Update:AmazonOpenSearchServerlessDestinationUpdate', amazonOpenSearchServerlessDestinationUpdate_s3Update - Undocumented member.

amazonOpenSearchServerlessDestinationUpdate_bufferingHints :: Lens' AmazonOpenSearchServerlessDestinationUpdate (Maybe AmazonOpenSearchServerlessBufferingHints) Source #

The buffering options. If no value is specified, AmazonopensearchBufferingHints object default values are used.

amazonOpenSearchServerlessDestinationUpdate_collectionEndpoint :: Lens' AmazonOpenSearchServerlessDestinationUpdate (Maybe Text) Source #

The endpoint to use when communicating with the collection in the Serverless offering for Amazon OpenSearch Service.

amazonOpenSearchServerlessDestinationUpdate_retryOptions :: Lens' AmazonOpenSearchServerlessDestinationUpdate (Maybe AmazonOpenSearchServerlessRetryOptions) Source #

The retry behavior in case Kinesis Data Firehose is unable to deliver documents to the Serverless offering for Amazon OpenSearch Service. The default value is 300 (5 minutes).

amazonOpenSearchServerlessDestinationUpdate_roleARN :: Lens' AmazonOpenSearchServerlessDestinationUpdate (Maybe Text) Source #

The Amazon Resource Name (ARN) of the IAM role to be assumed by Kinesis Data Firehose for calling the Serverless offering for Amazon OpenSearch Service Configuration API and for indexing documents.

AmazonOpenSearchServerlessRetryOptions

data AmazonOpenSearchServerlessRetryOptions Source #

Configures retry behavior in case Kinesis Data Firehose is unable to deliver documents to the Serverless offering for Amazon OpenSearch Service.

See: newAmazonOpenSearchServerlessRetryOptions smart constructor.

Constructors

AmazonOpenSearchServerlessRetryOptions' 

Fields

  • durationInSeconds :: Maybe Natural

    After an initial failure to deliver to the Serverless offering for Amazon OpenSearch Service, the total amount of time during which Kinesis Data Firehose retries delivery (including the first attempt). After this time has elapsed, the failed documents are written to Amazon S3. Default value is 300 seconds (5 minutes). A value of 0 (zero) results in no retries.

Instances

Instances details
FromJSON AmazonOpenSearchServerlessRetryOptions Source # 
Instance details

Defined in Amazonka.Firehose.Types.AmazonOpenSearchServerlessRetryOptions

ToJSON AmazonOpenSearchServerlessRetryOptions Source # 
Instance details

Defined in Amazonka.Firehose.Types.AmazonOpenSearchServerlessRetryOptions

Generic AmazonOpenSearchServerlessRetryOptions Source # 
Instance details

Defined in Amazonka.Firehose.Types.AmazonOpenSearchServerlessRetryOptions

Read AmazonOpenSearchServerlessRetryOptions Source # 
Instance details

Defined in Amazonka.Firehose.Types.AmazonOpenSearchServerlessRetryOptions

Show AmazonOpenSearchServerlessRetryOptions Source # 
Instance details

Defined in Amazonka.Firehose.Types.AmazonOpenSearchServerlessRetryOptions

NFData AmazonOpenSearchServerlessRetryOptions Source # 
Instance details

Defined in Amazonka.Firehose.Types.AmazonOpenSearchServerlessRetryOptions

Eq AmazonOpenSearchServerlessRetryOptions Source # 
Instance details

Defined in Amazonka.Firehose.Types.AmazonOpenSearchServerlessRetryOptions

Hashable AmazonOpenSearchServerlessRetryOptions Source # 
Instance details

Defined in Amazonka.Firehose.Types.AmazonOpenSearchServerlessRetryOptions

type Rep AmazonOpenSearchServerlessRetryOptions Source # 
Instance details

Defined in Amazonka.Firehose.Types.AmazonOpenSearchServerlessRetryOptions

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

newAmazonOpenSearchServerlessRetryOptions :: AmazonOpenSearchServerlessRetryOptions Source #

Create a value of AmazonOpenSearchServerlessRetryOptions 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:durationInSeconds:AmazonOpenSearchServerlessRetryOptions', amazonOpenSearchServerlessRetryOptions_durationInSeconds - After an initial failure to deliver to the Serverless offering for Amazon OpenSearch Service, the total amount of time during which Kinesis Data Firehose retries delivery (including the first attempt). After this time has elapsed, the failed documents are written to Amazon S3. Default value is 300 seconds (5 minutes). A value of 0 (zero) results in no retries.

amazonOpenSearchServerlessRetryOptions_durationInSeconds :: Lens' AmazonOpenSearchServerlessRetryOptions (Maybe Natural) Source #

After an initial failure to deliver to the Serverless offering for Amazon OpenSearch Service, the total amount of time during which Kinesis Data Firehose retries delivery (including the first attempt). After this time has elapsed, the failed documents are written to Amazon S3. Default value is 300 seconds (5 minutes). A value of 0 (zero) results in no retries.

AmazonopensearchserviceBufferingHints

data AmazonopensearchserviceBufferingHints Source #

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

See: newAmazonopensearchserviceBufferingHints smart constructor.

Constructors

AmazonopensearchserviceBufferingHints' 

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

Instances details
FromJSON AmazonopensearchserviceBufferingHints Source # 
Instance details

Defined in Amazonka.Firehose.Types.AmazonopensearchserviceBufferingHints

ToJSON AmazonopensearchserviceBufferingHints Source # 
Instance details

Defined in Amazonka.Firehose.Types.AmazonopensearchserviceBufferingHints

Generic AmazonopensearchserviceBufferingHints Source # 
Instance details

Defined in Amazonka.Firehose.Types.AmazonopensearchserviceBufferingHints

Read AmazonopensearchserviceBufferingHints Source # 
Instance details

Defined in Amazonka.Firehose.Types.AmazonopensearchserviceBufferingHints

Show AmazonopensearchserviceBufferingHints Source # 
Instance details

Defined in Amazonka.Firehose.Types.AmazonopensearchserviceBufferingHints

NFData AmazonopensearchserviceBufferingHints Source # 
Instance details

Defined in Amazonka.Firehose.Types.AmazonopensearchserviceBufferingHints

Eq AmazonopensearchserviceBufferingHints Source # 
Instance details

Defined in Amazonka.Firehose.Types.AmazonopensearchserviceBufferingHints

Hashable AmazonopensearchserviceBufferingHints Source # 
Instance details

Defined in Amazonka.Firehose.Types.AmazonopensearchserviceBufferingHints

type Rep AmazonopensearchserviceBufferingHints Source # 
Instance details

Defined in Amazonka.Firehose.Types.AmazonopensearchserviceBufferingHints

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

newAmazonopensearchserviceBufferingHints :: AmazonopensearchserviceBufferingHints Source #

Create a value of AmazonopensearchserviceBufferingHints 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:AmazonopensearchserviceBufferingHints', amazonopensearchserviceBufferingHints_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:AmazonopensearchserviceBufferingHints', amazonopensearchserviceBufferingHints_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.

amazonopensearchserviceBufferingHints_intervalInSeconds :: Lens' AmazonopensearchserviceBufferingHints (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).

amazonopensearchserviceBufferingHints_sizeInMBs :: Lens' AmazonopensearchserviceBufferingHints (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.

AmazonopensearchserviceDestinationConfiguration

data AmazonopensearchserviceDestinationConfiguration Source #

Describes the configuration of a destination in Amazon OpenSearch Service

See: newAmazonopensearchserviceDestinationConfiguration smart constructor.

Constructors

AmazonopensearchserviceDestinationConfiguration' 

Fields

Instances

Instances details
ToJSON AmazonopensearchserviceDestinationConfiguration Source # 
Instance details

Defined in Amazonka.Firehose.Types.AmazonopensearchserviceDestinationConfiguration

Generic AmazonopensearchserviceDestinationConfiguration Source # 
Instance details

Defined in Amazonka.Firehose.Types.AmazonopensearchserviceDestinationConfiguration

Read AmazonopensearchserviceDestinationConfiguration Source # 
Instance details

Defined in Amazonka.Firehose.Types.AmazonopensearchserviceDestinationConfiguration

Show AmazonopensearchserviceDestinationConfiguration Source # 
Instance details

Defined in Amazonka.Firehose.Types.AmazonopensearchserviceDestinationConfiguration

NFData AmazonopensearchserviceDestinationConfiguration Source # 
Instance details

Defined in Amazonka.Firehose.Types.AmazonopensearchserviceDestinationConfiguration

Eq AmazonopensearchserviceDestinationConfiguration Source # 
Instance details

Defined in Amazonka.Firehose.Types.AmazonopensearchserviceDestinationConfiguration

Hashable AmazonopensearchserviceDestinationConfiguration Source # 
Instance details

Defined in Amazonka.Firehose.Types.AmazonopensearchserviceDestinationConfiguration

type Rep AmazonopensearchserviceDestinationConfiguration Source # 
Instance details

Defined in Amazonka.Firehose.Types.AmazonopensearchserviceDestinationConfiguration

type Rep AmazonopensearchserviceDestinationConfiguration = D1 ('MetaData "AmazonopensearchserviceDestinationConfiguration" "Amazonka.Firehose.Types.AmazonopensearchserviceDestinationConfiguration" "amazonka-kinesis-firehose-2.0-6l1hHmh2UnHBvolxuQFkWB" 'False) (C1 ('MetaCons "AmazonopensearchserviceDestinationConfiguration'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "bufferingHints") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AmazonopensearchserviceBufferingHints)) :*: (S1 ('MetaSel ('Just "cloudWatchLoggingOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CloudWatchLoggingOptions)) :*: S1 ('MetaSel ('Just "clusterEndpoint") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: (S1 ('MetaSel ('Just "domainARN") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "indexRotationPeriod") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AmazonopensearchserviceIndexRotationPeriod)) :*: S1 ('MetaSel ('Just "processingConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ProcessingConfiguration))))) :*: ((S1 ('MetaSel ('Just "retryOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AmazonopensearchserviceRetryOptions)) :*: (S1 ('MetaSel ('Just "s3BackupMode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AmazonopensearchserviceS3BackupMode)) :*: S1 ('MetaSel ('Just "typeName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "vpcConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe VpcConfiguration)) :*: S1 ('MetaSel ('Just "roleARN") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :*: (S1 ('MetaSel ('Just "indexName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "s3Configuration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 S3DestinationConfiguration))))))

newAmazonopensearchserviceDestinationConfiguration Source #

Create a value of AmazonopensearchserviceDestinationConfiguration 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:

AmazonopensearchserviceDestinationConfiguration, amazonopensearchserviceDestinationConfiguration_bufferingHints - The buffering options. If no value is specified, the default values for AmazonopensearchserviceBufferingHints are used.

AmazonopensearchserviceDestinationConfiguration, amazonopensearchserviceDestinationConfiguration_cloudWatchLoggingOptions - Undocumented member.

$sel:clusterEndpoint:AmazonopensearchserviceDestinationConfiguration', amazonopensearchserviceDestinationConfiguration_clusterEndpoint - The endpoint to use when communicating with the cluster. Specify either this ClusterEndpoint or the DomainARN field.

$sel:domainARN:AmazonopensearchserviceDestinationConfiguration', amazonopensearchserviceDestinationConfiguration_domainARN - The ARN of the Amazon OpenSearch Service domain. The IAM role must have permissions for DescribeElasticsearchDomain, DescribeElasticsearchDomains, and DescribeElasticsearchDomainConfig after assuming the role specified in RoleARN.

$sel:indexRotationPeriod:AmazonopensearchserviceDestinationConfiguration', amazonopensearchserviceDestinationConfiguration_indexRotationPeriod - The Amazon OpenSearch Service index rotation period. Index rotation appends a timestamp to the IndexName to facilitate the expiration of old data.

$sel:processingConfiguration:AmazonopensearchserviceDestinationConfiguration', amazonopensearchserviceDestinationConfiguration_processingConfiguration - Undocumented member.

$sel:retryOptions:AmazonopensearchserviceDestinationConfiguration', amazonopensearchserviceDestinationConfiguration_retryOptions - The retry behavior in case Kinesis Data Firehose is unable to deliver documents to Amazon OpenSearch Service. The default value is 300 (5 minutes).

$sel:s3BackupMode:AmazonopensearchserviceDestinationConfiguration', amazonopensearchserviceDestinationConfiguration_s3BackupMode - Defines how documents should be delivered to Amazon S3. When it is set to FailedDocumentsOnly, Kinesis Data Firehose writes any documents that could not be indexed to the configured Amazon S3 destination, with AmazonOpenSearchService-failed/ appended to the key prefix. When set to AllDocuments, Kinesis Data Firehose delivers all incoming records to Amazon S3, and also writes failed documents with AmazonOpenSearchService-failed/ appended to the prefix.

$sel:typeName:AmazonopensearchserviceDestinationConfiguration', amazonopensearchserviceDestinationConfiguration_typeName - The Amazon OpenSearch Service type name. For Elasticsearch 6.x, there can be only one type per index. If you try to specify a new type for an existing index that already has another type, Kinesis Data Firehose returns an error during run time.

$sel:vpcConfiguration:AmazonopensearchserviceDestinationConfiguration', amazonopensearchserviceDestinationConfiguration_vpcConfiguration - Undocumented member.

AmazonopensearchserviceDestinationConfiguration, amazonopensearchserviceDestinationConfiguration_roleARN - The Amazon Resource Name (ARN) of the IAM role to be assumed by Kinesis Data Firehose for calling the Amazon OpenSearch Service Configuration API and for indexing documents.

$sel:indexName:AmazonopensearchserviceDestinationConfiguration', amazonopensearchserviceDestinationConfiguration_indexName - The ElasticsearAmazon OpenSearch Service index name.

$sel:s3Configuration:AmazonopensearchserviceDestinationConfiguration', amazonopensearchserviceDestinationConfiguration_s3Configuration - Undocumented member.

amazonopensearchserviceDestinationConfiguration_bufferingHints :: Lens' AmazonopensearchserviceDestinationConfiguration (Maybe AmazonopensearchserviceBufferingHints) Source #

The buffering options. If no value is specified, the default values for AmazonopensearchserviceBufferingHints are used.

amazonopensearchserviceDestinationConfiguration_clusterEndpoint :: Lens' AmazonopensearchserviceDestinationConfiguration (Maybe Text) Source #

The endpoint to use when communicating with the cluster. Specify either this ClusterEndpoint or the DomainARN field.

amazonopensearchserviceDestinationConfiguration_domainARN :: Lens' AmazonopensearchserviceDestinationConfiguration (Maybe Text) Source #

The ARN of the Amazon OpenSearch Service domain. The IAM role must have permissions for DescribeElasticsearchDomain, DescribeElasticsearchDomains, and DescribeElasticsearchDomainConfig after assuming the role specified in RoleARN.

amazonopensearchserviceDestinationConfiguration_indexRotationPeriod :: Lens' AmazonopensearchserviceDestinationConfiguration (Maybe AmazonopensearchserviceIndexRotationPeriod) Source #

The Amazon OpenSearch Service index rotation period. Index rotation appends a timestamp to the IndexName to facilitate the expiration of old data.

amazonopensearchserviceDestinationConfiguration_retryOptions :: Lens' AmazonopensearchserviceDestinationConfiguration (Maybe AmazonopensearchserviceRetryOptions) Source #

The retry behavior in case Kinesis Data Firehose is unable to deliver documents to Amazon OpenSearch Service. The default value is 300 (5 minutes).

amazonopensearchserviceDestinationConfiguration_s3BackupMode :: Lens' AmazonopensearchserviceDestinationConfiguration (Maybe AmazonopensearchserviceS3BackupMode) Source #

Defines how documents should be delivered to Amazon S3. When it is set to FailedDocumentsOnly, Kinesis Data Firehose writes any documents that could not be indexed to the configured Amazon S3 destination, with AmazonOpenSearchService-failed/ appended to the key prefix. When set to AllDocuments, Kinesis Data Firehose delivers all incoming records to Amazon S3, and also writes failed documents with AmazonOpenSearchService-failed/ appended to the prefix.

amazonopensearchserviceDestinationConfiguration_typeName :: Lens' AmazonopensearchserviceDestinationConfiguration (Maybe Text) Source #

The Amazon OpenSearch Service type name. For Elasticsearch 6.x, there can be only one type per index. If you try to specify a new type for an existing index that already has another type, Kinesis Data Firehose returns an error during run time.

amazonopensearchserviceDestinationConfiguration_roleARN :: Lens' AmazonopensearchserviceDestinationConfiguration Text Source #

The Amazon Resource Name (ARN) of the IAM role to be assumed by Kinesis Data Firehose for calling the Amazon OpenSearch Service Configuration API and for indexing documents.

AmazonopensearchserviceDestinationDescription

data AmazonopensearchserviceDestinationDescription Source #

The destination description in Amazon OpenSearch Service.

See: newAmazonopensearchserviceDestinationDescription smart constructor.

Constructors

AmazonopensearchserviceDestinationDescription' 

Fields

Instances

Instances details
FromJSON AmazonopensearchserviceDestinationDescription Source # 
Instance details

Defined in Amazonka.Firehose.Types.AmazonopensearchserviceDestinationDescription

Generic AmazonopensearchserviceDestinationDescription Source # 
Instance details

Defined in Amazonka.Firehose.Types.AmazonopensearchserviceDestinationDescription

Read AmazonopensearchserviceDestinationDescription Source # 
Instance details

Defined in Amazonka.Firehose.Types.AmazonopensearchserviceDestinationDescription

Show AmazonopensearchserviceDestinationDescription Source # 
Instance details

Defined in Amazonka.Firehose.Types.AmazonopensearchserviceDestinationDescription

NFData AmazonopensearchserviceDestinationDescription Source # 
Instance details

Defined in Amazonka.Firehose.Types.AmazonopensearchserviceDestinationDescription

Eq AmazonopensearchserviceDestinationDescription Source # 
Instance details

Defined in Amazonka.Firehose.Types.AmazonopensearchserviceDestinationDescription

Hashable AmazonopensearchserviceDestinationDescription Source # 
Instance details

Defined in Amazonka.Firehose.Types.AmazonopensearchserviceDestinationDescription

type Rep AmazonopensearchserviceDestinationDescription Source # 
Instance details

Defined in Amazonka.Firehose.Types.AmazonopensearchserviceDestinationDescription

type Rep AmazonopensearchserviceDestinationDescription = D1 ('MetaData "AmazonopensearchserviceDestinationDescription" "Amazonka.Firehose.Types.AmazonopensearchserviceDestinationDescription" "amazonka-kinesis-firehose-2.0-6l1hHmh2UnHBvolxuQFkWB" 'False) (C1 ('MetaCons "AmazonopensearchserviceDestinationDescription'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "bufferingHints") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AmazonopensearchserviceBufferingHints)) :*: (S1 ('MetaSel ('Just "cloudWatchLoggingOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CloudWatchLoggingOptions)) :*: S1 ('MetaSel ('Just "clusterEndpoint") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: (S1 ('MetaSel ('Just "domainARN") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "indexName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "indexRotationPeriod") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AmazonopensearchserviceIndexRotationPeriod))))) :*: ((S1 ('MetaSel ('Just "processingConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ProcessingConfiguration)) :*: (S1 ('MetaSel ('Just "retryOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AmazonopensearchserviceRetryOptions)) :*: S1 ('MetaSel ('Just "roleARN") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "s3BackupMode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AmazonopensearchserviceS3BackupMode)) :*: S1 ('MetaSel ('Just "s3DestinationDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe S3DestinationDescription))) :*: (S1 ('MetaSel ('Just "typeName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "vpcConfigurationDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe VpcConfigurationDescription)))))))

newAmazonopensearchserviceDestinationDescription :: AmazonopensearchserviceDestinationDescription Source #

Create a value of AmazonopensearchserviceDestinationDescription 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:

AmazonopensearchserviceDestinationDescription, amazonopensearchserviceDestinationDescription_bufferingHints - The buffering options.

AmazonopensearchserviceDestinationDescription, amazonopensearchserviceDestinationDescription_cloudWatchLoggingOptions - Undocumented member.

$sel:clusterEndpoint:AmazonopensearchserviceDestinationDescription', amazonopensearchserviceDestinationDescription_clusterEndpoint - The endpoint to use when communicating with the cluster. Kinesis Data Firehose uses either this ClusterEndpoint or the DomainARN field to send data to Amazon OpenSearch Service.

$sel:domainARN:AmazonopensearchserviceDestinationDescription', amazonopensearchserviceDestinationDescription_domainARN - The ARN of the Amazon OpenSearch Service domain.

$sel:indexName:AmazonopensearchserviceDestinationDescription', amazonopensearchserviceDestinationDescription_indexName - The Amazon OpenSearch Service index name.

$sel:indexRotationPeriod:AmazonopensearchserviceDestinationDescription', amazonopensearchserviceDestinationDescription_indexRotationPeriod - The Amazon OpenSearch Service index rotation period

$sel:processingConfiguration:AmazonopensearchserviceDestinationDescription', amazonopensearchserviceDestinationDescription_processingConfiguration - Undocumented member.

$sel:retryOptions:AmazonopensearchserviceDestinationDescription', amazonopensearchserviceDestinationDescription_retryOptions - The Amazon OpenSearch Service retry options.

AmazonopensearchserviceDestinationDescription, amazonopensearchserviceDestinationDescription_roleARN - The Amazon Resource Name (ARN) of the Amazon Web Services credentials.

$sel:s3BackupMode:AmazonopensearchserviceDestinationDescription', amazonopensearchserviceDestinationDescription_s3BackupMode - The Amazon S3 backup mode.

$sel:s3DestinationDescription:AmazonopensearchserviceDestinationDescription', amazonopensearchserviceDestinationDescription_s3DestinationDescription - Undocumented member.

$sel:typeName:AmazonopensearchserviceDestinationDescription', amazonopensearchserviceDestinationDescription_typeName - The Amazon OpenSearch Service type name. This applies to Elasticsearch 6.x and lower versions. For Elasticsearch 7.x and OpenSearch Service 1.x, there's no value for TypeName.

$sel:vpcConfigurationDescription:AmazonopensearchserviceDestinationDescription', amazonopensearchserviceDestinationDescription_vpcConfigurationDescription - Undocumented member.

amazonopensearchserviceDestinationDescription_clusterEndpoint :: Lens' AmazonopensearchserviceDestinationDescription (Maybe Text) Source #

The endpoint to use when communicating with the cluster. Kinesis Data Firehose uses either this ClusterEndpoint or the DomainARN field to send data to Amazon OpenSearch Service.

amazonopensearchserviceDestinationDescription_roleARN :: Lens' AmazonopensearchserviceDestinationDescription (Maybe Text) Source #

The Amazon Resource Name (ARN) of the Amazon Web Services credentials.

amazonopensearchserviceDestinationDescription_typeName :: Lens' AmazonopensearchserviceDestinationDescription (Maybe Text) Source #

The Amazon OpenSearch Service type name. This applies to Elasticsearch 6.x and lower versions. For Elasticsearch 7.x and OpenSearch Service 1.x, there's no value for TypeName.

AmazonopensearchserviceDestinationUpdate

data AmazonopensearchserviceDestinationUpdate Source #

Describes an update for a destination in Amazon OpenSearch Service.

See: newAmazonopensearchserviceDestinationUpdate smart constructor.

Constructors

AmazonopensearchserviceDestinationUpdate' 

Fields

Instances

Instances details
ToJSON AmazonopensearchserviceDestinationUpdate Source # 
Instance details

Defined in Amazonka.Firehose.Types.AmazonopensearchserviceDestinationUpdate

Generic AmazonopensearchserviceDestinationUpdate Source # 
Instance details

Defined in Amazonka.Firehose.Types.AmazonopensearchserviceDestinationUpdate

Read AmazonopensearchserviceDestinationUpdate Source # 
Instance details

Defined in Amazonka.Firehose.Types.AmazonopensearchserviceDestinationUpdate

Show AmazonopensearchserviceDestinationUpdate Source # 
Instance details

Defined in Amazonka.Firehose.Types.AmazonopensearchserviceDestinationUpdate

NFData AmazonopensearchserviceDestinationUpdate Source # 
Instance details

Defined in Amazonka.Firehose.Types.AmazonopensearchserviceDestinationUpdate

Eq AmazonopensearchserviceDestinationUpdate Source # 
Instance details

Defined in Amazonka.Firehose.Types.AmazonopensearchserviceDestinationUpdate

Hashable AmazonopensearchserviceDestinationUpdate Source # 
Instance details

Defined in Amazonka.Firehose.Types.AmazonopensearchserviceDestinationUpdate

type Rep AmazonopensearchserviceDestinationUpdate Source # 
Instance details

Defined in Amazonka.Firehose.Types.AmazonopensearchserviceDestinationUpdate

type Rep AmazonopensearchserviceDestinationUpdate = D1 ('MetaData "AmazonopensearchserviceDestinationUpdate" "Amazonka.Firehose.Types.AmazonopensearchserviceDestinationUpdate" "amazonka-kinesis-firehose-2.0-6l1hHmh2UnHBvolxuQFkWB" 'False) (C1 ('MetaCons "AmazonopensearchserviceDestinationUpdate'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "bufferingHints") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AmazonopensearchserviceBufferingHints)) :*: S1 ('MetaSel ('Just "cloudWatchLoggingOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CloudWatchLoggingOptions))) :*: (S1 ('MetaSel ('Just "clusterEndpoint") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "domainARN") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "indexName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :*: ((S1 ('MetaSel ('Just "indexRotationPeriod") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AmazonopensearchserviceIndexRotationPeriod)) :*: (S1 ('MetaSel ('Just "processingConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ProcessingConfiguration)) :*: S1 ('MetaSel ('Just "retryOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AmazonopensearchserviceRetryOptions)))) :*: (S1 ('MetaSel ('Just "roleARN") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "s3Update") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe S3DestinationUpdate)) :*: S1 ('MetaSel ('Just "typeName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))))

newAmazonopensearchserviceDestinationUpdate :: AmazonopensearchserviceDestinationUpdate Source #

Create a value of AmazonopensearchserviceDestinationUpdate 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:

AmazonopensearchserviceDestinationUpdate, amazonopensearchserviceDestinationUpdate_bufferingHints - The buffering options. If no value is specified, AmazonopensearchBufferingHints object default values are used.

AmazonopensearchserviceDestinationUpdate, amazonopensearchserviceDestinationUpdate_cloudWatchLoggingOptions - Undocumented member.

$sel:clusterEndpoint:AmazonopensearchserviceDestinationUpdate', amazonopensearchserviceDestinationUpdate_clusterEndpoint - The endpoint to use when communicating with the cluster. Specify either this ClusterEndpoint or the DomainARN field.

$sel:domainARN:AmazonopensearchserviceDestinationUpdate', amazonopensearchserviceDestinationUpdate_domainARN - The ARN of the Amazon OpenSearch Service domain. The IAM role must have permissions for DescribeDomain, DescribeDomains, and DescribeDomainConfig after assuming the IAM role specified in RoleARN.

$sel:indexName:AmazonopensearchserviceDestinationUpdate', amazonopensearchserviceDestinationUpdate_indexName - The Amazon OpenSearch Service index name.

$sel:indexRotationPeriod:AmazonopensearchserviceDestinationUpdate', amazonopensearchserviceDestinationUpdate_indexRotationPeriod - The Amazon OpenSearch Service index rotation period. Index rotation appends a timestamp to IndexName to facilitate the expiration of old data.

$sel:processingConfiguration:AmazonopensearchserviceDestinationUpdate', amazonopensearchserviceDestinationUpdate_processingConfiguration - Undocumented member.

$sel:retryOptions:AmazonopensearchserviceDestinationUpdate', amazonopensearchserviceDestinationUpdate_retryOptions - The retry behavior in case Kinesis Data Firehose is unable to deliver documents to Amazon OpenSearch Service. The default value is 300 (5 minutes).

AmazonopensearchserviceDestinationUpdate, amazonopensearchserviceDestinationUpdate_roleARN - The Amazon Resource Name (ARN) of the IAM role to be assumed by Kinesis Data Firehose for calling the Amazon OpenSearch Service Configuration API and for indexing documents.

$sel:s3Update:AmazonopensearchserviceDestinationUpdate', amazonopensearchserviceDestinationUpdate_s3Update - Undocumented member.

$sel:typeName:AmazonopensearchserviceDestinationUpdate', amazonopensearchserviceDestinationUpdate_typeName - The Amazon OpenSearch Service type name. For Elasticsearch 6.x, there can be only one type per index. If you try to specify a new type for an existing index that already has another type, Kinesis Data Firehose returns an error during runtime.

If you upgrade Elasticsearch from 6.x to 7.x and don’t update your delivery stream, Kinesis Data Firehose still delivers data to Elasticsearch with the old index name and type name. If you want to update your delivery stream with a new index name, provide an empty string for TypeName.

amazonopensearchserviceDestinationUpdate_bufferingHints :: Lens' AmazonopensearchserviceDestinationUpdate (Maybe AmazonopensearchserviceBufferingHints) Source #

The buffering options. If no value is specified, AmazonopensearchBufferingHints object default values are used.

amazonopensearchserviceDestinationUpdate_clusterEndpoint :: Lens' AmazonopensearchserviceDestinationUpdate (Maybe Text) Source #

The endpoint to use when communicating with the cluster. Specify either this ClusterEndpoint or the DomainARN field.

amazonopensearchserviceDestinationUpdate_domainARN :: Lens' AmazonopensearchserviceDestinationUpdate (Maybe Text) Source #

The ARN of the Amazon OpenSearch Service domain. The IAM role must have permissions for DescribeDomain, DescribeDomains, and DescribeDomainConfig after assuming the IAM role specified in RoleARN.

amazonopensearchserviceDestinationUpdate_indexRotationPeriod :: Lens' AmazonopensearchserviceDestinationUpdate (Maybe AmazonopensearchserviceIndexRotationPeriod) Source #

The Amazon OpenSearch Service index rotation period. Index rotation appends a timestamp to IndexName to facilitate the expiration of old data.

amazonopensearchserviceDestinationUpdate_retryOptions :: Lens' AmazonopensearchserviceDestinationUpdate (Maybe AmazonopensearchserviceRetryOptions) Source #

The retry behavior in case Kinesis Data Firehose is unable to deliver documents to Amazon OpenSearch Service. The default value is 300 (5 minutes).

amazonopensearchserviceDestinationUpdate_roleARN :: Lens' AmazonopensearchserviceDestinationUpdate (Maybe Text) Source #

The Amazon Resource Name (ARN) of the IAM role to be assumed by Kinesis Data Firehose for calling the Amazon OpenSearch Service Configuration API and for indexing documents.

amazonopensearchserviceDestinationUpdate_typeName :: Lens' AmazonopensearchserviceDestinationUpdate (Maybe Text) Source #

The Amazon OpenSearch Service type name. For Elasticsearch 6.x, there can be only one type per index. If you try to specify a new type for an existing index that already has another type, Kinesis Data Firehose returns an error during runtime.

If you upgrade Elasticsearch from 6.x to 7.x and don’t update your delivery stream, Kinesis Data Firehose still delivers data to Elasticsearch with the old index name and type name. If you want to update your delivery stream with a new index name, provide an empty string for TypeName.

AmazonopensearchserviceRetryOptions

data AmazonopensearchserviceRetryOptions Source #

Configures retry behavior in case Kinesis Data Firehose is unable to deliver documents to Amazon OpenSearch Service.

See: newAmazonopensearchserviceRetryOptions smart constructor.

Constructors

AmazonopensearchserviceRetryOptions' 

Fields

  • durationInSeconds :: Maybe Natural

    After an initial failure to deliver to Amazon OpenSearch Service, the total amount of time during which Kinesis Data Firehose retries delivery (including the first attempt). After this time has elapsed, the failed documents are written to Amazon S3. Default value is 300 seconds (5 minutes). A value of 0 (zero) results in no retries.

Instances

Instances details
FromJSON AmazonopensearchserviceRetryOptions Source # 
Instance details

Defined in Amazonka.Firehose.Types.AmazonopensearchserviceRetryOptions

ToJSON AmazonopensearchserviceRetryOptions Source # 
Instance details

Defined in Amazonka.Firehose.Types.AmazonopensearchserviceRetryOptions

Generic AmazonopensearchserviceRetryOptions Source # 
Instance details

Defined in Amazonka.Firehose.Types.AmazonopensearchserviceRetryOptions

Read AmazonopensearchserviceRetryOptions Source # 
Instance details

Defined in Amazonka.Firehose.Types.AmazonopensearchserviceRetryOptions

Show AmazonopensearchserviceRetryOptions Source # 
Instance details

Defined in Amazonka.Firehose.Types.AmazonopensearchserviceRetryOptions

NFData AmazonopensearchserviceRetryOptions Source # 
Instance details

Defined in Amazonka.Firehose.Types.AmazonopensearchserviceRetryOptions

Eq AmazonopensearchserviceRetryOptions Source # 
Instance details

Defined in Amazonka.Firehose.Types.AmazonopensearchserviceRetryOptions

Hashable AmazonopensearchserviceRetryOptions Source # 
Instance details

Defined in Amazonka.Firehose.Types.AmazonopensearchserviceRetryOptions

type Rep AmazonopensearchserviceRetryOptions Source # 
Instance details

Defined in Amazonka.Firehose.Types.AmazonopensearchserviceRetryOptions

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

newAmazonopensearchserviceRetryOptions :: AmazonopensearchserviceRetryOptions Source #

Create a value of AmazonopensearchserviceRetryOptions 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:durationInSeconds:AmazonopensearchserviceRetryOptions', amazonopensearchserviceRetryOptions_durationInSeconds - After an initial failure to deliver to Amazon OpenSearch Service, the total amount of time during which Kinesis Data Firehose retries delivery (including the first attempt). After this time has elapsed, the failed documents are written to Amazon S3. Default value is 300 seconds (5 minutes). A value of 0 (zero) results in no retries.

amazonopensearchserviceRetryOptions_durationInSeconds :: Lens' AmazonopensearchserviceRetryOptions (Maybe Natural) Source #

After an initial failure to deliver to Amazon OpenSearch Service, the total amount of time during which Kinesis Data Firehose retries delivery (including the first attempt). After this time has elapsed, the failed documents are written to Amazon S3. Default value is 300 seconds (5 minutes). A value of 0 (zero) results in no retries.

BufferingHints

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

  • 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

Instances details
FromJSON BufferingHints Source # 
Instance details

Defined in Amazonka.Firehose.Types.BufferingHints

ToJSON 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 #

Read BufferingHints Source # 
Instance details

Defined in Amazonka.Firehose.Types.BufferingHints

Show BufferingHints Source # 
Instance details

Defined in Amazonka.Firehose.Types.BufferingHints

NFData BufferingHints Source # 
Instance details

Defined in Amazonka.Firehose.Types.BufferingHints

Methods

rnf :: BufferingHints -> () #

Eq BufferingHints Source # 
Instance details

Defined in Amazonka.Firehose.Types.BufferingHints

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

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.

CloudWatchLoggingOptions

data CloudWatchLoggingOptions Source #

Describes the Amazon CloudWatch logging options for your delivery stream.

See: newCloudWatchLoggingOptions smart constructor.

Constructors

CloudWatchLoggingOptions' 

Fields

  • enabled :: Maybe Bool

    Enables or disables CloudWatch logging.

  • logGroupName :: Maybe Text

    The CloudWatch group name for logging. This value is required if CloudWatch logging is enabled.

  • logStreamName :: Maybe Text

    The CloudWatch log stream name for logging. This value is required if CloudWatch logging is enabled.

Instances

Instances details
FromJSON CloudWatchLoggingOptions Source # 
Instance details

Defined in Amazonka.Firehose.Types.CloudWatchLoggingOptions

ToJSON CloudWatchLoggingOptions Source # 
Instance details

Defined in Amazonka.Firehose.Types.CloudWatchLoggingOptions

Generic CloudWatchLoggingOptions Source # 
Instance details

Defined in Amazonka.Firehose.Types.CloudWatchLoggingOptions

Associated Types

type Rep CloudWatchLoggingOptions :: Type -> Type #

Read CloudWatchLoggingOptions Source # 
Instance details

Defined in Amazonka.Firehose.Types.CloudWatchLoggingOptions

Show CloudWatchLoggingOptions Source # 
Instance details

Defined in Amazonka.Firehose.Types.CloudWatchLoggingOptions

NFData CloudWatchLoggingOptions Source # 
Instance details

Defined in Amazonka.Firehose.Types.CloudWatchLoggingOptions

Eq CloudWatchLoggingOptions Source # 
Instance details

Defined in Amazonka.Firehose.Types.CloudWatchLoggingOptions

Hashable CloudWatchLoggingOptions Source # 
Instance details

Defined in Amazonka.Firehose.Types.CloudWatchLoggingOptions

type Rep CloudWatchLoggingOptions Source # 
Instance details

Defined in Amazonka.Firehose.Types.CloudWatchLoggingOptions

type Rep CloudWatchLoggingOptions = D1 ('MetaData "CloudWatchLoggingOptions" "Amazonka.Firehose.Types.CloudWatchLoggingOptions" "amazonka-kinesis-firehose-2.0-6l1hHmh2UnHBvolxuQFkWB" 'False) (C1 ('MetaCons "CloudWatchLoggingOptions'" 'PrefixI 'True) (S1 ('MetaSel ('Just "enabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: (S1 ('MetaSel ('Just "logGroupName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "logStreamName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newCloudWatchLoggingOptions :: CloudWatchLoggingOptions Source #

Create a value of CloudWatchLoggingOptions 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:enabled:CloudWatchLoggingOptions', cloudWatchLoggingOptions_enabled - Enables or disables CloudWatch logging.

$sel:logGroupName:CloudWatchLoggingOptions', cloudWatchLoggingOptions_logGroupName - The CloudWatch group name for logging. This value is required if CloudWatch logging is enabled.

$sel:logStreamName:CloudWatchLoggingOptions', cloudWatchLoggingOptions_logStreamName - The CloudWatch log stream name for logging. This value is required if CloudWatch logging is enabled.

cloudWatchLoggingOptions_logGroupName :: Lens' CloudWatchLoggingOptions (Maybe Text) Source #

The CloudWatch group name for logging. This value is required if CloudWatch logging is enabled.

cloudWatchLoggingOptions_logStreamName :: Lens' CloudWatchLoggingOptions (Maybe Text) Source #

The CloudWatch log stream name for logging. This value is required if CloudWatch logging is enabled.

CopyCommand

data CopyCommand Source #

Describes a COPY command for Amazon Redshift.

See: newCopyCommand smart constructor.

Constructors

CopyCommand' 

Fields

  • copyOptions :: Maybe Text

    Optional parameters to use with the Amazon Redshift COPY command. For more information, see the "Optional Parameters" section of Amazon Redshift COPY command. Some possible examples that would apply to Kinesis Data Firehose are as follows:

    delimiter '\t' lzop; - fields are delimited with "\t" (TAB character) and compressed using lzop.

    delimiter '|' - fields are delimited with "|" (this is the default delimiter).

    delimiter '|' escape - the delimiter should be escaped.

    fixedwidth 'venueid:3,venuename:25,venuecity:12,venuestate:2,venueseats:6' - fields are fixed width in the source, with each width specified after every column in the table.

    JSON 's3://mybucket/jsonpaths.txt' - data is in JSON format, and the path specified is the format of the data.

    For more examples, see Amazon Redshift COPY command examples.

  • dataTableColumns :: Maybe Text

    A comma-separated list of column names.

  • dataTableName :: Text

    The name of the target table. The table must already exist in the database.

Instances

Instances details
FromJSON CopyCommand Source # 
Instance details

Defined in Amazonka.Firehose.Types.CopyCommand

ToJSON CopyCommand Source # 
Instance details

Defined in Amazonka.Firehose.Types.CopyCommand

Generic CopyCommand Source # 
Instance details

Defined in Amazonka.Firehose.Types.CopyCommand

Associated Types

type Rep CopyCommand :: Type -> Type #

Read CopyCommand Source # 
Instance details

Defined in Amazonka.Firehose.Types.CopyCommand

Show CopyCommand Source # 
Instance details

Defined in Amazonka.Firehose.Types.CopyCommand

NFData CopyCommand Source # 
Instance details

Defined in Amazonka.Firehose.Types.CopyCommand

Methods

rnf :: CopyCommand -> () #

Eq CopyCommand Source # 
Instance details

Defined in Amazonka.Firehose.Types.CopyCommand

Hashable CopyCommand Source # 
Instance details

Defined in Amazonka.Firehose.Types.CopyCommand

type Rep CopyCommand Source # 
Instance details

Defined in Amazonka.Firehose.Types.CopyCommand

type Rep CopyCommand = D1 ('MetaData "CopyCommand" "Amazonka.Firehose.Types.CopyCommand" "amazonka-kinesis-firehose-2.0-6l1hHmh2UnHBvolxuQFkWB" 'False) (C1 ('MetaCons "CopyCommand'" 'PrefixI 'True) (S1 ('MetaSel ('Just "copyOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "dataTableColumns") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "dataTableName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newCopyCommand Source #

Create a value of CopyCommand 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:copyOptions:CopyCommand', copyCommand_copyOptions - Optional parameters to use with the Amazon Redshift COPY command. For more information, see the "Optional Parameters" section of Amazon Redshift COPY command. Some possible examples that would apply to Kinesis Data Firehose are as follows:

delimiter '\t' lzop; - fields are delimited with "\t" (TAB character) and compressed using lzop.

delimiter '|' - fields are delimited with "|" (this is the default delimiter).

delimiter '|' escape - the delimiter should be escaped.

fixedwidth 'venueid:3,venuename:25,venuecity:12,venuestate:2,venueseats:6' - fields are fixed width in the source, with each width specified after every column in the table.

JSON 's3://mybucket/jsonpaths.txt' - data is in JSON format, and the path specified is the format of the data.

For more examples, see Amazon Redshift COPY command examples.

$sel:dataTableColumns:CopyCommand', copyCommand_dataTableColumns - A comma-separated list of column names.

$sel:dataTableName:CopyCommand', copyCommand_dataTableName - The name of the target table. The table must already exist in the database.

copyCommand_copyOptions :: Lens' CopyCommand (Maybe Text) Source #

Optional parameters to use with the Amazon Redshift COPY command. For more information, see the "Optional Parameters" section of Amazon Redshift COPY command. Some possible examples that would apply to Kinesis Data Firehose are as follows:

delimiter '\t' lzop; - fields are delimited with "\t" (TAB character) and compressed using lzop.

delimiter '|' - fields are delimited with "|" (this is the default delimiter).

delimiter '|' escape - the delimiter should be escaped.

fixedwidth 'venueid:3,venuename:25,venuecity:12,venuestate:2,venueseats:6' - fields are fixed width in the source, with each width specified after every column in the table.

JSON 's3://mybucket/jsonpaths.txt' - data is in JSON format, and the path specified is the format of the data.

For more examples, see Amazon Redshift COPY command examples.

copyCommand_dataTableColumns :: Lens' CopyCommand (Maybe Text) Source #

A comma-separated list of column names.

copyCommand_dataTableName :: Lens' CopyCommand Text Source #

The name of the target table. The table must already exist in the database.

DataFormatConversionConfiguration

data DataFormatConversionConfiguration Source #

Specifies that you want Kinesis Data Firehose to convert data from the JSON format to the Parquet or ORC format before writing it to Amazon S3. Kinesis Data Firehose uses the serializer and deserializer that you specify, in addition to the column information from the Amazon Web Services Glue table, to deserialize your input data from JSON and then serialize it to the Parquet or ORC format. For more information, see Kinesis Data Firehose Record Format Conversion.

See: newDataFormatConversionConfiguration smart constructor.

Constructors

DataFormatConversionConfiguration' 

Fields

Instances

Instances details
FromJSON DataFormatConversionConfiguration Source # 
Instance details

Defined in Amazonka.Firehose.Types.DataFormatConversionConfiguration

ToJSON DataFormatConversionConfiguration Source # 
Instance details

Defined in Amazonka.Firehose.Types.DataFormatConversionConfiguration

Generic DataFormatConversionConfiguration Source # 
Instance details

Defined in Amazonka.Firehose.Types.DataFormatConversionConfiguration

Associated Types

type Rep DataFormatConversionConfiguration :: Type -> Type #

Read DataFormatConversionConfiguration Source # 
Instance details

Defined in Amazonka.Firehose.Types.DataFormatConversionConfiguration

Show DataFormatConversionConfiguration Source # 
Instance details

Defined in Amazonka.Firehose.Types.DataFormatConversionConfiguration

NFData DataFormatConversionConfiguration Source # 
Instance details

Defined in Amazonka.Firehose.Types.DataFormatConversionConfiguration

Eq DataFormatConversionConfiguration Source # 
Instance details

Defined in Amazonka.Firehose.Types.DataFormatConversionConfiguration

Hashable DataFormatConversionConfiguration Source # 
Instance details

Defined in Amazonka.Firehose.Types.DataFormatConversionConfiguration

type Rep DataFormatConversionConfiguration Source # 
Instance details

Defined in Amazonka.Firehose.Types.DataFormatConversionConfiguration

type Rep DataFormatConversionConfiguration = D1 ('MetaData "DataFormatConversionConfiguration" "Amazonka.Firehose.Types.DataFormatConversionConfiguration" "amazonka-kinesis-firehose-2.0-6l1hHmh2UnHBvolxuQFkWB" 'False) (C1 ('MetaCons "DataFormatConversionConfiguration'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "enabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "inputFormatConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe InputFormatConfiguration))) :*: (S1 ('MetaSel ('Just "outputFormatConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe OutputFormatConfiguration)) :*: S1 ('MetaSel ('Just "schemaConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SchemaConfiguration)))))

newDataFormatConversionConfiguration :: DataFormatConversionConfiguration Source #

Create a value of DataFormatConversionConfiguration 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:enabled:DataFormatConversionConfiguration', dataFormatConversionConfiguration_enabled - Defaults to true. Set it to false if you want to disable format conversion while preserving the configuration details.

$sel:inputFormatConfiguration:DataFormatConversionConfiguration', dataFormatConversionConfiguration_inputFormatConfiguration - Specifies the deserializer that you want Kinesis Data Firehose to use to convert the format of your data from JSON. This parameter is required if Enabled is set to true.

$sel:outputFormatConfiguration:DataFormatConversionConfiguration', dataFormatConversionConfiguration_outputFormatConfiguration - Specifies the serializer that you want Kinesis Data Firehose to use to convert the format of your data to the Parquet or ORC format. This parameter is required if Enabled is set to true.

$sel:schemaConfiguration:DataFormatConversionConfiguration', dataFormatConversionConfiguration_schemaConfiguration - Specifies the Amazon Web Services Glue Data Catalog table that contains the column information. This parameter is required if Enabled is set to true.

dataFormatConversionConfiguration_enabled :: Lens' DataFormatConversionConfiguration (Maybe Bool) Source #

Defaults to true. Set it to false if you want to disable format conversion while preserving the configuration details.

dataFormatConversionConfiguration_inputFormatConfiguration :: Lens' DataFormatConversionConfiguration (Maybe InputFormatConfiguration) Source #

Specifies the deserializer that you want Kinesis Data Firehose to use to convert the format of your data from JSON. This parameter is required if Enabled is set to true.

dataFormatConversionConfiguration_outputFormatConfiguration :: Lens' DataFormatConversionConfiguration (Maybe OutputFormatConfiguration) Source #

Specifies the serializer that you want Kinesis Data Firehose to use to convert the format of your data to the Parquet or ORC format. This parameter is required if Enabled is set to true.

dataFormatConversionConfiguration_schemaConfiguration :: Lens' DataFormatConversionConfiguration (Maybe SchemaConfiguration) Source #

Specifies the Amazon Web Services Glue Data Catalog table that contains the column information. This parameter is required if Enabled is set to true.

DeliveryStreamDescription

data DeliveryStreamDescription Source #

Contains information about a delivery stream.

See: newDeliveryStreamDescription smart constructor.

Constructors

DeliveryStreamDescription' 

Fields

Instances

Instances details
FromJSON DeliveryStreamDescription Source # 
Instance details

Defined in Amazonka.Firehose.Types.DeliveryStreamDescription

Generic DeliveryStreamDescription Source # 
Instance details

Defined in Amazonka.Firehose.Types.DeliveryStreamDescription

Associated Types

type Rep DeliveryStreamDescription :: Type -> Type #

Show DeliveryStreamDescription Source # 
Instance details

Defined in Amazonka.Firehose.Types.DeliveryStreamDescription

NFData DeliveryStreamDescription Source # 
Instance details

Defined in Amazonka.Firehose.Types.DeliveryStreamDescription

Eq DeliveryStreamDescription Source # 
Instance details

Defined in Amazonka.Firehose.Types.DeliveryStreamDescription

Hashable DeliveryStreamDescription Source # 
Instance details

Defined in Amazonka.Firehose.Types.DeliveryStreamDescription

type Rep DeliveryStreamDescription Source # 
Instance details

Defined in Amazonka.Firehose.Types.DeliveryStreamDescription

type Rep DeliveryStreamDescription = D1 ('MetaData "DeliveryStreamDescription" "Amazonka.Firehose.Types.DeliveryStreamDescription" "amazonka-kinesis-firehose-2.0-6l1hHmh2UnHBvolxuQFkWB" 'False) (C1 ('MetaCons "DeliveryStreamDescription'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "createTimestamp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: (S1 ('MetaSel ('Just "deliveryStreamEncryptionConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DeliveryStreamEncryptionConfiguration)) :*: S1 ('MetaSel ('Just "failureDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe FailureDescription)))) :*: (S1 ('MetaSel ('Just "lastUpdateTimestamp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: (S1 ('MetaSel ('Just "source") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SourceDescription)) :*: S1 ('MetaSel ('Just "deliveryStreamName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))) :*: ((S1 ('MetaSel ('Just "deliveryStreamARN") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "deliveryStreamStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 DeliveryStreamStatus) :*: S1 ('MetaSel ('Just "deliveryStreamType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 DeliveryStreamType))) :*: (S1 ('MetaSel ('Just "versionId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "destinations") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [DestinationDescription]) :*: S1 ('MetaSel ('Just "hasMoreDestinations") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool))))))

newDeliveryStreamDescription Source #

Create a value of DeliveryStreamDescription 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:createTimestamp:DeliveryStreamDescription', deliveryStreamDescription_createTimestamp - The date and time that the delivery stream was created.

$sel:deliveryStreamEncryptionConfiguration:DeliveryStreamDescription', deliveryStreamDescription_deliveryStreamEncryptionConfiguration - Indicates the server-side encryption (SSE) status for the delivery stream.

DeliveryStreamDescription, deliveryStreamDescription_failureDescription - Provides details in case one of the following operations fails due to an error related to KMS: CreateDeliveryStream, DeleteDeliveryStream, StartDeliveryStreamEncryption, StopDeliveryStreamEncryption.

$sel:lastUpdateTimestamp:DeliveryStreamDescription', deliveryStreamDescription_lastUpdateTimestamp - The date and time that the delivery stream was last updated.

$sel:source:DeliveryStreamDescription', deliveryStreamDescription_source - If the DeliveryStreamType parameter is KinesisStreamAsSource, a SourceDescription object describing the source Kinesis data stream.

$sel:deliveryStreamName:DeliveryStreamDescription', deliveryStreamDescription_deliveryStreamName - The name of the delivery stream.

$sel:deliveryStreamARN:DeliveryStreamDescription', deliveryStreamDescription_deliveryStreamARN - The Amazon Resource Name (ARN) of the delivery stream. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.

$sel:deliveryStreamStatus:DeliveryStreamDescription', deliveryStreamDescription_deliveryStreamStatus - The status of the delivery stream. If the status of a delivery stream is CREATING_FAILED, this status doesn't change, and you can't invoke CreateDeliveryStream again on it. However, you can invoke the DeleteDeliveryStream operation to delete it.

$sel:deliveryStreamType:DeliveryStreamDescription', deliveryStreamDescription_deliveryStreamType - The delivery stream type. This can be one of the following values:

  • DirectPut: Provider applications access the delivery stream directly.
  • KinesisStreamAsSource: The delivery stream uses a Kinesis data stream as a source.

$sel:versionId:DeliveryStreamDescription', deliveryStreamDescription_versionId - Each time the destination is updated for a delivery stream, the version ID is changed, and the current version ID is required when updating the destination. This is so that the service knows it is applying the changes to the correct version of the delivery stream.

$sel:destinations:DeliveryStreamDescription', deliveryStreamDescription_destinations - The destinations.

$sel:hasMoreDestinations:DeliveryStreamDescription', deliveryStreamDescription_hasMoreDestinations - Indicates whether there are more destinations available to list.

deliveryStreamDescription_createTimestamp :: Lens' DeliveryStreamDescription (Maybe UTCTime) Source #

The date and time that the delivery stream was created.

deliveryStreamDescription_failureDescription :: Lens' DeliveryStreamDescription (Maybe FailureDescription) Source #

Provides details in case one of the following operations fails due to an error related to KMS: CreateDeliveryStream, DeleteDeliveryStream, StartDeliveryStreamEncryption, StopDeliveryStreamEncryption.

deliveryStreamDescription_lastUpdateTimestamp :: Lens' DeliveryStreamDescription (Maybe UTCTime) Source #

The date and time that the delivery stream was last updated.

deliveryStreamDescription_source :: Lens' DeliveryStreamDescription (Maybe SourceDescription) Source #

If the DeliveryStreamType parameter is KinesisStreamAsSource, a SourceDescription object describing the source Kinesis data stream.

deliveryStreamDescription_deliveryStreamStatus :: Lens' DeliveryStreamDescription DeliveryStreamStatus Source #

The status of the delivery stream. If the status of a delivery stream is CREATING_FAILED, this status doesn't change, and you can't invoke CreateDeliveryStream again on it. However, you can invoke the DeleteDeliveryStream operation to delete it.

deliveryStreamDescription_deliveryStreamType :: Lens' DeliveryStreamDescription DeliveryStreamType Source #

The delivery stream type. This can be one of the following values:

  • DirectPut: Provider applications access the delivery stream directly.
  • KinesisStreamAsSource: The delivery stream uses a Kinesis data stream as a source.

deliveryStreamDescription_versionId :: Lens' DeliveryStreamDescription Text Source #

Each time the destination is updated for a delivery stream, the version ID is changed, and the current version ID is required when updating the destination. This is so that the service knows it is applying the changes to the correct version of the delivery stream.

deliveryStreamDescription_hasMoreDestinations :: Lens' DeliveryStreamDescription Bool Source #

Indicates whether there are more destinations available to list.

DeliveryStreamEncryptionConfiguration

data DeliveryStreamEncryptionConfiguration Source #

Contains information about the server-side encryption (SSE) status for the delivery stream, the type customer master key (CMK) in use, if any, and the ARN of the CMK. You can get DeliveryStreamEncryptionConfiguration by invoking the DescribeDeliveryStream operation.

See: newDeliveryStreamEncryptionConfiguration smart constructor.

Constructors

DeliveryStreamEncryptionConfiguration' 

Fields

  • failureDescription :: Maybe FailureDescription

    Provides details in case one of the following operations fails due to an error related to KMS: CreateDeliveryStream, DeleteDeliveryStream, StartDeliveryStreamEncryption, StopDeliveryStreamEncryption.

  • keyARN :: Maybe Text

    If KeyType is CUSTOMER_MANAGED_CMK, this field contains the ARN of the customer managed CMK. If KeyType is Amazon Web Services_OWNED_CMK, DeliveryStreamEncryptionConfiguration doesn't contain a value for KeyARN.

  • keyType :: Maybe KeyType

    Indicates the type of customer master key (CMK) that is used for encryption. The default setting is Amazon Web Services_OWNED_CMK. For more information about CMKs, see Customer Master Keys (CMKs).

  • status :: Maybe DeliveryStreamEncryptionStatus

    This is the server-side encryption (SSE) status for the delivery stream. For a full description of the different values of this status, see StartDeliveryStreamEncryption and StopDeliveryStreamEncryption. If this status is ENABLING_FAILED or DISABLING_FAILED, it is the status of the most recent attempt to enable or disable SSE, respectively.

Instances

Instances details
FromJSON DeliveryStreamEncryptionConfiguration Source # 
Instance details

Defined in Amazonka.Firehose.Types.DeliveryStreamEncryptionConfiguration

Generic DeliveryStreamEncryptionConfiguration Source # 
Instance details

Defined in Amazonka.Firehose.Types.DeliveryStreamEncryptionConfiguration

Read DeliveryStreamEncryptionConfiguration Source # 
Instance details

Defined in Amazonka.Firehose.Types.DeliveryStreamEncryptionConfiguration

Show DeliveryStreamEncryptionConfiguration Source # 
Instance details

Defined in Amazonka.Firehose.Types.DeliveryStreamEncryptionConfiguration

NFData DeliveryStreamEncryptionConfiguration Source # 
Instance details

Defined in Amazonka.Firehose.Types.DeliveryStreamEncryptionConfiguration

Eq DeliveryStreamEncryptionConfiguration Source # 
Instance details

Defined in Amazonka.Firehose.Types.DeliveryStreamEncryptionConfiguration

Hashable DeliveryStreamEncryptionConfiguration Source # 
Instance details

Defined in Amazonka.Firehose.Types.DeliveryStreamEncryptionConfiguration

type Rep DeliveryStreamEncryptionConfiguration Source # 
Instance details

Defined in Amazonka.Firehose.Types.DeliveryStreamEncryptionConfiguration

type Rep DeliveryStreamEncryptionConfiguration = D1 ('MetaData "DeliveryStreamEncryptionConfiguration" "Amazonka.Firehose.Types.DeliveryStreamEncryptionConfiguration" "amazonka-kinesis-firehose-2.0-6l1hHmh2UnHBvolxuQFkWB" 'False) (C1 ('MetaCons "DeliveryStreamEncryptionConfiguration'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "failureDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe FailureDescription)) :*: S1 ('MetaSel ('Just "keyARN") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "keyType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe KeyType)) :*: S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DeliveryStreamEncryptionStatus)))))

newDeliveryStreamEncryptionConfiguration :: DeliveryStreamEncryptionConfiguration Source #

Create a value of DeliveryStreamEncryptionConfiguration 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:failureDescription:DeliveryStreamEncryptionConfiguration', deliveryStreamEncryptionConfiguration_failureDescription - Provides details in case one of the following operations fails due to an error related to KMS: CreateDeliveryStream, DeleteDeliveryStream, StartDeliveryStreamEncryption, StopDeliveryStreamEncryption.

$sel:keyARN:DeliveryStreamEncryptionConfiguration', deliveryStreamEncryptionConfiguration_keyARN - If KeyType is CUSTOMER_MANAGED_CMK, this field contains the ARN of the customer managed CMK. If KeyType is Amazon Web Services_OWNED_CMK, DeliveryStreamEncryptionConfiguration doesn't contain a value for KeyARN.

$sel:keyType:DeliveryStreamEncryptionConfiguration', deliveryStreamEncryptionConfiguration_keyType - Indicates the type of customer master key (CMK) that is used for encryption. The default setting is Amazon Web Services_OWNED_CMK. For more information about CMKs, see Customer Master Keys (CMKs).

$sel:status:DeliveryStreamEncryptionConfiguration', deliveryStreamEncryptionConfiguration_status - This is the server-side encryption (SSE) status for the delivery stream. For a full description of the different values of this status, see StartDeliveryStreamEncryption and StopDeliveryStreamEncryption. If this status is ENABLING_FAILED or DISABLING_FAILED, it is the status of the most recent attempt to enable or disable SSE, respectively.

deliveryStreamEncryptionConfiguration_failureDescription :: Lens' DeliveryStreamEncryptionConfiguration (Maybe FailureDescription) Source #

Provides details in case one of the following operations fails due to an error related to KMS: CreateDeliveryStream, DeleteDeliveryStream, StartDeliveryStreamEncryption, StopDeliveryStreamEncryption.

deliveryStreamEncryptionConfiguration_keyARN :: Lens' DeliveryStreamEncryptionConfiguration (Maybe Text) Source #

If KeyType is CUSTOMER_MANAGED_CMK, this field contains the ARN of the customer managed CMK. If KeyType is Amazon Web Services_OWNED_CMK, DeliveryStreamEncryptionConfiguration doesn't contain a value for KeyARN.

deliveryStreamEncryptionConfiguration_keyType :: Lens' DeliveryStreamEncryptionConfiguration (Maybe KeyType) Source #

Indicates the type of customer master key (CMK) that is used for encryption. The default setting is Amazon Web Services_OWNED_CMK. For more information about CMKs, see Customer Master Keys (CMKs).

deliveryStreamEncryptionConfiguration_status :: Lens' DeliveryStreamEncryptionConfiguration (Maybe DeliveryStreamEncryptionStatus) Source #

This is the server-side encryption (SSE) status for the delivery stream. For a full description of the different values of this status, see StartDeliveryStreamEncryption and StopDeliveryStreamEncryption. If this status is ENABLING_FAILED or DISABLING_FAILED, it is the status of the most recent attempt to enable or disable SSE, respectively.

DeliveryStreamEncryptionConfigurationInput

data DeliveryStreamEncryptionConfigurationInput Source #

Specifies the type and Amazon Resource Name (ARN) of the CMK to use for Server-Side Encryption (SSE).

See: newDeliveryStreamEncryptionConfigurationInput smart constructor.

Constructors

DeliveryStreamEncryptionConfigurationInput' 

Fields

  • keyARN :: Maybe Text

    If you set KeyType to CUSTOMER_MANAGED_CMK, you must specify the Amazon Resource Name (ARN) of the CMK. If you set KeyType to Amazon Web Services_OWNED_CMK, Kinesis Data Firehose uses a service-account CMK.

  • keyType :: KeyType

    Indicates the type of customer master key (CMK) to use for encryption. The default setting is Amazon Web Services_OWNED_CMK. For more information about CMKs, see Customer Master Keys (CMKs). When you invoke CreateDeliveryStream or StartDeliveryStreamEncryption with KeyType set to CUSTOMER_MANAGED_CMK, Kinesis Data Firehose invokes the Amazon KMS operation CreateGrant to create a grant that allows the Kinesis Data Firehose service to use the customer managed CMK to perform encryption and decryption. Kinesis Data Firehose manages that grant.

    When you invoke StartDeliveryStreamEncryption to change the CMK for a delivery stream that is encrypted with a customer managed CMK, Kinesis Data Firehose schedules the grant it had on the old CMK for retirement.

    You can use a CMK of type CUSTOMER_MANAGED_CMK to encrypt up to 500 delivery streams. If a CreateDeliveryStream or StartDeliveryStreamEncryption operation exceeds this limit, Kinesis Data Firehose throws a LimitExceededException.

    To encrypt your delivery stream, use symmetric CMKs. Kinesis Data Firehose doesn't support asymmetric CMKs. For information about symmetric and asymmetric CMKs, see About Symmetric and Asymmetric CMKs in the Amazon Web Services Key Management Service developer guide.

Instances

Instances details
ToJSON DeliveryStreamEncryptionConfigurationInput Source # 
Instance details

Defined in Amazonka.Firehose.Types.DeliveryStreamEncryptionConfigurationInput

Generic DeliveryStreamEncryptionConfigurationInput Source # 
Instance details

Defined in Amazonka.Firehose.Types.DeliveryStreamEncryptionConfigurationInput

Read DeliveryStreamEncryptionConfigurationInput Source # 
Instance details

Defined in Amazonka.Firehose.Types.DeliveryStreamEncryptionConfigurationInput

Show DeliveryStreamEncryptionConfigurationInput Source # 
Instance details

Defined in Amazonka.Firehose.Types.DeliveryStreamEncryptionConfigurationInput

NFData DeliveryStreamEncryptionConfigurationInput Source # 
Instance details

Defined in Amazonka.Firehose.Types.DeliveryStreamEncryptionConfigurationInput

Eq DeliveryStreamEncryptionConfigurationInput Source # 
Instance details

Defined in Amazonka.Firehose.Types.DeliveryStreamEncryptionConfigurationInput

Hashable DeliveryStreamEncryptionConfigurationInput Source # 
Instance details

Defined in Amazonka.Firehose.Types.DeliveryStreamEncryptionConfigurationInput

type Rep DeliveryStreamEncryptionConfigurationInput Source # 
Instance details

Defined in Amazonka.Firehose.Types.DeliveryStreamEncryptionConfigurationInput

type Rep DeliveryStreamEncryptionConfigurationInput = D1 ('MetaData "DeliveryStreamEncryptionConfigurationInput" "Amazonka.Firehose.Types.DeliveryStreamEncryptionConfigurationInput" "amazonka-kinesis-firehose-2.0-6l1hHmh2UnHBvolxuQFkWB" 'False) (C1 ('MetaCons "DeliveryStreamEncryptionConfigurationInput'" 'PrefixI 'True) (S1 ('MetaSel ('Just "keyARN") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "keyType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 KeyType)))

newDeliveryStreamEncryptionConfigurationInput Source #

Create a value of DeliveryStreamEncryptionConfigurationInput 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:keyARN:DeliveryStreamEncryptionConfigurationInput', deliveryStreamEncryptionConfigurationInput_keyARN - If you set KeyType to CUSTOMER_MANAGED_CMK, you must specify the Amazon Resource Name (ARN) of the CMK. If you set KeyType to Amazon Web Services_OWNED_CMK, Kinesis Data Firehose uses a service-account CMK.

$sel:keyType:DeliveryStreamEncryptionConfigurationInput', deliveryStreamEncryptionConfigurationInput_keyType - Indicates the type of customer master key (CMK) to use for encryption. The default setting is Amazon Web Services_OWNED_CMK. For more information about CMKs, see Customer Master Keys (CMKs). When you invoke CreateDeliveryStream or StartDeliveryStreamEncryption with KeyType set to CUSTOMER_MANAGED_CMK, Kinesis Data Firehose invokes the Amazon KMS operation CreateGrant to create a grant that allows the Kinesis Data Firehose service to use the customer managed CMK to perform encryption and decryption. Kinesis Data Firehose manages that grant.

When you invoke StartDeliveryStreamEncryption to change the CMK for a delivery stream that is encrypted with a customer managed CMK, Kinesis Data Firehose schedules the grant it had on the old CMK for retirement.

You can use a CMK of type CUSTOMER_MANAGED_CMK to encrypt up to 500 delivery streams. If a CreateDeliveryStream or StartDeliveryStreamEncryption operation exceeds this limit, Kinesis Data Firehose throws a LimitExceededException.

To encrypt your delivery stream, use symmetric CMKs. Kinesis Data Firehose doesn't support asymmetric CMKs. For information about symmetric and asymmetric CMKs, see About Symmetric and Asymmetric CMKs in the Amazon Web Services Key Management Service developer guide.

deliveryStreamEncryptionConfigurationInput_keyARN :: Lens' DeliveryStreamEncryptionConfigurationInput (Maybe Text) Source #

If you set KeyType to CUSTOMER_MANAGED_CMK, you must specify the Amazon Resource Name (ARN) of the CMK. If you set KeyType to Amazon Web Services_OWNED_CMK, Kinesis Data Firehose uses a service-account CMK.

deliveryStreamEncryptionConfigurationInput_keyType :: Lens' DeliveryStreamEncryptionConfigurationInput KeyType Source #

Indicates the type of customer master key (CMK) to use for encryption. The default setting is Amazon Web Services_OWNED_CMK. For more information about CMKs, see Customer Master Keys (CMKs). When you invoke CreateDeliveryStream or StartDeliveryStreamEncryption with KeyType set to CUSTOMER_MANAGED_CMK, Kinesis Data Firehose invokes the Amazon KMS operation CreateGrant to create a grant that allows the Kinesis Data Firehose service to use the customer managed CMK to perform encryption and decryption. Kinesis Data Firehose manages that grant.

When you invoke StartDeliveryStreamEncryption to change the CMK for a delivery stream that is encrypted with a customer managed CMK, Kinesis Data Firehose schedules the grant it had on the old CMK for retirement.

You can use a CMK of type CUSTOMER_MANAGED_CMK to encrypt up to 500 delivery streams. If a CreateDeliveryStream or StartDeliveryStreamEncryption operation exceeds this limit, Kinesis Data Firehose throws a LimitExceededException.

To encrypt your delivery stream, use symmetric CMKs. Kinesis Data Firehose doesn't support asymmetric CMKs. For information about symmetric and asymmetric CMKs, see About Symmetric and Asymmetric CMKs in the Amazon Web Services Key Management Service developer guide.

Deserializer

data Deserializer Source #

The deserializer you want Kinesis Data Firehose to use for converting the input data from JSON. Kinesis Data Firehose then serializes the data to its final format using the Serializer. Kinesis Data Firehose supports two types of deserializers: the Apache Hive JSON SerDe and the OpenX JSON SerDe.

See: newDeserializer smart constructor.

Constructors

Deserializer' 

Fields

  • hiveJsonSerDe :: Maybe HiveJsonSerDe

    The native Hive / HCatalog JsonSerDe. Used by Kinesis Data Firehose for deserializing data, which means converting it from the JSON format in preparation for serializing it to the Parquet or ORC format. This is one of two deserializers you can choose, depending on which one offers the functionality you need. The other option is the OpenX SerDe.

  • openXJsonSerDe :: Maybe OpenXJsonSerDe

    The OpenX SerDe. Used by Kinesis Data Firehose for deserializing data, which means converting it from the JSON format in preparation for serializing it to the Parquet or ORC format. This is one of two deserializers you can choose, depending on which one offers the functionality you need. The other option is the native Hive / HCatalog JsonSerDe.

Instances

Instances details
FromJSON Deserializer Source # 
Instance details

Defined in Amazonka.Firehose.Types.Deserializer

ToJSON Deserializer Source # 
Instance details

Defined in Amazonka.Firehose.Types.Deserializer

Generic Deserializer Source # 
Instance details

Defined in Amazonka.Firehose.Types.Deserializer

Associated Types

type Rep Deserializer :: Type -> Type #

Read Deserializer Source # 
Instance details

Defined in Amazonka.Firehose.Types.Deserializer

Show Deserializer Source # 
Instance details

Defined in Amazonka.Firehose.Types.Deserializer

NFData Deserializer Source # 
Instance details

Defined in Amazonka.Firehose.Types.Deserializer

Methods

rnf :: Deserializer -> () #

Eq Deserializer Source # 
Instance details

Defined in Amazonka.Firehose.Types.Deserializer

Hashable Deserializer Source # 
Instance details

Defined in Amazonka.Firehose.Types.Deserializer

type Rep Deserializer Source # 
Instance details

Defined in Amazonka.Firehose.Types.Deserializer

type Rep Deserializer = D1 ('MetaData "Deserializer" "Amazonka.Firehose.Types.Deserializer" "amazonka-kinesis-firehose-2.0-6l1hHmh2UnHBvolxuQFkWB" 'False) (C1 ('MetaCons "Deserializer'" 'PrefixI 'True) (S1 ('MetaSel ('Just "hiveJsonSerDe") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe HiveJsonSerDe)) :*: S1 ('MetaSel ('Just "openXJsonSerDe") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe OpenXJsonSerDe))))

newDeserializer :: Deserializer Source #

Create a value of Deserializer 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:hiveJsonSerDe:Deserializer', deserializer_hiveJsonSerDe - The native Hive / HCatalog JsonSerDe. Used by Kinesis Data Firehose for deserializing data, which means converting it from the JSON format in preparation for serializing it to the Parquet or ORC format. This is one of two deserializers you can choose, depending on which one offers the functionality you need. The other option is the OpenX SerDe.

$sel:openXJsonSerDe:Deserializer', deserializer_openXJsonSerDe - The OpenX SerDe. Used by Kinesis Data Firehose for deserializing data, which means converting it from the JSON format in preparation for serializing it to the Parquet or ORC format. This is one of two deserializers you can choose, depending on which one offers the functionality you need. The other option is the native Hive / HCatalog JsonSerDe.

deserializer_hiveJsonSerDe :: Lens' Deserializer (Maybe HiveJsonSerDe) Source #

The native Hive / HCatalog JsonSerDe. Used by Kinesis Data Firehose for deserializing data, which means converting it from the JSON format in preparation for serializing it to the Parquet or ORC format. This is one of two deserializers you can choose, depending on which one offers the functionality you need. The other option is the OpenX SerDe.

deserializer_openXJsonSerDe :: Lens' Deserializer (Maybe OpenXJsonSerDe) Source #

The OpenX SerDe. Used by Kinesis Data Firehose for deserializing data, which means converting it from the JSON format in preparation for serializing it to the Parquet or ORC format. This is one of two deserializers you can choose, depending on which one offers the functionality you need. The other option is the native Hive / HCatalog JsonSerDe.

DestinationDescription

data DestinationDescription Source #

Describes the destination for a delivery stream.

See: newDestinationDescription smart constructor.

Instances

Instances details
FromJSON DestinationDescription Source # 
Instance details

Defined in Amazonka.Firehose.Types.DestinationDescription

Generic DestinationDescription Source # 
Instance details

Defined in Amazonka.Firehose.Types.DestinationDescription

Associated Types

type Rep DestinationDescription :: Type -> Type #

Show DestinationDescription Source # 
Instance details

Defined in Amazonka.Firehose.Types.DestinationDescription

NFData DestinationDescription Source # 
Instance details

Defined in Amazonka.Firehose.Types.DestinationDescription

Methods

rnf :: DestinationDescription -> () #

Eq DestinationDescription Source # 
Instance details

Defined in Amazonka.Firehose.Types.DestinationDescription

Hashable DestinationDescription Source # 
Instance details

Defined in Amazonka.Firehose.Types.DestinationDescription

type Rep DestinationDescription Source # 
Instance details

Defined in Amazonka.Firehose.Types.DestinationDescription

type Rep DestinationDescription = D1 ('MetaData "DestinationDescription" "Amazonka.Firehose.Types.DestinationDescription" "amazonka-kinesis-firehose-2.0-6l1hHmh2UnHBvolxuQFkWB" 'False) (C1 ('MetaCons "DestinationDescription'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "amazonOpenSearchServerlessDestinationDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AmazonOpenSearchServerlessDestinationDescription)) :*: S1 ('MetaSel ('Just "amazonopensearchserviceDestinationDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AmazonopensearchserviceDestinationDescription))) :*: (S1 ('MetaSel ('Just "elasticsearchDestinationDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ElasticsearchDestinationDescription)) :*: S1 ('MetaSel ('Just "extendedS3DestinationDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ExtendedS3DestinationDescription)))) :*: ((S1 ('MetaSel ('Just "httpEndpointDestinationDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe HttpEndpointDestinationDescription)) :*: S1 ('MetaSel ('Just "redshiftDestinationDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RedshiftDestinationDescription))) :*: (S1 ('MetaSel ('Just "s3DestinationDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe S3DestinationDescription)) :*: (S1 ('MetaSel ('Just "splunkDestinationDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SplunkDestinationDescription)) :*: S1 ('MetaSel ('Just "destinationId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))

newDestinationDescription Source #

Create a value of DestinationDescription 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:amazonOpenSearchServerlessDestinationDescription:DestinationDescription', destinationDescription_amazonOpenSearchServerlessDestinationDescription - The destination in the Serverless offering for Amazon OpenSearch Service.

$sel:amazonopensearchserviceDestinationDescription:DestinationDescription', destinationDescription_amazonopensearchserviceDestinationDescription - The destination in Amazon OpenSearch Service.

$sel:elasticsearchDestinationDescription:DestinationDescription', destinationDescription_elasticsearchDestinationDescription - The destination in Amazon ES.

$sel:extendedS3DestinationDescription:DestinationDescription', destinationDescription_extendedS3DestinationDescription - The destination in Amazon S3.

$sel:httpEndpointDestinationDescription:DestinationDescription', destinationDescription_httpEndpointDestinationDescription - Describes the specified HTTP endpoint destination.

$sel:redshiftDestinationDescription:DestinationDescription', destinationDescription_redshiftDestinationDescription - The destination in Amazon Redshift.

DestinationDescription, destinationDescription_s3DestinationDescription - [Deprecated] The destination in Amazon S3.

$sel:splunkDestinationDescription:DestinationDescription', destinationDescription_splunkDestinationDescription - The destination in Splunk.

$sel:destinationId:DestinationDescription', destinationDescription_destinationId - The ID of the destination.

DynamicPartitioningConfiguration

data DynamicPartitioningConfiguration Source #

The configuration of the dynamic partitioning mechanism that creates smaller data sets from the streaming data by partitioning it based on partition keys. Currently, dynamic partitioning is only supported for Amazon S3 destinations.

See: newDynamicPartitioningConfiguration smart constructor.

Constructors

DynamicPartitioningConfiguration' 

Fields

  • enabled :: Maybe Bool

    Specifies that the dynamic partitioning is enabled for this Kinesis Data Firehose delivery stream.

  • retryOptions :: Maybe RetryOptions

    The retry behavior in case Kinesis Data Firehose is unable to deliver data to an Amazon S3 prefix.

Instances

Instances details
FromJSON DynamicPartitioningConfiguration Source # 
Instance details

Defined in Amazonka.Firehose.Types.DynamicPartitioningConfiguration

ToJSON DynamicPartitioningConfiguration Source # 
Instance details

Defined in Amazonka.Firehose.Types.DynamicPartitioningConfiguration

Generic DynamicPartitioningConfiguration Source # 
Instance details

Defined in Amazonka.Firehose.Types.DynamicPartitioningConfiguration

Associated Types

type Rep DynamicPartitioningConfiguration :: Type -> Type #

Read DynamicPartitioningConfiguration Source # 
Instance details

Defined in Amazonka.Firehose.Types.DynamicPartitioningConfiguration

Show DynamicPartitioningConfiguration Source # 
Instance details

Defined in Amazonka.Firehose.Types.DynamicPartitioningConfiguration

NFData DynamicPartitioningConfiguration Source # 
Instance details

Defined in Amazonka.Firehose.Types.DynamicPartitioningConfiguration

Eq DynamicPartitioningConfiguration Source # 
Instance details

Defined in Amazonka.Firehose.Types.DynamicPartitioningConfiguration

Hashable DynamicPartitioningConfiguration Source # 
Instance details

Defined in Amazonka.Firehose.Types.DynamicPartitioningConfiguration

type Rep DynamicPartitioningConfiguration Source # 
Instance details

Defined in Amazonka.Firehose.Types.DynamicPartitioningConfiguration

type Rep DynamicPartitioningConfiguration = D1 ('MetaData "DynamicPartitioningConfiguration" "Amazonka.Firehose.Types.DynamicPartitioningConfiguration" "amazonka-kinesis-firehose-2.0-6l1hHmh2UnHBvolxuQFkWB" 'False) (C1 ('MetaCons "DynamicPartitioningConfiguration'" 'PrefixI 'True) (S1 ('MetaSel ('Just "enabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "retryOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RetryOptions))))

newDynamicPartitioningConfiguration :: DynamicPartitioningConfiguration Source #

Create a value of DynamicPartitioningConfiguration 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:enabled:DynamicPartitioningConfiguration', dynamicPartitioningConfiguration_enabled - Specifies that the dynamic partitioning is enabled for this Kinesis Data Firehose delivery stream.

$sel:retryOptions:DynamicPartitioningConfiguration', dynamicPartitioningConfiguration_retryOptions - The retry behavior in case Kinesis Data Firehose is unable to deliver data to an Amazon S3 prefix.

dynamicPartitioningConfiguration_enabled :: Lens' DynamicPartitioningConfiguration (Maybe Bool) Source #

Specifies that the dynamic partitioning is enabled for this Kinesis Data Firehose delivery stream.

dynamicPartitioningConfiguration_retryOptions :: Lens' DynamicPartitioningConfiguration (Maybe RetryOptions) Source #

The retry behavior in case Kinesis Data Firehose is unable to deliver data to an Amazon S3 prefix.

ElasticsearchBufferingHints

data ElasticsearchBufferingHints Source #

Describes the buffering to perform before delivering data to the Amazon ES destination.

See: newElasticsearchBufferingHints smart constructor.

Constructors

ElasticsearchBufferingHints' 

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

Instances details
FromJSON ElasticsearchBufferingHints Source # 
Instance details

Defined in Amazonka.Firehose.Types.ElasticsearchBufferingHints

ToJSON ElasticsearchBufferingHints Source # 
Instance details

Defined in Amazonka.Firehose.Types.ElasticsearchBufferingHints

Generic ElasticsearchBufferingHints Source # 
Instance details

Defined in Amazonka.Firehose.Types.ElasticsearchBufferingHints

Associated Types

type Rep ElasticsearchBufferingHints :: Type -> Type #

Read ElasticsearchBufferingHints Source # 
Instance details

Defined in Amazonka.Firehose.Types.ElasticsearchBufferingHints

Show ElasticsearchBufferingHints Source # 
Instance details

Defined in Amazonka.Firehose.Types.ElasticsearchBufferingHints

NFData ElasticsearchBufferingHints Source # 
Instance details

Defined in Amazonka.Firehose.Types.ElasticsearchBufferingHints

Eq ElasticsearchBufferingHints Source # 
Instance details

Defined in Amazonka.Firehose.Types.ElasticsearchBufferingHints

Hashable ElasticsearchBufferingHints Source # 
Instance details

Defined in Amazonka.Firehose.Types.ElasticsearchBufferingHints

type Rep ElasticsearchBufferingHints Source # 
Instance details

Defined in Amazonka.Firehose.Types.ElasticsearchBufferingHints

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

newElasticsearchBufferingHints :: ElasticsearchBufferingHints Source #

Create a value of ElasticsearchBufferingHints 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:ElasticsearchBufferingHints', elasticsearchBufferingHints_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:ElasticsearchBufferingHints', elasticsearchBufferingHints_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.

elasticsearchBufferingHints_intervalInSeconds :: Lens' ElasticsearchBufferingHints (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).

elasticsearchBufferingHints_sizeInMBs :: Lens' ElasticsearchBufferingHints (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.

ElasticsearchDestinationConfiguration

data ElasticsearchDestinationConfiguration Source #

Describes the configuration of a destination in Amazon ES.

See: newElasticsearchDestinationConfiguration smart constructor.

Constructors

ElasticsearchDestinationConfiguration' 

Fields

Instances

Instances details
ToJSON ElasticsearchDestinationConfiguration Source # 
Instance details

Defined in Amazonka.Firehose.Types.ElasticsearchDestinationConfiguration

Generic ElasticsearchDestinationConfiguration Source # 
Instance details

Defined in Amazonka.Firehose.Types.ElasticsearchDestinationConfiguration

Read ElasticsearchDestinationConfiguration Source # 
Instance details

Defined in Amazonka.Firehose.Types.ElasticsearchDestinationConfiguration

Show ElasticsearchDestinationConfiguration Source # 
Instance details

Defined in Amazonka.Firehose.Types.ElasticsearchDestinationConfiguration

NFData ElasticsearchDestinationConfiguration Source # 
Instance details

Defined in Amazonka.Firehose.Types.ElasticsearchDestinationConfiguration

Eq ElasticsearchDestinationConfiguration Source # 
Instance details

Defined in Amazonka.Firehose.Types.ElasticsearchDestinationConfiguration

Hashable ElasticsearchDestinationConfiguration Source # 
Instance details

Defined in Amazonka.Firehose.Types.ElasticsearchDestinationConfiguration

type Rep ElasticsearchDestinationConfiguration Source # 
Instance details

Defined in Amazonka.Firehose.Types.ElasticsearchDestinationConfiguration

type Rep ElasticsearchDestinationConfiguration = D1 ('MetaData "ElasticsearchDestinationConfiguration" "Amazonka.Firehose.Types.ElasticsearchDestinationConfiguration" "amazonka-kinesis-firehose-2.0-6l1hHmh2UnHBvolxuQFkWB" 'False) (C1 ('MetaCons "ElasticsearchDestinationConfiguration'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "bufferingHints") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ElasticsearchBufferingHints)) :*: (S1 ('MetaSel ('Just "cloudWatchLoggingOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CloudWatchLoggingOptions)) :*: S1 ('MetaSel ('Just "clusterEndpoint") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: (S1 ('MetaSel ('Just "domainARN") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "indexRotationPeriod") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ElasticsearchIndexRotationPeriod)) :*: S1 ('MetaSel ('Just "processingConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ProcessingConfiguration))))) :*: ((S1 ('MetaSel ('Just "retryOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ElasticsearchRetryOptions)) :*: (S1 ('MetaSel ('Just "s3BackupMode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ElasticsearchS3BackupMode)) :*: S1 ('MetaSel ('Just "typeName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "vpcConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe VpcConfiguration)) :*: S1 ('MetaSel ('Just "roleARN") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :*: (S1 ('MetaSel ('Just "indexName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "s3Configuration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 S3DestinationConfiguration))))))

newElasticsearchDestinationConfiguration Source #

Create a value of ElasticsearchDestinationConfiguration 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:

ElasticsearchDestinationConfiguration, elasticsearchDestinationConfiguration_bufferingHints - The buffering options. If no value is specified, the default values for ElasticsearchBufferingHints are used.

ElasticsearchDestinationConfiguration, elasticsearchDestinationConfiguration_cloudWatchLoggingOptions - The Amazon CloudWatch logging options for your delivery stream.

$sel:clusterEndpoint:ElasticsearchDestinationConfiguration', elasticsearchDestinationConfiguration_clusterEndpoint - The endpoint to use when communicating with the cluster. Specify either this ClusterEndpoint or the DomainARN field.

$sel:domainARN:ElasticsearchDestinationConfiguration', elasticsearchDestinationConfiguration_domainARN - The ARN of the Amazon ES domain. The IAM role must have permissions for DescribeDomain, DescribeDomains, and DescribeDomainConfig after assuming the role specified in RoleARN. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.

Specify either ClusterEndpoint or DomainARN.

$sel:indexRotationPeriod:ElasticsearchDestinationConfiguration', elasticsearchDestinationConfiguration_indexRotationPeriod - The Elasticsearch index rotation period. Index rotation appends a timestamp to the IndexName to facilitate the expiration of old data. For more information, see Index Rotation for the Amazon ES Destination. The default value is OneDay.

$sel:processingConfiguration:ElasticsearchDestinationConfiguration', elasticsearchDestinationConfiguration_processingConfiguration - The data processing configuration.

$sel:retryOptions:ElasticsearchDestinationConfiguration', elasticsearchDestinationConfiguration_retryOptions - The retry behavior in case Kinesis Data Firehose is unable to deliver documents to Amazon ES. The default value is 300 (5 minutes).

$sel:s3BackupMode:ElasticsearchDestinationConfiguration', elasticsearchDestinationConfiguration_s3BackupMode - Defines how documents should be delivered to Amazon S3. When it is set to FailedDocumentsOnly, Kinesis Data Firehose writes any documents that could not be indexed to the configured Amazon S3 destination, with AmazonOpenSearchService-failed/ appended to the key prefix. When set to AllDocuments, Kinesis Data Firehose delivers all incoming records to Amazon S3, and also writes failed documents with AmazonOpenSearchService-failed/ appended to the prefix. For more information, see Amazon S3 Backup for the Amazon ES Destination. Default value is FailedDocumentsOnly.

You can't change this backup mode after you create the delivery stream.

$sel:typeName:ElasticsearchDestinationConfiguration', elasticsearchDestinationConfiguration_typeName - The Elasticsearch type name. For Elasticsearch 6.x, there can be only one type per index. If you try to specify a new type for an existing index that already has another type, Kinesis Data Firehose returns an error during run time.

For Elasticsearch 7.x, don't specify a TypeName.

$sel:vpcConfiguration:ElasticsearchDestinationConfiguration', elasticsearchDestinationConfiguration_vpcConfiguration - The details of the VPC of the Amazon ES destination.

ElasticsearchDestinationConfiguration, elasticsearchDestinationConfiguration_roleARN - The Amazon Resource Name (ARN) of the IAM role to be assumed by Kinesis Data Firehose for calling the Amazon ES Configuration API and for indexing documents. For more information, see Grant Kinesis Data Firehose Access to an Amazon S3 Destination and Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.

$sel:indexName:ElasticsearchDestinationConfiguration', elasticsearchDestinationConfiguration_indexName - The Elasticsearch index name.

$sel:s3Configuration:ElasticsearchDestinationConfiguration', elasticsearchDestinationConfiguration_s3Configuration - The configuration for the backup Amazon S3 location.

elasticsearchDestinationConfiguration_bufferingHints :: Lens' ElasticsearchDestinationConfiguration (Maybe ElasticsearchBufferingHints) Source #

The buffering options. If no value is specified, the default values for ElasticsearchBufferingHints are used.

elasticsearchDestinationConfiguration_clusterEndpoint :: Lens' ElasticsearchDestinationConfiguration (Maybe Text) Source #

The endpoint to use when communicating with the cluster. Specify either this ClusterEndpoint or the DomainARN field.

elasticsearchDestinationConfiguration_domainARN :: Lens' ElasticsearchDestinationConfiguration (Maybe Text) Source #

The ARN of the Amazon ES domain. The IAM role must have permissions for DescribeDomain, DescribeDomains, and DescribeDomainConfig after assuming the role specified in RoleARN. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.

Specify either ClusterEndpoint or DomainARN.

elasticsearchDestinationConfiguration_indexRotationPeriod :: Lens' ElasticsearchDestinationConfiguration (Maybe ElasticsearchIndexRotationPeriod) Source #

The Elasticsearch index rotation period. Index rotation appends a timestamp to the IndexName to facilitate the expiration of old data. For more information, see Index Rotation for the Amazon ES Destination. The default value is OneDay.

elasticsearchDestinationConfiguration_retryOptions :: Lens' ElasticsearchDestinationConfiguration (Maybe ElasticsearchRetryOptions) Source #

The retry behavior in case Kinesis Data Firehose is unable to deliver documents to Amazon ES. The default value is 300 (5 minutes).

elasticsearchDestinationConfiguration_s3BackupMode :: Lens' ElasticsearchDestinationConfiguration (Maybe ElasticsearchS3BackupMode) Source #

Defines how documents should be delivered to Amazon S3. When it is set to FailedDocumentsOnly, Kinesis Data Firehose writes any documents that could not be indexed to the configured Amazon S3 destination, with AmazonOpenSearchService-failed/ appended to the key prefix. When set to AllDocuments, Kinesis Data Firehose delivers all incoming records to Amazon S3, and also writes failed documents with AmazonOpenSearchService-failed/ appended to the prefix. For more information, see Amazon S3 Backup for the Amazon ES Destination. Default value is FailedDocumentsOnly.

You can't change this backup mode after you create the delivery stream.

elasticsearchDestinationConfiguration_typeName :: Lens' ElasticsearchDestinationConfiguration (Maybe Text) Source #

The Elasticsearch type name. For Elasticsearch 6.x, there can be only one type per index. If you try to specify a new type for an existing index that already has another type, Kinesis Data Firehose returns an error during run time.

For Elasticsearch 7.x, don't specify a TypeName.

elasticsearchDestinationConfiguration_roleARN :: Lens' ElasticsearchDestinationConfiguration Text Source #

The Amazon Resource Name (ARN) of the IAM role to be assumed by Kinesis Data Firehose for calling the Amazon ES Configuration API and for indexing documents. For more information, see Grant Kinesis Data Firehose Access to an Amazon S3 Destination and Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.

ElasticsearchDestinationDescription

data ElasticsearchDestinationDescription Source #

The destination description in Amazon ES.

See: newElasticsearchDestinationDescription smart constructor.

Constructors

ElasticsearchDestinationDescription' 

Fields

Instances

Instances details
FromJSON ElasticsearchDestinationDescription Source # 
Instance details

Defined in Amazonka.Firehose.Types.ElasticsearchDestinationDescription

Generic ElasticsearchDestinationDescription Source # 
Instance details

Defined in Amazonka.Firehose.Types.ElasticsearchDestinationDescription

Read ElasticsearchDestinationDescription Source # 
Instance details

Defined in Amazonka.Firehose.Types.ElasticsearchDestinationDescription

Show ElasticsearchDestinationDescription Source # 
Instance details

Defined in Amazonka.Firehose.Types.ElasticsearchDestinationDescription

NFData ElasticsearchDestinationDescription Source # 
Instance details

Defined in Amazonka.Firehose.Types.ElasticsearchDestinationDescription

Eq ElasticsearchDestinationDescription Source # 
Instance details

Defined in Amazonka.Firehose.Types.ElasticsearchDestinationDescription

Hashable ElasticsearchDestinationDescription Source # 
Instance details

Defined in Amazonka.Firehose.Types.ElasticsearchDestinationDescription

type Rep ElasticsearchDestinationDescription Source # 
Instance details

Defined in Amazonka.Firehose.Types.ElasticsearchDestinationDescription

type Rep ElasticsearchDestinationDescription = D1 ('MetaData "ElasticsearchDestinationDescription" "Amazonka.Firehose.Types.ElasticsearchDestinationDescription" "amazonka-kinesis-firehose-2.0-6l1hHmh2UnHBvolxuQFkWB" 'False) (C1 ('MetaCons "ElasticsearchDestinationDescription'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "bufferingHints") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ElasticsearchBufferingHints)) :*: (S1 ('MetaSel ('Just "cloudWatchLoggingOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CloudWatchLoggingOptions)) :*: S1 ('MetaSel ('Just "clusterEndpoint") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: (S1 ('MetaSel ('Just "domainARN") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "indexName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "indexRotationPeriod") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ElasticsearchIndexRotationPeriod))))) :*: ((S1 ('MetaSel ('Just "processingConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ProcessingConfiguration)) :*: (S1 ('MetaSel ('Just "retryOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ElasticsearchRetryOptions)) :*: S1 ('MetaSel ('Just "roleARN") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "s3BackupMode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ElasticsearchS3BackupMode)) :*: S1 ('MetaSel ('Just "s3DestinationDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe S3DestinationDescription))) :*: (S1 ('MetaSel ('Just "typeName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "vpcConfigurationDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe VpcConfigurationDescription)))))))

newElasticsearchDestinationDescription :: ElasticsearchDestinationDescription Source #

Create a value of ElasticsearchDestinationDescription 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:

ElasticsearchDestinationDescription, elasticsearchDestinationDescription_bufferingHints - The buffering options.

ElasticsearchDestinationDescription, elasticsearchDestinationDescription_cloudWatchLoggingOptions - The Amazon CloudWatch logging options.

$sel:clusterEndpoint:ElasticsearchDestinationDescription', elasticsearchDestinationDescription_clusterEndpoint - The endpoint to use when communicating with the cluster. Kinesis Data Firehose uses either this ClusterEndpoint or the DomainARN field to send data to Amazon ES.

$sel:domainARN:ElasticsearchDestinationDescription', elasticsearchDestinationDescription_domainARN - The ARN of the Amazon ES domain. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.

Kinesis Data Firehose uses either ClusterEndpoint or DomainARN to send data to Amazon ES.

$sel:indexName:ElasticsearchDestinationDescription', elasticsearchDestinationDescription_indexName - The Elasticsearch index name.

$sel:indexRotationPeriod:ElasticsearchDestinationDescription', elasticsearchDestinationDescription_indexRotationPeriod - The Elasticsearch index rotation period

$sel:processingConfiguration:ElasticsearchDestinationDescription', elasticsearchDestinationDescription_processingConfiguration - The data processing configuration.

$sel:retryOptions:ElasticsearchDestinationDescription', elasticsearchDestinationDescription_retryOptions - The Amazon ES retry options.

ElasticsearchDestinationDescription, elasticsearchDestinationDescription_roleARN - The Amazon Resource Name (ARN) of the Amazon Web Services credentials. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.

$sel:s3BackupMode:ElasticsearchDestinationDescription', elasticsearchDestinationDescription_s3BackupMode - The Amazon S3 backup mode.

$sel:s3DestinationDescription:ElasticsearchDestinationDescription', elasticsearchDestinationDescription_s3DestinationDescription - The Amazon S3 destination.

$sel:typeName:ElasticsearchDestinationDescription', elasticsearchDestinationDescription_typeName - The Elasticsearch type name. This applies to Elasticsearch 6.x and lower versions. For Elasticsearch 7.x and OpenSearch Service 1.x, there's no value for TypeName.

$sel:vpcConfigurationDescription:ElasticsearchDestinationDescription', elasticsearchDestinationDescription_vpcConfigurationDescription - The details of the VPC of the Amazon ES destination.

elasticsearchDestinationDescription_clusterEndpoint :: Lens' ElasticsearchDestinationDescription (Maybe Text) Source #

The endpoint to use when communicating with the cluster. Kinesis Data Firehose uses either this ClusterEndpoint or the DomainARN field to send data to Amazon ES.

elasticsearchDestinationDescription_domainARN :: Lens' ElasticsearchDestinationDescription (Maybe Text) Source #

The ARN of the Amazon ES domain. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.

Kinesis Data Firehose uses either ClusterEndpoint or DomainARN to send data to Amazon ES.

elasticsearchDestinationDescription_typeName :: Lens' ElasticsearchDestinationDescription (Maybe Text) Source #

The Elasticsearch type name. This applies to Elasticsearch 6.x and lower versions. For Elasticsearch 7.x and OpenSearch Service 1.x, there's no value for TypeName.

ElasticsearchDestinationUpdate

data ElasticsearchDestinationUpdate Source #

Describes an update for a destination in Amazon ES.

See: newElasticsearchDestinationUpdate smart constructor.

Constructors

ElasticsearchDestinationUpdate' 

Fields

Instances

Instances details
ToJSON ElasticsearchDestinationUpdate Source # 
Instance details

Defined in Amazonka.Firehose.Types.ElasticsearchDestinationUpdate

Generic ElasticsearchDestinationUpdate Source # 
Instance details

Defined in Amazonka.Firehose.Types.ElasticsearchDestinationUpdate

Associated Types

type Rep ElasticsearchDestinationUpdate :: Type -> Type #

Read ElasticsearchDestinationUpdate Source # 
Instance details

Defined in Amazonka.Firehose.Types.ElasticsearchDestinationUpdate

Show ElasticsearchDestinationUpdate Source # 
Instance details

Defined in Amazonka.Firehose.Types.ElasticsearchDestinationUpdate

NFData ElasticsearchDestinationUpdate Source # 
Instance details

Defined in Amazonka.Firehose.Types.ElasticsearchDestinationUpdate

Eq ElasticsearchDestinationUpdate Source # 
Instance details

Defined in Amazonka.Firehose.Types.ElasticsearchDestinationUpdate

Hashable ElasticsearchDestinationUpdate Source # 
Instance details

Defined in Amazonka.Firehose.Types.ElasticsearchDestinationUpdate

type Rep ElasticsearchDestinationUpdate Source # 
Instance details

Defined in Amazonka.Firehose.Types.ElasticsearchDestinationUpdate

type Rep ElasticsearchDestinationUpdate = D1 ('MetaData "ElasticsearchDestinationUpdate" "Amazonka.Firehose.Types.ElasticsearchDestinationUpdate" "amazonka-kinesis-firehose-2.0-6l1hHmh2UnHBvolxuQFkWB" 'False) (C1 ('MetaCons "ElasticsearchDestinationUpdate'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "bufferingHints") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ElasticsearchBufferingHints)) :*: S1 ('MetaSel ('Just "cloudWatchLoggingOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CloudWatchLoggingOptions))) :*: (S1 ('MetaSel ('Just "clusterEndpoint") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "domainARN") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "indexName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :*: ((S1 ('MetaSel ('Just "indexRotationPeriod") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ElasticsearchIndexRotationPeriod)) :*: (S1 ('MetaSel ('Just "processingConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ProcessingConfiguration)) :*: S1 ('MetaSel ('Just "retryOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ElasticsearchRetryOptions)))) :*: (S1 ('MetaSel ('Just "roleARN") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "s3Update") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe S3DestinationUpdate)) :*: S1 ('MetaSel ('Just "typeName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))))

newElasticsearchDestinationUpdate :: ElasticsearchDestinationUpdate Source #

Create a value of ElasticsearchDestinationUpdate 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:

ElasticsearchDestinationUpdate, elasticsearchDestinationUpdate_bufferingHints - The buffering options. If no value is specified, ElasticsearchBufferingHints object default values are used.

ElasticsearchDestinationUpdate, elasticsearchDestinationUpdate_cloudWatchLoggingOptions - The CloudWatch logging options for your delivery stream.

$sel:clusterEndpoint:ElasticsearchDestinationUpdate', elasticsearchDestinationUpdate_clusterEndpoint - The endpoint to use when communicating with the cluster. Specify either this ClusterEndpoint or the DomainARN field.

$sel:domainARN:ElasticsearchDestinationUpdate', elasticsearchDestinationUpdate_domainARN - The ARN of the Amazon ES domain. The IAM role must have permissions for DescribeDomain, DescribeDomains, and DescribeDomainConfig after assuming the IAM role specified in RoleARN. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.

Specify either ClusterEndpoint or DomainARN.

$sel:indexName:ElasticsearchDestinationUpdate', elasticsearchDestinationUpdate_indexName - The Elasticsearch index name.

$sel:indexRotationPeriod:ElasticsearchDestinationUpdate', elasticsearchDestinationUpdate_indexRotationPeriod - The Elasticsearch index rotation period. Index rotation appends a timestamp to IndexName to facilitate the expiration of old data. For more information, see Index Rotation for the Amazon ES Destination. Default value is OneDay.

$sel:processingConfiguration:ElasticsearchDestinationUpdate', elasticsearchDestinationUpdate_processingConfiguration - The data processing configuration.

$sel:retryOptions:ElasticsearchDestinationUpdate', elasticsearchDestinationUpdate_retryOptions - The retry behavior in case Kinesis Data Firehose is unable to deliver documents to Amazon ES. The default value is 300 (5 minutes).

ElasticsearchDestinationUpdate, elasticsearchDestinationUpdate_roleARN - The Amazon Resource Name (ARN) of the IAM role to be assumed by Kinesis Data Firehose for calling the Amazon ES Configuration API and for indexing documents. For more information, see Grant Kinesis Data Firehose Access to an Amazon S3 Destination and Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.

$sel:s3Update:ElasticsearchDestinationUpdate', elasticsearchDestinationUpdate_s3Update - The Amazon S3 destination.

$sel:typeName:ElasticsearchDestinationUpdate', elasticsearchDestinationUpdate_typeName - The Elasticsearch type name. For Elasticsearch 6.x, there can be only one type per index. If you try to specify a new type for an existing index that already has another type, Kinesis Data Firehose returns an error during runtime.

If you upgrade Elasticsearch from 6.x to 7.x and don’t update your delivery stream, Kinesis Data Firehose still delivers data to Elasticsearch with the old index name and type name. If you want to update your delivery stream with a new index name, provide an empty string for TypeName.

elasticsearchDestinationUpdate_bufferingHints :: Lens' ElasticsearchDestinationUpdate (Maybe ElasticsearchBufferingHints) Source #

The buffering options. If no value is specified, ElasticsearchBufferingHints object default values are used.

elasticsearchDestinationUpdate_clusterEndpoint :: Lens' ElasticsearchDestinationUpdate (Maybe Text) Source #

The endpoint to use when communicating with the cluster. Specify either this ClusterEndpoint or the DomainARN field.

elasticsearchDestinationUpdate_domainARN :: Lens' ElasticsearchDestinationUpdate (Maybe Text) Source #

The ARN of the Amazon ES domain. The IAM role must have permissions for DescribeDomain, DescribeDomains, and DescribeDomainConfig after assuming the IAM role specified in RoleARN. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.

Specify either ClusterEndpoint or DomainARN.

elasticsearchDestinationUpdate_indexRotationPeriod :: Lens' ElasticsearchDestinationUpdate (Maybe ElasticsearchIndexRotationPeriod) Source #

The Elasticsearch index rotation period. Index rotation appends a timestamp to IndexName to facilitate the expiration of old data. For more information, see Index Rotation for the Amazon ES Destination. Default value is OneDay.

elasticsearchDestinationUpdate_retryOptions :: Lens' ElasticsearchDestinationUpdate (Maybe ElasticsearchRetryOptions) Source #

The retry behavior in case Kinesis Data Firehose is unable to deliver documents to Amazon ES. The default value is 300 (5 minutes).

elasticsearchDestinationUpdate_roleARN :: Lens' ElasticsearchDestinationUpdate (Maybe Text) Source #

The Amazon Resource Name (ARN) of the IAM role to be assumed by Kinesis Data Firehose for calling the Amazon ES Configuration API and for indexing documents. For more information, see Grant Kinesis Data Firehose Access to an Amazon S3 Destination and Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.

elasticsearchDestinationUpdate_typeName :: Lens' ElasticsearchDestinationUpdate (Maybe Text) Source #

The Elasticsearch type name. For Elasticsearch 6.x, there can be only one type per index. If you try to specify a new type for an existing index that already has another type, Kinesis Data Firehose returns an error during runtime.

If you upgrade Elasticsearch from 6.x to 7.x and don’t update your delivery stream, Kinesis Data Firehose still delivers data to Elasticsearch with the old index name and type name. If you want to update your delivery stream with a new index name, provide an empty string for TypeName.

ElasticsearchRetryOptions

data ElasticsearchRetryOptions Source #

Configures retry behavior in case Kinesis Data Firehose is unable to deliver documents to Amazon ES.

See: newElasticsearchRetryOptions smart constructor.

Constructors

ElasticsearchRetryOptions' 

Fields

  • durationInSeconds :: Maybe Natural

    After an initial failure to deliver to Amazon ES, the total amount of time during which Kinesis Data Firehose retries delivery (including the first attempt). After this time has elapsed, the failed documents are written to Amazon S3. Default value is 300 seconds (5 minutes). A value of 0 (zero) results in no retries.

Instances

Instances details
FromJSON ElasticsearchRetryOptions Source # 
Instance details

Defined in Amazonka.Firehose.Types.ElasticsearchRetryOptions

ToJSON ElasticsearchRetryOptions Source # 
Instance details

Defined in Amazonka.Firehose.Types.ElasticsearchRetryOptions

Generic ElasticsearchRetryOptions Source # 
Instance details

Defined in Amazonka.Firehose.Types.ElasticsearchRetryOptions

Associated Types

type Rep ElasticsearchRetryOptions :: Type -> Type #

Read ElasticsearchRetryOptions Source # 
Instance details

Defined in Amazonka.Firehose.Types.ElasticsearchRetryOptions

Show ElasticsearchRetryOptions Source # 
Instance details

Defined in Amazonka.Firehose.Types.ElasticsearchRetryOptions

NFData ElasticsearchRetryOptions Source # 
Instance details

Defined in Amazonka.Firehose.Types.ElasticsearchRetryOptions

Eq ElasticsearchRetryOptions Source # 
Instance details

Defined in Amazonka.Firehose.Types.ElasticsearchRetryOptions

Hashable ElasticsearchRetryOptions Source # 
Instance details

Defined in Amazonka.Firehose.Types.ElasticsearchRetryOptions

type Rep ElasticsearchRetryOptions Source # 
Instance details

Defined in Amazonka.Firehose.Types.ElasticsearchRetryOptions

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

newElasticsearchRetryOptions :: ElasticsearchRetryOptions Source #

Create a value of ElasticsearchRetryOptions 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:durationInSeconds:ElasticsearchRetryOptions', elasticsearchRetryOptions_durationInSeconds - After an initial failure to deliver to Amazon ES, the total amount of time during which Kinesis Data Firehose retries delivery (including the first attempt). After this time has elapsed, the failed documents are written to Amazon S3. Default value is 300 seconds (5 minutes). A value of 0 (zero) results in no retries.

elasticsearchRetryOptions_durationInSeconds :: Lens' ElasticsearchRetryOptions (Maybe Natural) Source #

After an initial failure to deliver to Amazon ES, the total amount of time during which Kinesis Data Firehose retries delivery (including the first attempt). After this time has elapsed, the failed documents are written to Amazon S3. Default value is 300 seconds (5 minutes). A value of 0 (zero) results in no retries.

EncryptionConfiguration

data EncryptionConfiguration Source #

Describes the encryption for a destination in Amazon S3.

See: newEncryptionConfiguration smart constructor.

Constructors

EncryptionConfiguration' 

Fields

Instances

Instances details
FromJSON EncryptionConfiguration Source # 
Instance details

Defined in Amazonka.Firehose.Types.EncryptionConfiguration

ToJSON EncryptionConfiguration Source # 
Instance details

Defined in Amazonka.Firehose.Types.EncryptionConfiguration

Generic EncryptionConfiguration Source # 
Instance details

Defined in Amazonka.Firehose.Types.EncryptionConfiguration

Associated Types

type Rep EncryptionConfiguration :: Type -> Type #

Read EncryptionConfiguration Source # 
Instance details

Defined in Amazonka.Firehose.Types.EncryptionConfiguration

Show EncryptionConfiguration Source # 
Instance details

Defined in Amazonka.Firehose.Types.EncryptionConfiguration

NFData EncryptionConfiguration Source # 
Instance details

Defined in Amazonka.Firehose.Types.EncryptionConfiguration

Methods

rnf :: EncryptionConfiguration -> () #

Eq EncryptionConfiguration Source # 
Instance details

Defined in Amazonka.Firehose.Types.EncryptionConfiguration

Hashable EncryptionConfiguration Source # 
Instance details

Defined in Amazonka.Firehose.Types.EncryptionConfiguration

type Rep EncryptionConfiguration Source # 
Instance details

Defined in Amazonka.Firehose.Types.EncryptionConfiguration

type Rep EncryptionConfiguration = D1 ('MetaData "EncryptionConfiguration" "Amazonka.Firehose.Types.EncryptionConfiguration" "amazonka-kinesis-firehose-2.0-6l1hHmh2UnHBvolxuQFkWB" 'False) (C1 ('MetaCons "EncryptionConfiguration'" 'PrefixI 'True) (S1 ('MetaSel ('Just "kmsEncryptionConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe KMSEncryptionConfig)) :*: S1 ('MetaSel ('Just "noEncryptionConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe NoEncryptionConfig))))

newEncryptionConfiguration :: EncryptionConfiguration Source #

Create a value of EncryptionConfiguration 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:kmsEncryptionConfig:EncryptionConfiguration', encryptionConfiguration_kmsEncryptionConfig - The encryption key.

$sel:noEncryptionConfig:EncryptionConfiguration', encryptionConfiguration_noEncryptionConfig - Specifically override existing encryption information to ensure that no encryption is used.

encryptionConfiguration_noEncryptionConfig :: Lens' EncryptionConfiguration (Maybe NoEncryptionConfig) Source #

Specifically override existing encryption information to ensure that no encryption is used.

ExtendedS3DestinationConfiguration

data ExtendedS3DestinationConfiguration Source #

Describes the configuration of a destination in Amazon S3.

See: newExtendedS3DestinationConfiguration smart constructor.

Constructors

ExtendedS3DestinationConfiguration' 

Fields

Instances

Instances details
ToJSON ExtendedS3DestinationConfiguration Source # 
Instance details

Defined in Amazonka.Firehose.Types.ExtendedS3DestinationConfiguration

Generic ExtendedS3DestinationConfiguration Source # 
Instance details

Defined in Amazonka.Firehose.Types.ExtendedS3DestinationConfiguration

Associated Types

type Rep ExtendedS3DestinationConfiguration :: Type -> Type #

Read ExtendedS3DestinationConfiguration Source # 
Instance details

Defined in Amazonka.Firehose.Types.ExtendedS3DestinationConfiguration

Show ExtendedS3DestinationConfiguration Source # 
Instance details

Defined in Amazonka.Firehose.Types.ExtendedS3DestinationConfiguration

NFData ExtendedS3DestinationConfiguration Source # 
Instance details

Defined in Amazonka.Firehose.Types.ExtendedS3DestinationConfiguration

Eq ExtendedS3DestinationConfiguration Source # 
Instance details

Defined in Amazonka.Firehose.Types.ExtendedS3DestinationConfiguration

Hashable ExtendedS3DestinationConfiguration Source # 
Instance details

Defined in Amazonka.Firehose.Types.ExtendedS3DestinationConfiguration

type Rep ExtendedS3DestinationConfiguration Source # 
Instance details

Defined in Amazonka.Firehose.Types.ExtendedS3DestinationConfiguration

type Rep ExtendedS3DestinationConfiguration = D1 ('MetaData "ExtendedS3DestinationConfiguration" "Amazonka.Firehose.Types.ExtendedS3DestinationConfiguration" "amazonka-kinesis-firehose-2.0-6l1hHmh2UnHBvolxuQFkWB" 'False) (C1 ('MetaCons "ExtendedS3DestinationConfiguration'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "bufferingHints") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe BufferingHints)) :*: (S1 ('MetaSel ('Just "cloudWatchLoggingOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CloudWatchLoggingOptions)) :*: S1 ('MetaSel ('Just "compressionFormat") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CompressionFormat)))) :*: (S1 ('MetaSel ('Just "dataFormatConversionConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DataFormatConversionConfiguration)) :*: (S1 ('MetaSel ('Just "dynamicPartitioningConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DynamicPartitioningConfiguration)) :*: S1 ('MetaSel ('Just "encryptionConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EncryptionConfiguration))))) :*: ((S1 ('MetaSel ('Just "errorOutputPrefix") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "prefix") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "processingConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ProcessingConfiguration)))) :*: ((S1 ('MetaSel ('Just "s3BackupConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe S3DestinationConfiguration)) :*: S1 ('MetaSel ('Just "s3BackupMode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe S3BackupMode))) :*: (S1 ('MetaSel ('Just "roleARN") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "bucketARN") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))

newExtendedS3DestinationConfiguration Source #

Create a value of ExtendedS3DestinationConfiguration 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:

ExtendedS3DestinationConfiguration, extendedS3DestinationConfiguration_bufferingHints - The buffering option.

ExtendedS3DestinationConfiguration, extendedS3DestinationConfiguration_cloudWatchLoggingOptions - The Amazon CloudWatch logging options for your delivery stream.

ExtendedS3DestinationConfiguration, extendedS3DestinationConfiguration_compressionFormat - The compression format. If no value is specified, the default is UNCOMPRESSED.

$sel:dataFormatConversionConfiguration:ExtendedS3DestinationConfiguration', extendedS3DestinationConfiguration_dataFormatConversionConfiguration - The serializer, deserializer, and schema for converting data from the JSON format to the Parquet or ORC format before writing it to Amazon S3.

$sel:dynamicPartitioningConfiguration:ExtendedS3DestinationConfiguration', extendedS3DestinationConfiguration_dynamicPartitioningConfiguration - The configuration of the dynamic partitioning mechanism that creates smaller data sets from the streaming data by partitioning it based on partition keys. Currently, dynamic partitioning is only supported for Amazon S3 destinations.

ExtendedS3DestinationConfiguration, extendedS3DestinationConfiguration_encryptionConfiguration - The encryption configuration. If no value is specified, the default is no encryption.

ExtendedS3DestinationConfiguration, extendedS3DestinationConfiguration_errorOutputPrefix - A prefix that Kinesis Data Firehose evaluates and adds to failed records before writing them to S3. This prefix appears immediately following the bucket name. For information about how to specify this prefix, see Custom Prefixes for Amazon S3 Objects.

ExtendedS3DestinationConfiguration, extendedS3DestinationConfiguration_prefix - The "YYYY/MM/DD/HH" time format prefix is automatically used for delivered Amazon S3 files. You can also specify a custom prefix, as described in Custom Prefixes for Amazon S3 Objects.

$sel:processingConfiguration:ExtendedS3DestinationConfiguration', extendedS3DestinationConfiguration_processingConfiguration - The data processing configuration.

$sel:s3BackupConfiguration:ExtendedS3DestinationConfiguration', extendedS3DestinationConfiguration_s3BackupConfiguration - The configuration for backup in Amazon S3.

$sel:s3BackupMode:ExtendedS3DestinationConfiguration', extendedS3DestinationConfiguration_s3BackupMode - The Amazon S3 backup mode. After you create a delivery stream, you can update it to enable Amazon S3 backup if it is disabled. If backup is enabled, you can't update the delivery stream to disable it.

ExtendedS3DestinationConfiguration, extendedS3DestinationConfiguration_roleARN - The Amazon Resource Name (ARN) of the Amazon Web Services credentials. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.

ExtendedS3DestinationConfiguration, extendedS3DestinationConfiguration_bucketARN - The ARN of the S3 bucket. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.

extendedS3DestinationConfiguration_compressionFormat :: Lens' ExtendedS3DestinationConfiguration (Maybe CompressionFormat) Source #

The compression format. If no value is specified, the default is UNCOMPRESSED.

extendedS3DestinationConfiguration_dataFormatConversionConfiguration :: Lens' ExtendedS3DestinationConfiguration (Maybe DataFormatConversionConfiguration) Source #

The serializer, deserializer, and schema for converting data from the JSON format to the Parquet or ORC format before writing it to Amazon S3.

extendedS3DestinationConfiguration_dynamicPartitioningConfiguration :: Lens' ExtendedS3DestinationConfiguration (Maybe DynamicPartitioningConfiguration) Source #

The configuration of the dynamic partitioning mechanism that creates smaller data sets from the streaming data by partitioning it based on partition keys. Currently, dynamic partitioning is only supported for Amazon S3 destinations.

extendedS3DestinationConfiguration_encryptionConfiguration :: Lens' ExtendedS3DestinationConfiguration (Maybe EncryptionConfiguration) Source #

The encryption configuration. If no value is specified, the default is no encryption.

extendedS3DestinationConfiguration_errorOutputPrefix :: Lens' ExtendedS3DestinationConfiguration (Maybe Text) Source #

A prefix that Kinesis Data Firehose evaluates and adds to failed records before writing them to S3. This prefix appears immediately following the bucket name. For information about how to specify this prefix, see Custom Prefixes for Amazon S3 Objects.

extendedS3DestinationConfiguration_prefix :: Lens' ExtendedS3DestinationConfiguration (Maybe Text) Source #

The "YYYY/MM/DD/HH" time format prefix is automatically used for delivered Amazon S3 files. You can also specify a custom prefix, as described in Custom Prefixes for Amazon S3 Objects.

extendedS3DestinationConfiguration_s3BackupMode :: Lens' ExtendedS3DestinationConfiguration (Maybe S3BackupMode) Source #

The Amazon S3 backup mode. After you create a delivery stream, you can update it to enable Amazon S3 backup if it is disabled. If backup is enabled, you can't update the delivery stream to disable it.

ExtendedS3DestinationDescription

data ExtendedS3DestinationDescription Source #

Describes a destination in Amazon S3.

See: newExtendedS3DestinationDescription smart constructor.

Constructors

ExtendedS3DestinationDescription' 

Fields

Instances

Instances details
FromJSON ExtendedS3DestinationDescription Source # 
Instance details

Defined in Amazonka.Firehose.Types.ExtendedS3DestinationDescription

Generic ExtendedS3DestinationDescription Source # 
Instance details

Defined in Amazonka.Firehose.Types.ExtendedS3DestinationDescription

Associated Types

type Rep ExtendedS3DestinationDescription :: Type -> Type #

Read ExtendedS3DestinationDescription Source # 
Instance details

Defined in Amazonka.Firehose.Types.ExtendedS3DestinationDescription

Show ExtendedS3DestinationDescription Source # 
Instance details

Defined in Amazonka.Firehose.Types.ExtendedS3DestinationDescription

NFData ExtendedS3DestinationDescription Source # 
Instance details

Defined in Amazonka.Firehose.Types.ExtendedS3DestinationDescription

Eq ExtendedS3DestinationDescription Source # 
Instance details

Defined in Amazonka.Firehose.Types.ExtendedS3DestinationDescription

Hashable ExtendedS3DestinationDescription Source # 
Instance details

Defined in Amazonka.Firehose.Types.ExtendedS3DestinationDescription

type Rep ExtendedS3DestinationDescription Source # 
Instance details

Defined in Amazonka.Firehose.Types.ExtendedS3DestinationDescription

type Rep ExtendedS3DestinationDescription = D1 ('MetaData "ExtendedS3DestinationDescription" "Amazonka.Firehose.Types.ExtendedS3DestinationDescription" "amazonka-kinesis-firehose-2.0-6l1hHmh2UnHBvolxuQFkWB" 'False) (C1 ('MetaCons "ExtendedS3DestinationDescription'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "cloudWatchLoggingOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CloudWatchLoggingOptions)) :*: (S1 ('MetaSel ('Just "dataFormatConversionConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DataFormatConversionConfiguration)) :*: S1 ('MetaSel ('Just "dynamicPartitioningConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DynamicPartitioningConfiguration)))) :*: (S1 ('MetaSel ('Just "errorOutputPrefix") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "prefix") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "processingConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ProcessingConfiguration))))) :*: ((S1 ('MetaSel ('Just "s3BackupDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe S3DestinationDescription)) :*: (S1 ('MetaSel ('Just "s3BackupMode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe S3BackupMode)) :*: S1 ('MetaSel ('Just "roleARN") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) :*: ((S1 ('MetaSel ('Just "bucketARN") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "bufferingHints") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 BufferingHints)) :*: (S1 ('MetaSel ('Just "compressionFormat") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 CompressionFormat) :*: S1 ('MetaSel ('Just "encryptionConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 EncryptionConfiguration))))))

newExtendedS3DestinationDescription Source #

Create a value of ExtendedS3DestinationDescription 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:

ExtendedS3DestinationDescription, extendedS3DestinationDescription_cloudWatchLoggingOptions - The Amazon CloudWatch logging options for your delivery stream.

$sel:dataFormatConversionConfiguration:ExtendedS3DestinationDescription', extendedS3DestinationDescription_dataFormatConversionConfiguration - The serializer, deserializer, and schema for converting data from the JSON format to the Parquet or ORC format before writing it to Amazon S3.

$sel:dynamicPartitioningConfiguration:ExtendedS3DestinationDescription', extendedS3DestinationDescription_dynamicPartitioningConfiguration - The configuration of the dynamic partitioning mechanism that creates smaller data sets from the streaming data by partitioning it based on partition keys. Currently, dynamic partitioning is only supported for Amazon S3 destinations.

ExtendedS3DestinationDescription, extendedS3DestinationDescription_errorOutputPrefix - A prefix that Kinesis Data Firehose evaluates and adds to failed records before writing them to S3. This prefix appears immediately following the bucket name. For information about how to specify this prefix, see Custom Prefixes for Amazon S3 Objects.

ExtendedS3DestinationDescription, extendedS3DestinationDescription_prefix - The "YYYY/MM/DD/HH" time format prefix is automatically used for delivered Amazon S3 files. You can also specify a custom prefix, as described in Custom Prefixes for Amazon S3 Objects.

$sel:processingConfiguration:ExtendedS3DestinationDescription', extendedS3DestinationDescription_processingConfiguration - The data processing configuration.

$sel:s3BackupDescription:ExtendedS3DestinationDescription', extendedS3DestinationDescription_s3BackupDescription - The configuration for backup in Amazon S3.

$sel:s3BackupMode:ExtendedS3DestinationDescription', extendedS3DestinationDescription_s3BackupMode - The Amazon S3 backup mode.

ExtendedS3DestinationDescription, extendedS3DestinationDescription_roleARN - The Amazon Resource Name (ARN) of the Amazon Web Services credentials. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.

ExtendedS3DestinationDescription, extendedS3DestinationDescription_bucketARN - The ARN of the S3 bucket. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.

ExtendedS3DestinationDescription, extendedS3DestinationDescription_bufferingHints - The buffering option.

ExtendedS3DestinationDescription, extendedS3DestinationDescription_compressionFormat - The compression format. If no value is specified, the default is UNCOMPRESSED.

ExtendedS3DestinationDescription, extendedS3DestinationDescription_encryptionConfiguration - The encryption configuration. If no value is specified, the default is no encryption.

extendedS3DestinationDescription_dataFormatConversionConfiguration :: Lens' ExtendedS3DestinationDescription (Maybe DataFormatConversionConfiguration) Source #

The serializer, deserializer, and schema for converting data from the JSON format to the Parquet or ORC format before writing it to Amazon S3.

extendedS3DestinationDescription_dynamicPartitioningConfiguration :: Lens' ExtendedS3DestinationDescription (Maybe DynamicPartitioningConfiguration) Source #

The configuration of the dynamic partitioning mechanism that creates smaller data sets from the streaming data by partitioning it based on partition keys. Currently, dynamic partitioning is only supported for Amazon S3 destinations.

extendedS3DestinationDescription_errorOutputPrefix :: Lens' ExtendedS3DestinationDescription (Maybe Text) Source #

A prefix that Kinesis Data Firehose evaluates and adds to failed records before writing them to S3. This prefix appears immediately following the bucket name. For information about how to specify this prefix, see Custom Prefixes for Amazon S3 Objects.

extendedS3DestinationDescription_prefix :: Lens' ExtendedS3DestinationDescription (Maybe Text) Source #

The "YYYY/MM/DD/HH" time format prefix is automatically used for delivered Amazon S3 files. You can also specify a custom prefix, as described in Custom Prefixes for Amazon S3 Objects.

extendedS3DestinationDescription_roleARN :: Lens' ExtendedS3DestinationDescription Text Source #

The Amazon Resource Name (ARN) of the Amazon Web Services credentials. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.

extendedS3DestinationDescription_compressionFormat :: Lens' ExtendedS3DestinationDescription CompressionFormat Source #

The compression format. If no value is specified, the default is UNCOMPRESSED.

extendedS3DestinationDescription_encryptionConfiguration :: Lens' ExtendedS3DestinationDescription EncryptionConfiguration Source #

The encryption configuration. If no value is specified, the default is no encryption.

ExtendedS3DestinationUpdate

data ExtendedS3DestinationUpdate Source #

Describes an update for a destination in Amazon S3.

See: newExtendedS3DestinationUpdate smart constructor.

Constructors

ExtendedS3DestinationUpdate' 

Fields

Instances

Instances details
ToJSON ExtendedS3DestinationUpdate Source # 
Instance details

Defined in Amazonka.Firehose.Types.ExtendedS3DestinationUpdate

Generic ExtendedS3DestinationUpdate Source # 
Instance details

Defined in Amazonka.Firehose.Types.ExtendedS3DestinationUpdate

Associated Types

type Rep ExtendedS3DestinationUpdate :: Type -> Type #

Read ExtendedS3DestinationUpdate Source # 
Instance details

Defined in Amazonka.Firehose.Types.ExtendedS3DestinationUpdate

Show ExtendedS3DestinationUpdate Source # 
Instance details

Defined in Amazonka.Firehose.Types.ExtendedS3DestinationUpdate

NFData ExtendedS3DestinationUpdate Source # 
Instance details

Defined in Amazonka.Firehose.Types.ExtendedS3DestinationUpdate

Eq ExtendedS3DestinationUpdate Source # 
Instance details

Defined in Amazonka.Firehose.Types.ExtendedS3DestinationUpdate

Hashable ExtendedS3DestinationUpdate Source # 
Instance details

Defined in Amazonka.Firehose.Types.ExtendedS3DestinationUpdate

type Rep ExtendedS3DestinationUpdate Source # 
Instance details

Defined in Amazonka.Firehose.Types.ExtendedS3DestinationUpdate

type Rep ExtendedS3DestinationUpdate = D1 ('MetaData "ExtendedS3DestinationUpdate" "Amazonka.Firehose.Types.ExtendedS3DestinationUpdate" "amazonka-kinesis-firehose-2.0-6l1hHmh2UnHBvolxuQFkWB" 'False) (C1 ('MetaCons "ExtendedS3DestinationUpdate'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "bucketARN") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "bufferingHints") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe BufferingHints)) :*: S1 ('MetaSel ('Just "cloudWatchLoggingOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CloudWatchLoggingOptions)))) :*: (S1 ('MetaSel ('Just "compressionFormat") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CompressionFormat)) :*: (S1 ('MetaSel ('Just "dataFormatConversionConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DataFormatConversionConfiguration)) :*: S1 ('MetaSel ('Just "dynamicPartitioningConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DynamicPartitioningConfiguration))))) :*: ((S1 ('MetaSel ('Just "encryptionConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EncryptionConfiguration)) :*: (S1 ('MetaSel ('Just "errorOutputPrefix") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "prefix") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "processingConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ProcessingConfiguration)) :*: S1 ('MetaSel ('Just "roleARN") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "s3BackupMode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe S3BackupMode)) :*: S1 ('MetaSel ('Just "s3BackupUpdate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe S3DestinationUpdate)))))))

newExtendedS3DestinationUpdate :: ExtendedS3DestinationUpdate Source #

Create a value of ExtendedS3DestinationUpdate 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:

ExtendedS3DestinationUpdate, extendedS3DestinationUpdate_bucketARN - The ARN of the S3 bucket. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.

ExtendedS3DestinationUpdate, extendedS3DestinationUpdate_bufferingHints - The buffering option.

ExtendedS3DestinationUpdate, extendedS3DestinationUpdate_cloudWatchLoggingOptions - The Amazon CloudWatch logging options for your delivery stream.

ExtendedS3DestinationUpdate, extendedS3DestinationUpdate_compressionFormat - The compression format. If no value is specified, the default is UNCOMPRESSED.

$sel:dataFormatConversionConfiguration:ExtendedS3DestinationUpdate', extendedS3DestinationUpdate_dataFormatConversionConfiguration - The serializer, deserializer, and schema for converting data from the JSON format to the Parquet or ORC format before writing it to Amazon S3.

$sel:dynamicPartitioningConfiguration:ExtendedS3DestinationUpdate', extendedS3DestinationUpdate_dynamicPartitioningConfiguration - The configuration of the dynamic partitioning mechanism that creates smaller data sets from the streaming data by partitioning it based on partition keys. Currently, dynamic partitioning is only supported for Amazon S3 destinations.

ExtendedS3DestinationUpdate, extendedS3DestinationUpdate_encryptionConfiguration - The encryption configuration. If no value is specified, the default is no encryption.

ExtendedS3DestinationUpdate, extendedS3DestinationUpdate_errorOutputPrefix - A prefix that Kinesis Data Firehose evaluates and adds to failed records before writing them to S3. This prefix appears immediately following the bucket name. For information about how to specify this prefix, see Custom Prefixes for Amazon S3 Objects.

ExtendedS3DestinationUpdate, extendedS3DestinationUpdate_prefix - The "YYYY/MM/DD/HH" time format prefix is automatically used for delivered Amazon S3 files. You can also specify a custom prefix, as described in Custom Prefixes for Amazon S3 Objects.

$sel:processingConfiguration:ExtendedS3DestinationUpdate', extendedS3DestinationUpdate_processingConfiguration - The data processing configuration.

ExtendedS3DestinationUpdate, extendedS3DestinationUpdate_roleARN - The Amazon Resource Name (ARN) of the Amazon Web Services credentials. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.

$sel:s3BackupMode:ExtendedS3DestinationUpdate', extendedS3DestinationUpdate_s3BackupMode - You can update a delivery stream to enable Amazon S3 backup if it is disabled. If backup is enabled, you can't update the delivery stream to disable it.

$sel:s3BackupUpdate:ExtendedS3DestinationUpdate', extendedS3DestinationUpdate_s3BackupUpdate - The Amazon S3 destination for backup.

extendedS3DestinationUpdate_compressionFormat :: Lens' ExtendedS3DestinationUpdate (Maybe CompressionFormat) Source #

The compression format. If no value is specified, the default is UNCOMPRESSED.

extendedS3DestinationUpdate_dataFormatConversionConfiguration :: Lens' ExtendedS3DestinationUpdate (Maybe DataFormatConversionConfiguration) Source #

The serializer, deserializer, and schema for converting data from the JSON format to the Parquet or ORC format before writing it to Amazon S3.

extendedS3DestinationUpdate_dynamicPartitioningConfiguration :: Lens' ExtendedS3DestinationUpdate (Maybe DynamicPartitioningConfiguration) Source #

The configuration of the dynamic partitioning mechanism that creates smaller data sets from the streaming data by partitioning it based on partition keys. Currently, dynamic partitioning is only supported for Amazon S3 destinations.

extendedS3DestinationUpdate_encryptionConfiguration :: Lens' ExtendedS3DestinationUpdate (Maybe EncryptionConfiguration) Source #

The encryption configuration. If no value is specified, the default is no encryption.

extendedS3DestinationUpdate_errorOutputPrefix :: Lens' ExtendedS3DestinationUpdate (Maybe Text) Source #

A prefix that Kinesis Data Firehose evaluates and adds to failed records before writing them to S3. This prefix appears immediately following the bucket name. For information about how to specify this prefix, see Custom Prefixes for Amazon S3 Objects.

extendedS3DestinationUpdate_prefix :: Lens' ExtendedS3DestinationUpdate (Maybe Text) Source #

The "YYYY/MM/DD/HH" time format prefix is automatically used for delivered Amazon S3 files. You can also specify a custom prefix, as described in Custom Prefixes for Amazon S3 Objects.

extendedS3DestinationUpdate_roleARN :: Lens' ExtendedS3DestinationUpdate (Maybe Text) Source #

The Amazon Resource Name (ARN) of the Amazon Web Services credentials. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.

extendedS3DestinationUpdate_s3BackupMode :: Lens' ExtendedS3DestinationUpdate (Maybe S3BackupMode) Source #

You can update a delivery stream to enable Amazon S3 backup if it is disabled. If backup is enabled, you can't update the delivery stream to disable it.

FailureDescription

data FailureDescription Source #

Provides details in case one of the following operations fails due to an error related to KMS: CreateDeliveryStream, DeleteDeliveryStream, StartDeliveryStreamEncryption, StopDeliveryStreamEncryption.

See: newFailureDescription smart constructor.

Constructors

FailureDescription' 

Fields

Instances

Instances details
FromJSON FailureDescription Source # 
Instance details

Defined in Amazonka.Firehose.Types.FailureDescription

Generic FailureDescription Source # 
Instance details

Defined in Amazonka.Firehose.Types.FailureDescription

Associated Types

type Rep FailureDescription :: Type -> Type #

Read FailureDescription Source # 
Instance details

Defined in Amazonka.Firehose.Types.FailureDescription

Show FailureDescription Source # 
Instance details

Defined in Amazonka.Firehose.Types.FailureDescription

NFData FailureDescription Source # 
Instance details

Defined in Amazonka.Firehose.Types.FailureDescription

Methods

rnf :: FailureDescription -> () #

Eq FailureDescription Source # 
Instance details

Defined in Amazonka.Firehose.Types.FailureDescription

Hashable FailureDescription Source # 
Instance details

Defined in Amazonka.Firehose.Types.FailureDescription

type Rep FailureDescription Source # 
Instance details

Defined in Amazonka.Firehose.Types.FailureDescription

type Rep FailureDescription = D1 ('MetaData "FailureDescription" "Amazonka.Firehose.Types.FailureDescription" "amazonka-kinesis-firehose-2.0-6l1hHmh2UnHBvolxuQFkWB" 'False) (C1 ('MetaCons "FailureDescription'" 'PrefixI 'True) (S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 DeliveryStreamFailureType) :*: S1 ('MetaSel ('Just "details") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newFailureDescription Source #

Create a value of FailureDescription 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:type':FailureDescription', failureDescription_type - The type of error that caused the failure.

$sel:details:FailureDescription', failureDescription_details - A message providing details about the error that caused the failure.

failureDescription_details :: Lens' FailureDescription Text Source #

A message providing details about the error that caused the failure.

HiveJsonSerDe

data HiveJsonSerDe Source #

The native Hive / HCatalog JsonSerDe. Used by Kinesis Data Firehose for deserializing data, which means converting it from the JSON format in preparation for serializing it to the Parquet or ORC format. This is one of two deserializers you can choose, depending on which one offers the functionality you need. The other option is the OpenX SerDe.

See: newHiveJsonSerDe smart constructor.

Constructors

HiveJsonSerDe' 

Fields

  • timestampFormats :: Maybe [Text]

    Indicates how you want Kinesis Data Firehose to parse the date and timestamps that may be present in your input data JSON. To specify these format strings, follow the pattern syntax of JodaTime's DateTimeFormat format strings. For more information, see Class DateTimeFormat. You can also use the special value millis to parse timestamps in epoch milliseconds. If you don't specify a format, Kinesis Data Firehose uses java.sql.Timestamp::valueOf by default.

Instances

Instances details
FromJSON HiveJsonSerDe Source # 
Instance details

Defined in Amazonka.Firehose.Types.HiveJsonSerDe

ToJSON HiveJsonSerDe Source # 
Instance details

Defined in Amazonka.Firehose.Types.HiveJsonSerDe

Generic HiveJsonSerDe Source # 
Instance details

Defined in Amazonka.Firehose.Types.HiveJsonSerDe

Associated Types

type Rep HiveJsonSerDe :: Type -> Type #

Read HiveJsonSerDe Source # 
Instance details

Defined in Amazonka.Firehose.Types.HiveJsonSerDe

Show HiveJsonSerDe Source # 
Instance details

Defined in Amazonka.Firehose.Types.HiveJsonSerDe

NFData HiveJsonSerDe Source # 
Instance details

Defined in Amazonka.Firehose.Types.HiveJsonSerDe

Methods

rnf :: HiveJsonSerDe -> () #

Eq HiveJsonSerDe Source # 
Instance details

Defined in Amazonka.Firehose.Types.HiveJsonSerDe

Hashable HiveJsonSerDe Source # 
Instance details

Defined in Amazonka.Firehose.Types.HiveJsonSerDe

type Rep HiveJsonSerDe Source # 
Instance details

Defined in Amazonka.Firehose.Types.HiveJsonSerDe

type Rep HiveJsonSerDe = D1 ('MetaData "HiveJsonSerDe" "Amazonka.Firehose.Types.HiveJsonSerDe" "amazonka-kinesis-firehose-2.0-6l1hHmh2UnHBvolxuQFkWB" 'False) (C1 ('MetaCons "HiveJsonSerDe'" 'PrefixI 'True) (S1 ('MetaSel ('Just "timestampFormats") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))))

newHiveJsonSerDe :: HiveJsonSerDe Source #

Create a value of HiveJsonSerDe 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:timestampFormats:HiveJsonSerDe', hiveJsonSerDe_timestampFormats - Indicates how you want Kinesis Data Firehose to parse the date and timestamps that may be present in your input data JSON. To specify these format strings, follow the pattern syntax of JodaTime's DateTimeFormat format strings. For more information, see Class DateTimeFormat. You can also use the special value millis to parse timestamps in epoch milliseconds. If you don't specify a format, Kinesis Data Firehose uses java.sql.Timestamp::valueOf by default.

hiveJsonSerDe_timestampFormats :: Lens' HiveJsonSerDe (Maybe [Text]) Source #

Indicates how you want Kinesis Data Firehose to parse the date and timestamps that may be present in your input data JSON. To specify these format strings, follow the pattern syntax of JodaTime's DateTimeFormat format strings. For more information, see Class DateTimeFormat. You can also use the special value millis to parse timestamps in epoch milliseconds. If you don't specify a format, Kinesis Data Firehose uses java.sql.Timestamp::valueOf by default.

HttpEndpointBufferingHints

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

  • 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

Instances details
FromJSON HttpEndpointBufferingHints Source # 
Instance details

Defined in Amazonka.Firehose.Types.HttpEndpointBufferingHints

ToJSON 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 #

Read HttpEndpointBufferingHints Source # 
Instance details

Defined in Amazonka.Firehose.Types.HttpEndpointBufferingHints

Show HttpEndpointBufferingHints Source # 
Instance details

Defined in Amazonka.Firehose.Types.HttpEndpointBufferingHints

NFData HttpEndpointBufferingHints Source # 
Instance details

Defined in Amazonka.Firehose.Types.HttpEndpointBufferingHints

Eq HttpEndpointBufferingHints Source # 
Instance details

Defined in Amazonka.Firehose.Types.HttpEndpointBufferingHints

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

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.

HttpEndpointCommonAttribute

data HttpEndpointCommonAttribute Source #

Describes the metadata that's delivered to the specified HTTP endpoint destination.

See: newHttpEndpointCommonAttribute smart constructor.

Constructors

HttpEndpointCommonAttribute' 

Fields

Instances

Instances details
FromJSON HttpEndpointCommonAttribute Source # 
Instance details

Defined in Amazonka.Firehose.Types.HttpEndpointCommonAttribute

ToJSON HttpEndpointCommonAttribute Source # 
Instance details

Defined in Amazonka.Firehose.Types.HttpEndpointCommonAttribute

Generic HttpEndpointCommonAttribute Source # 
Instance details

Defined in Amazonka.Firehose.Types.HttpEndpointCommonAttribute

Associated Types

type Rep HttpEndpointCommonAttribute :: Type -> Type #

Show HttpEndpointCommonAttribute Source # 
Instance details

Defined in Amazonka.Firehose.Types.HttpEndpointCommonAttribute

NFData HttpEndpointCommonAttribute Source # 
Instance details

Defined in Amazonka.Firehose.Types.HttpEndpointCommonAttribute

Eq HttpEndpointCommonAttribute Source # 
Instance details

Defined in Amazonka.Firehose.Types.HttpEndpointCommonAttribute

Hashable HttpEndpointCommonAttribute Source # 
Instance details

Defined in Amazonka.Firehose.Types.HttpEndpointCommonAttribute

type Rep HttpEndpointCommonAttribute Source # 
Instance details

Defined in Amazonka.Firehose.Types.HttpEndpointCommonAttribute

type Rep HttpEndpointCommonAttribute = D1 ('MetaData "HttpEndpointCommonAttribute" "Amazonka.Firehose.Types.HttpEndpointCommonAttribute" "amazonka-kinesis-firehose-2.0-6l1hHmh2UnHBvolxuQFkWB" 'False) (C1 ('MetaCons "HttpEndpointCommonAttribute'" 'PrefixI 'True) (S1 ('MetaSel ('Just "attributeName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Sensitive Text)) :*: S1 ('MetaSel ('Just "attributeValue") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Sensitive Text))))

newHttpEndpointCommonAttribute Source #

Create a value of HttpEndpointCommonAttribute 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:attributeName:HttpEndpointCommonAttribute', httpEndpointCommonAttribute_attributeName - The name of the HTTP endpoint common attribute.

$sel:attributeValue:HttpEndpointCommonAttribute', httpEndpointCommonAttribute_attributeValue - The value of the HTTP endpoint common attribute.

HttpEndpointConfiguration

data HttpEndpointConfiguration Source #

Describes the configuration of the HTTP endpoint to which Kinesis Firehose delivers data.

See: newHttpEndpointConfiguration smart constructor.

Constructors

HttpEndpointConfiguration' 

Fields

Instances

Instances details
ToJSON HttpEndpointConfiguration Source # 
Instance details

Defined in Amazonka.Firehose.Types.HttpEndpointConfiguration

Generic HttpEndpointConfiguration Source # 
Instance details

Defined in Amazonka.Firehose.Types.HttpEndpointConfiguration

Associated Types

type Rep HttpEndpointConfiguration :: Type -> Type #

Show HttpEndpointConfiguration Source # 
Instance details

Defined in Amazonka.Firehose.Types.HttpEndpointConfiguration

NFData HttpEndpointConfiguration Source # 
Instance details

Defined in Amazonka.Firehose.Types.HttpEndpointConfiguration

Eq HttpEndpointConfiguration Source # 
Instance details

Defined in Amazonka.Firehose.Types.HttpEndpointConfiguration

Hashable HttpEndpointConfiguration Source # 
Instance details

Defined in Amazonka.Firehose.Types.HttpEndpointConfiguration

type Rep HttpEndpointConfiguration Source # 
Instance details

Defined in Amazonka.Firehose.Types.HttpEndpointConfiguration

type Rep HttpEndpointConfiguration = D1 ('MetaData "HttpEndpointConfiguration" "Amazonka.Firehose.Types.HttpEndpointConfiguration" "amazonka-kinesis-firehose-2.0-6l1hHmh2UnHBvolxuQFkWB" 'False) (C1 ('MetaCons "HttpEndpointConfiguration'" 'PrefixI 'True) (S1 ('MetaSel ('Just "accessKey") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))) :*: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "url") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Sensitive Text)))))

newHttpEndpointConfiguration Source #

Create a value of HttpEndpointConfiguration 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:accessKey:HttpEndpointConfiguration', httpEndpointConfiguration_accessKey - The access key required for Kinesis Firehose to authenticate with the HTTP endpoint selected as the destination.

$sel:name:HttpEndpointConfiguration', httpEndpointConfiguration_name - The name of the HTTP endpoint selected as the destination.

$sel:url:HttpEndpointConfiguration', httpEndpointConfiguration_url - The URL of the HTTP endpoint selected as the destination.

If you choose an HTTP endpoint as your destination, review and follow the instructions in the Appendix - HTTP Endpoint Delivery Request and Response Specifications.

httpEndpointConfiguration_accessKey :: Lens' HttpEndpointConfiguration (Maybe Text) Source #

The access key required for Kinesis Firehose to authenticate with the HTTP endpoint selected as the destination.

httpEndpointConfiguration_name :: Lens' HttpEndpointConfiguration (Maybe Text) Source #

The name of the HTTP endpoint selected as the destination.

httpEndpointConfiguration_url :: Lens' HttpEndpointConfiguration Text Source #

The URL of the HTTP endpoint selected as the destination.

If you choose an HTTP endpoint as your destination, review and follow the instructions in the Appendix - HTTP Endpoint Delivery Request and Response Specifications.

HttpEndpointDescription

data HttpEndpointDescription Source #

Describes the HTTP endpoint selected as the destination.

See: newHttpEndpointDescription smart constructor.

Constructors

HttpEndpointDescription' 

Fields

Instances

Instances details
FromJSON HttpEndpointDescription Source # 
Instance details

Defined in Amazonka.Firehose.Types.HttpEndpointDescription

Generic HttpEndpointDescription Source # 
Instance details

Defined in Amazonka.Firehose.Types.HttpEndpointDescription

Associated Types

type Rep HttpEndpointDescription :: Type -> Type #

Show HttpEndpointDescription Source # 
Instance details

Defined in Amazonka.Firehose.Types.HttpEndpointDescription

NFData HttpEndpointDescription Source # 
Instance details

Defined in Amazonka.Firehose.Types.HttpEndpointDescription

Methods

rnf :: HttpEndpointDescription -> () #

Eq HttpEndpointDescription Source # 
Instance details

Defined in Amazonka.Firehose.Types.HttpEndpointDescription

Hashable HttpEndpointDescription Source # 
Instance details

Defined in Amazonka.Firehose.Types.HttpEndpointDescription

type Rep HttpEndpointDescription Source # 
Instance details

Defined in Amazonka.Firehose.Types.HttpEndpointDescription

type Rep HttpEndpointDescription = D1 ('MetaData "HttpEndpointDescription" "Amazonka.Firehose.Types.HttpEndpointDescription" "amazonka-kinesis-firehose-2.0-6l1hHmh2UnHBvolxuQFkWB" 'False) (C1 ('MetaCons "HttpEndpointDescription'" 'PrefixI 'True) (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "url") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text)))))

newHttpEndpointDescription :: HttpEndpointDescription Source #

Create a value of HttpEndpointDescription 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:name:HttpEndpointDescription', httpEndpointDescription_name - The name of the HTTP endpoint selected as the destination.

$sel:url:HttpEndpointDescription', httpEndpointDescription_url - The URL of the HTTP endpoint selected as the destination.

httpEndpointDescription_name :: Lens' HttpEndpointDescription (Maybe Text) Source #

The name of the HTTP endpoint selected as the destination.

httpEndpointDescription_url :: Lens' HttpEndpointDescription (Maybe Text) Source #

The URL of the HTTP endpoint selected as the destination.

HttpEndpointDestinationConfiguration

data HttpEndpointDestinationConfiguration Source #

Describes the configuration of the HTTP endpoint destination.

See: newHttpEndpointDestinationConfiguration smart constructor.

Constructors

HttpEndpointDestinationConfiguration' 

Fields

Instances

Instances details
ToJSON HttpEndpointDestinationConfiguration Source # 
Instance details

Defined in Amazonka.Firehose.Types.HttpEndpointDestinationConfiguration

Generic HttpEndpointDestinationConfiguration Source # 
Instance details

Defined in Amazonka.Firehose.Types.HttpEndpointDestinationConfiguration

Show HttpEndpointDestinationConfiguration Source # 
Instance details

Defined in Amazonka.Firehose.Types.HttpEndpointDestinationConfiguration

NFData HttpEndpointDestinationConfiguration Source # 
Instance details

Defined in Amazonka.Firehose.Types.HttpEndpointDestinationConfiguration

Eq HttpEndpointDestinationConfiguration Source # 
Instance details

Defined in Amazonka.Firehose.Types.HttpEndpointDestinationConfiguration

Hashable HttpEndpointDestinationConfiguration Source # 
Instance details

Defined in Amazonka.Firehose.Types.HttpEndpointDestinationConfiguration

type Rep HttpEndpointDestinationConfiguration Source # 
Instance details

Defined in Amazonka.Firehose.Types.HttpEndpointDestinationConfiguration

type Rep HttpEndpointDestinationConfiguration = D1 ('MetaData "HttpEndpointDestinationConfiguration" "Amazonka.Firehose.Types.HttpEndpointDestinationConfiguration" "amazonka-kinesis-firehose-2.0-6l1hHmh2UnHBvolxuQFkWB" 'False) (C1 ('MetaCons "HttpEndpointDestinationConfiguration'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "bufferingHints") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe HttpEndpointBufferingHints)) :*: S1 ('MetaSel ('Just "cloudWatchLoggingOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CloudWatchLoggingOptions))) :*: (S1 ('MetaSel ('Just "processingConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ProcessingConfiguration)) :*: S1 ('MetaSel ('Just "requestConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe HttpEndpointRequestConfiguration)))) :*: ((S1 ('MetaSel ('Just "retryOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe HttpEndpointRetryOptions)) :*: S1 ('MetaSel ('Just "roleARN") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "s3BackupMode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe HttpEndpointS3BackupMode)) :*: (S1 ('MetaSel ('Just "endpointConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 HttpEndpointConfiguration) :*: S1 ('MetaSel ('Just "s3Configuration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 S3DestinationConfiguration))))))

newHttpEndpointDestinationConfiguration Source #

Create a value of HttpEndpointDestinationConfiguration 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:

HttpEndpointDestinationConfiguration, httpEndpointDestinationConfiguration_bufferingHints - The buffering options that can be used before data is delivered to the specified 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 you specify a value for one of them, you must also provide a value for the other.

HttpEndpointDestinationConfiguration, httpEndpointDestinationConfiguration_cloudWatchLoggingOptions - Undocumented member.

$sel:processingConfiguration:HttpEndpointDestinationConfiguration', httpEndpointDestinationConfiguration_processingConfiguration - Undocumented member.

$sel:requestConfiguration:HttpEndpointDestinationConfiguration', httpEndpointDestinationConfiguration_requestConfiguration - The configuration of the requeste sent to the HTTP endpoint specified as the destination.

$sel:retryOptions:HttpEndpointDestinationConfiguration', httpEndpointDestinationConfiguration_retryOptions - Describes the retry behavior in case Kinesis Data Firehose is unable to deliver data to the specified HTTP endpoint destination, or if it doesn't receive a valid acknowledgment of receipt from the specified HTTP endpoint destination.

HttpEndpointDestinationConfiguration, httpEndpointDestinationConfiguration_roleARN - Kinesis Data Firehose uses this IAM role for all the permissions that the delivery stream needs.

$sel:s3BackupMode:HttpEndpointDestinationConfiguration', httpEndpointDestinationConfiguration_s3BackupMode - Describes the S3 bucket backup options for the data that Kinesis Data Firehose delivers to the HTTP endpoint destination. You can back up all documents (AllData) or only the documents that Kinesis Data Firehose could not deliver to the specified HTTP endpoint destination (FailedDataOnly).

$sel:endpointConfiguration:HttpEndpointDestinationConfiguration', httpEndpointDestinationConfiguration_endpointConfiguration - The configuration of the HTTP endpoint selected as the destination.

$sel:s3Configuration:HttpEndpointDestinationConfiguration', httpEndpointDestinationConfiguration_s3Configuration - Undocumented member.

httpEndpointDestinationConfiguration_bufferingHints :: Lens' HttpEndpointDestinationConfiguration (Maybe HttpEndpointBufferingHints) Source #

The buffering options that can be used before data is delivered to the specified 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 you specify a value for one of them, you must also provide a value for the other.

httpEndpointDestinationConfiguration_requestConfiguration :: Lens' HttpEndpointDestinationConfiguration (Maybe HttpEndpointRequestConfiguration) Source #

The configuration of the requeste sent to the HTTP endpoint specified as the destination.

httpEndpointDestinationConfiguration_retryOptions :: Lens' HttpEndpointDestinationConfiguration (Maybe HttpEndpointRetryOptions) Source #

Describes the retry behavior in case Kinesis Data Firehose is unable to deliver data to the specified HTTP endpoint destination, or if it doesn't receive a valid acknowledgment of receipt from the specified HTTP endpoint destination.

httpEndpointDestinationConfiguration_roleARN :: Lens' HttpEndpointDestinationConfiguration (Maybe Text) Source #

Kinesis Data Firehose uses this IAM role for all the permissions that the delivery stream needs.

httpEndpointDestinationConfiguration_s3BackupMode :: Lens' HttpEndpointDestinationConfiguration (Maybe HttpEndpointS3BackupMode) Source #

Describes the S3 bucket backup options for the data that Kinesis Data Firehose delivers to the HTTP endpoint destination. You can back up all documents (AllData) or only the documents that Kinesis Data Firehose could not deliver to the specified HTTP endpoint destination (FailedDataOnly).

HttpEndpointDestinationDescription

data HttpEndpointDestinationDescription Source #

Describes the HTTP endpoint destination.

See: newHttpEndpointDestinationDescription smart constructor.

Constructors

HttpEndpointDestinationDescription' 

Fields

Instances

Instances details
FromJSON HttpEndpointDestinationDescription Source # 
Instance details

Defined in Amazonka.Firehose.Types.HttpEndpointDestinationDescription

Generic HttpEndpointDestinationDescription Source # 
Instance details

Defined in Amazonka.Firehose.Types.HttpEndpointDestinationDescription

Associated Types

type Rep HttpEndpointDestinationDescription :: Type -> Type #

Show HttpEndpointDestinationDescription Source # 
Instance details

Defined in Amazonka.Firehose.Types.HttpEndpointDestinationDescription

NFData HttpEndpointDestinationDescription Source # 
Instance details

Defined in Amazonka.Firehose.Types.HttpEndpointDestinationDescription

Eq HttpEndpointDestinationDescription Source # 
Instance details

Defined in Amazonka.Firehose.Types.HttpEndpointDestinationDescription

Hashable HttpEndpointDestinationDescription Source # 
Instance details

Defined in Amazonka.Firehose.Types.HttpEndpointDestinationDescription

type Rep HttpEndpointDestinationDescription Source # 
Instance details

Defined in Amazonka.Firehose.Types.HttpEndpointDestinationDescription

type Rep HttpEndpointDestinationDescription = D1 ('MetaData "HttpEndpointDestinationDescription" "Amazonka.Firehose.Types.HttpEndpointDestinationDescription" "amazonka-kinesis-firehose-2.0-6l1hHmh2UnHBvolxuQFkWB" 'False) (C1 ('MetaCons "HttpEndpointDestinationDescription'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "bufferingHints") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe HttpEndpointBufferingHints)) :*: S1 ('MetaSel ('Just "cloudWatchLoggingOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CloudWatchLoggingOptions))) :*: (S1 ('MetaSel ('Just "endpointConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe HttpEndpointDescription)) :*: S1 ('MetaSel ('Just "processingConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ProcessingConfiguration)))) :*: ((S1 ('MetaSel ('Just "requestConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe HttpEndpointRequestConfiguration)) :*: S1 ('MetaSel ('Just "retryOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe HttpEndpointRetryOptions))) :*: (S1 ('MetaSel ('Just "roleARN") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "s3BackupMode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe HttpEndpointS3BackupMode)) :*: S1 ('MetaSel ('Just "s3DestinationDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe S3DestinationDescription)))))))

newHttpEndpointDestinationDescription :: HttpEndpointDestinationDescription Source #

Create a value of HttpEndpointDestinationDescription 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:

HttpEndpointDestinationDescription, httpEndpointDestinationDescription_bufferingHints - Describes buffering options that can be applied to the data before it is delivered to the HTTPS endpoint destination. Kinesis Data Firehose teats 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.

HttpEndpointDestinationDescription, httpEndpointDestinationDescription_cloudWatchLoggingOptions - Undocumented member.

$sel:endpointConfiguration:HttpEndpointDestinationDescription', httpEndpointDestinationDescription_endpointConfiguration - The configuration of the specified HTTP endpoint destination.

$sel:processingConfiguration:HttpEndpointDestinationDescription', httpEndpointDestinationDescription_processingConfiguration - Undocumented member.

$sel:requestConfiguration:HttpEndpointDestinationDescription', httpEndpointDestinationDescription_requestConfiguration - The configuration of request sent to the HTTP endpoint specified as the destination.

$sel:retryOptions:HttpEndpointDestinationDescription', httpEndpointDestinationDescription_retryOptions - Describes the retry behavior in case Kinesis Data Firehose is unable to deliver data to the specified HTTP endpoint destination, or if it doesn't receive a valid acknowledgment of receipt from the specified HTTP endpoint destination.

HttpEndpointDestinationDescription, httpEndpointDestinationDescription_roleARN - Kinesis Data Firehose uses this IAM role for all the permissions that the delivery stream needs.

$sel:s3BackupMode:HttpEndpointDestinationDescription', httpEndpointDestinationDescription_s3BackupMode - Describes the S3 bucket backup options for the data that Kinesis Firehose delivers to the HTTP endpoint destination. You can back up all documents (AllData) or only the documents that Kinesis Data Firehose could not deliver to the specified HTTP endpoint destination (FailedDataOnly).

$sel:s3DestinationDescription:HttpEndpointDestinationDescription', httpEndpointDestinationDescription_s3DestinationDescription - Undocumented member.

httpEndpointDestinationDescription_bufferingHints :: Lens' HttpEndpointDestinationDescription (Maybe HttpEndpointBufferingHints) Source #

Describes buffering options that can be applied to the data before it is delivered to the HTTPS endpoint destination. Kinesis Data Firehose teats 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.

httpEndpointDestinationDescription_requestConfiguration :: Lens' HttpEndpointDestinationDescription (Maybe HttpEndpointRequestConfiguration) Source #

The configuration of request sent to the HTTP endpoint specified as the destination.

httpEndpointDestinationDescription_retryOptions :: Lens' HttpEndpointDestinationDescription (Maybe HttpEndpointRetryOptions) Source #

Describes the retry behavior in case Kinesis Data Firehose is unable to deliver data to the specified HTTP endpoint destination, or if it doesn't receive a valid acknowledgment of receipt from the specified HTTP endpoint destination.

httpEndpointDestinationDescription_roleARN :: Lens' HttpEndpointDestinationDescription (Maybe Text) Source #

Kinesis Data Firehose uses this IAM role for all the permissions that the delivery stream needs.

httpEndpointDestinationDescription_s3BackupMode :: Lens' HttpEndpointDestinationDescription (Maybe HttpEndpointS3BackupMode) Source #

Describes the S3 bucket backup options for the data that Kinesis Firehose delivers to the HTTP endpoint destination. You can back up all documents (AllData) or only the documents that Kinesis Data Firehose could not deliver to the specified HTTP endpoint destination (FailedDataOnly).

HttpEndpointDestinationUpdate

data HttpEndpointDestinationUpdate Source #

Updates the specified HTTP endpoint destination.

See: newHttpEndpointDestinationUpdate smart constructor.

Constructors

HttpEndpointDestinationUpdate' 

Fields

Instances

Instances details
ToJSON HttpEndpointDestinationUpdate Source # 
Instance details

Defined in Amazonka.Firehose.Types.HttpEndpointDestinationUpdate

Generic HttpEndpointDestinationUpdate Source # 
Instance details

Defined in Amazonka.Firehose.Types.HttpEndpointDestinationUpdate

Associated Types

type Rep HttpEndpointDestinationUpdate :: Type -> Type #

Show HttpEndpointDestinationUpdate Source # 
Instance details

Defined in Amazonka.Firehose.Types.HttpEndpointDestinationUpdate

NFData HttpEndpointDestinationUpdate Source # 
Instance details

Defined in Amazonka.Firehose.Types.HttpEndpointDestinationUpdate

Eq HttpEndpointDestinationUpdate Source # 
Instance details

Defined in Amazonka.Firehose.Types.HttpEndpointDestinationUpdate

Hashable HttpEndpointDestinationUpdate Source # 
Instance details

Defined in Amazonka.Firehose.Types.HttpEndpointDestinationUpdate

type Rep HttpEndpointDestinationUpdate Source # 
Instance details

Defined in Amazonka.Firehose.Types.HttpEndpointDestinationUpdate

type Rep HttpEndpointDestinationUpdate = D1 ('MetaData "HttpEndpointDestinationUpdate" "Amazonka.Firehose.Types.HttpEndpointDestinationUpdate" "amazonka-kinesis-firehose-2.0-6l1hHmh2UnHBvolxuQFkWB" 'False) (C1 ('MetaCons "HttpEndpointDestinationUpdate'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "bufferingHints") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe HttpEndpointBufferingHints)) :*: S1 ('MetaSel ('Just "cloudWatchLoggingOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CloudWatchLoggingOptions))) :*: (S1 ('MetaSel ('Just "endpointConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe HttpEndpointConfiguration)) :*: S1 ('MetaSel ('Just "processingConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ProcessingConfiguration)))) :*: ((S1 ('MetaSel ('Just "requestConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe HttpEndpointRequestConfiguration)) :*: S1 ('MetaSel ('Just "retryOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe HttpEndpointRetryOptions))) :*: (S1 ('MetaSel ('Just "roleARN") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "s3BackupMode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe HttpEndpointS3BackupMode)) :*: S1 ('MetaSel ('Just "s3Update") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe S3DestinationUpdate)))))))

newHttpEndpointDestinationUpdate :: HttpEndpointDestinationUpdate Source #

Create a value of HttpEndpointDestinationUpdate 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:

HttpEndpointDestinationUpdate, httpEndpointDestinationUpdate_bufferingHints - Describes buffering options that can be applied to the data before it is delivered to the HTTPS endpoint destination. Kinesis Data Firehose teats 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.

HttpEndpointDestinationUpdate, httpEndpointDestinationUpdate_cloudWatchLoggingOptions - Undocumented member.

$sel:endpointConfiguration:HttpEndpointDestinationUpdate', httpEndpointDestinationUpdate_endpointConfiguration - Describes the configuration of the HTTP endpoint destination.

$sel:processingConfiguration:HttpEndpointDestinationUpdate', httpEndpointDestinationUpdate_processingConfiguration - Undocumented member.

$sel:requestConfiguration:HttpEndpointDestinationUpdate', httpEndpointDestinationUpdate_requestConfiguration - The configuration of the request sent to the HTTP endpoint specified as the destination.

$sel:retryOptions:HttpEndpointDestinationUpdate', httpEndpointDestinationUpdate_retryOptions - Describes the retry behavior in case Kinesis Data Firehose is unable to deliver data to the specified HTTP endpoint destination, or if it doesn't receive a valid acknowledgment of receipt from the specified HTTP endpoint destination.

HttpEndpointDestinationUpdate, httpEndpointDestinationUpdate_roleARN - Kinesis Data Firehose uses this IAM role for all the permissions that the delivery stream needs.

$sel:s3BackupMode:HttpEndpointDestinationUpdate', httpEndpointDestinationUpdate_s3BackupMode - Describes the S3 bucket backup options for the data that Kinesis Firehose delivers to the HTTP endpoint destination. You can back up all documents (AllData) or only the documents that Kinesis Data Firehose could not deliver to the specified HTTP endpoint destination (FailedDataOnly).

$sel:s3Update:HttpEndpointDestinationUpdate', httpEndpointDestinationUpdate_s3Update - Undocumented member.

httpEndpointDestinationUpdate_bufferingHints :: Lens' HttpEndpointDestinationUpdate (Maybe HttpEndpointBufferingHints) Source #

Describes buffering options that can be applied to the data before it is delivered to the HTTPS endpoint destination. Kinesis Data Firehose teats 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.

httpEndpointDestinationUpdate_requestConfiguration :: Lens' HttpEndpointDestinationUpdate (Maybe HttpEndpointRequestConfiguration) Source #

The configuration of the request sent to the HTTP endpoint specified as the destination.

httpEndpointDestinationUpdate_retryOptions :: Lens' HttpEndpointDestinationUpdate (Maybe HttpEndpointRetryOptions) Source #

Describes the retry behavior in case Kinesis Data Firehose is unable to deliver data to the specified HTTP endpoint destination, or if it doesn't receive a valid acknowledgment of receipt from the specified HTTP endpoint destination.

httpEndpointDestinationUpdate_roleARN :: Lens' HttpEndpointDestinationUpdate (Maybe Text) Source #

Kinesis Data Firehose uses this IAM role for all the permissions that the delivery stream needs.

httpEndpointDestinationUpdate_s3BackupMode :: Lens' HttpEndpointDestinationUpdate (Maybe HttpEndpointS3BackupMode) Source #

Describes the S3 bucket backup options for the data that Kinesis Firehose delivers to the HTTP endpoint destination. You can back up all documents (AllData) or only the documents that Kinesis Data Firehose could not deliver to the specified HTTP endpoint destination (FailedDataOnly).

HttpEndpointRequestConfiguration

data HttpEndpointRequestConfiguration Source #

The configuration of the HTTP endpoint request.

See: newHttpEndpointRequestConfiguration smart constructor.

Constructors

HttpEndpointRequestConfiguration' 

Fields

Instances

Instances details
FromJSON HttpEndpointRequestConfiguration Source # 
Instance details

Defined in Amazonka.Firehose.Types.HttpEndpointRequestConfiguration

ToJSON HttpEndpointRequestConfiguration Source # 
Instance details

Defined in Amazonka.Firehose.Types.HttpEndpointRequestConfiguration

Generic HttpEndpointRequestConfiguration Source # 
Instance details

Defined in Amazonka.Firehose.Types.HttpEndpointRequestConfiguration

Associated Types

type Rep HttpEndpointRequestConfiguration :: Type -> Type #

Show HttpEndpointRequestConfiguration Source # 
Instance details

Defined in Amazonka.Firehose.Types.HttpEndpointRequestConfiguration

NFData HttpEndpointRequestConfiguration Source # 
Instance details

Defined in Amazonka.Firehose.Types.HttpEndpointRequestConfiguration

Eq HttpEndpointRequestConfiguration Source # 
Instance details

Defined in Amazonka.Firehose.Types.HttpEndpointRequestConfiguration

Hashable HttpEndpointRequestConfiguration Source # 
Instance details

Defined in Amazonka.Firehose.Types.HttpEndpointRequestConfiguration

type Rep HttpEndpointRequestConfiguration Source # 
Instance details

Defined in Amazonka.Firehose.Types.HttpEndpointRequestConfiguration

type Rep HttpEndpointRequestConfiguration = D1 ('MetaData "HttpEndpointRequestConfiguration" "Amazonka.Firehose.Types.HttpEndpointRequestConfiguration" "amazonka-kinesis-firehose-2.0-6l1hHmh2UnHBvolxuQFkWB" 'False) (C1 ('MetaCons "HttpEndpointRequestConfiguration'" 'PrefixI 'True) (S1 ('MetaSel ('Just "commonAttributes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [HttpEndpointCommonAttribute])) :*: S1 ('MetaSel ('Just "contentEncoding") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ContentEncoding))))

newHttpEndpointRequestConfiguration :: HttpEndpointRequestConfiguration Source #

Create a value of HttpEndpointRequestConfiguration 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:commonAttributes:HttpEndpointRequestConfiguration', httpEndpointRequestConfiguration_commonAttributes - Describes the metadata sent to the HTTP endpoint destination.

$sel:contentEncoding:HttpEndpointRequestConfiguration', httpEndpointRequestConfiguration_contentEncoding - Kinesis Data Firehose uses the content encoding to compress the body of a request before sending the request to the destination. For more information, see Content-Encoding in MDN Web Docs, the official Mozilla documentation.

httpEndpointRequestConfiguration_contentEncoding :: Lens' HttpEndpointRequestConfiguration (Maybe ContentEncoding) Source #

Kinesis Data Firehose uses the content encoding to compress the body of a request before sending the request to the destination. For more information, see Content-Encoding in MDN Web Docs, the official Mozilla documentation.

HttpEndpointRetryOptions

data HttpEndpointRetryOptions Source #

Describes the retry behavior in case Kinesis Data Firehose is unable to deliver data to the specified HTTP endpoint destination, or if it doesn't receive a valid acknowledgment of receipt from the specified HTTP endpoint destination.

See: newHttpEndpointRetryOptions smart constructor.

Constructors

HttpEndpointRetryOptions' 

Fields

  • durationInSeconds :: Maybe Natural

    The total amount of time that Kinesis Data Firehose spends on retries. This duration starts after the initial attempt to send data to the custom destination via HTTPS endpoint fails. It doesn't include the periods during which Kinesis Data Firehose waits for acknowledgment from the specified destination after each attempt.

Instances

Instances details
FromJSON HttpEndpointRetryOptions Source # 
Instance details

Defined in Amazonka.Firehose.Types.HttpEndpointRetryOptions

ToJSON HttpEndpointRetryOptions Source # 
Instance details

Defined in Amazonka.Firehose.Types.HttpEndpointRetryOptions

Generic HttpEndpointRetryOptions Source # 
Instance details

Defined in Amazonka.Firehose.Types.HttpEndpointRetryOptions

Associated Types

type Rep HttpEndpointRetryOptions :: Type -> Type #

Read HttpEndpointRetryOptions Source # 
Instance details

Defined in Amazonka.Firehose.Types.HttpEndpointRetryOptions

Show HttpEndpointRetryOptions Source # 
Instance details

Defined in Amazonka.Firehose.Types.HttpEndpointRetryOptions

NFData HttpEndpointRetryOptions Source # 
Instance details

Defined in Amazonka.Firehose.Types.HttpEndpointRetryOptions

Eq HttpEndpointRetryOptions Source # 
Instance details

Defined in Amazonka.Firehose.Types.HttpEndpointRetryOptions

Hashable HttpEndpointRetryOptions Source # 
Instance details

Defined in Amazonka.Firehose.Types.HttpEndpointRetryOptions

type Rep HttpEndpointRetryOptions Source # 
Instance details

Defined in Amazonka.Firehose.Types.HttpEndpointRetryOptions

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

newHttpEndpointRetryOptions :: HttpEndpointRetryOptions Source #

Create a value of HttpEndpointRetryOptions 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:durationInSeconds:HttpEndpointRetryOptions', httpEndpointRetryOptions_durationInSeconds - The total amount of time that Kinesis Data Firehose spends on retries. This duration starts after the initial attempt to send data to the custom destination via HTTPS endpoint fails. It doesn't include the periods during which Kinesis Data Firehose waits for acknowledgment from the specified destination after each attempt.

httpEndpointRetryOptions_durationInSeconds :: Lens' HttpEndpointRetryOptions (Maybe Natural) Source #

The total amount of time that Kinesis Data Firehose spends on retries. This duration starts after the initial attempt to send data to the custom destination via HTTPS endpoint fails. It doesn't include the periods during which Kinesis Data Firehose waits for acknowledgment from the specified destination after each attempt.

InputFormatConfiguration

data InputFormatConfiguration Source #

Specifies the deserializer you want to use to convert the format of the input data. This parameter is required if Enabled is set to true.

See: newInputFormatConfiguration smart constructor.

Constructors

InputFormatConfiguration' 

Fields

  • deserializer :: Maybe Deserializer

    Specifies which deserializer to use. You can choose either the Apache Hive JSON SerDe or the OpenX JSON SerDe. If both are non-null, the server rejects the request.

Instances

Instances details
FromJSON InputFormatConfiguration Source # 
Instance details

Defined in Amazonka.Firehose.Types.InputFormatConfiguration

ToJSON InputFormatConfiguration Source # 
Instance details

Defined in Amazonka.Firehose.Types.InputFormatConfiguration

Generic InputFormatConfiguration Source # 
Instance details

Defined in Amazonka.Firehose.Types.InputFormatConfiguration

Associated Types

type Rep InputFormatConfiguration :: Type -> Type #

Read InputFormatConfiguration Source # 
Instance details

Defined in Amazonka.Firehose.Types.InputFormatConfiguration

Show InputFormatConfiguration Source # 
Instance details

Defined in Amazonka.Firehose.Types.InputFormatConfiguration

NFData InputFormatConfiguration Source # 
Instance details

Defined in Amazonka.Firehose.Types.InputFormatConfiguration

Eq InputFormatConfiguration Source # 
Instance details

Defined in Amazonka.Firehose.Types.InputFormatConfiguration

Hashable InputFormatConfiguration Source # 
Instance details

Defined in Amazonka.Firehose.Types.InputFormatConfiguration

type Rep InputFormatConfiguration Source # 
Instance details

Defined in Amazonka.Firehose.Types.InputFormatConfiguration

type Rep InputFormatConfiguration = D1 ('MetaData "InputFormatConfiguration" "Amazonka.Firehose.Types.InputFormatConfiguration" "amazonka-kinesis-firehose-2.0-6l1hHmh2UnHBvolxuQFkWB" 'False) (C1 ('MetaCons "InputFormatConfiguration'" 'PrefixI 'True) (S1 ('MetaSel ('Just "deserializer") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Deserializer))))

newInputFormatConfiguration :: InputFormatConfiguration Source #

Create a value of InputFormatConfiguration 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:deserializer:InputFormatConfiguration', inputFormatConfiguration_deserializer - Specifies which deserializer to use. You can choose either the Apache Hive JSON SerDe or the OpenX JSON SerDe. If both are non-null, the server rejects the request.

inputFormatConfiguration_deserializer :: Lens' InputFormatConfiguration (Maybe Deserializer) Source #

Specifies which deserializer to use. You can choose either the Apache Hive JSON SerDe or the OpenX JSON SerDe. If both are non-null, the server rejects the request.

KMSEncryptionConfig

data KMSEncryptionConfig Source #

Describes an encryption key for a destination in Amazon S3.

See: newKMSEncryptionConfig smart constructor.

Constructors

KMSEncryptionConfig' 

Fields

Instances

Instances details
FromJSON KMSEncryptionConfig Source # 
Instance details

Defined in Amazonka.Firehose.Types.KMSEncryptionConfig

ToJSON KMSEncryptionConfig Source # 
Instance details

Defined in Amazonka.Firehose.Types.KMSEncryptionConfig

Generic KMSEncryptionConfig Source # 
Instance details

Defined in Amazonka.Firehose.Types.KMSEncryptionConfig

Associated Types

type Rep KMSEncryptionConfig :: Type -> Type #

Read KMSEncryptionConfig Source # 
Instance details

Defined in Amazonka.Firehose.Types.KMSEncryptionConfig

Show KMSEncryptionConfig Source # 
Instance details

Defined in Amazonka.Firehose.Types.KMSEncryptionConfig

NFData KMSEncryptionConfig Source # 
Instance details

Defined in Amazonka.Firehose.Types.KMSEncryptionConfig

Methods

rnf :: KMSEncryptionConfig -> () #

Eq KMSEncryptionConfig Source # 
Instance details

Defined in Amazonka.Firehose.Types.KMSEncryptionConfig

Hashable KMSEncryptionConfig Source # 
Instance details

Defined in Amazonka.Firehose.Types.KMSEncryptionConfig

type Rep KMSEncryptionConfig Source # 
Instance details

Defined in Amazonka.Firehose.Types.KMSEncryptionConfig

type Rep KMSEncryptionConfig = D1 ('MetaData "KMSEncryptionConfig" "Amazonka.Firehose.Types.KMSEncryptionConfig" "amazonka-kinesis-firehose-2.0-6l1hHmh2UnHBvolxuQFkWB" 'False) (C1 ('MetaCons "KMSEncryptionConfig'" 'PrefixI 'True) (S1 ('MetaSel ('Just "aWSKMSKeyARN") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newKMSEncryptionConfig Source #

Create a value of KMSEncryptionConfig 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:aWSKMSKeyARN:KMSEncryptionConfig', kmsEncryptionConfig_aWSKMSKeyARN - The Amazon Resource Name (ARN) of the encryption key. Must belong to the same Amazon Web Services Region as the destination Amazon S3 bucket. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.

kmsEncryptionConfig_aWSKMSKeyARN :: Lens' KMSEncryptionConfig Text Source #

The Amazon Resource Name (ARN) of the encryption key. Must belong to the same Amazon Web Services Region as the destination Amazon S3 bucket. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.

KinesisStreamSourceConfiguration

data KinesisStreamSourceConfiguration Source #

The stream and role Amazon Resource Names (ARNs) for a Kinesis data stream used as the source for a delivery stream.

See: newKinesisStreamSourceConfiguration smart constructor.

Constructors

KinesisStreamSourceConfiguration' 

Fields

Instances

Instances details
ToJSON KinesisStreamSourceConfiguration Source # 
Instance details

Defined in Amazonka.Firehose.Types.KinesisStreamSourceConfiguration

Generic KinesisStreamSourceConfiguration Source # 
Instance details

Defined in Amazonka.Firehose.Types.KinesisStreamSourceConfiguration

Associated Types

type Rep KinesisStreamSourceConfiguration :: Type -> Type #

Read KinesisStreamSourceConfiguration Source # 
Instance details

Defined in Amazonka.Firehose.Types.KinesisStreamSourceConfiguration

Show KinesisStreamSourceConfiguration Source # 
Instance details

Defined in Amazonka.Firehose.Types.KinesisStreamSourceConfiguration

NFData KinesisStreamSourceConfiguration Source # 
Instance details

Defined in Amazonka.Firehose.Types.KinesisStreamSourceConfiguration

Eq KinesisStreamSourceConfiguration Source # 
Instance details

Defined in Amazonka.Firehose.Types.KinesisStreamSourceConfiguration

Hashable KinesisStreamSourceConfiguration Source # 
Instance details

Defined in Amazonka.Firehose.Types.KinesisStreamSourceConfiguration

type Rep KinesisStreamSourceConfiguration Source # 
Instance details

Defined in Amazonka.Firehose.Types.KinesisStreamSourceConfiguration

type Rep KinesisStreamSourceConfiguration = D1 ('MetaData "KinesisStreamSourceConfiguration" "Amazonka.Firehose.Types.KinesisStreamSourceConfiguration" "amazonka-kinesis-firehose-2.0-6l1hHmh2UnHBvolxuQFkWB" 'False) (C1 ('MetaCons "KinesisStreamSourceConfiguration'" 'PrefixI 'True) (S1 ('MetaSel ('Just "kinesisStreamARN") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "roleARN") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newKinesisStreamSourceConfiguration Source #

Create a value of KinesisStreamSourceConfiguration 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:kinesisStreamARN:KinesisStreamSourceConfiguration', kinesisStreamSourceConfiguration_kinesisStreamARN - The ARN of the source Kinesis data stream. For more information, see Amazon Kinesis Data Streams ARN Format.

$sel:roleARN:KinesisStreamSourceConfiguration', kinesisStreamSourceConfiguration_roleARN - The ARN of the role that provides access to the source Kinesis data stream. For more information, see Amazon Web Services Identity and Access Management (IAM) ARN Format.

kinesisStreamSourceConfiguration_roleARN :: Lens' KinesisStreamSourceConfiguration Text Source #

The ARN of the role that provides access to the source Kinesis data stream. For more information, see Amazon Web Services Identity and Access Management (IAM) ARN Format.

KinesisStreamSourceDescription

data KinesisStreamSourceDescription Source #

Details about a Kinesis data stream used as the source for a Kinesis Data Firehose delivery stream.

See: newKinesisStreamSourceDescription smart constructor.

Constructors

KinesisStreamSourceDescription' 

Fields

Instances

Instances details
FromJSON KinesisStreamSourceDescription Source # 
Instance details

Defined in Amazonka.Firehose.Types.KinesisStreamSourceDescription

Generic KinesisStreamSourceDescription Source # 
Instance details

Defined in Amazonka.Firehose.Types.KinesisStreamSourceDescription

Associated Types

type Rep KinesisStreamSourceDescription :: Type -> Type #

Read KinesisStreamSourceDescription Source # 
Instance details

Defined in Amazonka.Firehose.Types.KinesisStreamSourceDescription

Show KinesisStreamSourceDescription Source # 
Instance details

Defined in Amazonka.Firehose.Types.KinesisStreamSourceDescription

NFData KinesisStreamSourceDescription Source # 
Instance details

Defined in Amazonka.Firehose.Types.KinesisStreamSourceDescription

Eq KinesisStreamSourceDescription Source # 
Instance details

Defined in Amazonka.Firehose.Types.KinesisStreamSourceDescription

Hashable KinesisStreamSourceDescription Source # 
Instance details

Defined in Amazonka.Firehose.Types.KinesisStreamSourceDescription

type Rep KinesisStreamSourceDescription Source # 
Instance details

Defined in Amazonka.Firehose.Types.KinesisStreamSourceDescription

type Rep KinesisStreamSourceDescription = D1 ('MetaData "KinesisStreamSourceDescription" "Amazonka.Firehose.Types.KinesisStreamSourceDescription" "amazonka-kinesis-firehose-2.0-6l1hHmh2UnHBvolxuQFkWB" 'False) (C1 ('MetaCons "KinesisStreamSourceDescription'" 'PrefixI 'True) (S1 ('MetaSel ('Just "deliveryStartTimestamp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: (S1 ('MetaSel ('Just "kinesisStreamARN") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "roleARN") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newKinesisStreamSourceDescription :: KinesisStreamSourceDescription Source #

Create a value of KinesisStreamSourceDescription 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:deliveryStartTimestamp:KinesisStreamSourceDescription', kinesisStreamSourceDescription_deliveryStartTimestamp - Kinesis Data Firehose starts retrieving records from the Kinesis data stream starting with this timestamp.

$sel:kinesisStreamARN:KinesisStreamSourceDescription', kinesisStreamSourceDescription_kinesisStreamARN - The Amazon Resource Name (ARN) of the source Kinesis data stream. For more information, see Amazon Kinesis Data Streams ARN Format.

$sel:roleARN:KinesisStreamSourceDescription', kinesisStreamSourceDescription_roleARN - The ARN of the role used by the source Kinesis data stream. For more information, see Amazon Web Services Identity and Access Management (IAM) ARN Format.

kinesisStreamSourceDescription_deliveryStartTimestamp :: Lens' KinesisStreamSourceDescription (Maybe UTCTime) Source #

Kinesis Data Firehose starts retrieving records from the Kinesis data stream starting with this timestamp.

kinesisStreamSourceDescription_kinesisStreamARN :: Lens' KinesisStreamSourceDescription (Maybe Text) Source #

The Amazon Resource Name (ARN) of the source Kinesis data stream. For more information, see Amazon Kinesis Data Streams ARN Format.

OpenXJsonSerDe

data OpenXJsonSerDe Source #

The OpenX SerDe. Used by Kinesis Data Firehose for deserializing data, which means converting it from the JSON format in preparation for serializing it to the Parquet or ORC format. This is one of two deserializers you can choose, depending on which one offers the functionality you need. The other option is the native Hive / HCatalog JsonSerDe.

See: newOpenXJsonSerDe smart constructor.

Constructors

OpenXJsonSerDe' 

Fields

  • caseInsensitive :: Maybe Bool

    When set to true, which is the default, Kinesis Data Firehose converts JSON keys to lowercase before deserializing them.

  • columnToJsonKeyMappings :: Maybe (HashMap Text Text)

    Maps column names to JSON keys that aren't identical to the column names. This is useful when the JSON contains keys that are Hive keywords. For example, timestamp is a Hive keyword. If you have a JSON key named timestamp, set this parameter to {"ts": "timestamp"} to map this key to a column named ts.

  • convertDotsInJsonKeysToUnderscores :: Maybe Bool

    When set to true, specifies that the names of the keys include dots and that you want Kinesis Data Firehose to replace them with underscores. This is useful because Apache Hive does not allow dots in column names. For example, if the JSON contains a key whose name is "a.b", you can define the column name to be "a_b" when using this option.

    The default is false.

Instances

Instances details
FromJSON OpenXJsonSerDe Source # 
Instance details

Defined in Amazonka.Firehose.Types.OpenXJsonSerDe

ToJSON OpenXJsonSerDe Source # 
Instance details

Defined in Amazonka.Firehose.Types.OpenXJsonSerDe

Generic OpenXJsonSerDe Source # 
Instance details

Defined in Amazonka.Firehose.Types.OpenXJsonSerDe

Associated Types

type Rep OpenXJsonSerDe :: Type -> Type #

Read OpenXJsonSerDe Source # 
Instance details

Defined in Amazonka.Firehose.Types.OpenXJsonSerDe

Show OpenXJsonSerDe Source # 
Instance details

Defined in Amazonka.Firehose.Types.OpenXJsonSerDe

NFData OpenXJsonSerDe Source # 
Instance details

Defined in Amazonka.Firehose.Types.OpenXJsonSerDe

Methods

rnf :: OpenXJsonSerDe -> () #

Eq OpenXJsonSerDe Source # 
Instance details

Defined in Amazonka.Firehose.Types.OpenXJsonSerDe

Hashable OpenXJsonSerDe Source # 
Instance details

Defined in Amazonka.Firehose.Types.OpenXJsonSerDe

type Rep OpenXJsonSerDe Source # 
Instance details

Defined in Amazonka.Firehose.Types.OpenXJsonSerDe

type Rep OpenXJsonSerDe = D1 ('MetaData "OpenXJsonSerDe" "Amazonka.Firehose.Types.OpenXJsonSerDe" "amazonka-kinesis-firehose-2.0-6l1hHmh2UnHBvolxuQFkWB" 'False) (C1 ('MetaCons "OpenXJsonSerDe'" 'PrefixI 'True) (S1 ('MetaSel ('Just "caseInsensitive") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: (S1 ('MetaSel ('Just "columnToJsonKeyMappings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :*: S1 ('MetaSel ('Just "convertDotsInJsonKeysToUnderscores") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)))))

newOpenXJsonSerDe :: OpenXJsonSerDe Source #

Create a value of OpenXJsonSerDe 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:caseInsensitive:OpenXJsonSerDe', openXJsonSerDe_caseInsensitive - When set to true, which is the default, Kinesis Data Firehose converts JSON keys to lowercase before deserializing them.

$sel:columnToJsonKeyMappings:OpenXJsonSerDe', openXJsonSerDe_columnToJsonKeyMappings - Maps column names to JSON keys that aren't identical to the column names. This is useful when the JSON contains keys that are Hive keywords. For example, timestamp is a Hive keyword. If you have a JSON key named timestamp, set this parameter to {"ts": "timestamp"} to map this key to a column named ts.

$sel:convertDotsInJsonKeysToUnderscores:OpenXJsonSerDe', openXJsonSerDe_convertDotsInJsonKeysToUnderscores - When set to true, specifies that the names of the keys include dots and that you want Kinesis Data Firehose to replace them with underscores. This is useful because Apache Hive does not allow dots in column names. For example, if the JSON contains a key whose name is "a.b", you can define the column name to be "a_b" when using this option.

The default is false.

openXJsonSerDe_caseInsensitive :: Lens' OpenXJsonSerDe (Maybe Bool) Source #

When set to true, which is the default, Kinesis Data Firehose converts JSON keys to lowercase before deserializing them.

openXJsonSerDe_columnToJsonKeyMappings :: Lens' OpenXJsonSerDe (Maybe (HashMap Text Text)) Source #

Maps column names to JSON keys that aren't identical to the column names. This is useful when the JSON contains keys that are Hive keywords. For example, timestamp is a Hive keyword. If you have a JSON key named timestamp, set this parameter to {"ts": "timestamp"} to map this key to a column named ts.

openXJsonSerDe_convertDotsInJsonKeysToUnderscores :: Lens' OpenXJsonSerDe (Maybe Bool) Source #

When set to true, specifies that the names of the keys include dots and that you want Kinesis Data Firehose to replace them with underscores. This is useful because Apache Hive does not allow dots in column names. For example, if the JSON contains a key whose name is "a.b", you can define the column name to be "a_b" when using this option.

The default is false.

OrcSerDe

data OrcSerDe Source #

A serializer to use for converting data to the ORC format before storing it in Amazon S3. For more information, see Apache ORC.

See: newOrcSerDe smart constructor.

Constructors

OrcSerDe' 

Fields

  • blockSizeBytes :: Maybe Natural

    The Hadoop Distributed File System (HDFS) block size. This is useful if you intend to copy the data from Amazon S3 to HDFS before querying. The default is 256 MiB and the minimum is 64 MiB. Kinesis Data Firehose uses this value for padding calculations.

  • bloomFilterColumns :: Maybe [Text]

    The column names for which you want Kinesis Data Firehose to create bloom filters. The default is null.

  • bloomFilterFalsePositiveProbability :: Maybe Double

    The Bloom filter false positive probability (FPP). The lower the FPP, the bigger the Bloom filter. The default value is 0.05, the minimum is 0, and the maximum is 1.

  • compression :: Maybe OrcCompression

    The compression code to use over data blocks. The default is SNAPPY.

  • dictionaryKeyThreshold :: Maybe Double

    Represents the fraction of the total number of non-null rows. To turn off dictionary encoding, set this fraction to a number that is less than the number of distinct keys in a dictionary. To always use dictionary encoding, set this threshold to 1.

  • enablePadding :: Maybe Bool

    Set this to true to indicate that you want stripes to be padded to the HDFS block boundaries. This is useful if you intend to copy the data from Amazon S3 to HDFS before querying. The default is false.

  • formatVersion :: Maybe OrcFormatVersion

    The version of the file to write. The possible values are V0_11 and V0_12. The default is V0_12.

  • paddingTolerance :: Maybe Double

    A number between 0 and 1 that defines the tolerance for block padding as a decimal fraction of stripe size. The default value is 0.05, which means 5 percent of stripe size.

    For the default values of 64 MiB ORC stripes and 256 MiB HDFS blocks, the default block padding tolerance of 5 percent reserves a maximum of 3.2 MiB for padding within the 256 MiB block. In such a case, if the available size within the block is more than 3.2 MiB, a new, smaller stripe is inserted to fit within that space. This ensures that no stripe crosses block boundaries and causes remote reads within a node-local task.

    Kinesis Data Firehose ignores this parameter when OrcSerDe$EnablePadding is false.

  • rowIndexStride :: Maybe Natural

    The number of rows between index entries. The default is 10,000 and the minimum is 1,000.

  • stripeSizeBytes :: Maybe Natural

    The number of bytes in each stripe. The default is 64 MiB and the minimum is 8 MiB.

Instances

Instances details
FromJSON OrcSerDe Source # 
Instance details

Defined in Amazonka.Firehose.Types.OrcSerDe

ToJSON OrcSerDe Source # 
Instance details

Defined in Amazonka.Firehose.Types.OrcSerDe

Generic OrcSerDe Source # 
Instance details

Defined in Amazonka.Firehose.Types.OrcSerDe

Associated Types

type Rep OrcSerDe :: Type -> Type #

Methods

from :: OrcSerDe -> Rep OrcSerDe x #

to :: Rep OrcSerDe x -> OrcSerDe #

Read OrcSerDe Source # 
Instance details

Defined in Amazonka.Firehose.Types.OrcSerDe

Show OrcSerDe Source # 
Instance details

Defined in Amazonka.Firehose.Types.OrcSerDe

NFData OrcSerDe Source # 
Instance details

Defined in Amazonka.Firehose.Types.OrcSerDe

Methods

rnf :: OrcSerDe -> () #

Eq OrcSerDe Source # 
Instance details

Defined in Amazonka.Firehose.Types.OrcSerDe

Hashable OrcSerDe Source # 
Instance details

Defined in Amazonka.Firehose.Types.OrcSerDe

Methods

hashWithSalt :: Int -> OrcSerDe -> Int #

hash :: OrcSerDe -> Int #

type Rep OrcSerDe Source # 
Instance details

Defined in Amazonka.Firehose.Types.OrcSerDe

type Rep OrcSerDe = D1 ('MetaData "OrcSerDe" "Amazonka.Firehose.Types.OrcSerDe" "amazonka-kinesis-firehose-2.0-6l1hHmh2UnHBvolxuQFkWB" 'False) (C1 ('MetaCons "OrcSerDe'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "blockSizeBytes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "bloomFilterColumns") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))) :*: (S1 ('MetaSel ('Just "bloomFilterFalsePositiveProbability") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Double)) :*: (S1 ('MetaSel ('Just "compression") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe OrcCompression)) :*: S1 ('MetaSel ('Just "dictionaryKeyThreshold") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Double))))) :*: ((S1 ('MetaSel ('Just "enablePadding") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "formatVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe OrcFormatVersion))) :*: (S1 ('MetaSel ('Just "paddingTolerance") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Double)) :*: (S1 ('MetaSel ('Just "rowIndexStride") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "stripeSizeBytes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)))))))

newOrcSerDe :: OrcSerDe Source #

Create a value of OrcSerDe 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:blockSizeBytes:OrcSerDe', orcSerDe_blockSizeBytes - The Hadoop Distributed File System (HDFS) block size. This is useful if you intend to copy the data from Amazon S3 to HDFS before querying. The default is 256 MiB and the minimum is 64 MiB. Kinesis Data Firehose uses this value for padding calculations.

$sel:bloomFilterColumns:OrcSerDe', orcSerDe_bloomFilterColumns - The column names for which you want Kinesis Data Firehose to create bloom filters. The default is null.

$sel:bloomFilterFalsePositiveProbability:OrcSerDe', orcSerDe_bloomFilterFalsePositiveProbability - The Bloom filter false positive probability (FPP). The lower the FPP, the bigger the Bloom filter. The default value is 0.05, the minimum is 0, and the maximum is 1.

$sel:compression:OrcSerDe', orcSerDe_compression - The compression code to use over data blocks. The default is SNAPPY.

$sel:dictionaryKeyThreshold:OrcSerDe', orcSerDe_dictionaryKeyThreshold - Represents the fraction of the total number of non-null rows. To turn off dictionary encoding, set this fraction to a number that is less than the number of distinct keys in a dictionary. To always use dictionary encoding, set this threshold to 1.

$sel:enablePadding:OrcSerDe', orcSerDe_enablePadding - Set this to true to indicate that you want stripes to be padded to the HDFS block boundaries. This is useful if you intend to copy the data from Amazon S3 to HDFS before querying. The default is false.

$sel:formatVersion:OrcSerDe', orcSerDe_formatVersion - The version of the file to write. The possible values are V0_11 and V0_12. The default is V0_12.

$sel:paddingTolerance:OrcSerDe', orcSerDe_paddingTolerance - A number between 0 and 1 that defines the tolerance for block padding as a decimal fraction of stripe size. The default value is 0.05, which means 5 percent of stripe size.

For the default values of 64 MiB ORC stripes and 256 MiB HDFS blocks, the default block padding tolerance of 5 percent reserves a maximum of 3.2 MiB for padding within the 256 MiB block. In such a case, if the available size within the block is more than 3.2 MiB, a new, smaller stripe is inserted to fit within that space. This ensures that no stripe crosses block boundaries and causes remote reads within a node-local task.

Kinesis Data Firehose ignores this parameter when OrcSerDe$EnablePadding is false.

$sel:rowIndexStride:OrcSerDe', orcSerDe_rowIndexStride - The number of rows between index entries. The default is 10,000 and the minimum is 1,000.

$sel:stripeSizeBytes:OrcSerDe', orcSerDe_stripeSizeBytes - The number of bytes in each stripe. The default is 64 MiB and the minimum is 8 MiB.

orcSerDe_blockSizeBytes :: Lens' OrcSerDe (Maybe Natural) Source #

The Hadoop Distributed File System (HDFS) block size. This is useful if you intend to copy the data from Amazon S3 to HDFS before querying. The default is 256 MiB and the minimum is 64 MiB. Kinesis Data Firehose uses this value for padding calculations.

orcSerDe_bloomFilterColumns :: Lens' OrcSerDe (Maybe [Text]) Source #

The column names for which you want Kinesis Data Firehose to create bloom filters. The default is null.

orcSerDe_bloomFilterFalsePositiveProbability :: Lens' OrcSerDe (Maybe Double) Source #

The Bloom filter false positive probability (FPP). The lower the FPP, the bigger the Bloom filter. The default value is 0.05, the minimum is 0, and the maximum is 1.

orcSerDe_compression :: Lens' OrcSerDe (Maybe OrcCompression) Source #

The compression code to use over data blocks. The default is SNAPPY.

orcSerDe_dictionaryKeyThreshold :: Lens' OrcSerDe (Maybe Double) Source #

Represents the fraction of the total number of non-null rows. To turn off dictionary encoding, set this fraction to a number that is less than the number of distinct keys in a dictionary. To always use dictionary encoding, set this threshold to 1.

orcSerDe_enablePadding :: Lens' OrcSerDe (Maybe Bool) Source #

Set this to true to indicate that you want stripes to be padded to the HDFS block boundaries. This is useful if you intend to copy the data from Amazon S3 to HDFS before querying. The default is false.

orcSerDe_formatVersion :: Lens' OrcSerDe (Maybe OrcFormatVersion) Source #

The version of the file to write. The possible values are V0_11 and V0_12. The default is V0_12.

orcSerDe_paddingTolerance :: Lens' OrcSerDe (Maybe Double) Source #

A number between 0 and 1 that defines the tolerance for block padding as a decimal fraction of stripe size. The default value is 0.05, which means 5 percent of stripe size.

For the default values of 64 MiB ORC stripes and 256 MiB HDFS blocks, the default block padding tolerance of 5 percent reserves a maximum of 3.2 MiB for padding within the 256 MiB block. In such a case, if the available size within the block is more than 3.2 MiB, a new, smaller stripe is inserted to fit within that space. This ensures that no stripe crosses block boundaries and causes remote reads within a node-local task.

Kinesis Data Firehose ignores this parameter when OrcSerDe$EnablePadding is false.

orcSerDe_rowIndexStride :: Lens' OrcSerDe (Maybe Natural) Source #

The number of rows between index entries. The default is 10,000 and the minimum is 1,000.

orcSerDe_stripeSizeBytes :: Lens' OrcSerDe (Maybe Natural) Source #

The number of bytes in each stripe. The default is 64 MiB and the minimum is 8 MiB.

OutputFormatConfiguration

data OutputFormatConfiguration Source #

Specifies the serializer that you want Kinesis Data Firehose to use to convert the format of your data before it writes it to Amazon S3. This parameter is required if Enabled is set to true.

See: newOutputFormatConfiguration smart constructor.

Constructors

OutputFormatConfiguration' 

Fields

  • serializer :: Maybe Serializer

    Specifies which serializer to use. You can choose either the ORC SerDe or the Parquet SerDe. If both are non-null, the server rejects the request.

Instances

Instances details
FromJSON OutputFormatConfiguration Source # 
Instance details

Defined in Amazonka.Firehose.Types.OutputFormatConfiguration

ToJSON OutputFormatConfiguration Source # 
Instance details

Defined in Amazonka.Firehose.Types.OutputFormatConfiguration

Generic OutputFormatConfiguration Source # 
Instance details

Defined in Amazonka.Firehose.Types.OutputFormatConfiguration

Associated Types

type Rep OutputFormatConfiguration :: Type -> Type #

Read OutputFormatConfiguration Source # 
Instance details

Defined in Amazonka.Firehose.Types.OutputFormatConfiguration

Show OutputFormatConfiguration Source # 
Instance details

Defined in Amazonka.Firehose.Types.OutputFormatConfiguration

NFData OutputFormatConfiguration Source # 
Instance details

Defined in Amazonka.Firehose.Types.OutputFormatConfiguration

Eq OutputFormatConfiguration Source # 
Instance details

Defined in Amazonka.Firehose.Types.OutputFormatConfiguration

Hashable OutputFormatConfiguration Source # 
Instance details

Defined in Amazonka.Firehose.Types.OutputFormatConfiguration

type Rep OutputFormatConfiguration Source # 
Instance details

Defined in Amazonka.Firehose.Types.OutputFormatConfiguration

type Rep OutputFormatConfiguration = D1 ('MetaData "OutputFormatConfiguration" "Amazonka.Firehose.Types.OutputFormatConfiguration" "amazonka-kinesis-firehose-2.0-6l1hHmh2UnHBvolxuQFkWB" 'False) (C1 ('MetaCons "OutputFormatConfiguration'" 'PrefixI 'True) (S1 ('MetaSel ('Just "serializer") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Serializer))))

newOutputFormatConfiguration :: OutputFormatConfiguration Source #

Create a value of OutputFormatConfiguration 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:serializer:OutputFormatConfiguration', outputFormatConfiguration_serializer - Specifies which serializer to use. You can choose either the ORC SerDe or the Parquet SerDe. If both are non-null, the server rejects the request.

outputFormatConfiguration_serializer :: Lens' OutputFormatConfiguration (Maybe Serializer) Source #

Specifies which serializer to use. You can choose either the ORC SerDe or the Parquet SerDe. If both are non-null, the server rejects the request.

ParquetSerDe

data ParquetSerDe Source #

A serializer to use for converting data to the Parquet format before storing it in Amazon S3. For more information, see Apache Parquet.

See: newParquetSerDe smart constructor.

Constructors

ParquetSerDe' 

Fields

  • blockSizeBytes :: Maybe Natural

    The Hadoop Distributed File System (HDFS) block size. This is useful if you intend to copy the data from Amazon S3 to HDFS before querying. The default is 256 MiB and the minimum is 64 MiB. Kinesis Data Firehose uses this value for padding calculations.

  • compression :: Maybe ParquetCompression

    The compression code to use over data blocks. The possible values are UNCOMPRESSED, SNAPPY, and GZIP, with the default being SNAPPY. Use SNAPPY for higher decompression speed. Use GZIP if the compression ratio is more important than speed.

  • enableDictionaryCompression :: Maybe Bool

    Indicates whether to enable dictionary compression.

  • maxPaddingBytes :: Maybe Natural

    The maximum amount of padding to apply. This is useful if you intend to copy the data from Amazon S3 to HDFS before querying. The default is 0.

  • pageSizeBytes :: Maybe Natural

    The Parquet page size. Column chunks are divided into pages. A page is conceptually an indivisible unit (in terms of compression and encoding). The minimum value is 64 KiB and the default is 1 MiB.

  • writerVersion :: Maybe ParquetWriterVersion

    Indicates the version of row format to output. The possible values are V1 and V2. The default is V1.

Instances

Instances details
FromJSON ParquetSerDe Source # 
Instance details

Defined in Amazonka.Firehose.Types.ParquetSerDe

ToJSON ParquetSerDe Source # 
Instance details

Defined in Amazonka.Firehose.Types.ParquetSerDe

Generic ParquetSerDe Source # 
Instance details

Defined in Amazonka.Firehose.Types.ParquetSerDe

Associated Types

type Rep ParquetSerDe :: Type -> Type #

Read ParquetSerDe Source # 
Instance details

Defined in Amazonka.Firehose.Types.ParquetSerDe

Show ParquetSerDe Source # 
Instance details

Defined in Amazonka.Firehose.Types.ParquetSerDe

NFData ParquetSerDe Source # 
Instance details

Defined in Amazonka.Firehose.Types.ParquetSerDe

Methods

rnf :: ParquetSerDe -> () #

Eq ParquetSerDe Source # 
Instance details

Defined in Amazonka.Firehose.Types.ParquetSerDe

Hashable ParquetSerDe Source # 
Instance details

Defined in Amazonka.Firehose.Types.ParquetSerDe

type Rep ParquetSerDe Source # 
Instance details

Defined in Amazonka.Firehose.Types.ParquetSerDe

type Rep ParquetSerDe = D1 ('MetaData "ParquetSerDe" "Amazonka.Firehose.Types.ParquetSerDe" "amazonka-kinesis-firehose-2.0-6l1hHmh2UnHBvolxuQFkWB" 'False) (C1 ('MetaCons "ParquetSerDe'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "blockSizeBytes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: (S1 ('MetaSel ('Just "compression") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ParquetCompression)) :*: S1 ('MetaSel ('Just "enableDictionaryCompression") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)))) :*: (S1 ('MetaSel ('Just "maxPaddingBytes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: (S1 ('MetaSel ('Just "pageSizeBytes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "writerVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ParquetWriterVersion))))))

newParquetSerDe :: ParquetSerDe Source #

Create a value of ParquetSerDe 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:blockSizeBytes:ParquetSerDe', parquetSerDe_blockSizeBytes - The Hadoop Distributed File System (HDFS) block size. This is useful if you intend to copy the data from Amazon S3 to HDFS before querying. The default is 256 MiB and the minimum is 64 MiB. Kinesis Data Firehose uses this value for padding calculations.

$sel:compression:ParquetSerDe', parquetSerDe_compression - The compression code to use over data blocks. The possible values are UNCOMPRESSED, SNAPPY, and GZIP, with the default being SNAPPY. Use SNAPPY for higher decompression speed. Use GZIP if the compression ratio is more important than speed.

$sel:enableDictionaryCompression:ParquetSerDe', parquetSerDe_enableDictionaryCompression - Indicates whether to enable dictionary compression.

$sel:maxPaddingBytes:ParquetSerDe', parquetSerDe_maxPaddingBytes - The maximum amount of padding to apply. This is useful if you intend to copy the data from Amazon S3 to HDFS before querying. The default is 0.

$sel:pageSizeBytes:ParquetSerDe', parquetSerDe_pageSizeBytes - The Parquet page size. Column chunks are divided into pages. A page is conceptually an indivisible unit (in terms of compression and encoding). The minimum value is 64 KiB and the default is 1 MiB.

$sel:writerVersion:ParquetSerDe', parquetSerDe_writerVersion - Indicates the version of row format to output. The possible values are V1 and V2. The default is V1.

parquetSerDe_blockSizeBytes :: Lens' ParquetSerDe (Maybe Natural) Source #

The Hadoop Distributed File System (HDFS) block size. This is useful if you intend to copy the data from Amazon S3 to HDFS before querying. The default is 256 MiB and the minimum is 64 MiB. Kinesis Data Firehose uses this value for padding calculations.

parquetSerDe_compression :: Lens' ParquetSerDe (Maybe ParquetCompression) Source #

The compression code to use over data blocks. The possible values are UNCOMPRESSED, SNAPPY, and GZIP, with the default being SNAPPY. Use SNAPPY for higher decompression speed. Use GZIP if the compression ratio is more important than speed.

parquetSerDe_enableDictionaryCompression :: Lens' ParquetSerDe (Maybe Bool) Source #

Indicates whether to enable dictionary compression.

parquetSerDe_maxPaddingBytes :: Lens' ParquetSerDe (Maybe Natural) Source #

The maximum amount of padding to apply. This is useful if you intend to copy the data from Amazon S3 to HDFS before querying. The default is 0.

parquetSerDe_pageSizeBytes :: Lens' ParquetSerDe (Maybe Natural) Source #

The Parquet page size. Column chunks are divided into pages. A page is conceptually an indivisible unit (in terms of compression and encoding). The minimum value is 64 KiB and the default is 1 MiB.

parquetSerDe_writerVersion :: Lens' ParquetSerDe (Maybe ParquetWriterVersion) Source #

Indicates the version of row format to output. The possible values are V1 and V2. The default is V1.

ProcessingConfiguration

data ProcessingConfiguration Source #

Describes a data processing configuration.

See: newProcessingConfiguration smart constructor.

Constructors

ProcessingConfiguration' 

Fields

Instances

Instances details
FromJSON ProcessingConfiguration Source # 
Instance details

Defined in Amazonka.Firehose.Types.ProcessingConfiguration

ToJSON ProcessingConfiguration Source # 
Instance details

Defined in Amazonka.Firehose.Types.ProcessingConfiguration

Generic ProcessingConfiguration Source # 
Instance details

Defined in Amazonka.Firehose.Types.ProcessingConfiguration

Associated Types

type Rep ProcessingConfiguration :: Type -> Type #

Read ProcessingConfiguration Source # 
Instance details

Defined in Amazonka.Firehose.Types.ProcessingConfiguration

Show ProcessingConfiguration Source # 
Instance details

Defined in Amazonka.Firehose.Types.ProcessingConfiguration

NFData ProcessingConfiguration Source # 
Instance details

Defined in Amazonka.Firehose.Types.ProcessingConfiguration

Methods

rnf :: ProcessingConfiguration -> () #

Eq ProcessingConfiguration Source # 
Instance details

Defined in Amazonka.Firehose.Types.ProcessingConfiguration

Hashable ProcessingConfiguration Source # 
Instance details

Defined in Amazonka.Firehose.Types.ProcessingConfiguration

type Rep ProcessingConfiguration Source # 
Instance details

Defined in Amazonka.Firehose.Types.ProcessingConfiguration

type Rep ProcessingConfiguration = D1 ('MetaData "ProcessingConfiguration" "Amazonka.Firehose.Types.ProcessingConfiguration" "amazonka-kinesis-firehose-2.0-6l1hHmh2UnHBvolxuQFkWB" 'False) (C1 ('MetaCons "ProcessingConfiguration'" 'PrefixI 'True) (S1 ('MetaSel ('Just "enabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "processors") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Processor]))))

newProcessingConfiguration :: ProcessingConfiguration Source #

Create a value of ProcessingConfiguration 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:enabled:ProcessingConfiguration', processingConfiguration_enabled - Enables or disables data processing.

$sel:processors:ProcessingConfiguration', processingConfiguration_processors - The data processors.

Processor

data Processor Source #

Describes a data processor.

See: newProcessor smart constructor.

Constructors

Processor' 

Fields

Instances

Instances details
FromJSON Processor Source # 
Instance details

Defined in Amazonka.Firehose.Types.Processor

ToJSON Processor Source # 
Instance details

Defined in Amazonka.Firehose.Types.Processor

Generic Processor Source # 
Instance details

Defined in Amazonka.Firehose.Types.Processor

Associated Types

type Rep Processor :: Type -> Type #

Read Processor Source # 
Instance details

Defined in Amazonka.Firehose.Types.Processor

Show Processor Source # 
Instance details

Defined in Amazonka.Firehose.Types.Processor

NFData Processor Source # 
Instance details

Defined in Amazonka.Firehose.Types.Processor

Methods

rnf :: Processor -> () #

Eq Processor Source # 
Instance details

Defined in Amazonka.Firehose.Types.Processor

Hashable Processor Source # 
Instance details

Defined in Amazonka.Firehose.Types.Processor

type Rep Processor Source # 
Instance details

Defined in Amazonka.Firehose.Types.Processor

type Rep Processor = D1 ('MetaData "Processor" "Amazonka.Firehose.Types.Processor" "amazonka-kinesis-firehose-2.0-6l1hHmh2UnHBvolxuQFkWB" 'False) (C1 ('MetaCons "Processor'" 'PrefixI 'True) (S1 ('MetaSel ('Just "parameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ProcessorParameter])) :*: S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ProcessorType)))

newProcessor Source #

Create a value of Processor 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:parameters:Processor', processor_parameters - The processor parameters.

$sel:type':Processor', processor_type - The type of processor.

ProcessorParameter

data ProcessorParameter Source #

Describes the processor parameter.

See: newProcessorParameter smart constructor.

Constructors

ProcessorParameter' 

Fields

  • parameterName :: ProcessorParameterName

    The name of the parameter. Currently the following default values are supported: 3 for NumberOfRetries and 60 for the BufferIntervalInSeconds. The BufferSizeInMBs ranges between 0.2 MB and up to 3MB. The default buffering hint is 1MB for all destinations, except Splunk. For Splunk, the default buffering hint is 256 KB.

  • parameterValue :: Text

    The parameter value.

Instances

Instances details
FromJSON ProcessorParameter Source # 
Instance details

Defined in Amazonka.Firehose.Types.ProcessorParameter

ToJSON ProcessorParameter Source # 
Instance details

Defined in Amazonka.Firehose.Types.ProcessorParameter

Generic ProcessorParameter Source # 
Instance details

Defined in Amazonka.Firehose.Types.ProcessorParameter

Associated Types

type Rep ProcessorParameter :: Type -> Type #

Read ProcessorParameter Source # 
Instance details

Defined in Amazonka.Firehose.Types.ProcessorParameter

Show ProcessorParameter Source # 
Instance details

Defined in Amazonka.Firehose.Types.ProcessorParameter

NFData ProcessorParameter Source # 
Instance details

Defined in Amazonka.Firehose.Types.ProcessorParameter

Methods

rnf :: ProcessorParameter -> () #

Eq ProcessorParameter Source # 
Instance details

Defined in Amazonka.Firehose.Types.ProcessorParameter

Hashable ProcessorParameter Source # 
Instance details

Defined in Amazonka.Firehose.Types.ProcessorParameter

type Rep ProcessorParameter Source # 
Instance details

Defined in Amazonka.Firehose.Types.ProcessorParameter

type Rep ProcessorParameter = D1 ('MetaData "ProcessorParameter" "Amazonka.Firehose.Types.ProcessorParameter" "amazonka-kinesis-firehose-2.0-6l1hHmh2UnHBvolxuQFkWB" 'False) (C1 ('MetaCons "ProcessorParameter'" 'PrefixI 'True) (S1 ('MetaSel ('Just "parameterName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ProcessorParameterName) :*: S1 ('MetaSel ('Just "parameterValue") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newProcessorParameter Source #

Create a value of ProcessorParameter 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:parameterName:ProcessorParameter', processorParameter_parameterName - The name of the parameter. Currently the following default values are supported: 3 for NumberOfRetries and 60 for the BufferIntervalInSeconds. The BufferSizeInMBs ranges between 0.2 MB and up to 3MB. The default buffering hint is 1MB for all destinations, except Splunk. For Splunk, the default buffering hint is 256 KB.

$sel:parameterValue:ProcessorParameter', processorParameter_parameterValue - The parameter value.

processorParameter_parameterName :: Lens' ProcessorParameter ProcessorParameterName Source #

The name of the parameter. Currently the following default values are supported: 3 for NumberOfRetries and 60 for the BufferIntervalInSeconds. The BufferSizeInMBs ranges between 0.2 MB and up to 3MB. The default buffering hint is 1MB for all destinations, except Splunk. For Splunk, the default buffering hint is 256 KB.

PutRecordBatchResponseEntry

data PutRecordBatchResponseEntry Source #

Contains the result for an individual record from a PutRecordBatch request. If the record is successfully added to your delivery stream, it receives a record ID. If the record fails to be added to your delivery stream, the result includes an error code and an error message.

See: newPutRecordBatchResponseEntry smart constructor.

Constructors

PutRecordBatchResponseEntry' 

Fields

Instances

Instances details
FromJSON PutRecordBatchResponseEntry Source # 
Instance details

Defined in Amazonka.Firehose.Types.PutRecordBatchResponseEntry

Generic PutRecordBatchResponseEntry Source # 
Instance details

Defined in Amazonka.Firehose.Types.PutRecordBatchResponseEntry

Associated Types

type Rep PutRecordBatchResponseEntry :: Type -> Type #

Read PutRecordBatchResponseEntry Source # 
Instance details

Defined in Amazonka.Firehose.Types.PutRecordBatchResponseEntry

Show PutRecordBatchResponseEntry Source # 
Instance details

Defined in Amazonka.Firehose.Types.PutRecordBatchResponseEntry

NFData PutRecordBatchResponseEntry Source # 
Instance details

Defined in Amazonka.Firehose.Types.PutRecordBatchResponseEntry

Eq PutRecordBatchResponseEntry Source # 
Instance details

Defined in Amazonka.Firehose.Types.PutRecordBatchResponseEntry

Hashable PutRecordBatchResponseEntry Source # 
Instance details

Defined in Amazonka.Firehose.Types.PutRecordBatchResponseEntry

type Rep PutRecordBatchResponseEntry Source # 
Instance details

Defined in Amazonka.Firehose.Types.PutRecordBatchResponseEntry

type Rep PutRecordBatchResponseEntry = D1 ('MetaData "PutRecordBatchResponseEntry" "Amazonka.Firehose.Types.PutRecordBatchResponseEntry" "amazonka-kinesis-firehose-2.0-6l1hHmh2UnHBvolxuQFkWB" 'False) (C1 ('MetaCons "PutRecordBatchResponseEntry'" 'PrefixI 'True) (S1 ('MetaSel ('Just "errorCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "errorMessage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "recordId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newPutRecordBatchResponseEntry :: PutRecordBatchResponseEntry Source #

Create a value of PutRecordBatchResponseEntry 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:errorCode:PutRecordBatchResponseEntry', putRecordBatchResponseEntry_errorCode - The error code for an individual record result.

$sel:errorMessage:PutRecordBatchResponseEntry', putRecordBatchResponseEntry_errorMessage - The error message for an individual record result.

$sel:recordId:PutRecordBatchResponseEntry', putRecordBatchResponseEntry_recordId - The ID of the record.

putRecordBatchResponseEntry_errorCode :: Lens' PutRecordBatchResponseEntry (Maybe Text) Source #

The error code for an individual record result.

putRecordBatchResponseEntry_errorMessage :: Lens' PutRecordBatchResponseEntry (Maybe Text) Source #

The error message for an individual record result.

Record

data Record Source #

The unit of data in a delivery stream.

See: newRecord smart constructor.

Constructors

Record' 

Fields

  • data' :: Base64

    The data blob, which is base64-encoded when the blob is serialized. The maximum size of the data blob, before base64-encoding, is 1,000 KiB.

Instances

Instances details
ToJSON Record Source # 
Instance details

Defined in Amazonka.Firehose.Types.Record

Generic Record Source # 
Instance details

Defined in Amazonka.Firehose.Types.Record

Associated Types

type Rep Record :: Type -> Type #

Methods

from :: Record -> Rep Record x #

to :: Rep Record x -> Record #

Read Record Source # 
Instance details

Defined in Amazonka.Firehose.Types.Record

Show Record Source # 
Instance details

Defined in Amazonka.Firehose.Types.Record

NFData Record Source # 
Instance details

Defined in Amazonka.Firehose.Types.Record

Methods

rnf :: Record -> () #

Eq Record Source # 
Instance details

Defined in Amazonka.Firehose.Types.Record

Methods

(==) :: Record -> Record -> Bool #

(/=) :: Record -> Record -> Bool #

Hashable Record Source # 
Instance details

Defined in Amazonka.Firehose.Types.Record

Methods

hashWithSalt :: Int -> Record -> Int #

hash :: Record -> Int #

type Rep Record Source # 
Instance details

Defined in Amazonka.Firehose.Types.Record

type Rep Record = D1 ('MetaData "Record" "Amazonka.Firehose.Types.Record" "amazonka-kinesis-firehose-2.0-6l1hHmh2UnHBvolxuQFkWB" 'False) (C1 ('MetaCons "Record'" 'PrefixI 'True) (S1 ('MetaSel ('Just "data'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Base64)))

newRecord Source #

Create a value of Record 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:data':Record', record_data - The data blob, which is base64-encoded when the blob is serialized. The maximum size of the data blob, before base64-encoding, is 1,000 KiB.-- -- Note: This Lens automatically encodes and decodes Base64 data. -- The underlying isomorphism will encode to Base64 representation during -- serialisation, and decode from Base64 representation during deserialisation. -- This Lens accepts and returns only raw unencoded data.

record_data :: Lens' Record ByteString Source #

The data blob, which is base64-encoded when the blob is serialized. The maximum size of the data blob, before base64-encoding, is 1,000 KiB.-- -- Note: This Lens automatically encodes and decodes Base64 data. -- The underlying isomorphism will encode to Base64 representation during -- serialisation, and decode from Base64 representation during deserialisation. -- This Lens accepts and returns only raw unencoded data.

RedshiftDestinationConfiguration

data RedshiftDestinationConfiguration Source #

Describes the configuration of a destination in Amazon Redshift.

See: newRedshiftDestinationConfiguration smart constructor.

Constructors

RedshiftDestinationConfiguration' 

Fields

Instances

Instances details
ToJSON RedshiftDestinationConfiguration Source # 
Instance details

Defined in Amazonka.Firehose.Types.RedshiftDestinationConfiguration

Generic RedshiftDestinationConfiguration Source # 
Instance details

Defined in Amazonka.Firehose.Types.RedshiftDestinationConfiguration

Associated Types

type Rep RedshiftDestinationConfiguration :: Type -> Type #

Show RedshiftDestinationConfiguration Source # 
Instance details

Defined in Amazonka.Firehose.Types.RedshiftDestinationConfiguration

NFData RedshiftDestinationConfiguration Source # 
Instance details

Defined in Amazonka.Firehose.Types.RedshiftDestinationConfiguration

Eq RedshiftDestinationConfiguration Source # 
Instance details

Defined in Amazonka.Firehose.Types.RedshiftDestinationConfiguration

Hashable RedshiftDestinationConfiguration Source # 
Instance details

Defined in Amazonka.Firehose.Types.RedshiftDestinationConfiguration

type Rep RedshiftDestinationConfiguration Source # 
Instance details

Defined in Amazonka.Firehose.Types.RedshiftDestinationConfiguration

type Rep RedshiftDestinationConfiguration = D1 ('MetaData "RedshiftDestinationConfiguration" "Amazonka.Firehose.Types.RedshiftDestinationConfiguration" "amazonka-kinesis-firehose-2.0-6l1hHmh2UnHBvolxuQFkWB" 'False) (C1 ('MetaCons "RedshiftDestinationConfiguration'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "cloudWatchLoggingOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CloudWatchLoggingOptions)) :*: S1 ('MetaSel ('Just "processingConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ProcessingConfiguration))) :*: (S1 ('MetaSel ('Just "retryOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RedshiftRetryOptions)) :*: (S1 ('MetaSel ('Just "s3BackupConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe S3DestinationConfiguration)) :*: S1 ('MetaSel ('Just "s3BackupMode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RedshiftS3BackupMode))))) :*: ((S1 ('MetaSel ('Just "roleARN") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "clusterJDBCURL") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "copyCommand") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 CopyCommand))) :*: (S1 ('MetaSel ('Just "username") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Sensitive Text)) :*: (S1 ('MetaSel ('Just "password") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Sensitive Text)) :*: S1 ('MetaSel ('Just "s3Configuration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 S3DestinationConfiguration))))))

newRedshiftDestinationConfiguration Source #

Create a value of RedshiftDestinationConfiguration 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:

RedshiftDestinationConfiguration, redshiftDestinationConfiguration_cloudWatchLoggingOptions - The CloudWatch logging options for your delivery stream.

$sel:processingConfiguration:RedshiftDestinationConfiguration', redshiftDestinationConfiguration_processingConfiguration - The data processing configuration.

$sel:retryOptions:RedshiftDestinationConfiguration', redshiftDestinationConfiguration_retryOptions - The retry behavior in case Kinesis Data Firehose is unable to deliver documents to Amazon Redshift. Default value is 3600 (60 minutes).

$sel:s3BackupConfiguration:RedshiftDestinationConfiguration', redshiftDestinationConfiguration_s3BackupConfiguration - The configuration for backup in Amazon S3.

$sel:s3BackupMode:RedshiftDestinationConfiguration', redshiftDestinationConfiguration_s3BackupMode - The Amazon S3 backup mode. After you create a delivery stream, you can update it to enable Amazon S3 backup if it is disabled. If backup is enabled, you can't update the delivery stream to disable it.

RedshiftDestinationConfiguration, redshiftDestinationConfiguration_roleARN - The Amazon Resource Name (ARN) of the Amazon Web Services credentials. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.

$sel:clusterJDBCURL:RedshiftDestinationConfiguration', redshiftDestinationConfiguration_clusterJDBCURL - The database connection string.

$sel:copyCommand:RedshiftDestinationConfiguration', redshiftDestinationConfiguration_copyCommand - The COPY command.

$sel:username:RedshiftDestinationConfiguration', redshiftDestinationConfiguration_username - The name of the user.

$sel:password:RedshiftDestinationConfiguration', redshiftDestinationConfiguration_password - The user password.

$sel:s3Configuration:RedshiftDestinationConfiguration', redshiftDestinationConfiguration_s3Configuration - The configuration for the intermediate Amazon S3 location from which Amazon Redshift obtains data. Restrictions are described in the topic for CreateDeliveryStream.

The compression formats SNAPPY or ZIP cannot be specified in RedshiftDestinationConfiguration.S3Configuration because the Amazon Redshift COPY operation that reads from the S3 bucket doesn't support these compression formats.

redshiftDestinationConfiguration_retryOptions :: Lens' RedshiftDestinationConfiguration (Maybe RedshiftRetryOptions) Source #

The retry behavior in case Kinesis Data Firehose is unable to deliver documents to Amazon Redshift. Default value is 3600 (60 minutes).

redshiftDestinationConfiguration_s3BackupMode :: Lens' RedshiftDestinationConfiguration (Maybe RedshiftS3BackupMode) Source #

The Amazon S3 backup mode. After you create a delivery stream, you can update it to enable Amazon S3 backup if it is disabled. If backup is enabled, you can't update the delivery stream to disable it.

redshiftDestinationConfiguration_roleARN :: Lens' RedshiftDestinationConfiguration Text Source #

The Amazon Resource Name (ARN) of the Amazon Web Services credentials. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.

redshiftDestinationConfiguration_s3Configuration :: Lens' RedshiftDestinationConfiguration S3DestinationConfiguration Source #

The configuration for the intermediate Amazon S3 location from which Amazon Redshift obtains data. Restrictions are described in the topic for CreateDeliveryStream.

The compression formats SNAPPY or ZIP cannot be specified in RedshiftDestinationConfiguration.S3Configuration because the Amazon Redshift COPY operation that reads from the S3 bucket doesn't support these compression formats.

RedshiftDestinationDescription

data RedshiftDestinationDescription Source #

Describes a destination in Amazon Redshift.

See: newRedshiftDestinationDescription smart constructor.

Constructors

RedshiftDestinationDescription' 

Fields

Instances

Instances details
FromJSON RedshiftDestinationDescription Source # 
Instance details

Defined in Amazonka.Firehose.Types.RedshiftDestinationDescription

Generic RedshiftDestinationDescription Source # 
Instance details

Defined in Amazonka.Firehose.Types.RedshiftDestinationDescription

Associated Types

type Rep RedshiftDestinationDescription :: Type -> Type #

Show RedshiftDestinationDescription Source # 
Instance details

Defined in Amazonka.Firehose.Types.RedshiftDestinationDescription

NFData RedshiftDestinationDescription Source # 
Instance details

Defined in Amazonka.Firehose.Types.RedshiftDestinationDescription

Eq RedshiftDestinationDescription Source # 
Instance details

Defined in Amazonka.Firehose.Types.RedshiftDestinationDescription

Hashable RedshiftDestinationDescription Source # 
Instance details

Defined in Amazonka.Firehose.Types.RedshiftDestinationDescription

type Rep RedshiftDestinationDescription Source # 
Instance details

Defined in Amazonka.Firehose.Types.RedshiftDestinationDescription

type Rep RedshiftDestinationDescription = D1 ('MetaData "RedshiftDestinationDescription" "Amazonka.Firehose.Types.RedshiftDestinationDescription" "amazonka-kinesis-firehose-2.0-6l1hHmh2UnHBvolxuQFkWB" 'False) (C1 ('MetaCons "RedshiftDestinationDescription'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "cloudWatchLoggingOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CloudWatchLoggingOptions)) :*: S1 ('MetaSel ('Just "processingConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ProcessingConfiguration))) :*: (S1 ('MetaSel ('Just "retryOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RedshiftRetryOptions)) :*: (S1 ('MetaSel ('Just "s3BackupDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe S3DestinationDescription)) :*: S1 ('MetaSel ('Just "s3BackupMode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RedshiftS3BackupMode))))) :*: ((S1 ('MetaSel ('Just "roleARN") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "clusterJDBCURL") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :*: (S1 ('MetaSel ('Just "copyCommand") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 CopyCommand) :*: (S1 ('MetaSel ('Just "username") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Sensitive Text)) :*: S1 ('MetaSel ('Just "s3DestinationDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 S3DestinationDescription))))))

newRedshiftDestinationDescription Source #

Create a value of RedshiftDestinationDescription 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:

RedshiftDestinationDescription, redshiftDestinationDescription_cloudWatchLoggingOptions - The Amazon CloudWatch logging options for your delivery stream.

$sel:processingConfiguration:RedshiftDestinationDescription', redshiftDestinationDescription_processingConfiguration - The data processing configuration.

$sel:retryOptions:RedshiftDestinationDescription', redshiftDestinationDescription_retryOptions - The retry behavior in case Kinesis Data Firehose is unable to deliver documents to Amazon Redshift. Default value is 3600 (60 minutes).

$sel:s3BackupDescription:RedshiftDestinationDescription', redshiftDestinationDescription_s3BackupDescription - The configuration for backup in Amazon S3.

$sel:s3BackupMode:RedshiftDestinationDescription', redshiftDestinationDescription_s3BackupMode - The Amazon S3 backup mode.

RedshiftDestinationDescription, redshiftDestinationDescription_roleARN - The Amazon Resource Name (ARN) of the Amazon Web Services credentials. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.

$sel:clusterJDBCURL:RedshiftDestinationDescription', redshiftDestinationDescription_clusterJDBCURL - The database connection string.

$sel:copyCommand:RedshiftDestinationDescription', redshiftDestinationDescription_copyCommand - The COPY command.

$sel:username:RedshiftDestinationDescription', redshiftDestinationDescription_username - The name of the user.

$sel:s3DestinationDescription:RedshiftDestinationDescription', redshiftDestinationDescription_s3DestinationDescription - The Amazon S3 destination.

redshiftDestinationDescription_retryOptions :: Lens' RedshiftDestinationDescription (Maybe RedshiftRetryOptions) Source #

The retry behavior in case Kinesis Data Firehose is unable to deliver documents to Amazon Redshift. Default value is 3600 (60 minutes).

redshiftDestinationDescription_roleARN :: Lens' RedshiftDestinationDescription Text Source #

The Amazon Resource Name (ARN) of the Amazon Web Services credentials. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.

RedshiftDestinationUpdate

data RedshiftDestinationUpdate Source #

Describes an update for a destination in Amazon Redshift.

See: newRedshiftDestinationUpdate smart constructor.

Constructors

RedshiftDestinationUpdate' 

Fields

Instances

Instances details
ToJSON RedshiftDestinationUpdate Source # 
Instance details

Defined in Amazonka.Firehose.Types.RedshiftDestinationUpdate

Generic RedshiftDestinationUpdate Source # 
Instance details

Defined in Amazonka.Firehose.Types.RedshiftDestinationUpdate

Associated Types

type Rep RedshiftDestinationUpdate :: Type -> Type #

Show RedshiftDestinationUpdate Source # 
Instance details

Defined in Amazonka.Firehose.Types.RedshiftDestinationUpdate

NFData RedshiftDestinationUpdate Source # 
Instance details

Defined in Amazonka.Firehose.Types.RedshiftDestinationUpdate

Eq RedshiftDestinationUpdate Source # 
Instance details

Defined in Amazonka.Firehose.Types.RedshiftDestinationUpdate

Hashable RedshiftDestinationUpdate Source # 
Instance details

Defined in Amazonka.Firehose.Types.RedshiftDestinationUpdate

type Rep RedshiftDestinationUpdate Source # 
Instance details

Defined in Amazonka.Firehose.Types.RedshiftDestinationUpdate

type Rep RedshiftDestinationUpdate = D1 ('MetaData "RedshiftDestinationUpdate" "Amazonka.Firehose.Types.RedshiftDestinationUpdate" "amazonka-kinesis-firehose-2.0-6l1hHmh2UnHBvolxuQFkWB" 'False) (C1 ('MetaCons "RedshiftDestinationUpdate'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "cloudWatchLoggingOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CloudWatchLoggingOptions)) :*: S1 ('MetaSel ('Just "clusterJDBCURL") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "copyCommand") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CopyCommand)) :*: (S1 ('MetaSel ('Just "password") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))) :*: S1 ('MetaSel ('Just "processingConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ProcessingConfiguration))))) :*: ((S1 ('MetaSel ('Just "retryOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RedshiftRetryOptions)) :*: (S1 ('MetaSel ('Just "roleARN") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "s3BackupMode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RedshiftS3BackupMode)))) :*: (S1 ('MetaSel ('Just "s3BackupUpdate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe S3DestinationUpdate)) :*: (S1 ('MetaSel ('Just "s3Update") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe S3DestinationUpdate)) :*: S1 ('MetaSel ('Just "username") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))))))))

newRedshiftDestinationUpdate :: RedshiftDestinationUpdate Source #

Create a value of RedshiftDestinationUpdate 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:

RedshiftDestinationUpdate, redshiftDestinationUpdate_cloudWatchLoggingOptions - The Amazon CloudWatch logging options for your delivery stream.

$sel:clusterJDBCURL:RedshiftDestinationUpdate', redshiftDestinationUpdate_clusterJDBCURL - The database connection string.

$sel:copyCommand:RedshiftDestinationUpdate', redshiftDestinationUpdate_copyCommand - The COPY command.

$sel:password:RedshiftDestinationUpdate', redshiftDestinationUpdate_password - The user password.

$sel:processingConfiguration:RedshiftDestinationUpdate', redshiftDestinationUpdate_processingConfiguration - The data processing configuration.

$sel:retryOptions:RedshiftDestinationUpdate', redshiftDestinationUpdate_retryOptions - The retry behavior in case Kinesis Data Firehose is unable to deliver documents to Amazon Redshift. Default value is 3600 (60 minutes).

RedshiftDestinationUpdate, redshiftDestinationUpdate_roleARN - The Amazon Resource Name (ARN) of the Amazon Web Services credentials. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.

$sel:s3BackupMode:RedshiftDestinationUpdate', redshiftDestinationUpdate_s3BackupMode - You can update a delivery stream to enable Amazon S3 backup if it is disabled. If backup is enabled, you can't update the delivery stream to disable it.

$sel:s3BackupUpdate:RedshiftDestinationUpdate', redshiftDestinationUpdate_s3BackupUpdate - The Amazon S3 destination for backup.

$sel:s3Update:RedshiftDestinationUpdate', redshiftDestinationUpdate_s3Update - The Amazon S3 destination.

The compression formats SNAPPY or ZIP cannot be specified in RedshiftDestinationUpdate.S3Update because the Amazon Redshift COPY operation that reads from the S3 bucket doesn't support these compression formats.

$sel:username:RedshiftDestinationUpdate', redshiftDestinationUpdate_username - The name of the user.

redshiftDestinationUpdate_retryOptions :: Lens' RedshiftDestinationUpdate (Maybe RedshiftRetryOptions) Source #

The retry behavior in case Kinesis Data Firehose is unable to deliver documents to Amazon Redshift. Default value is 3600 (60 minutes).

redshiftDestinationUpdate_roleARN :: Lens' RedshiftDestinationUpdate (Maybe Text) Source #

The Amazon Resource Name (ARN) of the Amazon Web Services credentials. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.

redshiftDestinationUpdate_s3BackupMode :: Lens' RedshiftDestinationUpdate (Maybe RedshiftS3BackupMode) Source #

You can update a delivery stream to enable Amazon S3 backup if it is disabled. If backup is enabled, you can't update the delivery stream to disable it.

redshiftDestinationUpdate_s3Update :: Lens' RedshiftDestinationUpdate (Maybe S3DestinationUpdate) Source #

The Amazon S3 destination.

The compression formats SNAPPY or ZIP cannot be specified in RedshiftDestinationUpdate.S3Update because the Amazon Redshift COPY operation that reads from the S3 bucket doesn't support these compression formats.

RedshiftRetryOptions

data RedshiftRetryOptions Source #

Configures retry behavior in case Kinesis Data Firehose is unable to deliver documents to Amazon Redshift.

See: newRedshiftRetryOptions smart constructor.

Constructors

RedshiftRetryOptions' 

Fields

  • durationInSeconds :: Maybe Natural

    The length of time during which Kinesis Data Firehose retries delivery after a failure, starting from the initial request and including the first attempt. The default value is 3600 seconds (60 minutes). Kinesis Data Firehose does not retry if the value of DurationInSeconds is 0 (zero) or if the first delivery attempt takes longer than the current value.

Instances

Instances details
FromJSON RedshiftRetryOptions Source # 
Instance details

Defined in Amazonka.Firehose.Types.RedshiftRetryOptions

ToJSON RedshiftRetryOptions Source # 
Instance details

Defined in Amazonka.Firehose.Types.RedshiftRetryOptions

Generic RedshiftRetryOptions Source # 
Instance details

Defined in Amazonka.Firehose.Types.RedshiftRetryOptions

Associated Types

type Rep RedshiftRetryOptions :: Type -> Type #

Read RedshiftRetryOptions Source # 
Instance details

Defined in Amazonka.Firehose.Types.RedshiftRetryOptions

Show RedshiftRetryOptions Source # 
Instance details

Defined in Amazonka.Firehose.Types.RedshiftRetryOptions

NFData RedshiftRetryOptions Source # 
Instance details

Defined in Amazonka.Firehose.Types.RedshiftRetryOptions

Methods

rnf :: RedshiftRetryOptions -> () #

Eq RedshiftRetryOptions Source # 
Instance details

Defined in Amazonka.Firehose.Types.RedshiftRetryOptions

Hashable RedshiftRetryOptions Source # 
Instance details

Defined in Amazonka.Firehose.Types.RedshiftRetryOptions

type Rep RedshiftRetryOptions Source # 
Instance details

Defined in Amazonka.Firehose.Types.RedshiftRetryOptions

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

newRedshiftRetryOptions :: RedshiftRetryOptions Source #

Create a value of RedshiftRetryOptions 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:durationInSeconds:RedshiftRetryOptions', redshiftRetryOptions_durationInSeconds - The length of time during which Kinesis Data Firehose retries delivery after a failure, starting from the initial request and including the first attempt. The default value is 3600 seconds (60 minutes). Kinesis Data Firehose does not retry if the value of DurationInSeconds is 0 (zero) or if the first delivery attempt takes longer than the current value.

redshiftRetryOptions_durationInSeconds :: Lens' RedshiftRetryOptions (Maybe Natural) Source #

The length of time during which Kinesis Data Firehose retries delivery after a failure, starting from the initial request and including the first attempt. The default value is 3600 seconds (60 minutes). Kinesis Data Firehose does not retry if the value of DurationInSeconds is 0 (zero) or if the first delivery attempt takes longer than the current value.

RetryOptions

data RetryOptions Source #

The retry behavior in case Kinesis Data Firehose is unable to deliver data to an Amazon S3 prefix.

See: newRetryOptions smart constructor.

Constructors

RetryOptions' 

Fields

  • durationInSeconds :: Maybe Natural

    The period of time during which Kinesis Data Firehose retries to deliver data to the specified Amazon S3 prefix.

Instances

Instances details
FromJSON RetryOptions Source # 
Instance details

Defined in Amazonka.Firehose.Types.RetryOptions

ToJSON RetryOptions Source # 
Instance details

Defined in Amazonka.Firehose.Types.RetryOptions

Generic RetryOptions Source # 
Instance details

Defined in Amazonka.Firehose.Types.RetryOptions

Associated Types

type Rep RetryOptions :: Type -> Type #

Read RetryOptions Source # 
Instance details

Defined in Amazonka.Firehose.Types.RetryOptions

Show RetryOptions Source # 
Instance details

Defined in Amazonka.Firehose.Types.RetryOptions

NFData RetryOptions Source # 
Instance details

Defined in Amazonka.Firehose.Types.RetryOptions

Methods

rnf :: RetryOptions -> () #

Eq RetryOptions Source # 
Instance details

Defined in Amazonka.Firehose.Types.RetryOptions

Hashable RetryOptions Source # 
Instance details

Defined in Amazonka.Firehose.Types.RetryOptions

type Rep RetryOptions Source # 
Instance details

Defined in Amazonka.Firehose.Types.RetryOptions

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

newRetryOptions :: RetryOptions Source #

Create a value of RetryOptions 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:durationInSeconds:RetryOptions', retryOptions_durationInSeconds - The period of time during which Kinesis Data Firehose retries to deliver data to the specified Amazon S3 prefix.

retryOptions_durationInSeconds :: Lens' RetryOptions (Maybe Natural) Source #

The period of time during which Kinesis Data Firehose retries to deliver data to the specified Amazon S3 prefix.

S3DestinationConfiguration

data S3DestinationConfiguration Source #

Describes the configuration of a destination in Amazon S3.

See: newS3DestinationConfiguration smart constructor.

Constructors

S3DestinationConfiguration' 

Fields

Instances

Instances details
ToJSON S3DestinationConfiguration Source # 
Instance details

Defined in Amazonka.Firehose.Types.S3DestinationConfiguration

Generic S3DestinationConfiguration Source # 
Instance details

Defined in Amazonka.Firehose.Types.S3DestinationConfiguration

Associated Types

type Rep S3DestinationConfiguration :: Type -> Type #

Read S3DestinationConfiguration Source # 
Instance details

Defined in Amazonka.Firehose.Types.S3DestinationConfiguration

Show S3DestinationConfiguration Source # 
Instance details

Defined in Amazonka.Firehose.Types.S3DestinationConfiguration

NFData S3DestinationConfiguration Source # 
Instance details

Defined in Amazonka.Firehose.Types.S3DestinationConfiguration

Eq S3DestinationConfiguration Source # 
Instance details

Defined in Amazonka.Firehose.Types.S3DestinationConfiguration

Hashable S3DestinationConfiguration Source # 
Instance details

Defined in Amazonka.Firehose.Types.S3DestinationConfiguration

type Rep S3DestinationConfiguration Source # 
Instance details

Defined in Amazonka.Firehose.Types.S3DestinationConfiguration

type Rep S3DestinationConfiguration = D1 ('MetaData "S3DestinationConfiguration" "Amazonka.Firehose.Types.S3DestinationConfiguration" "amazonka-kinesis-firehose-2.0-6l1hHmh2UnHBvolxuQFkWB" 'False) (C1 ('MetaCons "S3DestinationConfiguration'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "bufferingHints") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe BufferingHints)) :*: S1 ('MetaSel ('Just "cloudWatchLoggingOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CloudWatchLoggingOptions))) :*: (S1 ('MetaSel ('Just "compressionFormat") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CompressionFormat)) :*: S1 ('MetaSel ('Just "encryptionConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EncryptionConfiguration)))) :*: ((S1 ('MetaSel ('Just "errorOutputPrefix") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "prefix") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "roleARN") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "bucketARN") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newS3DestinationConfiguration Source #

Create a value of S3DestinationConfiguration 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:bufferingHints:S3DestinationConfiguration', s3DestinationConfiguration_bufferingHints - The buffering option. If no value is specified, BufferingHints object default values are used.

$sel:cloudWatchLoggingOptions:S3DestinationConfiguration', s3DestinationConfiguration_cloudWatchLoggingOptions - The CloudWatch logging options for your delivery stream.

$sel:compressionFormat:S3DestinationConfiguration', s3DestinationConfiguration_compressionFormat - The compression format. If no value is specified, the default is UNCOMPRESSED.

The compression formats SNAPPY or ZIP cannot be specified for Amazon Redshift destinations because they are not supported by the Amazon Redshift COPY operation that reads from the S3 bucket.

$sel:encryptionConfiguration:S3DestinationConfiguration', s3DestinationConfiguration_encryptionConfiguration - The encryption configuration. If no value is specified, the default is no encryption.

$sel:errorOutputPrefix:S3DestinationConfiguration', s3DestinationConfiguration_errorOutputPrefix - A prefix that Kinesis Data Firehose evaluates and adds to failed records before writing them to S3. This prefix appears immediately following the bucket name. For information about how to specify this prefix, see Custom Prefixes for Amazon S3 Objects.

$sel:prefix:S3DestinationConfiguration', s3DestinationConfiguration_prefix - The "YYYY/MM/DD/HH" time format prefix is automatically used for delivered Amazon S3 files. You can also specify a custom prefix, as described in Custom Prefixes for Amazon S3 Objects.

$sel:roleARN:S3DestinationConfiguration', s3DestinationConfiguration_roleARN - The Amazon Resource Name (ARN) of the Amazon Web Services credentials. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.

$sel:bucketARN:S3DestinationConfiguration', s3DestinationConfiguration_bucketARN - The ARN of the S3 bucket. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.

s3DestinationConfiguration_bufferingHints :: Lens' S3DestinationConfiguration (Maybe BufferingHints) Source #

The buffering option. If no value is specified, BufferingHints object default values are used.

s3DestinationConfiguration_compressionFormat :: Lens' S3DestinationConfiguration (Maybe CompressionFormat) Source #

The compression format. If no value is specified, the default is UNCOMPRESSED.

The compression formats SNAPPY or ZIP cannot be specified for Amazon Redshift destinations because they are not supported by the Amazon Redshift COPY operation that reads from the S3 bucket.

s3DestinationConfiguration_encryptionConfiguration :: Lens' S3DestinationConfiguration (Maybe EncryptionConfiguration) Source #

The encryption configuration. If no value is specified, the default is no encryption.

s3DestinationConfiguration_errorOutputPrefix :: Lens' S3DestinationConfiguration (Maybe Text) Source #

A prefix that Kinesis Data Firehose evaluates and adds to failed records before writing them to S3. This prefix appears immediately following the bucket name. For information about how to specify this prefix, see Custom Prefixes for Amazon S3 Objects.

s3DestinationConfiguration_prefix :: Lens' S3DestinationConfiguration (Maybe Text) Source #

The "YYYY/MM/DD/HH" time format prefix is automatically used for delivered Amazon S3 files. You can also specify a custom prefix, as described in Custom Prefixes for Amazon S3 Objects.

s3DestinationConfiguration_roleARN :: Lens' S3DestinationConfiguration Text Source #

The Amazon Resource Name (ARN) of the Amazon Web Services credentials. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.

S3DestinationDescription

data S3DestinationDescription Source #

Describes a destination in Amazon S3.

See: newS3DestinationDescription smart constructor.

Constructors

S3DestinationDescription' 

Fields

Instances

Instances details
FromJSON S3DestinationDescription Source # 
Instance details

Defined in Amazonka.Firehose.Types.S3DestinationDescription

Generic S3DestinationDescription Source # 
Instance details

Defined in Amazonka.Firehose.Types.S3DestinationDescription

Associated Types

type Rep S3DestinationDescription :: Type -> Type #

Read S3DestinationDescription Source # 
Instance details

Defined in Amazonka.Firehose.Types.S3DestinationDescription

Show S3DestinationDescription Source # 
Instance details

Defined in Amazonka.Firehose.Types.S3DestinationDescription

NFData S3DestinationDescription Source # 
Instance details

Defined in Amazonka.Firehose.Types.S3DestinationDescription

Eq S3DestinationDescription Source # 
Instance details

Defined in Amazonka.Firehose.Types.S3DestinationDescription

Hashable S3DestinationDescription Source # 
Instance details

Defined in Amazonka.Firehose.Types.S3DestinationDescription

type Rep S3DestinationDescription Source # 
Instance details

Defined in Amazonka.Firehose.Types.S3DestinationDescription

type Rep S3DestinationDescription = D1 ('MetaData "S3DestinationDescription" "Amazonka.Firehose.Types.S3DestinationDescription" "amazonka-kinesis-firehose-2.0-6l1hHmh2UnHBvolxuQFkWB" 'False) (C1 ('MetaCons "S3DestinationDescription'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "cloudWatchLoggingOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CloudWatchLoggingOptions)) :*: S1 ('MetaSel ('Just "errorOutputPrefix") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "prefix") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "roleARN") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) :*: ((S1 ('MetaSel ('Just "bucketARN") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "bufferingHints") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 BufferingHints)) :*: (S1 ('MetaSel ('Just "compressionFormat") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 CompressionFormat) :*: S1 ('MetaSel ('Just "encryptionConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 EncryptionConfiguration)))))

newS3DestinationDescription Source #

Create a value of S3DestinationDescription 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:cloudWatchLoggingOptions:S3DestinationDescription', s3DestinationDescription_cloudWatchLoggingOptions - The Amazon CloudWatch logging options for your delivery stream.

$sel:errorOutputPrefix:S3DestinationDescription', s3DestinationDescription_errorOutputPrefix - A prefix that Kinesis Data Firehose evaluates and adds to failed records before writing them to S3. This prefix appears immediately following the bucket name. For information about how to specify this prefix, see Custom Prefixes for Amazon S3 Objects.

$sel:prefix:S3DestinationDescription', s3DestinationDescription_prefix - The "YYYY/MM/DD/HH" time format prefix is automatically used for delivered Amazon S3 files. You can also specify a custom prefix, as described in Custom Prefixes for Amazon S3 Objects.

$sel:roleARN:S3DestinationDescription', s3DestinationDescription_roleARN - The Amazon Resource Name (ARN) of the Amazon Web Services credentials. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.

$sel:bucketARN:S3DestinationDescription', s3DestinationDescription_bucketARN - The ARN of the S3 bucket. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.

$sel:bufferingHints:S3DestinationDescription', s3DestinationDescription_bufferingHints - The buffering option. If no value is specified, BufferingHints object default values are used.

$sel:compressionFormat:S3DestinationDescription', s3DestinationDescription_compressionFormat - The compression format. If no value is specified, the default is UNCOMPRESSED.

$sel:encryptionConfiguration:S3DestinationDescription', s3DestinationDescription_encryptionConfiguration - The encryption configuration. If no value is specified, the default is no encryption.

s3DestinationDescription_errorOutputPrefix :: Lens' S3DestinationDescription (Maybe Text) Source #

A prefix that Kinesis Data Firehose evaluates and adds to failed records before writing them to S3. This prefix appears immediately following the bucket name. For information about how to specify this prefix, see Custom Prefixes for Amazon S3 Objects.

s3DestinationDescription_prefix :: Lens' S3DestinationDescription (Maybe Text) Source #

The "YYYY/MM/DD/HH" time format prefix is automatically used for delivered Amazon S3 files. You can also specify a custom prefix, as described in Custom Prefixes for Amazon S3 Objects.

s3DestinationDescription_roleARN :: Lens' S3DestinationDescription Text Source #

The Amazon Resource Name (ARN) of the Amazon Web Services credentials. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.

s3DestinationDescription_bufferingHints :: Lens' S3DestinationDescription BufferingHints Source #

The buffering option. If no value is specified, BufferingHints object default values are used.

s3DestinationDescription_compressionFormat :: Lens' S3DestinationDescription CompressionFormat Source #

The compression format. If no value is specified, the default is UNCOMPRESSED.

s3DestinationDescription_encryptionConfiguration :: Lens' S3DestinationDescription EncryptionConfiguration Source #

The encryption configuration. If no value is specified, the default is no encryption.

S3DestinationUpdate

data S3DestinationUpdate Source #

Describes an update for a destination in Amazon S3.

See: newS3DestinationUpdate smart constructor.

Constructors

S3DestinationUpdate' 

Fields

Instances

Instances details
ToJSON S3DestinationUpdate Source # 
Instance details

Defined in Amazonka.Firehose.Types.S3DestinationUpdate

Generic S3DestinationUpdate Source # 
Instance details

Defined in Amazonka.Firehose.Types.S3DestinationUpdate

Associated Types

type Rep S3DestinationUpdate :: Type -> Type #

Read S3DestinationUpdate Source # 
Instance details

Defined in Amazonka.Firehose.Types.S3DestinationUpdate

Show S3DestinationUpdate Source # 
Instance details

Defined in Amazonka.Firehose.Types.S3DestinationUpdate

NFData S3DestinationUpdate Source # 
Instance details

Defined in Amazonka.Firehose.Types.S3DestinationUpdate

Methods

rnf :: S3DestinationUpdate -> () #

Eq S3DestinationUpdate Source # 
Instance details

Defined in Amazonka.Firehose.Types.S3DestinationUpdate

Hashable S3DestinationUpdate Source # 
Instance details

Defined in Amazonka.Firehose.Types.S3DestinationUpdate

type Rep S3DestinationUpdate Source # 
Instance details

Defined in Amazonka.Firehose.Types.S3DestinationUpdate

type Rep S3DestinationUpdate = D1 ('MetaData "S3DestinationUpdate" "Amazonka.Firehose.Types.S3DestinationUpdate" "amazonka-kinesis-firehose-2.0-6l1hHmh2UnHBvolxuQFkWB" 'False) (C1 ('MetaCons "S3DestinationUpdate'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "bucketARN") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "bufferingHints") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe BufferingHints))) :*: (S1 ('MetaSel ('Just "cloudWatchLoggingOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CloudWatchLoggingOptions)) :*: S1 ('MetaSel ('Just "compressionFormat") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CompressionFormat)))) :*: ((S1 ('MetaSel ('Just "encryptionConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EncryptionConfiguration)) :*: S1 ('MetaSel ('Just "errorOutputPrefix") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "prefix") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "roleARN") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))

newS3DestinationUpdate :: S3DestinationUpdate Source #

Create a value of S3DestinationUpdate 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:bucketARN:S3DestinationUpdate', s3DestinationUpdate_bucketARN - The ARN of the S3 bucket. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.

$sel:bufferingHints:S3DestinationUpdate', s3DestinationUpdate_bufferingHints - The buffering option. If no value is specified, BufferingHints object default values are used.

$sel:cloudWatchLoggingOptions:S3DestinationUpdate', s3DestinationUpdate_cloudWatchLoggingOptions - The CloudWatch logging options for your delivery stream.

$sel:compressionFormat:S3DestinationUpdate', s3DestinationUpdate_compressionFormat - The compression format. If no value is specified, the default is UNCOMPRESSED.

The compression formats SNAPPY or ZIP cannot be specified for Amazon Redshift destinations because they are not supported by the Amazon Redshift COPY operation that reads from the S3 bucket.

$sel:encryptionConfiguration:S3DestinationUpdate', s3DestinationUpdate_encryptionConfiguration - The encryption configuration. If no value is specified, the default is no encryption.

$sel:errorOutputPrefix:S3DestinationUpdate', s3DestinationUpdate_errorOutputPrefix - A prefix that Kinesis Data Firehose evaluates and adds to failed records before writing them to S3. This prefix appears immediately following the bucket name. For information about how to specify this prefix, see Custom Prefixes for Amazon S3 Objects.

$sel:prefix:S3DestinationUpdate', s3DestinationUpdate_prefix - The "YYYY/MM/DD/HH" time format prefix is automatically used for delivered Amazon S3 files. You can also specify a custom prefix, as described in Custom Prefixes for Amazon S3 Objects.

$sel:roleARN:S3DestinationUpdate', s3DestinationUpdate_roleARN - The Amazon Resource Name (ARN) of the Amazon Web Services credentials. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.

s3DestinationUpdate_bufferingHints :: Lens' S3DestinationUpdate (Maybe BufferingHints) Source #

The buffering option. If no value is specified, BufferingHints object default values are used.

s3DestinationUpdate_compressionFormat :: Lens' S3DestinationUpdate (Maybe CompressionFormat) Source #

The compression format. If no value is specified, the default is UNCOMPRESSED.

The compression formats SNAPPY or ZIP cannot be specified for Amazon Redshift destinations because they are not supported by the Amazon Redshift COPY operation that reads from the S3 bucket.

s3DestinationUpdate_encryptionConfiguration :: Lens' S3DestinationUpdate (Maybe EncryptionConfiguration) Source #

The encryption configuration. If no value is specified, the default is no encryption.

s3DestinationUpdate_errorOutputPrefix :: Lens' S3DestinationUpdate (Maybe Text) Source #

A prefix that Kinesis Data Firehose evaluates and adds to failed records before writing them to S3. This prefix appears immediately following the bucket name. For information about how to specify this prefix, see Custom Prefixes for Amazon S3 Objects.

s3DestinationUpdate_prefix :: Lens' S3DestinationUpdate (Maybe Text) Source #

The "YYYY/MM/DD/HH" time format prefix is automatically used for delivered Amazon S3 files. You can also specify a custom prefix, as described in Custom Prefixes for Amazon S3 Objects.

s3DestinationUpdate_roleARN :: Lens' S3DestinationUpdate (Maybe Text) Source #

The Amazon Resource Name (ARN) of the Amazon Web Services credentials. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.

SchemaConfiguration

data SchemaConfiguration Source #

Specifies the schema to which you want Kinesis Data Firehose to configure your data before it writes it to Amazon S3. This parameter is required if Enabled is set to true.

See: newSchemaConfiguration smart constructor.

Constructors

SchemaConfiguration' 

Fields

  • catalogId :: Maybe Text

    The ID of the Amazon Web Services Glue Data Catalog. If you don't supply this, the Amazon Web Services account ID is used by default.

  • databaseName :: Maybe Text

    Specifies the name of the Amazon Web Services Glue database that contains the schema for the output data.

    If the SchemaConfiguration request parameter is used as part of invoking the CreateDeliveryStream API, then the DatabaseName property is required and its value must be specified.

  • region :: Maybe Text

    If you don't specify an Amazon Web Services Region, the default is the current Region.

  • roleARN :: Maybe Text

    The role that Kinesis Data Firehose can use to access Amazon Web Services Glue. This role must be in the same account you use for Kinesis Data Firehose. Cross-account roles aren't allowed.

    If the SchemaConfiguration request parameter is used as part of invoking the CreateDeliveryStream API, then the RoleARN property is required and its value must be specified.

  • tableName :: Maybe Text

    Specifies the Amazon Web Services Glue table that contains the column information that constitutes your data schema.

    If the SchemaConfiguration request parameter is used as part of invoking the CreateDeliveryStream API, then the TableName property is required and its value must be specified.

  • versionId :: Maybe Text

    Specifies the table version for the output data schema. If you don't specify this version ID, or if you set it to LATEST, Kinesis Data Firehose uses the most recent version. This means that any updates to the table are automatically picked up.

Instances

Instances details
FromJSON SchemaConfiguration Source # 
Instance details

Defined in Amazonka.Firehose.Types.SchemaConfiguration

ToJSON SchemaConfiguration Source # 
Instance details

Defined in Amazonka.Firehose.Types.SchemaConfiguration

Generic SchemaConfiguration Source # 
Instance details

Defined in Amazonka.Firehose.Types.SchemaConfiguration

Associated Types

type Rep SchemaConfiguration :: Type -> Type #

Read SchemaConfiguration Source # 
Instance details

Defined in Amazonka.Firehose.Types.SchemaConfiguration

Show SchemaConfiguration Source # 
Instance details

Defined in Amazonka.Firehose.Types.SchemaConfiguration

NFData SchemaConfiguration Source # 
Instance details

Defined in Amazonka.Firehose.Types.SchemaConfiguration

Methods

rnf :: SchemaConfiguration -> () #

Eq SchemaConfiguration Source # 
Instance details

Defined in Amazonka.Firehose.Types.SchemaConfiguration

Hashable SchemaConfiguration Source # 
Instance details

Defined in Amazonka.Firehose.Types.SchemaConfiguration

type Rep SchemaConfiguration Source # 
Instance details

Defined in Amazonka.Firehose.Types.SchemaConfiguration

type Rep SchemaConfiguration = D1 ('MetaData "SchemaConfiguration" "Amazonka.Firehose.Types.SchemaConfiguration" "amazonka-kinesis-firehose-2.0-6l1hHmh2UnHBvolxuQFkWB" 'False) (C1 ('MetaCons "SchemaConfiguration'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "catalogId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "databaseName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "region") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: (S1 ('MetaSel ('Just "roleARN") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "tableName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "versionId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))

newSchemaConfiguration :: SchemaConfiguration Source #

Create a value of SchemaConfiguration 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:catalogId:SchemaConfiguration', schemaConfiguration_catalogId - The ID of the Amazon Web Services Glue Data Catalog. If you don't supply this, the Amazon Web Services account ID is used by default.

$sel:databaseName:SchemaConfiguration', schemaConfiguration_databaseName - Specifies the name of the Amazon Web Services Glue database that contains the schema for the output data.

If the SchemaConfiguration request parameter is used as part of invoking the CreateDeliveryStream API, then the DatabaseName property is required and its value must be specified.

$sel:region:SchemaConfiguration', schemaConfiguration_region - If you don't specify an Amazon Web Services Region, the default is the current Region.

$sel:roleARN:SchemaConfiguration', schemaConfiguration_roleARN - The role that Kinesis Data Firehose can use to access Amazon Web Services Glue. This role must be in the same account you use for Kinesis Data Firehose. Cross-account roles aren't allowed.

If the SchemaConfiguration request parameter is used as part of invoking the CreateDeliveryStream API, then the RoleARN property is required and its value must be specified.

$sel:tableName:SchemaConfiguration', schemaConfiguration_tableName - Specifies the Amazon Web Services Glue table that contains the column information that constitutes your data schema.

If the SchemaConfiguration request parameter is used as part of invoking the CreateDeliveryStream API, then the TableName property is required and its value must be specified.

$sel:versionId:SchemaConfiguration', schemaConfiguration_versionId - Specifies the table version for the output data schema. If you don't specify this version ID, or if you set it to LATEST, Kinesis Data Firehose uses the most recent version. This means that any updates to the table are automatically picked up.

schemaConfiguration_catalogId :: Lens' SchemaConfiguration (Maybe Text) Source #

The ID of the Amazon Web Services Glue Data Catalog. If you don't supply this, the Amazon Web Services account ID is used by default.

schemaConfiguration_databaseName :: Lens' SchemaConfiguration (Maybe Text) Source #

Specifies the name of the Amazon Web Services Glue database that contains the schema for the output data.

If the SchemaConfiguration request parameter is used as part of invoking the CreateDeliveryStream API, then the DatabaseName property is required and its value must be specified.

schemaConfiguration_region :: Lens' SchemaConfiguration (Maybe Text) Source #

If you don't specify an Amazon Web Services Region, the default is the current Region.

schemaConfiguration_roleARN :: Lens' SchemaConfiguration (Maybe Text) Source #

The role that Kinesis Data Firehose can use to access Amazon Web Services Glue. This role must be in the same account you use for Kinesis Data Firehose. Cross-account roles aren't allowed.

If the SchemaConfiguration request parameter is used as part of invoking the CreateDeliveryStream API, then the RoleARN property is required and its value must be specified.

schemaConfiguration_tableName :: Lens' SchemaConfiguration (Maybe Text) Source #

Specifies the Amazon Web Services Glue table that contains the column information that constitutes your data schema.

If the SchemaConfiguration request parameter is used as part of invoking the CreateDeliveryStream API, then the TableName property is required and its value must be specified.

schemaConfiguration_versionId :: Lens' SchemaConfiguration (Maybe Text) Source #

Specifies the table version for the output data schema. If you don't specify this version ID, or if you set it to LATEST, Kinesis Data Firehose uses the most recent version. This means that any updates to the table are automatically picked up.

Serializer

data Serializer Source #

The serializer that you want Kinesis Data Firehose to use to convert data to the target format before writing it to Amazon S3. Kinesis Data Firehose supports two types of serializers: the ORC SerDe and the Parquet SerDe.

See: newSerializer smart constructor.

Constructors

Serializer' 

Fields

Instances

Instances details
FromJSON Serializer Source # 
Instance details

Defined in Amazonka.Firehose.Types.Serializer

ToJSON Serializer Source # 
Instance details

Defined in Amazonka.Firehose.Types.Serializer

Generic Serializer Source # 
Instance details

Defined in Amazonka.Firehose.Types.Serializer

Associated Types

type Rep Serializer :: Type -> Type #

Read Serializer Source # 
Instance details

Defined in Amazonka.Firehose.Types.Serializer

Show Serializer Source # 
Instance details

Defined in Amazonka.Firehose.Types.Serializer

NFData Serializer Source # 
Instance details

Defined in Amazonka.Firehose.Types.Serializer

Methods

rnf :: Serializer -> () #

Eq Serializer Source # 
Instance details

Defined in Amazonka.Firehose.Types.Serializer

Hashable Serializer Source # 
Instance details

Defined in Amazonka.Firehose.Types.Serializer

type Rep Serializer Source # 
Instance details

Defined in Amazonka.Firehose.Types.Serializer

type Rep Serializer = D1 ('MetaData "Serializer" "Amazonka.Firehose.Types.Serializer" "amazonka-kinesis-firehose-2.0-6l1hHmh2UnHBvolxuQFkWB" 'False) (C1 ('MetaCons "Serializer'" 'PrefixI 'True) (S1 ('MetaSel ('Just "orcSerDe") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe OrcSerDe)) :*: S1 ('MetaSel ('Just "parquetSerDe") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ParquetSerDe))))

newSerializer :: Serializer Source #

Create a value of Serializer 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:orcSerDe:Serializer', serializer_orcSerDe - A serializer to use for converting data to the ORC format before storing it in Amazon S3. For more information, see Apache ORC.

$sel:parquetSerDe:Serializer', serializer_parquetSerDe - A serializer to use for converting data to the Parquet format before storing it in Amazon S3. For more information, see Apache Parquet.

serializer_orcSerDe :: Lens' Serializer (Maybe OrcSerDe) Source #

A serializer to use for converting data to the ORC format before storing it in Amazon S3. For more information, see Apache ORC.

serializer_parquetSerDe :: Lens' Serializer (Maybe ParquetSerDe) Source #

A serializer to use for converting data to the Parquet format before storing it in Amazon S3. For more information, see Apache Parquet.

SourceDescription

data SourceDescription Source #

Details about a Kinesis data stream used as the source for a Kinesis Data Firehose delivery stream.

See: newSourceDescription smart constructor.

Constructors

SourceDescription' 

Fields

Instances

Instances details
FromJSON SourceDescription Source # 
Instance details

Defined in Amazonka.Firehose.Types.SourceDescription

Generic SourceDescription Source # 
Instance details

Defined in Amazonka.Firehose.Types.SourceDescription

Associated Types

type Rep SourceDescription :: Type -> Type #

Read SourceDescription Source # 
Instance details

Defined in Amazonka.Firehose.Types.SourceDescription

Show SourceDescription Source # 
Instance details

Defined in Amazonka.Firehose.Types.SourceDescription

NFData SourceDescription Source # 
Instance details

Defined in Amazonka.Firehose.Types.SourceDescription

Methods

rnf :: SourceDescription -> () #

Eq SourceDescription Source # 
Instance details

Defined in Amazonka.Firehose.Types.SourceDescription

Hashable SourceDescription Source # 
Instance details

Defined in Amazonka.Firehose.Types.SourceDescription

type Rep SourceDescription Source # 
Instance details

Defined in Amazonka.Firehose.Types.SourceDescription

type Rep SourceDescription = D1 ('MetaData "SourceDescription" "Amazonka.Firehose.Types.SourceDescription" "amazonka-kinesis-firehose-2.0-6l1hHmh2UnHBvolxuQFkWB" 'False) (C1 ('MetaCons "SourceDescription'" 'PrefixI 'True) (S1 ('MetaSel ('Just "kinesisStreamSourceDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe KinesisStreamSourceDescription))))

newSourceDescription :: SourceDescription Source #

Create a value of SourceDescription 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:kinesisStreamSourceDescription:SourceDescription', sourceDescription_kinesisStreamSourceDescription - The KinesisStreamSourceDescription value for the source Kinesis data stream.

sourceDescription_kinesisStreamSourceDescription :: Lens' SourceDescription (Maybe KinesisStreamSourceDescription) Source #

The KinesisStreamSourceDescription value for the source Kinesis data stream.

SplunkDestinationConfiguration

data SplunkDestinationConfiguration Source #

Describes the configuration of a destination in Splunk.

See: newSplunkDestinationConfiguration smart constructor.

Constructors

SplunkDestinationConfiguration' 

Fields

  • cloudWatchLoggingOptions :: Maybe CloudWatchLoggingOptions

    The Amazon CloudWatch logging options for your delivery stream.

  • hECAcknowledgmentTimeoutInSeconds :: Maybe Natural

    The amount of time that Kinesis Data Firehose waits to receive an acknowledgment from Splunk after it sends it data. At the end of the timeout period, Kinesis Data Firehose either tries to send the data again or considers it an error, based on your retry settings.

  • processingConfiguration :: Maybe ProcessingConfiguration

    The data processing configuration.

  • retryOptions :: Maybe SplunkRetryOptions

    The retry behavior in case Kinesis Data Firehose is unable to deliver data to Splunk, or if it doesn't receive an acknowledgment of receipt from Splunk.

  • s3BackupMode :: Maybe SplunkS3BackupMode

    Defines how documents should be delivered to Amazon S3. When set to FailedEventsOnly, Kinesis Data Firehose writes any data that could not be indexed to the configured Amazon S3 destination. When set to AllEvents, Kinesis Data Firehose delivers all incoming records to Amazon S3, and also writes failed documents to Amazon S3. The default value is FailedEventsOnly.

    You can update this backup mode from FailedEventsOnly to AllEvents. You can't update it from AllEvents to FailedEventsOnly.

  • hECEndpoint :: Text

    The HTTP Event Collector (HEC) endpoint to which Kinesis Data Firehose sends your data.

  • hECEndpointType :: HECEndpointType

    This type can be either "Raw" or "Event."

  • hECToken :: Text

    This is a GUID that you obtain from your Splunk cluster when you create a new HEC endpoint.

  • s3Configuration :: S3DestinationConfiguration

    The configuration for the backup Amazon S3 location.

Instances

Instances details
ToJSON SplunkDestinationConfiguration Source # 
Instance details

Defined in Amazonka.Firehose.Types.SplunkDestinationConfiguration

Generic SplunkDestinationConfiguration Source # 
Instance details

Defined in Amazonka.Firehose.Types.SplunkDestinationConfiguration

Associated Types

type Rep SplunkDestinationConfiguration :: Type -> Type #

Read SplunkDestinationConfiguration Source # 
Instance details

Defined in Amazonka.Firehose.Types.SplunkDestinationConfiguration

Show SplunkDestinationConfiguration Source # 
Instance details

Defined in Amazonka.Firehose.Types.SplunkDestinationConfiguration

NFData SplunkDestinationConfiguration Source # 
Instance details

Defined in Amazonka.Firehose.Types.SplunkDestinationConfiguration

Eq SplunkDestinationConfiguration Source # 
Instance details

Defined in Amazonka.Firehose.Types.SplunkDestinationConfiguration

Hashable SplunkDestinationConfiguration Source # 
Instance details

Defined in Amazonka.Firehose.Types.SplunkDestinationConfiguration

type Rep SplunkDestinationConfiguration Source # 
Instance details

Defined in Amazonka.Firehose.Types.SplunkDestinationConfiguration

type Rep SplunkDestinationConfiguration = D1 ('MetaData "SplunkDestinationConfiguration" "Amazonka.Firehose.Types.SplunkDestinationConfiguration" "amazonka-kinesis-firehose-2.0-6l1hHmh2UnHBvolxuQFkWB" 'False) (C1 ('MetaCons "SplunkDestinationConfiguration'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "cloudWatchLoggingOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CloudWatchLoggingOptions)) :*: S1 ('MetaSel ('Just "hECAcknowledgmentTimeoutInSeconds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))) :*: (S1 ('MetaSel ('Just "processingConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ProcessingConfiguration)) :*: S1 ('MetaSel ('Just "retryOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SplunkRetryOptions)))) :*: ((S1 ('MetaSel ('Just "s3BackupMode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SplunkS3BackupMode)) :*: S1 ('MetaSel ('Just "hECEndpoint") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :*: (S1 ('MetaSel ('Just "hECEndpointType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 HECEndpointType) :*: (S1 ('MetaSel ('Just "hECToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "s3Configuration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 S3DestinationConfiguration))))))

newSplunkDestinationConfiguration Source #

Create a value of SplunkDestinationConfiguration 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:

SplunkDestinationConfiguration, splunkDestinationConfiguration_cloudWatchLoggingOptions - The Amazon CloudWatch logging options for your delivery stream.

$sel:hECAcknowledgmentTimeoutInSeconds:SplunkDestinationConfiguration', splunkDestinationConfiguration_hECAcknowledgmentTimeoutInSeconds - The amount of time that Kinesis Data Firehose waits to receive an acknowledgment from Splunk after it sends it data. At the end of the timeout period, Kinesis Data Firehose either tries to send the data again or considers it an error, based on your retry settings.

$sel:processingConfiguration:SplunkDestinationConfiguration', splunkDestinationConfiguration_processingConfiguration - The data processing configuration.

$sel:retryOptions:SplunkDestinationConfiguration', splunkDestinationConfiguration_retryOptions - The retry behavior in case Kinesis Data Firehose is unable to deliver data to Splunk, or if it doesn't receive an acknowledgment of receipt from Splunk.

$sel:s3BackupMode:SplunkDestinationConfiguration', splunkDestinationConfiguration_s3BackupMode - Defines how documents should be delivered to Amazon S3. When set to FailedEventsOnly, Kinesis Data Firehose writes any data that could not be indexed to the configured Amazon S3 destination. When set to AllEvents, Kinesis Data Firehose delivers all incoming records to Amazon S3, and also writes failed documents to Amazon S3. The default value is FailedEventsOnly.

You can update this backup mode from FailedEventsOnly to AllEvents. You can't update it from AllEvents to FailedEventsOnly.

$sel:hECEndpoint:SplunkDestinationConfiguration', splunkDestinationConfiguration_hECEndpoint - The HTTP Event Collector (HEC) endpoint to which Kinesis Data Firehose sends your data.

$sel:hECEndpointType:SplunkDestinationConfiguration', splunkDestinationConfiguration_hECEndpointType - This type can be either "Raw" or "Event."

$sel:hECToken:SplunkDestinationConfiguration', splunkDestinationConfiguration_hECToken - This is a GUID that you obtain from your Splunk cluster when you create a new HEC endpoint.

$sel:s3Configuration:SplunkDestinationConfiguration', splunkDestinationConfiguration_s3Configuration - The configuration for the backup Amazon S3 location.

splunkDestinationConfiguration_hECAcknowledgmentTimeoutInSeconds :: Lens' SplunkDestinationConfiguration (Maybe Natural) Source #

The amount of time that Kinesis Data Firehose waits to receive an acknowledgment from Splunk after it sends it data. At the end of the timeout period, Kinesis Data Firehose either tries to send the data again or considers it an error, based on your retry settings.

splunkDestinationConfiguration_retryOptions :: Lens' SplunkDestinationConfiguration (Maybe SplunkRetryOptions) Source #

The retry behavior in case Kinesis Data Firehose is unable to deliver data to Splunk, or if it doesn't receive an acknowledgment of receipt from Splunk.

splunkDestinationConfiguration_s3BackupMode :: Lens' SplunkDestinationConfiguration (Maybe SplunkS3BackupMode) Source #

Defines how documents should be delivered to Amazon S3. When set to FailedEventsOnly, Kinesis Data Firehose writes any data that could not be indexed to the configured Amazon S3 destination. When set to AllEvents, Kinesis Data Firehose delivers all incoming records to Amazon S3, and also writes failed documents to Amazon S3. The default value is FailedEventsOnly.

You can update this backup mode from FailedEventsOnly to AllEvents. You can't update it from AllEvents to FailedEventsOnly.

splunkDestinationConfiguration_hECEndpoint :: Lens' SplunkDestinationConfiguration Text Source #

The HTTP Event Collector (HEC) endpoint to which Kinesis Data Firehose sends your data.

splunkDestinationConfiguration_hECToken :: Lens' SplunkDestinationConfiguration Text Source #

This is a GUID that you obtain from your Splunk cluster when you create a new HEC endpoint.

SplunkDestinationDescription

data SplunkDestinationDescription Source #

Describes a destination in Splunk.

See: newSplunkDestinationDescription smart constructor.

Constructors

SplunkDestinationDescription' 

Fields

Instances

Instances details
FromJSON SplunkDestinationDescription Source # 
Instance details

Defined in Amazonka.Firehose.Types.SplunkDestinationDescription

Generic SplunkDestinationDescription Source # 
Instance details

Defined in Amazonka.Firehose.Types.SplunkDestinationDescription

Associated Types

type Rep SplunkDestinationDescription :: Type -> Type #

Read SplunkDestinationDescription Source # 
Instance details

Defined in Amazonka.Firehose.Types.SplunkDestinationDescription

Show SplunkDestinationDescription Source # 
Instance details

Defined in Amazonka.Firehose.Types.SplunkDestinationDescription

NFData SplunkDestinationDescription Source # 
Instance details

Defined in Amazonka.Firehose.Types.SplunkDestinationDescription

Eq SplunkDestinationDescription Source # 
Instance details

Defined in Amazonka.Firehose.Types.SplunkDestinationDescription

Hashable SplunkDestinationDescription Source # 
Instance details

Defined in Amazonka.Firehose.Types.SplunkDestinationDescription

type Rep SplunkDestinationDescription Source # 
Instance details

Defined in Amazonka.Firehose.Types.SplunkDestinationDescription

type Rep SplunkDestinationDescription = D1 ('MetaData "SplunkDestinationDescription" "Amazonka.Firehose.Types.SplunkDestinationDescription" "amazonka-kinesis-firehose-2.0-6l1hHmh2UnHBvolxuQFkWB" 'False) (C1 ('MetaCons "SplunkDestinationDescription'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "cloudWatchLoggingOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CloudWatchLoggingOptions)) :*: S1 ('MetaSel ('Just "hECAcknowledgmentTimeoutInSeconds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))) :*: (S1 ('MetaSel ('Just "hECEndpoint") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "hECEndpointType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe HECEndpointType)))) :*: ((S1 ('MetaSel ('Just "hECToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "processingConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ProcessingConfiguration))) :*: (S1 ('MetaSel ('Just "retryOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SplunkRetryOptions)) :*: (S1 ('MetaSel ('Just "s3BackupMode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SplunkS3BackupMode)) :*: S1 ('MetaSel ('Just "s3DestinationDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe S3DestinationDescription)))))))

newSplunkDestinationDescription :: SplunkDestinationDescription Source #

Create a value of SplunkDestinationDescription 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:

SplunkDestinationDescription, splunkDestinationDescription_cloudWatchLoggingOptions - The Amazon CloudWatch logging options for your delivery stream.

$sel:hECAcknowledgmentTimeoutInSeconds:SplunkDestinationDescription', splunkDestinationDescription_hECAcknowledgmentTimeoutInSeconds - The amount of time that Kinesis Data Firehose waits to receive an acknowledgment from Splunk after it sends it data. At the end of the timeout period, Kinesis Data Firehose either tries to send the data again or considers it an error, based on your retry settings.

$sel:hECEndpoint:SplunkDestinationDescription', splunkDestinationDescription_hECEndpoint - The HTTP Event Collector (HEC) endpoint to which Kinesis Data Firehose sends your data.

$sel:hECEndpointType:SplunkDestinationDescription', splunkDestinationDescription_hECEndpointType - This type can be either "Raw" or "Event."

$sel:hECToken:SplunkDestinationDescription', splunkDestinationDescription_hECToken - A GUID you obtain from your Splunk cluster when you create a new HEC endpoint.

$sel:processingConfiguration:SplunkDestinationDescription', splunkDestinationDescription_processingConfiguration - The data processing configuration.

$sel:retryOptions:SplunkDestinationDescription', splunkDestinationDescription_retryOptions - The retry behavior in case Kinesis Data Firehose is unable to deliver data to Splunk or if it doesn't receive an acknowledgment of receipt from Splunk.

$sel:s3BackupMode:SplunkDestinationDescription', splunkDestinationDescription_s3BackupMode - Defines how documents should be delivered to Amazon S3. When set to FailedDocumentsOnly, Kinesis Data Firehose writes any data that could not be indexed to the configured Amazon S3 destination. When set to AllDocuments, Kinesis Data Firehose delivers all incoming records to Amazon S3, and also writes failed documents to Amazon S3. Default value is FailedDocumentsOnly.

$sel:s3DestinationDescription:SplunkDestinationDescription', splunkDestinationDescription_s3DestinationDescription - The Amazon S3 destination.>

splunkDestinationDescription_hECAcknowledgmentTimeoutInSeconds :: Lens' SplunkDestinationDescription (Maybe Natural) Source #

The amount of time that Kinesis Data Firehose waits to receive an acknowledgment from Splunk after it sends it data. At the end of the timeout period, Kinesis Data Firehose either tries to send the data again or considers it an error, based on your retry settings.

splunkDestinationDescription_hECEndpoint :: Lens' SplunkDestinationDescription (Maybe Text) Source #

The HTTP Event Collector (HEC) endpoint to which Kinesis Data Firehose sends your data.

splunkDestinationDescription_hECToken :: Lens' SplunkDestinationDescription (Maybe Text) Source #

A GUID you obtain from your Splunk cluster when you create a new HEC endpoint.

splunkDestinationDescription_retryOptions :: Lens' SplunkDestinationDescription (Maybe SplunkRetryOptions) Source #

The retry behavior in case Kinesis Data Firehose is unable to deliver data to Splunk or if it doesn't receive an acknowledgment of receipt from Splunk.

splunkDestinationDescription_s3BackupMode :: Lens' SplunkDestinationDescription (Maybe SplunkS3BackupMode) Source #

Defines how documents should be delivered to Amazon S3. When set to FailedDocumentsOnly, Kinesis Data Firehose writes any data that could not be indexed to the configured Amazon S3 destination. When set to AllDocuments, Kinesis Data Firehose delivers all incoming records to Amazon S3, and also writes failed documents to Amazon S3. Default value is FailedDocumentsOnly.

SplunkDestinationUpdate

data SplunkDestinationUpdate Source #

Describes an update for a destination in Splunk.

See: newSplunkDestinationUpdate smart constructor.

Constructors

SplunkDestinationUpdate' 

Fields

  • cloudWatchLoggingOptions :: Maybe CloudWatchLoggingOptions

    The Amazon CloudWatch logging options for your delivery stream.

  • hECAcknowledgmentTimeoutInSeconds :: Maybe Natural

    The amount of time that Kinesis Data Firehose waits to receive an acknowledgment from Splunk after it sends data. At the end of the timeout period, Kinesis Data Firehose either tries to send the data again or considers it an error, based on your retry settings.

  • hECEndpoint :: Maybe Text

    The HTTP Event Collector (HEC) endpoint to which Kinesis Data Firehose sends your data.

  • hECEndpointType :: Maybe HECEndpointType

    This type can be either "Raw" or "Event."

  • hECToken :: Maybe Text

    A GUID that you obtain from your Splunk cluster when you create a new HEC endpoint.

  • processingConfiguration :: Maybe ProcessingConfiguration

    The data processing configuration.

  • retryOptions :: Maybe SplunkRetryOptions

    The retry behavior in case Kinesis Data Firehose is unable to deliver data to Splunk or if it doesn't receive an acknowledgment of receipt from Splunk.

  • s3BackupMode :: Maybe SplunkS3BackupMode

    Specifies how you want Kinesis Data Firehose to back up documents to Amazon S3. When set to FailedDocumentsOnly, Kinesis Data Firehose writes any data that could not be indexed to the configured Amazon S3 destination. When set to AllEvents, Kinesis Data Firehose delivers all incoming records to Amazon S3, and also writes failed documents to Amazon S3. The default value is FailedEventsOnly.

    You can update this backup mode from FailedEventsOnly to AllEvents. You can't update it from AllEvents to FailedEventsOnly.

  • s3Update :: Maybe S3DestinationUpdate

    Your update to the configuration of the backup Amazon S3 location.

Instances

Instances details
ToJSON SplunkDestinationUpdate Source # 
Instance details

Defined in Amazonka.Firehose.Types.SplunkDestinationUpdate

Generic SplunkDestinationUpdate Source # 
Instance details

Defined in Amazonka.Firehose.Types.SplunkDestinationUpdate

Associated Types

type Rep SplunkDestinationUpdate :: Type -> Type #

Read SplunkDestinationUpdate Source # 
Instance details

Defined in Amazonka.Firehose.Types.SplunkDestinationUpdate

Show SplunkDestinationUpdate Source # 
Instance details

Defined in Amazonka.Firehose.Types.SplunkDestinationUpdate

NFData SplunkDestinationUpdate Source # 
Instance details

Defined in Amazonka.Firehose.Types.SplunkDestinationUpdate

Methods

rnf :: SplunkDestinationUpdate -> () #

Eq SplunkDestinationUpdate Source # 
Instance details

Defined in Amazonka.Firehose.Types.SplunkDestinationUpdate

Hashable SplunkDestinationUpdate Source # 
Instance details

Defined in Amazonka.Firehose.Types.SplunkDestinationUpdate

type Rep SplunkDestinationUpdate Source # 
Instance details

Defined in Amazonka.Firehose.Types.SplunkDestinationUpdate

newSplunkDestinationUpdate :: SplunkDestinationUpdate Source #

Create a value of SplunkDestinationUpdate 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:

SplunkDestinationUpdate, splunkDestinationUpdate_cloudWatchLoggingOptions - The Amazon CloudWatch logging options for your delivery stream.

$sel:hECAcknowledgmentTimeoutInSeconds:SplunkDestinationUpdate', splunkDestinationUpdate_hECAcknowledgmentTimeoutInSeconds - The amount of time that Kinesis Data Firehose waits to receive an acknowledgment from Splunk after it sends data. At the end of the timeout period, Kinesis Data Firehose either tries to send the data again or considers it an error, based on your retry settings.

$sel:hECEndpoint:SplunkDestinationUpdate', splunkDestinationUpdate_hECEndpoint - The HTTP Event Collector (HEC) endpoint to which Kinesis Data Firehose sends your data.

$sel:hECEndpointType:SplunkDestinationUpdate', splunkDestinationUpdate_hECEndpointType - This type can be either "Raw" or "Event."

$sel:hECToken:SplunkDestinationUpdate', splunkDestinationUpdate_hECToken - A GUID that you obtain from your Splunk cluster when you create a new HEC endpoint.

$sel:processingConfiguration:SplunkDestinationUpdate', splunkDestinationUpdate_processingConfiguration - The data processing configuration.

$sel:retryOptions:SplunkDestinationUpdate', splunkDestinationUpdate_retryOptions - The retry behavior in case Kinesis Data Firehose is unable to deliver data to Splunk or if it doesn't receive an acknowledgment of receipt from Splunk.

$sel:s3BackupMode:SplunkDestinationUpdate', splunkDestinationUpdate_s3BackupMode - Specifies how you want Kinesis Data Firehose to back up documents to Amazon S3. When set to FailedDocumentsOnly, Kinesis Data Firehose writes any data that could not be indexed to the configured Amazon S3 destination. When set to AllEvents, Kinesis Data Firehose delivers all incoming records to Amazon S3, and also writes failed documents to Amazon S3. The default value is FailedEventsOnly.

You can update this backup mode from FailedEventsOnly to AllEvents. You can't update it from AllEvents to FailedEventsOnly.

$sel:s3Update:SplunkDestinationUpdate', splunkDestinationUpdate_s3Update - Your update to the configuration of the backup Amazon S3 location.

splunkDestinationUpdate_hECAcknowledgmentTimeoutInSeconds :: Lens' SplunkDestinationUpdate (Maybe Natural) Source #

The amount of time that Kinesis Data Firehose waits to receive an acknowledgment from Splunk after it sends data. At the end of the timeout period, Kinesis Data Firehose either tries to send the data again or considers it an error, based on your retry settings.

splunkDestinationUpdate_hECEndpoint :: Lens' SplunkDestinationUpdate (Maybe Text) Source #

The HTTP Event Collector (HEC) endpoint to which Kinesis Data Firehose sends your data.

splunkDestinationUpdate_hECToken :: Lens' SplunkDestinationUpdate (Maybe Text) Source #

A GUID that you obtain from your Splunk cluster when you create a new HEC endpoint.

splunkDestinationUpdate_retryOptions :: Lens' SplunkDestinationUpdate (Maybe SplunkRetryOptions) Source #

The retry behavior in case Kinesis Data Firehose is unable to deliver data to Splunk or if it doesn't receive an acknowledgment of receipt from Splunk.

splunkDestinationUpdate_s3BackupMode :: Lens' SplunkDestinationUpdate (Maybe SplunkS3BackupMode) Source #

Specifies how you want Kinesis Data Firehose to back up documents to Amazon S3. When set to FailedDocumentsOnly, Kinesis Data Firehose writes any data that could not be indexed to the configured Amazon S3 destination. When set to AllEvents, Kinesis Data Firehose delivers all incoming records to Amazon S3, and also writes failed documents to Amazon S3. The default value is FailedEventsOnly.

You can update this backup mode from FailedEventsOnly to AllEvents. You can't update it from AllEvents to FailedEventsOnly.

splunkDestinationUpdate_s3Update :: Lens' SplunkDestinationUpdate (Maybe S3DestinationUpdate) Source #

Your update to the configuration of the backup Amazon S3 location.

SplunkRetryOptions

data SplunkRetryOptions Source #

Configures retry behavior in case Kinesis Data Firehose is unable to deliver documents to Splunk, or if it doesn't receive an acknowledgment from Splunk.

See: newSplunkRetryOptions smart constructor.

Constructors

SplunkRetryOptions' 

Fields

  • durationInSeconds :: Maybe Natural

    The total amount of time that Kinesis Data Firehose spends on retries. This duration starts after the initial attempt to send data to Splunk fails. It doesn't include the periods during which Kinesis Data Firehose waits for acknowledgment from Splunk after each attempt.

Instances

Instances details
FromJSON SplunkRetryOptions Source # 
Instance details

Defined in Amazonka.Firehose.Types.SplunkRetryOptions

ToJSON SplunkRetryOptions Source # 
Instance details

Defined in Amazonka.Firehose.Types.SplunkRetryOptions

Generic SplunkRetryOptions Source # 
Instance details

Defined in Amazonka.Firehose.Types.SplunkRetryOptions

Associated Types

type Rep SplunkRetryOptions :: Type -> Type #

Read SplunkRetryOptions Source # 
Instance details

Defined in Amazonka.Firehose.Types.SplunkRetryOptions

Show SplunkRetryOptions Source # 
Instance details

Defined in Amazonka.Firehose.Types.SplunkRetryOptions

NFData SplunkRetryOptions Source # 
Instance details

Defined in Amazonka.Firehose.Types.SplunkRetryOptions

Methods

rnf :: SplunkRetryOptions -> () #

Eq SplunkRetryOptions Source # 
Instance details

Defined in Amazonka.Firehose.Types.SplunkRetryOptions

Hashable SplunkRetryOptions Source # 
Instance details

Defined in Amazonka.Firehose.Types.SplunkRetryOptions

type Rep SplunkRetryOptions Source # 
Instance details

Defined in Amazonka.Firehose.Types.SplunkRetryOptions

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

newSplunkRetryOptions :: SplunkRetryOptions Source #

Create a value of SplunkRetryOptions 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:durationInSeconds:SplunkRetryOptions', splunkRetryOptions_durationInSeconds - The total amount of time that Kinesis Data Firehose spends on retries. This duration starts after the initial attempt to send data to Splunk fails. It doesn't include the periods during which Kinesis Data Firehose waits for acknowledgment from Splunk after each attempt.

splunkRetryOptions_durationInSeconds :: Lens' SplunkRetryOptions (Maybe Natural) Source #

The total amount of time that Kinesis Data Firehose spends on retries. This duration starts after the initial attempt to send data to Splunk fails. It doesn't include the periods during which Kinesis Data Firehose waits for acknowledgment from Splunk after each attempt.

Tag

data Tag Source #

Metadata that you can assign to a delivery stream, consisting of a key-value pair.

See: newTag smart constructor.

Constructors

Tag' 

Fields

  • value :: Maybe Text

    An optional string, which you can use to describe or define the tag. Maximum length: 256 characters. Valid characters: Unicode letters, digits, white space, _ . / = + - % @

  • key :: Text

    A unique identifier for the tag. Maximum length: 128 characters. Valid characters: Unicode letters, digits, white space, _ . / = + - % @

Instances

Instances details
FromJSON Tag Source # 
Instance details

Defined in Amazonka.Firehose.Types.Tag

ToJSON Tag Source # 
Instance details

Defined in Amazonka.Firehose.Types.Tag

Generic Tag Source # 
Instance details

Defined in Amazonka.Firehose.Types.Tag

Associated Types

type Rep Tag :: Type -> Type #

Methods

from :: Tag -> Rep Tag x #

to :: Rep Tag x -> Tag #

Read Tag Source # 
Instance details

Defined in Amazonka.Firehose.Types.Tag

Show Tag Source # 
Instance details

Defined in Amazonka.Firehose.Types.Tag

Methods

showsPrec :: Int -> Tag -> ShowS #

show :: Tag -> String #

showList :: [Tag] -> ShowS #

NFData Tag Source # 
Instance details

Defined in Amazonka.Firehose.Types.Tag

Methods

rnf :: Tag -> () #

Eq Tag Source # 
Instance details

Defined in Amazonka.Firehose.Types.Tag

Methods

(==) :: Tag -> Tag -> Bool #

(/=) :: Tag -> Tag -> Bool #

Hashable Tag Source # 
Instance details

Defined in Amazonka.Firehose.Types.Tag

Methods

hashWithSalt :: Int -> Tag -> Int #

hash :: Tag -> Int #

type Rep Tag Source # 
Instance details

Defined in Amazonka.Firehose.Types.Tag

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

newTag Source #

Arguments

:: Text

$sel:key:Tag'

-> Tag 

Create a value of Tag 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:value:Tag', tag_value - An optional string, which you can use to describe or define the tag. Maximum length: 256 characters. Valid characters: Unicode letters, digits, white space, _ . / = + - % @

$sel:key:Tag', tag_key - A unique identifier for the tag. Maximum length: 128 characters. Valid characters: Unicode letters, digits, white space, _ . / = + - % @

tag_value :: Lens' Tag (Maybe Text) Source #

An optional string, which you can use to describe or define the tag. Maximum length: 256 characters. Valid characters: Unicode letters, digits, white space, _ . / = + - % @

tag_key :: Lens' Tag Text Source #

A unique identifier for the tag. Maximum length: 128 characters. Valid characters: Unicode letters, digits, white space, _ . / = + - % @

VpcConfiguration

data VpcConfiguration Source #

The details of the VPC of the Amazon ES destination.

See: newVpcConfiguration smart constructor.

Constructors

VpcConfiguration' 

Fields

  • subnetIds :: NonEmpty Text

    The IDs of the subnets that you want Kinesis Data Firehose to use to create ENIs in the VPC of the Amazon ES destination. Make sure that the routing tables and inbound and outbound rules allow traffic to flow from the subnets whose IDs are specified here to the subnets that have the destination Amazon ES endpoints. Kinesis Data Firehose creates at least one ENI in each of the subnets that are specified here. Do not delete or modify these ENIs.

    The number of ENIs that Kinesis Data Firehose creates in the subnets specified here scales up and down automatically based on throughput. To enable Kinesis Data Firehose to scale up the number of ENIs to match throughput, ensure that you have sufficient quota. To help you calculate the quota you need, assume that Kinesis Data Firehose can create up to three ENIs for this delivery stream for each of the subnets specified here. For more information about ENI quota, see Network Interfaces in the Amazon VPC Quotas topic.

  • roleARN :: Text

    The ARN of the IAM role that you want the delivery stream to use to create endpoints in the destination VPC. You can use your existing Kinesis Data Firehose delivery role or you can specify a new role. In either case, make sure that the role trusts the Kinesis Data Firehose service principal and that it grants the following permissions:

    • ec2:DescribeVpcs
    • ec2:DescribeVpcAttribute
    • ec2:DescribeSubnets
    • ec2:DescribeSecurityGroups
    • ec2:DescribeNetworkInterfaces
    • ec2:CreateNetworkInterface
    • ec2:CreateNetworkInterfacePermission
    • ec2:DeleteNetworkInterface

    If you revoke these permissions after you create the delivery stream, Kinesis Data Firehose can't scale out by creating more ENIs when necessary. You might therefore see a degradation in performance.

  • securityGroupIds :: NonEmpty Text

    The IDs of the security groups that you want Kinesis Data Firehose to use when it creates ENIs in the VPC of the Amazon ES destination. You can use the same security group that the Amazon ES domain uses or different ones. If you specify different security groups here, ensure that they allow outbound HTTPS traffic to the Amazon ES domain's security group. Also ensure that the Amazon ES domain's security group allows HTTPS traffic from the security groups specified here. If you use the same security group for both your delivery stream and the Amazon ES domain, make sure the security group inbound rule allows HTTPS traffic. For more information about security group rules, see Security group rules in the Amazon VPC documentation.

Instances

Instances details
ToJSON VpcConfiguration Source # 
Instance details

Defined in Amazonka.Firehose.Types.VpcConfiguration

Generic VpcConfiguration Source # 
Instance details

Defined in Amazonka.Firehose.Types.VpcConfiguration

Associated Types

type Rep VpcConfiguration :: Type -> Type #

Read VpcConfiguration Source # 
Instance details

Defined in Amazonka.Firehose.Types.VpcConfiguration

Show VpcConfiguration Source # 
Instance details

Defined in Amazonka.Firehose.Types.VpcConfiguration

NFData VpcConfiguration Source # 
Instance details

Defined in Amazonka.Firehose.Types.VpcConfiguration

Methods

rnf :: VpcConfiguration -> () #

Eq VpcConfiguration Source # 
Instance details

Defined in Amazonka.Firehose.Types.VpcConfiguration

Hashable VpcConfiguration Source # 
Instance details

Defined in Amazonka.Firehose.Types.VpcConfiguration

type Rep VpcConfiguration Source # 
Instance details

Defined in Amazonka.Firehose.Types.VpcConfiguration

type Rep VpcConfiguration = D1 ('MetaData "VpcConfiguration" "Amazonka.Firehose.Types.VpcConfiguration" "amazonka-kinesis-firehose-2.0-6l1hHmh2UnHBvolxuQFkWB" 'False) (C1 ('MetaCons "VpcConfiguration'" 'PrefixI 'True) (S1 ('MetaSel ('Just "subnetIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (NonEmpty Text)) :*: (S1 ('MetaSel ('Just "roleARN") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "securityGroupIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (NonEmpty Text)))))

newVpcConfiguration Source #

Create a value of VpcConfiguration 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:subnetIds:VpcConfiguration', vpcConfiguration_subnetIds - The IDs of the subnets that you want Kinesis Data Firehose to use to create ENIs in the VPC of the Amazon ES destination. Make sure that the routing tables and inbound and outbound rules allow traffic to flow from the subnets whose IDs are specified here to the subnets that have the destination Amazon ES endpoints. Kinesis Data Firehose creates at least one ENI in each of the subnets that are specified here. Do not delete or modify these ENIs.

The number of ENIs that Kinesis Data Firehose creates in the subnets specified here scales up and down automatically based on throughput. To enable Kinesis Data Firehose to scale up the number of ENIs to match throughput, ensure that you have sufficient quota. To help you calculate the quota you need, assume that Kinesis Data Firehose can create up to three ENIs for this delivery stream for each of the subnets specified here. For more information about ENI quota, see Network Interfaces in the Amazon VPC Quotas topic.

$sel:roleARN:VpcConfiguration', vpcConfiguration_roleARN - The ARN of the IAM role that you want the delivery stream to use to create endpoints in the destination VPC. You can use your existing Kinesis Data Firehose delivery role or you can specify a new role. In either case, make sure that the role trusts the Kinesis Data Firehose service principal and that it grants the following permissions:

  • ec2:DescribeVpcs
  • ec2:DescribeVpcAttribute
  • ec2:DescribeSubnets
  • ec2:DescribeSecurityGroups
  • ec2:DescribeNetworkInterfaces
  • ec2:CreateNetworkInterface
  • ec2:CreateNetworkInterfacePermission
  • ec2:DeleteNetworkInterface

If you revoke these permissions after you create the delivery stream, Kinesis Data Firehose can't scale out by creating more ENIs when necessary. You might therefore see a degradation in performance.

$sel:securityGroupIds:VpcConfiguration', vpcConfiguration_securityGroupIds - The IDs of the security groups that you want Kinesis Data Firehose to use when it creates ENIs in the VPC of the Amazon ES destination. You can use the same security group that the Amazon ES domain uses or different ones. If you specify different security groups here, ensure that they allow outbound HTTPS traffic to the Amazon ES domain's security group. Also ensure that the Amazon ES domain's security group allows HTTPS traffic from the security groups specified here. If you use the same security group for both your delivery stream and the Amazon ES domain, make sure the security group inbound rule allows HTTPS traffic. For more information about security group rules, see Security group rules in the Amazon VPC documentation.

vpcConfiguration_subnetIds :: Lens' VpcConfiguration (NonEmpty Text) Source #

The IDs of the subnets that you want Kinesis Data Firehose to use to create ENIs in the VPC of the Amazon ES destination. Make sure that the routing tables and inbound and outbound rules allow traffic to flow from the subnets whose IDs are specified here to the subnets that have the destination Amazon ES endpoints. Kinesis Data Firehose creates at least one ENI in each of the subnets that are specified here. Do not delete or modify these ENIs.

The number of ENIs that Kinesis Data Firehose creates in the subnets specified here scales up and down automatically based on throughput. To enable Kinesis Data Firehose to scale up the number of ENIs to match throughput, ensure that you have sufficient quota. To help you calculate the quota you need, assume that Kinesis Data Firehose can create up to three ENIs for this delivery stream for each of the subnets specified here. For more information about ENI quota, see Network Interfaces in the Amazon VPC Quotas topic.

vpcConfiguration_roleARN :: Lens' VpcConfiguration Text Source #

The ARN of the IAM role that you want the delivery stream to use to create endpoints in the destination VPC. You can use your existing Kinesis Data Firehose delivery role or you can specify a new role. In either case, make sure that the role trusts the Kinesis Data Firehose service principal and that it grants the following permissions:

  • ec2:DescribeVpcs
  • ec2:DescribeVpcAttribute
  • ec2:DescribeSubnets
  • ec2:DescribeSecurityGroups
  • ec2:DescribeNetworkInterfaces
  • ec2:CreateNetworkInterface
  • ec2:CreateNetworkInterfacePermission
  • ec2:DeleteNetworkInterface

If you revoke these permissions after you create the delivery stream, Kinesis Data Firehose can't scale out by creating more ENIs when necessary. You might therefore see a degradation in performance.

vpcConfiguration_securityGroupIds :: Lens' VpcConfiguration (NonEmpty Text) Source #

The IDs of the security groups that you want Kinesis Data Firehose to use when it creates ENIs in the VPC of the Amazon ES destination. You can use the same security group that the Amazon ES domain uses or different ones. If you specify different security groups here, ensure that they allow outbound HTTPS traffic to the Amazon ES domain's security group. Also ensure that the Amazon ES domain's security group allows HTTPS traffic from the security groups specified here. If you use the same security group for both your delivery stream and the Amazon ES domain, make sure the security group inbound rule allows HTTPS traffic. For more information about security group rules, see Security group rules in the Amazon VPC documentation.

VpcConfigurationDescription

data VpcConfigurationDescription Source #

The details of the VPC of the Amazon ES destination.

See: newVpcConfigurationDescription smart constructor.

Constructors

VpcConfigurationDescription' 

Fields

  • subnetIds :: NonEmpty Text

    The IDs of the subnets that Kinesis Data Firehose uses to create ENIs in the VPC of the Amazon ES destination. Make sure that the routing tables and inbound and outbound rules allow traffic to flow from the subnets whose IDs are specified here to the subnets that have the destination Amazon ES endpoints. Kinesis Data Firehose creates at least one ENI in each of the subnets that are specified here. Do not delete or modify these ENIs.

    The number of ENIs that Kinesis Data Firehose creates in the subnets specified here scales up and down automatically based on throughput. To enable Kinesis Data Firehose to scale up the number of ENIs to match throughput, ensure that you have sufficient quota. To help you calculate the quota you need, assume that Kinesis Data Firehose can create up to three ENIs for this delivery stream for each of the subnets specified here. For more information about ENI quota, see Network Interfaces in the Amazon VPC Quotas topic.

  • roleARN :: Text

    The ARN of the IAM role that the delivery stream uses to create endpoints in the destination VPC. You can use your existing Kinesis Data Firehose delivery role or you can specify a new role. In either case, make sure that the role trusts the Kinesis Data Firehose service principal and that it grants the following permissions:

    • ec2:DescribeVpcs
    • ec2:DescribeVpcAttribute
    • ec2:DescribeSubnets
    • ec2:DescribeSecurityGroups
    • ec2:DescribeNetworkInterfaces
    • ec2:CreateNetworkInterface
    • ec2:CreateNetworkInterfacePermission
    • ec2:DeleteNetworkInterface

    If you revoke these permissions after you create the delivery stream, Kinesis Data Firehose can't scale out by creating more ENIs when necessary. You might therefore see a degradation in performance.

  • securityGroupIds :: NonEmpty Text

    The IDs of the security groups that Kinesis Data Firehose uses when it creates ENIs in the VPC of the Amazon ES destination. You can use the same security group that the Amazon ES domain uses or different ones. If you specify different security groups, ensure that they allow outbound HTTPS traffic to the Amazon ES domain's security group. Also ensure that the Amazon ES domain's security group allows HTTPS traffic from the security groups specified here. If you use the same security group for both your delivery stream and the Amazon ES domain, make sure the security group inbound rule allows HTTPS traffic. For more information about security group rules, see Security group rules in the Amazon VPC documentation.

  • vpcId :: Text

    The ID of the Amazon ES destination's VPC.

Instances

Instances details
FromJSON VpcConfigurationDescription Source # 
Instance details

Defined in Amazonka.Firehose.Types.VpcConfigurationDescription

Generic VpcConfigurationDescription Source # 
Instance details

Defined in Amazonka.Firehose.Types.VpcConfigurationDescription

Associated Types

type Rep VpcConfigurationDescription :: Type -> Type #

Read VpcConfigurationDescription Source # 
Instance details

Defined in Amazonka.Firehose.Types.VpcConfigurationDescription

Show VpcConfigurationDescription Source # 
Instance details

Defined in Amazonka.Firehose.Types.VpcConfigurationDescription

NFData VpcConfigurationDescription Source # 
Instance details

Defined in Amazonka.Firehose.Types.VpcConfigurationDescription

Eq VpcConfigurationDescription Source # 
Instance details

Defined in Amazonka.Firehose.Types.VpcConfigurationDescription

Hashable VpcConfigurationDescription Source # 
Instance details

Defined in Amazonka.Firehose.Types.VpcConfigurationDescription

type Rep VpcConfigurationDescription Source # 
Instance details

Defined in Amazonka.Firehose.Types.VpcConfigurationDescription

type Rep VpcConfigurationDescription = D1 ('MetaData "VpcConfigurationDescription" "Amazonka.Firehose.Types.VpcConfigurationDescription" "amazonka-kinesis-firehose-2.0-6l1hHmh2UnHBvolxuQFkWB" 'False) (C1 ('MetaCons "VpcConfigurationDescription'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "subnetIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (NonEmpty Text)) :*: S1 ('MetaSel ('Just "roleARN") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :*: (S1 ('MetaSel ('Just "securityGroupIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (NonEmpty Text)) :*: S1 ('MetaSel ('Just "vpcId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newVpcConfigurationDescription Source #

Create a value of VpcConfigurationDescription 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:subnetIds:VpcConfigurationDescription', vpcConfigurationDescription_subnetIds - The IDs of the subnets that Kinesis Data Firehose uses to create ENIs in the VPC of the Amazon ES destination. Make sure that the routing tables and inbound and outbound rules allow traffic to flow from the subnets whose IDs are specified here to the subnets that have the destination Amazon ES endpoints. Kinesis Data Firehose creates at least one ENI in each of the subnets that are specified here. Do not delete or modify these ENIs.

The number of ENIs that Kinesis Data Firehose creates in the subnets specified here scales up and down automatically based on throughput. To enable Kinesis Data Firehose to scale up the number of ENIs to match throughput, ensure that you have sufficient quota. To help you calculate the quota you need, assume that Kinesis Data Firehose can create up to three ENIs for this delivery stream for each of the subnets specified here. For more information about ENI quota, see Network Interfaces in the Amazon VPC Quotas topic.

$sel:roleARN:VpcConfigurationDescription', vpcConfigurationDescription_roleARN - The ARN of the IAM role that the delivery stream uses to create endpoints in the destination VPC. You can use your existing Kinesis Data Firehose delivery role or you can specify a new role. In either case, make sure that the role trusts the Kinesis Data Firehose service principal and that it grants the following permissions:

  • ec2:DescribeVpcs
  • ec2:DescribeVpcAttribute
  • ec2:DescribeSubnets
  • ec2:DescribeSecurityGroups
  • ec2:DescribeNetworkInterfaces
  • ec2:CreateNetworkInterface
  • ec2:CreateNetworkInterfacePermission
  • ec2:DeleteNetworkInterface

If you revoke these permissions after you create the delivery stream, Kinesis Data Firehose can't scale out by creating more ENIs when necessary. You might therefore see a degradation in performance.

$sel:securityGroupIds:VpcConfigurationDescription', vpcConfigurationDescription_securityGroupIds - The IDs of the security groups that Kinesis Data Firehose uses when it creates ENIs in the VPC of the Amazon ES destination. You can use the same security group that the Amazon ES domain uses or different ones. If you specify different security groups, ensure that they allow outbound HTTPS traffic to the Amazon ES domain's security group. Also ensure that the Amazon ES domain's security group allows HTTPS traffic from the security groups specified here. If you use the same security group for both your delivery stream and the Amazon ES domain, make sure the security group inbound rule allows HTTPS traffic. For more information about security group rules, see Security group rules in the Amazon VPC documentation.

$sel:vpcId:VpcConfigurationDescription', vpcConfigurationDescription_vpcId - The ID of the Amazon ES destination's VPC.

vpcConfigurationDescription_subnetIds :: Lens' VpcConfigurationDescription (NonEmpty Text) Source #

The IDs of the subnets that Kinesis Data Firehose uses to create ENIs in the VPC of the Amazon ES destination. Make sure that the routing tables and inbound and outbound rules allow traffic to flow from the subnets whose IDs are specified here to the subnets that have the destination Amazon ES endpoints. Kinesis Data Firehose creates at least one ENI in each of the subnets that are specified here. Do not delete or modify these ENIs.

The number of ENIs that Kinesis Data Firehose creates in the subnets specified here scales up and down automatically based on throughput. To enable Kinesis Data Firehose to scale up the number of ENIs to match throughput, ensure that you have sufficient quota. To help you calculate the quota you need, assume that Kinesis Data Firehose can create up to three ENIs for this delivery stream for each of the subnets specified here. For more information about ENI quota, see Network Interfaces in the Amazon VPC Quotas topic.

vpcConfigurationDescription_roleARN :: Lens' VpcConfigurationDescription Text Source #

The ARN of the IAM role that the delivery stream uses to create endpoints in the destination VPC. You can use your existing Kinesis Data Firehose delivery role or you can specify a new role. In either case, make sure that the role trusts the Kinesis Data Firehose service principal and that it grants the following permissions:

  • ec2:DescribeVpcs
  • ec2:DescribeVpcAttribute
  • ec2:DescribeSubnets
  • ec2:DescribeSecurityGroups
  • ec2:DescribeNetworkInterfaces
  • ec2:CreateNetworkInterface
  • ec2:CreateNetworkInterfacePermission
  • ec2:DeleteNetworkInterface

If you revoke these permissions after you create the delivery stream, Kinesis Data Firehose can't scale out by creating more ENIs when necessary. You might therefore see a degradation in performance.

vpcConfigurationDescription_securityGroupIds :: Lens' VpcConfigurationDescription (NonEmpty Text) Source #

The IDs of the security groups that Kinesis Data Firehose uses when it creates ENIs in the VPC of the Amazon ES destination. You can use the same security group that the Amazon ES domain uses or different ones. If you specify different security groups, ensure that they allow outbound HTTPS traffic to the Amazon ES domain's security group. Also ensure that the Amazon ES domain's security group allows HTTPS traffic from the security groups specified here. If you use the same security group for both your delivery stream and the Amazon ES domain, make sure the security group inbound rule allows HTTPS traffic. For more information about security group rules, see Security group rules in the Amazon VPC documentation.