Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
- Service Configuration
- Errors
- Waiters
- Operations
- Types
- AmazonOpenSearchServerlessS3BackupMode
- AmazonopensearchserviceIndexRotationPeriod
- AmazonopensearchserviceS3BackupMode
- CompressionFormat
- ContentEncoding
- DeliveryStreamEncryptionStatus
- DeliveryStreamFailureType
- DeliveryStreamStatus
- DeliveryStreamType
- ElasticsearchIndexRotationPeriod
- ElasticsearchS3BackupMode
- HECEndpointType
- HttpEndpointS3BackupMode
- KeyType
- NoEncryptionConfig
- OrcCompression
- OrcFormatVersion
- ParquetCompression
- ParquetWriterVersion
- ProcessorParameterName
- ProcessorType
- RedshiftS3BackupMode
- S3BackupMode
- SplunkS3BackupMode
- AmazonOpenSearchServerlessBufferingHints
- AmazonOpenSearchServerlessDestinationConfiguration
- AmazonOpenSearchServerlessDestinationDescription
- AmazonOpenSearchServerlessDestinationUpdate
- AmazonOpenSearchServerlessRetryOptions
- AmazonopensearchserviceBufferingHints
- AmazonopensearchserviceDestinationConfiguration
- AmazonopensearchserviceDestinationDescription
- AmazonopensearchserviceDestinationUpdate
- AmazonopensearchserviceRetryOptions
- BufferingHints
- CloudWatchLoggingOptions
- CopyCommand
- DataFormatConversionConfiguration
- DeliveryStreamDescription
- DeliveryStreamEncryptionConfiguration
- DeliveryStreamEncryptionConfigurationInput
- Deserializer
- DestinationDescription
- DynamicPartitioningConfiguration
- ElasticsearchBufferingHints
- ElasticsearchDestinationConfiguration
- ElasticsearchDestinationDescription
- ElasticsearchDestinationUpdate
- ElasticsearchRetryOptions
- EncryptionConfiguration
- ExtendedS3DestinationConfiguration
- ExtendedS3DestinationDescription
- ExtendedS3DestinationUpdate
- FailureDescription
- HiveJsonSerDe
- HttpEndpointBufferingHints
- HttpEndpointCommonAttribute
- HttpEndpointConfiguration
- HttpEndpointDescription
- HttpEndpointDestinationConfiguration
- HttpEndpointDestinationDescription
- HttpEndpointDestinationUpdate
- HttpEndpointRequestConfiguration
- HttpEndpointRetryOptions
- InputFormatConfiguration
- KMSEncryptionConfig
- KinesisStreamSourceConfiguration
- KinesisStreamSourceDescription
- OpenXJsonSerDe
- OrcSerDe
- OutputFormatConfiguration
- ParquetSerDe
- ProcessingConfiguration
- Processor
- ProcessorParameter
- PutRecordBatchResponseEntry
- Record
- RedshiftDestinationConfiguration
- RedshiftDestinationDescription
- RedshiftDestinationUpdate
- RedshiftRetryOptions
- RetryOptions
- S3DestinationConfiguration
- S3DestinationDescription
- S3DestinationUpdate
- SchemaConfiguration
- Serializer
- SourceDescription
- SplunkDestinationConfiguration
- SplunkDestinationDescription
- SplunkDestinationUpdate
- SplunkRetryOptions
- Tag
- VpcConfiguration
- VpcConfigurationDescription
Derived from API version 2015-08-04
of the AWS service descriptions, licensed under Apache 2.0.
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 OpenSearch Service, Amazon Redshift, Splunk, and various other supportd destinations.
Synopsis
- defaultService :: Service
- _ConcurrentModificationException :: AsError a => Fold a ServiceError
- _InvalidArgumentException :: AsError a => Fold a ServiceError
- _InvalidKMSResourceException :: AsError a => Fold a ServiceError
- _LimitExceededException :: AsError a => Fold a ServiceError
- _ResourceInUseException :: AsError a => Fold a ServiceError
- _ResourceNotFoundException :: AsError a => Fold a ServiceError
- _ServiceUnavailableException :: AsError a => Fold a ServiceError
- data CreateDeliveryStream = CreateDeliveryStream' (Maybe AmazonOpenSearchServerlessDestinationConfiguration) (Maybe AmazonopensearchserviceDestinationConfiguration) (Maybe DeliveryStreamEncryptionConfigurationInput) (Maybe DeliveryStreamType) (Maybe ElasticsearchDestinationConfiguration) (Maybe ExtendedS3DestinationConfiguration) (Maybe HttpEndpointDestinationConfiguration) (Maybe KinesisStreamSourceConfiguration) (Maybe RedshiftDestinationConfiguration) (Maybe S3DestinationConfiguration) (Maybe SplunkDestinationConfiguration) (Maybe (NonEmpty Tag)) Text
- newCreateDeliveryStream :: Text -> CreateDeliveryStream
- data CreateDeliveryStreamResponse = CreateDeliveryStreamResponse' (Maybe Text) Int
- newCreateDeliveryStreamResponse :: Int -> CreateDeliveryStreamResponse
- data DeleteDeliveryStream = DeleteDeliveryStream' (Maybe Bool) Text
- newDeleteDeliveryStream :: Text -> DeleteDeliveryStream
- data DeleteDeliveryStreamResponse = DeleteDeliveryStreamResponse' Int
- newDeleteDeliveryStreamResponse :: Int -> DeleteDeliveryStreamResponse
- data DescribeDeliveryStream = DescribeDeliveryStream' (Maybe Text) (Maybe Natural) Text
- newDescribeDeliveryStream :: Text -> DescribeDeliveryStream
- data DescribeDeliveryStreamResponse = DescribeDeliveryStreamResponse' Int DeliveryStreamDescription
- newDescribeDeliveryStreamResponse :: Int -> DeliveryStreamDescription -> DescribeDeliveryStreamResponse
- data ListDeliveryStreams = ListDeliveryStreams' (Maybe DeliveryStreamType) (Maybe Text) (Maybe Natural)
- newListDeliveryStreams :: ListDeliveryStreams
- data ListDeliveryStreamsResponse = ListDeliveryStreamsResponse' Int [Text] Bool
- newListDeliveryStreamsResponse :: Int -> Bool -> ListDeliveryStreamsResponse
- data ListTagsForDeliveryStream = ListTagsForDeliveryStream' (Maybe Text) (Maybe Natural) Text
- newListTagsForDeliveryStream :: Text -> ListTagsForDeliveryStream
- data ListTagsForDeliveryStreamResponse = ListTagsForDeliveryStreamResponse' Int [Tag] Bool
- newListTagsForDeliveryStreamResponse :: Int -> Bool -> ListTagsForDeliveryStreamResponse
- data PutRecord = PutRecord' Text Record
- newPutRecord :: Text -> Record -> PutRecord
- data PutRecordResponse = PutRecordResponse' (Maybe Bool) Int Text
- newPutRecordResponse :: Int -> Text -> PutRecordResponse
- data PutRecordBatch = PutRecordBatch' Text (NonEmpty Record)
- newPutRecordBatch :: Text -> NonEmpty Record -> PutRecordBatch
- data PutRecordBatchResponse = PutRecordBatchResponse' (Maybe Bool) Int Natural (NonEmpty PutRecordBatchResponseEntry)
- newPutRecordBatchResponse :: Int -> Natural -> NonEmpty PutRecordBatchResponseEntry -> PutRecordBatchResponse
- data StartDeliveryStreamEncryption = StartDeliveryStreamEncryption' (Maybe DeliveryStreamEncryptionConfigurationInput) Text
- newStartDeliveryStreamEncryption :: Text -> StartDeliveryStreamEncryption
- data StartDeliveryStreamEncryptionResponse = StartDeliveryStreamEncryptionResponse' Int
- newStartDeliveryStreamEncryptionResponse :: Int -> StartDeliveryStreamEncryptionResponse
- data StopDeliveryStreamEncryption = StopDeliveryStreamEncryption' Text
- newStopDeliveryStreamEncryption :: Text -> StopDeliveryStreamEncryption
- data StopDeliveryStreamEncryptionResponse = StopDeliveryStreamEncryptionResponse' Int
- newStopDeliveryStreamEncryptionResponse :: Int -> StopDeliveryStreamEncryptionResponse
- data TagDeliveryStream = TagDeliveryStream' Text (NonEmpty Tag)
- newTagDeliveryStream :: Text -> NonEmpty Tag -> TagDeliveryStream
- data TagDeliveryStreamResponse = TagDeliveryStreamResponse' Int
- newTagDeliveryStreamResponse :: Int -> TagDeliveryStreamResponse
- data UntagDeliveryStream = UntagDeliveryStream' Text (NonEmpty Text)
- newUntagDeliveryStream :: Text -> NonEmpty Text -> UntagDeliveryStream
- data UntagDeliveryStreamResponse = UntagDeliveryStreamResponse' Int
- newUntagDeliveryStreamResponse :: Int -> UntagDeliveryStreamResponse
- data UpdateDestination = UpdateDestination' (Maybe AmazonOpenSearchServerlessDestinationUpdate) (Maybe AmazonopensearchserviceDestinationUpdate) (Maybe ElasticsearchDestinationUpdate) (Maybe ExtendedS3DestinationUpdate) (Maybe HttpEndpointDestinationUpdate) (Maybe RedshiftDestinationUpdate) (Maybe S3DestinationUpdate) (Maybe SplunkDestinationUpdate) Text Text Text
- newUpdateDestination :: Text -> Text -> Text -> UpdateDestination
- data UpdateDestinationResponse = UpdateDestinationResponse' Int
- newUpdateDestinationResponse :: Int -> UpdateDestinationResponse
- newtype AmazonOpenSearchServerlessS3BackupMode where
- newtype AmazonopensearchserviceIndexRotationPeriod where
- AmazonopensearchserviceIndexRotationPeriod' { }
- pattern AmazonopensearchserviceIndexRotationPeriod_NoRotation :: AmazonopensearchserviceIndexRotationPeriod
- pattern AmazonopensearchserviceIndexRotationPeriod_OneDay :: AmazonopensearchserviceIndexRotationPeriod
- pattern AmazonopensearchserviceIndexRotationPeriod_OneHour :: AmazonopensearchserviceIndexRotationPeriod
- pattern AmazonopensearchserviceIndexRotationPeriod_OneMonth :: AmazonopensearchserviceIndexRotationPeriod
- pattern AmazonopensearchserviceIndexRotationPeriod_OneWeek :: AmazonopensearchserviceIndexRotationPeriod
- newtype AmazonopensearchserviceS3BackupMode where
- newtype CompressionFormat where
- CompressionFormat' { }
- pattern CompressionFormat_GZIP :: CompressionFormat
- pattern CompressionFormat_HADOOP_SNAPPY :: CompressionFormat
- pattern CompressionFormat_Snappy :: CompressionFormat
- pattern CompressionFormat_UNCOMPRESSED :: CompressionFormat
- pattern CompressionFormat_ZIP :: CompressionFormat
- newtype ContentEncoding where
- ContentEncoding' { }
- pattern ContentEncoding_GZIP :: ContentEncoding
- pattern ContentEncoding_NONE :: ContentEncoding
- newtype DeliveryStreamEncryptionStatus where
- DeliveryStreamEncryptionStatus' { }
- pattern DeliveryStreamEncryptionStatus_DISABLED :: DeliveryStreamEncryptionStatus
- pattern DeliveryStreamEncryptionStatus_DISABLING :: DeliveryStreamEncryptionStatus
- pattern DeliveryStreamEncryptionStatus_DISABLING_FAILED :: DeliveryStreamEncryptionStatus
- pattern DeliveryStreamEncryptionStatus_ENABLED :: DeliveryStreamEncryptionStatus
- pattern DeliveryStreamEncryptionStatus_ENABLING :: DeliveryStreamEncryptionStatus
- pattern DeliveryStreamEncryptionStatus_ENABLING_FAILED :: DeliveryStreamEncryptionStatus
- newtype DeliveryStreamFailureType where
- DeliveryStreamFailureType' { }
- pattern DeliveryStreamFailureType_CREATE_ENI_FAILED :: DeliveryStreamFailureType
- pattern DeliveryStreamFailureType_CREATE_KMS_GRANT_FAILED :: DeliveryStreamFailureType
- pattern DeliveryStreamFailureType_DELETE_ENI_FAILED :: DeliveryStreamFailureType
- pattern DeliveryStreamFailureType_DISABLED_KMS_KEY :: DeliveryStreamFailureType
- pattern DeliveryStreamFailureType_ENI_ACCESS_DENIED :: DeliveryStreamFailureType
- pattern DeliveryStreamFailureType_INVALID_KMS_KEY :: DeliveryStreamFailureType
- pattern DeliveryStreamFailureType_KMS_ACCESS_DENIED :: DeliveryStreamFailureType
- pattern DeliveryStreamFailureType_KMS_KEY_NOT_FOUND :: DeliveryStreamFailureType
- pattern DeliveryStreamFailureType_KMS_OPT_IN_REQUIRED :: DeliveryStreamFailureType
- pattern DeliveryStreamFailureType_RETIRE_KMS_GRANT_FAILED :: DeliveryStreamFailureType
- pattern DeliveryStreamFailureType_SECURITY_GROUP_ACCESS_DENIED :: DeliveryStreamFailureType
- pattern DeliveryStreamFailureType_SECURITY_GROUP_NOT_FOUND :: DeliveryStreamFailureType
- pattern DeliveryStreamFailureType_SUBNET_ACCESS_DENIED :: DeliveryStreamFailureType
- pattern DeliveryStreamFailureType_SUBNET_NOT_FOUND :: DeliveryStreamFailureType
- pattern DeliveryStreamFailureType_UNKNOWN_ERROR :: DeliveryStreamFailureType
- newtype DeliveryStreamStatus where
- DeliveryStreamStatus' { }
- pattern DeliveryStreamStatus_ACTIVE :: DeliveryStreamStatus
- pattern DeliveryStreamStatus_CREATING :: DeliveryStreamStatus
- pattern DeliveryStreamStatus_CREATING_FAILED :: DeliveryStreamStatus
- pattern DeliveryStreamStatus_DELETING :: DeliveryStreamStatus
- pattern DeliveryStreamStatus_DELETING_FAILED :: DeliveryStreamStatus
- newtype DeliveryStreamType where
- newtype ElasticsearchIndexRotationPeriod where
- ElasticsearchIndexRotationPeriod' { }
- pattern ElasticsearchIndexRotationPeriod_NoRotation :: ElasticsearchIndexRotationPeriod
- pattern ElasticsearchIndexRotationPeriod_OneDay :: ElasticsearchIndexRotationPeriod
- pattern ElasticsearchIndexRotationPeriod_OneHour :: ElasticsearchIndexRotationPeriod
- pattern ElasticsearchIndexRotationPeriod_OneMonth :: ElasticsearchIndexRotationPeriod
- pattern ElasticsearchIndexRotationPeriod_OneWeek :: ElasticsearchIndexRotationPeriod
- newtype ElasticsearchS3BackupMode where
- newtype HECEndpointType where
- HECEndpointType' { }
- pattern HECEndpointType_Event :: HECEndpointType
- pattern HECEndpointType_Raw :: HECEndpointType
- newtype HttpEndpointS3BackupMode where
- newtype KeyType where
- KeyType' {
- fromKeyType :: Text
- pattern KeyType_AWS_OWNED_CMK :: KeyType
- pattern KeyType_CUSTOMER_MANAGED_CMK :: KeyType
- KeyType' {
- newtype NoEncryptionConfig where
- newtype OrcCompression where
- OrcCompression' { }
- pattern OrcCompression_NONE :: OrcCompression
- pattern OrcCompression_SNAPPY :: OrcCompression
- pattern OrcCompression_ZLIB :: OrcCompression
- newtype OrcFormatVersion where
- OrcFormatVersion' { }
- pattern OrcFormatVersion_V0_11 :: OrcFormatVersion
- pattern OrcFormatVersion_V0_12 :: OrcFormatVersion
- newtype ParquetCompression where
- ParquetCompression' { }
- pattern ParquetCompression_GZIP :: ParquetCompression
- pattern ParquetCompression_SNAPPY :: ParquetCompression
- pattern ParquetCompression_UNCOMPRESSED :: ParquetCompression
- newtype ParquetWriterVersion where
- newtype ProcessorParameterName where
- ProcessorParameterName' { }
- pattern ProcessorParameterName_BufferIntervalInSeconds :: ProcessorParameterName
- pattern ProcessorParameterName_BufferSizeInMBs :: ProcessorParameterName
- pattern ProcessorParameterName_Delimiter :: ProcessorParameterName
- pattern ProcessorParameterName_JsonParsingEngine :: ProcessorParameterName
- pattern ProcessorParameterName_LambdaArn :: ProcessorParameterName
- pattern ProcessorParameterName_MetadataExtractionQuery :: ProcessorParameterName
- pattern ProcessorParameterName_NumberOfRetries :: ProcessorParameterName
- pattern ProcessorParameterName_RoleArn :: ProcessorParameterName
- pattern ProcessorParameterName_SubRecordType :: ProcessorParameterName
- newtype ProcessorType where
- ProcessorType' { }
- pattern ProcessorType_AppendDelimiterToRecord :: ProcessorType
- pattern ProcessorType_Lambda :: ProcessorType
- pattern ProcessorType_MetadataExtraction :: ProcessorType
- pattern ProcessorType_RecordDeAggregation :: ProcessorType
- newtype RedshiftS3BackupMode where
- newtype S3BackupMode where
- S3BackupMode' { }
- pattern S3BackupMode_Disabled :: S3BackupMode
- pattern S3BackupMode_Enabled :: S3BackupMode
- newtype SplunkS3BackupMode where
- data AmazonOpenSearchServerlessBufferingHints = AmazonOpenSearchServerlessBufferingHints' (Maybe Natural) (Maybe Natural)
- newAmazonOpenSearchServerlessBufferingHints :: AmazonOpenSearchServerlessBufferingHints
- data AmazonOpenSearchServerlessDestinationConfiguration = AmazonOpenSearchServerlessDestinationConfiguration' (Maybe AmazonOpenSearchServerlessBufferingHints) (Maybe CloudWatchLoggingOptions) (Maybe Text) (Maybe ProcessingConfiguration) (Maybe AmazonOpenSearchServerlessRetryOptions) (Maybe AmazonOpenSearchServerlessS3BackupMode) (Maybe VpcConfiguration) Text Text S3DestinationConfiguration
- newAmazonOpenSearchServerlessDestinationConfiguration :: Text -> Text -> S3DestinationConfiguration -> AmazonOpenSearchServerlessDestinationConfiguration
- data AmazonOpenSearchServerlessDestinationDescription = AmazonOpenSearchServerlessDestinationDescription' (Maybe AmazonOpenSearchServerlessBufferingHints) (Maybe CloudWatchLoggingOptions) (Maybe Text) (Maybe Text) (Maybe ProcessingConfiguration) (Maybe AmazonOpenSearchServerlessRetryOptions) (Maybe Text) (Maybe AmazonOpenSearchServerlessS3BackupMode) (Maybe S3DestinationDescription) (Maybe VpcConfigurationDescription)
- newAmazonOpenSearchServerlessDestinationDescription :: AmazonOpenSearchServerlessDestinationDescription
- data AmazonOpenSearchServerlessDestinationUpdate = AmazonOpenSearchServerlessDestinationUpdate' (Maybe AmazonOpenSearchServerlessBufferingHints) (Maybe CloudWatchLoggingOptions) (Maybe Text) (Maybe Text) (Maybe ProcessingConfiguration) (Maybe AmazonOpenSearchServerlessRetryOptions) (Maybe Text) (Maybe S3DestinationUpdate)
- newAmazonOpenSearchServerlessDestinationUpdate :: AmazonOpenSearchServerlessDestinationUpdate
- data AmazonOpenSearchServerlessRetryOptions = AmazonOpenSearchServerlessRetryOptions' (Maybe Natural)
- newAmazonOpenSearchServerlessRetryOptions :: AmazonOpenSearchServerlessRetryOptions
- data AmazonopensearchserviceBufferingHints = AmazonopensearchserviceBufferingHints' (Maybe Natural) (Maybe Natural)
- newAmazonopensearchserviceBufferingHints :: AmazonopensearchserviceBufferingHints
- data AmazonopensearchserviceDestinationConfiguration = AmazonopensearchserviceDestinationConfiguration' (Maybe AmazonopensearchserviceBufferingHints) (Maybe CloudWatchLoggingOptions) (Maybe Text) (Maybe Text) (Maybe AmazonopensearchserviceIndexRotationPeriod) (Maybe ProcessingConfiguration) (Maybe AmazonopensearchserviceRetryOptions) (Maybe AmazonopensearchserviceS3BackupMode) (Maybe Text) (Maybe VpcConfiguration) Text Text S3DestinationConfiguration
- newAmazonopensearchserviceDestinationConfiguration :: Text -> Text -> S3DestinationConfiguration -> AmazonopensearchserviceDestinationConfiguration
- data AmazonopensearchserviceDestinationDescription = AmazonopensearchserviceDestinationDescription' (Maybe AmazonopensearchserviceBufferingHints) (Maybe CloudWatchLoggingOptions) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe AmazonopensearchserviceIndexRotationPeriod) (Maybe ProcessingConfiguration) (Maybe AmazonopensearchserviceRetryOptions) (Maybe Text) (Maybe AmazonopensearchserviceS3BackupMode) (Maybe S3DestinationDescription) (Maybe Text) (Maybe VpcConfigurationDescription)
- newAmazonopensearchserviceDestinationDescription :: AmazonopensearchserviceDestinationDescription
- data AmazonopensearchserviceDestinationUpdate = AmazonopensearchserviceDestinationUpdate' (Maybe AmazonopensearchserviceBufferingHints) (Maybe CloudWatchLoggingOptions) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe AmazonopensearchserviceIndexRotationPeriod) (Maybe ProcessingConfiguration) (Maybe AmazonopensearchserviceRetryOptions) (Maybe Text) (Maybe S3DestinationUpdate) (Maybe Text)
- newAmazonopensearchserviceDestinationUpdate :: AmazonopensearchserviceDestinationUpdate
- data AmazonopensearchserviceRetryOptions = AmazonopensearchserviceRetryOptions' (Maybe Natural)
- newAmazonopensearchserviceRetryOptions :: AmazonopensearchserviceRetryOptions
- data BufferingHints = BufferingHints' (Maybe Natural) (Maybe Natural)
- newBufferingHints :: BufferingHints
- data CloudWatchLoggingOptions = CloudWatchLoggingOptions' (Maybe Bool) (Maybe Text) (Maybe Text)
- newCloudWatchLoggingOptions :: CloudWatchLoggingOptions
- data CopyCommand = CopyCommand' (Maybe Text) (Maybe Text) Text
- newCopyCommand :: Text -> CopyCommand
- data DataFormatConversionConfiguration = DataFormatConversionConfiguration' (Maybe Bool) (Maybe InputFormatConfiguration) (Maybe OutputFormatConfiguration) (Maybe SchemaConfiguration)
- newDataFormatConversionConfiguration :: DataFormatConversionConfiguration
- data DeliveryStreamDescription = DeliveryStreamDescription' (Maybe POSIX) (Maybe DeliveryStreamEncryptionConfiguration) (Maybe FailureDescription) (Maybe POSIX) (Maybe SourceDescription) Text Text DeliveryStreamStatus DeliveryStreamType Text [DestinationDescription] Bool
- newDeliveryStreamDescription :: Text -> Text -> DeliveryStreamStatus -> DeliveryStreamType -> Text -> Bool -> DeliveryStreamDescription
- data DeliveryStreamEncryptionConfiguration = DeliveryStreamEncryptionConfiguration' (Maybe FailureDescription) (Maybe Text) (Maybe KeyType) (Maybe DeliveryStreamEncryptionStatus)
- newDeliveryStreamEncryptionConfiguration :: DeliveryStreamEncryptionConfiguration
- data DeliveryStreamEncryptionConfigurationInput = DeliveryStreamEncryptionConfigurationInput' (Maybe Text) KeyType
- newDeliveryStreamEncryptionConfigurationInput :: KeyType -> DeliveryStreamEncryptionConfigurationInput
- data Deserializer = Deserializer' (Maybe HiveJsonSerDe) (Maybe OpenXJsonSerDe)
- newDeserializer :: Deserializer
- data DestinationDescription = DestinationDescription' (Maybe AmazonOpenSearchServerlessDestinationDescription) (Maybe AmazonopensearchserviceDestinationDescription) (Maybe ElasticsearchDestinationDescription) (Maybe ExtendedS3DestinationDescription) (Maybe HttpEndpointDestinationDescription) (Maybe RedshiftDestinationDescription) (Maybe S3DestinationDescription) (Maybe SplunkDestinationDescription) Text
- newDestinationDescription :: Text -> DestinationDescription
- data DynamicPartitioningConfiguration = DynamicPartitioningConfiguration' (Maybe Bool) (Maybe RetryOptions)
- newDynamicPartitioningConfiguration :: DynamicPartitioningConfiguration
- data ElasticsearchBufferingHints = ElasticsearchBufferingHints' (Maybe Natural) (Maybe Natural)
- newElasticsearchBufferingHints :: ElasticsearchBufferingHints
- data ElasticsearchDestinationConfiguration = ElasticsearchDestinationConfiguration' (Maybe ElasticsearchBufferingHints) (Maybe CloudWatchLoggingOptions) (Maybe Text) (Maybe Text) (Maybe ElasticsearchIndexRotationPeriod) (Maybe ProcessingConfiguration) (Maybe ElasticsearchRetryOptions) (Maybe ElasticsearchS3BackupMode) (Maybe Text) (Maybe VpcConfiguration) Text Text S3DestinationConfiguration
- newElasticsearchDestinationConfiguration :: Text -> Text -> S3DestinationConfiguration -> ElasticsearchDestinationConfiguration
- data ElasticsearchDestinationDescription = ElasticsearchDestinationDescription' (Maybe ElasticsearchBufferingHints) (Maybe CloudWatchLoggingOptions) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe ElasticsearchIndexRotationPeriod) (Maybe ProcessingConfiguration) (Maybe ElasticsearchRetryOptions) (Maybe Text) (Maybe ElasticsearchS3BackupMode) (Maybe S3DestinationDescription) (Maybe Text) (Maybe VpcConfigurationDescription)
- newElasticsearchDestinationDescription :: ElasticsearchDestinationDescription
- data ElasticsearchDestinationUpdate = ElasticsearchDestinationUpdate' (Maybe ElasticsearchBufferingHints) (Maybe CloudWatchLoggingOptions) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe ElasticsearchIndexRotationPeriod) (Maybe ProcessingConfiguration) (Maybe ElasticsearchRetryOptions) (Maybe Text) (Maybe S3DestinationUpdate) (Maybe Text)
- newElasticsearchDestinationUpdate :: ElasticsearchDestinationUpdate
- data ElasticsearchRetryOptions = ElasticsearchRetryOptions' (Maybe Natural)
- newElasticsearchRetryOptions :: ElasticsearchRetryOptions
- data EncryptionConfiguration = EncryptionConfiguration' (Maybe KMSEncryptionConfig) (Maybe NoEncryptionConfig)
- newEncryptionConfiguration :: EncryptionConfiguration
- data ExtendedS3DestinationConfiguration = ExtendedS3DestinationConfiguration' (Maybe BufferingHints) (Maybe CloudWatchLoggingOptions) (Maybe CompressionFormat) (Maybe DataFormatConversionConfiguration) (Maybe DynamicPartitioningConfiguration) (Maybe EncryptionConfiguration) (Maybe Text) (Maybe Text) (Maybe ProcessingConfiguration) (Maybe S3DestinationConfiguration) (Maybe S3BackupMode) Text Text
- newExtendedS3DestinationConfiguration :: Text -> Text -> ExtendedS3DestinationConfiguration
- data ExtendedS3DestinationDescription = ExtendedS3DestinationDescription' (Maybe CloudWatchLoggingOptions) (Maybe DataFormatConversionConfiguration) (Maybe DynamicPartitioningConfiguration) (Maybe Text) (Maybe Text) (Maybe ProcessingConfiguration) (Maybe S3DestinationDescription) (Maybe S3BackupMode) Text Text BufferingHints CompressionFormat EncryptionConfiguration
- newExtendedS3DestinationDescription :: Text -> Text -> BufferingHints -> CompressionFormat -> EncryptionConfiguration -> ExtendedS3DestinationDescription
- data ExtendedS3DestinationUpdate = ExtendedS3DestinationUpdate' (Maybe Text) (Maybe BufferingHints) (Maybe CloudWatchLoggingOptions) (Maybe CompressionFormat) (Maybe DataFormatConversionConfiguration) (Maybe DynamicPartitioningConfiguration) (Maybe EncryptionConfiguration) (Maybe Text) (Maybe Text) (Maybe ProcessingConfiguration) (Maybe Text) (Maybe S3BackupMode) (Maybe S3DestinationUpdate)
- newExtendedS3DestinationUpdate :: ExtendedS3DestinationUpdate
- data FailureDescription = FailureDescription' DeliveryStreamFailureType Text
- newFailureDescription :: DeliveryStreamFailureType -> Text -> FailureDescription
- data HiveJsonSerDe = HiveJsonSerDe' (Maybe [Text])
- newHiveJsonSerDe :: HiveJsonSerDe
- data HttpEndpointBufferingHints = HttpEndpointBufferingHints' (Maybe Natural) (Maybe Natural)
- newHttpEndpointBufferingHints :: HttpEndpointBufferingHints
- data HttpEndpointCommonAttribute = HttpEndpointCommonAttribute' (Sensitive Text) (Sensitive Text)
- newHttpEndpointCommonAttribute :: Text -> Text -> HttpEndpointCommonAttribute
- data HttpEndpointConfiguration = HttpEndpointConfiguration' (Maybe (Sensitive Text)) (Maybe Text) (Sensitive Text)
- newHttpEndpointConfiguration :: Text -> HttpEndpointConfiguration
- data HttpEndpointDescription = HttpEndpointDescription' (Maybe Text) (Maybe (Sensitive Text))
- newHttpEndpointDescription :: HttpEndpointDescription
- data HttpEndpointDestinationConfiguration = HttpEndpointDestinationConfiguration' (Maybe HttpEndpointBufferingHints) (Maybe CloudWatchLoggingOptions) (Maybe ProcessingConfiguration) (Maybe HttpEndpointRequestConfiguration) (Maybe HttpEndpointRetryOptions) (Maybe Text) (Maybe HttpEndpointS3BackupMode) HttpEndpointConfiguration S3DestinationConfiguration
- newHttpEndpointDestinationConfiguration :: HttpEndpointConfiguration -> S3DestinationConfiguration -> HttpEndpointDestinationConfiguration
- data HttpEndpointDestinationDescription = HttpEndpointDestinationDescription' (Maybe HttpEndpointBufferingHints) (Maybe CloudWatchLoggingOptions) (Maybe HttpEndpointDescription) (Maybe ProcessingConfiguration) (Maybe HttpEndpointRequestConfiguration) (Maybe HttpEndpointRetryOptions) (Maybe Text) (Maybe HttpEndpointS3BackupMode) (Maybe S3DestinationDescription)
- newHttpEndpointDestinationDescription :: HttpEndpointDestinationDescription
- data HttpEndpointDestinationUpdate = HttpEndpointDestinationUpdate' (Maybe HttpEndpointBufferingHints) (Maybe CloudWatchLoggingOptions) (Maybe HttpEndpointConfiguration) (Maybe ProcessingConfiguration) (Maybe HttpEndpointRequestConfiguration) (Maybe HttpEndpointRetryOptions) (Maybe Text) (Maybe HttpEndpointS3BackupMode) (Maybe S3DestinationUpdate)
- newHttpEndpointDestinationUpdate :: HttpEndpointDestinationUpdate
- data HttpEndpointRequestConfiguration = HttpEndpointRequestConfiguration' (Maybe [HttpEndpointCommonAttribute]) (Maybe ContentEncoding)
- newHttpEndpointRequestConfiguration :: HttpEndpointRequestConfiguration
- data HttpEndpointRetryOptions = HttpEndpointRetryOptions' (Maybe Natural)
- newHttpEndpointRetryOptions :: HttpEndpointRetryOptions
- data InputFormatConfiguration = InputFormatConfiguration' (Maybe Deserializer)
- newInputFormatConfiguration :: InputFormatConfiguration
- data KMSEncryptionConfig = KMSEncryptionConfig' Text
- newKMSEncryptionConfig :: Text -> KMSEncryptionConfig
- data KinesisStreamSourceConfiguration = KinesisStreamSourceConfiguration' Text Text
- newKinesisStreamSourceConfiguration :: Text -> Text -> KinesisStreamSourceConfiguration
- data KinesisStreamSourceDescription = KinesisStreamSourceDescription' (Maybe POSIX) (Maybe Text) (Maybe Text)
- newKinesisStreamSourceDescription :: KinesisStreamSourceDescription
- data OpenXJsonSerDe = OpenXJsonSerDe' (Maybe Bool) (Maybe (HashMap Text Text)) (Maybe Bool)
- newOpenXJsonSerDe :: OpenXJsonSerDe
- data OrcSerDe = OrcSerDe' (Maybe Natural) (Maybe [Text]) (Maybe Double) (Maybe OrcCompression) (Maybe Double) (Maybe Bool) (Maybe OrcFormatVersion) (Maybe Double) (Maybe Natural) (Maybe Natural)
- newOrcSerDe :: OrcSerDe
- data OutputFormatConfiguration = OutputFormatConfiguration' (Maybe Serializer)
- newOutputFormatConfiguration :: OutputFormatConfiguration
- data ParquetSerDe = ParquetSerDe' (Maybe Natural) (Maybe ParquetCompression) (Maybe Bool) (Maybe Natural) (Maybe Natural) (Maybe ParquetWriterVersion)
- newParquetSerDe :: ParquetSerDe
- data ProcessingConfiguration = ProcessingConfiguration' (Maybe Bool) (Maybe [Processor])
- newProcessingConfiguration :: ProcessingConfiguration
- data Processor = Processor' (Maybe [ProcessorParameter]) ProcessorType
- newProcessor :: ProcessorType -> Processor
- data ProcessorParameter = ProcessorParameter' ProcessorParameterName Text
- newProcessorParameter :: ProcessorParameterName -> Text -> ProcessorParameter
- data PutRecordBatchResponseEntry = PutRecordBatchResponseEntry' (Maybe Text) (Maybe Text) (Maybe Text)
- newPutRecordBatchResponseEntry :: PutRecordBatchResponseEntry
- data Record = Record' Base64
- newRecord :: ByteString -> Record
- data RedshiftDestinationConfiguration = RedshiftDestinationConfiguration' (Maybe CloudWatchLoggingOptions) (Maybe ProcessingConfiguration) (Maybe RedshiftRetryOptions) (Maybe S3DestinationConfiguration) (Maybe RedshiftS3BackupMode) Text Text CopyCommand (Sensitive Text) (Sensitive Text) S3DestinationConfiguration
- newRedshiftDestinationConfiguration :: Text -> Text -> CopyCommand -> Text -> Text -> S3DestinationConfiguration -> RedshiftDestinationConfiguration
- data RedshiftDestinationDescription = RedshiftDestinationDescription' (Maybe CloudWatchLoggingOptions) (Maybe ProcessingConfiguration) (Maybe RedshiftRetryOptions) (Maybe S3DestinationDescription) (Maybe RedshiftS3BackupMode) Text Text CopyCommand (Sensitive Text) S3DestinationDescription
- newRedshiftDestinationDescription :: Text -> Text -> CopyCommand -> Text -> S3DestinationDescription -> RedshiftDestinationDescription
- data RedshiftDestinationUpdate = RedshiftDestinationUpdate' (Maybe CloudWatchLoggingOptions) (Maybe Text) (Maybe CopyCommand) (Maybe (Sensitive Text)) (Maybe ProcessingConfiguration) (Maybe RedshiftRetryOptions) (Maybe Text) (Maybe RedshiftS3BackupMode) (Maybe S3DestinationUpdate) (Maybe S3DestinationUpdate) (Maybe (Sensitive Text))
- newRedshiftDestinationUpdate :: RedshiftDestinationUpdate
- data RedshiftRetryOptions = RedshiftRetryOptions' (Maybe Natural)
- newRedshiftRetryOptions :: RedshiftRetryOptions
- data RetryOptions = RetryOptions' (Maybe Natural)
- newRetryOptions :: RetryOptions
- data S3DestinationConfiguration = S3DestinationConfiguration' (Maybe BufferingHints) (Maybe CloudWatchLoggingOptions) (Maybe CompressionFormat) (Maybe EncryptionConfiguration) (Maybe Text) (Maybe Text) Text Text
- newS3DestinationConfiguration :: Text -> Text -> S3DestinationConfiguration
- data S3DestinationDescription = S3DestinationDescription' (Maybe CloudWatchLoggingOptions) (Maybe Text) (Maybe Text) Text Text BufferingHints CompressionFormat EncryptionConfiguration
- newS3DestinationDescription :: Text -> Text -> BufferingHints -> CompressionFormat -> EncryptionConfiguration -> S3DestinationDescription
- data S3DestinationUpdate = S3DestinationUpdate' (Maybe Text) (Maybe BufferingHints) (Maybe CloudWatchLoggingOptions) (Maybe CompressionFormat) (Maybe EncryptionConfiguration) (Maybe Text) (Maybe Text) (Maybe Text)
- newS3DestinationUpdate :: S3DestinationUpdate
- data SchemaConfiguration = SchemaConfiguration' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text)
- newSchemaConfiguration :: SchemaConfiguration
- data Serializer = Serializer' (Maybe OrcSerDe) (Maybe ParquetSerDe)
- newSerializer :: Serializer
- data SourceDescription = SourceDescription' (Maybe KinesisStreamSourceDescription)
- newSourceDescription :: SourceDescription
- data SplunkDestinationConfiguration = SplunkDestinationConfiguration' (Maybe CloudWatchLoggingOptions) (Maybe Natural) (Maybe ProcessingConfiguration) (Maybe SplunkRetryOptions) (Maybe SplunkS3BackupMode) Text HECEndpointType Text S3DestinationConfiguration
- newSplunkDestinationConfiguration :: Text -> HECEndpointType -> Text -> S3DestinationConfiguration -> SplunkDestinationConfiguration
- data SplunkDestinationDescription = SplunkDestinationDescription' (Maybe CloudWatchLoggingOptions) (Maybe Natural) (Maybe Text) (Maybe HECEndpointType) (Maybe Text) (Maybe ProcessingConfiguration) (Maybe SplunkRetryOptions) (Maybe SplunkS3BackupMode) (Maybe S3DestinationDescription)
- newSplunkDestinationDescription :: SplunkDestinationDescription
- data SplunkDestinationUpdate = SplunkDestinationUpdate' (Maybe CloudWatchLoggingOptions) (Maybe Natural) (Maybe Text) (Maybe HECEndpointType) (Maybe Text) (Maybe ProcessingConfiguration) (Maybe SplunkRetryOptions) (Maybe SplunkS3BackupMode) (Maybe S3DestinationUpdate)
- newSplunkDestinationUpdate :: SplunkDestinationUpdate
- data SplunkRetryOptions = SplunkRetryOptions' (Maybe Natural)
- newSplunkRetryOptions :: SplunkRetryOptions
- data Tag = Tag' (Maybe Text) Text
- newTag :: Text -> Tag
- data VpcConfiguration = VpcConfiguration' (NonEmpty Text) Text (NonEmpty Text)
- newVpcConfiguration :: NonEmpty Text -> Text -> NonEmpty Text -> VpcConfiguration
- data VpcConfigurationDescription = VpcConfigurationDescription' (NonEmpty Text) Text (NonEmpty Text) Text
- newVpcConfigurationDescription :: NonEmpty Text -> Text -> NonEmpty Text -> Text -> VpcConfigurationDescription
Service Configuration
defaultService :: Service Source #
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
.
ConcurrentModificationException
_ConcurrentModificationException :: AsError a => Fold a ServiceError Source #
Another modification has already happened. Fetch VersionId
again and
use it to update the destination.
InvalidArgumentException
_InvalidArgumentException :: AsError a => Fold a ServiceError Source #
The specified input parameter has a value that is not valid.
InvalidKMSResourceException
_InvalidKMSResourceException :: AsError a => Fold a ServiceError Source #
Kinesis Data Firehose throws this exception when an attempt to put
records or to start or stop delivery stream encryption fails. This
happens when the KMS service throws one of the following exception
types: AccessDeniedException
, InvalidStateException
,
DisabledException
, or NotFoundException
.
LimitExceededException
_LimitExceededException :: AsError a => Fold a ServiceError Source #
You have already reached the limit for a requested resource.
ResourceInUseException
_ResourceInUseException :: AsError a => Fold a ServiceError Source #
The resource is already in use and not available for this operation.
ResourceNotFoundException
_ResourceNotFoundException :: AsError a => Fold a ServiceError Source #
The specified resource could not be found.
ServiceUnavailableException
_ServiceUnavailableException :: AsError a => Fold a ServiceError Source #
The service is unavailable. Back off and retry the operation. If you continue to see the exception, throughput limits for the delivery stream may have been exceeded. For more information about limits and how to request an increase, see Amazon Kinesis Data Firehose Limits.
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.
CreateDeliveryStream
data CreateDeliveryStream Source #
See: newCreateDeliveryStream
smart constructor.
Instances
newCreateDeliveryStream Source #
Create a value of CreateDeliveryStream
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:amazonOpenSearchServerlessDestinationConfiguration:CreateDeliveryStream'
, createDeliveryStream_amazonOpenSearchServerlessDestinationConfiguration
- The destination in the Serverless offering for Amazon OpenSearch
Service. You can specify only one destination.
$sel:amazonopensearchserviceDestinationConfiguration:CreateDeliveryStream'
, createDeliveryStream_amazonopensearchserviceDestinationConfiguration
- The destination in Amazon OpenSearch Service. You can specify only one
destination.
$sel:deliveryStreamEncryptionConfigurationInput:CreateDeliveryStream'
, createDeliveryStream_deliveryStreamEncryptionConfigurationInput
- Used to specify the type and Amazon Resource Name (ARN) of the KMS key
needed for Server-Side Encryption (SSE).
CreateDeliveryStream
, createDeliveryStream_deliveryStreamType
- The delivery stream type. This parameter can be one of the following
values:
DirectPut
: Provider applications access the delivery stream directly.KinesisStreamAsSource
: The delivery stream uses a Kinesis data stream as a source.
$sel:elasticsearchDestinationConfiguration:CreateDeliveryStream'
, createDeliveryStream_elasticsearchDestinationConfiguration
- The destination in Amazon ES. You can specify only one destination.
$sel:extendedS3DestinationConfiguration:CreateDeliveryStream'
, createDeliveryStream_extendedS3DestinationConfiguration
- The destination in Amazon S3. You can specify only one destination.
$sel:httpEndpointDestinationConfiguration:CreateDeliveryStream'
, createDeliveryStream_httpEndpointDestinationConfiguration
- Enables configuring Kinesis Firehose to deliver data to any HTTP
endpoint destination. You can specify only one destination.
$sel:kinesisStreamSourceConfiguration:CreateDeliveryStream'
, createDeliveryStream_kinesisStreamSourceConfiguration
- When a Kinesis data stream is used as the source for the delivery
stream, a KinesisStreamSourceConfiguration containing the Kinesis data
stream Amazon Resource Name (ARN) and the role ARN for the source
stream.
$sel:redshiftDestinationConfiguration:CreateDeliveryStream'
, createDeliveryStream_redshiftDestinationConfiguration
- The destination in Amazon Redshift. You can specify only one
destination.
$sel:s3DestinationConfiguration:CreateDeliveryStream'
, createDeliveryStream_s3DestinationConfiguration
- [Deprecated] The destination in Amazon S3. You can specify only one
destination.
$sel:splunkDestinationConfiguration:CreateDeliveryStream'
, createDeliveryStream_splunkDestinationConfiguration
- The destination in Splunk. You can specify only one destination.
$sel:tags:CreateDeliveryStream'
, createDeliveryStream_tags
- A set of tags to assign to the delivery stream. A tag is a key-value
pair that you can define and assign to Amazon Web Services resources.
Tags are metadata. For example, you can add friendly names and
descriptions or other types of information that can help you distinguish
the delivery stream. For more information about tags, see
Using Cost Allocation Tags
in the Amazon Web Services Billing and Cost Management User Guide.
You can specify up to 50 tags when creating a delivery stream.
CreateDeliveryStream
, createDeliveryStream_deliveryStreamName
- The name of the delivery stream. This name must be unique per Amazon Web
Services account in the same Amazon Web Services Region. If the delivery
streams are in different accounts or different Regions, you can have
multiple delivery streams with the same name.
data CreateDeliveryStreamResponse Source #
See: newCreateDeliveryStreamResponse
smart constructor.
Instances
newCreateDeliveryStreamResponse Source #
Create a value of CreateDeliveryStreamResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateDeliveryStreamResponse
, createDeliveryStreamResponse_deliveryStreamARN
- The ARN of the delivery stream.
$sel:httpStatus:CreateDeliveryStreamResponse'
, createDeliveryStreamResponse_httpStatus
- The response's http status code.
DeleteDeliveryStream
data DeleteDeliveryStream Source #
See: newDeleteDeliveryStream
smart constructor.
Instances
newDeleteDeliveryStream Source #
Create a value of DeleteDeliveryStream
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:allowForceDelete:DeleteDeliveryStream'
, deleteDeliveryStream_allowForceDelete
- Set this to true if you want to delete the delivery stream even if
Kinesis Data Firehose is unable to retire the grant for the CMK. Kinesis
Data Firehose might be unable to retire the grant due to a customer
error, such as when the CMK or the grant are in an invalid state. If you
force deletion, you can then use the
RevokeGrant
operation to revoke the grant you gave to Kinesis Data Firehose. If a
failure to retire the grant happens due to an Amazon Web Services KMS
issue, Kinesis Data Firehose keeps retrying the delete operation.
The default value is false.
DeleteDeliveryStream
, deleteDeliveryStream_deliveryStreamName
- The name of the delivery stream.
data DeleteDeliveryStreamResponse Source #
See: newDeleteDeliveryStreamResponse
smart constructor.
Instances
newDeleteDeliveryStreamResponse Source #
Create a value of DeleteDeliveryStreamResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:DeleteDeliveryStreamResponse'
, deleteDeliveryStreamResponse_httpStatus
- The response's http status code.
DescribeDeliveryStream
data DescribeDeliveryStream Source #
See: newDescribeDeliveryStream
smart constructor.
Instances
newDescribeDeliveryStream Source #
Create a value of DescribeDeliveryStream
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:exclusiveStartDestinationId:DescribeDeliveryStream'
, describeDeliveryStream_exclusiveStartDestinationId
- The ID of the destination to start returning the destination
information. Kinesis Data Firehose supports one destination per delivery
stream.
$sel:limit:DescribeDeliveryStream'
, describeDeliveryStream_limit
- The limit on the number of destinations to return. You can have one
destination per delivery stream.
DescribeDeliveryStream
, describeDeliveryStream_deliveryStreamName
- The name of the delivery stream.
data DescribeDeliveryStreamResponse Source #
See: newDescribeDeliveryStreamResponse
smart constructor.
Instances
Generic DescribeDeliveryStreamResponse Source # | |
Show DescribeDeliveryStreamResponse Source # | |
Defined in Amazonka.Firehose.DescribeDeliveryStream | |
NFData DescribeDeliveryStreamResponse Source # | |
Defined in Amazonka.Firehose.DescribeDeliveryStream rnf :: DescribeDeliveryStreamResponse -> () # | |
Eq DescribeDeliveryStreamResponse Source # | |
type Rep DescribeDeliveryStreamResponse Source # | |
Defined in Amazonka.Firehose.DescribeDeliveryStream type Rep DescribeDeliveryStreamResponse = D1 ('MetaData "DescribeDeliveryStreamResponse" "Amazonka.Firehose.DescribeDeliveryStream" "amazonka-kinesis-firehose-2.0-6l1hHmh2UnHBvolxuQFkWB" 'False) (C1 ('MetaCons "DescribeDeliveryStreamResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "deliveryStreamDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 DeliveryStreamDescription))) |
newDescribeDeliveryStreamResponse Source #
:: Int | |
-> DeliveryStreamDescription |
|
-> DescribeDeliveryStreamResponse |
Create a value of DescribeDeliveryStreamResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:DescribeDeliveryStreamResponse'
, describeDeliveryStreamResponse_httpStatus
- The response's http status code.
$sel:deliveryStreamDescription:DescribeDeliveryStreamResponse'
, describeDeliveryStreamResponse_deliveryStreamDescription
- Information about the delivery stream.
ListDeliveryStreams
data ListDeliveryStreams Source #
See: newListDeliveryStreams
smart constructor.
Instances
newListDeliveryStreams :: ListDeliveryStreams Source #
Create a value of ListDeliveryStreams
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListDeliveryStreams
, listDeliveryStreams_deliveryStreamType
- The delivery stream type. This can be one of the following values:
DirectPut
: Provider applications access the delivery stream directly.KinesisStreamAsSource
: The delivery stream uses a Kinesis data stream as a source.
This parameter is optional. If this parameter is omitted, delivery streams of all types are returned.
$sel:exclusiveStartDeliveryStreamName:ListDeliveryStreams'
, listDeliveryStreams_exclusiveStartDeliveryStreamName
- The list of delivery streams returned by this call to
ListDeliveryStreams
will start with the delivery stream whose name
comes alphabetically immediately after the name you specify in
ExclusiveStartDeliveryStreamName
.
$sel:limit:ListDeliveryStreams'
, listDeliveryStreams_limit
- The maximum number of delivery streams to list. The default value is 10.
data ListDeliveryStreamsResponse Source #
See: newListDeliveryStreamsResponse
smart constructor.
Instances
newListDeliveryStreamsResponse Source #
:: Int | |
-> Bool | |
-> ListDeliveryStreamsResponse |
Create a value of ListDeliveryStreamsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:ListDeliveryStreamsResponse'
, listDeliveryStreamsResponse_httpStatus
- The response's http status code.
$sel:deliveryStreamNames:ListDeliveryStreamsResponse'
, listDeliveryStreamsResponse_deliveryStreamNames
- The names of the delivery streams.
$sel:hasMoreDeliveryStreams:ListDeliveryStreamsResponse'
, listDeliveryStreamsResponse_hasMoreDeliveryStreams
- Indicates whether there are more delivery streams available to list.
ListTagsForDeliveryStream
data ListTagsForDeliveryStream Source #
See: newListTagsForDeliveryStream
smart constructor.
Instances
newListTagsForDeliveryStream Source #
Create a value of ListTagsForDeliveryStream
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:exclusiveStartTagKey:ListTagsForDeliveryStream'
, listTagsForDeliveryStream_exclusiveStartTagKey
- The key to use as the starting point for the list of tags. If you set
this parameter, ListTagsForDeliveryStream
gets all tags that occur
after ExclusiveStartTagKey
.
$sel:limit:ListTagsForDeliveryStream'
, listTagsForDeliveryStream_limit
- The number of tags to return. If this number is less than the total
number of tags associated with the delivery stream, HasMoreTags
is set
to true
in the response. To list additional tags, set
ExclusiveStartTagKey
to the last key in the response.
ListTagsForDeliveryStream
, listTagsForDeliveryStream_deliveryStreamName
- The name of the delivery stream whose tags you want to list.
data ListTagsForDeliveryStreamResponse Source #
See: newListTagsForDeliveryStreamResponse
smart constructor.
Instances
newListTagsForDeliveryStreamResponse Source #
Create a value of ListTagsForDeliveryStreamResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:ListTagsForDeliveryStreamResponse'
, listTagsForDeliveryStreamResponse_httpStatus
- The response's http status code.
$sel:tags:ListTagsForDeliveryStreamResponse'
, listTagsForDeliveryStreamResponse_tags
- A list of tags associated with DeliveryStreamName
, starting with the
first tag after ExclusiveStartTagKey
and up to the specified Limit
.
$sel:hasMoreTags:ListTagsForDeliveryStreamResponse'
, listTagsForDeliveryStreamResponse_hasMoreTags
- If this is true
in the response, more tags are available. To list the
remaining tags, set ExclusiveStartTagKey
to the key of the last tag
returned and call ListTagsForDeliveryStream
again.
PutRecord
See: newPutRecord
smart constructor.
Instances
Create a value of PutRecord
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
PutRecord
, putRecord_deliveryStreamName
- The name of the delivery stream.
$sel:record:PutRecord'
, putRecord_record
- The record.
data PutRecordResponse Source #
See: newPutRecordResponse
smart constructor.
Instances
Create a value of PutRecordResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:encrypted:PutRecordResponse'
, putRecordResponse_encrypted
- Indicates whether server-side encryption (SSE) was enabled during this
operation.
$sel:httpStatus:PutRecordResponse'
, putRecordResponse_httpStatus
- The response's http status code.
PutRecordResponse
, putRecordResponse_recordId
- The ID of the record.
PutRecordBatch
data PutRecordBatch Source #
See: newPutRecordBatch
smart constructor.
Instances
Create a value of PutRecordBatch
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
PutRecordBatch
, putRecordBatch_deliveryStreamName
- The name of the delivery stream.
$sel:records:PutRecordBatch'
, putRecordBatch_records
- One or more records.
data PutRecordBatchResponse Source #
See: newPutRecordBatchResponse
smart constructor.
Instances
newPutRecordBatchResponse Source #
Create a value of PutRecordBatchResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:encrypted:PutRecordBatchResponse'
, putRecordBatchResponse_encrypted
- Indicates whether server-side encryption (SSE) was enabled during this
operation.
$sel:httpStatus:PutRecordBatchResponse'
, putRecordBatchResponse_httpStatus
- The response's http status code.
$sel:failedPutCount:PutRecordBatchResponse'
, putRecordBatchResponse_failedPutCount
- The number of records that might have failed processing. This number
might be greater than 0 even if the PutRecordBatch call succeeds. Check
FailedPutCount
to determine whether there are records that you need to
resend.
$sel:requestResponses:PutRecordBatchResponse'
, putRecordBatchResponse_requestResponses
- The results array. For each record, the index of the response element is
the same as the index used in the request array.
StartDeliveryStreamEncryption
data StartDeliveryStreamEncryption Source #
See: newStartDeliveryStreamEncryption
smart constructor.
Instances
newStartDeliveryStreamEncryption Source #
Create a value of StartDeliveryStreamEncryption
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:deliveryStreamEncryptionConfigurationInput:StartDeliveryStreamEncryption'
, startDeliveryStreamEncryption_deliveryStreamEncryptionConfigurationInput
- Used to specify the type and Amazon Resource Name (ARN) of the KMS key
needed for Server-Side Encryption (SSE).
StartDeliveryStreamEncryption
, startDeliveryStreamEncryption_deliveryStreamName
- The name of the delivery stream for which you want to enable server-side
encryption (SSE).
data StartDeliveryStreamEncryptionResponse Source #
See: newStartDeliveryStreamEncryptionResponse
smart constructor.
Instances
newStartDeliveryStreamEncryptionResponse Source #
Create a value of StartDeliveryStreamEncryptionResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:StartDeliveryStreamEncryptionResponse'
, startDeliveryStreamEncryptionResponse_httpStatus
- The response's http status code.
StopDeliveryStreamEncryption
data StopDeliveryStreamEncryption Source #
See: newStopDeliveryStreamEncryption
smart constructor.
Instances
newStopDeliveryStreamEncryption Source #
Create a value of StopDeliveryStreamEncryption
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
StopDeliveryStreamEncryption
, stopDeliveryStreamEncryption_deliveryStreamName
- The name of the delivery stream for which you want to disable
server-side encryption (SSE).
data StopDeliveryStreamEncryptionResponse Source #
See: newStopDeliveryStreamEncryptionResponse
smart constructor.
Instances
Generic StopDeliveryStreamEncryptionResponse Source # | |
Defined in Amazonka.Firehose.StopDeliveryStreamEncryption type Rep StopDeliveryStreamEncryptionResponse :: Type -> Type # | |
Read StopDeliveryStreamEncryptionResponse Source # | |
Show StopDeliveryStreamEncryptionResponse Source # | |
NFData StopDeliveryStreamEncryptionResponse Source # | |
Defined in Amazonka.Firehose.StopDeliveryStreamEncryption rnf :: StopDeliveryStreamEncryptionResponse -> () # | |
Eq StopDeliveryStreamEncryptionResponse Source # | |
type Rep StopDeliveryStreamEncryptionResponse Source # | |
Defined in Amazonka.Firehose.StopDeliveryStreamEncryption type Rep StopDeliveryStreamEncryptionResponse = D1 ('MetaData "StopDeliveryStreamEncryptionResponse" "Amazonka.Firehose.StopDeliveryStreamEncryption" "amazonka-kinesis-firehose-2.0-6l1hHmh2UnHBvolxuQFkWB" 'False) (C1 ('MetaCons "StopDeliveryStreamEncryptionResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))) |
newStopDeliveryStreamEncryptionResponse Source #
Create a value of StopDeliveryStreamEncryptionResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:StopDeliveryStreamEncryptionResponse'
, stopDeliveryStreamEncryptionResponse_httpStatus
- The response's http status code.
TagDeliveryStream
data TagDeliveryStream Source #
See: newTagDeliveryStream
smart constructor.
Instances
Create a value of TagDeliveryStream
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
TagDeliveryStream
, tagDeliveryStream_deliveryStreamName
- The name of the delivery stream to which you want to add the tags.
$sel:tags:TagDeliveryStream'
, tagDeliveryStream_tags
- A set of key-value pairs to use to create the tags.
data TagDeliveryStreamResponse Source #
See: newTagDeliveryStreamResponse
smart constructor.
Instances
newTagDeliveryStreamResponse Source #
Create a value of TagDeliveryStreamResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:TagDeliveryStreamResponse'
, tagDeliveryStreamResponse_httpStatus
- The response's http status code.
UntagDeliveryStream
data UntagDeliveryStream Source #
See: newUntagDeliveryStream
smart constructor.
Instances
newUntagDeliveryStream Source #
Create a value of UntagDeliveryStream
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
UntagDeliveryStream
, untagDeliveryStream_deliveryStreamName
- The name of the delivery stream.
$sel:tagKeys:UntagDeliveryStream'
, untagDeliveryStream_tagKeys
- A list of tag keys. Each corresponding tag is removed from the delivery
stream.
data UntagDeliveryStreamResponse Source #
See: newUntagDeliveryStreamResponse
smart constructor.
Instances
newUntagDeliveryStreamResponse Source #
Create a value of UntagDeliveryStreamResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:UntagDeliveryStreamResponse'
, untagDeliveryStreamResponse_httpStatus
- The response's http status code.
UpdateDestination
data UpdateDestination Source #
See: newUpdateDestination
smart constructor.
Instances
:: Text | |
-> Text | |
-> Text | |
-> UpdateDestination |
Create a value of UpdateDestination
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:amazonOpenSearchServerlessDestinationUpdate:UpdateDestination'
, updateDestination_amazonOpenSearchServerlessDestinationUpdate
- Describes an update for a destination in the Serverless offering for
Amazon OpenSearch Service.
$sel:amazonopensearchserviceDestinationUpdate:UpdateDestination'
, updateDestination_amazonopensearchserviceDestinationUpdate
- Describes an update for a destination in Amazon OpenSearch Service.
$sel:elasticsearchDestinationUpdate:UpdateDestination'
, updateDestination_elasticsearchDestinationUpdate
- Describes an update for a destination in Amazon ES.
$sel:extendedS3DestinationUpdate:UpdateDestination'
, updateDestination_extendedS3DestinationUpdate
- Describes an update for a destination in Amazon S3.
$sel:httpEndpointDestinationUpdate:UpdateDestination'
, updateDestination_httpEndpointDestinationUpdate
- Describes an update to the specified HTTP endpoint destination.
$sel:redshiftDestinationUpdate:UpdateDestination'
, updateDestination_redshiftDestinationUpdate
- Describes an update for a destination in Amazon Redshift.
$sel:s3DestinationUpdate:UpdateDestination'
, updateDestination_s3DestinationUpdate
- [Deprecated] Describes an update for a destination in Amazon S3.
$sel:splunkDestinationUpdate:UpdateDestination'
, updateDestination_splunkDestinationUpdate
- Describes an update for a destination in Splunk.
UpdateDestination
, updateDestination_deliveryStreamName
- The name of the delivery stream.
$sel:currentDeliveryStreamVersionId:UpdateDestination'
, updateDestination_currentDeliveryStreamVersionId
- Obtain this value from the VersionId
result of
DeliveryStreamDescription. This value is required, and helps the service
perform conditional operations. For example, if there is an interleaving
update and this value is null, then the update destination fails. After
the update is successful, the VersionId
value is updated. The service
then performs a merge of the old configuration with the new
configuration.
UpdateDestination
, updateDestination_destinationId
- The ID of the destination.
data UpdateDestinationResponse Source #
See: newUpdateDestinationResponse
smart constructor.
Instances
newUpdateDestinationResponse Source #
Create a value of UpdateDestinationResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:UpdateDestinationResponse'
, updateDestinationResponse_httpStatus
- The response's http status code.
Types
AmazonOpenSearchServerlessS3BackupMode
newtype AmazonOpenSearchServerlessS3BackupMode Source #
Instances
AmazonopensearchserviceIndexRotationPeriod
newtype AmazonopensearchserviceIndexRotationPeriod Source #
Instances
AmazonopensearchserviceS3BackupMode
newtype AmazonopensearchserviceS3BackupMode Source #
pattern AmazonopensearchserviceS3BackupMode_AllDocuments :: AmazonopensearchserviceS3BackupMode | |
pattern AmazonopensearchserviceS3BackupMode_FailedDocumentsOnly :: AmazonopensearchserviceS3BackupMode |
Instances
CompressionFormat
newtype CompressionFormat Source #
pattern CompressionFormat_GZIP :: CompressionFormat | |
pattern CompressionFormat_HADOOP_SNAPPY :: CompressionFormat | |
pattern CompressionFormat_Snappy :: CompressionFormat | |
pattern CompressionFormat_UNCOMPRESSED :: CompressionFormat | |
pattern CompressionFormat_ZIP :: CompressionFormat |
Instances
ContentEncoding
newtype ContentEncoding Source #
pattern ContentEncoding_GZIP :: ContentEncoding | |
pattern ContentEncoding_NONE :: ContentEncoding |
Instances
DeliveryStreamEncryptionStatus
newtype DeliveryStreamEncryptionStatus Source #
Instances
DeliveryStreamFailureType
newtype DeliveryStreamFailureType Source #
Instances
DeliveryStreamStatus
newtype DeliveryStreamStatus Source #
Instances
DeliveryStreamType
newtype DeliveryStreamType Source #
pattern DeliveryStreamType_DirectPut :: DeliveryStreamType | |
pattern DeliveryStreamType_KinesisStreamAsSource :: DeliveryStreamType |
Instances
ElasticsearchIndexRotationPeriod
newtype ElasticsearchIndexRotationPeriod Source #
Instances
ElasticsearchS3BackupMode
newtype ElasticsearchS3BackupMode Source #
pattern ElasticsearchS3BackupMode_AllDocuments :: ElasticsearchS3BackupMode | |
pattern ElasticsearchS3BackupMode_FailedDocumentsOnly :: ElasticsearchS3BackupMode |
Instances
HECEndpointType
newtype HECEndpointType Source #
pattern HECEndpointType_Event :: HECEndpointType | |
pattern HECEndpointType_Raw :: HECEndpointType |
Instances
HttpEndpointS3BackupMode
newtype HttpEndpointS3BackupMode Source #
pattern HttpEndpointS3BackupMode_AllData :: HttpEndpointS3BackupMode | |
pattern HttpEndpointS3BackupMode_FailedDataOnly :: HttpEndpointS3BackupMode |
Instances
KeyType
pattern KeyType_AWS_OWNED_CMK :: KeyType | |
pattern KeyType_CUSTOMER_MANAGED_CMK :: KeyType |
Instances
NoEncryptionConfig
newtype NoEncryptionConfig Source #
Instances
OrcCompression
newtype OrcCompression Source #
pattern OrcCompression_NONE :: OrcCompression | |
pattern OrcCompression_SNAPPY :: OrcCompression | |
pattern OrcCompression_ZLIB :: OrcCompression |
Instances
OrcFormatVersion
newtype OrcFormatVersion Source #
pattern OrcFormatVersion_V0_11 :: OrcFormatVersion | |
pattern OrcFormatVersion_V0_12 :: OrcFormatVersion |
Instances
ParquetCompression
newtype ParquetCompression Source #
pattern ParquetCompression_GZIP :: ParquetCompression | |
pattern ParquetCompression_SNAPPY :: ParquetCompression | |
pattern ParquetCompression_UNCOMPRESSED :: ParquetCompression |
Instances
ParquetWriterVersion
newtype ParquetWriterVersion Source #
pattern ParquetWriterVersion_V1 :: ParquetWriterVersion | |
pattern ParquetWriterVersion_V2 :: ParquetWriterVersion |
Instances
ProcessorParameterName
newtype ProcessorParameterName Source #
Instances
ProcessorType
newtype ProcessorType Source #
pattern ProcessorType_AppendDelimiterToRecord :: ProcessorType | |
pattern ProcessorType_Lambda :: ProcessorType | |
pattern ProcessorType_MetadataExtraction :: ProcessorType | |
pattern ProcessorType_RecordDeAggregation :: ProcessorType |
Instances
RedshiftS3BackupMode
newtype RedshiftS3BackupMode Source #
pattern RedshiftS3BackupMode_Disabled :: RedshiftS3BackupMode | |
pattern RedshiftS3BackupMode_Enabled :: RedshiftS3BackupMode |
Instances
S3BackupMode
newtype S3BackupMode Source #
pattern S3BackupMode_Disabled :: S3BackupMode | |
pattern S3BackupMode_Enabled :: S3BackupMode |
Instances
SplunkS3BackupMode
newtype SplunkS3BackupMode Source #
pattern SplunkS3BackupMode_AllEvents :: SplunkS3BackupMode | |
pattern SplunkS3BackupMode_FailedEventsOnly :: SplunkS3BackupMode |
Instances
AmazonOpenSearchServerlessBufferingHints
data AmazonOpenSearchServerlessBufferingHints Source #
Describes the buffering to perform before delivering data to the Serverless offering for Amazon OpenSearch Service destination.
See: newAmazonOpenSearchServerlessBufferingHints
smart constructor.
Instances
newAmazonOpenSearchServerlessBufferingHints :: AmazonOpenSearchServerlessBufferingHints Source #
Create a value of AmazonOpenSearchServerlessBufferingHints
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:intervalInSeconds:AmazonOpenSearchServerlessBufferingHints'
, amazonOpenSearchServerlessBufferingHints_intervalInSeconds
- Buffer incoming data for the specified period of time, in seconds,
before delivering it to the destination. The default value is 300 (5
minutes).
$sel:sizeInMBs:AmazonOpenSearchServerlessBufferingHints'
, amazonOpenSearchServerlessBufferingHints_sizeInMBs
- Buffer incoming data to the specified size, in MBs, before delivering it
to the destination. The default value is 5.
We recommend setting this parameter to a value greater than the amount of data you typically ingest into the delivery stream in 10 seconds. For example, if you typically ingest data at 1 MB/sec, the value should be 10 MB or higher.
AmazonOpenSearchServerlessDestinationConfiguration
data AmazonOpenSearchServerlessDestinationConfiguration Source #
Describes the configuration of a destination in the Serverless offering for Amazon OpenSearch Service.
See: newAmazonOpenSearchServerlessDestinationConfiguration
smart constructor.
Instances
newAmazonOpenSearchServerlessDestinationConfiguration Source #
Create a value of AmazonOpenSearchServerlessDestinationConfiguration
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
AmazonOpenSearchServerlessDestinationConfiguration
, amazonOpenSearchServerlessDestinationConfiguration_bufferingHints
- The buffering options. If no value is specified, the default values for
AmazonopensearchserviceBufferingHints are used.
AmazonOpenSearchServerlessDestinationConfiguration
, amazonOpenSearchServerlessDestinationConfiguration_cloudWatchLoggingOptions
- Undocumented member.
$sel:collectionEndpoint:AmazonOpenSearchServerlessDestinationConfiguration'
, amazonOpenSearchServerlessDestinationConfiguration_collectionEndpoint
- The endpoint to use when communicating with the collection in the
Serverless offering for Amazon OpenSearch Service.
$sel:processingConfiguration:AmazonOpenSearchServerlessDestinationConfiguration'
, amazonOpenSearchServerlessDestinationConfiguration_processingConfiguration
- Undocumented member.
$sel:retryOptions:AmazonOpenSearchServerlessDestinationConfiguration'
, amazonOpenSearchServerlessDestinationConfiguration_retryOptions
- The retry behavior in case Kinesis Data Firehose is unable to deliver
documents to the Serverless offering for Amazon OpenSearch Service. The
default value is 300 (5 minutes).
$sel:s3BackupMode:AmazonOpenSearchServerlessDestinationConfiguration'
, amazonOpenSearchServerlessDestinationConfiguration_s3BackupMode
- Defines how documents should be delivered to Amazon S3. When it is set
to FailedDocumentsOnly, Kinesis Data Firehose writes any documents that
could not be indexed to the configured Amazon S3 destination, with
AmazonOpenSearchService-failed/ appended to the key prefix. When set to
AllDocuments, Kinesis Data Firehose delivers all incoming records to
Amazon S3, and also writes failed documents with
AmazonOpenSearchService-failed/ appended to the prefix.
$sel:vpcConfiguration:AmazonOpenSearchServerlessDestinationConfiguration'
, amazonOpenSearchServerlessDestinationConfiguration_vpcConfiguration
- Undocumented member.
AmazonOpenSearchServerlessDestinationConfiguration
, amazonOpenSearchServerlessDestinationConfiguration_roleARN
- The Amazon Resource Name (ARN) of the IAM role to be assumed by Kinesis
Data Firehose for calling the Serverless offering for Amazon OpenSearch
Service Configuration API and for indexing documents.
$sel:indexName:AmazonOpenSearchServerlessDestinationConfiguration'
, amazonOpenSearchServerlessDestinationConfiguration_indexName
- The Serverless offering for Amazon OpenSearch Service index name.
$sel:s3Configuration:AmazonOpenSearchServerlessDestinationConfiguration'
, amazonOpenSearchServerlessDestinationConfiguration_s3Configuration
- Undocumented member.
AmazonOpenSearchServerlessDestinationDescription
data AmazonOpenSearchServerlessDestinationDescription Source #
The destination description in the Serverless offering for Amazon OpenSearch Service.
See: newAmazonOpenSearchServerlessDestinationDescription
smart constructor.
Instances
newAmazonOpenSearchServerlessDestinationDescription :: AmazonOpenSearchServerlessDestinationDescription Source #
Create a value of AmazonOpenSearchServerlessDestinationDescription
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
AmazonOpenSearchServerlessDestinationDescription
, amazonOpenSearchServerlessDestinationDescription_bufferingHints
- The buffering options.
AmazonOpenSearchServerlessDestinationDescription
, amazonOpenSearchServerlessDestinationDescription_cloudWatchLoggingOptions
- Undocumented member.
$sel:collectionEndpoint:AmazonOpenSearchServerlessDestinationDescription'
, amazonOpenSearchServerlessDestinationDescription_collectionEndpoint
- The endpoint to use when communicating with the collection in the
Serverless offering for Amazon OpenSearch Service.
$sel:indexName:AmazonOpenSearchServerlessDestinationDescription'
, amazonOpenSearchServerlessDestinationDescription_indexName
- The Serverless offering for Amazon OpenSearch Service index name.
$sel:processingConfiguration:AmazonOpenSearchServerlessDestinationDescription'
, amazonOpenSearchServerlessDestinationDescription_processingConfiguration
- Undocumented member.
$sel:retryOptions:AmazonOpenSearchServerlessDestinationDescription'
, amazonOpenSearchServerlessDestinationDescription_retryOptions
- The Serverless offering for Amazon OpenSearch Service retry options.
AmazonOpenSearchServerlessDestinationDescription
, amazonOpenSearchServerlessDestinationDescription_roleARN
- The Amazon Resource Name (ARN) of the AWS credentials.
$sel:s3BackupMode:AmazonOpenSearchServerlessDestinationDescription'
, amazonOpenSearchServerlessDestinationDescription_s3BackupMode
- The Amazon S3 backup mode.
$sel:s3DestinationDescription:AmazonOpenSearchServerlessDestinationDescription'
, amazonOpenSearchServerlessDestinationDescription_s3DestinationDescription
- Undocumented member.
$sel:vpcConfigurationDescription:AmazonOpenSearchServerlessDestinationDescription'
, amazonOpenSearchServerlessDestinationDescription_vpcConfigurationDescription
- Undocumented member.
AmazonOpenSearchServerlessDestinationUpdate
data AmazonOpenSearchServerlessDestinationUpdate Source #
Describes an update for a destination in the Serverless offering for Amazon OpenSearch Service.
See: newAmazonOpenSearchServerlessDestinationUpdate
smart constructor.
Instances
newAmazonOpenSearchServerlessDestinationUpdate :: AmazonOpenSearchServerlessDestinationUpdate Source #
Create a value of AmazonOpenSearchServerlessDestinationUpdate
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
AmazonOpenSearchServerlessDestinationUpdate
, amazonOpenSearchServerlessDestinationUpdate_bufferingHints
- The buffering options. If no value is specified,
AmazonopensearchBufferingHints object default values are used.
AmazonOpenSearchServerlessDestinationUpdate
, amazonOpenSearchServerlessDestinationUpdate_cloudWatchLoggingOptions
- Undocumented member.
$sel:collectionEndpoint:AmazonOpenSearchServerlessDestinationUpdate'
, amazonOpenSearchServerlessDestinationUpdate_collectionEndpoint
- The endpoint to use when communicating with the collection in the
Serverless offering for Amazon OpenSearch Service.
$sel:indexName:AmazonOpenSearchServerlessDestinationUpdate'
, amazonOpenSearchServerlessDestinationUpdate_indexName
- The Serverless offering for Amazon OpenSearch Service index name.
$sel:processingConfiguration:AmazonOpenSearchServerlessDestinationUpdate'
, amazonOpenSearchServerlessDestinationUpdate_processingConfiguration
- Undocumented member.
$sel:retryOptions:AmazonOpenSearchServerlessDestinationUpdate'
, amazonOpenSearchServerlessDestinationUpdate_retryOptions
- The retry behavior in case Kinesis Data Firehose is unable to deliver
documents to the Serverless offering for Amazon OpenSearch Service. The
default value is 300 (5 minutes).
AmazonOpenSearchServerlessDestinationUpdate
, amazonOpenSearchServerlessDestinationUpdate_roleARN
- The Amazon Resource Name (ARN) of the IAM role to be assumed by Kinesis
Data Firehose for calling the Serverless offering for Amazon OpenSearch
Service Configuration API and for indexing documents.
$sel:s3Update:AmazonOpenSearchServerlessDestinationUpdate'
, amazonOpenSearchServerlessDestinationUpdate_s3Update
- Undocumented member.
AmazonOpenSearchServerlessRetryOptions
data AmazonOpenSearchServerlessRetryOptions Source #
Configures retry behavior in case Kinesis Data Firehose is unable to deliver documents to the Serverless offering for Amazon OpenSearch Service.
See: newAmazonOpenSearchServerlessRetryOptions
smart constructor.
Instances
FromJSON AmazonOpenSearchServerlessRetryOptions Source # | |
ToJSON AmazonOpenSearchServerlessRetryOptions Source # | |
Generic AmazonOpenSearchServerlessRetryOptions Source # | |
Read AmazonOpenSearchServerlessRetryOptions Source # | |
Show AmazonOpenSearchServerlessRetryOptions Source # | |
NFData AmazonOpenSearchServerlessRetryOptions Source # | |
Eq AmazonOpenSearchServerlessRetryOptions Source # | |
Hashable AmazonOpenSearchServerlessRetryOptions Source # | |
type Rep AmazonOpenSearchServerlessRetryOptions Source # | |
Defined in Amazonka.Firehose.Types.AmazonOpenSearchServerlessRetryOptions type Rep AmazonOpenSearchServerlessRetryOptions = D1 ('MetaData "AmazonOpenSearchServerlessRetryOptions" "Amazonka.Firehose.Types.AmazonOpenSearchServerlessRetryOptions" "amazonka-kinesis-firehose-2.0-6l1hHmh2UnHBvolxuQFkWB" 'False) (C1 ('MetaCons "AmazonOpenSearchServerlessRetryOptions'" 'PrefixI 'True) (S1 ('MetaSel ('Just "durationInSeconds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)))) |
newAmazonOpenSearchServerlessRetryOptions :: AmazonOpenSearchServerlessRetryOptions Source #
Create a value of AmazonOpenSearchServerlessRetryOptions
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:durationInSeconds:AmazonOpenSearchServerlessRetryOptions'
, amazonOpenSearchServerlessRetryOptions_durationInSeconds
- After an initial failure to deliver to the Serverless offering for
Amazon OpenSearch Service, the total amount of time during which Kinesis
Data Firehose retries delivery (including the first attempt). After this
time has elapsed, the failed documents are written to Amazon S3. Default
value is 300 seconds (5 minutes). A value of 0 (zero) results in no
retries.
AmazonopensearchserviceBufferingHints
data AmazonopensearchserviceBufferingHints Source #
Describes the buffering to perform before delivering data to the Amazon OpenSearch Service destination.
See: newAmazonopensearchserviceBufferingHints
smart constructor.
Instances
newAmazonopensearchserviceBufferingHints :: AmazonopensearchserviceBufferingHints Source #
Create a value of AmazonopensearchserviceBufferingHints
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:intervalInSeconds:AmazonopensearchserviceBufferingHints'
, amazonopensearchserviceBufferingHints_intervalInSeconds
- Buffer incoming data for the specified period of time, in seconds,
before delivering it to the destination. The default value is 300 (5
minutes).
$sel:sizeInMBs:AmazonopensearchserviceBufferingHints'
, amazonopensearchserviceBufferingHints_sizeInMBs
- Buffer incoming data to the specified size, in MBs, before delivering it
to the destination. The default value is 5.
We recommend setting this parameter to a value greater than the amount of data you typically ingest into the delivery stream in 10 seconds. For example, if you typically ingest data at 1 MB/sec, the value should be 10 MB or higher.
AmazonopensearchserviceDestinationConfiguration
data AmazonopensearchserviceDestinationConfiguration Source #
Describes the configuration of a destination in Amazon OpenSearch Service
See: newAmazonopensearchserviceDestinationConfiguration
smart constructor.
Instances
newAmazonopensearchserviceDestinationConfiguration Source #
Create a value of AmazonopensearchserviceDestinationConfiguration
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
AmazonopensearchserviceDestinationConfiguration
, amazonopensearchserviceDestinationConfiguration_bufferingHints
- The buffering options. If no value is specified, the default values for
AmazonopensearchserviceBufferingHints are used.
AmazonopensearchserviceDestinationConfiguration
, amazonopensearchserviceDestinationConfiguration_cloudWatchLoggingOptions
- Undocumented member.
$sel:clusterEndpoint:AmazonopensearchserviceDestinationConfiguration'
, amazonopensearchserviceDestinationConfiguration_clusterEndpoint
- The endpoint to use when communicating with the cluster. Specify either
this ClusterEndpoint or the DomainARN field.
$sel:domainARN:AmazonopensearchserviceDestinationConfiguration'
, amazonopensearchserviceDestinationConfiguration_domainARN
- The ARN of the Amazon OpenSearch Service domain. The IAM role must have
permissions for DescribeElasticsearchDomain,
DescribeElasticsearchDomains, and DescribeElasticsearchDomainConfig
after assuming the role specified in RoleARN.
$sel:indexRotationPeriod:AmazonopensearchserviceDestinationConfiguration'
, amazonopensearchserviceDestinationConfiguration_indexRotationPeriod
- The Amazon OpenSearch Service index rotation period. Index rotation
appends a timestamp to the IndexName to facilitate the expiration of old
data.
$sel:processingConfiguration:AmazonopensearchserviceDestinationConfiguration'
, amazonopensearchserviceDestinationConfiguration_processingConfiguration
- Undocumented member.
$sel:retryOptions:AmazonopensearchserviceDestinationConfiguration'
, amazonopensearchserviceDestinationConfiguration_retryOptions
- The retry behavior in case Kinesis Data Firehose is unable to deliver
documents to Amazon OpenSearch Service. The default value is 300 (5
minutes).
$sel:s3BackupMode:AmazonopensearchserviceDestinationConfiguration'
, amazonopensearchserviceDestinationConfiguration_s3BackupMode
- Defines how documents should be delivered to Amazon S3. When it is set
to FailedDocumentsOnly, Kinesis Data Firehose writes any documents that
could not be indexed to the configured Amazon S3 destination, with
AmazonOpenSearchService-failed/ appended to the key prefix. When set to
AllDocuments, Kinesis Data Firehose delivers all incoming records to
Amazon S3, and also writes failed documents with
AmazonOpenSearchService-failed/ appended to the prefix.
$sel:typeName:AmazonopensearchserviceDestinationConfiguration'
, amazonopensearchserviceDestinationConfiguration_typeName
- The Amazon OpenSearch Service type name. For Elasticsearch 6.x, there
can be only one type per index. If you try to specify a new type for an
existing index that already has another type, Kinesis Data Firehose
returns an error during run time.
$sel:vpcConfiguration:AmazonopensearchserviceDestinationConfiguration'
, amazonopensearchserviceDestinationConfiguration_vpcConfiguration
- Undocumented member.
AmazonopensearchserviceDestinationConfiguration
, amazonopensearchserviceDestinationConfiguration_roleARN
- The Amazon Resource Name (ARN) of the IAM role to be assumed by Kinesis
Data Firehose for calling the Amazon OpenSearch Service Configuration
API and for indexing documents.
$sel:indexName:AmazonopensearchserviceDestinationConfiguration'
, amazonopensearchserviceDestinationConfiguration_indexName
- The ElasticsearAmazon OpenSearch Service index name.
$sel:s3Configuration:AmazonopensearchserviceDestinationConfiguration'
, amazonopensearchserviceDestinationConfiguration_s3Configuration
- Undocumented member.
AmazonopensearchserviceDestinationDescription
data AmazonopensearchserviceDestinationDescription Source #
The destination description in Amazon OpenSearch Service.
See: newAmazonopensearchserviceDestinationDescription
smart constructor.
Instances
newAmazonopensearchserviceDestinationDescription :: AmazonopensearchserviceDestinationDescription Source #
Create a value of AmazonopensearchserviceDestinationDescription
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
AmazonopensearchserviceDestinationDescription
, amazonopensearchserviceDestinationDescription_bufferingHints
- The buffering options.
AmazonopensearchserviceDestinationDescription
, amazonopensearchserviceDestinationDescription_cloudWatchLoggingOptions
- Undocumented member.
$sel:clusterEndpoint:AmazonopensearchserviceDestinationDescription'
, amazonopensearchserviceDestinationDescription_clusterEndpoint
- The endpoint to use when communicating with the cluster. Kinesis Data
Firehose uses either this ClusterEndpoint or the DomainARN field to send
data to Amazon OpenSearch Service.
$sel:domainARN:AmazonopensearchserviceDestinationDescription'
, amazonopensearchserviceDestinationDescription_domainARN
- The ARN of the Amazon OpenSearch Service domain.
$sel:indexName:AmazonopensearchserviceDestinationDescription'
, amazonopensearchserviceDestinationDescription_indexName
- The Amazon OpenSearch Service index name.
$sel:indexRotationPeriod:AmazonopensearchserviceDestinationDescription'
, amazonopensearchserviceDestinationDescription_indexRotationPeriod
- The Amazon OpenSearch Service index rotation period
$sel:processingConfiguration:AmazonopensearchserviceDestinationDescription'
, amazonopensearchserviceDestinationDescription_processingConfiguration
- Undocumented member.
$sel:retryOptions:AmazonopensearchserviceDestinationDescription'
, amazonopensearchserviceDestinationDescription_retryOptions
- The Amazon OpenSearch Service retry options.
AmazonopensearchserviceDestinationDescription
, amazonopensearchserviceDestinationDescription_roleARN
- The Amazon Resource Name (ARN) of the Amazon Web Services credentials.
$sel:s3BackupMode:AmazonopensearchserviceDestinationDescription'
, amazonopensearchserviceDestinationDescription_s3BackupMode
- The Amazon S3 backup mode.
$sel:s3DestinationDescription:AmazonopensearchserviceDestinationDescription'
, amazonopensearchserviceDestinationDescription_s3DestinationDescription
- Undocumented member.
$sel:typeName:AmazonopensearchserviceDestinationDescription'
, amazonopensearchserviceDestinationDescription_typeName
- The Amazon OpenSearch Service type name. This applies to Elasticsearch
6.x and lower versions. For Elasticsearch 7.x and OpenSearch Service
1.x, there's no value for TypeName.
$sel:vpcConfigurationDescription:AmazonopensearchserviceDestinationDescription'
, amazonopensearchserviceDestinationDescription_vpcConfigurationDescription
- Undocumented member.
AmazonopensearchserviceDestinationUpdate
data AmazonopensearchserviceDestinationUpdate Source #
Describes an update for a destination in Amazon OpenSearch Service.
See: newAmazonopensearchserviceDestinationUpdate
smart constructor.
Instances
newAmazonopensearchserviceDestinationUpdate :: AmazonopensearchserviceDestinationUpdate Source #
Create a value of AmazonopensearchserviceDestinationUpdate
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
AmazonopensearchserviceDestinationUpdate
, amazonopensearchserviceDestinationUpdate_bufferingHints
- The buffering options. If no value is specified,
AmazonopensearchBufferingHints object default values are used.
AmazonopensearchserviceDestinationUpdate
, amazonopensearchserviceDestinationUpdate_cloudWatchLoggingOptions
- Undocumented member.
$sel:clusterEndpoint:AmazonopensearchserviceDestinationUpdate'
, amazonopensearchserviceDestinationUpdate_clusterEndpoint
- The endpoint to use when communicating with the cluster. Specify either
this ClusterEndpoint or the DomainARN field.
$sel:domainARN:AmazonopensearchserviceDestinationUpdate'
, amazonopensearchserviceDestinationUpdate_domainARN
- The ARN of the Amazon OpenSearch Service domain. The IAM role must have
permissions for DescribeDomain, DescribeDomains, and
DescribeDomainConfig after assuming the IAM role specified in RoleARN.
$sel:indexName:AmazonopensearchserviceDestinationUpdate'
, amazonopensearchserviceDestinationUpdate_indexName
- The Amazon OpenSearch Service index name.
$sel:indexRotationPeriod:AmazonopensearchserviceDestinationUpdate'
, amazonopensearchserviceDestinationUpdate_indexRotationPeriod
- The Amazon OpenSearch Service index rotation period. Index rotation
appends a timestamp to IndexName to facilitate the expiration of old
data.
$sel:processingConfiguration:AmazonopensearchserviceDestinationUpdate'
, amazonopensearchserviceDestinationUpdate_processingConfiguration
- Undocumented member.
$sel:retryOptions:AmazonopensearchserviceDestinationUpdate'
, amazonopensearchserviceDestinationUpdate_retryOptions
- The retry behavior in case Kinesis Data Firehose is unable to deliver
documents to Amazon OpenSearch Service. The default value is 300 (5
minutes).
AmazonopensearchserviceDestinationUpdate
, amazonopensearchserviceDestinationUpdate_roleARN
- The Amazon Resource Name (ARN) of the IAM role to be assumed by Kinesis
Data Firehose for calling the Amazon OpenSearch Service Configuration
API and for indexing documents.
$sel:s3Update:AmazonopensearchserviceDestinationUpdate'
, amazonopensearchserviceDestinationUpdate_s3Update
- Undocumented member.
$sel:typeName:AmazonopensearchserviceDestinationUpdate'
, amazonopensearchserviceDestinationUpdate_typeName
- The Amazon OpenSearch Service type name. For Elasticsearch 6.x, there
can be only one type per index. If you try to specify a new type for an
existing index that already has another type, Kinesis Data Firehose
returns an error during runtime.
If you upgrade Elasticsearch from 6.x to 7.x and don’t update your delivery stream, Kinesis Data Firehose still delivers data to Elasticsearch with the old index name and type name. If you want to update your delivery stream with a new index name, provide an empty string for TypeName.
AmazonopensearchserviceRetryOptions
data AmazonopensearchserviceRetryOptions Source #
Configures retry behavior in case Kinesis Data Firehose is unable to deliver documents to Amazon OpenSearch Service.
See: newAmazonopensearchserviceRetryOptions
smart constructor.
Instances
newAmazonopensearchserviceRetryOptions :: AmazonopensearchserviceRetryOptions Source #
Create a value of AmazonopensearchserviceRetryOptions
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:durationInSeconds:AmazonopensearchserviceRetryOptions'
, amazonopensearchserviceRetryOptions_durationInSeconds
- After an initial failure to deliver to Amazon OpenSearch Service, the
total amount of time during which Kinesis Data Firehose retries delivery
(including the first attempt). After this time has elapsed, the failed
documents are written to Amazon S3. Default value is 300 seconds (5
minutes). A value of 0 (zero) results in no retries.
BufferingHints
data BufferingHints Source #
Describes hints for the buffering to perform before delivering data to
the destination. These options are treated as hints, and therefore
Kinesis Data Firehose might choose to use different values when it is
optimal. The SizeInMBs
and IntervalInSeconds
parameters are
optional. However, if specify a value for one of them, you must also
provide a value for the other.
See: newBufferingHints
smart constructor.
Instances
newBufferingHints :: BufferingHints Source #
Create a value of BufferingHints
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:intervalInSeconds:BufferingHints'
, bufferingHints_intervalInSeconds
- Buffer incoming data for the specified period of time, in seconds,
before delivering it to the destination. The default value is 300. This
parameter is optional but if you specify a value for it, you must also
specify a value for SizeInMBs
, and vice versa.
$sel:sizeInMBs:BufferingHints'
, bufferingHints_sizeInMBs
- Buffer incoming data to the specified size, in MiBs, before delivering
it to the destination. The default value is 5. This parameter is
optional but if you specify a value for it, you must also specify a
value for IntervalInSeconds
, and vice versa.
We recommend setting this parameter to a value greater than the amount of data you typically ingest into the delivery stream in 10 seconds. For example, if you typically ingest data at 1 MiB/sec, the value should be 10 MiB or higher.
CloudWatchLoggingOptions
data CloudWatchLoggingOptions Source #
Describes the Amazon CloudWatch logging options for your delivery stream.
See: newCloudWatchLoggingOptions
smart constructor.
Instances
newCloudWatchLoggingOptions :: CloudWatchLoggingOptions Source #
Create a value of CloudWatchLoggingOptions
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:enabled:CloudWatchLoggingOptions'
, cloudWatchLoggingOptions_enabled
- Enables or disables CloudWatch logging.
$sel:logGroupName:CloudWatchLoggingOptions'
, cloudWatchLoggingOptions_logGroupName
- The CloudWatch group name for logging. This value is required if
CloudWatch logging is enabled.
$sel:logStreamName:CloudWatchLoggingOptions'
, cloudWatchLoggingOptions_logStreamName
- The CloudWatch log stream name for logging. This value is required if
CloudWatch logging is enabled.
CopyCommand
data CopyCommand Source #
Describes a COPY
command for Amazon Redshift.
See: newCopyCommand
smart constructor.
Instances
Create a value of CopyCommand
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:copyOptions:CopyCommand'
, copyCommand_copyOptions
- Optional parameters to use with the Amazon Redshift COPY
command. For
more information, see the "Optional Parameters" section of
Amazon Redshift COPY command.
Some possible examples that would apply to Kinesis Data Firehose are as
follows:
delimiter '\t' lzop;
- fields are delimited with "\t" (TAB
character) and compressed using lzop.
delimiter '|'
- fields are delimited with "|" (this is the default
delimiter).
delimiter '|' escape
- the delimiter should be escaped.
fixedwidth 'venueid:3,venuename:25,venuecity:12,venuestate:2,venueseats:6'
- fields are fixed width in the source, with each width specified after
every column in the table.
JSON 's3://mybucket/jsonpaths.txt'
- data is in JSON format, and
the path specified is the format of the data.
For more examples, see Amazon Redshift COPY command examples.
$sel:dataTableColumns:CopyCommand'
, copyCommand_dataTableColumns
- A comma-separated list of column names.
$sel:dataTableName:CopyCommand'
, copyCommand_dataTableName
- The name of the target table. The table must already exist in the
database.
DataFormatConversionConfiguration
data DataFormatConversionConfiguration Source #
Specifies that you want Kinesis Data Firehose to convert data from the JSON format to the Parquet or ORC format before writing it to Amazon S3. Kinesis Data Firehose uses the serializer and deserializer that you specify, in addition to the column information from the Amazon Web Services Glue table, to deserialize your input data from JSON and then serialize it to the Parquet or ORC format. For more information, see Kinesis Data Firehose Record Format Conversion.
See: newDataFormatConversionConfiguration
smart constructor.
DataFormatConversionConfiguration' (Maybe Bool) (Maybe InputFormatConfiguration) (Maybe OutputFormatConfiguration) (Maybe SchemaConfiguration) |
Instances
newDataFormatConversionConfiguration :: DataFormatConversionConfiguration Source #
Create a value of DataFormatConversionConfiguration
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:enabled:DataFormatConversionConfiguration'
, dataFormatConversionConfiguration_enabled
- Defaults to true
. Set it to false
if you want to disable format
conversion while preserving the configuration details.
$sel:inputFormatConfiguration:DataFormatConversionConfiguration'
, dataFormatConversionConfiguration_inputFormatConfiguration
- Specifies the deserializer that you want Kinesis Data Firehose to use to
convert the format of your data from JSON. This parameter is required if
Enabled
is set to true.
$sel:outputFormatConfiguration:DataFormatConversionConfiguration'
, dataFormatConversionConfiguration_outputFormatConfiguration
- Specifies the serializer that you want Kinesis Data Firehose to use to
convert the format of your data to the Parquet or ORC format. This
parameter is required if Enabled
is set to true.
$sel:schemaConfiguration:DataFormatConversionConfiguration'
, dataFormatConversionConfiguration_schemaConfiguration
- Specifies the Amazon Web Services Glue Data Catalog table that contains
the column information. This parameter is required if Enabled
is set
to true.
DeliveryStreamDescription
data DeliveryStreamDescription Source #
Contains information about a delivery stream.
See: newDeliveryStreamDescription
smart constructor.
Instances
newDeliveryStreamDescription Source #
:: Text | |
-> Text | |
-> DeliveryStreamStatus | |
-> DeliveryStreamType | |
-> Text | |
-> Bool | |
-> DeliveryStreamDescription |
Create a value of DeliveryStreamDescription
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:createTimestamp:DeliveryStreamDescription'
, deliveryStreamDescription_createTimestamp
- The date and time that the delivery stream was created.
$sel:deliveryStreamEncryptionConfiguration:DeliveryStreamDescription'
, deliveryStreamDescription_deliveryStreamEncryptionConfiguration
- Indicates the server-side encryption (SSE) status for the delivery
stream.
DeliveryStreamDescription
, deliveryStreamDescription_failureDescription
- Provides details in case one of the following operations fails due to an
error related to KMS: CreateDeliveryStream, DeleteDeliveryStream,
StartDeliveryStreamEncryption, StopDeliveryStreamEncryption.
$sel:lastUpdateTimestamp:DeliveryStreamDescription'
, deliveryStreamDescription_lastUpdateTimestamp
- The date and time that the delivery stream was last updated.
$sel:source:DeliveryStreamDescription'
, deliveryStreamDescription_source
- If the DeliveryStreamType
parameter is KinesisStreamAsSource
, a
SourceDescription object describing the source Kinesis data stream.
$sel:deliveryStreamName:DeliveryStreamDescription'
, deliveryStreamDescription_deliveryStreamName
- The name of the delivery stream.
$sel:deliveryStreamARN:DeliveryStreamDescription'
, deliveryStreamDescription_deliveryStreamARN
- The Amazon Resource Name (ARN) of the delivery stream. For more
information, see
Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.
$sel:deliveryStreamStatus:DeliveryStreamDescription'
, deliveryStreamDescription_deliveryStreamStatus
- The status of the delivery stream. If the status of a delivery stream is
CREATING_FAILED
, this status doesn't change, and you can't invoke
CreateDeliveryStream
again on it. However, you can invoke the
DeleteDeliveryStream operation to delete it.
$sel:deliveryStreamType:DeliveryStreamDescription'
, deliveryStreamDescription_deliveryStreamType
- The delivery stream type. This can be one of the following values:
DirectPut
: Provider applications access the delivery stream directly.KinesisStreamAsSource
: The delivery stream uses a Kinesis data stream as a source.
$sel:versionId:DeliveryStreamDescription'
, deliveryStreamDescription_versionId
- Each time the destination is updated for a delivery stream, the version
ID is changed, and the current version ID is required when updating the
destination. This is so that the service knows it is applying the
changes to the correct version of the delivery stream.
$sel:destinations:DeliveryStreamDescription'
, deliveryStreamDescription_destinations
- The destinations.
$sel:hasMoreDestinations:DeliveryStreamDescription'
, deliveryStreamDescription_hasMoreDestinations
- Indicates whether there are more destinations available to list.
DeliveryStreamEncryptionConfiguration
data DeliveryStreamEncryptionConfiguration Source #
Contains information about the server-side encryption (SSE) status for
the delivery stream, the type customer master key (CMK) in use, if any,
and the ARN of the CMK. You can get
DeliveryStreamEncryptionConfiguration
by invoking the
DescribeDeliveryStream operation.
See: newDeliveryStreamEncryptionConfiguration
smart constructor.
DeliveryStreamEncryptionConfiguration' (Maybe FailureDescription) (Maybe Text) (Maybe KeyType) (Maybe DeliveryStreamEncryptionStatus) |
Instances
newDeliveryStreamEncryptionConfiguration :: DeliveryStreamEncryptionConfiguration Source #
Create a value of DeliveryStreamEncryptionConfiguration
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:failureDescription:DeliveryStreamEncryptionConfiguration'
, deliveryStreamEncryptionConfiguration_failureDescription
- Provides details in case one of the following operations fails due to an
error related to KMS: CreateDeliveryStream, DeleteDeliveryStream,
StartDeliveryStreamEncryption, StopDeliveryStreamEncryption.
$sel:keyARN:DeliveryStreamEncryptionConfiguration'
, deliveryStreamEncryptionConfiguration_keyARN
- If KeyType
is CUSTOMER_MANAGED_CMK
, this field contains the ARN of
the customer managed CMK. If KeyType
is
Amazon Web Services_OWNED_CMK
, DeliveryStreamEncryptionConfiguration
doesn't contain a value for KeyARN
.
$sel:keyType:DeliveryStreamEncryptionConfiguration'
, deliveryStreamEncryptionConfiguration_keyType
- Indicates the type of customer master key (CMK) that is used for
encryption. The default setting is Amazon Web Services_OWNED_CMK
. For
more information about CMKs, see
Customer Master Keys (CMKs).
$sel:status:DeliveryStreamEncryptionConfiguration'
, deliveryStreamEncryptionConfiguration_status
- This is the server-side encryption (SSE) status for the delivery stream.
For a full description of the different values of this status, see
StartDeliveryStreamEncryption and StopDeliveryStreamEncryption. If this
status is ENABLING_FAILED
or DISABLING_FAILED
, it is the status of
the most recent attempt to enable or disable SSE, respectively.
DeliveryStreamEncryptionConfigurationInput
data DeliveryStreamEncryptionConfigurationInput Source #
Specifies the type and Amazon Resource Name (ARN) of the CMK to use for Server-Side Encryption (SSE).
See: newDeliveryStreamEncryptionConfigurationInput
smart constructor.
Instances
newDeliveryStreamEncryptionConfigurationInput Source #
Create a value of DeliveryStreamEncryptionConfigurationInput
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:keyARN:DeliveryStreamEncryptionConfigurationInput'
, deliveryStreamEncryptionConfigurationInput_keyARN
- If you set KeyType
to CUSTOMER_MANAGED_CMK
, you must specify the
Amazon Resource Name (ARN) of the CMK. If you set KeyType
to
Amazon Web Services_OWNED_CMK
, Kinesis Data Firehose uses a
service-account CMK.
$sel:keyType:DeliveryStreamEncryptionConfigurationInput'
, deliveryStreamEncryptionConfigurationInput_keyType
- Indicates the type of customer master key (CMK) to use for encryption.
The default setting is Amazon Web Services_OWNED_CMK
. For more
information about CMKs, see
Customer Master Keys (CMKs).
When you invoke CreateDeliveryStream or StartDeliveryStreamEncryption
with KeyType
set to CUSTOMER_MANAGED_CMK, Kinesis Data Firehose
invokes the Amazon KMS operation
CreateGrant
to create a grant that allows the Kinesis Data Firehose service to use
the customer managed CMK to perform encryption and decryption. Kinesis
Data Firehose manages that grant.
When you invoke StartDeliveryStreamEncryption to change the CMK for a delivery stream that is encrypted with a customer managed CMK, Kinesis Data Firehose schedules the grant it had on the old CMK for retirement.
You can use a CMK of type CUSTOMER_MANAGED_CMK to encrypt up to 500
delivery streams. If a CreateDeliveryStream or
StartDeliveryStreamEncryption operation exceeds this limit, Kinesis Data
Firehose throws a LimitExceededException
.
To encrypt your delivery stream, use symmetric CMKs. Kinesis Data Firehose doesn't support asymmetric CMKs. For information about symmetric and asymmetric CMKs, see About Symmetric and Asymmetric CMKs in the Amazon Web Services Key Management Service developer guide.
Deserializer
data Deserializer Source #
The deserializer you want Kinesis Data Firehose to use for converting the input data from JSON. Kinesis Data Firehose then serializes the data to its final format using the Serializer. Kinesis Data Firehose supports two types of deserializers: the Apache Hive JSON SerDe and the OpenX JSON SerDe.
See: newDeserializer
smart constructor.
Instances
newDeserializer :: Deserializer Source #
Create a value of Deserializer
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:hiveJsonSerDe:Deserializer'
, deserializer_hiveJsonSerDe
- The native Hive / HCatalog JsonSerDe. Used by Kinesis Data Firehose for
deserializing data, which means converting it from the JSON format in
preparation for serializing it to the Parquet or ORC format. This is one
of two deserializers you can choose, depending on which one offers the
functionality you need. The other option is the OpenX SerDe.
$sel:openXJsonSerDe:Deserializer'
, deserializer_openXJsonSerDe
- The OpenX SerDe. Used by Kinesis Data Firehose for deserializing data,
which means converting it from the JSON format in preparation for
serializing it to the Parquet or ORC format. This is one of two
deserializers you can choose, depending on which one offers the
functionality you need. The other option is the native Hive / HCatalog
JsonSerDe.
DestinationDescription
data DestinationDescription Source #
Describes the destination for a delivery stream.
See: newDestinationDescription
smart constructor.
Instances
newDestinationDescription Source #
Create a value of DestinationDescription
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:amazonOpenSearchServerlessDestinationDescription:DestinationDescription'
, destinationDescription_amazonOpenSearchServerlessDestinationDescription
- The destination in the Serverless offering for Amazon OpenSearch
Service.
$sel:amazonopensearchserviceDestinationDescription:DestinationDescription'
, destinationDescription_amazonopensearchserviceDestinationDescription
- The destination in Amazon OpenSearch Service.
$sel:elasticsearchDestinationDescription:DestinationDescription'
, destinationDescription_elasticsearchDestinationDescription
- The destination in Amazon ES.
$sel:extendedS3DestinationDescription:DestinationDescription'
, destinationDescription_extendedS3DestinationDescription
- The destination in Amazon S3.
$sel:httpEndpointDestinationDescription:DestinationDescription'
, destinationDescription_httpEndpointDestinationDescription
- Describes the specified HTTP endpoint destination.
$sel:redshiftDestinationDescription:DestinationDescription'
, destinationDescription_redshiftDestinationDescription
- The destination in Amazon Redshift.
DestinationDescription
, destinationDescription_s3DestinationDescription
- [Deprecated] The destination in Amazon S3.
$sel:splunkDestinationDescription:DestinationDescription'
, destinationDescription_splunkDestinationDescription
- The destination in Splunk.
$sel:destinationId:DestinationDescription'
, destinationDescription_destinationId
- The ID of the destination.
DynamicPartitioningConfiguration
data DynamicPartitioningConfiguration Source #
The configuration of the dynamic partitioning mechanism that creates smaller data sets from the streaming data by partitioning it based on partition keys. Currently, dynamic partitioning is only supported for Amazon S3 destinations.
See: newDynamicPartitioningConfiguration
smart constructor.
Instances
newDynamicPartitioningConfiguration :: DynamicPartitioningConfiguration Source #
Create a value of DynamicPartitioningConfiguration
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:enabled:DynamicPartitioningConfiguration'
, dynamicPartitioningConfiguration_enabled
- Specifies that the dynamic partitioning is enabled for this Kinesis Data
Firehose delivery stream.
$sel:retryOptions:DynamicPartitioningConfiguration'
, dynamicPartitioningConfiguration_retryOptions
- The retry behavior in case Kinesis Data Firehose is unable to deliver
data to an Amazon S3 prefix.
ElasticsearchBufferingHints
data ElasticsearchBufferingHints Source #
Describes the buffering to perform before delivering data to the Amazon ES destination.
See: newElasticsearchBufferingHints
smart constructor.
Instances
newElasticsearchBufferingHints :: ElasticsearchBufferingHints Source #
Create a value of ElasticsearchBufferingHints
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:intervalInSeconds:ElasticsearchBufferingHints'
, elasticsearchBufferingHints_intervalInSeconds
- Buffer incoming data for the specified period of time, in seconds,
before delivering it to the destination. The default value is 300 (5
minutes).
$sel:sizeInMBs:ElasticsearchBufferingHints'
, elasticsearchBufferingHints_sizeInMBs
- Buffer incoming data to the specified size, in MBs, before delivering it
to the destination. The default value is 5.
We recommend setting this parameter to a value greater than the amount of data you typically ingest into the delivery stream in 10 seconds. For example, if you typically ingest data at 1 MB/sec, the value should be 10 MB or higher.
ElasticsearchDestinationConfiguration
data ElasticsearchDestinationConfiguration Source #
Describes the configuration of a destination in Amazon ES.
See: newElasticsearchDestinationConfiguration
smart constructor.
Instances
newElasticsearchDestinationConfiguration Source #
Create a value of ElasticsearchDestinationConfiguration
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ElasticsearchDestinationConfiguration
, elasticsearchDestinationConfiguration_bufferingHints
- The buffering options. If no value is specified, the default values for
ElasticsearchBufferingHints
are used.
ElasticsearchDestinationConfiguration
, elasticsearchDestinationConfiguration_cloudWatchLoggingOptions
- The Amazon CloudWatch logging options for your delivery stream.
$sel:clusterEndpoint:ElasticsearchDestinationConfiguration'
, elasticsearchDestinationConfiguration_clusterEndpoint
- The endpoint to use when communicating with the cluster. Specify either
this ClusterEndpoint
or the DomainARN
field.
$sel:domainARN:ElasticsearchDestinationConfiguration'
, elasticsearchDestinationConfiguration_domainARN
- The ARN of the Amazon ES domain. The IAM role must have permissions
for DescribeDomain
, DescribeDomains
, and
DescribeDomainConfig
after assuming the role specified in RoleARN.
For more information, see
Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.
Specify either ClusterEndpoint
or DomainARN
.
$sel:indexRotationPeriod:ElasticsearchDestinationConfiguration'
, elasticsearchDestinationConfiguration_indexRotationPeriod
- The Elasticsearch index rotation period. Index rotation appends a
timestamp to the IndexName
to facilitate the expiration of old data.
For more information, see
Index Rotation for the Amazon ES Destination.
The default value is OneDay
.
$sel:processingConfiguration:ElasticsearchDestinationConfiguration'
, elasticsearchDestinationConfiguration_processingConfiguration
- The data processing configuration.
$sel:retryOptions:ElasticsearchDestinationConfiguration'
, elasticsearchDestinationConfiguration_retryOptions
- The retry behavior in case Kinesis Data Firehose is unable to deliver
documents to Amazon ES. The default value is 300 (5 minutes).
$sel:s3BackupMode:ElasticsearchDestinationConfiguration'
, elasticsearchDestinationConfiguration_s3BackupMode
- Defines how documents should be delivered to Amazon S3. When it is set
to FailedDocumentsOnly
, Kinesis Data Firehose writes any documents
that could not be indexed to the configured Amazon S3 destination, with
AmazonOpenSearchService-failed/
appended to the key prefix. When set
to AllDocuments
, Kinesis Data Firehose delivers all incoming records
to Amazon S3, and also writes failed documents with
AmazonOpenSearchService-failed/
appended to the prefix. For more
information, see
Amazon S3 Backup for the Amazon ES Destination.
Default value is FailedDocumentsOnly
.
You can't change this backup mode after you create the delivery stream.
$sel:typeName:ElasticsearchDestinationConfiguration'
, elasticsearchDestinationConfiguration_typeName
- The Elasticsearch type name. For Elasticsearch 6.x, there can be only
one type per index. If you try to specify a new type for an existing
index that already has another type, Kinesis Data Firehose returns an
error during run time.
For Elasticsearch 7.x, don't specify a TypeName
.
$sel:vpcConfiguration:ElasticsearchDestinationConfiguration'
, elasticsearchDestinationConfiguration_vpcConfiguration
- The details of the VPC of the Amazon ES destination.
ElasticsearchDestinationConfiguration
, elasticsearchDestinationConfiguration_roleARN
- The Amazon Resource Name (ARN) of the IAM role to be assumed by Kinesis
Data Firehose for calling the Amazon ES Configuration API and for
indexing documents. For more information, see
Grant Kinesis Data Firehose Access to an Amazon S3 Destination
and
Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.
$sel:indexName:ElasticsearchDestinationConfiguration'
, elasticsearchDestinationConfiguration_indexName
- The Elasticsearch index name.
$sel:s3Configuration:ElasticsearchDestinationConfiguration'
, elasticsearchDestinationConfiguration_s3Configuration
- The configuration for the backup Amazon S3 location.
ElasticsearchDestinationDescription
data ElasticsearchDestinationDescription Source #
The destination description in Amazon ES.
See: newElasticsearchDestinationDescription
smart constructor.
Instances
newElasticsearchDestinationDescription :: ElasticsearchDestinationDescription Source #
Create a value of ElasticsearchDestinationDescription
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ElasticsearchDestinationDescription
, elasticsearchDestinationDescription_bufferingHints
- The buffering options.
ElasticsearchDestinationDescription
, elasticsearchDestinationDescription_cloudWatchLoggingOptions
- The Amazon CloudWatch logging options.
$sel:clusterEndpoint:ElasticsearchDestinationDescription'
, elasticsearchDestinationDescription_clusterEndpoint
- The endpoint to use when communicating with the cluster. Kinesis Data
Firehose uses either this ClusterEndpoint
or the DomainARN
field to
send data to Amazon ES.
$sel:domainARN:ElasticsearchDestinationDescription'
, elasticsearchDestinationDescription_domainARN
- The ARN of the Amazon ES domain. For more information, see
Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.
Kinesis Data Firehose uses either ClusterEndpoint
or DomainARN
to
send data to Amazon ES.
$sel:indexName:ElasticsearchDestinationDescription'
, elasticsearchDestinationDescription_indexName
- The Elasticsearch index name.
$sel:indexRotationPeriod:ElasticsearchDestinationDescription'
, elasticsearchDestinationDescription_indexRotationPeriod
- The Elasticsearch index rotation period
$sel:processingConfiguration:ElasticsearchDestinationDescription'
, elasticsearchDestinationDescription_processingConfiguration
- The data processing configuration.
$sel:retryOptions:ElasticsearchDestinationDescription'
, elasticsearchDestinationDescription_retryOptions
- The Amazon ES retry options.
ElasticsearchDestinationDescription
, elasticsearchDestinationDescription_roleARN
- The Amazon Resource Name (ARN) of the Amazon Web Services credentials.
For more information, see
Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.
$sel:s3BackupMode:ElasticsearchDestinationDescription'
, elasticsearchDestinationDescription_s3BackupMode
- The Amazon S3 backup mode.
$sel:s3DestinationDescription:ElasticsearchDestinationDescription'
, elasticsearchDestinationDescription_s3DestinationDescription
- The Amazon S3 destination.
$sel:typeName:ElasticsearchDestinationDescription'
, elasticsearchDestinationDescription_typeName
- The Elasticsearch type name. This applies to Elasticsearch 6.x and lower
versions. For Elasticsearch 7.x and OpenSearch Service 1.x, there's no
value for TypeName
.
$sel:vpcConfigurationDescription:ElasticsearchDestinationDescription'
, elasticsearchDestinationDescription_vpcConfigurationDescription
- The details of the VPC of the Amazon ES destination.
ElasticsearchDestinationUpdate
data ElasticsearchDestinationUpdate Source #
Describes an update for a destination in Amazon ES.
See: newElasticsearchDestinationUpdate
smart constructor.
Instances
newElasticsearchDestinationUpdate :: ElasticsearchDestinationUpdate Source #
Create a value of ElasticsearchDestinationUpdate
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ElasticsearchDestinationUpdate
, elasticsearchDestinationUpdate_bufferingHints
- The buffering options. If no value is specified,
ElasticsearchBufferingHints
object default values are used.
ElasticsearchDestinationUpdate
, elasticsearchDestinationUpdate_cloudWatchLoggingOptions
- The CloudWatch logging options for your delivery stream.
$sel:clusterEndpoint:ElasticsearchDestinationUpdate'
, elasticsearchDestinationUpdate_clusterEndpoint
- The endpoint to use when communicating with the cluster. Specify either
this ClusterEndpoint
or the DomainARN
field.
$sel:domainARN:ElasticsearchDestinationUpdate'
, elasticsearchDestinationUpdate_domainARN
- The ARN of the Amazon ES domain. The IAM role must have permissions
for DescribeDomain
, DescribeDomains
, and
DescribeDomainConfig
after assuming the IAM role specified in
RoleARN
. For more information, see
Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.
Specify either ClusterEndpoint
or DomainARN
.
$sel:indexName:ElasticsearchDestinationUpdate'
, elasticsearchDestinationUpdate_indexName
- The Elasticsearch index name.
$sel:indexRotationPeriod:ElasticsearchDestinationUpdate'
, elasticsearchDestinationUpdate_indexRotationPeriod
- The Elasticsearch index rotation period. Index rotation appends a
timestamp to IndexName
to facilitate the expiration of old data. For
more information, see
Index Rotation for the Amazon ES Destination.
Default value is OneDay
.
$sel:processingConfiguration:ElasticsearchDestinationUpdate'
, elasticsearchDestinationUpdate_processingConfiguration
- The data processing configuration.
$sel:retryOptions:ElasticsearchDestinationUpdate'
, elasticsearchDestinationUpdate_retryOptions
- The retry behavior in case Kinesis Data Firehose is unable to deliver
documents to Amazon ES. The default value is 300 (5 minutes).
ElasticsearchDestinationUpdate
, elasticsearchDestinationUpdate_roleARN
- The Amazon Resource Name (ARN) of the IAM role to be assumed by Kinesis
Data Firehose for calling the Amazon ES Configuration API and for
indexing documents. For more information, see
Grant Kinesis Data Firehose Access to an Amazon S3 Destination
and
Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.
$sel:s3Update:ElasticsearchDestinationUpdate'
, elasticsearchDestinationUpdate_s3Update
- The Amazon S3 destination.
$sel:typeName:ElasticsearchDestinationUpdate'
, elasticsearchDestinationUpdate_typeName
- The Elasticsearch type name. For Elasticsearch 6.x, there can be only
one type per index. If you try to specify a new type for an existing
index that already has another type, Kinesis Data Firehose returns an
error during runtime.
If you upgrade Elasticsearch from 6.x to 7.x and don’t update your
delivery stream, Kinesis Data Firehose still delivers data to
Elasticsearch with the old index name and type name. If you want to
update your delivery stream with a new index name, provide an empty
string for TypeName
.
ElasticsearchRetryOptions
data ElasticsearchRetryOptions Source #
Configures retry behavior in case Kinesis Data Firehose is unable to deliver documents to Amazon ES.
See: newElasticsearchRetryOptions
smart constructor.
Instances
newElasticsearchRetryOptions :: ElasticsearchRetryOptions Source #
Create a value of ElasticsearchRetryOptions
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:durationInSeconds:ElasticsearchRetryOptions'
, elasticsearchRetryOptions_durationInSeconds
- After an initial failure to deliver to Amazon ES, the total amount of
time during which Kinesis Data Firehose retries delivery (including the
first attempt). After this time has elapsed, the failed documents are
written to Amazon S3. Default value is 300 seconds (5 minutes). A value
of 0 (zero) results in no retries.
EncryptionConfiguration
data EncryptionConfiguration Source #
Describes the encryption for a destination in Amazon S3.
See: newEncryptionConfiguration
smart constructor.
Instances
newEncryptionConfiguration :: EncryptionConfiguration Source #
Create a value of EncryptionConfiguration
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:kmsEncryptionConfig:EncryptionConfiguration'
, encryptionConfiguration_kmsEncryptionConfig
- The encryption key.
$sel:noEncryptionConfig:EncryptionConfiguration'
, encryptionConfiguration_noEncryptionConfig
- Specifically override existing encryption information to ensure that no
encryption is used.
ExtendedS3DestinationConfiguration
data ExtendedS3DestinationConfiguration Source #
Describes the configuration of a destination in Amazon S3.
See: newExtendedS3DestinationConfiguration
smart constructor.
Instances
newExtendedS3DestinationConfiguration Source #
Create a value of ExtendedS3DestinationConfiguration
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ExtendedS3DestinationConfiguration
, extendedS3DestinationConfiguration_bufferingHints
- The buffering option.
ExtendedS3DestinationConfiguration
, extendedS3DestinationConfiguration_cloudWatchLoggingOptions
- The Amazon CloudWatch logging options for your delivery stream.
ExtendedS3DestinationConfiguration
, extendedS3DestinationConfiguration_compressionFormat
- The compression format. If no value is specified, the default is
UNCOMPRESSED.
$sel:dataFormatConversionConfiguration:ExtendedS3DestinationConfiguration'
, extendedS3DestinationConfiguration_dataFormatConversionConfiguration
- The serializer, deserializer, and schema for converting data from the
JSON format to the Parquet or ORC format before writing it to Amazon S3.
$sel:dynamicPartitioningConfiguration:ExtendedS3DestinationConfiguration'
, extendedS3DestinationConfiguration_dynamicPartitioningConfiguration
- The configuration of the dynamic partitioning mechanism that creates
smaller data sets from the streaming data by partitioning it based on
partition keys. Currently, dynamic partitioning is only supported for
Amazon S3 destinations.
ExtendedS3DestinationConfiguration
, extendedS3DestinationConfiguration_encryptionConfiguration
- The encryption configuration. If no value is specified, the default is
no encryption.
ExtendedS3DestinationConfiguration
, extendedS3DestinationConfiguration_errorOutputPrefix
- A prefix that Kinesis Data Firehose evaluates and adds to failed records
before writing them to S3. This prefix appears immediately following the
bucket name. For information about how to specify this prefix, see
Custom Prefixes for Amazon S3 Objects.
ExtendedS3DestinationConfiguration
, extendedS3DestinationConfiguration_prefix
- The "YYYY/MM/DD/HH" time format prefix is automatically used for
delivered Amazon S3 files. You can also specify a custom prefix, as
described in
Custom Prefixes for Amazon S3 Objects.
$sel:processingConfiguration:ExtendedS3DestinationConfiguration'
, extendedS3DestinationConfiguration_processingConfiguration
- The data processing configuration.
$sel:s3BackupConfiguration:ExtendedS3DestinationConfiguration'
, extendedS3DestinationConfiguration_s3BackupConfiguration
- The configuration for backup in Amazon S3.
$sel:s3BackupMode:ExtendedS3DestinationConfiguration'
, extendedS3DestinationConfiguration_s3BackupMode
- The Amazon S3 backup mode. After you create a delivery stream, you can
update it to enable Amazon S3 backup if it is disabled. If backup is
enabled, you can't update the delivery stream to disable it.
ExtendedS3DestinationConfiguration
, extendedS3DestinationConfiguration_roleARN
- The Amazon Resource Name (ARN) of the Amazon Web Services credentials.
For more information, see
Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.
ExtendedS3DestinationConfiguration
, extendedS3DestinationConfiguration_bucketARN
- The ARN of the S3 bucket. For more information, see
Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.
ExtendedS3DestinationDescription
data ExtendedS3DestinationDescription Source #
Describes a destination in Amazon S3.
See: newExtendedS3DestinationDescription
smart constructor.
Instances
newExtendedS3DestinationDescription Source #
:: Text | |
-> Text | |
-> BufferingHints | |
-> CompressionFormat | |
-> EncryptionConfiguration | |
-> ExtendedS3DestinationDescription |
Create a value of ExtendedS3DestinationDescription
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ExtendedS3DestinationDescription
, extendedS3DestinationDescription_cloudWatchLoggingOptions
- The Amazon CloudWatch logging options for your delivery stream.
$sel:dataFormatConversionConfiguration:ExtendedS3DestinationDescription'
, extendedS3DestinationDescription_dataFormatConversionConfiguration
- The serializer, deserializer, and schema for converting data from the
JSON format to the Parquet or ORC format before writing it to Amazon S3.
$sel:dynamicPartitioningConfiguration:ExtendedS3DestinationDescription'
, extendedS3DestinationDescription_dynamicPartitioningConfiguration
- The configuration of the dynamic partitioning mechanism that creates
smaller data sets from the streaming data by partitioning it based on
partition keys. Currently, dynamic partitioning is only supported for
Amazon S3 destinations.
ExtendedS3DestinationDescription
, extendedS3DestinationDescription_errorOutputPrefix
- A prefix that Kinesis Data Firehose evaluates and adds to failed records
before writing them to S3. This prefix appears immediately following the
bucket name. For information about how to specify this prefix, see
Custom Prefixes for Amazon S3 Objects.
ExtendedS3DestinationDescription
, extendedS3DestinationDescription_prefix
- The "YYYY/MM/DD/HH" time format prefix is automatically used for
delivered Amazon S3 files. You can also specify a custom prefix, as
described in
Custom Prefixes for Amazon S3 Objects.
$sel:processingConfiguration:ExtendedS3DestinationDescription'
, extendedS3DestinationDescription_processingConfiguration
- The data processing configuration.
$sel:s3BackupDescription:ExtendedS3DestinationDescription'
, extendedS3DestinationDescription_s3BackupDescription
- The configuration for backup in Amazon S3.
$sel:s3BackupMode:ExtendedS3DestinationDescription'
, extendedS3DestinationDescription_s3BackupMode
- The Amazon S3 backup mode.
ExtendedS3DestinationDescription
, extendedS3DestinationDescription_roleARN
- The Amazon Resource Name (ARN) of the Amazon Web Services credentials.
For more information, see
Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.
ExtendedS3DestinationDescription
, extendedS3DestinationDescription_bucketARN
- The ARN of the S3 bucket. For more information, see
Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.
ExtendedS3DestinationDescription
, extendedS3DestinationDescription_bufferingHints
- The buffering option.
ExtendedS3DestinationDescription
, extendedS3DestinationDescription_compressionFormat
- The compression format. If no value is specified, the default is
UNCOMPRESSED
.
ExtendedS3DestinationDescription
, extendedS3DestinationDescription_encryptionConfiguration
- The encryption configuration. If no value is specified, the default is
no encryption.
ExtendedS3DestinationUpdate
data ExtendedS3DestinationUpdate Source #
Describes an update for a destination in Amazon S3.
See: newExtendedS3DestinationUpdate
smart constructor.
Instances
newExtendedS3DestinationUpdate :: ExtendedS3DestinationUpdate Source #
Create a value of ExtendedS3DestinationUpdate
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ExtendedS3DestinationUpdate
, extendedS3DestinationUpdate_bucketARN
- The ARN of the S3 bucket. For more information, see
Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.
ExtendedS3DestinationUpdate
, extendedS3DestinationUpdate_bufferingHints
- The buffering option.
ExtendedS3DestinationUpdate
, extendedS3DestinationUpdate_cloudWatchLoggingOptions
- The Amazon CloudWatch logging options for your delivery stream.
ExtendedS3DestinationUpdate
, extendedS3DestinationUpdate_compressionFormat
- The compression format. If no value is specified, the default is
UNCOMPRESSED
.
$sel:dataFormatConversionConfiguration:ExtendedS3DestinationUpdate'
, extendedS3DestinationUpdate_dataFormatConversionConfiguration
- The serializer, deserializer, and schema for converting data from the
JSON format to the Parquet or ORC format before writing it to Amazon S3.
$sel:dynamicPartitioningConfiguration:ExtendedS3DestinationUpdate'
, extendedS3DestinationUpdate_dynamicPartitioningConfiguration
- The configuration of the dynamic partitioning mechanism that creates
smaller data sets from the streaming data by partitioning it based on
partition keys. Currently, dynamic partitioning is only supported for
Amazon S3 destinations.
ExtendedS3DestinationUpdate
, extendedS3DestinationUpdate_encryptionConfiguration
- The encryption configuration. If no value is specified, the default is
no encryption.
ExtendedS3DestinationUpdate
, extendedS3DestinationUpdate_errorOutputPrefix
- A prefix that Kinesis Data Firehose evaluates and adds to failed records
before writing them to S3. This prefix appears immediately following the
bucket name. For information about how to specify this prefix, see
Custom Prefixes for Amazon S3 Objects.
ExtendedS3DestinationUpdate
, extendedS3DestinationUpdate_prefix
- The "YYYY/MM/DD/HH" time format prefix is automatically used for
delivered Amazon S3 files. You can also specify a custom prefix, as
described in
Custom Prefixes for Amazon S3 Objects.
$sel:processingConfiguration:ExtendedS3DestinationUpdate'
, extendedS3DestinationUpdate_processingConfiguration
- The data processing configuration.
ExtendedS3DestinationUpdate
, extendedS3DestinationUpdate_roleARN
- The Amazon Resource Name (ARN) of the Amazon Web Services credentials.
For more information, see
Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.
$sel:s3BackupMode:ExtendedS3DestinationUpdate'
, extendedS3DestinationUpdate_s3BackupMode
- You can update a delivery stream to enable Amazon S3 backup if it is
disabled. If backup is enabled, you can't update the delivery stream to
disable it.
$sel:s3BackupUpdate:ExtendedS3DestinationUpdate'
, extendedS3DestinationUpdate_s3BackupUpdate
- The Amazon S3 destination for backup.
FailureDescription
data FailureDescription Source #
Provides details in case one of the following operations fails due to an error related to KMS: CreateDeliveryStream, DeleteDeliveryStream, StartDeliveryStreamEncryption, StopDeliveryStreamEncryption.
See: newFailureDescription
smart constructor.
Instances
newFailureDescription Source #
Create a value of FailureDescription
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:type':FailureDescription'
, failureDescription_type
- The type of error that caused the failure.
$sel:details:FailureDescription'
, failureDescription_details
- A message providing details about the error that caused the failure.
HiveJsonSerDe
data HiveJsonSerDe Source #
The native Hive / HCatalog JsonSerDe. Used by Kinesis Data Firehose for deserializing data, which means converting it from the JSON format in preparation for serializing it to the Parquet or ORC format. This is one of two deserializers you can choose, depending on which one offers the functionality you need. The other option is the OpenX SerDe.
See: newHiveJsonSerDe
smart constructor.
HiveJsonSerDe' (Maybe [Text]) |
Instances
newHiveJsonSerDe :: HiveJsonSerDe Source #
Create a value of HiveJsonSerDe
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:timestampFormats:HiveJsonSerDe'
, hiveJsonSerDe_timestampFormats
- Indicates how you want Kinesis Data Firehose to parse the date and
timestamps that may be present in your input data JSON. To specify these
format strings, follow the pattern syntax of JodaTime's DateTimeFormat
format strings. For more information, see
Class DateTimeFormat.
You can also use the special value millis
to parse timestamps in epoch
milliseconds. If you don't specify a format, Kinesis Data Firehose uses
java.sql.Timestamp::valueOf
by default.
HttpEndpointBufferingHints
data HttpEndpointBufferingHints Source #
Describes the buffering options that can be applied before data is
delivered to the HTTP endpoint destination. Kinesis Data Firehose treats
these options as hints, and it might choose to use more optimal values.
The SizeInMBs
and IntervalInSeconds
parameters are optional.
However, if specify a value for one of them, you must also provide a
value for the other.
See: newHttpEndpointBufferingHints
smart constructor.
Instances
newHttpEndpointBufferingHints :: HttpEndpointBufferingHints Source #
Create a value of HttpEndpointBufferingHints
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:intervalInSeconds:HttpEndpointBufferingHints'
, httpEndpointBufferingHints_intervalInSeconds
- Buffer incoming data for the specified period of time, in seconds,
before delivering it to the destination. The default value is 300 (5
minutes).
$sel:sizeInMBs:HttpEndpointBufferingHints'
, httpEndpointBufferingHints_sizeInMBs
- Buffer incoming data to the specified size, in MBs, before delivering it
to the destination. The default value is 5.
We recommend setting this parameter to a value greater than the amount of data you typically ingest into the delivery stream in 10 seconds. For example, if you typically ingest data at 1 MB/sec, the value should be 10 MB or higher.
HttpEndpointCommonAttribute
data HttpEndpointCommonAttribute Source #
Describes the metadata that's delivered to the specified HTTP endpoint destination.
See: newHttpEndpointCommonAttribute
smart constructor.
Instances
newHttpEndpointCommonAttribute Source #
:: Text | |
-> Text | |
-> HttpEndpointCommonAttribute |
Create a value of HttpEndpointCommonAttribute
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:attributeName:HttpEndpointCommonAttribute'
, httpEndpointCommonAttribute_attributeName
- The name of the HTTP endpoint common attribute.
$sel:attributeValue:HttpEndpointCommonAttribute'
, httpEndpointCommonAttribute_attributeValue
- The value of the HTTP endpoint common attribute.
HttpEndpointConfiguration
data HttpEndpointConfiguration Source #
Describes the configuration of the HTTP endpoint to which Kinesis Firehose delivers data.
See: newHttpEndpointConfiguration
smart constructor.
Instances
newHttpEndpointConfiguration Source #
Create a value of HttpEndpointConfiguration
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:accessKey:HttpEndpointConfiguration'
, httpEndpointConfiguration_accessKey
- The access key required for Kinesis Firehose to authenticate with the
HTTP endpoint selected as the destination.
$sel:name:HttpEndpointConfiguration'
, httpEndpointConfiguration_name
- The name of the HTTP endpoint selected as the destination.
$sel:url:HttpEndpointConfiguration'
, httpEndpointConfiguration_url
- The URL of the HTTP endpoint selected as the destination.
If you choose an HTTP endpoint as your destination, review and follow the instructions in the Appendix - HTTP Endpoint Delivery Request and Response Specifications.
HttpEndpointDescription
data HttpEndpointDescription Source #
Describes the HTTP endpoint selected as the destination.
See: newHttpEndpointDescription
smart constructor.
Instances
newHttpEndpointDescription :: HttpEndpointDescription Source #
Create a value of HttpEndpointDescription
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:name:HttpEndpointDescription'
, httpEndpointDescription_name
- The name of the HTTP endpoint selected as the destination.
$sel:url:HttpEndpointDescription'
, httpEndpointDescription_url
- The URL of the HTTP endpoint selected as the destination.
HttpEndpointDestinationConfiguration
data HttpEndpointDestinationConfiguration Source #
Describes the configuration of the HTTP endpoint destination.
See: newHttpEndpointDestinationConfiguration
smart constructor.
Instances
newHttpEndpointDestinationConfiguration Source #
:: HttpEndpointConfiguration |
|
-> S3DestinationConfiguration | |
-> HttpEndpointDestinationConfiguration |
Create a value of HttpEndpointDestinationConfiguration
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
HttpEndpointDestinationConfiguration
, httpEndpointDestinationConfiguration_bufferingHints
- The buffering options that can be used before data is delivered to the
specified destination. Kinesis Data Firehose treats these options as
hints, and it might choose to use more optimal values. The SizeInMBs
and IntervalInSeconds
parameters are optional. However, if you specify
a value for one of them, you must also provide a value for the other.
HttpEndpointDestinationConfiguration
, httpEndpointDestinationConfiguration_cloudWatchLoggingOptions
- Undocumented member.
$sel:processingConfiguration:HttpEndpointDestinationConfiguration'
, httpEndpointDestinationConfiguration_processingConfiguration
- Undocumented member.
$sel:requestConfiguration:HttpEndpointDestinationConfiguration'
, httpEndpointDestinationConfiguration_requestConfiguration
- The configuration of the requeste sent to the HTTP endpoint specified as
the destination.
$sel:retryOptions:HttpEndpointDestinationConfiguration'
, httpEndpointDestinationConfiguration_retryOptions
- Describes the retry behavior in case Kinesis Data Firehose is unable to
deliver data to the specified HTTP endpoint destination, or if it
doesn't receive a valid acknowledgment of receipt from the specified
HTTP endpoint destination.
HttpEndpointDestinationConfiguration
, httpEndpointDestinationConfiguration_roleARN
- Kinesis Data Firehose uses this IAM role for all the permissions that
the delivery stream needs.
$sel:s3BackupMode:HttpEndpointDestinationConfiguration'
, httpEndpointDestinationConfiguration_s3BackupMode
- Describes the S3 bucket backup options for the data that Kinesis Data
Firehose delivers to the HTTP endpoint destination. You can back up all
documents (AllData
) or only the documents that Kinesis Data Firehose
could not deliver to the specified HTTP endpoint destination
(FailedDataOnly
).
$sel:endpointConfiguration:HttpEndpointDestinationConfiguration'
, httpEndpointDestinationConfiguration_endpointConfiguration
- The configuration of the HTTP endpoint selected as the destination.
$sel:s3Configuration:HttpEndpointDestinationConfiguration'
, httpEndpointDestinationConfiguration_s3Configuration
- Undocumented member.
HttpEndpointDestinationDescription
data HttpEndpointDestinationDescription Source #
Describes the HTTP endpoint destination.
See: newHttpEndpointDestinationDescription
smart constructor.
Instances
newHttpEndpointDestinationDescription :: HttpEndpointDestinationDescription Source #
Create a value of HttpEndpointDestinationDescription
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
HttpEndpointDestinationDescription
, httpEndpointDestinationDescription_bufferingHints
- Describes buffering options that can be applied to the data before it is
delivered to the HTTPS endpoint destination. Kinesis Data Firehose teats
these options as hints, and it might choose to use more optimal values.
The SizeInMBs
and IntervalInSeconds
parameters are optional.
However, if specify a value for one of them, you must also provide a
value for the other.
HttpEndpointDestinationDescription
, httpEndpointDestinationDescription_cloudWatchLoggingOptions
- Undocumented member.
$sel:endpointConfiguration:HttpEndpointDestinationDescription'
, httpEndpointDestinationDescription_endpointConfiguration
- The configuration of the specified HTTP endpoint destination.
$sel:processingConfiguration:HttpEndpointDestinationDescription'
, httpEndpointDestinationDescription_processingConfiguration
- Undocumented member.
$sel:requestConfiguration:HttpEndpointDestinationDescription'
, httpEndpointDestinationDescription_requestConfiguration
- The configuration of request sent to the HTTP endpoint specified as the
destination.
$sel:retryOptions:HttpEndpointDestinationDescription'
, httpEndpointDestinationDescription_retryOptions
- Describes the retry behavior in case Kinesis Data Firehose is unable to
deliver data to the specified HTTP endpoint destination, or if it
doesn't receive a valid acknowledgment of receipt from the specified
HTTP endpoint destination.
HttpEndpointDestinationDescription
, httpEndpointDestinationDescription_roleARN
- Kinesis Data Firehose uses this IAM role for all the permissions that
the delivery stream needs.
$sel:s3BackupMode:HttpEndpointDestinationDescription'
, httpEndpointDestinationDescription_s3BackupMode
- Describes the S3 bucket backup options for the data that Kinesis
Firehose delivers to the HTTP endpoint destination. You can back up all
documents (AllData
) or only the documents that Kinesis Data Firehose
could not deliver to the specified HTTP endpoint destination
(FailedDataOnly
).
$sel:s3DestinationDescription:HttpEndpointDestinationDescription'
, httpEndpointDestinationDescription_s3DestinationDescription
- Undocumented member.
HttpEndpointDestinationUpdate
data HttpEndpointDestinationUpdate Source #
Updates the specified HTTP endpoint destination.
See: newHttpEndpointDestinationUpdate
smart constructor.
Instances
newHttpEndpointDestinationUpdate :: HttpEndpointDestinationUpdate Source #
Create a value of HttpEndpointDestinationUpdate
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
HttpEndpointDestinationUpdate
, httpEndpointDestinationUpdate_bufferingHints
- Describes buffering options that can be applied to the data before it is
delivered to the HTTPS endpoint destination. Kinesis Data Firehose teats
these options as hints, and it might choose to use more optimal values.
The SizeInMBs
and IntervalInSeconds
parameters are optional.
However, if specify a value for one of them, you must also provide a
value for the other.
HttpEndpointDestinationUpdate
, httpEndpointDestinationUpdate_cloudWatchLoggingOptions
- Undocumented member.
$sel:endpointConfiguration:HttpEndpointDestinationUpdate'
, httpEndpointDestinationUpdate_endpointConfiguration
- Describes the configuration of the HTTP endpoint destination.
$sel:processingConfiguration:HttpEndpointDestinationUpdate'
, httpEndpointDestinationUpdate_processingConfiguration
- Undocumented member.
$sel:requestConfiguration:HttpEndpointDestinationUpdate'
, httpEndpointDestinationUpdate_requestConfiguration
- The configuration of the request sent to the HTTP endpoint specified as
the destination.
$sel:retryOptions:HttpEndpointDestinationUpdate'
, httpEndpointDestinationUpdate_retryOptions
- Describes the retry behavior in case Kinesis Data Firehose is unable to
deliver data to the specified HTTP endpoint destination, or if it
doesn't receive a valid acknowledgment of receipt from the specified
HTTP endpoint destination.
HttpEndpointDestinationUpdate
, httpEndpointDestinationUpdate_roleARN
- Kinesis Data Firehose uses this IAM role for all the permissions that
the delivery stream needs.
$sel:s3BackupMode:HttpEndpointDestinationUpdate'
, httpEndpointDestinationUpdate_s3BackupMode
- Describes the S3 bucket backup options for the data that Kinesis
Firehose delivers to the HTTP endpoint destination. You can back up all
documents (AllData
) or only the documents that Kinesis Data Firehose
could not deliver to the specified HTTP endpoint destination
(FailedDataOnly
).
$sel:s3Update:HttpEndpointDestinationUpdate'
, httpEndpointDestinationUpdate_s3Update
- Undocumented member.
HttpEndpointRequestConfiguration
data HttpEndpointRequestConfiguration Source #
The configuration of the HTTP endpoint request.
See: newHttpEndpointRequestConfiguration
smart constructor.
Instances
newHttpEndpointRequestConfiguration :: HttpEndpointRequestConfiguration Source #
Create a value of HttpEndpointRequestConfiguration
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:commonAttributes:HttpEndpointRequestConfiguration'
, httpEndpointRequestConfiguration_commonAttributes
- Describes the metadata sent to the HTTP endpoint destination.
$sel:contentEncoding:HttpEndpointRequestConfiguration'
, httpEndpointRequestConfiguration_contentEncoding
- Kinesis Data Firehose uses the content encoding to compress the body of
a request before sending the request to the destination. For more
information, see
Content-Encoding
in MDN Web Docs, the official Mozilla documentation.
HttpEndpointRetryOptions
data HttpEndpointRetryOptions Source #
Describes the retry behavior in case Kinesis Data Firehose is unable to deliver data to the specified HTTP endpoint destination, or if it doesn't receive a valid acknowledgment of receipt from the specified HTTP endpoint destination.
See: newHttpEndpointRetryOptions
smart constructor.
Instances
newHttpEndpointRetryOptions :: HttpEndpointRetryOptions Source #
Create a value of HttpEndpointRetryOptions
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:durationInSeconds:HttpEndpointRetryOptions'
, httpEndpointRetryOptions_durationInSeconds
- The total amount of time that Kinesis Data Firehose spends on retries.
This duration starts after the initial attempt to send data to the
custom destination via HTTPS endpoint fails. It doesn't include the
periods during which Kinesis Data Firehose waits for acknowledgment from
the specified destination after each attempt.
InputFormatConfiguration
data InputFormatConfiguration Source #
Specifies the deserializer you want to use to convert the format of the
input data. This parameter is required if Enabled
is set to true.
See: newInputFormatConfiguration
smart constructor.
Instances
newInputFormatConfiguration :: InputFormatConfiguration Source #
Create a value of InputFormatConfiguration
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:deserializer:InputFormatConfiguration'
, inputFormatConfiguration_deserializer
- Specifies which deserializer to use. You can choose either the Apache
Hive JSON SerDe or the OpenX JSON SerDe. If both are non-null, the
server rejects the request.
KMSEncryptionConfig
data KMSEncryptionConfig Source #
Describes an encryption key for a destination in Amazon S3.
See: newKMSEncryptionConfig
smart constructor.
Instances
newKMSEncryptionConfig Source #
Create a value of KMSEncryptionConfig
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:aWSKMSKeyARN:KMSEncryptionConfig'
, kmsEncryptionConfig_aWSKMSKeyARN
- The Amazon Resource Name (ARN) of the encryption key. Must belong to the
same Amazon Web Services Region as the destination Amazon S3 bucket. For
more information, see
Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.
KinesisStreamSourceConfiguration
data KinesisStreamSourceConfiguration Source #
The stream and role Amazon Resource Names (ARNs) for a Kinesis data stream used as the source for a delivery stream.
See: newKinesisStreamSourceConfiguration
smart constructor.
Instances
newKinesisStreamSourceConfiguration Source #
Create a value of KinesisStreamSourceConfiguration
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:kinesisStreamARN:KinesisStreamSourceConfiguration'
, kinesisStreamSourceConfiguration_kinesisStreamARN
- The ARN of the source Kinesis data stream. For more information, see
Amazon Kinesis Data Streams ARN Format.
$sel:roleARN:KinesisStreamSourceConfiguration'
, kinesisStreamSourceConfiguration_roleARN
- The ARN of the role that provides access to the source Kinesis data
stream. For more information, see
Amazon Web Services Identity and Access Management (IAM) ARN Format.
KinesisStreamSourceDescription
data KinesisStreamSourceDescription Source #
Details about a Kinesis data stream used as the source for a Kinesis Data Firehose delivery stream.
See: newKinesisStreamSourceDescription
smart constructor.
Instances
newKinesisStreamSourceDescription :: KinesisStreamSourceDescription Source #
Create a value of KinesisStreamSourceDescription
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:deliveryStartTimestamp:KinesisStreamSourceDescription'
, kinesisStreamSourceDescription_deliveryStartTimestamp
- Kinesis Data Firehose starts retrieving records from the Kinesis data
stream starting with this timestamp.
$sel:kinesisStreamARN:KinesisStreamSourceDescription'
, kinesisStreamSourceDescription_kinesisStreamARN
- The Amazon Resource Name (ARN) of the source Kinesis data stream. For
more information, see
Amazon Kinesis Data Streams ARN Format.
$sel:roleARN:KinesisStreamSourceDescription'
, kinesisStreamSourceDescription_roleARN
- The ARN of the role used by the source Kinesis data stream. For more
information, see
Amazon Web Services Identity and Access Management (IAM) ARN Format.
OpenXJsonSerDe
data OpenXJsonSerDe Source #
The OpenX SerDe. Used by Kinesis Data Firehose for deserializing data, which means converting it from the JSON format in preparation for serializing it to the Parquet or ORC format. This is one of two deserializers you can choose, depending on which one offers the functionality you need. The other option is the native Hive / HCatalog JsonSerDe.
See: newOpenXJsonSerDe
smart constructor.
Instances
newOpenXJsonSerDe :: OpenXJsonSerDe Source #
Create a value of OpenXJsonSerDe
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:caseInsensitive:OpenXJsonSerDe'
, openXJsonSerDe_caseInsensitive
- When set to true
, which is the default, Kinesis Data Firehose converts
JSON keys to lowercase before deserializing them.
$sel:columnToJsonKeyMappings:OpenXJsonSerDe'
, openXJsonSerDe_columnToJsonKeyMappings
- Maps column names to JSON keys that aren't identical to the column
names. This is useful when the JSON contains keys that are Hive
keywords. For example, timestamp
is a Hive keyword. If you have a JSON
key named timestamp
, set this parameter to {"ts": "timestamp"}
to map this key to a column named ts
.
$sel:convertDotsInJsonKeysToUnderscores:OpenXJsonSerDe'
, openXJsonSerDe_convertDotsInJsonKeysToUnderscores
- When set to true
, specifies that the names of the keys include dots
and that you want Kinesis Data Firehose to replace them with
underscores. This is useful because Apache Hive does not allow dots in
column names. For example, if the JSON contains a key whose name is
"a.b", you can define the column name to be "a_b" when using this
option.
The default is false
.
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: newOrcSerDe
smart constructor.
OrcSerDe' (Maybe Natural) (Maybe [Text]) (Maybe Double) (Maybe OrcCompression) (Maybe Double) (Maybe Bool) (Maybe OrcFormatVersion) (Maybe Double) (Maybe Natural) (Maybe Natural) |
Instances
newOrcSerDe :: OrcSerDe Source #
Create a value of OrcSerDe
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:blockSizeBytes:OrcSerDe'
, orcSerDe_blockSizeBytes
- The Hadoop Distributed File System (HDFS) block size. This is useful if
you intend to copy the data from Amazon S3 to HDFS before querying. The
default is 256 MiB and the minimum is 64 MiB. Kinesis Data Firehose uses
this value for padding calculations.
$sel:bloomFilterColumns:OrcSerDe'
, orcSerDe_bloomFilterColumns
- The column names for which you want Kinesis Data Firehose to create
bloom filters. The default is null
.
$sel:bloomFilterFalsePositiveProbability:OrcSerDe'
, orcSerDe_bloomFilterFalsePositiveProbability
- The Bloom filter false positive probability (FPP). The lower the FPP,
the bigger the Bloom filter. The default value is 0.05, the minimum is
0, and the maximum is 1.
$sel:compression:OrcSerDe'
, orcSerDe_compression
- The compression code to use over data blocks. The default is SNAPPY
.
$sel:dictionaryKeyThreshold:OrcSerDe'
, orcSerDe_dictionaryKeyThreshold
- Represents the fraction of the total number of non-null rows. To turn
off dictionary encoding, set this fraction to a number that is less than
the number of distinct keys in a dictionary. To always use dictionary
encoding, set this threshold to 1.
$sel:enablePadding:OrcSerDe'
, orcSerDe_enablePadding
- Set this to true
to indicate that you want stripes to be padded to the
HDFS block boundaries. This is useful if you intend to copy the data
from Amazon S3 to HDFS before querying. The default is false
.
$sel:formatVersion:OrcSerDe'
, orcSerDe_formatVersion
- The version of the file to write. The possible values are V0_11
and
V0_12
. The default is V0_12
.
$sel:paddingTolerance:OrcSerDe'
, orcSerDe_paddingTolerance
- A number between 0 and 1 that defines the tolerance for block padding as
a decimal fraction of stripe size. The default value is 0.05, which
means 5 percent of stripe size.
For the default values of 64 MiB ORC stripes and 256 MiB HDFS blocks, the default block padding tolerance of 5 percent reserves a maximum of 3.2 MiB for padding within the 256 MiB block. In such a case, if the available size within the block is more than 3.2 MiB, a new, smaller stripe is inserted to fit within that space. This ensures that no stripe crosses block boundaries and causes remote reads within a node-local task.
Kinesis Data Firehose ignores this parameter when OrcSerDe$EnablePadding
is false
.
$sel:rowIndexStride:OrcSerDe'
, orcSerDe_rowIndexStride
- The number of rows between index entries. The default is 10,000 and the
minimum is 1,000.
$sel:stripeSizeBytes:OrcSerDe'
, orcSerDe_stripeSizeBytes
- The number of bytes in each stripe. The default is 64 MiB and the
minimum is 8 MiB.
OutputFormatConfiguration
data OutputFormatConfiguration Source #
Specifies the serializer that you want Kinesis Data Firehose to use to
convert the format of your data before it writes it to Amazon S3. This
parameter is required if Enabled
is set to true.
See: newOutputFormatConfiguration
smart constructor.
Instances
newOutputFormatConfiguration :: OutputFormatConfiguration Source #
Create a value of OutputFormatConfiguration
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:serializer:OutputFormatConfiguration'
, outputFormatConfiguration_serializer
- Specifies which serializer to use. You can choose either the ORC SerDe
or the Parquet SerDe. If both are non-null, the server rejects the
request.
ParquetSerDe
data ParquetSerDe Source #
A serializer to use for converting data to the Parquet format before storing it in Amazon S3. For more information, see Apache Parquet.
See: newParquetSerDe
smart constructor.
ParquetSerDe' (Maybe Natural) (Maybe ParquetCompression) (Maybe Bool) (Maybe Natural) (Maybe Natural) (Maybe ParquetWriterVersion) |
Instances
newParquetSerDe :: ParquetSerDe Source #
Create a value of ParquetSerDe
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:blockSizeBytes:ParquetSerDe'
, parquetSerDe_blockSizeBytes
- The Hadoop Distributed File System (HDFS) block size. This is useful if
you intend to copy the data from Amazon S3 to HDFS before querying. The
default is 256 MiB and the minimum is 64 MiB. Kinesis Data Firehose uses
this value for padding calculations.
$sel:compression:ParquetSerDe'
, parquetSerDe_compression
- The compression code to use over data blocks. The possible values are
UNCOMPRESSED
, SNAPPY
, and GZIP
, with the default being SNAPPY
.
Use SNAPPY
for higher decompression speed. Use GZIP
if the
compression ratio is more important than speed.
$sel:enableDictionaryCompression:ParquetSerDe'
, parquetSerDe_enableDictionaryCompression
- Indicates whether to enable dictionary compression.
$sel:maxPaddingBytes:ParquetSerDe'
, parquetSerDe_maxPaddingBytes
- The maximum amount of padding to apply. This is useful if you intend to
copy the data from Amazon S3 to HDFS before querying. The default is 0.
$sel:pageSizeBytes:ParquetSerDe'
, parquetSerDe_pageSizeBytes
- The Parquet page size. Column chunks are divided into pages. A page is
conceptually an indivisible unit (in terms of compression and encoding).
The minimum value is 64 KiB and the default is 1 MiB.
$sel:writerVersion:ParquetSerDe'
, parquetSerDe_writerVersion
- Indicates the version of row format to output. The possible values are
V1
and V2
. The default is V1
.
ProcessingConfiguration
data ProcessingConfiguration Source #
Describes a data processing configuration.
See: newProcessingConfiguration
smart constructor.
Instances
newProcessingConfiguration :: ProcessingConfiguration Source #
Create a value of ProcessingConfiguration
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:enabled:ProcessingConfiguration'
, processingConfiguration_enabled
- Enables or disables data processing.
$sel:processors:ProcessingConfiguration'
, processingConfiguration_processors
- The data processors.
Processor
Describes a data processor.
See: newProcessor
smart constructor.
Instances
FromJSON Processor Source # | |
ToJSON Processor Source # | |
Defined in Amazonka.Firehose.Types.Processor | |
Generic Processor Source # | |
Read Processor Source # | |
Show Processor Source # | |
NFData Processor Source # | |
Defined in Amazonka.Firehose.Types.Processor | |
Eq Processor Source # | |
Hashable Processor Source # | |
Defined in Amazonka.Firehose.Types.Processor | |
type Rep Processor Source # | |
Defined in Amazonka.Firehose.Types.Processor type Rep Processor = D1 ('MetaData "Processor" "Amazonka.Firehose.Types.Processor" "amazonka-kinesis-firehose-2.0-6l1hHmh2UnHBvolxuQFkWB" 'False) (C1 ('MetaCons "Processor'" 'PrefixI 'True) (S1 ('MetaSel ('Just "parameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ProcessorParameter])) :*: S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ProcessorType))) |
Create a value of Processor
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:parameters:Processor'
, processor_parameters
- The processor parameters.
$sel:type':Processor'
, processor_type
- The type of processor.
ProcessorParameter
data ProcessorParameter Source #
Describes the processor parameter.
See: newProcessorParameter
smart constructor.
Instances
newProcessorParameter Source #
Create a value of ProcessorParameter
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:parameterName:ProcessorParameter'
, processorParameter_parameterName
- The name of the parameter. Currently the following default values are
supported: 3 for NumberOfRetries
and 60 for the
BufferIntervalInSeconds
. The BufferSizeInMBs
ranges between 0.2 MB
and up to 3MB. The default buffering hint is 1MB for all destinations,
except Splunk. For Splunk, the default buffering hint is 256 KB.
$sel:parameterValue:ProcessorParameter'
, processorParameter_parameterValue
- The parameter value.
PutRecordBatchResponseEntry
data PutRecordBatchResponseEntry Source #
Contains the result for an individual record from a PutRecordBatch request. If the record is successfully added to your delivery stream, it receives a record ID. If the record fails to be added to your delivery stream, the result includes an error code and an error message.
See: newPutRecordBatchResponseEntry
smart constructor.
Instances
newPutRecordBatchResponseEntry :: PutRecordBatchResponseEntry Source #
Create a value of PutRecordBatchResponseEntry
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:errorCode:PutRecordBatchResponseEntry'
, putRecordBatchResponseEntry_errorCode
- The error code for an individual record result.
$sel:errorMessage:PutRecordBatchResponseEntry'
, putRecordBatchResponseEntry_errorMessage
- The error message for an individual record result.
$sel:recordId:PutRecordBatchResponseEntry'
, putRecordBatchResponseEntry_recordId
- The ID of the record.
Record
The unit of data in a delivery stream.
See: newRecord
smart constructor.
Instances
ToJSON Record Source # | |
Defined in Amazonka.Firehose.Types.Record | |
Generic Record Source # | |
Read Record Source # | |
Show Record Source # | |
NFData Record Source # | |
Defined in Amazonka.Firehose.Types.Record | |
Eq Record Source # | |
Hashable Record Source # | |
Defined in Amazonka.Firehose.Types.Record | |
type Rep Record Source # | |
Defined in Amazonka.Firehose.Types.Record |
Create a value of Record
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:data':Record'
, record_data
- The data blob, which is base64-encoded when the blob is serialized. The
maximum size of the data blob, before base64-encoding, is 1,000 KiB.--
-- Note: This Lens
automatically encodes and decodes Base64 data.
-- The underlying isomorphism will encode to Base64 representation during
-- serialisation, and decode from Base64 representation during deserialisation.
-- This Lens
accepts and returns only raw unencoded data.
RedshiftDestinationConfiguration
data RedshiftDestinationConfiguration Source #
Describes the configuration of a destination in Amazon Redshift.
See: newRedshiftDestinationConfiguration
smart constructor.
Instances
newRedshiftDestinationConfiguration Source #
:: Text | |
-> Text | |
-> CopyCommand | |
-> Text | |
-> Text | |
-> S3DestinationConfiguration | |
-> RedshiftDestinationConfiguration |
Create a value of RedshiftDestinationConfiguration
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
RedshiftDestinationConfiguration
, redshiftDestinationConfiguration_cloudWatchLoggingOptions
- The CloudWatch logging options for your delivery stream.
$sel:processingConfiguration:RedshiftDestinationConfiguration'
, redshiftDestinationConfiguration_processingConfiguration
- The data processing configuration.
$sel:retryOptions:RedshiftDestinationConfiguration'
, redshiftDestinationConfiguration_retryOptions
- The retry behavior in case Kinesis Data Firehose is unable to deliver
documents to Amazon Redshift. Default value is 3600 (60 minutes).
$sel:s3BackupConfiguration:RedshiftDestinationConfiguration'
, redshiftDestinationConfiguration_s3BackupConfiguration
- The configuration for backup in Amazon S3.
$sel:s3BackupMode:RedshiftDestinationConfiguration'
, redshiftDestinationConfiguration_s3BackupMode
- The Amazon S3 backup mode. After you create a delivery stream, you can
update it to enable Amazon S3 backup if it is disabled. If backup is
enabled, you can't update the delivery stream to disable it.
RedshiftDestinationConfiguration
, redshiftDestinationConfiguration_roleARN
- The Amazon Resource Name (ARN) of the Amazon Web Services credentials.
For more information, see
Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.
$sel:clusterJDBCURL:RedshiftDestinationConfiguration'
, redshiftDestinationConfiguration_clusterJDBCURL
- The database connection string.
$sel:copyCommand:RedshiftDestinationConfiguration'
, redshiftDestinationConfiguration_copyCommand
- The COPY
command.
$sel:username:RedshiftDestinationConfiguration'
, redshiftDestinationConfiguration_username
- The name of the user.
$sel:password:RedshiftDestinationConfiguration'
, redshiftDestinationConfiguration_password
- The user password.
$sel:s3Configuration:RedshiftDestinationConfiguration'
, redshiftDestinationConfiguration_s3Configuration
- The configuration for the intermediate Amazon S3 location from which
Amazon Redshift obtains data. Restrictions are described in the topic
for CreateDeliveryStream.
The compression formats SNAPPY
or ZIP
cannot be specified in
RedshiftDestinationConfiguration.S3Configuration
because the Amazon
Redshift COPY
operation that reads from the S3 bucket doesn't support
these compression formats.
RedshiftDestinationDescription
data RedshiftDestinationDescription Source #
Describes a destination in Amazon Redshift.
See: newRedshiftDestinationDescription
smart constructor.
Instances
newRedshiftDestinationDescription Source #
:: Text | |
-> Text | |
-> CopyCommand | |
-> Text | |
-> S3DestinationDescription |
|
-> RedshiftDestinationDescription |
Create a value of RedshiftDestinationDescription
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
RedshiftDestinationDescription
, redshiftDestinationDescription_cloudWatchLoggingOptions
- The Amazon CloudWatch logging options for your delivery stream.
$sel:processingConfiguration:RedshiftDestinationDescription'
, redshiftDestinationDescription_processingConfiguration
- The data processing configuration.
$sel:retryOptions:RedshiftDestinationDescription'
, redshiftDestinationDescription_retryOptions
- The retry behavior in case Kinesis Data Firehose is unable to deliver
documents to Amazon Redshift. Default value is 3600 (60 minutes).
$sel:s3BackupDescription:RedshiftDestinationDescription'
, redshiftDestinationDescription_s3BackupDescription
- The configuration for backup in Amazon S3.
$sel:s3BackupMode:RedshiftDestinationDescription'
, redshiftDestinationDescription_s3BackupMode
- The Amazon S3 backup mode.
RedshiftDestinationDescription
, redshiftDestinationDescription_roleARN
- The Amazon Resource Name (ARN) of the Amazon Web Services credentials.
For more information, see
Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.
$sel:clusterJDBCURL:RedshiftDestinationDescription'
, redshiftDestinationDescription_clusterJDBCURL
- The database connection string.
$sel:copyCommand:RedshiftDestinationDescription'
, redshiftDestinationDescription_copyCommand
- The COPY
command.
$sel:username:RedshiftDestinationDescription'
, redshiftDestinationDescription_username
- The name of the user.
$sel:s3DestinationDescription:RedshiftDestinationDescription'
, redshiftDestinationDescription_s3DestinationDescription
- The Amazon S3 destination.
RedshiftDestinationUpdate
data RedshiftDestinationUpdate Source #
Describes an update for a destination in Amazon Redshift.
See: newRedshiftDestinationUpdate
smart constructor.
Instances
newRedshiftDestinationUpdate :: RedshiftDestinationUpdate Source #
Create a value of RedshiftDestinationUpdate
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
RedshiftDestinationUpdate
, redshiftDestinationUpdate_cloudWatchLoggingOptions
- The Amazon CloudWatch logging options for your delivery stream.
$sel:clusterJDBCURL:RedshiftDestinationUpdate'
, redshiftDestinationUpdate_clusterJDBCURL
- The database connection string.
$sel:copyCommand:RedshiftDestinationUpdate'
, redshiftDestinationUpdate_copyCommand
- The COPY
command.
$sel:password:RedshiftDestinationUpdate'
, redshiftDestinationUpdate_password
- The user password.
$sel:processingConfiguration:RedshiftDestinationUpdate'
, redshiftDestinationUpdate_processingConfiguration
- The data processing configuration.
$sel:retryOptions:RedshiftDestinationUpdate'
, redshiftDestinationUpdate_retryOptions
- The retry behavior in case Kinesis Data Firehose is unable to deliver
documents to Amazon Redshift. Default value is 3600 (60 minutes).
RedshiftDestinationUpdate
, redshiftDestinationUpdate_roleARN
- The Amazon Resource Name (ARN) of the Amazon Web Services credentials.
For more information, see
Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.
$sel:s3BackupMode:RedshiftDestinationUpdate'
, redshiftDestinationUpdate_s3BackupMode
- You can update a delivery stream to enable Amazon S3 backup if it is
disabled. If backup is enabled, you can't update the delivery stream to
disable it.
$sel:s3BackupUpdate:RedshiftDestinationUpdate'
, redshiftDestinationUpdate_s3BackupUpdate
- The Amazon S3 destination for backup.
$sel:s3Update:RedshiftDestinationUpdate'
, redshiftDestinationUpdate_s3Update
- The Amazon S3 destination.
The compression formats SNAPPY
or ZIP
cannot be specified in
RedshiftDestinationUpdate.S3Update
because the Amazon Redshift COPY
operation that reads from the S3 bucket doesn't support these
compression formats.
$sel:username:RedshiftDestinationUpdate'
, redshiftDestinationUpdate_username
- The name of the user.
RedshiftRetryOptions
data RedshiftRetryOptions Source #
Configures retry behavior in case Kinesis Data Firehose is unable to deliver documents to Amazon Redshift.
See: newRedshiftRetryOptions
smart constructor.
Instances
newRedshiftRetryOptions :: RedshiftRetryOptions Source #
Create a value of RedshiftRetryOptions
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:durationInSeconds:RedshiftRetryOptions'
, redshiftRetryOptions_durationInSeconds
- The length of time during which Kinesis Data Firehose retries delivery
after a failure, starting from the initial request and including the
first attempt. The default value is 3600 seconds (60 minutes). Kinesis
Data Firehose does not retry if the value of DurationInSeconds
is 0
(zero) or if the first delivery attempt takes longer than the current
value.
RetryOptions
data RetryOptions Source #
The retry behavior in case Kinesis Data Firehose is unable to deliver data to an Amazon S3 prefix.
See: newRetryOptions
smart constructor.
Instances
newRetryOptions :: RetryOptions Source #
Create a value of RetryOptions
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:durationInSeconds:RetryOptions'
, retryOptions_durationInSeconds
- The period of time during which Kinesis Data Firehose retries to deliver
data to the specified Amazon S3 prefix.
S3DestinationConfiguration
data S3DestinationConfiguration Source #
Describes the configuration of a destination in Amazon S3.
See: newS3DestinationConfiguration
smart constructor.
S3DestinationConfiguration' (Maybe BufferingHints) (Maybe CloudWatchLoggingOptions) (Maybe CompressionFormat) (Maybe EncryptionConfiguration) (Maybe Text) (Maybe Text) Text Text |
Instances
newS3DestinationConfiguration Source #
:: Text | |
-> Text | |
-> S3DestinationConfiguration |
Create a value of S3DestinationConfiguration
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:bufferingHints:S3DestinationConfiguration'
, s3DestinationConfiguration_bufferingHints
- The buffering option. If no value is specified, BufferingHints
object
default values are used.
$sel:cloudWatchLoggingOptions:S3DestinationConfiguration'
, s3DestinationConfiguration_cloudWatchLoggingOptions
- The CloudWatch logging options for your delivery stream.
$sel:compressionFormat:S3DestinationConfiguration'
, s3DestinationConfiguration_compressionFormat
- The compression format. If no value is specified, the default is
UNCOMPRESSED
.
The compression formats SNAPPY
or ZIP
cannot be specified for Amazon
Redshift destinations because they are not supported by the Amazon
Redshift COPY
operation that reads from the S3 bucket.
$sel:encryptionConfiguration:S3DestinationConfiguration'
, s3DestinationConfiguration_encryptionConfiguration
- The encryption configuration. If no value is specified, the default is
no encryption.
$sel:errorOutputPrefix:S3DestinationConfiguration'
, s3DestinationConfiguration_errorOutputPrefix
- A prefix that Kinesis Data Firehose evaluates and adds to failed records
before writing them to S3. This prefix appears immediately following the
bucket name. For information about how to specify this prefix, see
Custom Prefixes for Amazon S3 Objects.
$sel:prefix:S3DestinationConfiguration'
, s3DestinationConfiguration_prefix
- The "YYYY/MM/DD/HH" time format prefix is automatically used for
delivered Amazon S3 files. You can also specify a custom prefix, as
described in
Custom Prefixes for Amazon S3 Objects.
$sel:roleARN:S3DestinationConfiguration'
, s3DestinationConfiguration_roleARN
- The Amazon Resource Name (ARN) of the Amazon Web Services credentials.
For more information, see
Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.
$sel:bucketARN:S3DestinationConfiguration'
, s3DestinationConfiguration_bucketARN
- The ARN of the S3 bucket. For more information, see
Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.
S3DestinationDescription
data S3DestinationDescription Source #
Describes a destination in Amazon S3.
See: newS3DestinationDescription
smart constructor.
S3DestinationDescription' (Maybe CloudWatchLoggingOptions) (Maybe Text) (Maybe Text) Text Text BufferingHints CompressionFormat EncryptionConfiguration |
Instances
newS3DestinationDescription Source #
:: Text | |
-> Text | |
-> BufferingHints | |
-> CompressionFormat | |
-> EncryptionConfiguration | |
-> S3DestinationDescription |
Create a value of S3DestinationDescription
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:cloudWatchLoggingOptions:S3DestinationDescription'
, s3DestinationDescription_cloudWatchLoggingOptions
- The Amazon CloudWatch logging options for your delivery stream.
$sel:errorOutputPrefix:S3DestinationDescription'
, s3DestinationDescription_errorOutputPrefix
- A prefix that Kinesis Data Firehose evaluates and adds to failed records
before writing them to S3. This prefix appears immediately following the
bucket name. For information about how to specify this prefix, see
Custom Prefixes for Amazon S3 Objects.
$sel:prefix:S3DestinationDescription'
, s3DestinationDescription_prefix
- The "YYYY/MM/DD/HH" time format prefix is automatically used for
delivered Amazon S3 files. You can also specify a custom prefix, as
described in
Custom Prefixes for Amazon S3 Objects.
$sel:roleARN:S3DestinationDescription'
, s3DestinationDescription_roleARN
- The Amazon Resource Name (ARN) of the Amazon Web Services credentials.
For more information, see
Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.
$sel:bucketARN:S3DestinationDescription'
, s3DestinationDescription_bucketARN
- The ARN of the S3 bucket. For more information, see
Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.
$sel:bufferingHints:S3DestinationDescription'
, s3DestinationDescription_bufferingHints
- The buffering option. If no value is specified, BufferingHints
object
default values are used.
$sel:compressionFormat:S3DestinationDescription'
, s3DestinationDescription_compressionFormat
- The compression format. If no value is specified, the default is
UNCOMPRESSED
.
$sel:encryptionConfiguration:S3DestinationDescription'
, s3DestinationDescription_encryptionConfiguration
- The encryption configuration. If no value is specified, the default is
no encryption.
S3DestinationUpdate
data S3DestinationUpdate Source #
Describes an update for a destination in Amazon S3.
See: newS3DestinationUpdate
smart constructor.
S3DestinationUpdate' (Maybe Text) (Maybe BufferingHints) (Maybe CloudWatchLoggingOptions) (Maybe CompressionFormat) (Maybe EncryptionConfiguration) (Maybe Text) (Maybe Text) (Maybe Text) |
Instances
newS3DestinationUpdate :: S3DestinationUpdate Source #
Create a value of S3DestinationUpdate
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:bucketARN:S3DestinationUpdate'
, s3DestinationUpdate_bucketARN
- The ARN of the S3 bucket. For more information, see
Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.
$sel:bufferingHints:S3DestinationUpdate'
, s3DestinationUpdate_bufferingHints
- The buffering option. If no value is specified, BufferingHints
object
default values are used.
$sel:cloudWatchLoggingOptions:S3DestinationUpdate'
, s3DestinationUpdate_cloudWatchLoggingOptions
- The CloudWatch logging options for your delivery stream.
$sel:compressionFormat:S3DestinationUpdate'
, s3DestinationUpdate_compressionFormat
- The compression format. If no value is specified, the default is
UNCOMPRESSED
.
The compression formats SNAPPY
or ZIP
cannot be specified for Amazon
Redshift destinations because they are not supported by the Amazon
Redshift COPY
operation that reads from the S3 bucket.
$sel:encryptionConfiguration:S3DestinationUpdate'
, s3DestinationUpdate_encryptionConfiguration
- The encryption configuration. If no value is specified, the default is
no encryption.
$sel:errorOutputPrefix:S3DestinationUpdate'
, s3DestinationUpdate_errorOutputPrefix
- A prefix that Kinesis Data Firehose evaluates and adds to failed records
before writing them to S3. This prefix appears immediately following the
bucket name. For information about how to specify this prefix, see
Custom Prefixes for Amazon S3 Objects.
$sel:prefix:S3DestinationUpdate'
, s3DestinationUpdate_prefix
- The "YYYY/MM/DD/HH" time format prefix is automatically used for
delivered Amazon S3 files. You can also specify a custom prefix, as
described in
Custom Prefixes for Amazon S3 Objects.
$sel:roleARN:S3DestinationUpdate'
, s3DestinationUpdate_roleARN
- The Amazon Resource Name (ARN) of the Amazon Web Services credentials.
For more information, see
Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.
SchemaConfiguration
data SchemaConfiguration Source #
Specifies the schema to which you want Kinesis Data Firehose to
configure your data before it writes it to Amazon S3. This parameter is
required if Enabled
is set to true.
See: newSchemaConfiguration
smart constructor.
Instances
newSchemaConfiguration :: SchemaConfiguration Source #
Create a value of SchemaConfiguration
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:catalogId:SchemaConfiguration'
, schemaConfiguration_catalogId
- The ID of the Amazon Web Services Glue Data Catalog. If you don't
supply this, the Amazon Web Services account ID is used by default.
$sel:databaseName:SchemaConfiguration'
, schemaConfiguration_databaseName
- Specifies the name of the Amazon Web Services Glue database that
contains the schema for the output data.
If the SchemaConfiguration
request parameter is used as part of
invoking the CreateDeliveryStream
API, then the DatabaseName
property is required and its value must be specified.
$sel:region:SchemaConfiguration'
, schemaConfiguration_region
- If you don't specify an Amazon Web Services Region, the default is the
current Region.
$sel:roleARN:SchemaConfiguration'
, schemaConfiguration_roleARN
- The role that Kinesis Data Firehose can use to access Amazon Web
Services Glue. This role must be in the same account you use for Kinesis
Data Firehose. Cross-account roles aren't allowed.
If the SchemaConfiguration
request parameter is used as part of
invoking the CreateDeliveryStream
API, then the RoleARN
property is
required and its value must be specified.
$sel:tableName:SchemaConfiguration'
, schemaConfiguration_tableName
- Specifies the Amazon Web Services Glue table that contains the column
information that constitutes your data schema.
If the SchemaConfiguration
request parameter is used as part of
invoking the CreateDeliveryStream
API, then the TableName
property
is required and its value must be specified.
$sel:versionId:SchemaConfiguration'
, schemaConfiguration_versionId
- Specifies the table version for the output data schema. If you don't
specify this version ID, or if you set it to LATEST
, Kinesis Data
Firehose uses the most recent version. This means that any updates to
the table are automatically picked up.
Serializer
data Serializer Source #
The serializer that you want Kinesis Data Firehose to use to convert data to the target format before writing it to Amazon S3. Kinesis Data Firehose supports two types of serializers: the ORC SerDe and the Parquet SerDe.
See: newSerializer
smart constructor.
Instances
newSerializer :: Serializer Source #
Create a value of Serializer
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:orcSerDe:Serializer'
, serializer_orcSerDe
- A serializer to use for converting data to the ORC format before storing
it in Amazon S3. For more information, see
Apache ORC.
$sel:parquetSerDe:Serializer'
, serializer_parquetSerDe
- A serializer to use for converting data to the Parquet format before
storing it in Amazon S3. For more information, see
Apache Parquet.
SourceDescription
data SourceDescription Source #
Details about a Kinesis data stream used as the source for a Kinesis Data Firehose delivery stream.
See: newSourceDescription
smart constructor.
Instances
newSourceDescription :: SourceDescription Source #
Create a value of SourceDescription
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:kinesisStreamSourceDescription:SourceDescription'
, sourceDescription_kinesisStreamSourceDescription
- The KinesisStreamSourceDescription value for the source Kinesis data
stream.
SplunkDestinationConfiguration
data SplunkDestinationConfiguration Source #
Describes the configuration of a destination in Splunk.
See: newSplunkDestinationConfiguration
smart constructor.
Instances
newSplunkDestinationConfiguration Source #
Create a value of SplunkDestinationConfiguration
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
SplunkDestinationConfiguration
, splunkDestinationConfiguration_cloudWatchLoggingOptions
- The Amazon CloudWatch logging options for your delivery stream.
$sel:hECAcknowledgmentTimeoutInSeconds:SplunkDestinationConfiguration'
, splunkDestinationConfiguration_hECAcknowledgmentTimeoutInSeconds
- The amount of time that Kinesis Data Firehose waits to receive an
acknowledgment from Splunk after it sends it data. At the end of the
timeout period, Kinesis Data Firehose either tries to send the data
again or considers it an error, based on your retry settings.
$sel:processingConfiguration:SplunkDestinationConfiguration'
, splunkDestinationConfiguration_processingConfiguration
- The data processing configuration.
$sel:retryOptions:SplunkDestinationConfiguration'
, splunkDestinationConfiguration_retryOptions
- The retry behavior in case Kinesis Data Firehose is unable to deliver
data to Splunk, or if it doesn't receive an acknowledgment of receipt
from Splunk.
$sel:s3BackupMode:SplunkDestinationConfiguration'
, splunkDestinationConfiguration_s3BackupMode
- Defines how documents should be delivered to Amazon S3. When set to
FailedEventsOnly
, Kinesis Data Firehose writes any data that could not
be indexed to the configured Amazon S3 destination. When set to
AllEvents
, Kinesis Data Firehose delivers all incoming records to
Amazon S3, and also writes failed documents to Amazon S3. The default
value is FailedEventsOnly
.
You can update this backup mode from FailedEventsOnly
to AllEvents
.
You can't update it from AllEvents
to FailedEventsOnly
.
$sel:hECEndpoint:SplunkDestinationConfiguration'
, splunkDestinationConfiguration_hECEndpoint
- The HTTP Event Collector (HEC) endpoint to which Kinesis Data Firehose
sends your data.
$sel:hECEndpointType:SplunkDestinationConfiguration'
, splunkDestinationConfiguration_hECEndpointType
- This type can be either "Raw" or "Event."
$sel:hECToken:SplunkDestinationConfiguration'
, splunkDestinationConfiguration_hECToken
- This is a GUID that you obtain from your Splunk cluster when you create
a new HEC endpoint.
$sel:s3Configuration:SplunkDestinationConfiguration'
, splunkDestinationConfiguration_s3Configuration
- The configuration for the backup Amazon S3 location.
SplunkDestinationDescription
data SplunkDestinationDescription Source #
Describes a destination in Splunk.
See: newSplunkDestinationDescription
smart constructor.
Instances
newSplunkDestinationDescription :: SplunkDestinationDescription Source #
Create a value of SplunkDestinationDescription
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
SplunkDestinationDescription
, splunkDestinationDescription_cloudWatchLoggingOptions
- The Amazon CloudWatch logging options for your delivery stream.
$sel:hECAcknowledgmentTimeoutInSeconds:SplunkDestinationDescription'
, splunkDestinationDescription_hECAcknowledgmentTimeoutInSeconds
- The amount of time that Kinesis Data Firehose waits to receive an
acknowledgment from Splunk after it sends it data. At the end of the
timeout period, Kinesis Data Firehose either tries to send the data
again or considers it an error, based on your retry settings.
$sel:hECEndpoint:SplunkDestinationDescription'
, splunkDestinationDescription_hECEndpoint
- The HTTP Event Collector (HEC) endpoint to which Kinesis Data Firehose
sends your data.
$sel:hECEndpointType:SplunkDestinationDescription'
, splunkDestinationDescription_hECEndpointType
- This type can be either "Raw" or "Event."
$sel:hECToken:SplunkDestinationDescription'
, splunkDestinationDescription_hECToken
- A GUID you obtain from your Splunk cluster when you create a new HEC
endpoint.
$sel:processingConfiguration:SplunkDestinationDescription'
, splunkDestinationDescription_processingConfiguration
- The data processing configuration.
$sel:retryOptions:SplunkDestinationDescription'
, splunkDestinationDescription_retryOptions
- The retry behavior in case Kinesis Data Firehose is unable to deliver
data to Splunk or if it doesn't receive an acknowledgment of receipt
from Splunk.
$sel:s3BackupMode:SplunkDestinationDescription'
, splunkDestinationDescription_s3BackupMode
- Defines how documents should be delivered to Amazon S3. When set to
FailedDocumentsOnly
, Kinesis Data Firehose writes any data that could
not be indexed to the configured Amazon S3 destination. When set to
AllDocuments
, Kinesis Data Firehose delivers all incoming records to
Amazon S3, and also writes failed documents to Amazon S3. Default value
is FailedDocumentsOnly
.
$sel:s3DestinationDescription:SplunkDestinationDescription'
, splunkDestinationDescription_s3DestinationDescription
- The Amazon S3 destination.>
SplunkDestinationUpdate
data SplunkDestinationUpdate Source #
Describes an update for a destination in Splunk.
See: newSplunkDestinationUpdate
smart constructor.
Instances
newSplunkDestinationUpdate :: SplunkDestinationUpdate Source #
Create a value of SplunkDestinationUpdate
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
SplunkDestinationUpdate
, splunkDestinationUpdate_cloudWatchLoggingOptions
- The Amazon CloudWatch logging options for your delivery stream.
$sel:hECAcknowledgmentTimeoutInSeconds:SplunkDestinationUpdate'
, splunkDestinationUpdate_hECAcknowledgmentTimeoutInSeconds
- The amount of time that Kinesis Data Firehose waits to receive an
acknowledgment from Splunk after it sends data. At the end of the
timeout period, Kinesis Data Firehose either tries to send the data
again or considers it an error, based on your retry settings.
$sel:hECEndpoint:SplunkDestinationUpdate'
, splunkDestinationUpdate_hECEndpoint
- The HTTP Event Collector (HEC) endpoint to which Kinesis Data Firehose
sends your data.
$sel:hECEndpointType:SplunkDestinationUpdate'
, splunkDestinationUpdate_hECEndpointType
- This type can be either "Raw" or "Event."
$sel:hECToken:SplunkDestinationUpdate'
, splunkDestinationUpdate_hECToken
- A GUID that you obtain from your Splunk cluster when you create a new
HEC endpoint.
$sel:processingConfiguration:SplunkDestinationUpdate'
, splunkDestinationUpdate_processingConfiguration
- The data processing configuration.
$sel:retryOptions:SplunkDestinationUpdate'
, splunkDestinationUpdate_retryOptions
- The retry behavior in case Kinesis Data Firehose is unable to deliver
data to Splunk or if it doesn't receive an acknowledgment of receipt
from Splunk.
$sel:s3BackupMode:SplunkDestinationUpdate'
, splunkDestinationUpdate_s3BackupMode
- Specifies how you want Kinesis Data Firehose to back up documents to
Amazon S3. When set to FailedDocumentsOnly
, Kinesis Data Firehose
writes any data that could not be indexed to the configured Amazon S3
destination. When set to AllEvents
, Kinesis Data Firehose delivers all
incoming records to Amazon S3, and also writes failed documents to
Amazon S3. The default value is FailedEventsOnly
.
You can update this backup mode from FailedEventsOnly
to AllEvents
.
You can't update it from AllEvents
to FailedEventsOnly
.
$sel:s3Update:SplunkDestinationUpdate'
, splunkDestinationUpdate_s3Update
- Your update to the configuration of the backup Amazon S3 location.
SplunkRetryOptions
data SplunkRetryOptions Source #
Configures retry behavior in case Kinesis Data Firehose is unable to deliver documents to Splunk, or if it doesn't receive an acknowledgment from Splunk.
See: newSplunkRetryOptions
smart constructor.
Instances
newSplunkRetryOptions :: SplunkRetryOptions Source #
Create a value of SplunkRetryOptions
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:durationInSeconds:SplunkRetryOptions'
, splunkRetryOptions_durationInSeconds
- The total amount of time that Kinesis Data Firehose spends on retries.
This duration starts after the initial attempt to send data to Splunk
fails. It doesn't include the periods during which Kinesis Data
Firehose waits for acknowledgment from Splunk after each attempt.
Tag
Metadata that you can assign to a delivery stream, consisting of a key-value pair.
See: newTag
smart constructor.
Instances
FromJSON Tag Source # | |
ToJSON Tag Source # | |
Defined in Amazonka.Firehose.Types.Tag | |
Generic Tag Source # | |
Read Tag Source # | |
Show Tag Source # | |
NFData Tag Source # | |
Defined in Amazonka.Firehose.Types.Tag | |
Eq Tag Source # | |
Hashable Tag Source # | |
Defined in Amazonka.Firehose.Types.Tag | |
type Rep Tag Source # | |
Defined in Amazonka.Firehose.Types.Tag type Rep Tag = D1 ('MetaData "Tag" "Amazonka.Firehose.Types.Tag" "amazonka-kinesis-firehose-2.0-6l1hHmh2UnHBvolxuQFkWB" 'False) (C1 ('MetaCons "Tag'" 'PrefixI 'True) (S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "key") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) |
Create a value of Tag
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:value:Tag'
, tag_value
- An optional string, which you can use to describe or define the tag.
Maximum length: 256 characters. Valid characters: Unicode letters,
digits, white space, _ . / = + - % @
$sel:key:Tag'
, tag_key
- A unique identifier for the tag. Maximum length: 128 characters. Valid
characters: Unicode letters, digits, white space, _ . / = + - % @
VpcConfiguration
data VpcConfiguration Source #
The details of the VPC of the Amazon ES destination.
See: newVpcConfiguration
smart constructor.
Instances
Create a value of VpcConfiguration
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:subnetIds:VpcConfiguration'
, vpcConfiguration_subnetIds
- The IDs of the subnets that you want Kinesis Data Firehose to use to
create ENIs in the VPC of the Amazon ES destination. Make sure that the
routing tables and inbound and outbound rules allow traffic to flow from
the subnets whose IDs are specified here to the subnets that have the
destination Amazon ES endpoints. Kinesis Data Firehose creates at least
one ENI in each of the subnets that are specified here. Do not delete or
modify these ENIs.
The number of ENIs that Kinesis Data Firehose creates in the subnets specified here scales up and down automatically based on throughput. To enable Kinesis Data Firehose to scale up the number of ENIs to match throughput, ensure that you have sufficient quota. To help you calculate the quota you need, assume that Kinesis Data Firehose can create up to three ENIs for this delivery stream for each of the subnets specified here. For more information about ENI quota, see Network Interfaces in the Amazon VPC Quotas topic.
$sel:roleARN:VpcConfiguration'
, vpcConfiguration_roleARN
- The ARN of the IAM role that you want the delivery stream to use to
create endpoints in the destination VPC. You can use your existing
Kinesis Data Firehose delivery role or you can specify a new role. In
either case, make sure that the role trusts the Kinesis Data Firehose
service principal and that it grants the following permissions:
ec2:DescribeVpcs
ec2:DescribeVpcAttribute
ec2:DescribeSubnets
ec2:DescribeSecurityGroups
ec2:DescribeNetworkInterfaces
ec2:CreateNetworkInterface
ec2:CreateNetworkInterfacePermission
ec2:DeleteNetworkInterface
If you revoke these permissions after you create the delivery stream, Kinesis Data Firehose can't scale out by creating more ENIs when necessary. You might therefore see a degradation in performance.
$sel:securityGroupIds:VpcConfiguration'
, vpcConfiguration_securityGroupIds
- The IDs of the security groups that you want Kinesis Data Firehose to
use when it creates ENIs in the VPC of the Amazon ES destination. You
can use the same security group that the Amazon ES domain uses or
different ones. If you specify different security groups here, ensure
that they allow outbound HTTPS traffic to the Amazon ES domain's
security group. Also ensure that the Amazon ES domain's security group
allows HTTPS traffic from the security groups specified here. If you use
the same security group for both your delivery stream and the Amazon ES
domain, make sure the security group inbound rule allows HTTPS traffic.
For more information about security group rules, see
Security group rules
in the Amazon VPC documentation.
VpcConfigurationDescription
data VpcConfigurationDescription Source #
The details of the VPC of the Amazon ES destination.
See: newVpcConfigurationDescription
smart constructor.
Instances
newVpcConfigurationDescription Source #
Create a value of VpcConfigurationDescription
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:subnetIds:VpcConfigurationDescription'
, vpcConfigurationDescription_subnetIds
- The IDs of the subnets that Kinesis Data Firehose uses to create ENIs in
the VPC of the Amazon ES destination. Make sure that the routing tables
and inbound and outbound rules allow traffic to flow from the subnets
whose IDs are specified here to the subnets that have the destination
Amazon ES endpoints. Kinesis Data Firehose creates at least one ENI in
each of the subnets that are specified here. Do not delete or modify
these ENIs.
The number of ENIs that Kinesis Data Firehose creates in the subnets specified here scales up and down automatically based on throughput. To enable Kinesis Data Firehose to scale up the number of ENIs to match throughput, ensure that you have sufficient quota. To help you calculate the quota you need, assume that Kinesis Data Firehose can create up to three ENIs for this delivery stream for each of the subnets specified here. For more information about ENI quota, see Network Interfaces in the Amazon VPC Quotas topic.
$sel:roleARN:VpcConfigurationDescription'
, vpcConfigurationDescription_roleARN
- The ARN of the IAM role that the delivery stream uses to create
endpoints in the destination VPC. You can use your existing Kinesis Data
Firehose delivery role or you can specify a new role. In either case,
make sure that the role trusts the Kinesis Data Firehose service
principal and that it grants the following permissions:
ec2:DescribeVpcs
ec2:DescribeVpcAttribute
ec2:DescribeSubnets
ec2:DescribeSecurityGroups
ec2:DescribeNetworkInterfaces
ec2:CreateNetworkInterface
ec2:CreateNetworkInterfacePermission
ec2:DeleteNetworkInterface
If you revoke these permissions after you create the delivery stream, Kinesis Data Firehose can't scale out by creating more ENIs when necessary. You might therefore see a degradation in performance.
$sel:securityGroupIds:VpcConfigurationDescription'
, vpcConfigurationDescription_securityGroupIds
- The IDs of the security groups that Kinesis Data Firehose uses when it
creates ENIs in the VPC of the Amazon ES destination. You can use the
same security group that the Amazon ES domain uses or different ones. If
you specify different security groups, ensure that they allow outbound
HTTPS traffic to the Amazon ES domain's security group. Also ensure
that the Amazon ES domain's security group allows HTTPS traffic from
the security groups specified here. If you use the same security group
for both your delivery stream and the Amazon ES domain, make sure the
security group inbound rule allows HTTPS traffic. For more information
about security group rules, see
Security group rules
in the Amazon VPC documentation.
$sel:vpcId:VpcConfigurationDescription'
, vpcConfigurationDescription_vpcId
- The ID of the Amazon ES destination's VPC.