| Copyright | (c) 2013-2018 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
| Language | Haskell2010 |
Network.AWS.Firehose
Contents
- Service Configuration
- Errors
- Waiters
- Operations
- Types
- CompressionFormat
- DeliveryStreamStatus
- DeliveryStreamType
- ElasticsearchIndexRotationPeriod
- ElasticsearchS3BackupMode
- HECEndpointType
- NoEncryptionConfig
- OrcCompression
- OrcFormatVersion
- ParquetCompression
- ParquetWriterVersion
- ProcessorParameterName
- ProcessorType
- RedshiftS3BackupMode
- S3BackupMode
- SplunkS3BackupMode
- BufferingHints
- CloudWatchLoggingOptions
- CopyCommand
- DataFormatConversionConfiguration
- DeliveryStreamDescription
- Deserializer
- DestinationDescription
- ElasticsearchBufferingHints
- ElasticsearchDestinationConfiguration
- ElasticsearchDestinationDescription
- ElasticsearchDestinationUpdate
- ElasticsearchRetryOptions
- EncryptionConfiguration
- ExtendedS3DestinationConfiguration
- ExtendedS3DestinationDescription
- ExtendedS3DestinationUpdate
- HiveJSONSerDe
- InputFormatConfiguration
- KMSEncryptionConfig
- KinesisStreamSourceConfiguration
- KinesisStreamSourceDescription
- OpenXJSONSerDe
- OrcSerDe
- OutputFormatConfiguration
- ParquetSerDe
- ProcessingConfiguration
- Processor
- ProcessorParameter
- PutRecordBatchResponseEntry
- Record
- RedshiftDestinationConfiguration
- RedshiftDestinationDescription
- RedshiftDestinationUpdate
- RedshiftRetryOptions
- S3DestinationConfiguration
- S3DestinationDescription
- S3DestinationUpdate
- SchemaConfiguration
- Serializer
- SourceDescription
- SplunkDestinationConfiguration
- SplunkDestinationDescription
- SplunkDestinationUpdate
- SplunkRetryOptions
- Tag
Description
Amazon Kinesis Data Firehose API Reference
Amazon Kinesis Data Firehose is a fully managed service that delivers real-time streaming data to destinations such as Amazon Simple Storage Service (Amazon S3), Amazon Elasticsearch Service (Amazon ES), Amazon Redshift, and Splunk.
- firehose :: Service
- _InvalidArgumentException :: AsError a => Getting (First ServiceError) a ServiceError
- _ConcurrentModificationException :: AsError a => Getting (First ServiceError) a ServiceError
- _ServiceUnavailableException :: AsError a => Getting (First ServiceError) a ServiceError
- _ResourceNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError
- _LimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError
- _ResourceInUseException :: AsError a => Getting (First ServiceError) a ServiceError
- module Network.AWS.Firehose.PutRecord
- module Network.AWS.Firehose.TagDeliveryStream
- module Network.AWS.Firehose.UpdateDestination
- module Network.AWS.Firehose.PutRecordBatch
- module Network.AWS.Firehose.UntagDeliveryStream
- module Network.AWS.Firehose.CreateDeliveryStream
- module Network.AWS.Firehose.DescribeDeliveryStream
- module Network.AWS.Firehose.ListTagsForDeliveryStream
- module Network.AWS.Firehose.ListDeliveryStreams
- module Network.AWS.Firehose.DeleteDeliveryStream
- data CompressionFormat
- = Gzip
- | Snappy
- | Uncompressed
- | Zip
- data DeliveryStreamStatus
- data DeliveryStreamType
- data ElasticsearchIndexRotationPeriod
- = NoRotation
- | OneDay
- | OneHour
- | OneMonth
- | OneWeek
- data ElasticsearchS3BackupMode
- data HECEndpointType
- data NoEncryptionConfig = NoEncryption
- data OrcCompression
- data OrcFormatVersion
- data ParquetCompression
- data ParquetWriterVersion
- data ProcessorParameterName
- data ProcessorType = Lambda
- data RedshiftS3BackupMode
- data S3BackupMode
- data SplunkS3BackupMode
- data BufferingHints
- bufferingHints :: BufferingHints
- bhSizeInMBs :: Lens' BufferingHints (Maybe Natural)
- bhIntervalInSeconds :: Lens' BufferingHints (Maybe Natural)
- data CloudWatchLoggingOptions
- cloudWatchLoggingOptions :: CloudWatchLoggingOptions
- cwloEnabled :: Lens' CloudWatchLoggingOptions (Maybe Bool)
- cwloLogGroupName :: Lens' CloudWatchLoggingOptions (Maybe Text)
- cwloLogStreamName :: Lens' CloudWatchLoggingOptions (Maybe Text)
- data CopyCommand
- copyCommand :: Text -> CopyCommand
- ccCopyOptions :: Lens' CopyCommand (Maybe Text)
- ccDataTableColumns :: Lens' CopyCommand (Maybe Text)
- ccDataTableName :: Lens' CopyCommand Text
- data DataFormatConversionConfiguration
- dataFormatConversionConfiguration :: DataFormatConversionConfiguration
- dfccOutputFormatConfiguration :: Lens' DataFormatConversionConfiguration (Maybe OutputFormatConfiguration)
- dfccEnabled :: Lens' DataFormatConversionConfiguration (Maybe Bool)
- dfccSchemaConfiguration :: Lens' DataFormatConversionConfiguration (Maybe SchemaConfiguration)
- dfccInputFormatConfiguration :: Lens' DataFormatConversionConfiguration (Maybe InputFormatConfiguration)
- data DeliveryStreamDescription
- deliveryStreamDescription :: Text -> Text -> DeliveryStreamStatus -> DeliveryStreamType -> Text -> Bool -> DeliveryStreamDescription
- dsdCreateTimestamp :: Lens' DeliveryStreamDescription (Maybe UTCTime)
- dsdSource :: Lens' DeliveryStreamDescription (Maybe SourceDescription)
- dsdLastUpdateTimestamp :: Lens' DeliveryStreamDescription (Maybe UTCTime)
- dsdDeliveryStreamName :: Lens' DeliveryStreamDescription Text
- dsdDeliveryStreamARN :: Lens' DeliveryStreamDescription Text
- dsdDeliveryStreamStatus :: Lens' DeliveryStreamDescription DeliveryStreamStatus
- dsdDeliveryStreamType :: Lens' DeliveryStreamDescription DeliveryStreamType
- dsdVersionId :: Lens' DeliveryStreamDescription Text
- dsdDestinations :: Lens' DeliveryStreamDescription [DestinationDescription]
- dsdHasMoreDestinations :: Lens' DeliveryStreamDescription Bool
- data Deserializer
- deserializer :: Deserializer
- dOpenXJSONSerDe :: Lens' Deserializer (Maybe OpenXJSONSerDe)
- dHiveJSONSerDe :: Lens' Deserializer (Maybe HiveJSONSerDe)
- data DestinationDescription
- destinationDescription :: Text -> DestinationDescription
- ddSplunkDestinationDescription :: Lens' DestinationDescription (Maybe SplunkDestinationDescription)
- ddS3DestinationDescription :: Lens' DestinationDescription (Maybe S3DestinationDescription)
- ddExtendedS3DestinationDescription :: Lens' DestinationDescription (Maybe ExtendedS3DestinationDescription)
- ddElasticsearchDestinationDescription :: Lens' DestinationDescription (Maybe ElasticsearchDestinationDescription)
- ddRedshiftDestinationDescription :: Lens' DestinationDescription (Maybe RedshiftDestinationDescription)
- ddDestinationId :: Lens' DestinationDescription Text
- data ElasticsearchBufferingHints
- elasticsearchBufferingHints :: ElasticsearchBufferingHints
- ebhSizeInMBs :: Lens' ElasticsearchBufferingHints (Maybe Natural)
- ebhIntervalInSeconds :: Lens' ElasticsearchBufferingHints (Maybe Natural)
- data ElasticsearchDestinationConfiguration
- elasticsearchDestinationConfiguration :: Text -> Text -> Text -> Text -> S3DestinationConfiguration -> ElasticsearchDestinationConfiguration
- edcIndexRotationPeriod :: Lens' ElasticsearchDestinationConfiguration (Maybe ElasticsearchIndexRotationPeriod)
- edcS3BackupMode :: Lens' ElasticsearchDestinationConfiguration (Maybe ElasticsearchS3BackupMode)
- edcCloudWatchLoggingOptions :: Lens' ElasticsearchDestinationConfiguration (Maybe CloudWatchLoggingOptions)
- edcBufferingHints :: Lens' ElasticsearchDestinationConfiguration (Maybe ElasticsearchBufferingHints)
- edcRetryOptions :: Lens' ElasticsearchDestinationConfiguration (Maybe ElasticsearchRetryOptions)
- edcProcessingConfiguration :: Lens' ElasticsearchDestinationConfiguration (Maybe ProcessingConfiguration)
- edcRoleARN :: Lens' ElasticsearchDestinationConfiguration Text
- edcDomainARN :: Lens' ElasticsearchDestinationConfiguration Text
- edcIndexName :: Lens' ElasticsearchDestinationConfiguration Text
- edcTypeName :: Lens' ElasticsearchDestinationConfiguration Text
- edcS3Configuration :: Lens' ElasticsearchDestinationConfiguration S3DestinationConfiguration
- data ElasticsearchDestinationDescription
- elasticsearchDestinationDescription :: ElasticsearchDestinationDescription
- eddIndexRotationPeriod :: Lens' ElasticsearchDestinationDescription (Maybe ElasticsearchIndexRotationPeriod)
- eddTypeName :: Lens' ElasticsearchDestinationDescription (Maybe Text)
- eddS3BackupMode :: Lens' ElasticsearchDestinationDescription (Maybe ElasticsearchS3BackupMode)
- eddDomainARN :: Lens' ElasticsearchDestinationDescription (Maybe Text)
- eddCloudWatchLoggingOptions :: Lens' ElasticsearchDestinationDescription (Maybe CloudWatchLoggingOptions)
- eddS3DestinationDescription :: Lens' ElasticsearchDestinationDescription (Maybe S3DestinationDescription)
- eddBufferingHints :: Lens' ElasticsearchDestinationDescription (Maybe ElasticsearchBufferingHints)
- eddRetryOptions :: Lens' ElasticsearchDestinationDescription (Maybe ElasticsearchRetryOptions)
- eddProcessingConfiguration :: Lens' ElasticsearchDestinationDescription (Maybe ProcessingConfiguration)
- eddRoleARN :: Lens' ElasticsearchDestinationDescription (Maybe Text)
- eddIndexName :: Lens' ElasticsearchDestinationDescription (Maybe Text)
- data ElasticsearchDestinationUpdate
- elasticsearchDestinationUpdate :: ElasticsearchDestinationUpdate
- eduIndexRotationPeriod :: Lens' ElasticsearchDestinationUpdate (Maybe ElasticsearchIndexRotationPeriod)
- eduTypeName :: Lens' ElasticsearchDestinationUpdate (Maybe Text)
- eduDomainARN :: Lens' ElasticsearchDestinationUpdate (Maybe Text)
- eduCloudWatchLoggingOptions :: Lens' ElasticsearchDestinationUpdate (Maybe CloudWatchLoggingOptions)
- eduS3Update :: Lens' ElasticsearchDestinationUpdate (Maybe S3DestinationUpdate)
- eduBufferingHints :: Lens' ElasticsearchDestinationUpdate (Maybe ElasticsearchBufferingHints)
- eduRetryOptions :: Lens' ElasticsearchDestinationUpdate (Maybe ElasticsearchRetryOptions)
- eduProcessingConfiguration :: Lens' ElasticsearchDestinationUpdate (Maybe ProcessingConfiguration)
- eduRoleARN :: Lens' ElasticsearchDestinationUpdate (Maybe Text)
- eduIndexName :: Lens' ElasticsearchDestinationUpdate (Maybe Text)
- data ElasticsearchRetryOptions
- elasticsearchRetryOptions :: ElasticsearchRetryOptions
- eroDurationInSeconds :: Lens' ElasticsearchRetryOptions (Maybe Natural)
- data EncryptionConfiguration
- encryptionConfiguration :: EncryptionConfiguration
- ecNoEncryptionConfig :: Lens' EncryptionConfiguration (Maybe NoEncryptionConfig)
- ecKMSEncryptionConfig :: Lens' EncryptionConfiguration (Maybe KMSEncryptionConfig)
- data ExtendedS3DestinationConfiguration
- extendedS3DestinationConfiguration :: Text -> Text -> ExtendedS3DestinationConfiguration
- esdcS3BackupMode :: Lens' ExtendedS3DestinationConfiguration (Maybe S3BackupMode)
- esdcPrefix :: Lens' ExtendedS3DestinationConfiguration (Maybe Text)
- esdcCloudWatchLoggingOptions :: Lens' ExtendedS3DestinationConfiguration (Maybe CloudWatchLoggingOptions)
- esdcS3BackupConfiguration :: Lens' ExtendedS3DestinationConfiguration (Maybe S3DestinationConfiguration)
- esdcEncryptionConfiguration :: Lens' ExtendedS3DestinationConfiguration (Maybe EncryptionConfiguration)
- esdcCompressionFormat :: Lens' ExtendedS3DestinationConfiguration (Maybe CompressionFormat)
- esdcBufferingHints :: Lens' ExtendedS3DestinationConfiguration (Maybe BufferingHints)
- esdcDataFormatConversionConfiguration :: Lens' ExtendedS3DestinationConfiguration (Maybe DataFormatConversionConfiguration)
- esdcProcessingConfiguration :: Lens' ExtendedS3DestinationConfiguration (Maybe ProcessingConfiguration)
- esdcRoleARN :: Lens' ExtendedS3DestinationConfiguration Text
- esdcBucketARN :: Lens' ExtendedS3DestinationConfiguration Text
- data ExtendedS3DestinationDescription
- extendedS3DestinationDescription :: Text -> Text -> BufferingHints -> CompressionFormat -> EncryptionConfiguration -> ExtendedS3DestinationDescription
- esddS3BackupMode :: Lens' ExtendedS3DestinationDescription (Maybe S3BackupMode)
- esddS3BackupDescription :: Lens' ExtendedS3DestinationDescription (Maybe S3DestinationDescription)
- esddPrefix :: Lens' ExtendedS3DestinationDescription (Maybe Text)
- esddCloudWatchLoggingOptions :: Lens' ExtendedS3DestinationDescription (Maybe CloudWatchLoggingOptions)
- esddDataFormatConversionConfiguration :: Lens' ExtendedS3DestinationDescription (Maybe DataFormatConversionConfiguration)
- esddProcessingConfiguration :: Lens' ExtendedS3DestinationDescription (Maybe ProcessingConfiguration)
- esddRoleARN :: Lens' ExtendedS3DestinationDescription Text
- esddBucketARN :: Lens' ExtendedS3DestinationDescription Text
- esddBufferingHints :: Lens' ExtendedS3DestinationDescription BufferingHints
- esddCompressionFormat :: Lens' ExtendedS3DestinationDescription CompressionFormat
- esddEncryptionConfiguration :: Lens' ExtendedS3DestinationDescription EncryptionConfiguration
- data ExtendedS3DestinationUpdate
- extendedS3DestinationUpdate :: ExtendedS3DestinationUpdate
- esduS3BackupMode :: Lens' ExtendedS3DestinationUpdate (Maybe S3BackupMode)
- esduPrefix :: Lens' ExtendedS3DestinationUpdate (Maybe Text)
- esduCloudWatchLoggingOptions :: Lens' ExtendedS3DestinationUpdate (Maybe CloudWatchLoggingOptions)
- esduS3BackupUpdate :: Lens' ExtendedS3DestinationUpdate (Maybe S3DestinationUpdate)
- esduEncryptionConfiguration :: Lens' ExtendedS3DestinationUpdate (Maybe EncryptionConfiguration)
- esduCompressionFormat :: Lens' ExtendedS3DestinationUpdate (Maybe CompressionFormat)
- esduBufferingHints :: Lens' ExtendedS3DestinationUpdate (Maybe BufferingHints)
- esduDataFormatConversionConfiguration :: Lens' ExtendedS3DestinationUpdate (Maybe DataFormatConversionConfiguration)
- esduBucketARN :: Lens' ExtendedS3DestinationUpdate (Maybe Text)
- esduProcessingConfiguration :: Lens' ExtendedS3DestinationUpdate (Maybe ProcessingConfiguration)
- esduRoleARN :: Lens' ExtendedS3DestinationUpdate (Maybe Text)
- data HiveJSONSerDe
- hiveJSONSerDe :: HiveJSONSerDe
- hjsdTimestampFormats :: Lens' HiveJSONSerDe [Text]
- data InputFormatConfiguration
- inputFormatConfiguration :: InputFormatConfiguration
- ifcDeserializer :: Lens' InputFormatConfiguration (Maybe Deserializer)
- data KMSEncryptionConfig
- kmsEncryptionConfig :: Text -> KMSEncryptionConfig
- kecAWSKMSKeyARN :: Lens' KMSEncryptionConfig Text
- data KinesisStreamSourceConfiguration
- kinesisStreamSourceConfiguration :: Text -> Text -> KinesisStreamSourceConfiguration
- ksscKinesisStreamARN :: Lens' KinesisStreamSourceConfiguration Text
- ksscRoleARN :: Lens' KinesisStreamSourceConfiguration Text
- data KinesisStreamSourceDescription
- kinesisStreamSourceDescription :: KinesisStreamSourceDescription
- kssdDeliveryStartTimestamp :: Lens' KinesisStreamSourceDescription (Maybe UTCTime)
- kssdKinesisStreamARN :: Lens' KinesisStreamSourceDescription (Maybe Text)
- kssdRoleARN :: Lens' KinesisStreamSourceDescription (Maybe Text)
- data OpenXJSONSerDe
- openXJSONSerDe :: OpenXJSONSerDe
- oxjsdColumnToJSONKeyMappings :: Lens' OpenXJSONSerDe (HashMap Text Text)
- oxjsdCaseInsensitive :: Lens' OpenXJSONSerDe (Maybe Bool)
- oxjsdConvertDotsInJSONKeysToUnderscores :: Lens' OpenXJSONSerDe (Maybe Bool)
- data OrcSerDe
- orcSerDe :: OrcSerDe
- osdBloomFilterFalsePositiveProbability :: Lens' OrcSerDe (Maybe Double)
- osdDictionaryKeyThreshold :: Lens' OrcSerDe (Maybe Double)
- osdEnablePadding :: Lens' OrcSerDe (Maybe Bool)
- osdCompression :: Lens' OrcSerDe (Maybe OrcCompression)
- osdBloomFilterColumns :: Lens' OrcSerDe [Text]
- osdRowIndexStride :: Lens' OrcSerDe (Maybe Natural)
- osdFormatVersion :: Lens' OrcSerDe (Maybe OrcFormatVersion)
- osdBlockSizeBytes :: Lens' OrcSerDe (Maybe Natural)
- osdStripeSizeBytes :: Lens' OrcSerDe (Maybe Natural)
- osdPaddingTolerance :: Lens' OrcSerDe (Maybe Double)
- data OutputFormatConfiguration
- outputFormatConfiguration :: OutputFormatConfiguration
- ofcSerializer :: Lens' OutputFormatConfiguration (Maybe Serializer)
- data ParquetSerDe
- parquetSerDe :: ParquetSerDe
- psdWriterVersion :: Lens' ParquetSerDe (Maybe ParquetWriterVersion)
- psdCompression :: Lens' ParquetSerDe (Maybe ParquetCompression)
- psdMaxPaddingBytes :: Lens' ParquetSerDe (Maybe Natural)
- psdEnableDictionaryCompression :: Lens' ParquetSerDe (Maybe Bool)
- psdPageSizeBytes :: Lens' ParquetSerDe (Maybe Natural)
- psdBlockSizeBytes :: Lens' ParquetSerDe (Maybe Natural)
- data ProcessingConfiguration
- processingConfiguration :: ProcessingConfiguration
- pcEnabled :: Lens' ProcessingConfiguration (Maybe Bool)
- pcProcessors :: Lens' ProcessingConfiguration [Processor]
- data Processor
- processor :: ProcessorType -> Processor
- pParameters :: Lens' Processor [ProcessorParameter]
- pType :: Lens' Processor ProcessorType
- data ProcessorParameter
- processorParameter :: ProcessorParameterName -> Text -> ProcessorParameter
- ppParameterName :: Lens' ProcessorParameter ProcessorParameterName
- ppParameterValue :: Lens' ProcessorParameter Text
- data PutRecordBatchResponseEntry
- putRecordBatchResponseEntry :: PutRecordBatchResponseEntry
- prbreRecordId :: Lens' PutRecordBatchResponseEntry (Maybe Text)
- prbreErrorCode :: Lens' PutRecordBatchResponseEntry (Maybe Text)
- prbreErrorMessage :: Lens' PutRecordBatchResponseEntry (Maybe Text)
- data Record
- record :: ByteString -> Record
- rData :: Lens' Record ByteString
- data RedshiftDestinationConfiguration
- redshiftDestinationConfiguration :: Text -> Text -> CopyCommand -> Text -> Text -> S3DestinationConfiguration -> RedshiftDestinationConfiguration
- rdcS3BackupMode :: Lens' RedshiftDestinationConfiguration (Maybe RedshiftS3BackupMode)
- rdcCloudWatchLoggingOptions :: Lens' RedshiftDestinationConfiguration (Maybe CloudWatchLoggingOptions)
- rdcS3BackupConfiguration :: Lens' RedshiftDestinationConfiguration (Maybe S3DestinationConfiguration)
- rdcRetryOptions :: Lens' RedshiftDestinationConfiguration (Maybe RedshiftRetryOptions)
- rdcProcessingConfiguration :: Lens' RedshiftDestinationConfiguration (Maybe ProcessingConfiguration)
- rdcRoleARN :: Lens' RedshiftDestinationConfiguration Text
- rdcClusterJDBCURL :: Lens' RedshiftDestinationConfiguration Text
- rdcCopyCommand :: Lens' RedshiftDestinationConfiguration CopyCommand
- rdcUsername :: Lens' RedshiftDestinationConfiguration Text
- rdcPassword :: Lens' RedshiftDestinationConfiguration Text
- rdcS3Configuration :: Lens' RedshiftDestinationConfiguration S3DestinationConfiguration
- data RedshiftDestinationDescription
- redshiftDestinationDescription :: Text -> Text -> CopyCommand -> Text -> S3DestinationDescription -> RedshiftDestinationDescription
- rddS3BackupMode :: Lens' RedshiftDestinationDescription (Maybe RedshiftS3BackupMode)
- rddS3BackupDescription :: Lens' RedshiftDestinationDescription (Maybe S3DestinationDescription)
- rddCloudWatchLoggingOptions :: Lens' RedshiftDestinationDescription (Maybe CloudWatchLoggingOptions)
- rddRetryOptions :: Lens' RedshiftDestinationDescription (Maybe RedshiftRetryOptions)
- rddProcessingConfiguration :: Lens' RedshiftDestinationDescription (Maybe ProcessingConfiguration)
- rddRoleARN :: Lens' RedshiftDestinationDescription Text
- rddClusterJDBCURL :: Lens' RedshiftDestinationDescription Text
- rddCopyCommand :: Lens' RedshiftDestinationDescription CopyCommand
- rddUsername :: Lens' RedshiftDestinationDescription Text
- rddS3DestinationDescription :: Lens' RedshiftDestinationDescription S3DestinationDescription
- data RedshiftDestinationUpdate
- redshiftDestinationUpdate :: RedshiftDestinationUpdate
- rduS3BackupMode :: Lens' RedshiftDestinationUpdate (Maybe RedshiftS3BackupMode)
- rduCloudWatchLoggingOptions :: Lens' RedshiftDestinationUpdate (Maybe CloudWatchLoggingOptions)
- rduUsername :: Lens' RedshiftDestinationUpdate (Maybe Text)
- rduS3Update :: Lens' RedshiftDestinationUpdate (Maybe S3DestinationUpdate)
- rduPassword :: Lens' RedshiftDestinationUpdate (Maybe Text)
- rduS3BackupUpdate :: Lens' RedshiftDestinationUpdate (Maybe S3DestinationUpdate)
- rduCopyCommand :: Lens' RedshiftDestinationUpdate (Maybe CopyCommand)
- rduRetryOptions :: Lens' RedshiftDestinationUpdate (Maybe RedshiftRetryOptions)
- rduProcessingConfiguration :: Lens' RedshiftDestinationUpdate (Maybe ProcessingConfiguration)
- rduClusterJDBCURL :: Lens' RedshiftDestinationUpdate (Maybe Text)
- rduRoleARN :: Lens' RedshiftDestinationUpdate (Maybe Text)
- data RedshiftRetryOptions
- redshiftRetryOptions :: RedshiftRetryOptions
- rroDurationInSeconds :: Lens' RedshiftRetryOptions (Maybe Natural)
- data S3DestinationConfiguration
- s3DestinationConfiguration :: Text -> Text -> S3DestinationConfiguration
- sdcPrefix :: Lens' S3DestinationConfiguration (Maybe Text)
- sdcCloudWatchLoggingOptions :: Lens' S3DestinationConfiguration (Maybe CloudWatchLoggingOptions)
- sdcEncryptionConfiguration :: Lens' S3DestinationConfiguration (Maybe EncryptionConfiguration)
- sdcCompressionFormat :: Lens' S3DestinationConfiguration (Maybe CompressionFormat)
- sdcBufferingHints :: Lens' S3DestinationConfiguration (Maybe BufferingHints)
- sdcRoleARN :: Lens' S3DestinationConfiguration Text
- sdcBucketARN :: Lens' S3DestinationConfiguration Text
- data S3DestinationDescription
- s3DestinationDescription :: Text -> Text -> BufferingHints -> CompressionFormat -> EncryptionConfiguration -> S3DestinationDescription
- s3Prefix :: Lens' S3DestinationDescription (Maybe Text)
- s3CloudWatchLoggingOptions :: Lens' S3DestinationDescription (Maybe CloudWatchLoggingOptions)
- s3RoleARN :: Lens' S3DestinationDescription Text
- s3BucketARN :: Lens' S3DestinationDescription Text
- s3BufferingHints :: Lens' S3DestinationDescription BufferingHints
- s3CompressionFormat :: Lens' S3DestinationDescription CompressionFormat
- s3EncryptionConfiguration :: Lens' S3DestinationDescription EncryptionConfiguration
- data S3DestinationUpdate
- s3DestinationUpdate :: S3DestinationUpdate
- sPrefix :: Lens' S3DestinationUpdate (Maybe Text)
- sCloudWatchLoggingOptions :: Lens' S3DestinationUpdate (Maybe CloudWatchLoggingOptions)
- sEncryptionConfiguration :: Lens' S3DestinationUpdate (Maybe EncryptionConfiguration)
- sCompressionFormat :: Lens' S3DestinationUpdate (Maybe CompressionFormat)
- sBufferingHints :: Lens' S3DestinationUpdate (Maybe BufferingHints)
- sBucketARN :: Lens' S3DestinationUpdate (Maybe Text)
- sRoleARN :: Lens' S3DestinationUpdate (Maybe Text)
- data SchemaConfiguration
- schemaConfiguration :: SchemaConfiguration
- scVersionId :: Lens' SchemaConfiguration (Maybe Text)
- scCatalogId :: Lens' SchemaConfiguration (Maybe Text)
- scDatabaseName :: Lens' SchemaConfiguration (Maybe Text)
- scRegion :: Lens' SchemaConfiguration (Maybe Text)
- scTableName :: Lens' SchemaConfiguration (Maybe Text)
- scRoleARN :: Lens' SchemaConfiguration (Maybe Text)
- data Serializer
- serializer :: Serializer
- sOrcSerDe :: Lens' Serializer (Maybe OrcSerDe)
- sParquetSerDe :: Lens' Serializer (Maybe ParquetSerDe)
- data SourceDescription
- sourceDescription :: SourceDescription
- sdKinesisStreamSourceDescription :: Lens' SourceDescription (Maybe KinesisStreamSourceDescription)
- data SplunkDestinationConfiguration
- splunkDestinationConfiguration :: Text -> HECEndpointType -> Text -> S3DestinationConfiguration -> SplunkDestinationConfiguration
- splS3BackupMode :: Lens' SplunkDestinationConfiguration (Maybe SplunkS3BackupMode)
- splCloudWatchLoggingOptions :: Lens' SplunkDestinationConfiguration (Maybe CloudWatchLoggingOptions)
- splHECAcknowledgmentTimeoutInSeconds :: Lens' SplunkDestinationConfiguration (Maybe Natural)
- splRetryOptions :: Lens' SplunkDestinationConfiguration (Maybe SplunkRetryOptions)
- splProcessingConfiguration :: Lens' SplunkDestinationConfiguration (Maybe ProcessingConfiguration)
- splHECEndpoint :: Lens' SplunkDestinationConfiguration Text
- splHECEndpointType :: Lens' SplunkDestinationConfiguration HECEndpointType
- splHECToken :: Lens' SplunkDestinationConfiguration Text
- splS3Configuration :: Lens' SplunkDestinationConfiguration S3DestinationConfiguration
- data SplunkDestinationDescription
- splunkDestinationDescription :: SplunkDestinationDescription
- sddS3BackupMode :: Lens' SplunkDestinationDescription (Maybe SplunkS3BackupMode)
- sddHECToken :: Lens' SplunkDestinationDescription (Maybe Text)
- sddHECEndpointType :: Lens' SplunkDestinationDescription (Maybe HECEndpointType)
- sddCloudWatchLoggingOptions :: Lens' SplunkDestinationDescription (Maybe CloudWatchLoggingOptions)
- sddHECAcknowledgmentTimeoutInSeconds :: Lens' SplunkDestinationDescription (Maybe Natural)
- sddS3DestinationDescription :: Lens' SplunkDestinationDescription (Maybe S3DestinationDescription)
- sddHECEndpoint :: Lens' SplunkDestinationDescription (Maybe Text)
- sddRetryOptions :: Lens' SplunkDestinationDescription (Maybe SplunkRetryOptions)
- sddProcessingConfiguration :: Lens' SplunkDestinationDescription (Maybe ProcessingConfiguration)
- data SplunkDestinationUpdate
- splunkDestinationUpdate :: SplunkDestinationUpdate
- sduS3BackupMode :: Lens' SplunkDestinationUpdate (Maybe SplunkS3BackupMode)
- sduHECToken :: Lens' SplunkDestinationUpdate (Maybe Text)
- sduHECEndpointType :: Lens' SplunkDestinationUpdate (Maybe HECEndpointType)
- sduCloudWatchLoggingOptions :: Lens' SplunkDestinationUpdate (Maybe CloudWatchLoggingOptions)
- sduHECAcknowledgmentTimeoutInSeconds :: Lens' SplunkDestinationUpdate (Maybe Natural)
- sduS3Update :: Lens' SplunkDestinationUpdate (Maybe S3DestinationUpdate)
- sduHECEndpoint :: Lens' SplunkDestinationUpdate (Maybe Text)
- sduRetryOptions :: Lens' SplunkDestinationUpdate (Maybe SplunkRetryOptions)
- sduProcessingConfiguration :: Lens' SplunkDestinationUpdate (Maybe ProcessingConfiguration)
- data SplunkRetryOptions
- splunkRetryOptions :: SplunkRetryOptions
- sroDurationInSeconds :: Lens' SplunkRetryOptions (Maybe Natural)
- data Tag
- tag :: Text -> Tag
- tagValue :: Lens' Tag (Maybe Text)
- tagKey :: Lens' Tag Text
Service Configuration
API version 2015-08-04 of the Amazon Kinesis Firehose SDK configuration.
Errors
Error matchers are designed for use with the functions provided by
Control.Exception.Lens.
This allows catching (and rethrowing) service specific errors returned
by Firehose.
InvalidArgumentException
_InvalidArgumentException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified input parameter has a value that is not valid.
ConcurrentModificationException
_ConcurrentModificationException :: AsError a => Getting (First ServiceError) a ServiceError Source #
Another modification has already happened. Fetch VersionId again and use it to update the destination.
ServiceUnavailableException
_ServiceUnavailableException :: AsError a => Getting (First ServiceError) 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 .
ResourceNotFoundException
_ResourceNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified resource could not be found.
LimitExceededException
_LimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError Source #
You have already reached the limit for a requested resource.
ResourceInUseException
_ResourceInUseException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The resource is already in use and not available for this operation.
Waiters
Waiters poll by repeatedly sending a request until some remote success condition
configured by the Wait specification is fulfilled. The Wait specification
determines how many attempts should be made, in addition to delay and retry strategies.
Operations
Some AWS operations return results that are incomplete and require subsequent
requests in order to obtain the entire result set. The process of sending
subsequent requests to continue where a previous request left off is called
pagination. For example, the ListObjects operation of Amazon S3 returns up to
1000 objects at a time, and you must send subsequent requests with the
appropriate Marker in order to retrieve the next page of results.
Operations that have an AWSPager instance can transparently perform subsequent
requests, correctly setting Markers and other request facets to iterate through
the entire result set of a truncated API operation. Operations which support
this have an additional note in the documentation.
Many operations have the ability to filter results on the server side. See the individual operation parameters for details.
PutRecord
TagDeliveryStream
UpdateDestination
PutRecordBatch
UntagDeliveryStream
CreateDeliveryStream
DescribeDeliveryStream
ListTagsForDeliveryStream
ListDeliveryStreams
DeleteDeliveryStream
Types
CompressionFormat
data CompressionFormat Source #
Constructors
| Gzip | |
| Snappy | |
| Uncompressed | |
| Zip |
Instances
DeliveryStreamStatus
data DeliveryStreamStatus Source #
Instances
DeliveryStreamType
data DeliveryStreamType Source #
Constructors
| DirectPut | |
| KinesisStreamAsSource |
Instances
ElasticsearchIndexRotationPeriod
data ElasticsearchIndexRotationPeriod Source #
Constructors
| NoRotation | |
| OneDay | |
| OneHour | |
| OneMonth | |
| OneWeek |
Instances
ElasticsearchS3BackupMode
data ElasticsearchS3BackupMode Source #
Constructors
| AllDocuments | |
| FailedDocumentsOnly |
Instances
HECEndpointType
data HECEndpointType Source #
Instances
NoEncryptionConfig
data NoEncryptionConfig Source #
Constructors
| NoEncryption |
Instances
OrcCompression
data OrcCompression Source #
Instances
OrcFormatVersion
data OrcFormatVersion Source #
Instances
ParquetCompression
data ParquetCompression Source #
Constructors
| PCGzip | |
| PCSnappy | |
| PCUncompressed |
Instances
ParquetWriterVersion
data ParquetWriterVersion Source #
Instances
ProcessorParameterName
data ProcessorParameterName Source #
Instances
ProcessorType
data ProcessorType Source #
Constructors
| Lambda |
Instances
RedshiftS3BackupMode
data RedshiftS3BackupMode Source #
Instances
S3BackupMode
data S3BackupMode Source #
Constructors
| SBMDisabled | |
| SBMEnabled |
Instances
SplunkS3BackupMode
data SplunkS3BackupMode Source #
Constructors
| AllEvents | |
| FailedEventsOnly |
Instances
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.
See: bufferingHints smart constructor.
Instances
bufferingHints :: BufferingHints Source #
Creates a value of BufferingHints with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
bhSizeInMBs- 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.bhIntervalInSeconds- Buffer incoming data for the specified period of time, in seconds, before delivering it to the destination. The default value is 300.
bhSizeInMBs :: Lens' BufferingHints (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.
bhIntervalInSeconds :: 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.
CloudWatchLoggingOptions
data CloudWatchLoggingOptions Source #
Describes the Amazon CloudWatch logging options for your delivery stream.
See: cloudWatchLoggingOptions smart constructor.
Instances
cloudWatchLoggingOptions :: CloudWatchLoggingOptions Source #
Creates a value of CloudWatchLoggingOptions with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
cwloEnabled- Enables or disables CloudWatch logging.cwloLogGroupName- The CloudWatch group name for logging. This value is required if CloudWatch logging is enabled.cwloLogStreamName- The CloudWatch log stream name for logging. This value is required if CloudWatch logging is enabled.
cwloEnabled :: Lens' CloudWatchLoggingOptions (Maybe Bool) Source #
Enables or disables CloudWatch logging.
cwloLogGroupName :: Lens' CloudWatchLoggingOptions (Maybe Text) Source #
The CloudWatch group name for logging. This value is required if CloudWatch logging is enabled.
cwloLogStreamName :: 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: copyCommand smart constructor.
Arguments
| :: Text | |
| -> CopyCommand |
Creates a value of CopyCommand with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ccCopyOptions- Optional parameters to use with the Amazon RedshiftCOPYcommand. 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 .ccDataTableColumns- A comma-separated list of column names.ccDataTableName- The name of the target table. The table must already exist in the database.
ccCopyOptions :: 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 .
ccDataTableColumns :: Lens' CopyCommand (Maybe Text) Source #
A comma-separated list of column names.
ccDataTableName :: 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 AWS 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: dataFormatConversionConfiguration smart constructor.
Instances
dataFormatConversionConfiguration :: DataFormatConversionConfiguration Source #
Creates a value of DataFormatConversionConfiguration with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
dfccOutputFormatConfiguration- Specifies the serializer that you want Kinesis Data Firehose to use to convert the format of your data to the Parquet or ORC format.dfccEnabled- Defaults totrue. Set it tofalseif you want to disable format conversion while preserving the configuration details.dfccSchemaConfiguration- Specifies the AWS Glue Data Catalog table that contains the column information.dfccInputFormatConfiguration- Specifies the deserializer that you want Kinesis Data Firehose to use to convert the format of your data from JSON.
dfccOutputFormatConfiguration :: 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.
dfccEnabled :: Lens' DataFormatConversionConfiguration (Maybe Bool) Source #
Defaults to true . Set it to false if you want to disable format conversion while preserving the configuration details.
dfccSchemaConfiguration :: Lens' DataFormatConversionConfiguration (Maybe SchemaConfiguration) Source #
Specifies the AWS Glue Data Catalog table that contains the column information.
dfccInputFormatConfiguration :: 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.
DeliveryStreamDescription
data DeliveryStreamDescription Source #
Contains information about a delivery stream.
See: deliveryStreamDescription smart constructor.
Instances
deliveryStreamDescription Source #
Arguments
| :: Text | |
| -> Text | |
| -> DeliveryStreamStatus | |
| -> DeliveryStreamType | |
| -> Text | |
| -> Bool | |
| -> DeliveryStreamDescription |
Creates a value of DeliveryStreamDescription with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
dsdCreateTimestamp- The date and time that the delivery stream was created.dsdSource- If theDeliveryStreamTypeparameter isKinesisStreamAsSource, aSourceDescriptionobject describing the source Kinesis data stream.dsdLastUpdateTimestamp- The date and time that the delivery stream was last updated.dsdDeliveryStreamName- The name of the delivery stream.dsdDeliveryStreamARN- The Amazon Resource Name (ARN) of the delivery stream. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces .dsdDeliveryStreamStatus- The status of the delivery stream.dsdDeliveryStreamType- 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.dsdVersionId- 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.dsdDestinations- The destinations.dsdHasMoreDestinations- Indicates whether there are more destinations available to list.
dsdCreateTimestamp :: Lens' DeliveryStreamDescription (Maybe UTCTime) Source #
The date and time that the delivery stream was created.
dsdSource :: Lens' DeliveryStreamDescription (Maybe SourceDescription) Source #
If the DeliveryStreamType parameter is KinesisStreamAsSource , a SourceDescription object describing the source Kinesis data stream.
dsdLastUpdateTimestamp :: Lens' DeliveryStreamDescription (Maybe UTCTime) Source #
The date and time that the delivery stream was last updated.
dsdDeliveryStreamName :: Lens' DeliveryStreamDescription Text Source #
The name of the delivery stream.
dsdDeliveryStreamARN :: Lens' DeliveryStreamDescription Text Source #
The Amazon Resource Name (ARN) of the delivery stream. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces .
dsdDeliveryStreamStatus :: Lens' DeliveryStreamDescription DeliveryStreamStatus Source #
The status of the delivery stream.
dsdDeliveryStreamType :: 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.
dsdVersionId :: 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.
dsdDestinations :: Lens' DeliveryStreamDescription [DestinationDescription] Source #
The destinations.
dsdHasMoreDestinations :: Lens' DeliveryStreamDescription Bool Source #
Indicates whether there are more destinations available to list.
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: deserializer smart constructor.
deserializer :: Deserializer Source #
Creates a value of Deserializer with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
dOpenXJSONSerDe- 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.dHiveJSONSerDe- 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.
dOpenXJSONSerDe :: 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.
dHiveJSONSerDe :: 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.
DestinationDescription
data DestinationDescription Source #
Describes the destination for a delivery stream.
See: destinationDescription smart constructor.
Instances
destinationDescription Source #
Arguments
| :: Text | |
| -> DestinationDescription |
Creates a value of DestinationDescription with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ddSplunkDestinationDescription- The destination in Splunk.ddS3DestinationDescription- [Deprecated] The destination in Amazon S3.ddExtendedS3DestinationDescription- The destination in Amazon S3.ddElasticsearchDestinationDescription- The destination in Amazon ES.ddRedshiftDestinationDescription- The destination in Amazon Redshift.ddDestinationId- The ID of the destination.
ddSplunkDestinationDescription :: Lens' DestinationDescription (Maybe SplunkDestinationDescription) Source #
The destination in Splunk.
ddS3DestinationDescription :: Lens' DestinationDescription (Maybe S3DestinationDescription) Source #
- Deprecated
- The destination in Amazon S3.
ddExtendedS3DestinationDescription :: Lens' DestinationDescription (Maybe ExtendedS3DestinationDescription) Source #
The destination in Amazon S3.
ddElasticsearchDestinationDescription :: Lens' DestinationDescription (Maybe ElasticsearchDestinationDescription) Source #
The destination in Amazon ES.
ddRedshiftDestinationDescription :: Lens' DestinationDescription (Maybe RedshiftDestinationDescription) Source #
The destination in Amazon Redshift.
ddDestinationId :: Lens' DestinationDescription Text Source #
The ID of the destination.
ElasticsearchBufferingHints
data ElasticsearchBufferingHints Source #
Describes the buffering to perform before delivering data to the Amazon ES destination.
See: elasticsearchBufferingHints smart constructor.
Instances
elasticsearchBufferingHints :: ElasticsearchBufferingHints Source #
Creates a value of ElasticsearchBufferingHints with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ebhSizeInMBs- 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.ebhIntervalInSeconds- Buffer incoming data for the specified period of time, in seconds, before delivering it to the destination. The default value is 300 (5 minutes).
ebhSizeInMBs :: 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.
ebhIntervalInSeconds :: 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).
ElasticsearchDestinationConfiguration
data ElasticsearchDestinationConfiguration Source #
Describes the configuration of a destination in Amazon ES.
See: elasticsearchDestinationConfiguration smart constructor.
Instances
elasticsearchDestinationConfiguration Source #
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> Text | |
| -> S3DestinationConfiguration | |
| -> ElasticsearchDestinationConfiguration |
Creates a value of ElasticsearchDestinationConfiguration with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
edcIndexRotationPeriod- The Elasticsearch index rotation period. Index rotation appends a time stamp to theIndexNameto facilitate the expiration of old data. For more information, see Index Rotation for the Amazon ES Destination . The default value isOneDay.edcS3BackupMode- Defines how documents should be delivered to Amazon S3. When it is set toFailedDocumentsOnly, Kinesis Data Firehose writes any documents that could not be indexed to the configured Amazon S3 destination, withelasticsearch-failed/appended to the key prefix. When set toAllDocuments, Kinesis Data Firehose delivers all incoming records to Amazon S3, and also writes failed documents withelasticsearch-failed/appended to the prefix. For more information, see Amazon S3 Backup for the Amazon ES Destination . Default value isFailedDocumentsOnly.edcCloudWatchLoggingOptions- The Amazon CloudWatch logging options for your delivery stream.edcBufferingHints- The buffering options. If no value is specified, the default values forElasticsearchBufferingHintsare used.edcRetryOptions- The retry behavior in case Kinesis Data Firehose is unable to deliver documents to Amazon ES. The default value is 300 (5 minutes).edcProcessingConfiguration- The data processing configuration.edcRoleARN- 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 AWS Service Namespaces .edcDomainARN- The ARN of the Amazon ES domain. The IAM role must have permissions forDescribeElasticsearchDomain,DescribeElasticsearchDomains, andDescribeElasticsearchDomainConfigafter assuming the role specified in RoleARN . For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces .edcIndexName- The Elasticsearch index name.edcTypeName- 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.edcS3Configuration- The configuration for the backup Amazon S3 location.
edcIndexRotationPeriod :: Lens' ElasticsearchDestinationConfiguration (Maybe ElasticsearchIndexRotationPeriod) Source #
The Elasticsearch index rotation period. Index rotation appends a time stamp 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 .
edcS3BackupMode :: 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 elasticsearch-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 elasticsearch-failed/ appended to the prefix. For more information, see Amazon S3 Backup for the Amazon ES Destination . Default value is FailedDocumentsOnly .
edcCloudWatchLoggingOptions :: Lens' ElasticsearchDestinationConfiguration (Maybe CloudWatchLoggingOptions) Source #
The Amazon CloudWatch logging options for your delivery stream.
edcBufferingHints :: Lens' ElasticsearchDestinationConfiguration (Maybe ElasticsearchBufferingHints) Source #
The buffering options. If no value is specified, the default values for ElasticsearchBufferingHints are used.
edcRetryOptions :: 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).
edcProcessingConfiguration :: Lens' ElasticsearchDestinationConfiguration (Maybe ProcessingConfiguration) Source #
The data processing configuration.
edcRoleARN :: 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 AWS Service Namespaces .
edcDomainARN :: Lens' ElasticsearchDestinationConfiguration Text Source #
The ARN of the Amazon ES domain. The IAM role must have permissions for DescribeElasticsearchDomain , DescribeElasticsearchDomains , and DescribeElasticsearchDomainConfig after assuming the role specified in RoleARN . For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces .
edcIndexName :: Lens' ElasticsearchDestinationConfiguration Text Source #
The Elasticsearch index name.
edcTypeName :: Lens' ElasticsearchDestinationConfiguration 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.
edcS3Configuration :: Lens' ElasticsearchDestinationConfiguration S3DestinationConfiguration Source #
The configuration for the backup Amazon S3 location.
ElasticsearchDestinationDescription
data ElasticsearchDestinationDescription Source #
The destination description in Amazon ES.
See: elasticsearchDestinationDescription smart constructor.
Instances
elasticsearchDestinationDescription :: ElasticsearchDestinationDescription Source #
Creates a value of ElasticsearchDestinationDescription with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
eddIndexRotationPeriod- The Elasticsearch index rotation periodeddTypeName- The Elasticsearch type name.eddS3BackupMode- The Amazon S3 backup mode.eddDomainARN- The ARN of the Amazon ES domain. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces .eddCloudWatchLoggingOptions- The Amazon CloudWatch logging options.eddS3DestinationDescription- The Amazon S3 destination.eddBufferingHints- The buffering options.eddRetryOptions- The Amazon ES retry options.eddProcessingConfiguration- The data processing configuration.eddRoleARN- The Amazon Resource Name (ARN) of the AWS credentials. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces .eddIndexName- The Elasticsearch index name.
eddIndexRotationPeriod :: Lens' ElasticsearchDestinationDescription (Maybe ElasticsearchIndexRotationPeriod) Source #
The Elasticsearch index rotation period
eddTypeName :: Lens' ElasticsearchDestinationDescription (Maybe Text) Source #
The Elasticsearch type name.
eddS3BackupMode :: Lens' ElasticsearchDestinationDescription (Maybe ElasticsearchS3BackupMode) Source #
The Amazon S3 backup mode.
eddDomainARN :: Lens' ElasticsearchDestinationDescription (Maybe Text) Source #
The ARN of the Amazon ES domain. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces .
eddCloudWatchLoggingOptions :: Lens' ElasticsearchDestinationDescription (Maybe CloudWatchLoggingOptions) Source #
The Amazon CloudWatch logging options.
eddS3DestinationDescription :: Lens' ElasticsearchDestinationDescription (Maybe S3DestinationDescription) Source #
The Amazon S3 destination.
eddBufferingHints :: Lens' ElasticsearchDestinationDescription (Maybe ElasticsearchBufferingHints) Source #
The buffering options.
eddRetryOptions :: Lens' ElasticsearchDestinationDescription (Maybe ElasticsearchRetryOptions) Source #
The Amazon ES retry options.
eddProcessingConfiguration :: Lens' ElasticsearchDestinationDescription (Maybe ProcessingConfiguration) Source #
The data processing configuration.
eddRoleARN :: Lens' ElasticsearchDestinationDescription (Maybe Text) Source #
The Amazon Resource Name (ARN) of the AWS credentials. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces .
eddIndexName :: Lens' ElasticsearchDestinationDescription (Maybe Text) Source #
The Elasticsearch index name.
ElasticsearchDestinationUpdate
data ElasticsearchDestinationUpdate Source #
Describes an update for a destination in Amazon ES.
See: elasticsearchDestinationUpdate smart constructor.
Instances
elasticsearchDestinationUpdate :: ElasticsearchDestinationUpdate Source #
Creates a value of ElasticsearchDestinationUpdate with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
eduIndexRotationPeriod- The Elasticsearch index rotation period. Index rotation appends a time stamp toIndexNameto facilitate the expiration of old data. For more information, see Index Rotation for the Amazon ES Destination . Default value isOneDay.eduTypeName- 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.eduDomainARN- The ARN of the Amazon ES domain. The IAM role must have permissions forDescribeElasticsearchDomain,DescribeElasticsearchDomains, andDescribeElasticsearchDomainConfigafter assuming the IAM role specified in RoleARN . For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces .eduCloudWatchLoggingOptions- The CloudWatch logging options for your delivery stream.eduS3Update- The Amazon S3 destination.eduBufferingHints- The buffering options. If no value is specified, ElasticsearchBufferingHints object default values are used.eduRetryOptions- The retry behavior in case Kinesis Data Firehose is unable to deliver documents to Amazon ES. The default value is 300 (5 minutes).eduProcessingConfiguration- The data processing configuration.eduRoleARN- 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 AWS Service Namespaces .eduIndexName- The Elasticsearch index name.
eduIndexRotationPeriod :: Lens' ElasticsearchDestinationUpdate (Maybe ElasticsearchIndexRotationPeriod) Source #
The Elasticsearch index rotation period. Index rotation appends a time stamp to IndexName to facilitate the expiration of old data. For more information, see Index Rotation for the Amazon ES Destination . Default value is OneDay .
eduTypeName :: 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.
eduDomainARN :: Lens' ElasticsearchDestinationUpdate (Maybe Text) Source #
The ARN of the Amazon ES domain. The IAM role must have permissions for DescribeElasticsearchDomain , DescribeElasticsearchDomains , and DescribeElasticsearchDomainConfig after assuming the IAM role specified in RoleARN . For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces .
eduCloudWatchLoggingOptions :: Lens' ElasticsearchDestinationUpdate (Maybe CloudWatchLoggingOptions) Source #
The CloudWatch logging options for your delivery stream.
eduS3Update :: Lens' ElasticsearchDestinationUpdate (Maybe S3DestinationUpdate) Source #
The Amazon S3 destination.
eduBufferingHints :: Lens' ElasticsearchDestinationUpdate (Maybe ElasticsearchBufferingHints) Source #
The buffering options. If no value is specified, ElasticsearchBufferingHints object default values are used.
eduRetryOptions :: 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).
eduProcessingConfiguration :: Lens' ElasticsearchDestinationUpdate (Maybe ProcessingConfiguration) Source #
The data processing configuration.
eduRoleARN :: 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 AWS Service Namespaces .
eduIndexName :: Lens' ElasticsearchDestinationUpdate (Maybe Text) Source #
The Elasticsearch index name.
ElasticsearchRetryOptions
data ElasticsearchRetryOptions Source #
Configures retry behavior in case Kinesis Data Firehose is unable to deliver documents to Amazon ES.
See: elasticsearchRetryOptions smart constructor.
Instances
elasticsearchRetryOptions :: ElasticsearchRetryOptions Source #
Creates a value of ElasticsearchRetryOptions with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
eroDurationInSeconds- 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.
eroDurationInSeconds :: 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: encryptionConfiguration smart constructor.
Instances
encryptionConfiguration :: EncryptionConfiguration Source #
Creates a value of EncryptionConfiguration with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ecNoEncryptionConfig- Specifically override existing encryption information to ensure that no encryption is used.ecKMSEncryptionConfig- The encryption key.
ecNoEncryptionConfig :: Lens' EncryptionConfiguration (Maybe NoEncryptionConfig) Source #
Specifically override existing encryption information to ensure that no encryption is used.
ecKMSEncryptionConfig :: Lens' EncryptionConfiguration (Maybe KMSEncryptionConfig) Source #
The encryption key.
ExtendedS3DestinationConfiguration
data ExtendedS3DestinationConfiguration Source #
Describes the configuration of a destination in Amazon S3.
See: extendedS3DestinationConfiguration smart constructor.
Instances
extendedS3DestinationConfiguration Source #
Arguments
| :: Text | |
| -> Text | |
| -> ExtendedS3DestinationConfiguration |
Creates a value of ExtendedS3DestinationConfiguration with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
esdcS3BackupMode- The Amazon S3 backup mode.esdcPrefix- The "YYYYMMDDHH" time format prefix is automatically used for delivered Amazon S3 files. You can specify an extra prefix to be added in front of the time format prefix. If the prefix ends with a slash, it appears as a folder in the S3 bucket. For more information, see <http:docs.aws.amazon.comfirehoselatestdevbasic-deliver.html#s3-object-name Amazon S3 Object Name Format> in the Amazon Kinesis Data Firehose Developer Guide/ .esdcCloudWatchLoggingOptions- The Amazon CloudWatch logging options for your delivery stream.esdcS3BackupConfiguration- The configuration for backup in Amazon S3.esdcEncryptionConfiguration- The encryption configuration. If no value is specified, the default is no encryption.esdcCompressionFormat- The compression format. If no value is specified, the default is UNCOMPRESSED.esdcBufferingHints- The buffering option.esdcDataFormatConversionConfiguration- The serializer, deserializer, and schema for converting data from the JSON format to the Parquet or ORC format before writing it to Amazon S3.esdcProcessingConfiguration- The data processing configuration.esdcRoleARN- The Amazon Resource Name (ARN) of the AWS credentials. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces .esdcBucketARN- The ARN of the S3 bucket. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces .
esdcS3BackupMode :: Lens' ExtendedS3DestinationConfiguration (Maybe S3BackupMode) Source #
The Amazon S3 backup mode.
esdcPrefix :: Lens' ExtendedS3DestinationConfiguration (Maybe Text) Source #
The "YYYYMMDDHH" time format prefix is automatically used for delivered Amazon S3 files. You can specify an extra prefix to be added in front of the time format prefix. If the prefix ends with a slash, it appears as a folder in the S3 bucket. For more information, see <http:docs.aws.amazon.comfirehoselatestdevbasic-deliver.html#s3-object-name Amazon S3 Object Name Format> in the Amazon Kinesis Data Firehose Developer Guide/ .
esdcCloudWatchLoggingOptions :: Lens' ExtendedS3DestinationConfiguration (Maybe CloudWatchLoggingOptions) Source #
The Amazon CloudWatch logging options for your delivery stream.
esdcS3BackupConfiguration :: Lens' ExtendedS3DestinationConfiguration (Maybe S3DestinationConfiguration) Source #
The configuration for backup in Amazon S3.
esdcEncryptionConfiguration :: Lens' ExtendedS3DestinationConfiguration (Maybe EncryptionConfiguration) Source #
The encryption configuration. If no value is specified, the default is no encryption.
esdcCompressionFormat :: Lens' ExtendedS3DestinationConfiguration (Maybe CompressionFormat) Source #
The compression format. If no value is specified, the default is UNCOMPRESSED.
esdcBufferingHints :: Lens' ExtendedS3DestinationConfiguration (Maybe BufferingHints) Source #
The buffering option.
esdcDataFormatConversionConfiguration :: 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.
esdcProcessingConfiguration :: Lens' ExtendedS3DestinationConfiguration (Maybe ProcessingConfiguration) Source #
The data processing configuration.
esdcRoleARN :: Lens' ExtendedS3DestinationConfiguration Text Source #
The Amazon Resource Name (ARN) of the AWS credentials. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces .
esdcBucketARN :: Lens' ExtendedS3DestinationConfiguration Text Source #
The ARN of the S3 bucket. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces .
ExtendedS3DestinationDescription
data ExtendedS3DestinationDescription Source #
Describes a destination in Amazon S3.
See: extendedS3DestinationDescription smart constructor.
Instances
extendedS3DestinationDescription Source #
Arguments
| :: Text | |
| -> Text | |
| -> BufferingHints | |
| -> CompressionFormat | |
| -> EncryptionConfiguration | |
| -> ExtendedS3DestinationDescription |
Creates a value of ExtendedS3DestinationDescription with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
esddS3BackupMode- The Amazon S3 backup mode.esddS3BackupDescription- The configuration for backup in Amazon S3.esddPrefix- The "YYYYMMDDHH" time format prefix is automatically used for delivered Amazon S3 files. You can specify an extra prefix to be added in front of the time format prefix. If the prefix ends with a slash, it appears as a folder in the S3 bucket. For more information, see <http:docs.aws.amazon.comfirehoselatestdevbasic-deliver.html#s3-object-name Amazon S3 Object Name Format> in the Amazon Kinesis Data Firehose Developer Guide/ .esddCloudWatchLoggingOptions- The Amazon CloudWatch logging options for your delivery stream.esddDataFormatConversionConfiguration- The serializer, deserializer, and schema for converting data from the JSON format to the Parquet or ORC format before writing it to Amazon S3.esddProcessingConfiguration- The data processing configuration.esddRoleARN- The Amazon Resource Name (ARN) of the AWS credentials. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces .esddBucketARN- The ARN of the S3 bucket. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces .esddBufferingHints- The buffering option.esddCompressionFormat- The compression format. If no value is specified, the default isUNCOMPRESSED.esddEncryptionConfiguration- The encryption configuration. If no value is specified, the default is no encryption.
esddS3BackupMode :: Lens' ExtendedS3DestinationDescription (Maybe S3BackupMode) Source #
The Amazon S3 backup mode.
esddS3BackupDescription :: Lens' ExtendedS3DestinationDescription (Maybe S3DestinationDescription) Source #
The configuration for backup in Amazon S3.
esddPrefix :: Lens' ExtendedS3DestinationDescription (Maybe Text) Source #
The "YYYYMMDDHH" time format prefix is automatically used for delivered Amazon S3 files. You can specify an extra prefix to be added in front of the time format prefix. If the prefix ends with a slash, it appears as a folder in the S3 bucket. For more information, see <http:docs.aws.amazon.comfirehoselatestdevbasic-deliver.html#s3-object-name Amazon S3 Object Name Format> in the Amazon Kinesis Data Firehose Developer Guide/ .
esddCloudWatchLoggingOptions :: Lens' ExtendedS3DestinationDescription (Maybe CloudWatchLoggingOptions) Source #
The Amazon CloudWatch logging options for your delivery stream.
esddDataFormatConversionConfiguration :: 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.
esddProcessingConfiguration :: Lens' ExtendedS3DestinationDescription (Maybe ProcessingConfiguration) Source #
The data processing configuration.
esddRoleARN :: Lens' ExtendedS3DestinationDescription Text Source #
The Amazon Resource Name (ARN) of the AWS credentials. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces .
esddBucketARN :: Lens' ExtendedS3DestinationDescription Text Source #
The ARN of the S3 bucket. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces .
esddBufferingHints :: Lens' ExtendedS3DestinationDescription BufferingHints Source #
The buffering option.
esddCompressionFormat :: Lens' ExtendedS3DestinationDescription CompressionFormat Source #
The compression format. If no value is specified, the default is UNCOMPRESSED .
esddEncryptionConfiguration :: 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: extendedS3DestinationUpdate smart constructor.
Instances
extendedS3DestinationUpdate :: ExtendedS3DestinationUpdate Source #
Creates a value of ExtendedS3DestinationUpdate with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
esduS3BackupMode- Enables or disables Amazon S3 backup mode.esduPrefix- The "YYYYMMDDHH" time format prefix is automatically used for delivered Amazon S3 files. You can specify an extra prefix to be added in front of the time format prefix. If the prefix ends with a slash, it appears as a folder in the S3 bucket. For more information, see <http:docs.aws.amazon.comfirehoselatestdevbasic-deliver.html#s3-object-name Amazon S3 Object Name Format> in the Amazon Kinesis Data Firehose Developer Guide/ .esduCloudWatchLoggingOptions- The Amazon CloudWatch logging options for your delivery stream.esduS3BackupUpdate- The Amazon S3 destination for backup.esduEncryptionConfiguration- The encryption configuration. If no value is specified, the default is no encryption.esduCompressionFormat- The compression format. If no value is specified, the default isUNCOMPRESSED.esduBufferingHints- The buffering option.esduDataFormatConversionConfiguration- The serializer, deserializer, and schema for converting data from the JSON format to the Parquet or ORC format before writing it to Amazon S3.esduBucketARN- The ARN of the S3 bucket. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces .esduProcessingConfiguration- The data processing configuration.esduRoleARN- The Amazon Resource Name (ARN) of the AWS credentials. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces .
esduS3BackupMode :: Lens' ExtendedS3DestinationUpdate (Maybe S3BackupMode) Source #
Enables or disables Amazon S3 backup mode.
esduPrefix :: Lens' ExtendedS3DestinationUpdate (Maybe Text) Source #
The "YYYYMMDDHH" time format prefix is automatically used for delivered Amazon S3 files. You can specify an extra prefix to be added in front of the time format prefix. If the prefix ends with a slash, it appears as a folder in the S3 bucket. For more information, see <http:docs.aws.amazon.comfirehoselatestdevbasic-deliver.html#s3-object-name Amazon S3 Object Name Format> in the Amazon Kinesis Data Firehose Developer Guide/ .
esduCloudWatchLoggingOptions :: Lens' ExtendedS3DestinationUpdate (Maybe CloudWatchLoggingOptions) Source #
The Amazon CloudWatch logging options for your delivery stream.
esduS3BackupUpdate :: Lens' ExtendedS3DestinationUpdate (Maybe S3DestinationUpdate) Source #
The Amazon S3 destination for backup.
esduEncryptionConfiguration :: Lens' ExtendedS3DestinationUpdate (Maybe EncryptionConfiguration) Source #
The encryption configuration. If no value is specified, the default is no encryption.
esduCompressionFormat :: Lens' ExtendedS3DestinationUpdate (Maybe CompressionFormat) Source #
The compression format. If no value is specified, the default is UNCOMPRESSED .
esduBufferingHints :: Lens' ExtendedS3DestinationUpdate (Maybe BufferingHints) Source #
The buffering option.
esduDataFormatConversionConfiguration :: 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.
esduBucketARN :: Lens' ExtendedS3DestinationUpdate (Maybe Text) Source #
The ARN of the S3 bucket. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces .
esduProcessingConfiguration :: Lens' ExtendedS3DestinationUpdate (Maybe ProcessingConfiguration) Source #
The data processing configuration.
esduRoleARN :: Lens' ExtendedS3DestinationUpdate (Maybe Text) Source #
The Amazon Resource Name (ARN) of the AWS credentials. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces .
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: hiveJSONSerDe smart constructor.
Instances
hiveJSONSerDe :: HiveJSONSerDe Source #
Creates a value of HiveJSONSerDe with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
hjsdTimestampFormats- Indicates how you want Kinesis Data Firehose to parse the date and time stamps 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 valuemillisto parse time stamps in epoch milliseconds. If you don't specify a format, Kinesis Data Firehose usesjava.sql.Timestamp::valueOfby default.
hjsdTimestampFormats :: Lens' HiveJSONSerDe [Text] Source #
Indicates how you want Kinesis Data Firehose to parse the date and time stamps 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 time stamps in epoch milliseconds. If you don't specify a format, Kinesis Data Firehose uses java.sql.Timestamp::valueOf by default.
InputFormatConfiguration
data InputFormatConfiguration Source #
Specifies the deserializer you want to use to convert the format of the input data.
See: inputFormatConfiguration smart constructor.
Instances
inputFormatConfiguration :: InputFormatConfiguration Source #
Creates a value of InputFormatConfiguration with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ifcDeserializer- 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.
ifcDeserializer :: 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: kmsEncryptionConfig smart constructor.
Instances
Arguments
| :: Text | |
| -> KMSEncryptionConfig |
Creates a value of KMSEncryptionConfig with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
kecAWSKMSKeyARN- The Amazon Resource Name (ARN) of the encryption key. Must belong to the same AWS Region as the destination Amazon S3 bucket. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces .
kecAWSKMSKeyARN :: Lens' KMSEncryptionConfig Text Source #
The Amazon Resource Name (ARN) of the encryption key. Must belong to the same AWS Region as the destination Amazon S3 bucket. For more information, see Amazon Resource Names (ARNs) and AWS 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: kinesisStreamSourceConfiguration smart constructor.
Instances
kinesisStreamSourceConfiguration Source #
Arguments
| :: Text | |
| -> Text | |
| -> KinesisStreamSourceConfiguration |
Creates a value of KinesisStreamSourceConfiguration with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ksscKinesisStreamARN- The ARN of the source Kinesis data stream. For more information, see Amazon Kinesis Data Streams ARN Format .ksscRoleARN- The ARN of the role that provides access to the source Kinesis data stream. For more information, see AWS Identity and Access Management (IAM) ARN Format .
ksscKinesisStreamARN :: Lens' KinesisStreamSourceConfiguration Text Source #
The ARN of the source Kinesis data stream. For more information, see Amazon Kinesis Data Streams ARN Format .
ksscRoleARN :: Lens' KinesisStreamSourceConfiguration Text Source #
The ARN of the role that provides access to the source Kinesis data stream. For more information, see AWS 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: kinesisStreamSourceDescription smart constructor.
Instances
kinesisStreamSourceDescription :: KinesisStreamSourceDescription Source #
Creates a value of KinesisStreamSourceDescription with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
kssdDeliveryStartTimestamp- Kinesis Data Firehose starts retrieving records from the Kinesis data stream starting with this time stamp.kssdKinesisStreamARN- The Amazon Resource Name (ARN) of the source Kinesis data stream. For more information, see Amazon Kinesis Data Streams ARN Format .kssdRoleARN- The ARN of the role used by the source Kinesis data stream. For more information, see AWS Identity and Access Management (IAM) ARN Format .
kssdDeliveryStartTimestamp :: Lens' KinesisStreamSourceDescription (Maybe UTCTime) Source #
Kinesis Data Firehose starts retrieving records from the Kinesis data stream starting with this time stamp.
kssdKinesisStreamARN :: 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 .
kssdRoleARN :: Lens' KinesisStreamSourceDescription (Maybe Text) Source #
The ARN of the role used by the source Kinesis data stream. For more information, see AWS Identity and Access Management (IAM) 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: openXJSONSerDe smart constructor.
Instances
openXJSONSerDe :: OpenXJSONSerDe Source #
Creates a value of OpenXJSONSerDe with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
oxjsdColumnToJSONKeyMappings- 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,timestampis a Hive keyword. If you have a JSON key namedtimestamp, set this parameter to{"ts": "timestamp"}to map this key to a column namedts.oxjsdCaseInsensitive- When set totrue, which is the default, Kinesis Data Firehose converts JSON keys to lowercase before deserializing them.oxjsdConvertDotsInJSONKeysToUnderscores- When set totrue, 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 isfalse.
oxjsdColumnToJSONKeyMappings :: Lens' OpenXJSONSerDe (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 .
oxjsdCaseInsensitive :: Lens' OpenXJSONSerDe (Maybe Bool) Source #
When set to true , which is the default, Kinesis Data Firehose converts JSON keys to lowercase before deserializing them.
oxjsdConvertDotsInJSONKeysToUnderscores :: 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
A serializer to use for converting data to the ORC format before storing it in Amazon S3. For more information, see Apache ORC .
See: orcSerDe smart constructor.
Creates a value of OrcSerDe with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
osdBloomFilterFalsePositiveProbability- 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.osdDictionaryKeyThreshold- 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.osdEnablePadding- Set this totrueto 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 isfalse.osdCompression- The compression code to use over data blocks. The default isSNAPPY.osdBloomFilterColumns- The column names for which you want Kinesis Data Firehose to create bloom filters. The default isnull.osdRowIndexStride- The number of rows between index entries. The default is 10,000 and the minimum is 1,000.osdFormatVersion- The version of the file to write. The possible values areV0_11andV0_12. The default isV0_12.osdBlockSizeBytes- 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.osdStripeSizeBytes- The number of bytes in each stripe. The default is 64 MiB and the minimum is 8 MiB.osdPaddingTolerance- 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' isfalse.
osdBloomFilterFalsePositiveProbability :: 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.
osdDictionaryKeyThreshold :: 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.
osdEnablePadding :: 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 .
osdCompression :: Lens' OrcSerDe (Maybe OrcCompression) Source #
The compression code to use over data blocks. The default is SNAPPY .
osdBloomFilterColumns :: Lens' OrcSerDe [Text] Source #
The column names for which you want Kinesis Data Firehose to create bloom filters. The default is null .
osdRowIndexStride :: Lens' OrcSerDe (Maybe Natural) Source #
The number of rows between index entries. The default is 10,000 and the minimum is 1,000.
osdFormatVersion :: 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 .
osdBlockSizeBytes :: 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.
osdStripeSizeBytes :: Lens' OrcSerDe (Maybe Natural) Source #
The number of bytes in each stripe. The default is 64 MiB and the minimum is 8 MiB.
osdPaddingTolerance :: 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 .
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.
See: outputFormatConfiguration smart constructor.
Instances
outputFormatConfiguration :: OutputFormatConfiguration Source #
Creates a value of OutputFormatConfiguration with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ofcSerializer- 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.
ofcSerializer :: 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: parquetSerDe smart constructor.
parquetSerDe :: ParquetSerDe Source #
Creates a value of ParquetSerDe with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
psdWriterVersion- Indicates the version of row format to output. The possible values areV1andV2. The default isV1.psdCompression- The compression code to use over data blocks. The possible values areUNCOMPRESSED,SNAPPY, andGZIP, with the default beingSNAPPY. UseSNAPPYfor higher decompression speed. UseGZIPif the compression ration is more important than speed.psdMaxPaddingBytes- 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.psdEnableDictionaryCompression- Indicates whether to enable dictionary compression.psdPageSizeBytes- 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.psdBlockSizeBytes- 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.
psdWriterVersion :: Lens' ParquetSerDe (Maybe ParquetWriterVersion) Source #
Indicates the version of row format to output. The possible values are V1 and V2 . The default is V1 .
psdCompression :: 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 ration is more important than speed.
psdMaxPaddingBytes :: 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.
psdEnableDictionaryCompression :: Lens' ParquetSerDe (Maybe Bool) Source #
Indicates whether to enable dictionary compression.
psdPageSizeBytes :: 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.
psdBlockSizeBytes :: 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.
ProcessingConfiguration
data ProcessingConfiguration Source #
Describes a data processing configuration.
See: processingConfiguration smart constructor.
Instances
processingConfiguration :: ProcessingConfiguration Source #
Creates a value of ProcessingConfiguration with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
pcEnabled- Enables or disables data processing.pcProcessors- The data processors.
pcEnabled :: Lens' ProcessingConfiguration (Maybe Bool) Source #
Enables or disables data processing.
pcProcessors :: Lens' ProcessingConfiguration [Processor] Source #
The data processors.
Processor
Describes a data processor.
See: processor smart constructor.
Arguments
| :: ProcessorType | |
| -> Processor |
Creates a value of Processor with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
pParameters- The processor parameters.pType- The type of processor.
pParameters :: Lens' Processor [ProcessorParameter] Source #
The processor parameters.
ProcessorParameter
data ProcessorParameter Source #
Describes the processor parameter.
See: processorParameter smart constructor.
Instances
Creates a value of ProcessorParameter with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ppParameterName- The name of the parameter.ppParameterValue- The parameter value.
ppParameterName :: Lens' ProcessorParameter ProcessorParameterName Source #
The name of the parameter.
ppParameterValue :: Lens' ProcessorParameter Text Source #
The parameter value.
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: putRecordBatchResponseEntry smart constructor.
Instances
putRecordBatchResponseEntry :: PutRecordBatchResponseEntry Source #
Creates a value of PutRecordBatchResponseEntry with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
prbreRecordId- The ID of the record.prbreErrorCode- The error code for an individual record result.prbreErrorMessage- The error message for an individual record result.
prbreRecordId :: Lens' PutRecordBatchResponseEntry (Maybe Text) Source #
The ID of the record.
prbreErrorCode :: Lens' PutRecordBatchResponseEntry (Maybe Text) Source #
The error code for an individual record result.
prbreErrorMessage :: Lens' PutRecordBatchResponseEntry (Maybe Text) Source #
The error message for an individual record result.
Record
The unit of data in a delivery stream.
See: record smart constructor.
Arguments
| :: ByteString | |
| -> Record |
Creates a value of Record with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
rData- 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 KB.-- Note: ThisLensautomatically encodes and decodes Base64 data. The underlying isomorphism will encode to Base64 representation during serialisation, and decode from Base64 representation during deserialisation. ThisLensaccepts and returns only raw unencoded data.
rData :: 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 KB.-- 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: redshiftDestinationConfiguration smart constructor.
Instances
redshiftDestinationConfiguration Source #
Arguments
| :: Text | |
| -> Text | |
| -> CopyCommand | |
| -> Text | |
| -> Text | |
| -> S3DestinationConfiguration | |
| -> RedshiftDestinationConfiguration |
Creates a value of RedshiftDestinationConfiguration with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
rdcS3BackupMode- The Amazon S3 backup mode.rdcCloudWatchLoggingOptions- The CloudWatch logging options for your delivery stream.rdcS3BackupConfiguration- The configuration for backup in Amazon S3.rdcRetryOptions- The retry behavior in case Kinesis Data Firehose is unable to deliver documents to Amazon Redshift. Default value is 3600 (60 minutes).rdcProcessingConfiguration- The data processing configuration.rdcRoleARN- The Amazon Resource Name (ARN) of the AWS credentials. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces .rdcClusterJDBCURL- The database connection string.rdcCopyCommand- TheCOPYcommand.rdcUsername- The name of the user.rdcPassword- The user password.rdcS3Configuration- The configuration for the intermediate Amazon S3 location from which Amazon Redshift obtains data. Restrictions are described in the topic forCreateDeliveryStream. The compression formatsSNAPPYorZIPcannot be specified inRedshiftDestinationConfiguration.S3Configurationbecause the Amazon RedshiftCOPYoperation that reads from the S3 bucket doesn't support these compression formats.
rdcS3BackupMode :: Lens' RedshiftDestinationConfiguration (Maybe RedshiftS3BackupMode) Source #
The Amazon S3 backup mode.
rdcCloudWatchLoggingOptions :: Lens' RedshiftDestinationConfiguration (Maybe CloudWatchLoggingOptions) Source #
The CloudWatch logging options for your delivery stream.
rdcS3BackupConfiguration :: Lens' RedshiftDestinationConfiguration (Maybe S3DestinationConfiguration) Source #
The configuration for backup in Amazon S3.
rdcRetryOptions :: 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).
rdcProcessingConfiguration :: Lens' RedshiftDestinationConfiguration (Maybe ProcessingConfiguration) Source #
The data processing configuration.
rdcRoleARN :: Lens' RedshiftDestinationConfiguration Text Source #
The Amazon Resource Name (ARN) of the AWS credentials. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces .
rdcClusterJDBCURL :: Lens' RedshiftDestinationConfiguration Text Source #
The database connection string.
rdcCopyCommand :: Lens' RedshiftDestinationConfiguration CopyCommand Source #
The COPY command.
rdcUsername :: Lens' RedshiftDestinationConfiguration Text Source #
The name of the user.
rdcPassword :: Lens' RedshiftDestinationConfiguration Text Source #
The user password.
rdcS3Configuration :: 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: redshiftDestinationDescription smart constructor.
Instances
redshiftDestinationDescription Source #
Arguments
| :: Text | |
| -> Text | |
| -> CopyCommand | |
| -> Text | |
| -> S3DestinationDescription | |
| -> RedshiftDestinationDescription |
Creates a value of RedshiftDestinationDescription with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
rddS3BackupMode- The Amazon S3 backup mode.rddS3BackupDescription- The configuration for backup in Amazon S3.rddCloudWatchLoggingOptions- The Amazon CloudWatch logging options for your delivery stream.rddRetryOptions- The retry behavior in case Kinesis Data Firehose is unable to deliver documents to Amazon Redshift. Default value is 3600 (60 minutes).rddProcessingConfiguration- The data processing configuration.rddRoleARN- The Amazon Resource Name (ARN) of the AWS credentials. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces .rddClusterJDBCURL- The database connection string.rddCopyCommand- TheCOPYcommand.rddUsername- The name of the user.rddS3DestinationDescription- The Amazon S3 destination.
rddS3BackupMode :: Lens' RedshiftDestinationDescription (Maybe RedshiftS3BackupMode) Source #
The Amazon S3 backup mode.
rddS3BackupDescription :: Lens' RedshiftDestinationDescription (Maybe S3DestinationDescription) Source #
The configuration for backup in Amazon S3.
rddCloudWatchLoggingOptions :: Lens' RedshiftDestinationDescription (Maybe CloudWatchLoggingOptions) Source #
The Amazon CloudWatch logging options for your delivery stream.
rddRetryOptions :: 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).
rddProcessingConfiguration :: Lens' RedshiftDestinationDescription (Maybe ProcessingConfiguration) Source #
The data processing configuration.
rddRoleARN :: Lens' RedshiftDestinationDescription Text Source #
The Amazon Resource Name (ARN) of the AWS credentials. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces .
rddClusterJDBCURL :: Lens' RedshiftDestinationDescription Text Source #
The database connection string.
rddCopyCommand :: Lens' RedshiftDestinationDescription CopyCommand Source #
The COPY command.
rddUsername :: Lens' RedshiftDestinationDescription Text Source #
The name of the user.
rddS3DestinationDescription :: Lens' RedshiftDestinationDescription S3DestinationDescription Source #
The Amazon S3 destination.
RedshiftDestinationUpdate
data RedshiftDestinationUpdate Source #
Describes an update for a destination in Amazon Redshift.
See: redshiftDestinationUpdate smart constructor.
Instances
redshiftDestinationUpdate :: RedshiftDestinationUpdate Source #
Creates a value of RedshiftDestinationUpdate with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
rduS3BackupMode- The Amazon S3 backup mode.rduCloudWatchLoggingOptions- The Amazon CloudWatch logging options for your delivery stream.rduUsername- The name of the user.rduS3Update- The Amazon S3 destination. The compression formatsSNAPPYorZIPcannot be specified inRedshiftDestinationUpdate.S3Updatebecause the Amazon RedshiftCOPYoperation that reads from the S3 bucket doesn't support these compression formats.rduPassword- The user password.rduS3BackupUpdate- The Amazon S3 destination for backup.rduCopyCommand- TheCOPYcommand.rduRetryOptions- The retry behavior in case Kinesis Data Firehose is unable to deliver documents to Amazon Redshift. Default value is 3600 (60 minutes).rduProcessingConfiguration- The data processing configuration.rduClusterJDBCURL- The database connection string.rduRoleARN- The Amazon Resource Name (ARN) of the AWS credentials. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces .
rduS3BackupMode :: Lens' RedshiftDestinationUpdate (Maybe RedshiftS3BackupMode) Source #
The Amazon S3 backup mode.
rduCloudWatchLoggingOptions :: Lens' RedshiftDestinationUpdate (Maybe CloudWatchLoggingOptions) Source #
The Amazon CloudWatch logging options for your delivery stream.
rduUsername :: Lens' RedshiftDestinationUpdate (Maybe Text) Source #
The name of the user.
rduS3Update :: 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.
rduPassword :: Lens' RedshiftDestinationUpdate (Maybe Text) Source #
The user password.
rduS3BackupUpdate :: Lens' RedshiftDestinationUpdate (Maybe S3DestinationUpdate) Source #
The Amazon S3 destination for backup.
rduCopyCommand :: Lens' RedshiftDestinationUpdate (Maybe CopyCommand) Source #
The COPY command.
rduRetryOptions :: 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).
rduProcessingConfiguration :: Lens' RedshiftDestinationUpdate (Maybe ProcessingConfiguration) Source #
The data processing configuration.
rduClusterJDBCURL :: Lens' RedshiftDestinationUpdate (Maybe Text) Source #
The database connection string.
rduRoleARN :: Lens' RedshiftDestinationUpdate (Maybe Text) Source #
The Amazon Resource Name (ARN) of the AWS credentials. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces .
RedshiftRetryOptions
data RedshiftRetryOptions Source #
Configures retry behavior in case Kinesis Data Firehose is unable to deliver documents to Amazon Redshift.
See: redshiftRetryOptions smart constructor.
Instances
redshiftRetryOptions :: RedshiftRetryOptions Source #
Creates a value of RedshiftRetryOptions with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
rroDurationInSeconds- 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 ofDurationInSecondsis 0 (zero) or if the first delivery attempt takes longer than the current value.
rroDurationInSeconds :: 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.
S3DestinationConfiguration
data S3DestinationConfiguration Source #
Describes the configuration of a destination in Amazon S3.
See: s3DestinationConfiguration smart constructor.
Instances
s3DestinationConfiguration Source #
Arguments
| :: Text | |
| -> Text | |
| -> S3DestinationConfiguration |
Creates a value of S3DestinationConfiguration with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
sdcPrefix- The "YYYYMMDDHH" time format prefix is automatically used for delivered Amazon S3 files. You can specify an extra prefix to be added in front of the time format prefix. If the prefix ends with a slash, it appears as a folder in the S3 bucket. For more information, see <http:docs.aws.amazon.comfirehoselatestdevbasic-deliver.html#s3-object-name Amazon S3 Object Name Format> in the Amazon Kinesis Data Firehose Developer Guide/ .sdcCloudWatchLoggingOptions- The CloudWatch logging options for your delivery stream.sdcEncryptionConfiguration- The encryption configuration. If no value is specified, the default is no encryption.sdcCompressionFormat- The compression format. If no value is specified, the default isUNCOMPRESSED. The compression formatsSNAPPYorZIPcannot be specified for Amazon Redshift destinations because they are not supported by the Amazon RedshiftCOPYoperation that reads from the S3 bucket.sdcBufferingHints- The buffering option. If no value is specified,BufferingHintsobject default values are used.sdcRoleARN- The Amazon Resource Name (ARN) of the AWS credentials. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces .sdcBucketARN- The ARN of the S3 bucket. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces .
sdcPrefix :: Lens' S3DestinationConfiguration (Maybe Text) Source #
The "YYYYMMDDHH" time format prefix is automatically used for delivered Amazon S3 files. You can specify an extra prefix to be added in front of the time format prefix. If the prefix ends with a slash, it appears as a folder in the S3 bucket. For more information, see <http:docs.aws.amazon.comfirehoselatestdevbasic-deliver.html#s3-object-name Amazon S3 Object Name Format> in the Amazon Kinesis Data Firehose Developer Guide/ .
sdcCloudWatchLoggingOptions :: Lens' S3DestinationConfiguration (Maybe CloudWatchLoggingOptions) Source #
The CloudWatch logging options for your delivery stream.
sdcEncryptionConfiguration :: Lens' S3DestinationConfiguration (Maybe EncryptionConfiguration) Source #
The encryption configuration. If no value is specified, the default is no encryption.
sdcCompressionFormat :: 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.
sdcBufferingHints :: Lens' S3DestinationConfiguration (Maybe BufferingHints) Source #
The buffering option. If no value is specified, BufferingHints object default values are used.
sdcRoleARN :: Lens' S3DestinationConfiguration Text Source #
The Amazon Resource Name (ARN) of the AWS credentials. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces .
sdcBucketARN :: Lens' S3DestinationConfiguration Text Source #
The ARN of the S3 bucket. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces .
S3DestinationDescription
data S3DestinationDescription Source #
Describes a destination in Amazon S3.
See: s3DestinationDescription smart constructor.
Instances
s3DestinationDescription Source #
Arguments
| :: Text | |
| -> Text | |
| -> BufferingHints | |
| -> CompressionFormat | |
| -> EncryptionConfiguration | |
| -> S3DestinationDescription |
Creates a value of S3DestinationDescription with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
s3Prefix- The "YYYYMMDDHH" time format prefix is automatically used for delivered Amazon S3 files. You can specify an extra prefix to be added in front of the time format prefix. If the prefix ends with a slash, it appears as a folder in the S3 bucket. For more information, see <http:docs.aws.amazon.comfirehoselatestdevbasic-deliver.html#s3-object-name Amazon S3 Object Name Format> in the Amazon Kinesis Data Firehose Developer Guide/ .s3CloudWatchLoggingOptions- The Amazon CloudWatch logging options for your delivery stream.s3RoleARN- The Amazon Resource Name (ARN) of the AWS credentials. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces .s3BucketARN- The ARN of the S3 bucket. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces .s3BufferingHints- The buffering option. If no value is specified,BufferingHintsobject default values are used.s3CompressionFormat- The compression format. If no value is specified, the default isUNCOMPRESSED.s3EncryptionConfiguration- The encryption configuration. If no value is specified, the default is no encryption.
s3Prefix :: Lens' S3DestinationDescription (Maybe Text) Source #
The "YYYYMMDDHH" time format prefix is automatically used for delivered Amazon S3 files. You can specify an extra prefix to be added in front of the time format prefix. If the prefix ends with a slash, it appears as a folder in the S3 bucket. For more information, see <http:docs.aws.amazon.comfirehoselatestdevbasic-deliver.html#s3-object-name Amazon S3 Object Name Format> in the Amazon Kinesis Data Firehose Developer Guide/ .
s3CloudWatchLoggingOptions :: Lens' S3DestinationDescription (Maybe CloudWatchLoggingOptions) Source #
The Amazon CloudWatch logging options for your delivery stream.
s3RoleARN :: Lens' S3DestinationDescription Text Source #
The Amazon Resource Name (ARN) of the AWS credentials. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces .
s3BucketARN :: Lens' S3DestinationDescription Text Source #
The ARN of the S3 bucket. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces .
s3BufferingHints :: Lens' S3DestinationDescription BufferingHints Source #
The buffering option. If no value is specified, BufferingHints object default values are used.
s3CompressionFormat :: Lens' S3DestinationDescription CompressionFormat Source #
The compression format. If no value is specified, the default is UNCOMPRESSED .
s3EncryptionConfiguration :: 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: s3DestinationUpdate smart constructor.
Instances
s3DestinationUpdate :: S3DestinationUpdate Source #
Creates a value of S3DestinationUpdate with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
sPrefix- The "YYYYMMDDHH" time format prefix is automatically used for delivered Amazon S3 files. You can specify an extra prefix to be added in front of the time format prefix. If the prefix ends with a slash, it appears as a folder in the S3 bucket. For more information, see <http:docs.aws.amazon.comfirehoselatestdevbasic-deliver.html#s3-object-name Amazon S3 Object Name Format> in the Amazon Kinesis Data Firehose Developer Guide/ .sCloudWatchLoggingOptions- The CloudWatch logging options for your delivery stream.sEncryptionConfiguration- The encryption configuration. If no value is specified, the default is no encryption.sCompressionFormat- The compression format. If no value is specified, the default isUNCOMPRESSED. The compression formatsSNAPPYorZIPcannot be specified for Amazon Redshift destinations because they are not supported by the Amazon RedshiftCOPYoperation that reads from the S3 bucket.sBufferingHints- The buffering option. If no value is specified,BufferingHintsobject default values are used.sBucketARN- The ARN of the S3 bucket. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces .sRoleARN- The Amazon Resource Name (ARN) of the AWS credentials. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces .
sPrefix :: Lens' S3DestinationUpdate (Maybe Text) Source #
The "YYYYMMDDHH" time format prefix is automatically used for delivered Amazon S3 files. You can specify an extra prefix to be added in front of the time format prefix. If the prefix ends with a slash, it appears as a folder in the S3 bucket. For more information, see <http:docs.aws.amazon.comfirehoselatestdevbasic-deliver.html#s3-object-name Amazon S3 Object Name Format> in the Amazon Kinesis Data Firehose Developer Guide/ .
sCloudWatchLoggingOptions :: Lens' S3DestinationUpdate (Maybe CloudWatchLoggingOptions) Source #
The CloudWatch logging options for your delivery stream.
sEncryptionConfiguration :: Lens' S3DestinationUpdate (Maybe EncryptionConfiguration) Source #
The encryption configuration. If no value is specified, the default is no encryption.
sCompressionFormat :: 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.
sBufferingHints :: Lens' S3DestinationUpdate (Maybe BufferingHints) Source #
The buffering option. If no value is specified, BufferingHints object default values are used.
sBucketARN :: Lens' S3DestinationUpdate (Maybe Text) Source #
The ARN of the S3 bucket. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces .
sRoleARN :: Lens' S3DestinationUpdate (Maybe Text) Source #
The Amazon Resource Name (ARN) of the AWS credentials. For more information, see Amazon Resource Names (ARNs) and AWS 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.
See: schemaConfiguration smart constructor.
Instances
schemaConfiguration :: SchemaConfiguration Source #
Creates a value of SchemaConfiguration with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
scVersionId- Specifies the table version for the output data schema. If you don't specify this version ID, or if you set it toLATEST, Kinesis Data Firehose uses the most recent version. This means that any updates to the table are automatically picked up.scCatalogId- The ID of the AWS Glue Data Catalog. If you don't supply this, the AWS account ID is used by default.scDatabaseName- Specifies the name of the AWS Glue database that contains the schema for the output data.scRegion- If you don't specify an AWS Region, the default is the current Region.scTableName- Specifies the AWS Glue table that contains the column information that constitutes your data schema.scRoleARN- The role that Kinesis Data Firehose can use to access AWS Glue. This role must be in the same account you use for Kinesis Data Firehose. Cross-account roles aren't allowed.
scVersionId :: 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.
scCatalogId :: Lens' SchemaConfiguration (Maybe Text) Source #
The ID of the AWS Glue Data Catalog. If you don't supply this, the AWS account ID is used by default.
scDatabaseName :: Lens' SchemaConfiguration (Maybe Text) Source #
Specifies the name of the AWS Glue database that contains the schema for the output data.
scRegion :: Lens' SchemaConfiguration (Maybe Text) Source #
If you don't specify an AWS Region, the default is the current Region.
scTableName :: Lens' SchemaConfiguration (Maybe Text) Source #
Specifies the AWS Glue table that contains the column information that constitutes your data schema.
scRoleARN :: Lens' SchemaConfiguration (Maybe Text) Source #
The role that Kinesis Data Firehose can use to access AWS Glue. This role must be in the same account you use for Kinesis Data Firehose. Cross-account roles aren't allowed.
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: serializer smart constructor.
serializer :: Serializer Source #
Creates a value of Serializer with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
sOrcSerDe- A serializer to use for converting data to the ORC format before storing it in Amazon S3. For more information, see Apache ORC .sParquetSerDe- A serializer to use for converting data to the Parquet format before storing it in Amazon S3. For more information, see Apache Parquet .
sOrcSerDe :: 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 .
sParquetSerDe :: 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: sourceDescription smart constructor.
Instances
sourceDescription :: SourceDescription Source #
Creates a value of SourceDescription with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
sdKinesisStreamSourceDescription- TheKinesisStreamSourceDescriptionvalue for the source Kinesis data stream.
sdKinesisStreamSourceDescription :: 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: splunkDestinationConfiguration smart constructor.
Instances
splunkDestinationConfiguration Source #
Arguments
| :: Text | |
| -> HECEndpointType | |
| -> Text | |
| -> S3DestinationConfiguration | |
| -> SplunkDestinationConfiguration |
Creates a value of SplunkDestinationConfiguration with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
splS3BackupMode- Defines how documents should be delivered to Amazon S3. When set toFailedDocumentsOnly, Kinesis Data Firehose writes any data that could not be indexed to the configured Amazon S3 destination. When set toAllDocuments, Kinesis Data Firehose delivers all incoming records to Amazon S3, and also writes failed documents to Amazon S3. Default value isFailedDocumentsOnly.splCloudWatchLoggingOptions- The Amazon CloudWatch logging options for your delivery stream.splHECAcknowledgmentTimeoutInSeconds- 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.splRetryOptions- 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.splProcessingConfiguration- The data processing configuration.splHECEndpoint- The HTTP Event Collector (HEC) endpoint to which Kinesis Data Firehose sends your data.splHECEndpointType- This type can be either Raw or "Event."splHECToken- This is a GUID that you obtain from your Splunk cluster when you create a new HEC endpoint.splS3Configuration- The configuration for the backup Amazon S3 location.
splS3BackupMode :: Lens' SplunkDestinationConfiguration (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 .
splCloudWatchLoggingOptions :: Lens' SplunkDestinationConfiguration (Maybe CloudWatchLoggingOptions) Source #
The Amazon CloudWatch logging options for your delivery stream.
splHECAcknowledgmentTimeoutInSeconds :: 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.
splRetryOptions :: 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.
splProcessingConfiguration :: Lens' SplunkDestinationConfiguration (Maybe ProcessingConfiguration) Source #
The data processing configuration.
splHECEndpoint :: Lens' SplunkDestinationConfiguration Text Source #
The HTTP Event Collector (HEC) endpoint to which Kinesis Data Firehose sends your data.
splHECEndpointType :: Lens' SplunkDestinationConfiguration HECEndpointType Source #
This type can be either Raw or "Event."
splHECToken :: Lens' SplunkDestinationConfiguration Text Source #
This is a GUID that you obtain from your Splunk cluster when you create a new HEC endpoint.
splS3Configuration :: Lens' SplunkDestinationConfiguration S3DestinationConfiguration Source #
The configuration for the backup Amazon S3 location.
SplunkDestinationDescription
data SplunkDestinationDescription Source #
Describes a destination in Splunk.
See: splunkDestinationDescription smart constructor.
Instances
splunkDestinationDescription :: SplunkDestinationDescription Source #
Creates a value of SplunkDestinationDescription with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
sddS3BackupMode- Defines how documents should be delivered to Amazon S3. When set toFailedDocumentsOnly, Kinesis Data Firehose writes any data that could not be indexed to the configured Amazon S3 destination. When set toAllDocuments, Kinesis Data Firehose delivers all incoming records to Amazon S3, and also writes failed documents to Amazon S3. Default value isFailedDocumentsOnly.sddHECToken- A GUID you obtain from your Splunk cluster when you create a new HEC endpoint.sddHECEndpointType- This type can be either Raw or "Event."sddCloudWatchLoggingOptions- The Amazon CloudWatch logging options for your delivery stream.sddHECAcknowledgmentTimeoutInSeconds- 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.sddS3DestinationDescription- The Amazon S3 destination.>sddHECEndpoint- The HTTP Event Collector (HEC) endpoint to which Kinesis Data Firehose sends your data.sddRetryOptions- 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.sddProcessingConfiguration- The data processing configuration.
sddS3BackupMode :: 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 .
sddHECToken :: Lens' SplunkDestinationDescription (Maybe Text) Source #
A GUID you obtain from your Splunk cluster when you create a new HEC endpoint.
sddHECEndpointType :: Lens' SplunkDestinationDescription (Maybe HECEndpointType) Source #
This type can be either Raw or "Event."
sddCloudWatchLoggingOptions :: Lens' SplunkDestinationDescription (Maybe CloudWatchLoggingOptions) Source #
The Amazon CloudWatch logging options for your delivery stream.
sddHECAcknowledgmentTimeoutInSeconds :: 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.
sddS3DestinationDescription :: Lens' SplunkDestinationDescription (Maybe S3DestinationDescription) Source #
The Amazon S3 destination.>
sddHECEndpoint :: Lens' SplunkDestinationDescription (Maybe Text) Source #
The HTTP Event Collector (HEC) endpoint to which Kinesis Data Firehose sends your data.
sddRetryOptions :: 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.
sddProcessingConfiguration :: Lens' SplunkDestinationDescription (Maybe ProcessingConfiguration) Source #
The data processing configuration.
SplunkDestinationUpdate
data SplunkDestinationUpdate Source #
Describes an update for a destination in Splunk.
See: splunkDestinationUpdate smart constructor.
Instances
splunkDestinationUpdate :: SplunkDestinationUpdate Source #
Creates a value of SplunkDestinationUpdate with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
sduS3BackupMode- Defines how documents should be delivered to Amazon S3. When set toFailedDocumentsOnly, Kinesis Data Firehose writes any data that could not be indexed to the configured Amazon S3 destination. When set toAllDocuments, Kinesis Data Firehose delivers all incoming records to Amazon S3, and also writes failed documents to Amazon S3. Default value isFailedDocumentsOnly.sduHECToken- A GUID that you obtain from your Splunk cluster when you create a new HEC endpoint.sduHECEndpointType- This type can be either Raw or "Event."sduCloudWatchLoggingOptions- The Amazon CloudWatch logging options for your delivery stream.sduHECAcknowledgmentTimeoutInSeconds- 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.sduS3Update- Your update to the configuration of the backup Amazon S3 location.sduHECEndpoint- The HTTP Event Collector (HEC) endpoint to which Kinesis Data Firehose sends your data.sduRetryOptions- 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.sduProcessingConfiguration- The data processing configuration.
sduS3BackupMode :: Lens' SplunkDestinationUpdate (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 .
sduHECToken :: Lens' SplunkDestinationUpdate (Maybe Text) Source #
A GUID that you obtain from your Splunk cluster when you create a new HEC endpoint.
sduHECEndpointType :: Lens' SplunkDestinationUpdate (Maybe HECEndpointType) Source #
This type can be either Raw or "Event."
sduCloudWatchLoggingOptions :: Lens' SplunkDestinationUpdate (Maybe CloudWatchLoggingOptions) Source #
The Amazon CloudWatch logging options for your delivery stream.
sduHECAcknowledgmentTimeoutInSeconds :: 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.
sduS3Update :: Lens' SplunkDestinationUpdate (Maybe S3DestinationUpdate) Source #
Your update to the configuration of the backup Amazon S3 location.
sduHECEndpoint :: Lens' SplunkDestinationUpdate (Maybe Text) Source #
The HTTP Event Collector (HEC) endpoint to which Kinesis Data Firehose sends your data.
sduRetryOptions :: 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.
sduProcessingConfiguration :: Lens' SplunkDestinationUpdate (Maybe ProcessingConfiguration) Source #
The data processing configuration.
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: splunkRetryOptions smart constructor.
Instances
splunkRetryOptions :: SplunkRetryOptions Source #
Creates a value of SplunkRetryOptions with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
sroDurationInSeconds- 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.
sroDurationInSeconds :: 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
Metadata that you can assign to a delivery stream, consisting of a key-value pair.
See: tag smart constructor.
Creates a value of Tag with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
tagValue- An optional string, which you can use to describe or define the tag. Maximum length: 256 characters. Valid characters: Unicode letters, digits, white space, _ . / = + - % @tagKey- A unique identifier for the tag. Maximum length: 128 characters. Valid characters: Unicode letters, digits, white space, _ . / = + - % @