| Copyright | (c) 2013-2021 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
Amazonka.Firehose.Types
Contents
- Service Configuration
- Errors
- AmazonopensearchserviceIndexRotationPeriod
- AmazonopensearchserviceS3BackupMode
- CompressionFormat
- ContentEncoding
- DeliveryStreamEncryptionStatus
- DeliveryStreamFailureType
- DeliveryStreamStatus
- DeliveryStreamType
- ElasticsearchIndexRotationPeriod
- ElasticsearchS3BackupMode
- HECEndpointType
- HttpEndpointS3BackupMode
- KeyType
- NoEncryptionConfig
- OrcCompression
- OrcFormatVersion
- ParquetCompression
- ParquetWriterVersion
- ProcessorParameterName
- ProcessorType
- RedshiftS3BackupMode
- S3BackupMode
- SplunkS3BackupMode
- 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
Description
Synopsis
- defaultService :: Service
- _InvalidArgumentException :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidKMSResourceException :: AsError a => Getting (First ServiceError) a ServiceError
- _ConcurrentModificationException :: AsError a => Getting (First ServiceError) a ServiceError
- _ServiceUnavailableException :: AsError a => Getting (First ServiceError) a ServiceError
- _ResourceNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError
- _LimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError
- _ResourceInUseException :: AsError a => Getting (First ServiceError) a ServiceError
- 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 AmazonopensearchserviceBufferingHints = AmazonopensearchserviceBufferingHints' {}
- newAmazonopensearchserviceBufferingHints :: AmazonopensearchserviceBufferingHints
- amazonopensearchserviceBufferingHints_sizeInMBs :: Lens' AmazonopensearchserviceBufferingHints (Maybe Natural)
- amazonopensearchserviceBufferingHints_intervalInSeconds :: Lens' AmazonopensearchserviceBufferingHints (Maybe Natural)
- data AmazonopensearchserviceDestinationConfiguration = AmazonopensearchserviceDestinationConfiguration' {
- indexRotationPeriod :: Maybe AmazonopensearchserviceIndexRotationPeriod
- typeName :: Maybe Text
- s3BackupMode :: Maybe AmazonopensearchserviceS3BackupMode
- domainARN :: Maybe Text
- cloudWatchLoggingOptions :: Maybe CloudWatchLoggingOptions
- vpcConfiguration :: Maybe VpcConfiguration
- bufferingHints :: Maybe AmazonopensearchserviceBufferingHints
- retryOptions :: Maybe AmazonopensearchserviceRetryOptions
- processingConfiguration :: Maybe ProcessingConfiguration
- clusterEndpoint :: Maybe Text
- roleARN :: Text
- indexName :: Text
- s3Configuration :: S3DestinationConfiguration
- newAmazonopensearchserviceDestinationConfiguration :: Text -> Text -> S3DestinationConfiguration -> AmazonopensearchserviceDestinationConfiguration
- amazonopensearchserviceDestinationConfiguration_indexRotationPeriod :: Lens' AmazonopensearchserviceDestinationConfiguration (Maybe AmazonopensearchserviceIndexRotationPeriod)
- amazonopensearchserviceDestinationConfiguration_typeName :: Lens' AmazonopensearchserviceDestinationConfiguration (Maybe Text)
- amazonopensearchserviceDestinationConfiguration_s3BackupMode :: Lens' AmazonopensearchserviceDestinationConfiguration (Maybe AmazonopensearchserviceS3BackupMode)
- amazonopensearchserviceDestinationConfiguration_domainARN :: Lens' AmazonopensearchserviceDestinationConfiguration (Maybe Text)
- amazonopensearchserviceDestinationConfiguration_cloudWatchLoggingOptions :: Lens' AmazonopensearchserviceDestinationConfiguration (Maybe CloudWatchLoggingOptions)
- amazonopensearchserviceDestinationConfiguration_vpcConfiguration :: Lens' AmazonopensearchserviceDestinationConfiguration (Maybe VpcConfiguration)
- amazonopensearchserviceDestinationConfiguration_bufferingHints :: Lens' AmazonopensearchserviceDestinationConfiguration (Maybe AmazonopensearchserviceBufferingHints)
- amazonopensearchserviceDestinationConfiguration_retryOptions :: Lens' AmazonopensearchserviceDestinationConfiguration (Maybe AmazonopensearchserviceRetryOptions)
- amazonopensearchserviceDestinationConfiguration_processingConfiguration :: Lens' AmazonopensearchserviceDestinationConfiguration (Maybe ProcessingConfiguration)
- amazonopensearchserviceDestinationConfiguration_clusterEndpoint :: Lens' AmazonopensearchserviceDestinationConfiguration (Maybe Text)
- amazonopensearchserviceDestinationConfiguration_roleARN :: Lens' AmazonopensearchserviceDestinationConfiguration Text
- amazonopensearchserviceDestinationConfiguration_indexName :: Lens' AmazonopensearchserviceDestinationConfiguration Text
- amazonopensearchserviceDestinationConfiguration_s3Configuration :: Lens' AmazonopensearchserviceDestinationConfiguration S3DestinationConfiguration
- data AmazonopensearchserviceDestinationDescription = AmazonopensearchserviceDestinationDescription' {
- indexRotationPeriod :: Maybe AmazonopensearchserviceIndexRotationPeriod
- typeName :: Maybe Text
- s3BackupMode :: Maybe AmazonopensearchserviceS3BackupMode
- domainARN :: Maybe Text
- vpcConfigurationDescription :: Maybe VpcConfigurationDescription
- cloudWatchLoggingOptions :: Maybe CloudWatchLoggingOptions
- s3DestinationDescription :: Maybe S3DestinationDescription
- bufferingHints :: Maybe AmazonopensearchserviceBufferingHints
- retryOptions :: Maybe AmazonopensearchserviceRetryOptions
- processingConfiguration :: Maybe ProcessingConfiguration
- roleARN :: Maybe Text
- clusterEndpoint :: Maybe Text
- indexName :: Maybe Text
- newAmazonopensearchserviceDestinationDescription :: AmazonopensearchserviceDestinationDescription
- amazonopensearchserviceDestinationDescription_indexRotationPeriod :: Lens' AmazonopensearchserviceDestinationDescription (Maybe AmazonopensearchserviceIndexRotationPeriod)
- amazonopensearchserviceDestinationDescription_typeName :: Lens' AmazonopensearchserviceDestinationDescription (Maybe Text)
- amazonopensearchserviceDestinationDescription_s3BackupMode :: Lens' AmazonopensearchserviceDestinationDescription (Maybe AmazonopensearchserviceS3BackupMode)
- amazonopensearchserviceDestinationDescription_domainARN :: Lens' AmazonopensearchserviceDestinationDescription (Maybe Text)
- amazonopensearchserviceDestinationDescription_vpcConfigurationDescription :: Lens' AmazonopensearchserviceDestinationDescription (Maybe VpcConfigurationDescription)
- amazonopensearchserviceDestinationDescription_cloudWatchLoggingOptions :: Lens' AmazonopensearchserviceDestinationDescription (Maybe CloudWatchLoggingOptions)
- amazonopensearchserviceDestinationDescription_s3DestinationDescription :: Lens' AmazonopensearchserviceDestinationDescription (Maybe S3DestinationDescription)
- amazonopensearchserviceDestinationDescription_bufferingHints :: Lens' AmazonopensearchserviceDestinationDescription (Maybe AmazonopensearchserviceBufferingHints)
- amazonopensearchserviceDestinationDescription_retryOptions :: Lens' AmazonopensearchserviceDestinationDescription (Maybe AmazonopensearchserviceRetryOptions)
- amazonopensearchserviceDestinationDescription_processingConfiguration :: Lens' AmazonopensearchserviceDestinationDescription (Maybe ProcessingConfiguration)
- amazonopensearchserviceDestinationDescription_roleARN :: Lens' AmazonopensearchserviceDestinationDescription (Maybe Text)
- amazonopensearchserviceDestinationDescription_clusterEndpoint :: Lens' AmazonopensearchserviceDestinationDescription (Maybe Text)
- amazonopensearchserviceDestinationDescription_indexName :: Lens' AmazonopensearchserviceDestinationDescription (Maybe Text)
- data AmazonopensearchserviceDestinationUpdate = AmazonopensearchserviceDestinationUpdate' {
- indexRotationPeriod :: Maybe AmazonopensearchserviceIndexRotationPeriod
- typeName :: Maybe Text
- domainARN :: Maybe Text
- cloudWatchLoggingOptions :: Maybe CloudWatchLoggingOptions
- s3Update :: Maybe S3DestinationUpdate
- bufferingHints :: Maybe AmazonopensearchserviceBufferingHints
- retryOptions :: Maybe AmazonopensearchserviceRetryOptions
- processingConfiguration :: Maybe ProcessingConfiguration
- roleARN :: Maybe Text
- clusterEndpoint :: Maybe Text
- indexName :: Maybe Text
- newAmazonopensearchserviceDestinationUpdate :: AmazonopensearchserviceDestinationUpdate
- amazonopensearchserviceDestinationUpdate_indexRotationPeriod :: Lens' AmazonopensearchserviceDestinationUpdate (Maybe AmazonopensearchserviceIndexRotationPeriod)
- amazonopensearchserviceDestinationUpdate_typeName :: Lens' AmazonopensearchserviceDestinationUpdate (Maybe Text)
- amazonopensearchserviceDestinationUpdate_domainARN :: Lens' AmazonopensearchserviceDestinationUpdate (Maybe Text)
- amazonopensearchserviceDestinationUpdate_cloudWatchLoggingOptions :: Lens' AmazonopensearchserviceDestinationUpdate (Maybe CloudWatchLoggingOptions)
- amazonopensearchserviceDestinationUpdate_s3Update :: Lens' AmazonopensearchserviceDestinationUpdate (Maybe S3DestinationUpdate)
- amazonopensearchserviceDestinationUpdate_bufferingHints :: Lens' AmazonopensearchserviceDestinationUpdate (Maybe AmazonopensearchserviceBufferingHints)
- amazonopensearchserviceDestinationUpdate_retryOptions :: Lens' AmazonopensearchserviceDestinationUpdate (Maybe AmazonopensearchserviceRetryOptions)
- amazonopensearchserviceDestinationUpdate_processingConfiguration :: Lens' AmazonopensearchserviceDestinationUpdate (Maybe ProcessingConfiguration)
- amazonopensearchserviceDestinationUpdate_roleARN :: Lens' AmazonopensearchserviceDestinationUpdate (Maybe Text)
- amazonopensearchserviceDestinationUpdate_clusterEndpoint :: Lens' AmazonopensearchserviceDestinationUpdate (Maybe Text)
- amazonopensearchserviceDestinationUpdate_indexName :: Lens' AmazonopensearchserviceDestinationUpdate (Maybe Text)
- data AmazonopensearchserviceRetryOptions = AmazonopensearchserviceRetryOptions' {}
- newAmazonopensearchserviceRetryOptions :: AmazonopensearchserviceRetryOptions
- amazonopensearchserviceRetryOptions_durationInSeconds :: Lens' AmazonopensearchserviceRetryOptions (Maybe Natural)
- data BufferingHints = BufferingHints' {}
- newBufferingHints :: BufferingHints
- bufferingHints_sizeInMBs :: Lens' BufferingHints (Maybe Natural)
- bufferingHints_intervalInSeconds :: Lens' BufferingHints (Maybe Natural)
- data CloudWatchLoggingOptions = CloudWatchLoggingOptions' {
- enabled :: Maybe Bool
- logGroupName :: Maybe Text
- logStreamName :: Maybe Text
- newCloudWatchLoggingOptions :: CloudWatchLoggingOptions
- cloudWatchLoggingOptions_enabled :: Lens' CloudWatchLoggingOptions (Maybe Bool)
- cloudWatchLoggingOptions_logGroupName :: Lens' CloudWatchLoggingOptions (Maybe Text)
- cloudWatchLoggingOptions_logStreamName :: Lens' CloudWatchLoggingOptions (Maybe Text)
- data CopyCommand = CopyCommand' {}
- newCopyCommand :: Text -> CopyCommand
- copyCommand_copyOptions :: Lens' CopyCommand (Maybe Text)
- copyCommand_dataTableColumns :: Lens' CopyCommand (Maybe Text)
- copyCommand_dataTableName :: Lens' CopyCommand Text
- data DataFormatConversionConfiguration = DataFormatConversionConfiguration' {}
- newDataFormatConversionConfiguration :: DataFormatConversionConfiguration
- dataFormatConversionConfiguration_outputFormatConfiguration :: Lens' DataFormatConversionConfiguration (Maybe OutputFormatConfiguration)
- dataFormatConversionConfiguration_enabled :: Lens' DataFormatConversionConfiguration (Maybe Bool)
- dataFormatConversionConfiguration_schemaConfiguration :: Lens' DataFormatConversionConfiguration (Maybe SchemaConfiguration)
- dataFormatConversionConfiguration_inputFormatConfiguration :: Lens' DataFormatConversionConfiguration (Maybe InputFormatConfiguration)
- data DeliveryStreamDescription = DeliveryStreamDescription' {
- failureDescription :: Maybe FailureDescription
- deliveryStreamEncryptionConfiguration :: Maybe DeliveryStreamEncryptionConfiguration
- createTimestamp :: Maybe POSIX
- source :: Maybe SourceDescription
- lastUpdateTimestamp :: Maybe POSIX
- deliveryStreamName :: Text
- deliveryStreamARN :: Text
- deliveryStreamStatus :: DeliveryStreamStatus
- deliveryStreamType :: DeliveryStreamType
- versionId :: Text
- destinations :: [DestinationDescription]
- hasMoreDestinations :: Bool
- newDeliveryStreamDescription :: Text -> Text -> DeliveryStreamStatus -> DeliveryStreamType -> Text -> Bool -> DeliveryStreamDescription
- deliveryStreamDescription_failureDescription :: Lens' DeliveryStreamDescription (Maybe FailureDescription)
- deliveryStreamDescription_deliveryStreamEncryptionConfiguration :: Lens' DeliveryStreamDescription (Maybe DeliveryStreamEncryptionConfiguration)
- deliveryStreamDescription_createTimestamp :: Lens' DeliveryStreamDescription (Maybe UTCTime)
- deliveryStreamDescription_source :: Lens' DeliveryStreamDescription (Maybe SourceDescription)
- deliveryStreamDescription_lastUpdateTimestamp :: Lens' DeliveryStreamDescription (Maybe UTCTime)
- deliveryStreamDescription_deliveryStreamName :: Lens' DeliveryStreamDescription Text
- deliveryStreamDescription_deliveryStreamARN :: Lens' DeliveryStreamDescription Text
- deliveryStreamDescription_deliveryStreamStatus :: Lens' DeliveryStreamDescription DeliveryStreamStatus
- deliveryStreamDescription_deliveryStreamType :: Lens' DeliveryStreamDescription DeliveryStreamType
- deliveryStreamDescription_versionId :: Lens' DeliveryStreamDescription Text
- deliveryStreamDescription_destinations :: Lens' DeliveryStreamDescription [DestinationDescription]
- deliveryStreamDescription_hasMoreDestinations :: Lens' DeliveryStreamDescription Bool
- data DeliveryStreamEncryptionConfiguration = DeliveryStreamEncryptionConfiguration' {}
- newDeliveryStreamEncryptionConfiguration :: DeliveryStreamEncryptionConfiguration
- deliveryStreamEncryptionConfiguration_status :: Lens' DeliveryStreamEncryptionConfiguration (Maybe DeliveryStreamEncryptionStatus)
- deliveryStreamEncryptionConfiguration_keyType :: Lens' DeliveryStreamEncryptionConfiguration (Maybe KeyType)
- deliveryStreamEncryptionConfiguration_keyARN :: Lens' DeliveryStreamEncryptionConfiguration (Maybe Text)
- deliveryStreamEncryptionConfiguration_failureDescription :: Lens' DeliveryStreamEncryptionConfiguration (Maybe FailureDescription)
- data DeliveryStreamEncryptionConfigurationInput = DeliveryStreamEncryptionConfigurationInput' {}
- newDeliveryStreamEncryptionConfigurationInput :: KeyType -> DeliveryStreamEncryptionConfigurationInput
- deliveryStreamEncryptionConfigurationInput_keyARN :: Lens' DeliveryStreamEncryptionConfigurationInput (Maybe Text)
- deliveryStreamEncryptionConfigurationInput_keyType :: Lens' DeliveryStreamEncryptionConfigurationInput KeyType
- data Deserializer = Deserializer' {}
- newDeserializer :: Deserializer
- deserializer_openXJsonSerDe :: Lens' Deserializer (Maybe OpenXJsonSerDe)
- deserializer_hiveJsonSerDe :: Lens' Deserializer (Maybe HiveJsonSerDe)
- data DestinationDescription = DestinationDescription' {
- splunkDestinationDescription :: Maybe SplunkDestinationDescription
- amazonopensearchserviceDestinationDescription :: Maybe AmazonopensearchserviceDestinationDescription
- httpEndpointDestinationDescription :: Maybe HttpEndpointDestinationDescription
- s3DestinationDescription :: Maybe S3DestinationDescription
- extendedS3DestinationDescription :: Maybe ExtendedS3DestinationDescription
- elasticsearchDestinationDescription :: Maybe ElasticsearchDestinationDescription
- redshiftDestinationDescription :: Maybe RedshiftDestinationDescription
- destinationId :: Text
- newDestinationDescription :: Text -> DestinationDescription
- destinationDescription_splunkDestinationDescription :: Lens' DestinationDescription (Maybe SplunkDestinationDescription)
- destinationDescription_amazonopensearchserviceDestinationDescription :: Lens' DestinationDescription (Maybe AmazonopensearchserviceDestinationDescription)
- destinationDescription_httpEndpointDestinationDescription :: Lens' DestinationDescription (Maybe HttpEndpointDestinationDescription)
- destinationDescription_s3DestinationDescription :: Lens' DestinationDescription (Maybe S3DestinationDescription)
- destinationDescription_extendedS3DestinationDescription :: Lens' DestinationDescription (Maybe ExtendedS3DestinationDescription)
- destinationDescription_elasticsearchDestinationDescription :: Lens' DestinationDescription (Maybe ElasticsearchDestinationDescription)
- destinationDescription_redshiftDestinationDescription :: Lens' DestinationDescription (Maybe RedshiftDestinationDescription)
- destinationDescription_destinationId :: Lens' DestinationDescription Text
- data DynamicPartitioningConfiguration = DynamicPartitioningConfiguration' {}
- newDynamicPartitioningConfiguration :: DynamicPartitioningConfiguration
- dynamicPartitioningConfiguration_enabled :: Lens' DynamicPartitioningConfiguration (Maybe Bool)
- dynamicPartitioningConfiguration_retryOptions :: Lens' DynamicPartitioningConfiguration (Maybe RetryOptions)
- data ElasticsearchBufferingHints = ElasticsearchBufferingHints' {}
- newElasticsearchBufferingHints :: ElasticsearchBufferingHints
- elasticsearchBufferingHints_sizeInMBs :: Lens' ElasticsearchBufferingHints (Maybe Natural)
- elasticsearchBufferingHints_intervalInSeconds :: Lens' ElasticsearchBufferingHints (Maybe Natural)
- data ElasticsearchDestinationConfiguration = ElasticsearchDestinationConfiguration' {
- indexRotationPeriod :: Maybe ElasticsearchIndexRotationPeriod
- typeName :: Maybe Text
- s3BackupMode :: Maybe ElasticsearchS3BackupMode
- domainARN :: Maybe Text
- cloudWatchLoggingOptions :: Maybe CloudWatchLoggingOptions
- vpcConfiguration :: Maybe VpcConfiguration
- bufferingHints :: Maybe ElasticsearchBufferingHints
- retryOptions :: Maybe ElasticsearchRetryOptions
- processingConfiguration :: Maybe ProcessingConfiguration
- clusterEndpoint :: Maybe Text
- roleARN :: Text
- indexName :: Text
- s3Configuration :: S3DestinationConfiguration
- newElasticsearchDestinationConfiguration :: Text -> Text -> S3DestinationConfiguration -> ElasticsearchDestinationConfiguration
- elasticsearchDestinationConfiguration_indexRotationPeriod :: Lens' ElasticsearchDestinationConfiguration (Maybe ElasticsearchIndexRotationPeriod)
- elasticsearchDestinationConfiguration_typeName :: Lens' ElasticsearchDestinationConfiguration (Maybe Text)
- elasticsearchDestinationConfiguration_s3BackupMode :: Lens' ElasticsearchDestinationConfiguration (Maybe ElasticsearchS3BackupMode)
- elasticsearchDestinationConfiguration_domainARN :: Lens' ElasticsearchDestinationConfiguration (Maybe Text)
- elasticsearchDestinationConfiguration_cloudWatchLoggingOptions :: Lens' ElasticsearchDestinationConfiguration (Maybe CloudWatchLoggingOptions)
- elasticsearchDestinationConfiguration_vpcConfiguration :: Lens' ElasticsearchDestinationConfiguration (Maybe VpcConfiguration)
- elasticsearchDestinationConfiguration_bufferingHints :: Lens' ElasticsearchDestinationConfiguration (Maybe ElasticsearchBufferingHints)
- elasticsearchDestinationConfiguration_retryOptions :: Lens' ElasticsearchDestinationConfiguration (Maybe ElasticsearchRetryOptions)
- elasticsearchDestinationConfiguration_processingConfiguration :: Lens' ElasticsearchDestinationConfiguration (Maybe ProcessingConfiguration)
- elasticsearchDestinationConfiguration_clusterEndpoint :: Lens' ElasticsearchDestinationConfiguration (Maybe Text)
- elasticsearchDestinationConfiguration_roleARN :: Lens' ElasticsearchDestinationConfiguration Text
- elasticsearchDestinationConfiguration_indexName :: Lens' ElasticsearchDestinationConfiguration Text
- elasticsearchDestinationConfiguration_s3Configuration :: Lens' ElasticsearchDestinationConfiguration S3DestinationConfiguration
- data ElasticsearchDestinationDescription = ElasticsearchDestinationDescription' {
- indexRotationPeriod :: Maybe ElasticsearchIndexRotationPeriod
- typeName :: Maybe Text
- s3BackupMode :: Maybe ElasticsearchS3BackupMode
- domainARN :: Maybe Text
- vpcConfigurationDescription :: Maybe VpcConfigurationDescription
- cloudWatchLoggingOptions :: Maybe CloudWatchLoggingOptions
- s3DestinationDescription :: Maybe S3DestinationDescription
- bufferingHints :: Maybe ElasticsearchBufferingHints
- retryOptions :: Maybe ElasticsearchRetryOptions
- processingConfiguration :: Maybe ProcessingConfiguration
- roleARN :: Maybe Text
- clusterEndpoint :: Maybe Text
- indexName :: Maybe Text
- newElasticsearchDestinationDescription :: ElasticsearchDestinationDescription
- elasticsearchDestinationDescription_indexRotationPeriod :: Lens' ElasticsearchDestinationDescription (Maybe ElasticsearchIndexRotationPeriod)
- elasticsearchDestinationDescription_typeName :: Lens' ElasticsearchDestinationDescription (Maybe Text)
- elasticsearchDestinationDescription_s3BackupMode :: Lens' ElasticsearchDestinationDescription (Maybe ElasticsearchS3BackupMode)
- elasticsearchDestinationDescription_domainARN :: Lens' ElasticsearchDestinationDescription (Maybe Text)
- elasticsearchDestinationDescription_vpcConfigurationDescription :: Lens' ElasticsearchDestinationDescription (Maybe VpcConfigurationDescription)
- elasticsearchDestinationDescription_cloudWatchLoggingOptions :: Lens' ElasticsearchDestinationDescription (Maybe CloudWatchLoggingOptions)
- elasticsearchDestinationDescription_s3DestinationDescription :: Lens' ElasticsearchDestinationDescription (Maybe S3DestinationDescription)
- elasticsearchDestinationDescription_bufferingHints :: Lens' ElasticsearchDestinationDescription (Maybe ElasticsearchBufferingHints)
- elasticsearchDestinationDescription_retryOptions :: Lens' ElasticsearchDestinationDescription (Maybe ElasticsearchRetryOptions)
- elasticsearchDestinationDescription_processingConfiguration :: Lens' ElasticsearchDestinationDescription (Maybe ProcessingConfiguration)
- elasticsearchDestinationDescription_roleARN :: Lens' ElasticsearchDestinationDescription (Maybe Text)
- elasticsearchDestinationDescription_clusterEndpoint :: Lens' ElasticsearchDestinationDescription (Maybe Text)
- elasticsearchDestinationDescription_indexName :: Lens' ElasticsearchDestinationDescription (Maybe Text)
- data ElasticsearchDestinationUpdate = ElasticsearchDestinationUpdate' {
- indexRotationPeriod :: Maybe ElasticsearchIndexRotationPeriod
- typeName :: Maybe Text
- domainARN :: Maybe Text
- cloudWatchLoggingOptions :: Maybe CloudWatchLoggingOptions
- s3Update :: Maybe S3DestinationUpdate
- bufferingHints :: Maybe ElasticsearchBufferingHints
- retryOptions :: Maybe ElasticsearchRetryOptions
- processingConfiguration :: Maybe ProcessingConfiguration
- roleARN :: Maybe Text
- clusterEndpoint :: Maybe Text
- indexName :: Maybe Text
- newElasticsearchDestinationUpdate :: ElasticsearchDestinationUpdate
- elasticsearchDestinationUpdate_indexRotationPeriod :: Lens' ElasticsearchDestinationUpdate (Maybe ElasticsearchIndexRotationPeriod)
- elasticsearchDestinationUpdate_typeName :: Lens' ElasticsearchDestinationUpdate (Maybe Text)
- elasticsearchDestinationUpdate_domainARN :: Lens' ElasticsearchDestinationUpdate (Maybe Text)
- elasticsearchDestinationUpdate_cloudWatchLoggingOptions :: Lens' ElasticsearchDestinationUpdate (Maybe CloudWatchLoggingOptions)
- elasticsearchDestinationUpdate_s3Update :: Lens' ElasticsearchDestinationUpdate (Maybe S3DestinationUpdate)
- elasticsearchDestinationUpdate_bufferingHints :: Lens' ElasticsearchDestinationUpdate (Maybe ElasticsearchBufferingHints)
- elasticsearchDestinationUpdate_retryOptions :: Lens' ElasticsearchDestinationUpdate (Maybe ElasticsearchRetryOptions)
- elasticsearchDestinationUpdate_processingConfiguration :: Lens' ElasticsearchDestinationUpdate (Maybe ProcessingConfiguration)
- elasticsearchDestinationUpdate_roleARN :: Lens' ElasticsearchDestinationUpdate (Maybe Text)
- elasticsearchDestinationUpdate_clusterEndpoint :: Lens' ElasticsearchDestinationUpdate (Maybe Text)
- elasticsearchDestinationUpdate_indexName :: Lens' ElasticsearchDestinationUpdate (Maybe Text)
- data ElasticsearchRetryOptions = ElasticsearchRetryOptions' {}
- newElasticsearchRetryOptions :: ElasticsearchRetryOptions
- elasticsearchRetryOptions_durationInSeconds :: Lens' ElasticsearchRetryOptions (Maybe Natural)
- data EncryptionConfiguration = EncryptionConfiguration' {}
- newEncryptionConfiguration :: EncryptionConfiguration
- encryptionConfiguration_noEncryptionConfig :: Lens' EncryptionConfiguration (Maybe NoEncryptionConfig)
- encryptionConfiguration_kmsEncryptionConfig :: Lens' EncryptionConfiguration (Maybe KMSEncryptionConfig)
- data ExtendedS3DestinationConfiguration = ExtendedS3DestinationConfiguration' {
- s3BackupMode :: Maybe S3BackupMode
- prefix :: Maybe Text
- cloudWatchLoggingOptions :: Maybe CloudWatchLoggingOptions
- s3BackupConfiguration :: Maybe S3DestinationConfiguration
- errorOutputPrefix :: Maybe Text
- encryptionConfiguration :: Maybe EncryptionConfiguration
- dynamicPartitioningConfiguration :: Maybe DynamicPartitioningConfiguration
- compressionFormat :: Maybe CompressionFormat
- bufferingHints :: Maybe BufferingHints
- dataFormatConversionConfiguration :: Maybe DataFormatConversionConfiguration
- processingConfiguration :: Maybe ProcessingConfiguration
- roleARN :: Text
- bucketARN :: Text
- newExtendedS3DestinationConfiguration :: Text -> Text -> ExtendedS3DestinationConfiguration
- extendedS3DestinationConfiguration_s3BackupMode :: Lens' ExtendedS3DestinationConfiguration (Maybe S3BackupMode)
- extendedS3DestinationConfiguration_prefix :: Lens' ExtendedS3DestinationConfiguration (Maybe Text)
- extendedS3DestinationConfiguration_cloudWatchLoggingOptions :: Lens' ExtendedS3DestinationConfiguration (Maybe CloudWatchLoggingOptions)
- extendedS3DestinationConfiguration_s3BackupConfiguration :: Lens' ExtendedS3DestinationConfiguration (Maybe S3DestinationConfiguration)
- extendedS3DestinationConfiguration_errorOutputPrefix :: Lens' ExtendedS3DestinationConfiguration (Maybe Text)
- extendedS3DestinationConfiguration_encryptionConfiguration :: Lens' ExtendedS3DestinationConfiguration (Maybe EncryptionConfiguration)
- extendedS3DestinationConfiguration_dynamicPartitioningConfiguration :: Lens' ExtendedS3DestinationConfiguration (Maybe DynamicPartitioningConfiguration)
- extendedS3DestinationConfiguration_compressionFormat :: Lens' ExtendedS3DestinationConfiguration (Maybe CompressionFormat)
- extendedS3DestinationConfiguration_bufferingHints :: Lens' ExtendedS3DestinationConfiguration (Maybe BufferingHints)
- extendedS3DestinationConfiguration_dataFormatConversionConfiguration :: Lens' ExtendedS3DestinationConfiguration (Maybe DataFormatConversionConfiguration)
- extendedS3DestinationConfiguration_processingConfiguration :: Lens' ExtendedS3DestinationConfiguration (Maybe ProcessingConfiguration)
- extendedS3DestinationConfiguration_roleARN :: Lens' ExtendedS3DestinationConfiguration Text
- extendedS3DestinationConfiguration_bucketARN :: Lens' ExtendedS3DestinationConfiguration Text
- data ExtendedS3DestinationDescription = ExtendedS3DestinationDescription' {
- s3BackupMode :: Maybe S3BackupMode
- s3BackupDescription :: Maybe S3DestinationDescription
- prefix :: Maybe Text
- cloudWatchLoggingOptions :: Maybe CloudWatchLoggingOptions
- errorOutputPrefix :: Maybe Text
- dynamicPartitioningConfiguration :: Maybe DynamicPartitioningConfiguration
- dataFormatConversionConfiguration :: Maybe DataFormatConversionConfiguration
- processingConfiguration :: Maybe ProcessingConfiguration
- roleARN :: Text
- bucketARN :: Text
- bufferingHints :: BufferingHints
- compressionFormat :: CompressionFormat
- encryptionConfiguration :: EncryptionConfiguration
- newExtendedS3DestinationDescription :: Text -> Text -> BufferingHints -> CompressionFormat -> EncryptionConfiguration -> ExtendedS3DestinationDescription
- extendedS3DestinationDescription_s3BackupMode :: Lens' ExtendedS3DestinationDescription (Maybe S3BackupMode)
- extendedS3DestinationDescription_s3BackupDescription :: Lens' ExtendedS3DestinationDescription (Maybe S3DestinationDescription)
- extendedS3DestinationDescription_prefix :: Lens' ExtendedS3DestinationDescription (Maybe Text)
- extendedS3DestinationDescription_cloudWatchLoggingOptions :: Lens' ExtendedS3DestinationDescription (Maybe CloudWatchLoggingOptions)
- extendedS3DestinationDescription_errorOutputPrefix :: Lens' ExtendedS3DestinationDescription (Maybe Text)
- extendedS3DestinationDescription_dynamicPartitioningConfiguration :: Lens' ExtendedS3DestinationDescription (Maybe DynamicPartitioningConfiguration)
- extendedS3DestinationDescription_dataFormatConversionConfiguration :: Lens' ExtendedS3DestinationDescription (Maybe DataFormatConversionConfiguration)
- extendedS3DestinationDescription_processingConfiguration :: Lens' ExtendedS3DestinationDescription (Maybe ProcessingConfiguration)
- extendedS3DestinationDescription_roleARN :: Lens' ExtendedS3DestinationDescription Text
- extendedS3DestinationDescription_bucketARN :: Lens' ExtendedS3DestinationDescription Text
- extendedS3DestinationDescription_bufferingHints :: Lens' ExtendedS3DestinationDescription BufferingHints
- extendedS3DestinationDescription_compressionFormat :: Lens' ExtendedS3DestinationDescription CompressionFormat
- extendedS3DestinationDescription_encryptionConfiguration :: Lens' ExtendedS3DestinationDescription EncryptionConfiguration
- data ExtendedS3DestinationUpdate = ExtendedS3DestinationUpdate' {
- s3BackupMode :: Maybe S3BackupMode
- prefix :: Maybe Text
- cloudWatchLoggingOptions :: Maybe CloudWatchLoggingOptions
- errorOutputPrefix :: Maybe Text
- s3BackupUpdate :: Maybe S3DestinationUpdate
- encryptionConfiguration :: Maybe EncryptionConfiguration
- dynamicPartitioningConfiguration :: Maybe DynamicPartitioningConfiguration
- compressionFormat :: Maybe CompressionFormat
- bufferingHints :: Maybe BufferingHints
- dataFormatConversionConfiguration :: Maybe DataFormatConversionConfiguration
- bucketARN :: Maybe Text
- processingConfiguration :: Maybe ProcessingConfiguration
- roleARN :: Maybe Text
- newExtendedS3DestinationUpdate :: ExtendedS3DestinationUpdate
- extendedS3DestinationUpdate_s3BackupMode :: Lens' ExtendedS3DestinationUpdate (Maybe S3BackupMode)
- extendedS3DestinationUpdate_prefix :: Lens' ExtendedS3DestinationUpdate (Maybe Text)
- extendedS3DestinationUpdate_cloudWatchLoggingOptions :: Lens' ExtendedS3DestinationUpdate (Maybe CloudWatchLoggingOptions)
- extendedS3DestinationUpdate_errorOutputPrefix :: Lens' ExtendedS3DestinationUpdate (Maybe Text)
- extendedS3DestinationUpdate_s3BackupUpdate :: Lens' ExtendedS3DestinationUpdate (Maybe S3DestinationUpdate)
- extendedS3DestinationUpdate_encryptionConfiguration :: Lens' ExtendedS3DestinationUpdate (Maybe EncryptionConfiguration)
- extendedS3DestinationUpdate_dynamicPartitioningConfiguration :: Lens' ExtendedS3DestinationUpdate (Maybe DynamicPartitioningConfiguration)
- extendedS3DestinationUpdate_compressionFormat :: Lens' ExtendedS3DestinationUpdate (Maybe CompressionFormat)
- extendedS3DestinationUpdate_bufferingHints :: Lens' ExtendedS3DestinationUpdate (Maybe BufferingHints)
- extendedS3DestinationUpdate_dataFormatConversionConfiguration :: Lens' ExtendedS3DestinationUpdate (Maybe DataFormatConversionConfiguration)
- extendedS3DestinationUpdate_bucketARN :: Lens' ExtendedS3DestinationUpdate (Maybe Text)
- extendedS3DestinationUpdate_processingConfiguration :: Lens' ExtendedS3DestinationUpdate (Maybe ProcessingConfiguration)
- extendedS3DestinationUpdate_roleARN :: Lens' ExtendedS3DestinationUpdate (Maybe Text)
- data FailureDescription = FailureDescription' {}
- newFailureDescription :: DeliveryStreamFailureType -> Text -> FailureDescription
- failureDescription_type :: Lens' FailureDescription DeliveryStreamFailureType
- failureDescription_details :: Lens' FailureDescription Text
- data HiveJsonSerDe = HiveJsonSerDe' {
- timestampFormats :: Maybe [Text]
- newHiveJsonSerDe :: HiveJsonSerDe
- hiveJsonSerDe_timestampFormats :: Lens' HiveJsonSerDe (Maybe [Text])
- data HttpEndpointBufferingHints = HttpEndpointBufferingHints' {}
- newHttpEndpointBufferingHints :: HttpEndpointBufferingHints
- httpEndpointBufferingHints_sizeInMBs :: Lens' HttpEndpointBufferingHints (Maybe Natural)
- httpEndpointBufferingHints_intervalInSeconds :: Lens' HttpEndpointBufferingHints (Maybe Natural)
- data HttpEndpointCommonAttribute = HttpEndpointCommonAttribute' {}
- newHttpEndpointCommonAttribute :: Text -> Text -> HttpEndpointCommonAttribute
- httpEndpointCommonAttribute_attributeName :: Lens' HttpEndpointCommonAttribute Text
- httpEndpointCommonAttribute_attributeValue :: Lens' HttpEndpointCommonAttribute Text
- data HttpEndpointConfiguration = HttpEndpointConfiguration' {}
- newHttpEndpointConfiguration :: Text -> HttpEndpointConfiguration
- httpEndpointConfiguration_name :: Lens' HttpEndpointConfiguration (Maybe Text)
- httpEndpointConfiguration_accessKey :: Lens' HttpEndpointConfiguration (Maybe Text)
- httpEndpointConfiguration_url :: Lens' HttpEndpointConfiguration Text
- data HttpEndpointDescription = HttpEndpointDescription' {}
- newHttpEndpointDescription :: HttpEndpointDescription
- httpEndpointDescription_url :: Lens' HttpEndpointDescription (Maybe Text)
- httpEndpointDescription_name :: Lens' HttpEndpointDescription (Maybe Text)
- data HttpEndpointDestinationConfiguration = HttpEndpointDestinationConfiguration' {
- s3BackupMode :: Maybe HttpEndpointS3BackupMode
- cloudWatchLoggingOptions :: Maybe CloudWatchLoggingOptions
- bufferingHints :: Maybe HttpEndpointBufferingHints
- retryOptions :: Maybe HttpEndpointRetryOptions
- processingConfiguration :: Maybe ProcessingConfiguration
- requestConfiguration :: Maybe HttpEndpointRequestConfiguration
- roleARN :: Maybe Text
- endpointConfiguration :: HttpEndpointConfiguration
- s3Configuration :: S3DestinationConfiguration
- newHttpEndpointDestinationConfiguration :: HttpEndpointConfiguration -> S3DestinationConfiguration -> HttpEndpointDestinationConfiguration
- httpEndpointDestinationConfiguration_s3BackupMode :: Lens' HttpEndpointDestinationConfiguration (Maybe HttpEndpointS3BackupMode)
- httpEndpointDestinationConfiguration_cloudWatchLoggingOptions :: Lens' HttpEndpointDestinationConfiguration (Maybe CloudWatchLoggingOptions)
- httpEndpointDestinationConfiguration_bufferingHints :: Lens' HttpEndpointDestinationConfiguration (Maybe HttpEndpointBufferingHints)
- httpEndpointDestinationConfiguration_retryOptions :: Lens' HttpEndpointDestinationConfiguration (Maybe HttpEndpointRetryOptions)
- httpEndpointDestinationConfiguration_processingConfiguration :: Lens' HttpEndpointDestinationConfiguration (Maybe ProcessingConfiguration)
- httpEndpointDestinationConfiguration_requestConfiguration :: Lens' HttpEndpointDestinationConfiguration (Maybe HttpEndpointRequestConfiguration)
- httpEndpointDestinationConfiguration_roleARN :: Lens' HttpEndpointDestinationConfiguration (Maybe Text)
- httpEndpointDestinationConfiguration_endpointConfiguration :: Lens' HttpEndpointDestinationConfiguration HttpEndpointConfiguration
- httpEndpointDestinationConfiguration_s3Configuration :: Lens' HttpEndpointDestinationConfiguration S3DestinationConfiguration
- data HttpEndpointDestinationDescription = HttpEndpointDestinationDescription' {
- s3BackupMode :: Maybe HttpEndpointS3BackupMode
- cloudWatchLoggingOptions :: Maybe CloudWatchLoggingOptions
- s3DestinationDescription :: Maybe S3DestinationDescription
- bufferingHints :: Maybe HttpEndpointBufferingHints
- retryOptions :: Maybe HttpEndpointRetryOptions
- endpointConfiguration :: Maybe HttpEndpointDescription
- processingConfiguration :: Maybe ProcessingConfiguration
- requestConfiguration :: Maybe HttpEndpointRequestConfiguration
- roleARN :: Maybe Text
- newHttpEndpointDestinationDescription :: HttpEndpointDestinationDescription
- httpEndpointDestinationDescription_s3BackupMode :: Lens' HttpEndpointDestinationDescription (Maybe HttpEndpointS3BackupMode)
- httpEndpointDestinationDescription_cloudWatchLoggingOptions :: Lens' HttpEndpointDestinationDescription (Maybe CloudWatchLoggingOptions)
- httpEndpointDestinationDescription_s3DestinationDescription :: Lens' HttpEndpointDestinationDescription (Maybe S3DestinationDescription)
- httpEndpointDestinationDescription_bufferingHints :: Lens' HttpEndpointDestinationDescription (Maybe HttpEndpointBufferingHints)
- httpEndpointDestinationDescription_retryOptions :: Lens' HttpEndpointDestinationDescription (Maybe HttpEndpointRetryOptions)
- httpEndpointDestinationDescription_endpointConfiguration :: Lens' HttpEndpointDestinationDescription (Maybe HttpEndpointDescription)
- httpEndpointDestinationDescription_processingConfiguration :: Lens' HttpEndpointDestinationDescription (Maybe ProcessingConfiguration)
- httpEndpointDestinationDescription_requestConfiguration :: Lens' HttpEndpointDestinationDescription (Maybe HttpEndpointRequestConfiguration)
- httpEndpointDestinationDescription_roleARN :: Lens' HttpEndpointDestinationDescription (Maybe Text)
- data HttpEndpointDestinationUpdate = HttpEndpointDestinationUpdate' {
- s3BackupMode :: Maybe HttpEndpointS3BackupMode
- cloudWatchLoggingOptions :: Maybe CloudWatchLoggingOptions
- s3Update :: Maybe S3DestinationUpdate
- bufferingHints :: Maybe HttpEndpointBufferingHints
- retryOptions :: Maybe HttpEndpointRetryOptions
- endpointConfiguration :: Maybe HttpEndpointConfiguration
- processingConfiguration :: Maybe ProcessingConfiguration
- requestConfiguration :: Maybe HttpEndpointRequestConfiguration
- roleARN :: Maybe Text
- newHttpEndpointDestinationUpdate :: HttpEndpointDestinationUpdate
- httpEndpointDestinationUpdate_s3BackupMode :: Lens' HttpEndpointDestinationUpdate (Maybe HttpEndpointS3BackupMode)
- httpEndpointDestinationUpdate_cloudWatchLoggingOptions :: Lens' HttpEndpointDestinationUpdate (Maybe CloudWatchLoggingOptions)
- httpEndpointDestinationUpdate_s3Update :: Lens' HttpEndpointDestinationUpdate (Maybe S3DestinationUpdate)
- httpEndpointDestinationUpdate_bufferingHints :: Lens' HttpEndpointDestinationUpdate (Maybe HttpEndpointBufferingHints)
- httpEndpointDestinationUpdate_retryOptions :: Lens' HttpEndpointDestinationUpdate (Maybe HttpEndpointRetryOptions)
- httpEndpointDestinationUpdate_endpointConfiguration :: Lens' HttpEndpointDestinationUpdate (Maybe HttpEndpointConfiguration)
- httpEndpointDestinationUpdate_processingConfiguration :: Lens' HttpEndpointDestinationUpdate (Maybe ProcessingConfiguration)
- httpEndpointDestinationUpdate_requestConfiguration :: Lens' HttpEndpointDestinationUpdate (Maybe HttpEndpointRequestConfiguration)
- httpEndpointDestinationUpdate_roleARN :: Lens' HttpEndpointDestinationUpdate (Maybe Text)
- data HttpEndpointRequestConfiguration = HttpEndpointRequestConfiguration' {}
- newHttpEndpointRequestConfiguration :: HttpEndpointRequestConfiguration
- httpEndpointRequestConfiguration_commonAttributes :: Lens' HttpEndpointRequestConfiguration (Maybe [HttpEndpointCommonAttribute])
- httpEndpointRequestConfiguration_contentEncoding :: Lens' HttpEndpointRequestConfiguration (Maybe ContentEncoding)
- data HttpEndpointRetryOptions = HttpEndpointRetryOptions' {}
- newHttpEndpointRetryOptions :: HttpEndpointRetryOptions
- httpEndpointRetryOptions_durationInSeconds :: Lens' HttpEndpointRetryOptions (Maybe Natural)
- data InputFormatConfiguration = InputFormatConfiguration' {}
- newInputFormatConfiguration :: InputFormatConfiguration
- inputFormatConfiguration_deserializer :: Lens' InputFormatConfiguration (Maybe Deserializer)
- data KMSEncryptionConfig = KMSEncryptionConfig' {
- aWSKMSKeyARN :: Text
- newKMSEncryptionConfig :: Text -> KMSEncryptionConfig
- kmsEncryptionConfig_aWSKMSKeyARN :: Lens' KMSEncryptionConfig Text
- data KinesisStreamSourceConfiguration = KinesisStreamSourceConfiguration' {
- kinesisStreamARN :: Text
- roleARN :: Text
- newKinesisStreamSourceConfiguration :: Text -> Text -> KinesisStreamSourceConfiguration
- kinesisStreamSourceConfiguration_kinesisStreamARN :: Lens' KinesisStreamSourceConfiguration Text
- kinesisStreamSourceConfiguration_roleARN :: Lens' KinesisStreamSourceConfiguration Text
- data KinesisStreamSourceDescription = KinesisStreamSourceDescription' {}
- newKinesisStreamSourceDescription :: KinesisStreamSourceDescription
- kinesisStreamSourceDescription_deliveryStartTimestamp :: Lens' KinesisStreamSourceDescription (Maybe UTCTime)
- kinesisStreamSourceDescription_kinesisStreamARN :: Lens' KinesisStreamSourceDescription (Maybe Text)
- kinesisStreamSourceDescription_roleARN :: Lens' KinesisStreamSourceDescription (Maybe Text)
- data OpenXJsonSerDe = OpenXJsonSerDe' {}
- newOpenXJsonSerDe :: OpenXJsonSerDe
- openXJsonSerDe_columnToJsonKeyMappings :: Lens' OpenXJsonSerDe (Maybe (HashMap Text Text))
- openXJsonSerDe_caseInsensitive :: Lens' OpenXJsonSerDe (Maybe Bool)
- openXJsonSerDe_convertDotsInJsonKeysToUnderscores :: Lens' OpenXJsonSerDe (Maybe Bool)
- data OrcSerDe = OrcSerDe' {
- bloomFilterFalsePositiveProbability :: Maybe Double
- dictionaryKeyThreshold :: Maybe Double
- enablePadding :: Maybe Bool
- compression :: Maybe OrcCompression
- bloomFilterColumns :: Maybe [Text]
- rowIndexStride :: Maybe Natural
- formatVersion :: Maybe OrcFormatVersion
- blockSizeBytes :: Maybe Natural
- stripeSizeBytes :: Maybe Natural
- paddingTolerance :: Maybe Double
- newOrcSerDe :: OrcSerDe
- orcSerDe_bloomFilterFalsePositiveProbability :: Lens' OrcSerDe (Maybe Double)
- orcSerDe_dictionaryKeyThreshold :: Lens' OrcSerDe (Maybe Double)
- orcSerDe_enablePadding :: Lens' OrcSerDe (Maybe Bool)
- orcSerDe_compression :: Lens' OrcSerDe (Maybe OrcCompression)
- orcSerDe_bloomFilterColumns :: Lens' OrcSerDe (Maybe [Text])
- orcSerDe_rowIndexStride :: Lens' OrcSerDe (Maybe Natural)
- orcSerDe_formatVersion :: Lens' OrcSerDe (Maybe OrcFormatVersion)
- orcSerDe_blockSizeBytes :: Lens' OrcSerDe (Maybe Natural)
- orcSerDe_stripeSizeBytes :: Lens' OrcSerDe (Maybe Natural)
- orcSerDe_paddingTolerance :: Lens' OrcSerDe (Maybe Double)
- data OutputFormatConfiguration = OutputFormatConfiguration' {}
- newOutputFormatConfiguration :: OutputFormatConfiguration
- outputFormatConfiguration_serializer :: Lens' OutputFormatConfiguration (Maybe Serializer)
- data ParquetSerDe = ParquetSerDe' {}
- newParquetSerDe :: ParquetSerDe
- parquetSerDe_writerVersion :: Lens' ParquetSerDe (Maybe ParquetWriterVersion)
- parquetSerDe_compression :: Lens' ParquetSerDe (Maybe ParquetCompression)
- parquetSerDe_maxPaddingBytes :: Lens' ParquetSerDe (Maybe Natural)
- parquetSerDe_enableDictionaryCompression :: Lens' ParquetSerDe (Maybe Bool)
- parquetSerDe_pageSizeBytes :: Lens' ParquetSerDe (Maybe Natural)
- parquetSerDe_blockSizeBytes :: Lens' ParquetSerDe (Maybe Natural)
- data ProcessingConfiguration = ProcessingConfiguration' {}
- newProcessingConfiguration :: ProcessingConfiguration
- processingConfiguration_enabled :: Lens' ProcessingConfiguration (Maybe Bool)
- processingConfiguration_processors :: Lens' ProcessingConfiguration (Maybe [Processor])
- data Processor = Processor' {}
- newProcessor :: ProcessorType -> Processor
- processor_parameters :: Lens' Processor (Maybe [ProcessorParameter])
- processor_type :: Lens' Processor ProcessorType
- data ProcessorParameter = ProcessorParameter' {}
- newProcessorParameter :: ProcessorParameterName -> Text -> ProcessorParameter
- processorParameter_parameterName :: Lens' ProcessorParameter ProcessorParameterName
- processorParameter_parameterValue :: Lens' ProcessorParameter Text
- data PutRecordBatchResponseEntry = PutRecordBatchResponseEntry' {}
- newPutRecordBatchResponseEntry :: PutRecordBatchResponseEntry
- putRecordBatchResponseEntry_recordId :: Lens' PutRecordBatchResponseEntry (Maybe Text)
- putRecordBatchResponseEntry_errorCode :: Lens' PutRecordBatchResponseEntry (Maybe Text)
- putRecordBatchResponseEntry_errorMessage :: Lens' PutRecordBatchResponseEntry (Maybe Text)
- data Record = Record' {}
- newRecord :: ByteString -> Record
- record_data :: Lens' Record ByteString
- data RedshiftDestinationConfiguration = RedshiftDestinationConfiguration' {
- s3BackupMode :: Maybe RedshiftS3BackupMode
- cloudWatchLoggingOptions :: Maybe CloudWatchLoggingOptions
- s3BackupConfiguration :: Maybe S3DestinationConfiguration
- retryOptions :: Maybe RedshiftRetryOptions
- processingConfiguration :: Maybe ProcessingConfiguration
- roleARN :: Text
- clusterJDBCURL :: Text
- copyCommand :: CopyCommand
- username :: Sensitive Text
- password :: Sensitive Text
- s3Configuration :: S3DestinationConfiguration
- newRedshiftDestinationConfiguration :: Text -> Text -> CopyCommand -> Text -> Text -> S3DestinationConfiguration -> RedshiftDestinationConfiguration
- redshiftDestinationConfiguration_s3BackupMode :: Lens' RedshiftDestinationConfiguration (Maybe RedshiftS3BackupMode)
- redshiftDestinationConfiguration_cloudWatchLoggingOptions :: Lens' RedshiftDestinationConfiguration (Maybe CloudWatchLoggingOptions)
- redshiftDestinationConfiguration_s3BackupConfiguration :: Lens' RedshiftDestinationConfiguration (Maybe S3DestinationConfiguration)
- redshiftDestinationConfiguration_retryOptions :: Lens' RedshiftDestinationConfiguration (Maybe RedshiftRetryOptions)
- redshiftDestinationConfiguration_processingConfiguration :: Lens' RedshiftDestinationConfiguration (Maybe ProcessingConfiguration)
- redshiftDestinationConfiguration_roleARN :: Lens' RedshiftDestinationConfiguration Text
- redshiftDestinationConfiguration_clusterJDBCURL :: Lens' RedshiftDestinationConfiguration Text
- redshiftDestinationConfiguration_copyCommand :: Lens' RedshiftDestinationConfiguration CopyCommand
- redshiftDestinationConfiguration_username :: Lens' RedshiftDestinationConfiguration Text
- redshiftDestinationConfiguration_password :: Lens' RedshiftDestinationConfiguration Text
- redshiftDestinationConfiguration_s3Configuration :: Lens' RedshiftDestinationConfiguration S3DestinationConfiguration
- data RedshiftDestinationDescription = RedshiftDestinationDescription' {
- s3BackupMode :: Maybe RedshiftS3BackupMode
- s3BackupDescription :: Maybe S3DestinationDescription
- cloudWatchLoggingOptions :: Maybe CloudWatchLoggingOptions
- retryOptions :: Maybe RedshiftRetryOptions
- processingConfiguration :: Maybe ProcessingConfiguration
- roleARN :: Text
- clusterJDBCURL :: Text
- copyCommand :: CopyCommand
- username :: Sensitive Text
- s3DestinationDescription :: S3DestinationDescription
- newRedshiftDestinationDescription :: Text -> Text -> CopyCommand -> Text -> S3DestinationDescription -> RedshiftDestinationDescription
- redshiftDestinationDescription_s3BackupMode :: Lens' RedshiftDestinationDescription (Maybe RedshiftS3BackupMode)
- redshiftDestinationDescription_s3BackupDescription :: Lens' RedshiftDestinationDescription (Maybe S3DestinationDescription)
- redshiftDestinationDescription_cloudWatchLoggingOptions :: Lens' RedshiftDestinationDescription (Maybe CloudWatchLoggingOptions)
- redshiftDestinationDescription_retryOptions :: Lens' RedshiftDestinationDescription (Maybe RedshiftRetryOptions)
- redshiftDestinationDescription_processingConfiguration :: Lens' RedshiftDestinationDescription (Maybe ProcessingConfiguration)
- redshiftDestinationDescription_roleARN :: Lens' RedshiftDestinationDescription Text
- redshiftDestinationDescription_clusterJDBCURL :: Lens' RedshiftDestinationDescription Text
- redshiftDestinationDescription_copyCommand :: Lens' RedshiftDestinationDescription CopyCommand
- redshiftDestinationDescription_username :: Lens' RedshiftDestinationDescription Text
- redshiftDestinationDescription_s3DestinationDescription :: Lens' RedshiftDestinationDescription S3DestinationDescription
- data RedshiftDestinationUpdate = RedshiftDestinationUpdate' {
- s3BackupMode :: Maybe RedshiftS3BackupMode
- cloudWatchLoggingOptions :: Maybe CloudWatchLoggingOptions
- username :: Maybe (Sensitive Text)
- s3Update :: Maybe S3DestinationUpdate
- password :: Maybe (Sensitive Text)
- s3BackupUpdate :: Maybe S3DestinationUpdate
- copyCommand :: Maybe CopyCommand
- retryOptions :: Maybe RedshiftRetryOptions
- processingConfiguration :: Maybe ProcessingConfiguration
- clusterJDBCURL :: Maybe Text
- roleARN :: Maybe Text
- newRedshiftDestinationUpdate :: RedshiftDestinationUpdate
- redshiftDestinationUpdate_s3BackupMode :: Lens' RedshiftDestinationUpdate (Maybe RedshiftS3BackupMode)
- redshiftDestinationUpdate_cloudWatchLoggingOptions :: Lens' RedshiftDestinationUpdate (Maybe CloudWatchLoggingOptions)
- redshiftDestinationUpdate_username :: Lens' RedshiftDestinationUpdate (Maybe Text)
- redshiftDestinationUpdate_s3Update :: Lens' RedshiftDestinationUpdate (Maybe S3DestinationUpdate)
- redshiftDestinationUpdate_password :: Lens' RedshiftDestinationUpdate (Maybe Text)
- redshiftDestinationUpdate_s3BackupUpdate :: Lens' RedshiftDestinationUpdate (Maybe S3DestinationUpdate)
- redshiftDestinationUpdate_copyCommand :: Lens' RedshiftDestinationUpdate (Maybe CopyCommand)
- redshiftDestinationUpdate_retryOptions :: Lens' RedshiftDestinationUpdate (Maybe RedshiftRetryOptions)
- redshiftDestinationUpdate_processingConfiguration :: Lens' RedshiftDestinationUpdate (Maybe ProcessingConfiguration)
- redshiftDestinationUpdate_clusterJDBCURL :: Lens' RedshiftDestinationUpdate (Maybe Text)
- redshiftDestinationUpdate_roleARN :: Lens' RedshiftDestinationUpdate (Maybe Text)
- data RedshiftRetryOptions = RedshiftRetryOptions' {}
- newRedshiftRetryOptions :: RedshiftRetryOptions
- redshiftRetryOptions_durationInSeconds :: Lens' RedshiftRetryOptions (Maybe Natural)
- data RetryOptions = RetryOptions' {}
- newRetryOptions :: RetryOptions
- retryOptions_durationInSeconds :: Lens' RetryOptions (Maybe Natural)
- data S3DestinationConfiguration = S3DestinationConfiguration' {}
- newS3DestinationConfiguration :: Text -> Text -> S3DestinationConfiguration
- s3DestinationConfiguration_prefix :: Lens' S3DestinationConfiguration (Maybe Text)
- s3DestinationConfiguration_cloudWatchLoggingOptions :: Lens' S3DestinationConfiguration (Maybe CloudWatchLoggingOptions)
- s3DestinationConfiguration_errorOutputPrefix :: Lens' S3DestinationConfiguration (Maybe Text)
- s3DestinationConfiguration_encryptionConfiguration :: Lens' S3DestinationConfiguration (Maybe EncryptionConfiguration)
- s3DestinationConfiguration_compressionFormat :: Lens' S3DestinationConfiguration (Maybe CompressionFormat)
- s3DestinationConfiguration_bufferingHints :: Lens' S3DestinationConfiguration (Maybe BufferingHints)
- s3DestinationConfiguration_roleARN :: Lens' S3DestinationConfiguration Text
- s3DestinationConfiguration_bucketARN :: Lens' S3DestinationConfiguration Text
- data S3DestinationDescription = S3DestinationDescription' {}
- newS3DestinationDescription :: Text -> Text -> BufferingHints -> CompressionFormat -> EncryptionConfiguration -> S3DestinationDescription
- s3DestinationDescription_prefix :: Lens' S3DestinationDescription (Maybe Text)
- s3DestinationDescription_cloudWatchLoggingOptions :: Lens' S3DestinationDescription (Maybe CloudWatchLoggingOptions)
- s3DestinationDescription_errorOutputPrefix :: Lens' S3DestinationDescription (Maybe Text)
- s3DestinationDescription_roleARN :: Lens' S3DestinationDescription Text
- s3DestinationDescription_bucketARN :: Lens' S3DestinationDescription Text
- s3DestinationDescription_bufferingHints :: Lens' S3DestinationDescription BufferingHints
- s3DestinationDescription_compressionFormat :: Lens' S3DestinationDescription CompressionFormat
- s3DestinationDescription_encryptionConfiguration :: Lens' S3DestinationDescription EncryptionConfiguration
- data S3DestinationUpdate = S3DestinationUpdate' {}
- newS3DestinationUpdate :: S3DestinationUpdate
- s3DestinationUpdate_prefix :: Lens' S3DestinationUpdate (Maybe Text)
- s3DestinationUpdate_cloudWatchLoggingOptions :: Lens' S3DestinationUpdate (Maybe CloudWatchLoggingOptions)
- s3DestinationUpdate_errorOutputPrefix :: Lens' S3DestinationUpdate (Maybe Text)
- s3DestinationUpdate_encryptionConfiguration :: Lens' S3DestinationUpdate (Maybe EncryptionConfiguration)
- s3DestinationUpdate_compressionFormat :: Lens' S3DestinationUpdate (Maybe CompressionFormat)
- s3DestinationUpdate_bufferingHints :: Lens' S3DestinationUpdate (Maybe BufferingHints)
- s3DestinationUpdate_bucketARN :: Lens' S3DestinationUpdate (Maybe Text)
- s3DestinationUpdate_roleARN :: Lens' S3DestinationUpdate (Maybe Text)
- data SchemaConfiguration = SchemaConfiguration' {}
- newSchemaConfiguration :: SchemaConfiguration
- schemaConfiguration_versionId :: Lens' SchemaConfiguration (Maybe Text)
- schemaConfiguration_catalogId :: Lens' SchemaConfiguration (Maybe Text)
- schemaConfiguration_databaseName :: Lens' SchemaConfiguration (Maybe Text)
- schemaConfiguration_region :: Lens' SchemaConfiguration (Maybe Text)
- schemaConfiguration_tableName :: Lens' SchemaConfiguration (Maybe Text)
- schemaConfiguration_roleARN :: Lens' SchemaConfiguration (Maybe Text)
- data Serializer = Serializer' {}
- newSerializer :: Serializer
- serializer_orcSerDe :: Lens' Serializer (Maybe OrcSerDe)
- serializer_parquetSerDe :: Lens' Serializer (Maybe ParquetSerDe)
- data SourceDescription = SourceDescription' {}
- newSourceDescription :: SourceDescription
- sourceDescription_kinesisStreamSourceDescription :: Lens' SourceDescription (Maybe KinesisStreamSourceDescription)
- data SplunkDestinationConfiguration = SplunkDestinationConfiguration' {
- s3BackupMode :: Maybe SplunkS3BackupMode
- cloudWatchLoggingOptions :: Maybe CloudWatchLoggingOptions
- hECAcknowledgmentTimeoutInSeconds :: Maybe Natural
- retryOptions :: Maybe SplunkRetryOptions
- processingConfiguration :: Maybe ProcessingConfiguration
- hECEndpoint :: Text
- hECEndpointType :: HECEndpointType
- hECToken :: Text
- s3Configuration :: S3DestinationConfiguration
- newSplunkDestinationConfiguration :: Text -> HECEndpointType -> Text -> S3DestinationConfiguration -> SplunkDestinationConfiguration
- splunkDestinationConfiguration_s3BackupMode :: Lens' SplunkDestinationConfiguration (Maybe SplunkS3BackupMode)
- splunkDestinationConfiguration_cloudWatchLoggingOptions :: Lens' SplunkDestinationConfiguration (Maybe CloudWatchLoggingOptions)
- splunkDestinationConfiguration_hECAcknowledgmentTimeoutInSeconds :: Lens' SplunkDestinationConfiguration (Maybe Natural)
- splunkDestinationConfiguration_retryOptions :: Lens' SplunkDestinationConfiguration (Maybe SplunkRetryOptions)
- splunkDestinationConfiguration_processingConfiguration :: Lens' SplunkDestinationConfiguration (Maybe ProcessingConfiguration)
- splunkDestinationConfiguration_hECEndpoint :: Lens' SplunkDestinationConfiguration Text
- splunkDestinationConfiguration_hECEndpointType :: Lens' SplunkDestinationConfiguration HECEndpointType
- splunkDestinationConfiguration_hECToken :: Lens' SplunkDestinationConfiguration Text
- splunkDestinationConfiguration_s3Configuration :: Lens' SplunkDestinationConfiguration S3DestinationConfiguration
- data SplunkDestinationDescription = SplunkDestinationDescription' {
- s3BackupMode :: Maybe SplunkS3BackupMode
- hECToken :: Maybe Text
- hECEndpointType :: Maybe HECEndpointType
- cloudWatchLoggingOptions :: Maybe CloudWatchLoggingOptions
- hECAcknowledgmentTimeoutInSeconds :: Maybe Natural
- s3DestinationDescription :: Maybe S3DestinationDescription
- hECEndpoint :: Maybe Text
- retryOptions :: Maybe SplunkRetryOptions
- processingConfiguration :: Maybe ProcessingConfiguration
- newSplunkDestinationDescription :: SplunkDestinationDescription
- splunkDestinationDescription_s3BackupMode :: Lens' SplunkDestinationDescription (Maybe SplunkS3BackupMode)
- splunkDestinationDescription_hECToken :: Lens' SplunkDestinationDescription (Maybe Text)
- splunkDestinationDescription_hECEndpointType :: Lens' SplunkDestinationDescription (Maybe HECEndpointType)
- splunkDestinationDescription_cloudWatchLoggingOptions :: Lens' SplunkDestinationDescription (Maybe CloudWatchLoggingOptions)
- splunkDestinationDescription_hECAcknowledgmentTimeoutInSeconds :: Lens' SplunkDestinationDescription (Maybe Natural)
- splunkDestinationDescription_s3DestinationDescription :: Lens' SplunkDestinationDescription (Maybe S3DestinationDescription)
- splunkDestinationDescription_hECEndpoint :: Lens' SplunkDestinationDescription (Maybe Text)
- splunkDestinationDescription_retryOptions :: Lens' SplunkDestinationDescription (Maybe SplunkRetryOptions)
- splunkDestinationDescription_processingConfiguration :: Lens' SplunkDestinationDescription (Maybe ProcessingConfiguration)
- data SplunkDestinationUpdate = SplunkDestinationUpdate' {
- s3BackupMode :: Maybe SplunkS3BackupMode
- hECToken :: Maybe Text
- hECEndpointType :: Maybe HECEndpointType
- cloudWatchLoggingOptions :: Maybe CloudWatchLoggingOptions
- hECAcknowledgmentTimeoutInSeconds :: Maybe Natural
- s3Update :: Maybe S3DestinationUpdate
- hECEndpoint :: Maybe Text
- retryOptions :: Maybe SplunkRetryOptions
- processingConfiguration :: Maybe ProcessingConfiguration
- newSplunkDestinationUpdate :: SplunkDestinationUpdate
- splunkDestinationUpdate_s3BackupMode :: Lens' SplunkDestinationUpdate (Maybe SplunkS3BackupMode)
- splunkDestinationUpdate_hECToken :: Lens' SplunkDestinationUpdate (Maybe Text)
- splunkDestinationUpdate_hECEndpointType :: Lens' SplunkDestinationUpdate (Maybe HECEndpointType)
- splunkDestinationUpdate_cloudWatchLoggingOptions :: Lens' SplunkDestinationUpdate (Maybe CloudWatchLoggingOptions)
- splunkDestinationUpdate_hECAcknowledgmentTimeoutInSeconds :: Lens' SplunkDestinationUpdate (Maybe Natural)
- splunkDestinationUpdate_s3Update :: Lens' SplunkDestinationUpdate (Maybe S3DestinationUpdate)
- splunkDestinationUpdate_hECEndpoint :: Lens' SplunkDestinationUpdate (Maybe Text)
- splunkDestinationUpdate_retryOptions :: Lens' SplunkDestinationUpdate (Maybe SplunkRetryOptions)
- splunkDestinationUpdate_processingConfiguration :: Lens' SplunkDestinationUpdate (Maybe ProcessingConfiguration)
- data SplunkRetryOptions = SplunkRetryOptions' {}
- newSplunkRetryOptions :: SplunkRetryOptions
- splunkRetryOptions_durationInSeconds :: Lens' SplunkRetryOptions (Maybe Natural)
- data Tag = Tag' {}
- newTag :: Text -> Tag
- tag_value :: Lens' Tag (Maybe Text)
- tag_key :: Lens' Tag Text
- data VpcConfiguration = VpcConfiguration' {}
- newVpcConfiguration :: NonEmpty Text -> Text -> NonEmpty Text -> VpcConfiguration
- vpcConfiguration_subnetIds :: Lens' VpcConfiguration (NonEmpty Text)
- vpcConfiguration_roleARN :: Lens' VpcConfiguration Text
- vpcConfiguration_securityGroupIds :: Lens' VpcConfiguration (NonEmpty Text)
- data VpcConfigurationDescription = VpcConfigurationDescription' {}
- newVpcConfigurationDescription :: NonEmpty Text -> Text -> NonEmpty Text -> Text -> VpcConfigurationDescription
- vpcConfigurationDescription_subnetIds :: Lens' VpcConfigurationDescription (NonEmpty Text)
- vpcConfigurationDescription_roleARN :: Lens' VpcConfigurationDescription Text
- vpcConfigurationDescription_securityGroupIds :: Lens' VpcConfigurationDescription (NonEmpty Text)
- vpcConfigurationDescription_vpcId :: Lens' VpcConfigurationDescription Text
Service Configuration
defaultService :: Service Source #
API version 2015-08-04 of the Amazon Kinesis Firehose SDK configuration.
Errors
_InvalidArgumentException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified input parameter has a value that is not valid.
_InvalidKMSResourceException :: AsError a => Getting (First ServiceError) 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.
_ConcurrentModificationException :: AsError a => Getting (First ServiceError) a ServiceError Source #
Another modification has already happened. Fetch VersionId again and
use it to update the destination.
_ServiceUnavailableException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The service is unavailable. Back off and retry the operation. If you continue to see the exception, throughput limits for the delivery stream may have been exceeded. For more information about limits and how to request an increase, see Amazon Kinesis Data Firehose Limits.
_ResourceNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified resource could not be found.
_LimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError Source #
You have already reached the limit for a requested resource.
_ResourceInUseException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The resource is already in use and not available for this operation.
AmazonopensearchserviceIndexRotationPeriod
newtype AmazonopensearchserviceIndexRotationPeriod Source #
Constructors
| AmazonopensearchserviceIndexRotationPeriod' | |
Bundled Patterns
Instances
AmazonopensearchserviceS3BackupMode
newtype AmazonopensearchserviceS3BackupMode Source #
Constructors
| AmazonopensearchserviceS3BackupMode' | |
Bundled Patterns
| pattern AmazonopensearchserviceS3BackupMode_AllDocuments :: AmazonopensearchserviceS3BackupMode | |
| pattern AmazonopensearchserviceS3BackupMode_FailedDocumentsOnly :: AmazonopensearchserviceS3BackupMode |
Instances
CompressionFormat
newtype CompressionFormat Source #
Constructors
| CompressionFormat' | |
Fields | |
Bundled Patterns
| 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 #
Constructors
| ContentEncoding' | |
Fields | |
Bundled Patterns
| pattern ContentEncoding_GZIP :: ContentEncoding | |
| pattern ContentEncoding_NONE :: ContentEncoding |
Instances
DeliveryStreamEncryptionStatus
newtype DeliveryStreamEncryptionStatus Source #
Constructors
| DeliveryStreamEncryptionStatus' | |
Fields | |
Bundled Patterns
Instances
DeliveryStreamFailureType
newtype DeliveryStreamFailureType Source #
Constructors
| DeliveryStreamFailureType' | |
Fields | |
Bundled Patterns
Instances
DeliveryStreamStatus
newtype DeliveryStreamStatus Source #
Constructors
| DeliveryStreamStatus' | |
Fields | |
Bundled Patterns
Instances
DeliveryStreamType
newtype DeliveryStreamType Source #
Constructors
| DeliveryStreamType' | |
Fields | |
Bundled Patterns
| pattern DeliveryStreamType_DirectPut :: DeliveryStreamType | |
| pattern DeliveryStreamType_KinesisStreamAsSource :: DeliveryStreamType |
Instances
ElasticsearchIndexRotationPeriod
newtype ElasticsearchIndexRotationPeriod Source #
Constructors
| ElasticsearchIndexRotationPeriod' | |
Fields | |
Bundled Patterns
Instances
ElasticsearchS3BackupMode
newtype ElasticsearchS3BackupMode Source #
Constructors
| ElasticsearchS3BackupMode' | |
Fields | |
Bundled Patterns
| pattern ElasticsearchS3BackupMode_AllDocuments :: ElasticsearchS3BackupMode | |
| pattern ElasticsearchS3BackupMode_FailedDocumentsOnly :: ElasticsearchS3BackupMode |
Instances
HECEndpointType
newtype HECEndpointType Source #
Constructors
| HECEndpointType' | |
Fields | |
Bundled Patterns
| pattern HECEndpointType_Event :: HECEndpointType | |
| pattern HECEndpointType_Raw :: HECEndpointType |
Instances
HttpEndpointS3BackupMode
newtype HttpEndpointS3BackupMode Source #
Constructors
| HttpEndpointS3BackupMode' | |
Fields | |
Bundled Patterns
| pattern HttpEndpointS3BackupMode_AllData :: HttpEndpointS3BackupMode | |
| pattern HttpEndpointS3BackupMode_FailedDataOnly :: HttpEndpointS3BackupMode |
Instances
KeyType
Constructors
| KeyType' | |
Fields
| |
Bundled Patterns
| pattern KeyType_AWS_OWNED_CMK :: KeyType | |
| pattern KeyType_CUSTOMER_MANAGED_CMK :: KeyType |
Instances
NoEncryptionConfig
newtype NoEncryptionConfig Source #
Constructors
| NoEncryptionConfig' | |
Fields | |
Bundled Patterns
| pattern NoEncryptionConfig_NoEncryption :: NoEncryptionConfig |
Instances
OrcCompression
newtype OrcCompression Source #
Constructors
| OrcCompression' | |
Fields | |
Bundled Patterns
| pattern OrcCompression_NONE :: OrcCompression | |
| pattern OrcCompression_SNAPPY :: OrcCompression | |
| pattern OrcCompression_ZLIB :: OrcCompression |
Instances
OrcFormatVersion
newtype OrcFormatVersion Source #
Constructors
| OrcFormatVersion' | |
Fields | |
Bundled Patterns
| pattern OrcFormatVersion_V0_11 :: OrcFormatVersion | |
| pattern OrcFormatVersion_V0_12 :: OrcFormatVersion |
Instances
ParquetCompression
newtype ParquetCompression Source #
Constructors
| ParquetCompression' | |
Fields | |
Bundled Patterns
| pattern ParquetCompression_GZIP :: ParquetCompression | |
| pattern ParquetCompression_SNAPPY :: ParquetCompression | |
| pattern ParquetCompression_UNCOMPRESSED :: ParquetCompression |
Instances
ParquetWriterVersion
newtype ParquetWriterVersion Source #
Constructors
| ParquetWriterVersion' | |
Fields | |
Bundled Patterns
| pattern ParquetWriterVersion_V1 :: ParquetWriterVersion | |
| pattern ParquetWriterVersion_V2 :: ParquetWriterVersion |
Instances
ProcessorParameterName
newtype ProcessorParameterName Source #
Constructors
| ProcessorParameterName' | |
Fields | |
Bundled Patterns
Instances
ProcessorType
newtype ProcessorType Source #
Constructors
| ProcessorType' | |
Fields | |
Bundled Patterns
| pattern ProcessorType_AppendDelimiterToRecord :: ProcessorType | |
| pattern ProcessorType_Lambda :: ProcessorType | |
| pattern ProcessorType_MetadataExtraction :: ProcessorType | |
| pattern ProcessorType_RecordDeAggregation :: ProcessorType |
Instances
RedshiftS3BackupMode
newtype RedshiftS3BackupMode Source #
Constructors
| RedshiftS3BackupMode' | |
Fields | |
Bundled Patterns
| pattern RedshiftS3BackupMode_Disabled :: RedshiftS3BackupMode | |
| pattern RedshiftS3BackupMode_Enabled :: RedshiftS3BackupMode |
Instances
S3BackupMode
newtype S3BackupMode Source #
Constructors
| S3BackupMode' | |
Fields | |
Bundled Patterns
| pattern S3BackupMode_Disabled :: S3BackupMode | |
| pattern S3BackupMode_Enabled :: S3BackupMode |
Instances
SplunkS3BackupMode
newtype SplunkS3BackupMode Source #
Constructors
| SplunkS3BackupMode' | |
Fields | |
Bundled Patterns
| pattern SplunkS3BackupMode_AllEvents :: SplunkS3BackupMode | |
| pattern SplunkS3BackupMode_FailedEventsOnly :: SplunkS3BackupMode |
Instances
AmazonopensearchserviceBufferingHints
data AmazonopensearchserviceBufferingHints Source #
See: newAmazonopensearchserviceBufferingHints smart constructor.
Constructors
| AmazonopensearchserviceBufferingHints' | |
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:sizeInMBs:AmazonopensearchserviceBufferingHints', amazonopensearchserviceBufferingHints_sizeInMBs - Undocumented member.
$sel:intervalInSeconds:AmazonopensearchserviceBufferingHints', amazonopensearchserviceBufferingHints_intervalInSeconds - Undocumented member.
amazonopensearchserviceBufferingHints_sizeInMBs :: Lens' AmazonopensearchserviceBufferingHints (Maybe Natural) Source #
Undocumented member.
amazonopensearchserviceBufferingHints_intervalInSeconds :: Lens' AmazonopensearchserviceBufferingHints (Maybe Natural) Source #
Undocumented member.
AmazonopensearchserviceDestinationConfiguration
data AmazonopensearchserviceDestinationConfiguration Source #
See: newAmazonopensearchserviceDestinationConfiguration smart constructor.
Constructors
Instances
newAmazonopensearchserviceDestinationConfiguration Source #
Arguments
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:
$sel:indexRotationPeriod:AmazonopensearchserviceDestinationConfiguration', amazonopensearchserviceDestinationConfiguration_indexRotationPeriod - Undocumented member.
$sel:typeName:AmazonopensearchserviceDestinationConfiguration', amazonopensearchserviceDestinationConfiguration_typeName - Undocumented member.
$sel:s3BackupMode:AmazonopensearchserviceDestinationConfiguration', amazonopensearchserviceDestinationConfiguration_s3BackupMode - Undocumented member.
$sel:domainARN:AmazonopensearchserviceDestinationConfiguration', amazonopensearchserviceDestinationConfiguration_domainARN - Undocumented member.
$sel:cloudWatchLoggingOptions:AmazonopensearchserviceDestinationConfiguration', amazonopensearchserviceDestinationConfiguration_cloudWatchLoggingOptions - Undocumented member.
$sel:vpcConfiguration:AmazonopensearchserviceDestinationConfiguration', amazonopensearchserviceDestinationConfiguration_vpcConfiguration - Undocumented member.
$sel:bufferingHints:AmazonopensearchserviceDestinationConfiguration', amazonopensearchserviceDestinationConfiguration_bufferingHints - Undocumented member.
$sel:retryOptions:AmazonopensearchserviceDestinationConfiguration', amazonopensearchserviceDestinationConfiguration_retryOptions - Undocumented member.
$sel:processingConfiguration:AmazonopensearchserviceDestinationConfiguration', amazonopensearchserviceDestinationConfiguration_processingConfiguration - Undocumented member.
$sel:clusterEndpoint:AmazonopensearchserviceDestinationConfiguration', amazonopensearchserviceDestinationConfiguration_clusterEndpoint - Undocumented member.
$sel:roleARN:AmazonopensearchserviceDestinationConfiguration', amazonopensearchserviceDestinationConfiguration_roleARN - Undocumented member.
$sel:indexName:AmazonopensearchserviceDestinationConfiguration', amazonopensearchserviceDestinationConfiguration_indexName - Undocumented member.
$sel:s3Configuration:AmazonopensearchserviceDestinationConfiguration', amazonopensearchserviceDestinationConfiguration_s3Configuration - Undocumented member.
amazonopensearchserviceDestinationConfiguration_indexRotationPeriod :: Lens' AmazonopensearchserviceDestinationConfiguration (Maybe AmazonopensearchserviceIndexRotationPeriod) Source #
Undocumented member.
amazonopensearchserviceDestinationConfiguration_typeName :: Lens' AmazonopensearchserviceDestinationConfiguration (Maybe Text) Source #
Undocumented member.
amazonopensearchserviceDestinationConfiguration_s3BackupMode :: Lens' AmazonopensearchserviceDestinationConfiguration (Maybe AmazonopensearchserviceS3BackupMode) Source #
Undocumented member.
amazonopensearchserviceDestinationConfiguration_domainARN :: Lens' AmazonopensearchserviceDestinationConfiguration (Maybe Text) Source #
Undocumented member.
amazonopensearchserviceDestinationConfiguration_cloudWatchLoggingOptions :: Lens' AmazonopensearchserviceDestinationConfiguration (Maybe CloudWatchLoggingOptions) Source #
Undocumented member.
amazonopensearchserviceDestinationConfiguration_vpcConfiguration :: Lens' AmazonopensearchserviceDestinationConfiguration (Maybe VpcConfiguration) Source #
Undocumented member.
amazonopensearchserviceDestinationConfiguration_bufferingHints :: Lens' AmazonopensearchserviceDestinationConfiguration (Maybe AmazonopensearchserviceBufferingHints) Source #
Undocumented member.
amazonopensearchserviceDestinationConfiguration_retryOptions :: Lens' AmazonopensearchserviceDestinationConfiguration (Maybe AmazonopensearchserviceRetryOptions) Source #
Undocumented member.
amazonopensearchserviceDestinationConfiguration_processingConfiguration :: Lens' AmazonopensearchserviceDestinationConfiguration (Maybe ProcessingConfiguration) Source #
Undocumented member.
amazonopensearchserviceDestinationConfiguration_clusterEndpoint :: Lens' AmazonopensearchserviceDestinationConfiguration (Maybe Text) Source #
Undocumented member.
amazonopensearchserviceDestinationConfiguration_roleARN :: Lens' AmazonopensearchserviceDestinationConfiguration Text Source #
Undocumented member.
amazonopensearchserviceDestinationConfiguration_indexName :: Lens' AmazonopensearchserviceDestinationConfiguration Text Source #
Undocumented member.
amazonopensearchserviceDestinationConfiguration_s3Configuration :: Lens' AmazonopensearchserviceDestinationConfiguration S3DestinationConfiguration Source #
Undocumented member.
AmazonopensearchserviceDestinationDescription
data AmazonopensearchserviceDestinationDescription Source #
See: newAmazonopensearchserviceDestinationDescription smart constructor.
Constructors
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:
$sel:indexRotationPeriod:AmazonopensearchserviceDestinationDescription', amazonopensearchserviceDestinationDescription_indexRotationPeriod - Undocumented member.
$sel:typeName:AmazonopensearchserviceDestinationDescription', amazonopensearchserviceDestinationDescription_typeName - Undocumented member.
$sel:s3BackupMode:AmazonopensearchserviceDestinationDescription', amazonopensearchserviceDestinationDescription_s3BackupMode - Undocumented member.
$sel:domainARN:AmazonopensearchserviceDestinationDescription', amazonopensearchserviceDestinationDescription_domainARN - Undocumented member.
$sel:vpcConfigurationDescription:AmazonopensearchserviceDestinationDescription', amazonopensearchserviceDestinationDescription_vpcConfigurationDescription - Undocumented member.
$sel:cloudWatchLoggingOptions:AmazonopensearchserviceDestinationDescription', amazonopensearchserviceDestinationDescription_cloudWatchLoggingOptions - Undocumented member.
$sel:s3DestinationDescription:AmazonopensearchserviceDestinationDescription', amazonopensearchserviceDestinationDescription_s3DestinationDescription - Undocumented member.
$sel:bufferingHints:AmazonopensearchserviceDestinationDescription', amazonopensearchserviceDestinationDescription_bufferingHints - Undocumented member.
$sel:retryOptions:AmazonopensearchserviceDestinationDescription', amazonopensearchserviceDestinationDescription_retryOptions - Undocumented member.
$sel:processingConfiguration:AmazonopensearchserviceDestinationDescription', amazonopensearchserviceDestinationDescription_processingConfiguration - Undocumented member.
$sel:roleARN:AmazonopensearchserviceDestinationDescription', amazonopensearchserviceDestinationDescription_roleARN - Undocumented member.
$sel:clusterEndpoint:AmazonopensearchserviceDestinationDescription', amazonopensearchserviceDestinationDescription_clusterEndpoint - Undocumented member.
$sel:indexName:AmazonopensearchserviceDestinationDescription', amazonopensearchserviceDestinationDescription_indexName - Undocumented member.
amazonopensearchserviceDestinationDescription_indexRotationPeriod :: Lens' AmazonopensearchserviceDestinationDescription (Maybe AmazonopensearchserviceIndexRotationPeriod) Source #
Undocumented member.
amazonopensearchserviceDestinationDescription_typeName :: Lens' AmazonopensearchserviceDestinationDescription (Maybe Text) Source #
Undocumented member.
amazonopensearchserviceDestinationDescription_s3BackupMode :: Lens' AmazonopensearchserviceDestinationDescription (Maybe AmazonopensearchserviceS3BackupMode) Source #
Undocumented member.
amazonopensearchserviceDestinationDescription_domainARN :: Lens' AmazonopensearchserviceDestinationDescription (Maybe Text) Source #
Undocumented member.
amazonopensearchserviceDestinationDescription_vpcConfigurationDescription :: Lens' AmazonopensearchserviceDestinationDescription (Maybe VpcConfigurationDescription) Source #
Undocumented member.
amazonopensearchserviceDestinationDescription_cloudWatchLoggingOptions :: Lens' AmazonopensearchserviceDestinationDescription (Maybe CloudWatchLoggingOptions) Source #
Undocumented member.
amazonopensearchserviceDestinationDescription_s3DestinationDescription :: Lens' AmazonopensearchserviceDestinationDescription (Maybe S3DestinationDescription) Source #
Undocumented member.
amazonopensearchserviceDestinationDescription_bufferingHints :: Lens' AmazonopensearchserviceDestinationDescription (Maybe AmazonopensearchserviceBufferingHints) Source #
Undocumented member.
amazonopensearchserviceDestinationDescription_retryOptions :: Lens' AmazonopensearchserviceDestinationDescription (Maybe AmazonopensearchserviceRetryOptions) Source #
Undocumented member.
amazonopensearchserviceDestinationDescription_processingConfiguration :: Lens' AmazonopensearchserviceDestinationDescription (Maybe ProcessingConfiguration) Source #
Undocumented member.
amazonopensearchserviceDestinationDescription_roleARN :: Lens' AmazonopensearchserviceDestinationDescription (Maybe Text) Source #
Undocumented member.
amazonopensearchserviceDestinationDescription_clusterEndpoint :: Lens' AmazonopensearchserviceDestinationDescription (Maybe Text) Source #
Undocumented member.
amazonopensearchserviceDestinationDescription_indexName :: Lens' AmazonopensearchserviceDestinationDescription (Maybe Text) Source #
Undocumented member.
AmazonopensearchserviceDestinationUpdate
data AmazonopensearchserviceDestinationUpdate Source #
See: newAmazonopensearchserviceDestinationUpdate smart constructor.
Constructors
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:
$sel:indexRotationPeriod:AmazonopensearchserviceDestinationUpdate', amazonopensearchserviceDestinationUpdate_indexRotationPeriod - Undocumented member.
$sel:typeName:AmazonopensearchserviceDestinationUpdate', amazonopensearchserviceDestinationUpdate_typeName - Undocumented member.
$sel:domainARN:AmazonopensearchserviceDestinationUpdate', amazonopensearchserviceDestinationUpdate_domainARN - Undocumented member.
$sel:cloudWatchLoggingOptions:AmazonopensearchserviceDestinationUpdate', amazonopensearchserviceDestinationUpdate_cloudWatchLoggingOptions - Undocumented member.
$sel:s3Update:AmazonopensearchserviceDestinationUpdate', amazonopensearchserviceDestinationUpdate_s3Update - Undocumented member.
$sel:bufferingHints:AmazonopensearchserviceDestinationUpdate', amazonopensearchserviceDestinationUpdate_bufferingHints - Undocumented member.
$sel:retryOptions:AmazonopensearchserviceDestinationUpdate', amazonopensearchserviceDestinationUpdate_retryOptions - Undocumented member.
$sel:processingConfiguration:AmazonopensearchserviceDestinationUpdate', amazonopensearchserviceDestinationUpdate_processingConfiguration - Undocumented member.
$sel:roleARN:AmazonopensearchserviceDestinationUpdate', amazonopensearchserviceDestinationUpdate_roleARN - Undocumented member.
$sel:clusterEndpoint:AmazonopensearchserviceDestinationUpdate', amazonopensearchserviceDestinationUpdate_clusterEndpoint - Undocumented member.
$sel:indexName:AmazonopensearchserviceDestinationUpdate', amazonopensearchserviceDestinationUpdate_indexName - Undocumented member.
amazonopensearchserviceDestinationUpdate_indexRotationPeriod :: Lens' AmazonopensearchserviceDestinationUpdate (Maybe AmazonopensearchserviceIndexRotationPeriod) Source #
Undocumented member.
amazonopensearchserviceDestinationUpdate_typeName :: Lens' AmazonopensearchserviceDestinationUpdate (Maybe Text) Source #
Undocumented member.
amazonopensearchserviceDestinationUpdate_domainARN :: Lens' AmazonopensearchserviceDestinationUpdate (Maybe Text) Source #
Undocumented member.
amazonopensearchserviceDestinationUpdate_cloudWatchLoggingOptions :: Lens' AmazonopensearchserviceDestinationUpdate (Maybe CloudWatchLoggingOptions) Source #
Undocumented member.
amazonopensearchserviceDestinationUpdate_s3Update :: Lens' AmazonopensearchserviceDestinationUpdate (Maybe S3DestinationUpdate) Source #
Undocumented member.
amazonopensearchserviceDestinationUpdate_bufferingHints :: Lens' AmazonopensearchserviceDestinationUpdate (Maybe AmazonopensearchserviceBufferingHints) Source #
Undocumented member.
amazonopensearchserviceDestinationUpdate_retryOptions :: Lens' AmazonopensearchserviceDestinationUpdate (Maybe AmazonopensearchserviceRetryOptions) Source #
Undocumented member.
amazonopensearchserviceDestinationUpdate_processingConfiguration :: Lens' AmazonopensearchserviceDestinationUpdate (Maybe ProcessingConfiguration) Source #
Undocumented member.
amazonopensearchserviceDestinationUpdate_roleARN :: Lens' AmazonopensearchserviceDestinationUpdate (Maybe Text) Source #
Undocumented member.
amazonopensearchserviceDestinationUpdate_clusterEndpoint :: Lens' AmazonopensearchserviceDestinationUpdate (Maybe Text) Source #
Undocumented member.
amazonopensearchserviceDestinationUpdate_indexName :: Lens' AmazonopensearchserviceDestinationUpdate (Maybe Text) Source #
Undocumented member.
AmazonopensearchserviceRetryOptions
data AmazonopensearchserviceRetryOptions Source #
See: newAmazonopensearchserviceRetryOptions smart constructor.
Constructors
| AmazonopensearchserviceRetryOptions' | |
Fields | |
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 - Undocumented member.
amazonopensearchserviceRetryOptions_durationInSeconds :: Lens' AmazonopensearchserviceRetryOptions (Maybe Natural) Source #
Undocumented member.
BufferingHints
data BufferingHints Source #
Describes hints for the buffering to perform before delivering data to
the destination. These options are treated as hints, and therefore
Kinesis Data Firehose might choose to use different values when it is
optimal. The SizeInMBs and IntervalInSeconds parameters are
optional. However, if specify a value for one of them, you must also
provide a value for the other.
See: newBufferingHints smart constructor.
Constructors
| BufferingHints' | |
Fields
| |
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: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.
$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.
bufferingHints_sizeInMBs :: Lens' BufferingHints (Maybe Natural) Source #
Buffer incoming data to the specified size, in MiBs, before delivering
it to the destination. The default value is 5. This parameter is
optional but if you specify a value for it, you must also specify a
value for IntervalInSeconds, and vice versa.
We recommend setting this parameter to a value greater than the amount of data you typically ingest into the delivery stream in 10 seconds. For example, if you typically ingest data at 1 MiB/sec, the value should be 10 MiB or higher.
bufferingHints_intervalInSeconds :: Lens' BufferingHints (Maybe Natural) Source #
Buffer incoming data for the specified period of time, in seconds,
before delivering it to the destination. The default value is 300. This
parameter is optional but if you specify a value for it, you must also
specify a value for SizeInMBs, and vice versa.
CloudWatchLoggingOptions
data CloudWatchLoggingOptions Source #
Describes the Amazon CloudWatch logging options for your delivery stream.
See: newCloudWatchLoggingOptions smart constructor.
Constructors
| CloudWatchLoggingOptions' | |
Fields
| |
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.
cloudWatchLoggingOptions_enabled :: Lens' CloudWatchLoggingOptions (Maybe Bool) Source #
Enables or disables CloudWatch logging.
cloudWatchLoggingOptions_logGroupName :: Lens' CloudWatchLoggingOptions (Maybe Text) Source #
The CloudWatch group name for logging. This value is required if CloudWatch logging is enabled.
cloudWatchLoggingOptions_logStreamName :: Lens' CloudWatchLoggingOptions (Maybe Text) Source #
The CloudWatch log stream name for logging. This value is required if CloudWatch logging is enabled.
CopyCommand
data CopyCommand Source #
Describes a COPY command for Amazon Redshift.
See: newCopyCommand smart constructor.
Constructors
| CopyCommand' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> CopyCommand |
Create a value of CopyCommand with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:copyOptions:CopyCommand', copyCommand_copyOptions - Optional parameters to use with the Amazon Redshift COPY command. For
more information, see the "Optional Parameters" section of
Amazon Redshift COPY command.
Some possible examples that would apply to Kinesis Data Firehose are as
follows:
delimiter '\t' lzop; - fields are delimited with "\t" (TAB
character) and compressed using lzop.
delimiter '|' - fields are delimited with "|" (this is the default
delimiter).
delimiter '|' escape - the delimiter should be escaped.
fixedwidth 'venueid:3,venuename:25,venuecity:12,venuestate:2,venueseats:6'
- fields are fixed width in the source, with each width specified after
every column in the table.
JSON 's3://mybucket/jsonpaths.txt' - data is in JSON format, and
the path specified is the format of the data.
For more examples, see Amazon Redshift COPY command examples.
$sel:dataTableColumns:CopyCommand', copyCommand_dataTableColumns - A comma-separated list of column names.
$sel:dataTableName:CopyCommand', copyCommand_dataTableName - The name of the target table. The table must already exist in the
database.
copyCommand_copyOptions :: Lens' CopyCommand (Maybe Text) Source #
Optional parameters to use with the Amazon Redshift COPY command. For
more information, see the "Optional Parameters" section of
Amazon Redshift COPY command.
Some possible examples that would apply to Kinesis Data Firehose are as
follows:
delimiter '\t' lzop; - fields are delimited with "\t" (TAB
character) and compressed using lzop.
delimiter '|' - fields are delimited with "|" (this is the default
delimiter).
delimiter '|' escape - the delimiter should be escaped.
fixedwidth 'venueid:3,venuename:25,venuecity:12,venuestate:2,venueseats:6'
- fields are fixed width in the source, with each width specified after
every column in the table.
JSON 's3://mybucket/jsonpaths.txt' - data is in JSON format, and
the path specified is the format of the data.
For more examples, see Amazon Redshift COPY command examples.
copyCommand_dataTableColumns :: Lens' CopyCommand (Maybe Text) Source #
A comma-separated list of column names.
copyCommand_dataTableName :: Lens' CopyCommand Text Source #
The name of the target table. The table must already exist in the database.
DataFormatConversionConfiguration
data DataFormatConversionConfiguration Source #
Specifies that you want Kinesis Data Firehose to convert data from the JSON format to the Parquet or ORC format before writing it to Amazon S3. Kinesis Data Firehose uses the serializer and deserializer that you specify, in addition to the column information from the AWS Glue table, to deserialize your input data from JSON and then serialize it to the Parquet or ORC format. For more information, see Kinesis Data Firehose Record Format Conversion.
See: newDataFormatConversionConfiguration smart constructor.
Constructors
| DataFormatConversionConfiguration' | |
Fields
| |
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: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:enabled:DataFormatConversionConfiguration', dataFormatConversionConfiguration_enabled - Defaults to true. Set it to false if you want to disable format
conversion while preserving the configuration details.
$sel:schemaConfiguration:DataFormatConversionConfiguration', dataFormatConversionConfiguration_schemaConfiguration - Specifies the AWS Glue Data Catalog table that contains the column
information. This parameter is required if Enabled is set to true.
$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.
dataFormatConversionConfiguration_outputFormatConfiguration :: Lens' DataFormatConversionConfiguration (Maybe OutputFormatConfiguration) Source #
Specifies the serializer that you want Kinesis Data Firehose to use to
convert the format of your data to the Parquet or ORC format. This
parameter is required if Enabled is set to true.
dataFormatConversionConfiguration_enabled :: Lens' DataFormatConversionConfiguration (Maybe Bool) Source #
Defaults to true. Set it to false if you want to disable format
conversion while preserving the configuration details.
dataFormatConversionConfiguration_schemaConfiguration :: Lens' DataFormatConversionConfiguration (Maybe SchemaConfiguration) Source #
Specifies the AWS Glue Data Catalog table that contains the column
information. This parameter is required if Enabled is set to true.
dataFormatConversionConfiguration_inputFormatConfiguration :: Lens' DataFormatConversionConfiguration (Maybe InputFormatConfiguration) Source #
Specifies the deserializer that you want Kinesis Data Firehose to use to
convert the format of your data from JSON. This parameter is required if
Enabled is set to true.
DeliveryStreamDescription
data DeliveryStreamDescription Source #
Contains information about a delivery stream.
See: newDeliveryStreamDescription smart constructor.
Constructors
| DeliveryStreamDescription' | |
Fields
| |
Instances
newDeliveryStreamDescription Source #
Arguments
| :: 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:failureDescription: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:deliveryStreamEncryptionConfiguration:DeliveryStreamDescription', deliveryStreamDescription_deliveryStreamEncryptionConfiguration - Indicates the server-side encryption (SSE) status for the delivery
stream.
$sel:createTimestamp:DeliveryStreamDescription', deliveryStreamDescription_createTimestamp - The date and time that the delivery stream was created.
$sel:source:DeliveryStreamDescription', deliveryStreamDescription_source - If the DeliveryStreamType parameter is KinesisStreamAsSource, a
SourceDescription object describing the source Kinesis data stream.
$sel:lastUpdateTimestamp:DeliveryStreamDescription', deliveryStreamDescription_lastUpdateTimestamp - The date and time that the delivery stream was last updated.
$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 AWS Service Namespaces.
$sel:deliveryStreamStatus:DeliveryStreamDescription', deliveryStreamDescription_deliveryStreamStatus - The status of the delivery stream. If the status of a delivery stream is
CREATING_FAILED, this status doesn't change, and you can't invoke
CreateDeliveryStream again on it. However, you can invoke the
DeleteDeliveryStream operation to delete it.
$sel:deliveryStreamType:DeliveryStreamDescription', deliveryStreamDescription_deliveryStreamType - The delivery stream type. This can be one of the following values:
DirectPut: Provider applications access the delivery stream directly.KinesisStreamAsSource: The delivery stream uses a Kinesis data stream as a source.
$sel:versionId:DeliveryStreamDescription', deliveryStreamDescription_versionId - Each time the destination is updated for a delivery stream, the version
ID is changed, and the current version ID is required when updating the
destination. This is so that the service knows it is applying the
changes to the correct version of the delivery stream.
$sel:destinations:DeliveryStreamDescription', deliveryStreamDescription_destinations - The destinations.
$sel:hasMoreDestinations:DeliveryStreamDescription', deliveryStreamDescription_hasMoreDestinations - Indicates whether there are more destinations available to list.
deliveryStreamDescription_failureDescription :: Lens' DeliveryStreamDescription (Maybe FailureDescription) Source #
Provides details in case one of the following operations fails due to an error related to KMS: CreateDeliveryStream, DeleteDeliveryStream, StartDeliveryStreamEncryption, StopDeliveryStreamEncryption.
deliveryStreamDescription_deliveryStreamEncryptionConfiguration :: Lens' DeliveryStreamDescription (Maybe DeliveryStreamEncryptionConfiguration) Source #
Indicates the server-side encryption (SSE) status for the delivery stream.
deliveryStreamDescription_createTimestamp :: Lens' DeliveryStreamDescription (Maybe UTCTime) Source #
The date and time that the delivery stream was created.
deliveryStreamDescription_source :: Lens' DeliveryStreamDescription (Maybe SourceDescription) Source #
If the DeliveryStreamType parameter is KinesisStreamAsSource, a
SourceDescription object describing the source Kinesis data stream.
deliveryStreamDescription_lastUpdateTimestamp :: Lens' DeliveryStreamDescription (Maybe UTCTime) Source #
The date and time that the delivery stream was last updated.
deliveryStreamDescription_deliveryStreamName :: Lens' DeliveryStreamDescription Text Source #
The name of the delivery stream.
deliveryStreamDescription_deliveryStreamARN :: Lens' DeliveryStreamDescription Text Source #
The Amazon Resource Name (ARN) of the delivery stream. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces.
deliveryStreamDescription_deliveryStreamStatus :: Lens' DeliveryStreamDescription DeliveryStreamStatus Source #
The status of the delivery stream. If the status of a delivery stream is
CREATING_FAILED, this status doesn't change, and you can't invoke
CreateDeliveryStream again on it. However, you can invoke the
DeleteDeliveryStream operation to delete it.
deliveryStreamDescription_deliveryStreamType :: Lens' DeliveryStreamDescription DeliveryStreamType Source #
The delivery stream type. This can be one of the following values:
DirectPut: Provider applications access the delivery stream directly.KinesisStreamAsSource: The delivery stream uses a Kinesis data stream as a source.
deliveryStreamDescription_versionId :: Lens' DeliveryStreamDescription Text Source #
Each time the destination is updated for a delivery stream, the version ID is changed, and the current version ID is required when updating the destination. This is so that the service knows it is applying the changes to the correct version of the delivery stream.
deliveryStreamDescription_destinations :: Lens' DeliveryStreamDescription [DestinationDescription] Source #
The destinations.
deliveryStreamDescription_hasMoreDestinations :: Lens' DeliveryStreamDescription Bool Source #
Indicates whether there are more destinations available to list.
DeliveryStreamEncryptionConfiguration
data DeliveryStreamEncryptionConfiguration Source #
Contains information about the server-side encryption (SSE) status for
the delivery stream, the type customer master key (CMK) in use, if any,
and the ARN of the CMK. You can get
DeliveryStreamEncryptionConfiguration by invoking the
DescribeDeliveryStream operation.
See: newDeliveryStreamEncryptionConfiguration smart constructor.
Constructors
| DeliveryStreamEncryptionConfiguration' | |
Fields
| |
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: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.
$sel:keyType:DeliveryStreamEncryptionConfiguration', deliveryStreamEncryptionConfiguration_keyType - Indicates the type of customer master key (CMK) that is used for
encryption. The default setting is AWS_OWNED_CMK. For more information
about CMKs, see
Customer Master Keys (CMKs).
$sel:keyARN:DeliveryStreamEncryptionConfiguration', deliveryStreamEncryptionConfiguration_keyARN - If KeyType is CUSTOMER_MANAGED_CMK, this field contains the ARN of
the customer managed CMK. If KeyType is AWS_OWNED_CMK,
DeliveryStreamEncryptionConfiguration doesn't contain a value for
KeyARN.
$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.
deliveryStreamEncryptionConfiguration_status :: Lens' DeliveryStreamEncryptionConfiguration (Maybe DeliveryStreamEncryptionStatus) Source #
This is the server-side encryption (SSE) status for the delivery stream.
For a full description of the different values of this status, see
StartDeliveryStreamEncryption and StopDeliveryStreamEncryption. If this
status is ENABLING_FAILED or DISABLING_FAILED, it is the status of
the most recent attempt to enable or disable SSE, respectively.
deliveryStreamEncryptionConfiguration_keyType :: Lens' DeliveryStreamEncryptionConfiguration (Maybe KeyType) Source #
Indicates the type of customer master key (CMK) that is used for
encryption. The default setting is AWS_OWNED_CMK. For more information
about CMKs, see
Customer Master Keys (CMKs).
deliveryStreamEncryptionConfiguration_keyARN :: Lens' DeliveryStreamEncryptionConfiguration (Maybe Text) Source #
If KeyType is CUSTOMER_MANAGED_CMK, this field contains the ARN of
the customer managed CMK. If KeyType is AWS_OWNED_CMK,
DeliveryStreamEncryptionConfiguration doesn't contain a value for
KeyARN.
deliveryStreamEncryptionConfiguration_failureDescription :: Lens' DeliveryStreamEncryptionConfiguration (Maybe FailureDescription) Source #
Provides details in case one of the following operations fails due to an error related to KMS: CreateDeliveryStream, DeleteDeliveryStream, StartDeliveryStreamEncryption, StopDeliveryStreamEncryption.
DeliveryStreamEncryptionConfigurationInput
data DeliveryStreamEncryptionConfigurationInput Source #
Specifies the type and Amazon Resource Name (ARN) of the CMK to use for Server-Side Encryption (SSE).
See: newDeliveryStreamEncryptionConfigurationInput smart constructor.
Constructors
| DeliveryStreamEncryptionConfigurationInput' | |
Fields
| |
Instances
newDeliveryStreamEncryptionConfigurationInput Source #
Arguments
| :: KeyType | |
| -> DeliveryStreamEncryptionConfigurationInput |
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
AWS_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 AWS_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 AWS Key Management Service developer guide.
deliveryStreamEncryptionConfigurationInput_keyARN :: Lens' DeliveryStreamEncryptionConfigurationInput (Maybe Text) Source #
If you set KeyType to CUSTOMER_MANAGED_CMK, you must specify the
Amazon Resource Name (ARN) of the CMK. If you set KeyType to
AWS_OWNED_CMK, Kinesis Data Firehose uses a service-account CMK.
deliveryStreamEncryptionConfigurationInput_keyType :: Lens' DeliveryStreamEncryptionConfigurationInput KeyType Source #
Indicates the type of customer master key (CMK) to use for encryption.
The default setting is AWS_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 AWS Key Management Service developer guide.
Deserializer
data Deserializer Source #
The deserializer you want Kinesis Data Firehose to use for converting the input data from JSON. Kinesis Data Firehose then serializes the data to its final format using the Serializer. Kinesis Data Firehose supports two types of deserializers: the Apache Hive JSON SerDe and the OpenX JSON SerDe.
See: newDeserializer smart constructor.
Constructors
| Deserializer' | |
Fields
| |
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: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.
$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.
deserializer_openXJsonSerDe :: Lens' Deserializer (Maybe OpenXJsonSerDe) Source #
The OpenX SerDe. Used by Kinesis Data Firehose for deserializing data, which means converting it from the JSON format in preparation for serializing it to the Parquet or ORC format. This is one of two deserializers you can choose, depending on which one offers the functionality you need. The other option is the native Hive / HCatalog JsonSerDe.
deserializer_hiveJsonSerDe :: Lens' Deserializer (Maybe HiveJsonSerDe) Source #
The native Hive / HCatalog JsonSerDe. Used by Kinesis Data Firehose for deserializing data, which means converting it from the JSON format in preparation for serializing it to the Parquet or ORC format. This is one of two deserializers you can choose, depending on which one offers the functionality you need. The other option is the OpenX SerDe.
DestinationDescription
data DestinationDescription Source #
Describes the destination for a delivery stream.
See: newDestinationDescription smart constructor.
Constructors
| DestinationDescription' | |
Fields
| |
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:splunkDestinationDescription:DestinationDescription', destinationDescription_splunkDestinationDescription - The destination in Splunk.
$sel:amazonopensearchserviceDestinationDescription:DestinationDescription', destinationDescription_amazonopensearchserviceDestinationDescription - Undocumented member.
$sel:httpEndpointDestinationDescription:DestinationDescription', destinationDescription_httpEndpointDestinationDescription - Describes the specified HTTP endpoint destination.
$sel:s3DestinationDescription:DestinationDescription', destinationDescription_s3DestinationDescription - [Deprecated] The destination in Amazon S3.
$sel:extendedS3DestinationDescription:DestinationDescription', destinationDescription_extendedS3DestinationDescription - The destination in Amazon S3.
$sel:elasticsearchDestinationDescription:DestinationDescription', destinationDescription_elasticsearchDestinationDescription - The destination in Amazon ES.
$sel:redshiftDestinationDescription:DestinationDescription', destinationDescription_redshiftDestinationDescription - The destination in Amazon Redshift.
$sel:destinationId:DestinationDescription', destinationDescription_destinationId - The ID of the destination.
destinationDescription_splunkDestinationDescription :: Lens' DestinationDescription (Maybe SplunkDestinationDescription) Source #
The destination in Splunk.
destinationDescription_amazonopensearchserviceDestinationDescription :: Lens' DestinationDescription (Maybe AmazonopensearchserviceDestinationDescription) Source #
Undocumented member.
destinationDescription_httpEndpointDestinationDescription :: Lens' DestinationDescription (Maybe HttpEndpointDestinationDescription) Source #
Describes the specified HTTP endpoint destination.
destinationDescription_s3DestinationDescription :: Lens' DestinationDescription (Maybe S3DestinationDescription) Source #
- Deprecated
- The destination in Amazon S3.
destinationDescription_extendedS3DestinationDescription :: Lens' DestinationDescription (Maybe ExtendedS3DestinationDescription) Source #
The destination in Amazon S3.
destinationDescription_elasticsearchDestinationDescription :: Lens' DestinationDescription (Maybe ElasticsearchDestinationDescription) Source #
The destination in Amazon ES.
destinationDescription_redshiftDestinationDescription :: Lens' DestinationDescription (Maybe RedshiftDestinationDescription) Source #
The destination in Amazon Redshift.
destinationDescription_destinationId :: Lens' DestinationDescription Text Source #
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. For more information, see https://docs.aws.amazon.com/firehose/latest/dev/dynamic-partitioning.html
See: newDynamicPartitioningConfiguration smart constructor.
Constructors
| DynamicPartitioningConfiguration' | |
Fields
| |
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.
dynamicPartitioningConfiguration_enabled :: Lens' DynamicPartitioningConfiguration (Maybe Bool) Source #
Specifies that the dynamic partitioning is enabled for this Kinesis Data Firehose delivery stream.
dynamicPartitioningConfiguration_retryOptions :: Lens' DynamicPartitioningConfiguration (Maybe RetryOptions) Source #
The retry behavior in case Kinesis Data Firehose is unable to deliver data to an Amazon S3 prefix.
ElasticsearchBufferingHints
data ElasticsearchBufferingHints Source #
Describes the buffering to perform before delivering data to the Amazon ES destination.
See: newElasticsearchBufferingHints smart constructor.
Constructors
| ElasticsearchBufferingHints' | |
Fields
| |
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: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.
$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).
elasticsearchBufferingHints_sizeInMBs :: Lens' ElasticsearchBufferingHints (Maybe Natural) Source #
Buffer incoming data to the specified size, in MBs, before delivering it to the destination. The default value is 5.
We recommend setting this parameter to a value greater than the amount of data you typically ingest into the delivery stream in 10 seconds. For example, if you typically ingest data at 1 MB/sec, the value should be 10 MB or higher.
elasticsearchBufferingHints_intervalInSeconds :: Lens' ElasticsearchBufferingHints (Maybe Natural) Source #
Buffer incoming data for the specified period of time, in seconds, before delivering it to the destination. The default value is 300 (5 minutes).
ElasticsearchDestinationConfiguration
data ElasticsearchDestinationConfiguration Source #
Describes the configuration of a destination in Amazon ES.
See: newElasticsearchDestinationConfiguration smart constructor.
Constructors
| ElasticsearchDestinationConfiguration' | |
Fields
| |
Instances
newElasticsearchDestinationConfiguration Source #
Arguments
| :: Text | |
| -> Text | |
| -> S3DestinationConfiguration | |
| -> ElasticsearchDestinationConfiguration |
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:
$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: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: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
elasticsearch-failed/ appended to the key prefix. When set to
AllDocuments, Kinesis Data Firehose delivers all incoming records to
Amazon S3, and also writes failed documents with
elasticsearch-failed/ appended to the prefix. For more information,
see
Amazon S3 Backup for the Amazon ES Destination.
Default value is FailedDocumentsOnly.
You can't change this backup mode after you create the delivery stream.
$sel:domainARN:ElasticsearchDestinationConfiguration', elasticsearchDestinationConfiguration_domainARN - The ARN of the Amazon ES domain. The IAM role must have permissions
for DescribeElasticsearchDomain, DescribeElasticsearchDomains, and
DescribeElasticsearchDomainConfig after assuming the role specified in
RoleARN. For more information, see
Amazon Resource Names (ARNs) and AWS Service Namespaces.
Specify either ClusterEndpoint or DomainARN.
$sel:cloudWatchLoggingOptions:ElasticsearchDestinationConfiguration', elasticsearchDestinationConfiguration_cloudWatchLoggingOptions - The Amazon CloudWatch logging options for your delivery stream.
$sel:vpcConfiguration:ElasticsearchDestinationConfiguration', elasticsearchDestinationConfiguration_vpcConfiguration - The details of the VPC of the Amazon ES destination.
$sel:bufferingHints:ElasticsearchDestinationConfiguration', elasticsearchDestinationConfiguration_bufferingHints - The buffering options. If no value is specified, the default values for
ElasticsearchBufferingHints are used.
$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:processingConfiguration:ElasticsearchDestinationConfiguration', elasticsearchDestinationConfiguration_processingConfiguration - The data processing configuration.
$sel:clusterEndpoint:ElasticsearchDestinationConfiguration', elasticsearchDestinationConfiguration_clusterEndpoint - The endpoint to use when communicating with the cluster. Specify either
this ClusterEndpoint or the DomainARN field.
$sel:roleARN: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 AWS Service Namespaces.
$sel:indexName:ElasticsearchDestinationConfiguration', elasticsearchDestinationConfiguration_indexName - The Elasticsearch index name.
$sel:s3Configuration:ElasticsearchDestinationConfiguration', elasticsearchDestinationConfiguration_s3Configuration - The configuration for the backup Amazon S3 location.
elasticsearchDestinationConfiguration_indexRotationPeriod :: Lens' ElasticsearchDestinationConfiguration (Maybe ElasticsearchIndexRotationPeriod) Source #
The Elasticsearch index rotation period. Index rotation appends a
timestamp to the IndexName to facilitate the expiration of old data.
For more information, see
Index Rotation for the Amazon ES Destination.
The default value is OneDay.
elasticsearchDestinationConfiguration_typeName :: Lens' ElasticsearchDestinationConfiguration (Maybe Text) Source #
The Elasticsearch type name. For Elasticsearch 6.x, there can be only one type per index. If you try to specify a new type for an existing index that already has another type, Kinesis Data Firehose returns an error during run time.
For Elasticsearch 7.x, don't specify a TypeName.
elasticsearchDestinationConfiguration_s3BackupMode :: Lens' ElasticsearchDestinationConfiguration (Maybe ElasticsearchS3BackupMode) Source #
Defines how documents should be delivered to Amazon S3. When it is set
to FailedDocumentsOnly, Kinesis Data Firehose writes any documents
that could not be indexed to the configured Amazon S3 destination, with
elasticsearch-failed/ appended to the key prefix. When set to
AllDocuments, Kinesis Data Firehose delivers all incoming records to
Amazon S3, and also writes failed documents with
elasticsearch-failed/ appended to the prefix. For more information,
see
Amazon S3 Backup for the Amazon ES Destination.
Default value is FailedDocumentsOnly.
You can't change this backup mode after you create the delivery stream.
elasticsearchDestinationConfiguration_domainARN :: Lens' ElasticsearchDestinationConfiguration (Maybe Text) Source #
The ARN of the Amazon ES domain. The IAM role must have permissions
for DescribeElasticsearchDomain, DescribeElasticsearchDomains, and
DescribeElasticsearchDomainConfig after assuming the role specified in
RoleARN. For more information, see
Amazon Resource Names (ARNs) and AWS Service Namespaces.
Specify either ClusterEndpoint or DomainARN.
elasticsearchDestinationConfiguration_cloudWatchLoggingOptions :: Lens' ElasticsearchDestinationConfiguration (Maybe CloudWatchLoggingOptions) Source #
The Amazon CloudWatch logging options for your delivery stream.
elasticsearchDestinationConfiguration_vpcConfiguration :: Lens' ElasticsearchDestinationConfiguration (Maybe VpcConfiguration) Source #
The details of the VPC of the Amazon ES destination.
elasticsearchDestinationConfiguration_bufferingHints :: Lens' ElasticsearchDestinationConfiguration (Maybe ElasticsearchBufferingHints) Source #
The buffering options. If no value is specified, the default values for
ElasticsearchBufferingHints are used.
elasticsearchDestinationConfiguration_retryOptions :: Lens' ElasticsearchDestinationConfiguration (Maybe ElasticsearchRetryOptions) Source #
The retry behavior in case Kinesis Data Firehose is unable to deliver documents to Amazon ES. The default value is 300 (5 minutes).
elasticsearchDestinationConfiguration_processingConfiguration :: Lens' ElasticsearchDestinationConfiguration (Maybe ProcessingConfiguration) Source #
The data processing configuration.
elasticsearchDestinationConfiguration_clusterEndpoint :: Lens' ElasticsearchDestinationConfiguration (Maybe Text) Source #
The endpoint to use when communicating with the cluster. Specify either
this ClusterEndpoint or the DomainARN field.
elasticsearchDestinationConfiguration_roleARN :: Lens' ElasticsearchDestinationConfiguration Text Source #
The Amazon Resource Name (ARN) of the IAM role to be assumed by Kinesis Data Firehose for calling the Amazon ES Configuration API and for indexing documents. For more information, see Grant Kinesis Data Firehose Access to an Amazon S3 Destination and Amazon Resource Names (ARNs) and AWS Service Namespaces.
elasticsearchDestinationConfiguration_indexName :: Lens' ElasticsearchDestinationConfiguration Text Source #
The Elasticsearch index name.
elasticsearchDestinationConfiguration_s3Configuration :: Lens' ElasticsearchDestinationConfiguration S3DestinationConfiguration Source #
The configuration for the backup Amazon S3 location.
ElasticsearchDestinationDescription
data ElasticsearchDestinationDescription Source #
The destination description in Amazon ES.
See: newElasticsearchDestinationDescription smart constructor.
Constructors
| ElasticsearchDestinationDescription' | |
Fields
| |
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:
$sel:indexRotationPeriod:ElasticsearchDestinationDescription', elasticsearchDestinationDescription_indexRotationPeriod - The Elasticsearch index rotation period
$sel:typeName:ElasticsearchDestinationDescription', elasticsearchDestinationDescription_typeName - The Elasticsearch type name. This applies to Elasticsearch 6.x and lower
versions. For Elasticsearch 7.x, there's no value for TypeName.
$sel:s3BackupMode:ElasticsearchDestinationDescription', elasticsearchDestinationDescription_s3BackupMode - The Amazon S3 backup mode.
$sel:domainARN:ElasticsearchDestinationDescription', elasticsearchDestinationDescription_domainARN - The ARN of the Amazon ES domain. For more information, see
Amazon Resource Names (ARNs) and AWS Service Namespaces.
Kinesis Data Firehose uses either ClusterEndpoint or DomainARN to
send data to Amazon ES.
$sel:vpcConfigurationDescription:ElasticsearchDestinationDescription', elasticsearchDestinationDescription_vpcConfigurationDescription - The details of the VPC of the Amazon ES destination.
$sel:cloudWatchLoggingOptions:ElasticsearchDestinationDescription', elasticsearchDestinationDescription_cloudWatchLoggingOptions - The Amazon CloudWatch logging options.
$sel:s3DestinationDescription:ElasticsearchDestinationDescription', elasticsearchDestinationDescription_s3DestinationDescription - The Amazon S3 destination.
$sel:bufferingHints:ElasticsearchDestinationDescription', elasticsearchDestinationDescription_bufferingHints - The buffering options.
$sel:retryOptions:ElasticsearchDestinationDescription', elasticsearchDestinationDescription_retryOptions - The Amazon ES retry options.
$sel:processingConfiguration:ElasticsearchDestinationDescription', elasticsearchDestinationDescription_processingConfiguration - The data processing configuration.
$sel:roleARN:ElasticsearchDestinationDescription', elasticsearchDestinationDescription_roleARN - The Amazon Resource Name (ARN) of the AWS credentials. For more
information, see
Amazon Resource Names (ARNs) and AWS Service Namespaces.
$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:indexName:ElasticsearchDestinationDescription', elasticsearchDestinationDescription_indexName - The Elasticsearch index name.
elasticsearchDestinationDescription_indexRotationPeriod :: Lens' ElasticsearchDestinationDescription (Maybe ElasticsearchIndexRotationPeriod) Source #
The Elasticsearch index rotation period
elasticsearchDestinationDescription_typeName :: Lens' ElasticsearchDestinationDescription (Maybe Text) Source #
The Elasticsearch type name. This applies to Elasticsearch 6.x and lower
versions. For Elasticsearch 7.x, there's no value for TypeName.
elasticsearchDestinationDescription_s3BackupMode :: Lens' ElasticsearchDestinationDescription (Maybe ElasticsearchS3BackupMode) Source #
The Amazon S3 backup mode.
elasticsearchDestinationDescription_domainARN :: Lens' ElasticsearchDestinationDescription (Maybe Text) Source #
The ARN of the Amazon ES domain. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces.
Kinesis Data Firehose uses either ClusterEndpoint or DomainARN to
send data to Amazon ES.
elasticsearchDestinationDescription_vpcConfigurationDescription :: Lens' ElasticsearchDestinationDescription (Maybe VpcConfigurationDescription) Source #
The details of the VPC of the Amazon ES destination.
elasticsearchDestinationDescription_cloudWatchLoggingOptions :: Lens' ElasticsearchDestinationDescription (Maybe CloudWatchLoggingOptions) Source #
The Amazon CloudWatch logging options.
elasticsearchDestinationDescription_s3DestinationDescription :: Lens' ElasticsearchDestinationDescription (Maybe S3DestinationDescription) Source #
The Amazon S3 destination.
elasticsearchDestinationDescription_bufferingHints :: Lens' ElasticsearchDestinationDescription (Maybe ElasticsearchBufferingHints) Source #
The buffering options.
elasticsearchDestinationDescription_retryOptions :: Lens' ElasticsearchDestinationDescription (Maybe ElasticsearchRetryOptions) Source #
The Amazon ES retry options.
elasticsearchDestinationDescription_processingConfiguration :: Lens' ElasticsearchDestinationDescription (Maybe ProcessingConfiguration) Source #
The data processing configuration.
elasticsearchDestinationDescription_roleARN :: Lens' ElasticsearchDestinationDescription (Maybe Text) Source #
The Amazon Resource Name (ARN) of the AWS credentials. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces.
elasticsearchDestinationDescription_clusterEndpoint :: Lens' ElasticsearchDestinationDescription (Maybe Text) Source #
The endpoint to use when communicating with the cluster. Kinesis Data
Firehose uses either this ClusterEndpoint or the DomainARN field to
send data to Amazon ES.
elasticsearchDestinationDescription_indexName :: Lens' ElasticsearchDestinationDescription (Maybe Text) Source #
The Elasticsearch index name.
ElasticsearchDestinationUpdate
data ElasticsearchDestinationUpdate Source #
Describes an update for a destination in Amazon ES.
See: newElasticsearchDestinationUpdate smart constructor.
Constructors
| ElasticsearchDestinationUpdate' | |
Fields
| |
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:
$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: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.
$sel:domainARN:ElasticsearchDestinationUpdate', elasticsearchDestinationUpdate_domainARN - The ARN of the Amazon ES domain. The IAM role must have permissions
for DescribeElasticsearchDomain, DescribeElasticsearchDomains, and
DescribeElasticsearchDomainConfig after assuming the IAM role
specified in RoleARN. For more information, see
Amazon Resource Names (ARNs) and AWS Service Namespaces.
Specify either ClusterEndpoint or DomainARN.
$sel:cloudWatchLoggingOptions:ElasticsearchDestinationUpdate', elasticsearchDestinationUpdate_cloudWatchLoggingOptions - The CloudWatch logging options for your delivery stream.
$sel:s3Update:ElasticsearchDestinationUpdate', elasticsearchDestinationUpdate_s3Update - The Amazon S3 destination.
$sel:bufferingHints:ElasticsearchDestinationUpdate', elasticsearchDestinationUpdate_bufferingHints - The buffering options. If no value is specified,
ElasticsearchBufferingHints object default values are used.
$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).
$sel:processingConfiguration:ElasticsearchDestinationUpdate', elasticsearchDestinationUpdate_processingConfiguration - The data processing configuration.
$sel:roleARN: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 AWS Service Namespaces.
$sel:clusterEndpoint:ElasticsearchDestinationUpdate', elasticsearchDestinationUpdate_clusterEndpoint - The endpoint to use when communicating with the cluster. Specify either
this ClusterEndpoint or the DomainARN field.
$sel:indexName:ElasticsearchDestinationUpdate', elasticsearchDestinationUpdate_indexName - The Elasticsearch index name.
elasticsearchDestinationUpdate_indexRotationPeriod :: Lens' ElasticsearchDestinationUpdate (Maybe ElasticsearchIndexRotationPeriod) Source #
The Elasticsearch index rotation period. Index rotation appends a
timestamp to IndexName to facilitate the expiration of old data. For
more information, see
Index Rotation for the Amazon ES Destination.
Default value is OneDay.
elasticsearchDestinationUpdate_typeName :: Lens' ElasticsearchDestinationUpdate (Maybe Text) Source #
The Elasticsearch type name. For Elasticsearch 6.x, there can be only one type per index. If you try to specify a new type for an existing index that already has another type, Kinesis Data Firehose returns an error during runtime.
If you upgrade Elasticsearch from 6.x to 7.x and don’t update your
delivery stream, Kinesis Data Firehose still delivers data to
Elasticsearch with the old index name and type name. If you want to
update your delivery stream with a new index name, provide an empty
string for TypeName.
elasticsearchDestinationUpdate_domainARN :: Lens' ElasticsearchDestinationUpdate (Maybe Text) Source #
The ARN of the Amazon ES domain. The IAM role must have permissions
for DescribeElasticsearchDomain, DescribeElasticsearchDomains, and
DescribeElasticsearchDomainConfig after assuming the IAM role
specified in RoleARN. For more information, see
Amazon Resource Names (ARNs) and AWS Service Namespaces.
Specify either ClusterEndpoint or DomainARN.
elasticsearchDestinationUpdate_cloudWatchLoggingOptions :: Lens' ElasticsearchDestinationUpdate (Maybe CloudWatchLoggingOptions) Source #
The CloudWatch logging options for your delivery stream.
elasticsearchDestinationUpdate_s3Update :: Lens' ElasticsearchDestinationUpdate (Maybe S3DestinationUpdate) Source #
The Amazon S3 destination.
elasticsearchDestinationUpdate_bufferingHints :: Lens' ElasticsearchDestinationUpdate (Maybe ElasticsearchBufferingHints) Source #
The buffering options. If no value is specified,
ElasticsearchBufferingHints object default values are used.
elasticsearchDestinationUpdate_retryOptions :: Lens' ElasticsearchDestinationUpdate (Maybe ElasticsearchRetryOptions) Source #
The retry behavior in case Kinesis Data Firehose is unable to deliver documents to Amazon ES. The default value is 300 (5 minutes).
elasticsearchDestinationUpdate_processingConfiguration :: Lens' ElasticsearchDestinationUpdate (Maybe ProcessingConfiguration) Source #
The data processing configuration.
elasticsearchDestinationUpdate_roleARN :: Lens' ElasticsearchDestinationUpdate (Maybe Text) Source #
The Amazon Resource Name (ARN) of the IAM role to be assumed by Kinesis Data Firehose for calling the Amazon ES Configuration API and for indexing documents. For more information, see Grant Kinesis Data Firehose Access to an Amazon S3 Destination and Amazon Resource Names (ARNs) and AWS Service Namespaces.
elasticsearchDestinationUpdate_clusterEndpoint :: Lens' ElasticsearchDestinationUpdate (Maybe Text) Source #
The endpoint to use when communicating with the cluster. Specify either
this ClusterEndpoint or the DomainARN field.
elasticsearchDestinationUpdate_indexName :: Lens' ElasticsearchDestinationUpdate (Maybe Text) Source #
The Elasticsearch index name.
ElasticsearchRetryOptions
data ElasticsearchRetryOptions Source #
Configures retry behavior in case Kinesis Data Firehose is unable to deliver documents to Amazon ES.
See: newElasticsearchRetryOptions smart constructor.
Constructors
| ElasticsearchRetryOptions' | |
Fields
| |
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.
elasticsearchRetryOptions_durationInSeconds :: Lens' ElasticsearchRetryOptions (Maybe Natural) Source #
After an initial failure to deliver to Amazon ES, the total amount of time during which Kinesis Data Firehose retries delivery (including the first attempt). After this time has elapsed, the failed documents are written to Amazon S3. Default value is 300 seconds (5 minutes). A value of 0 (zero) results in no retries.
EncryptionConfiguration
data EncryptionConfiguration Source #
Describes the encryption for a destination in Amazon S3.
See: newEncryptionConfiguration smart constructor.
Constructors
| EncryptionConfiguration' | |
Fields
| |
Instances
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:noEncryptionConfig:EncryptionConfiguration', encryptionConfiguration_noEncryptionConfig - Specifically override existing encryption information to ensure that no
encryption is used.
$sel:kmsEncryptionConfig:EncryptionConfiguration', encryptionConfiguration_kmsEncryptionConfig - The encryption key.
encryptionConfiguration_noEncryptionConfig :: Lens' EncryptionConfiguration (Maybe NoEncryptionConfig) Source #
Specifically override existing encryption information to ensure that no encryption is used.
encryptionConfiguration_kmsEncryptionConfig :: Lens' EncryptionConfiguration (Maybe KMSEncryptionConfig) Source #
The encryption key.
ExtendedS3DestinationConfiguration
data ExtendedS3DestinationConfiguration Source #
Describes the configuration of a destination in Amazon S3.
See: newExtendedS3DestinationConfiguration smart constructor.
Constructors
| ExtendedS3DestinationConfiguration' | |
Fields
| |
Instances
newExtendedS3DestinationConfiguration Source #
Arguments
| :: Text | |
| -> Text | |
| -> ExtendedS3DestinationConfiguration |
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:
$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.
$sel:prefix: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:cloudWatchLoggingOptions:ExtendedS3DestinationConfiguration', extendedS3DestinationConfiguration_cloudWatchLoggingOptions - The Amazon CloudWatch logging options for your delivery stream.
$sel:s3BackupConfiguration:ExtendedS3DestinationConfiguration', extendedS3DestinationConfiguration_s3BackupConfiguration - The configuration for backup in Amazon S3.
$sel:errorOutputPrefix: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.
$sel:encryptionConfiguration:ExtendedS3DestinationConfiguration', extendedS3DestinationConfiguration_encryptionConfiguration - The encryption configuration. If no value is specified, the default is
no encryption.
$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. For more information, see
https://docs.aws.amazon.com/firehose/latest/dev/dynamic-partitioning.html
$sel:compressionFormat:ExtendedS3DestinationConfiguration', extendedS3DestinationConfiguration_compressionFormat - The compression format. If no value is specified, the default is
UNCOMPRESSED.
$sel:bufferingHints:ExtendedS3DestinationConfiguration', extendedS3DestinationConfiguration_bufferingHints - The buffering option.
$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:processingConfiguration:ExtendedS3DestinationConfiguration', extendedS3DestinationConfiguration_processingConfiguration - The data processing configuration.
$sel:roleARN:ExtendedS3DestinationConfiguration', extendedS3DestinationConfiguration_roleARN - The Amazon Resource Name (ARN) of the AWS credentials. For more
information, see
Amazon Resource Names (ARNs) and AWS Service Namespaces.
$sel:bucketARN:ExtendedS3DestinationConfiguration', extendedS3DestinationConfiguration_bucketARN - The ARN of the S3 bucket. For more information, see
Amazon Resource Names (ARNs) and AWS Service Namespaces.
extendedS3DestinationConfiguration_s3BackupMode :: Lens' ExtendedS3DestinationConfiguration (Maybe S3BackupMode) Source #
The Amazon S3 backup mode. After you create a delivery stream, you can update it to enable Amazon S3 backup if it is disabled. If backup is enabled, you can't update the delivery stream to disable it.
extendedS3DestinationConfiguration_prefix :: Lens' ExtendedS3DestinationConfiguration (Maybe Text) Source #
The "YYYY/MM/DD/HH" time format prefix is automatically used for delivered Amazon S3 files. You can also specify a custom prefix, as described in Custom Prefixes for Amazon S3 Objects.
extendedS3DestinationConfiguration_cloudWatchLoggingOptions :: Lens' ExtendedS3DestinationConfiguration (Maybe CloudWatchLoggingOptions) Source #
The Amazon CloudWatch logging options for your delivery stream.
extendedS3DestinationConfiguration_s3BackupConfiguration :: Lens' ExtendedS3DestinationConfiguration (Maybe S3DestinationConfiguration) Source #
The configuration for backup in Amazon S3.
extendedS3DestinationConfiguration_errorOutputPrefix :: Lens' ExtendedS3DestinationConfiguration (Maybe Text) Source #
A prefix that Kinesis Data Firehose evaluates and adds to failed records before writing them to S3. This prefix appears immediately following the bucket name. For information about how to specify this prefix, see Custom Prefixes for Amazon S3 Objects.
extendedS3DestinationConfiguration_encryptionConfiguration :: Lens' ExtendedS3DestinationConfiguration (Maybe EncryptionConfiguration) Source #
The encryption configuration. If no value is specified, the default is no encryption.
extendedS3DestinationConfiguration_dynamicPartitioningConfiguration :: Lens' ExtendedS3DestinationConfiguration (Maybe DynamicPartitioningConfiguration) Source #
The configuration of the dynamic partitioning mechanism that creates smaller data sets from the streaming data by partitioning it based on partition keys. Currently, dynamic partitioning is only supported for Amazon S3 destinations. For more information, see https://docs.aws.amazon.com/firehose/latest/dev/dynamic-partitioning.html
extendedS3DestinationConfiguration_compressionFormat :: Lens' ExtendedS3DestinationConfiguration (Maybe CompressionFormat) Source #
The compression format. If no value is specified, the default is UNCOMPRESSED.
extendedS3DestinationConfiguration_bufferingHints :: Lens' ExtendedS3DestinationConfiguration (Maybe BufferingHints) Source #
The buffering option.
extendedS3DestinationConfiguration_dataFormatConversionConfiguration :: Lens' ExtendedS3DestinationConfiguration (Maybe DataFormatConversionConfiguration) Source #
The serializer, deserializer, and schema for converting data from the JSON format to the Parquet or ORC format before writing it to Amazon S3.
extendedS3DestinationConfiguration_processingConfiguration :: Lens' ExtendedS3DestinationConfiguration (Maybe ProcessingConfiguration) Source #
The data processing configuration.
extendedS3DestinationConfiguration_roleARN :: Lens' ExtendedS3DestinationConfiguration Text Source #
The Amazon Resource Name (ARN) of the AWS credentials. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces.
extendedS3DestinationConfiguration_bucketARN :: Lens' ExtendedS3DestinationConfiguration Text Source #
The ARN of the S3 bucket. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces.
ExtendedS3DestinationDescription
data ExtendedS3DestinationDescription Source #
Describes a destination in Amazon S3.
See: newExtendedS3DestinationDescription smart constructor.
Constructors
| ExtendedS3DestinationDescription' | |
Fields
| |
Instances
newExtendedS3DestinationDescription Source #
Arguments
| :: 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:
$sel:s3BackupMode:ExtendedS3DestinationDescription', extendedS3DestinationDescription_s3BackupMode - The Amazon S3 backup mode.
$sel:s3BackupDescription:ExtendedS3DestinationDescription', extendedS3DestinationDescription_s3BackupDescription - The configuration for backup in Amazon S3.
$sel:prefix: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:cloudWatchLoggingOptions:ExtendedS3DestinationDescription', extendedS3DestinationDescription_cloudWatchLoggingOptions - The Amazon CloudWatch logging options for your delivery stream.
$sel:errorOutputPrefix: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.
$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. For more information, see
https://docs.aws.amazon.com/firehose/latest/dev/dynamic-partitioning.html
$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:processingConfiguration:ExtendedS3DestinationDescription', extendedS3DestinationDescription_processingConfiguration - The data processing configuration.
$sel:roleARN:ExtendedS3DestinationDescription', extendedS3DestinationDescription_roleARN - The Amazon Resource Name (ARN) of the AWS credentials. For more
information, see
Amazon Resource Names (ARNs) and AWS Service Namespaces.
$sel:bucketARN:ExtendedS3DestinationDescription', extendedS3DestinationDescription_bucketARN - The ARN of the S3 bucket. For more information, see
Amazon Resource Names (ARNs) and AWS Service Namespaces.
$sel:bufferingHints:ExtendedS3DestinationDescription', extendedS3DestinationDescription_bufferingHints - The buffering option.
$sel:compressionFormat:ExtendedS3DestinationDescription', extendedS3DestinationDescription_compressionFormat - The compression format. If no value is specified, the default is
UNCOMPRESSED.
$sel:encryptionConfiguration:ExtendedS3DestinationDescription', extendedS3DestinationDescription_encryptionConfiguration - The encryption configuration. If no value is specified, the default is
no encryption.
extendedS3DestinationDescription_s3BackupMode :: Lens' ExtendedS3DestinationDescription (Maybe S3BackupMode) Source #
The Amazon S3 backup mode.
extendedS3DestinationDescription_s3BackupDescription :: Lens' ExtendedS3DestinationDescription (Maybe S3DestinationDescription) Source #
The configuration for backup in Amazon S3.
extendedS3DestinationDescription_prefix :: Lens' ExtendedS3DestinationDescription (Maybe Text) Source #
The "YYYY/MM/DD/HH" time format prefix is automatically used for delivered Amazon S3 files. You can also specify a custom prefix, as described in Custom Prefixes for Amazon S3 Objects.
extendedS3DestinationDescription_cloudWatchLoggingOptions :: Lens' ExtendedS3DestinationDescription (Maybe CloudWatchLoggingOptions) Source #
The Amazon CloudWatch logging options for your delivery stream.
extendedS3DestinationDescription_errorOutputPrefix :: Lens' ExtendedS3DestinationDescription (Maybe Text) Source #
A prefix that Kinesis Data Firehose evaluates and adds to failed records before writing them to S3. This prefix appears immediately following the bucket name. For information about how to specify this prefix, see Custom Prefixes for Amazon S3 Objects.
extendedS3DestinationDescription_dynamicPartitioningConfiguration :: Lens' ExtendedS3DestinationDescription (Maybe DynamicPartitioningConfiguration) Source #
The configuration of the dynamic partitioning mechanism that creates smaller data sets from the streaming data by partitioning it based on partition keys. Currently, dynamic partitioning is only supported for Amazon S3 destinations. For more information, see https://docs.aws.amazon.com/firehose/latest/dev/dynamic-partitioning.html
extendedS3DestinationDescription_dataFormatConversionConfiguration :: Lens' ExtendedS3DestinationDescription (Maybe DataFormatConversionConfiguration) Source #
The serializer, deserializer, and schema for converting data from the JSON format to the Parquet or ORC format before writing it to Amazon S3.
extendedS3DestinationDescription_processingConfiguration :: Lens' ExtendedS3DestinationDescription (Maybe ProcessingConfiguration) Source #
The data processing configuration.
extendedS3DestinationDescription_roleARN :: Lens' ExtendedS3DestinationDescription Text Source #
The Amazon Resource Name (ARN) of the AWS credentials. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces.
extendedS3DestinationDescription_bucketARN :: Lens' ExtendedS3DestinationDescription Text Source #
The ARN of the S3 bucket. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces.
extendedS3DestinationDescription_bufferingHints :: Lens' ExtendedS3DestinationDescription BufferingHints Source #
The buffering option.
extendedS3DestinationDescription_compressionFormat :: Lens' ExtendedS3DestinationDescription CompressionFormat Source #
The compression format. If no value is specified, the default is
UNCOMPRESSED.
extendedS3DestinationDescription_encryptionConfiguration :: Lens' ExtendedS3DestinationDescription EncryptionConfiguration Source #
The encryption configuration. If no value is specified, the default is no encryption.
ExtendedS3DestinationUpdate
data ExtendedS3DestinationUpdate Source #
Describes an update for a destination in Amazon S3.
See: newExtendedS3DestinationUpdate smart constructor.
Constructors
| ExtendedS3DestinationUpdate' | |
Fields
| |
Instances
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:
$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:prefix: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:cloudWatchLoggingOptions:ExtendedS3DestinationUpdate', extendedS3DestinationUpdate_cloudWatchLoggingOptions - The Amazon CloudWatch logging options for your delivery stream.
$sel:errorOutputPrefix: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.
$sel:s3BackupUpdate:ExtendedS3DestinationUpdate', extendedS3DestinationUpdate_s3BackupUpdate - The Amazon S3 destination for backup.
$sel:encryptionConfiguration:ExtendedS3DestinationUpdate', extendedS3DestinationUpdate_encryptionConfiguration - The encryption configuration. If no value is specified, the default is
no encryption.
$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. For more information, see
https://docs.aws.amazon.com/firehose/latest/dev/dynamic-partitioning.html
$sel:compressionFormat:ExtendedS3DestinationUpdate', extendedS3DestinationUpdate_compressionFormat - The compression format. If no value is specified, the default is
UNCOMPRESSED.
$sel:bufferingHints:ExtendedS3DestinationUpdate', extendedS3DestinationUpdate_bufferingHints - The buffering option.
$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:bucketARN:ExtendedS3DestinationUpdate', extendedS3DestinationUpdate_bucketARN - The ARN of the S3 bucket. For more information, see
Amazon Resource Names (ARNs) and AWS Service Namespaces.
$sel:processingConfiguration:ExtendedS3DestinationUpdate', extendedS3DestinationUpdate_processingConfiguration - The data processing configuration.
$sel:roleARN:ExtendedS3DestinationUpdate', extendedS3DestinationUpdate_roleARN - The Amazon Resource Name (ARN) of the AWS credentials. For more
information, see
Amazon Resource Names (ARNs) and AWS Service Namespaces.
extendedS3DestinationUpdate_s3BackupMode :: Lens' ExtendedS3DestinationUpdate (Maybe S3BackupMode) Source #
You can update a delivery stream to enable Amazon S3 backup if it is disabled. If backup is enabled, you can't update the delivery stream to disable it.
extendedS3DestinationUpdate_prefix :: Lens' ExtendedS3DestinationUpdate (Maybe Text) Source #
The "YYYY/MM/DD/HH" time format prefix is automatically used for delivered Amazon S3 files. You can also specify a custom prefix, as described in Custom Prefixes for Amazon S3 Objects.
extendedS3DestinationUpdate_cloudWatchLoggingOptions :: Lens' ExtendedS3DestinationUpdate (Maybe CloudWatchLoggingOptions) Source #
The Amazon CloudWatch logging options for your delivery stream.
extendedS3DestinationUpdate_errorOutputPrefix :: Lens' ExtendedS3DestinationUpdate (Maybe Text) Source #
A prefix that Kinesis Data Firehose evaluates and adds to failed records before writing them to S3. This prefix appears immediately following the bucket name. For information about how to specify this prefix, see Custom Prefixes for Amazon S3 Objects.
extendedS3DestinationUpdate_s3BackupUpdate :: Lens' ExtendedS3DestinationUpdate (Maybe S3DestinationUpdate) Source #
The Amazon S3 destination for backup.
extendedS3DestinationUpdate_encryptionConfiguration :: Lens' ExtendedS3DestinationUpdate (Maybe EncryptionConfiguration) Source #
The encryption configuration. If no value is specified, the default is no encryption.
extendedS3DestinationUpdate_dynamicPartitioningConfiguration :: Lens' ExtendedS3DestinationUpdate (Maybe DynamicPartitioningConfiguration) Source #
The configuration of the dynamic partitioning mechanism that creates smaller data sets from the streaming data by partitioning it based on partition keys. Currently, dynamic partitioning is only supported for Amazon S3 destinations. For more information, see https://docs.aws.amazon.com/firehose/latest/dev/dynamic-partitioning.html
extendedS3DestinationUpdate_compressionFormat :: Lens' ExtendedS3DestinationUpdate (Maybe CompressionFormat) Source #
The compression format. If no value is specified, the default is
UNCOMPRESSED.
extendedS3DestinationUpdate_bufferingHints :: Lens' ExtendedS3DestinationUpdate (Maybe BufferingHints) Source #
The buffering option.
extendedS3DestinationUpdate_dataFormatConversionConfiguration :: Lens' ExtendedS3DestinationUpdate (Maybe DataFormatConversionConfiguration) Source #
The serializer, deserializer, and schema for converting data from the JSON format to the Parquet or ORC format before writing it to Amazon S3.
extendedS3DestinationUpdate_bucketARN :: Lens' ExtendedS3DestinationUpdate (Maybe Text) Source #
The ARN of the S3 bucket. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces.
extendedS3DestinationUpdate_processingConfiguration :: Lens' ExtendedS3DestinationUpdate (Maybe ProcessingConfiguration) Source #
The data processing configuration.
extendedS3DestinationUpdate_roleARN :: Lens' ExtendedS3DestinationUpdate (Maybe Text) Source #
The Amazon Resource Name (ARN) of the AWS credentials. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces.
FailureDescription
data FailureDescription Source #
Provides details in case one of the following operations fails due to an error related to KMS: CreateDeliveryStream, DeleteDeliveryStream, StartDeliveryStreamEncryption, StopDeliveryStreamEncryption.
See: newFailureDescription smart constructor.
Constructors
| FailureDescription' | |
Fields
| |
Instances
newFailureDescription Source #
Arguments
| :: DeliveryStreamFailureType | |
| -> Text | |
| -> FailureDescription |
Create a value of FailureDescription with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:type':FailureDescription', failureDescription_type - The type of error that caused the failure.
$sel:details:FailureDescription', failureDescription_details - A message providing details about the error that caused the failure.
failureDescription_type :: Lens' FailureDescription DeliveryStreamFailureType Source #
The type of error that caused the failure.
failureDescription_details :: Lens' FailureDescription Text Source #
A message providing details about the error that caused the failure.
HiveJsonSerDe
data HiveJsonSerDe Source #
The native Hive / HCatalog JsonSerDe. Used by Kinesis Data Firehose for deserializing data, which means converting it from the JSON format in preparation for serializing it to the Parquet or ORC format. This is one of two deserializers you can choose, depending on which one offers the functionality you need. The other option is the OpenX SerDe.
See: newHiveJsonSerDe smart constructor.
Constructors
| HiveJsonSerDe' | |
Fields
| |
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.
hiveJsonSerDe_timestampFormats :: Lens' HiveJsonSerDe (Maybe [Text]) Source #
Indicates how you want Kinesis Data Firehose to parse the date and
timestamps that may be present in your input data JSON. To specify these
format strings, follow the pattern syntax of JodaTime's DateTimeFormat
format strings. For more information, see
Class DateTimeFormat.
You can also use the special value millis to parse timestamps in epoch
milliseconds. If you don't specify a format, Kinesis Data Firehose uses
java.sql.Timestamp::valueOf by default.
HttpEndpointBufferingHints
data HttpEndpointBufferingHints Source #
Describes the buffering options that can be applied before data is
delivered to the HTTP endpoint destination. Kinesis Data Firehose treats
these options as hints, and it might choose to use more optimal values.
The SizeInMBs and IntervalInSeconds parameters are optional.
However, if specify a value for one of them, you must also provide a
value for the other.
See: newHttpEndpointBufferingHints smart constructor.
Constructors
| HttpEndpointBufferingHints' | |
Fields
| |
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: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.
$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).
httpEndpointBufferingHints_sizeInMBs :: Lens' HttpEndpointBufferingHints (Maybe Natural) Source #
Buffer incoming data to the specified size, in MBs, before delivering it to the destination. The default value is 5.
We recommend setting this parameter to a value greater than the amount of data you typically ingest into the delivery stream in 10 seconds. For example, if you typically ingest data at 1 MB/sec, the value should be 10 MB or higher.
httpEndpointBufferingHints_intervalInSeconds :: Lens' HttpEndpointBufferingHints (Maybe Natural) Source #
Buffer incoming data for the specified period of time, in seconds, before delivering it to the destination. The default value is 300 (5 minutes).
HttpEndpointCommonAttribute
data HttpEndpointCommonAttribute Source #
Describes the metadata that's delivered to the specified HTTP endpoint destination.
See: newHttpEndpointCommonAttribute smart constructor.
Constructors
| HttpEndpointCommonAttribute' | |
Fields
| |
Instances
newHttpEndpointCommonAttribute Source #
Arguments
| :: 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.
httpEndpointCommonAttribute_attributeName :: Lens' HttpEndpointCommonAttribute Text Source #
The name of the HTTP endpoint common attribute.
httpEndpointCommonAttribute_attributeValue :: Lens' HttpEndpointCommonAttribute Text Source #
The value of the HTTP endpoint common attribute.
HttpEndpointConfiguration
data HttpEndpointConfiguration Source #
Describes the configuration of the HTTP endpoint to which Kinesis Firehose delivers data.
See: newHttpEndpointConfiguration smart constructor.
Constructors
| HttpEndpointConfiguration' | |
Fields
| |
Instances
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:name:HttpEndpointConfiguration', httpEndpointConfiguration_name - The name of the HTTP endpoint selected as the destination.
$sel:accessKey:HttpEndpointConfiguration', httpEndpointConfiguration_accessKey - The access key required for Kinesis Firehose to authenticate with the
HTTP endpoint selected as the destination.
$sel:url:HttpEndpointConfiguration', httpEndpointConfiguration_url - The URL of the HTTP endpoint selected as the destination.
If you choose an HTTP endpoint as your destination, review and follow the instructions in the Appendix - HTTP Endpoint Delivery Request and Response Specifications.
httpEndpointConfiguration_name :: Lens' HttpEndpointConfiguration (Maybe Text) Source #
The name of the HTTP endpoint selected as the destination.
httpEndpointConfiguration_accessKey :: Lens' HttpEndpointConfiguration (Maybe Text) Source #
The access key required for Kinesis Firehose to authenticate with the HTTP endpoint selected as the destination.
httpEndpointConfiguration_url :: Lens' HttpEndpointConfiguration Text Source #
The URL of the HTTP endpoint selected as the destination.
If you choose an HTTP endpoint as your destination, review and follow the instructions in the Appendix - HTTP Endpoint Delivery Request and Response Specifications.
HttpEndpointDescription
data HttpEndpointDescription Source #
Describes the HTTP endpoint selected as the destination.
See: newHttpEndpointDescription smart constructor.
Constructors
| HttpEndpointDescription' | |
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:url:HttpEndpointDescription', httpEndpointDescription_url - The URL of the HTTP endpoint selected as the destination.
$sel:name:HttpEndpointDescription', httpEndpointDescription_name - The name of the HTTP endpoint selected as the destination.
httpEndpointDescription_url :: Lens' HttpEndpointDescription (Maybe Text) Source #
The URL of the HTTP endpoint selected as the destination.
httpEndpointDescription_name :: Lens' HttpEndpointDescription (Maybe Text) Source #
The name of the HTTP endpoint selected as the destination.
HttpEndpointDestinationConfiguration
data HttpEndpointDestinationConfiguration Source #
Describes the configuration of the HTTP endpoint destination.
See: newHttpEndpointDestinationConfiguration smart constructor.
Constructors
| HttpEndpointDestinationConfiguration' | |
Fields
| |
Instances
newHttpEndpointDestinationConfiguration Source #
Arguments
| :: 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:
$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:cloudWatchLoggingOptions:HttpEndpointDestinationConfiguration', httpEndpointDestinationConfiguration_cloudWatchLoggingOptions - Undocumented member.
$sel:bufferingHints: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.
$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.
$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:roleARN:HttpEndpointDestinationConfiguration', httpEndpointDestinationConfiguration_roleARN - Kinesis Data Firehose uses this IAM role for all the permissions that
the delivery stream needs.
$sel:endpointConfiguration:HttpEndpointDestinationConfiguration', httpEndpointDestinationConfiguration_endpointConfiguration - The configuration of the HTTP endpoint selected as the destination.
$sel:s3Configuration:HttpEndpointDestinationConfiguration', httpEndpointDestinationConfiguration_s3Configuration - Undocumented member.
httpEndpointDestinationConfiguration_s3BackupMode :: Lens' HttpEndpointDestinationConfiguration (Maybe HttpEndpointS3BackupMode) Source #
Describes the S3 bucket backup options for the data that Kinesis Data
Firehose delivers to the HTTP endpoint destination. You can back up all
documents (AllData) or only the documents that Kinesis Data Firehose
could not deliver to the specified HTTP endpoint destination
(FailedDataOnly).
httpEndpointDestinationConfiguration_cloudWatchLoggingOptions :: Lens' HttpEndpointDestinationConfiguration (Maybe CloudWatchLoggingOptions) Source #
Undocumented member.
httpEndpointDestinationConfiguration_bufferingHints :: Lens' HttpEndpointDestinationConfiguration (Maybe HttpEndpointBufferingHints) Source #
The buffering options that can be used before data is delivered to the
specified destination. Kinesis Data Firehose treats these options as
hints, and it might choose to use more optimal values. The SizeInMBs
and IntervalInSeconds parameters are optional. However, if you specify
a value for one of them, you must also provide a value for the other.
httpEndpointDestinationConfiguration_retryOptions :: Lens' HttpEndpointDestinationConfiguration (Maybe HttpEndpointRetryOptions) Source #
Describes the retry behavior in case Kinesis Data Firehose is unable to deliver data to the specified HTTP endpoint destination, or if it doesn't receive a valid acknowledgment of receipt from the specified HTTP endpoint destination.
httpEndpointDestinationConfiguration_processingConfiguration :: Lens' HttpEndpointDestinationConfiguration (Maybe ProcessingConfiguration) Source #
Undocumented member.
httpEndpointDestinationConfiguration_requestConfiguration :: Lens' HttpEndpointDestinationConfiguration (Maybe HttpEndpointRequestConfiguration) Source #
The configuration of the requeste sent to the HTTP endpoint specified as the destination.
httpEndpointDestinationConfiguration_roleARN :: Lens' HttpEndpointDestinationConfiguration (Maybe Text) Source #
Kinesis Data Firehose uses this IAM role for all the permissions that the delivery stream needs.
httpEndpointDestinationConfiguration_endpointConfiguration :: Lens' HttpEndpointDestinationConfiguration HttpEndpointConfiguration Source #
The configuration of the HTTP endpoint selected as the destination.
httpEndpointDestinationConfiguration_s3Configuration :: Lens' HttpEndpointDestinationConfiguration S3DestinationConfiguration Source #
Undocumented member.
HttpEndpointDestinationDescription
data HttpEndpointDestinationDescription Source #
Describes the HTTP endpoint destination.
See: newHttpEndpointDestinationDescription smart constructor.
Constructors
| HttpEndpointDestinationDescription' | |
Fields
| |
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:
$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:cloudWatchLoggingOptions:HttpEndpointDestinationDescription', httpEndpointDestinationDescription_cloudWatchLoggingOptions - Undocumented member.
$sel:s3DestinationDescription:HttpEndpointDestinationDescription', httpEndpointDestinationDescription_s3DestinationDescription - Undocumented member.
$sel:bufferingHints: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.
$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.
$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:roleARN:HttpEndpointDestinationDescription', httpEndpointDestinationDescription_roleARN - Kinesis Data Firehose uses this IAM role for all the permissions that
the delivery stream needs.
httpEndpointDestinationDescription_s3BackupMode :: Lens' HttpEndpointDestinationDescription (Maybe HttpEndpointS3BackupMode) Source #
Describes the S3 bucket backup options for the data that Kinesis
Firehose delivers to the HTTP endpoint destination. You can back up all
documents (AllData) or only the documents that Kinesis Data Firehose
could not deliver to the specified HTTP endpoint destination
(FailedDataOnly).
httpEndpointDestinationDescription_cloudWatchLoggingOptions :: Lens' HttpEndpointDestinationDescription (Maybe CloudWatchLoggingOptions) Source #
Undocumented member.
httpEndpointDestinationDescription_s3DestinationDescription :: Lens' HttpEndpointDestinationDescription (Maybe S3DestinationDescription) Source #
Undocumented member.
httpEndpointDestinationDescription_bufferingHints :: Lens' HttpEndpointDestinationDescription (Maybe HttpEndpointBufferingHints) Source #
Describes buffering options that can be applied to the data before it is
delivered to the HTTPS endpoint destination. Kinesis Data Firehose teats
these options as hints, and it might choose to use more optimal values.
The SizeInMBs and IntervalInSeconds parameters are optional.
However, if specify a value for one of them, you must also provide a
value for the other.
httpEndpointDestinationDescription_retryOptions :: Lens' HttpEndpointDestinationDescription (Maybe HttpEndpointRetryOptions) Source #
Describes the retry behavior in case Kinesis Data Firehose is unable to deliver data to the specified HTTP endpoint destination, or if it doesn't receive a valid acknowledgment of receipt from the specified HTTP endpoint destination.
httpEndpointDestinationDescription_endpointConfiguration :: Lens' HttpEndpointDestinationDescription (Maybe HttpEndpointDescription) Source #
The configuration of the specified HTTP endpoint destination.
httpEndpointDestinationDescription_processingConfiguration :: Lens' HttpEndpointDestinationDescription (Maybe ProcessingConfiguration) Source #
Undocumented member.
httpEndpointDestinationDescription_requestConfiguration :: Lens' HttpEndpointDestinationDescription (Maybe HttpEndpointRequestConfiguration) Source #
The configuration of request sent to the HTTP endpoint specified as the destination.
httpEndpointDestinationDescription_roleARN :: Lens' HttpEndpointDestinationDescription (Maybe Text) Source #
Kinesis Data Firehose uses this IAM role for all the permissions that the delivery stream needs.
HttpEndpointDestinationUpdate
data HttpEndpointDestinationUpdate Source #
Updates the specified HTTP endpoint destination.
See: newHttpEndpointDestinationUpdate smart constructor.
Constructors
| HttpEndpointDestinationUpdate' | |
Fields
| |
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:
$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:cloudWatchLoggingOptions:HttpEndpointDestinationUpdate', httpEndpointDestinationUpdate_cloudWatchLoggingOptions - Undocumented member.
$sel:s3Update:HttpEndpointDestinationUpdate', httpEndpointDestinationUpdate_s3Update - Undocumented member.
$sel:bufferingHints: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.
$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.
$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:roleARN:HttpEndpointDestinationUpdate', httpEndpointDestinationUpdate_roleARN - Kinesis Data Firehose uses this IAM role for all the permissions that
the delivery stream needs.
httpEndpointDestinationUpdate_s3BackupMode :: Lens' HttpEndpointDestinationUpdate (Maybe HttpEndpointS3BackupMode) Source #
Describes the S3 bucket backup options for the data that Kinesis
Firehose delivers to the HTTP endpoint destination. You can back up all
documents (AllData) or only the documents that Kinesis Data Firehose
could not deliver to the specified HTTP endpoint destination
(FailedDataOnly).
httpEndpointDestinationUpdate_cloudWatchLoggingOptions :: Lens' HttpEndpointDestinationUpdate (Maybe CloudWatchLoggingOptions) Source #
Undocumented member.
httpEndpointDestinationUpdate_s3Update :: Lens' HttpEndpointDestinationUpdate (Maybe S3DestinationUpdate) Source #
Undocumented member.
httpEndpointDestinationUpdate_bufferingHints :: Lens' HttpEndpointDestinationUpdate (Maybe HttpEndpointBufferingHints) Source #
Describes buffering options that can be applied to the data before it is
delivered to the HTTPS endpoint destination. Kinesis Data Firehose teats
these options as hints, and it might choose to use more optimal values.
The SizeInMBs and IntervalInSeconds parameters are optional.
However, if specify a value for one of them, you must also provide a
value for the other.
httpEndpointDestinationUpdate_retryOptions :: Lens' HttpEndpointDestinationUpdate (Maybe HttpEndpointRetryOptions) Source #
Describes the retry behavior in case Kinesis Data Firehose is unable to deliver data to the specified HTTP endpoint destination, or if it doesn't receive a valid acknowledgment of receipt from the specified HTTP endpoint destination.
httpEndpointDestinationUpdate_endpointConfiguration :: Lens' HttpEndpointDestinationUpdate (Maybe HttpEndpointConfiguration) Source #
Describes the configuration of the HTTP endpoint destination.
httpEndpointDestinationUpdate_processingConfiguration :: Lens' HttpEndpointDestinationUpdate (Maybe ProcessingConfiguration) Source #
Undocumented member.
httpEndpointDestinationUpdate_requestConfiguration :: Lens' HttpEndpointDestinationUpdate (Maybe HttpEndpointRequestConfiguration) Source #
The configuration of the request sent to the HTTP endpoint specified as the destination.
httpEndpointDestinationUpdate_roleARN :: Lens' HttpEndpointDestinationUpdate (Maybe Text) Source #
Kinesis Data Firehose uses this IAM role for all the permissions that the delivery stream needs.
HttpEndpointRequestConfiguration
data HttpEndpointRequestConfiguration Source #
The configuration of the HTTP endpoint request.
See: newHttpEndpointRequestConfiguration smart constructor.
Constructors
| HttpEndpointRequestConfiguration' | |
Fields
| |
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.
httpEndpointRequestConfiguration_commonAttributes :: Lens' HttpEndpointRequestConfiguration (Maybe [HttpEndpointCommonAttribute]) Source #
Describes the metadata sent to the HTTP endpoint destination.
httpEndpointRequestConfiguration_contentEncoding :: Lens' HttpEndpointRequestConfiguration (Maybe ContentEncoding) Source #
Kinesis Data Firehose uses the content encoding to compress the body of a request before sending the request to the destination. For more information, see Content-Encoding in MDN Web Docs, the official Mozilla documentation.
HttpEndpointRetryOptions
data HttpEndpointRetryOptions Source #
Describes the retry behavior in case Kinesis Data Firehose is unable to deliver data to the specified HTTP endpoint destination, or if it doesn't receive a valid acknowledgment of receipt from the specified HTTP endpoint destination.
See: newHttpEndpointRetryOptions smart constructor.
Constructors
| HttpEndpointRetryOptions' | |
Fields
| |
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.
httpEndpointRetryOptions_durationInSeconds :: Lens' HttpEndpointRetryOptions (Maybe Natural) Source #
The total amount of time that Kinesis Data Firehose spends on retries. This duration starts after the initial attempt to send data to the custom destination via HTTPS endpoint fails. It doesn't include the periods during which Kinesis Data Firehose waits for acknowledgment from the specified destination after each attempt.
InputFormatConfiguration
data InputFormatConfiguration Source #
Specifies the deserializer you want to use to convert the format of the
input data. This parameter is required if Enabled is set to true.
See: newInputFormatConfiguration smart constructor.
Constructors
| InputFormatConfiguration' | |
Fields
| |
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.
inputFormatConfiguration_deserializer :: Lens' InputFormatConfiguration (Maybe Deserializer) Source #
Specifies which deserializer to use. You can choose either the Apache Hive JSON SerDe or the OpenX JSON SerDe. If both are non-null, the server rejects the request.
KMSEncryptionConfig
data KMSEncryptionConfig Source #
Describes an encryption key for a destination in Amazon S3.
See: newKMSEncryptionConfig smart constructor.
Constructors
| KMSEncryptionConfig' | |
Fields
| |
Instances
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 AWS Region as the destination Amazon S3 bucket. For more
information, see
Amazon Resource Names (ARNs) and AWS Service Namespaces.
kmsEncryptionConfig_aWSKMSKeyARN :: Lens' KMSEncryptionConfig Text Source #
The Amazon Resource Name (ARN) of the encryption key. Must belong to the same AWS Region as the destination Amazon S3 bucket. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces.
KinesisStreamSourceConfiguration
data KinesisStreamSourceConfiguration Source #
The stream and role Amazon Resource Names (ARNs) for a Kinesis data stream used as the source for a delivery stream.
See: newKinesisStreamSourceConfiguration smart constructor.
Constructors
| KinesisStreamSourceConfiguration' | |
Fields
| |
Instances
newKinesisStreamSourceConfiguration Source #
Arguments
| :: Text | |
| -> Text | |
| -> KinesisStreamSourceConfiguration |
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
AWS Identity and Access Management (IAM) ARN Format.
kinesisStreamSourceConfiguration_kinesisStreamARN :: Lens' KinesisStreamSourceConfiguration Text Source #
The ARN of the source Kinesis data stream. For more information, see Amazon Kinesis Data Streams ARN Format.
kinesisStreamSourceConfiguration_roleARN :: Lens' KinesisStreamSourceConfiguration Text Source #
The ARN of the role that provides access to the source Kinesis data stream. For more information, see AWS Identity and Access Management (IAM) ARN Format.
KinesisStreamSourceDescription
data KinesisStreamSourceDescription Source #
Details about a Kinesis data stream used as the source for a Kinesis Data Firehose delivery stream.
See: newKinesisStreamSourceDescription smart constructor.
Constructors
| KinesisStreamSourceDescription' | |
Fields
| |
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
AWS Identity and Access Management (IAM) ARN Format.
kinesisStreamSourceDescription_deliveryStartTimestamp :: Lens' KinesisStreamSourceDescription (Maybe UTCTime) Source #
Kinesis Data Firehose starts retrieving records from the Kinesis data stream starting with this timestamp.
kinesisStreamSourceDescription_kinesisStreamARN :: Lens' KinesisStreamSourceDescription (Maybe Text) Source #
The Amazon Resource Name (ARN) of the source Kinesis data stream. For more information, see Amazon Kinesis Data Streams ARN Format.
kinesisStreamSourceDescription_roleARN :: Lens' KinesisStreamSourceDescription (Maybe Text) Source #
The ARN of the role used by the source Kinesis data stream. For more information, see AWS Identity and Access Management (IAM) ARN Format.
OpenXJsonSerDe
data OpenXJsonSerDe Source #
The OpenX SerDe. Used by Kinesis Data Firehose for deserializing data, which means converting it from the JSON format in preparation for serializing it to the Parquet or ORC format. This is one of two deserializers you can choose, depending on which one offers the functionality you need. The other option is the native Hive / HCatalog JsonSerDe.
See: newOpenXJsonSerDe smart constructor.
Constructors
| OpenXJsonSerDe' | |
Fields
| |
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: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:caseInsensitive:OpenXJsonSerDe', openXJsonSerDe_caseInsensitive - When set to true, which is the default, Kinesis Data Firehose converts
JSON keys to lowercase before deserializing them.
$sel:convertDotsInJsonKeysToUnderscores:OpenXJsonSerDe', openXJsonSerDe_convertDotsInJsonKeysToUnderscores - When set to true, specifies that the names of the keys include dots
and that you want Kinesis Data Firehose to replace them with
underscores. This is useful because Apache Hive does not allow dots in
column names. For example, if the JSON contains a key whose name is
"a.b", you can define the column name to be "a_b" when using this
option.
The default is false.
openXJsonSerDe_columnToJsonKeyMappings :: Lens' OpenXJsonSerDe (Maybe (HashMap Text Text)) Source #
Maps column names to JSON keys that aren't identical to the column
names. This is useful when the JSON contains keys that are Hive
keywords. For example, timestamp is a Hive keyword. If you have a JSON
key named timestamp, set this parameter to {"ts": "timestamp"}
to map this key to a column named ts.
openXJsonSerDe_caseInsensitive :: Lens' OpenXJsonSerDe (Maybe Bool) Source #
When set to true, which is the default, Kinesis Data Firehose converts
JSON keys to lowercase before deserializing them.
openXJsonSerDe_convertDotsInJsonKeysToUnderscores :: Lens' OpenXJsonSerDe (Maybe Bool) Source #
When set to true, specifies that the names of the keys include dots
and that you want Kinesis Data Firehose to replace them with
underscores. This is useful because Apache Hive does not allow dots in
column names. For example, if the JSON contains a key whose name is
"a.b", you can define the column name to be "a_b" when using this
option.
The default is false.
OrcSerDe
A serializer to use for converting data to the ORC format before storing it in Amazon S3. For more information, see Apache ORC.
See: newOrcSerDe smart constructor.
Constructors
| OrcSerDe' | |
Fields
| |
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: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: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:compression:OrcSerDe', orcSerDe_compression - The compression code to use over data blocks. The default is SNAPPY.
$sel:bloomFilterColumns:OrcSerDe', orcSerDe_bloomFilterColumns - The column names for which you want Kinesis Data Firehose to create
bloom filters. The default is null.
$sel:rowIndexStride:OrcSerDe', orcSerDe_rowIndexStride - The number of rows between index entries. The default is 10,000 and the
minimum is 1,000.
$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: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:stripeSizeBytes:OrcSerDe', orcSerDe_stripeSizeBytes - The number of bytes in each stripe. The default is 64 MiB and the
minimum is 8 MiB.
$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.
orcSerDe_bloomFilterFalsePositiveProbability :: Lens' OrcSerDe (Maybe Double) Source #
The Bloom filter false positive probability (FPP). The lower the FPP, the bigger the Bloom filter. The default value is 0.05, the minimum is 0, and the maximum is 1.
orcSerDe_dictionaryKeyThreshold :: Lens' OrcSerDe (Maybe Double) Source #
Represents the fraction of the total number of non-null rows. To turn off dictionary encoding, set this fraction to a number that is less than the number of distinct keys in a dictionary. To always use dictionary encoding, set this threshold to 1.
orcSerDe_enablePadding :: Lens' OrcSerDe (Maybe Bool) Source #
Set this to true to indicate that you want stripes to be padded to the
HDFS block boundaries. This is useful if you intend to copy the data
from Amazon S3 to HDFS before querying. The default is false.
orcSerDe_compression :: Lens' OrcSerDe (Maybe OrcCompression) Source #
The compression code to use over data blocks. The default is SNAPPY.
orcSerDe_bloomFilterColumns :: Lens' OrcSerDe (Maybe [Text]) Source #
The column names for which you want Kinesis Data Firehose to create
bloom filters. The default is null.
orcSerDe_rowIndexStride :: Lens' OrcSerDe (Maybe Natural) Source #
The number of rows between index entries. The default is 10,000 and the minimum is 1,000.
orcSerDe_formatVersion :: Lens' OrcSerDe (Maybe OrcFormatVersion) Source #
The version of the file to write. The possible values are V0_11 and
V0_12. The default is V0_12.
orcSerDe_blockSizeBytes :: Lens' OrcSerDe (Maybe Natural) Source #
The Hadoop Distributed File System (HDFS) block size. This is useful if you intend to copy the data from Amazon S3 to HDFS before querying. The default is 256 MiB and the minimum is 64 MiB. Kinesis Data Firehose uses this value for padding calculations.
orcSerDe_stripeSizeBytes :: Lens' OrcSerDe (Maybe Natural) Source #
The number of bytes in each stripe. The default is 64 MiB and the minimum is 8 MiB.
orcSerDe_paddingTolerance :: Lens' OrcSerDe (Maybe Double) Source #
A number between 0 and 1 that defines the tolerance for block padding as a decimal fraction of stripe size. The default value is 0.05, which means 5 percent of stripe size.
For the default values of 64 MiB ORC stripes and 256 MiB HDFS blocks, the default block padding tolerance of 5 percent reserves a maximum of 3.2 MiB for padding within the 256 MiB block. In such a case, if the available size within the block is more than 3.2 MiB, a new, smaller stripe is inserted to fit within that space. This ensures that no stripe crosses block boundaries and causes remote reads within a node-local task.
Kinesis Data Firehose ignores this parameter when OrcSerDe$EnablePadding
is false.
OutputFormatConfiguration
data OutputFormatConfiguration Source #
Specifies the serializer that you want Kinesis Data Firehose to use to
convert the format of your data before it writes it to Amazon S3. This
parameter is required if Enabled is set to true.
See: newOutputFormatConfiguration smart constructor.
Constructors
| OutputFormatConfiguration' | |
Fields
| |
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.
outputFormatConfiguration_serializer :: Lens' OutputFormatConfiguration (Maybe Serializer) Source #
Specifies which serializer to use. You can choose either the ORC SerDe or the Parquet SerDe. If both are non-null, the server rejects the request.
ParquetSerDe
data ParquetSerDe Source #
A serializer to use for converting data to the Parquet format before storing it in Amazon S3. For more information, see Apache Parquet.
See: newParquetSerDe smart constructor.
Constructors
| ParquetSerDe' | |
Fields
| |
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:writerVersion:ParquetSerDe', parquetSerDe_writerVersion - Indicates the version of row format to output. The possible values are
V1 and V2. The default is V1.
$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: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:enableDictionaryCompression:ParquetSerDe', parquetSerDe_enableDictionaryCompression - Indicates whether to enable dictionary compression.
$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: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.
parquetSerDe_writerVersion :: Lens' ParquetSerDe (Maybe ParquetWriterVersion) Source #
Indicates the version of row format to output. The possible values are
V1 and V2. The default is V1.
parquetSerDe_compression :: Lens' ParquetSerDe (Maybe ParquetCompression) Source #
The compression code to use over data blocks. The possible values are
UNCOMPRESSED, SNAPPY, and GZIP, with the default being SNAPPY.
Use SNAPPY for higher decompression speed. Use GZIP if the
compression ratio is more important than speed.
parquetSerDe_maxPaddingBytes :: Lens' ParquetSerDe (Maybe Natural) Source #
The maximum amount of padding to apply. This is useful if you intend to copy the data from Amazon S3 to HDFS before querying. The default is 0.
parquetSerDe_enableDictionaryCompression :: Lens' ParquetSerDe (Maybe Bool) Source #
Indicates whether to enable dictionary compression.
parquetSerDe_pageSizeBytes :: Lens' ParquetSerDe (Maybe Natural) Source #
The Parquet page size. Column chunks are divided into pages. A page is conceptually an indivisible unit (in terms of compression and encoding). The minimum value is 64 KiB and the default is 1 MiB.
parquetSerDe_blockSizeBytes :: Lens' ParquetSerDe (Maybe Natural) Source #
The Hadoop Distributed File System (HDFS) block size. This is useful if you intend to copy the data from Amazon S3 to HDFS before querying. The default is 256 MiB and the minimum is 64 MiB. Kinesis Data Firehose uses this value for padding calculations.
ProcessingConfiguration
data ProcessingConfiguration Source #
Describes a data processing configuration.
See: newProcessingConfiguration smart constructor.
Constructors
| ProcessingConfiguration' | |
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.
processingConfiguration_enabled :: Lens' ProcessingConfiguration (Maybe Bool) Source #
Enables or disables data processing.
processingConfiguration_processors :: Lens' ProcessingConfiguration (Maybe [Processor]) Source #
The data processors.
Processor
Describes a data processor.
See: newProcessor smart constructor.
Constructors
| Processor' | |
Fields
| |
Instances
| Eq Processor Source # | |
| Read Processor Source # | |
| Show Processor Source # | |
| Generic Processor Source # | |
| NFData Processor Source # | |
Defined in Amazonka.Firehose.Types.Processor | |
| Hashable Processor Source # | |
Defined in Amazonka.Firehose.Types.Processor | |
| ToJSON Processor Source # | |
Defined in Amazonka.Firehose.Types.Processor | |
| FromJSON Processor Source # | |
| type Rep Processor Source # | |
Defined in Amazonka.Firehose.Types.Processor type Rep Processor = D1 ('MetaData "Processor" "Amazonka.Firehose.Types.Processor" "libZSservicesZSamazonka-kinesis-firehoseZSamazonka-kinesis-firehose" '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))) | |
Arguments
| :: ProcessorType | |
| -> Processor |
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.
processor_parameters :: Lens' Processor (Maybe [ProcessorParameter]) Source #
The processor parameters.
processor_type :: Lens' Processor ProcessorType Source #
The type of processor.
ProcessorParameter
data ProcessorParameter Source #
Describes the processor parameter.
See: newProcessorParameter smart constructor.
Constructors
| ProcessorParameter' | |
Fields
| |
Instances
newProcessorParameter Source #
Arguments
| :: ProcessorParameterName | |
| -> Text | |
| -> ProcessorParameter |
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.
$sel:parameterValue:ProcessorParameter', processorParameter_parameterValue - The parameter value.
processorParameter_parameterName :: Lens' ProcessorParameter ProcessorParameterName Source #
The name of the parameter.
processorParameter_parameterValue :: Lens' ProcessorParameter Text Source #
The parameter value.
PutRecordBatchResponseEntry
data PutRecordBatchResponseEntry Source #
Contains the result for an individual record from a PutRecordBatch request. If the record is successfully added to your delivery stream, it receives a record ID. If the record fails to be added to your delivery stream, the result includes an error code and an error message.
See: newPutRecordBatchResponseEntry smart constructor.
Constructors
| PutRecordBatchResponseEntry' | |
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:recordId:PutRecordBatchResponseEntry', putRecordBatchResponseEntry_recordId - The ID of the record.
$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.
putRecordBatchResponseEntry_recordId :: Lens' PutRecordBatchResponseEntry (Maybe Text) Source #
The ID of the record.
putRecordBatchResponseEntry_errorCode :: Lens' PutRecordBatchResponseEntry (Maybe Text) Source #
The error code for an individual record result.
putRecordBatchResponseEntry_errorMessage :: Lens' PutRecordBatchResponseEntry (Maybe Text) Source #
The error message for an individual record result.
Record
The unit of data in a delivery stream.
See: newRecord smart constructor.
Constructors
| Record' | |
Instances
| Eq Record Source # | |
| Read Record Source # | |
| Show Record Source # | |
| Generic Record Source # | |
| NFData Record Source # | |
Defined in Amazonka.Firehose.Types.Record | |
| Hashable Record Source # | |
Defined in Amazonka.Firehose.Types.Record | |
| ToJSON Record Source # | |
Defined in Amazonka.Firehose.Types.Record | |
| type Rep Record Source # | |
Defined in Amazonka.Firehose.Types.Record | |
Arguments
| :: ByteString | |
| -> 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.
record_data :: Lens' Record ByteString Source #
The data blob, which is base64-encoded when the blob is serialized. The
maximum size of the data blob, before base64-encoding, is 1,000 KiB.--
-- Note: This Lens automatically encodes and decodes Base64 data.
-- The underlying isomorphism will encode to Base64 representation during
-- serialisation, and decode from Base64 representation during deserialisation.
-- This Lens accepts and returns only raw unencoded data.
RedshiftDestinationConfiguration
data RedshiftDestinationConfiguration Source #
Describes the configuration of a destination in Amazon Redshift.
See: newRedshiftDestinationConfiguration smart constructor.
Constructors
| RedshiftDestinationConfiguration' | |
Fields
| |
Instances
newRedshiftDestinationConfiguration Source #
Arguments
| :: 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:
$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.
$sel:cloudWatchLoggingOptions:RedshiftDestinationConfiguration', redshiftDestinationConfiguration_cloudWatchLoggingOptions - The CloudWatch logging options for your delivery stream.
$sel:s3BackupConfiguration:RedshiftDestinationConfiguration', redshiftDestinationConfiguration_s3BackupConfiguration - The configuration for backup in Amazon S3.
$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:processingConfiguration:RedshiftDestinationConfiguration', redshiftDestinationConfiguration_processingConfiguration - The data processing configuration.
$sel:roleARN:RedshiftDestinationConfiguration', redshiftDestinationConfiguration_roleARN - The Amazon Resource Name (ARN) of the AWS credentials. For more
information, see
Amazon Resource Names (ARNs) and AWS Service Namespaces.
$sel:clusterJDBCURL:RedshiftDestinationConfiguration', redshiftDestinationConfiguration_clusterJDBCURL - The database connection string.
$sel:copyCommand:RedshiftDestinationConfiguration', redshiftDestinationConfiguration_copyCommand - The COPY command.
$sel:username:RedshiftDestinationConfiguration', redshiftDestinationConfiguration_username - The name of the user.
$sel:password:RedshiftDestinationConfiguration', redshiftDestinationConfiguration_password - The user password.
$sel:s3Configuration:RedshiftDestinationConfiguration', redshiftDestinationConfiguration_s3Configuration - The configuration for the intermediate Amazon S3 location from which
Amazon Redshift obtains data. Restrictions are described in the topic
for CreateDeliveryStream.
The compression formats SNAPPY or ZIP cannot be specified in
RedshiftDestinationConfiguration.S3Configuration because the Amazon
Redshift COPY operation that reads from the S3 bucket doesn't support
these compression formats.
redshiftDestinationConfiguration_s3BackupMode :: Lens' RedshiftDestinationConfiguration (Maybe RedshiftS3BackupMode) Source #
The Amazon S3 backup mode. After you create a delivery stream, you can update it to enable Amazon S3 backup if it is disabled. If backup is enabled, you can't update the delivery stream to disable it.
redshiftDestinationConfiguration_cloudWatchLoggingOptions :: Lens' RedshiftDestinationConfiguration (Maybe CloudWatchLoggingOptions) Source #
The CloudWatch logging options for your delivery stream.
redshiftDestinationConfiguration_s3BackupConfiguration :: Lens' RedshiftDestinationConfiguration (Maybe S3DestinationConfiguration) Source #
The configuration for backup in Amazon S3.
redshiftDestinationConfiguration_retryOptions :: Lens' RedshiftDestinationConfiguration (Maybe RedshiftRetryOptions) Source #
The retry behavior in case Kinesis Data Firehose is unable to deliver documents to Amazon Redshift. Default value is 3600 (60 minutes).
redshiftDestinationConfiguration_processingConfiguration :: Lens' RedshiftDestinationConfiguration (Maybe ProcessingConfiguration) Source #
The data processing configuration.
redshiftDestinationConfiguration_roleARN :: Lens' RedshiftDestinationConfiguration Text Source #
The Amazon Resource Name (ARN) of the AWS credentials. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces.
redshiftDestinationConfiguration_clusterJDBCURL :: Lens' RedshiftDestinationConfiguration Text Source #
The database connection string.
redshiftDestinationConfiguration_copyCommand :: Lens' RedshiftDestinationConfiguration CopyCommand Source #
The COPY command.
redshiftDestinationConfiguration_username :: Lens' RedshiftDestinationConfiguration Text Source #
The name of the user.
redshiftDestinationConfiguration_password :: Lens' RedshiftDestinationConfiguration Text Source #
The user password.
redshiftDestinationConfiguration_s3Configuration :: Lens' RedshiftDestinationConfiguration S3DestinationConfiguration Source #
The configuration for the intermediate Amazon S3 location from which Amazon Redshift obtains data. Restrictions are described in the topic for CreateDeliveryStream.
The compression formats SNAPPY or ZIP cannot be specified in
RedshiftDestinationConfiguration.S3Configuration because the Amazon
Redshift COPY operation that reads from the S3 bucket doesn't support
these compression formats.
RedshiftDestinationDescription
data RedshiftDestinationDescription Source #
Describes a destination in Amazon Redshift.
See: newRedshiftDestinationDescription smart constructor.
Constructors
| RedshiftDestinationDescription' | |
Fields
| |
Instances
newRedshiftDestinationDescription Source #
Arguments
| :: 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:
$sel:s3BackupMode:RedshiftDestinationDescription', redshiftDestinationDescription_s3BackupMode - The Amazon S3 backup mode.
$sel:s3BackupDescription:RedshiftDestinationDescription', redshiftDestinationDescription_s3BackupDescription - The configuration for backup in Amazon S3.
$sel:cloudWatchLoggingOptions:RedshiftDestinationDescription', redshiftDestinationDescription_cloudWatchLoggingOptions - The Amazon CloudWatch logging options for your delivery stream.
$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:processingConfiguration:RedshiftDestinationDescription', redshiftDestinationDescription_processingConfiguration - The data processing configuration.
$sel:roleARN:RedshiftDestinationDescription', redshiftDestinationDescription_roleARN - The Amazon Resource Name (ARN) of the AWS credentials. For more
information, see
Amazon Resource Names (ARNs) and AWS Service Namespaces.
$sel:clusterJDBCURL:RedshiftDestinationDescription', redshiftDestinationDescription_clusterJDBCURL - The database connection string.
$sel:copyCommand:RedshiftDestinationDescription', redshiftDestinationDescription_copyCommand - The COPY command.
$sel:username:RedshiftDestinationDescription', redshiftDestinationDescription_username - The name of the user.
$sel:s3DestinationDescription:RedshiftDestinationDescription', redshiftDestinationDescription_s3DestinationDescription - The Amazon S3 destination.
redshiftDestinationDescription_s3BackupMode :: Lens' RedshiftDestinationDescription (Maybe RedshiftS3BackupMode) Source #
The Amazon S3 backup mode.
redshiftDestinationDescription_s3BackupDescription :: Lens' RedshiftDestinationDescription (Maybe S3DestinationDescription) Source #
The configuration for backup in Amazon S3.
redshiftDestinationDescription_cloudWatchLoggingOptions :: Lens' RedshiftDestinationDescription (Maybe CloudWatchLoggingOptions) Source #
The Amazon CloudWatch logging options for your delivery stream.
redshiftDestinationDescription_retryOptions :: Lens' RedshiftDestinationDescription (Maybe RedshiftRetryOptions) Source #
The retry behavior in case Kinesis Data Firehose is unable to deliver documents to Amazon Redshift. Default value is 3600 (60 minutes).
redshiftDestinationDescription_processingConfiguration :: Lens' RedshiftDestinationDescription (Maybe ProcessingConfiguration) Source #
The data processing configuration.
redshiftDestinationDescription_roleARN :: Lens' RedshiftDestinationDescription Text Source #
The Amazon Resource Name (ARN) of the AWS credentials. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces.
redshiftDestinationDescription_clusterJDBCURL :: Lens' RedshiftDestinationDescription Text Source #
The database connection string.
redshiftDestinationDescription_copyCommand :: Lens' RedshiftDestinationDescription CopyCommand Source #
The COPY command.
redshiftDestinationDescription_username :: Lens' RedshiftDestinationDescription Text Source #
The name of the user.
redshiftDestinationDescription_s3DestinationDescription :: Lens' RedshiftDestinationDescription S3DestinationDescription Source #
The Amazon S3 destination.
RedshiftDestinationUpdate
data RedshiftDestinationUpdate Source #
Describes an update for a destination in Amazon Redshift.
See: newRedshiftDestinationUpdate smart constructor.
Constructors
| RedshiftDestinationUpdate' | |
Fields
| |
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:
$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:cloudWatchLoggingOptions:RedshiftDestinationUpdate', redshiftDestinationUpdate_cloudWatchLoggingOptions - The Amazon CloudWatch logging options for your delivery stream.
$sel:username:RedshiftDestinationUpdate', redshiftDestinationUpdate_username - The name of the user.
$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:password:RedshiftDestinationUpdate', redshiftDestinationUpdate_password - The user password.
$sel:s3BackupUpdate:RedshiftDestinationUpdate', redshiftDestinationUpdate_s3BackupUpdate - The Amazon S3 destination for backup.
$sel:copyCommand:RedshiftDestinationUpdate', redshiftDestinationUpdate_copyCommand - The COPY command.
$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).
$sel:processingConfiguration:RedshiftDestinationUpdate', redshiftDestinationUpdate_processingConfiguration - The data processing configuration.
$sel:clusterJDBCURL:RedshiftDestinationUpdate', redshiftDestinationUpdate_clusterJDBCURL - The database connection string.
$sel:roleARN:RedshiftDestinationUpdate', redshiftDestinationUpdate_roleARN - The Amazon Resource Name (ARN) of the AWS credentials. For more
information, see
Amazon Resource Names (ARNs) and AWS Service Namespaces.
redshiftDestinationUpdate_s3BackupMode :: Lens' RedshiftDestinationUpdate (Maybe RedshiftS3BackupMode) Source #
You can update a delivery stream to enable Amazon S3 backup if it is disabled. If backup is enabled, you can't update the delivery stream to disable it.
redshiftDestinationUpdate_cloudWatchLoggingOptions :: Lens' RedshiftDestinationUpdate (Maybe CloudWatchLoggingOptions) Source #
The Amazon CloudWatch logging options for your delivery stream.
redshiftDestinationUpdate_username :: Lens' RedshiftDestinationUpdate (Maybe Text) Source #
The name of the user.
redshiftDestinationUpdate_s3Update :: Lens' RedshiftDestinationUpdate (Maybe S3DestinationUpdate) Source #
The Amazon S3 destination.
The compression formats SNAPPY or ZIP cannot be specified in
RedshiftDestinationUpdate.S3Update because the Amazon Redshift COPY
operation that reads from the S3 bucket doesn't support these
compression formats.
redshiftDestinationUpdate_password :: Lens' RedshiftDestinationUpdate (Maybe Text) Source #
The user password.
redshiftDestinationUpdate_s3BackupUpdate :: Lens' RedshiftDestinationUpdate (Maybe S3DestinationUpdate) Source #
The Amazon S3 destination for backup.
redshiftDestinationUpdate_copyCommand :: Lens' RedshiftDestinationUpdate (Maybe CopyCommand) Source #
The COPY command.
redshiftDestinationUpdate_retryOptions :: Lens' RedshiftDestinationUpdate (Maybe RedshiftRetryOptions) Source #
The retry behavior in case Kinesis Data Firehose is unable to deliver documents to Amazon Redshift. Default value is 3600 (60 minutes).
redshiftDestinationUpdate_processingConfiguration :: Lens' RedshiftDestinationUpdate (Maybe ProcessingConfiguration) Source #
The data processing configuration.
redshiftDestinationUpdate_clusterJDBCURL :: Lens' RedshiftDestinationUpdate (Maybe Text) Source #
The database connection string.
redshiftDestinationUpdate_roleARN :: Lens' RedshiftDestinationUpdate (Maybe Text) Source #
The Amazon Resource Name (ARN) of the AWS credentials. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces.
RedshiftRetryOptions
data RedshiftRetryOptions Source #
Configures retry behavior in case Kinesis Data Firehose is unable to deliver documents to Amazon Redshift.
See: newRedshiftRetryOptions smart constructor.
Constructors
| RedshiftRetryOptions' | |
Fields
| |
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.
redshiftRetryOptions_durationInSeconds :: Lens' RedshiftRetryOptions (Maybe Natural) Source #
The length of time during which Kinesis Data Firehose retries delivery
after a failure, starting from the initial request and including the
first attempt. The default value is 3600 seconds (60 minutes). Kinesis
Data Firehose does not retry if the value of DurationInSeconds is 0
(zero) or if the first delivery attempt takes longer than the current
value.
RetryOptions
data RetryOptions Source #
The retry behavior in case Kinesis Data Firehose is unable to deliver data to an Amazon S3 prefix.
See: newRetryOptions smart constructor.
Constructors
| RetryOptions' | |
Fields
| |
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.
retryOptions_durationInSeconds :: Lens' RetryOptions (Maybe Natural) Source #
The period of time during which Kinesis Data Firehose retries to deliver data to the specified Amazon S3 prefix.
S3DestinationConfiguration
data S3DestinationConfiguration Source #
Describes the configuration of a destination in Amazon S3.
See: newS3DestinationConfiguration smart constructor.
Constructors
| S3DestinationConfiguration' | |
Fields
| |
Instances
newS3DestinationConfiguration Source #
Arguments
| :: 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: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:cloudWatchLoggingOptions:S3DestinationConfiguration', s3DestinationConfiguration_cloudWatchLoggingOptions - The CloudWatch logging options for your delivery stream.
$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:encryptionConfiguration:S3DestinationConfiguration', s3DestinationConfiguration_encryptionConfiguration - The encryption configuration. If no value is specified, the default is
no encryption.
$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:bufferingHints:S3DestinationConfiguration', s3DestinationConfiguration_bufferingHints - The buffering option. If no value is specified, BufferingHints object
default values are used.
$sel:roleARN:S3DestinationConfiguration', s3DestinationConfiguration_roleARN - The Amazon Resource Name (ARN) of the AWS credentials. For more
information, see
Amazon Resource Names (ARNs) and AWS Service Namespaces.
$sel:bucketARN:S3DestinationConfiguration', s3DestinationConfiguration_bucketARN - The ARN of the S3 bucket. For more information, see
Amazon Resource Names (ARNs) and AWS Service Namespaces.
s3DestinationConfiguration_prefix :: Lens' S3DestinationConfiguration (Maybe Text) Source #
The "YYYY/MM/DD/HH" time format prefix is automatically used for delivered Amazon S3 files. You can also specify a custom prefix, as described in Custom Prefixes for Amazon S3 Objects.
s3DestinationConfiguration_cloudWatchLoggingOptions :: Lens' S3DestinationConfiguration (Maybe CloudWatchLoggingOptions) Source #
The CloudWatch logging options for your delivery stream.
s3DestinationConfiguration_errorOutputPrefix :: Lens' S3DestinationConfiguration (Maybe Text) Source #
A prefix that Kinesis Data Firehose evaluates and adds to failed records before writing them to S3. This prefix appears immediately following the bucket name. For information about how to specify this prefix, see Custom Prefixes for Amazon S3 Objects.
s3DestinationConfiguration_encryptionConfiguration :: Lens' S3DestinationConfiguration (Maybe EncryptionConfiguration) Source #
The encryption configuration. If no value is specified, the default is no encryption.
s3DestinationConfiguration_compressionFormat :: Lens' S3DestinationConfiguration (Maybe CompressionFormat) Source #
The compression format. If no value is specified, the default is
UNCOMPRESSED.
The compression formats SNAPPY or ZIP cannot be specified for Amazon
Redshift destinations because they are not supported by the Amazon
Redshift COPY operation that reads from the S3 bucket.
s3DestinationConfiguration_bufferingHints :: Lens' S3DestinationConfiguration (Maybe BufferingHints) Source #
The buffering option. If no value is specified, BufferingHints object
default values are used.
s3DestinationConfiguration_roleARN :: Lens' S3DestinationConfiguration Text Source #
The Amazon Resource Name (ARN) of the AWS credentials. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces.
s3DestinationConfiguration_bucketARN :: Lens' S3DestinationConfiguration Text Source #
The ARN of the S3 bucket. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces.
S3DestinationDescription
data S3DestinationDescription Source #
Describes a destination in Amazon S3.
See: newS3DestinationDescription smart constructor.
Constructors
| S3DestinationDescription' | |
Fields
| |
Instances
newS3DestinationDescription Source #
Arguments
| :: 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: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: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:roleARN:S3DestinationDescription', s3DestinationDescription_roleARN - The Amazon Resource Name (ARN) of the AWS credentials. For more
information, see
Amazon Resource Names (ARNs) and AWS Service Namespaces.
$sel:bucketARN:S3DestinationDescription', s3DestinationDescription_bucketARN - The ARN of the S3 bucket. For more information, see
Amazon Resource Names (ARNs) and AWS Service Namespaces.
$sel:bufferingHints:S3DestinationDescription', s3DestinationDescription_bufferingHints - The buffering option. If no value is specified, BufferingHints object
default values are used.
$sel:compressionFormat:S3DestinationDescription', s3DestinationDescription_compressionFormat - The compression format. If no value is specified, the default is
UNCOMPRESSED.
$sel:encryptionConfiguration:S3DestinationDescription', s3DestinationDescription_encryptionConfiguration - The encryption configuration. If no value is specified, the default is
no encryption.
s3DestinationDescription_prefix :: Lens' S3DestinationDescription (Maybe Text) Source #
The "YYYY/MM/DD/HH" time format prefix is automatically used for delivered Amazon S3 files. You can also specify a custom prefix, as described in Custom Prefixes for Amazon S3 Objects.
s3DestinationDescription_cloudWatchLoggingOptions :: Lens' S3DestinationDescription (Maybe CloudWatchLoggingOptions) Source #
The Amazon CloudWatch logging options for your delivery stream.
s3DestinationDescription_errorOutputPrefix :: Lens' S3DestinationDescription (Maybe Text) Source #
A prefix that Kinesis Data Firehose evaluates and adds to failed records before writing them to S3. This prefix appears immediately following the bucket name. For information about how to specify this prefix, see Custom Prefixes for Amazon S3 Objects.
s3DestinationDescription_roleARN :: Lens' S3DestinationDescription Text Source #
The Amazon Resource Name (ARN) of the AWS credentials. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces.
s3DestinationDescription_bucketARN :: Lens' S3DestinationDescription Text Source #
The ARN of the S3 bucket. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces.
s3DestinationDescription_bufferingHints :: Lens' S3DestinationDescription BufferingHints Source #
The buffering option. If no value is specified, BufferingHints object
default values are used.
s3DestinationDescription_compressionFormat :: Lens' S3DestinationDescription CompressionFormat Source #
The compression format. If no value is specified, the default is
UNCOMPRESSED.
s3DestinationDescription_encryptionConfiguration :: Lens' S3DestinationDescription EncryptionConfiguration Source #
The encryption configuration. If no value is specified, the default is no encryption.
S3DestinationUpdate
data S3DestinationUpdate Source #
Describes an update for a destination in Amazon S3.
See: newS3DestinationUpdate smart constructor.
Constructors
| S3DestinationUpdate' | |
Fields
| |
Instances
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: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:cloudWatchLoggingOptions:S3DestinationUpdate', s3DestinationUpdate_cloudWatchLoggingOptions - The CloudWatch logging options for your delivery stream.
$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:encryptionConfiguration:S3DestinationUpdate', s3DestinationUpdate_encryptionConfiguration - The encryption configuration. If no value is specified, the default is
no encryption.
$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:bufferingHints:S3DestinationUpdate', s3DestinationUpdate_bufferingHints - The buffering option. If no value is specified, BufferingHints object
default values are used.
$sel:bucketARN:S3DestinationUpdate', s3DestinationUpdate_bucketARN - The ARN of the S3 bucket. For more information, see
Amazon Resource Names (ARNs) and AWS Service Namespaces.
$sel:roleARN:S3DestinationUpdate', s3DestinationUpdate_roleARN - The Amazon Resource Name (ARN) of the AWS credentials. For more
information, see
Amazon Resource Names (ARNs) and AWS Service Namespaces.
s3DestinationUpdate_prefix :: Lens' S3DestinationUpdate (Maybe Text) Source #
The "YYYY/MM/DD/HH" time format prefix is automatically used for delivered Amazon S3 files. You can also specify a custom prefix, as described in Custom Prefixes for Amazon S3 Objects.
s3DestinationUpdate_cloudWatchLoggingOptions :: Lens' S3DestinationUpdate (Maybe CloudWatchLoggingOptions) Source #
The CloudWatch logging options for your delivery stream.
s3DestinationUpdate_errorOutputPrefix :: Lens' S3DestinationUpdate (Maybe Text) Source #
A prefix that Kinesis Data Firehose evaluates and adds to failed records before writing them to S3. This prefix appears immediately following the bucket name. For information about how to specify this prefix, see Custom Prefixes for Amazon S3 Objects.
s3DestinationUpdate_encryptionConfiguration :: Lens' S3DestinationUpdate (Maybe EncryptionConfiguration) Source #
The encryption configuration. If no value is specified, the default is no encryption.
s3DestinationUpdate_compressionFormat :: Lens' S3DestinationUpdate (Maybe CompressionFormat) Source #
The compression format. If no value is specified, the default is
UNCOMPRESSED.
The compression formats SNAPPY or ZIP cannot be specified for Amazon
Redshift destinations because they are not supported by the Amazon
Redshift COPY operation that reads from the S3 bucket.
s3DestinationUpdate_bufferingHints :: Lens' S3DestinationUpdate (Maybe BufferingHints) Source #
The buffering option. If no value is specified, BufferingHints object
default values are used.
s3DestinationUpdate_bucketARN :: Lens' S3DestinationUpdate (Maybe Text) Source #
The ARN of the S3 bucket. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces.
s3DestinationUpdate_roleARN :: Lens' S3DestinationUpdate (Maybe Text) Source #
The Amazon Resource Name (ARN) of the AWS credentials. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces.
SchemaConfiguration
data SchemaConfiguration Source #
Specifies the schema to which you want Kinesis Data Firehose to
configure your data before it writes it to Amazon S3. This parameter is
required if Enabled is set to true.
See: newSchemaConfiguration smart constructor.
Constructors
| SchemaConfiguration' | |
Fields
| |
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: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.
$sel:catalogId:SchemaConfiguration', schemaConfiguration_catalogId - The ID of the AWS Glue Data Catalog. If you don't supply this, the AWS
account ID is used by default.
$sel:databaseName:SchemaConfiguration', schemaConfiguration_databaseName - Specifies the name of the AWS 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 AWS Region, the default is the current Region.
$sel:tableName:SchemaConfiguration', schemaConfiguration_tableName - Specifies the AWS 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:roleARN:SchemaConfiguration', schemaConfiguration_roleARN - The role that Kinesis Data Firehose can use to access AWS Glue. This
role must be in the same account you use for Kinesis Data Firehose.
Cross-account roles aren't allowed.
If the SchemaConfiguration request parameter is used as part of
invoking the CreateDeliveryStream API, then the RoleARN property is
required and its value must be specified.
schemaConfiguration_versionId :: Lens' SchemaConfiguration (Maybe Text) Source #
Specifies the table version for the output data schema. If you don't
specify this version ID, or if you set it to LATEST, Kinesis Data
Firehose uses the most recent version. This means that any updates to
the table are automatically picked up.
schemaConfiguration_catalogId :: Lens' SchemaConfiguration (Maybe Text) Source #
The ID of the AWS Glue Data Catalog. If you don't supply this, the AWS account ID is used by default.
schemaConfiguration_databaseName :: Lens' SchemaConfiguration (Maybe Text) Source #
Specifies the name of the AWS Glue database that contains the schema for the output data.
If the SchemaConfiguration request parameter is used as part of
invoking the CreateDeliveryStream API, then the DatabaseName
property is required and its value must be specified.
schemaConfiguration_region :: Lens' SchemaConfiguration (Maybe Text) Source #
If you don't specify an AWS Region, the default is the current Region.
schemaConfiguration_tableName :: Lens' SchemaConfiguration (Maybe Text) Source #
Specifies the AWS Glue table that contains the column information that constitutes your data schema.
If the SchemaConfiguration request parameter is used as part of
invoking the CreateDeliveryStream API, then the TableName property
is required and its value must be specified.
schemaConfiguration_roleARN :: Lens' SchemaConfiguration (Maybe Text) Source #
The role that Kinesis Data Firehose can use to access AWS Glue. This role must be in the same account you use for Kinesis Data Firehose. Cross-account roles aren't allowed.
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.
Serializer
data Serializer Source #
The serializer that you want Kinesis Data Firehose to use to convert data to the target format before writing it to Amazon S3. Kinesis Data Firehose supports two types of serializers: the ORC SerDe and the Parquet SerDe.
See: newSerializer smart constructor.
Constructors
| Serializer' | |
Fields
| |
Instances
newSerializer :: Serializer Source #
Create a value of Serializer with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:orcSerDe:Serializer', serializer_orcSerDe - A serializer to use for converting data to the ORC format before storing
it in Amazon S3. For more information, see
Apache ORC.
$sel:parquetSerDe:Serializer', serializer_parquetSerDe - A serializer to use for converting data to the Parquet format before
storing it in Amazon S3. For more information, see
Apache Parquet.
serializer_orcSerDe :: Lens' Serializer (Maybe OrcSerDe) Source #
A serializer to use for converting data to the ORC format before storing it in Amazon S3. For more information, see Apache ORC.
serializer_parquetSerDe :: Lens' Serializer (Maybe ParquetSerDe) Source #
A serializer to use for converting data to the Parquet format before storing it in Amazon S3. For more information, see Apache Parquet.
SourceDescription
data SourceDescription Source #
Details about a Kinesis data stream used as the source for a Kinesis Data Firehose delivery stream.
See: newSourceDescription smart constructor.
Constructors
| SourceDescription' | |
Fields
| |
Instances
newSourceDescription :: SourceDescription Source #
Create a value of SourceDescription with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:kinesisStreamSourceDescription:SourceDescription', sourceDescription_kinesisStreamSourceDescription - The KinesisStreamSourceDescription value for the source Kinesis data
stream.
sourceDescription_kinesisStreamSourceDescription :: Lens' SourceDescription (Maybe KinesisStreamSourceDescription) Source #
The KinesisStreamSourceDescription value for the source Kinesis data stream.
SplunkDestinationConfiguration
data SplunkDestinationConfiguration Source #
Describes the configuration of a destination in Splunk.
See: newSplunkDestinationConfiguration smart constructor.
Constructors
| SplunkDestinationConfiguration' | |
Fields
| |
Instances
newSplunkDestinationConfiguration Source #
Arguments
| :: Text | |
| -> HECEndpointType | |
| -> Text | |
| -> S3DestinationConfiguration | |
| -> SplunkDestinationConfiguration |
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:
$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:cloudWatchLoggingOptions: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: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:processingConfiguration:SplunkDestinationConfiguration', splunkDestinationConfiguration_processingConfiguration - The data processing configuration.
$sel:hECEndpoint:SplunkDestinationConfiguration', splunkDestinationConfiguration_hECEndpoint - The HTTP Event Collector (HEC) endpoint to which Kinesis Data Firehose
sends your data.
$sel:hECEndpointType:SplunkDestinationConfiguration', splunkDestinationConfiguration_hECEndpointType - This type can be either "Raw" or "Event."
$sel:hECToken:SplunkDestinationConfiguration', splunkDestinationConfiguration_hECToken - This is a GUID that you obtain from your Splunk cluster when you create
a new HEC endpoint.
$sel:s3Configuration:SplunkDestinationConfiguration', splunkDestinationConfiguration_s3Configuration - The configuration for the backup Amazon S3 location.
splunkDestinationConfiguration_s3BackupMode :: Lens' SplunkDestinationConfiguration (Maybe SplunkS3BackupMode) Source #
Defines how documents should be delivered to Amazon S3. When set to
FailedEventsOnly, Kinesis Data Firehose writes any data that could not
be indexed to the configured Amazon S3 destination. When set to
AllEvents, Kinesis Data Firehose delivers all incoming records to
Amazon S3, and also writes failed documents to Amazon S3. The default
value is FailedEventsOnly.
You can update this backup mode from FailedEventsOnly to AllEvents.
You can't update it from AllEvents to FailedEventsOnly.
splunkDestinationConfiguration_cloudWatchLoggingOptions :: Lens' SplunkDestinationConfiguration (Maybe CloudWatchLoggingOptions) Source #
The Amazon CloudWatch logging options for your delivery stream.
splunkDestinationConfiguration_hECAcknowledgmentTimeoutInSeconds :: Lens' SplunkDestinationConfiguration (Maybe Natural) Source #
The amount of time that Kinesis Data Firehose waits to receive an acknowledgment from Splunk after it sends it data. At the end of the timeout period, Kinesis Data Firehose either tries to send the data again or considers it an error, based on your retry settings.
splunkDestinationConfiguration_retryOptions :: Lens' SplunkDestinationConfiguration (Maybe SplunkRetryOptions) Source #
The retry behavior in case Kinesis Data Firehose is unable to deliver data to Splunk, or if it doesn't receive an acknowledgment of receipt from Splunk.
splunkDestinationConfiguration_processingConfiguration :: Lens' SplunkDestinationConfiguration (Maybe ProcessingConfiguration) Source #
The data processing configuration.
splunkDestinationConfiguration_hECEndpoint :: Lens' SplunkDestinationConfiguration Text Source #
The HTTP Event Collector (HEC) endpoint to which Kinesis Data Firehose sends your data.
splunkDestinationConfiguration_hECEndpointType :: Lens' SplunkDestinationConfiguration HECEndpointType Source #
This type can be either "Raw" or "Event."
splunkDestinationConfiguration_hECToken :: Lens' SplunkDestinationConfiguration Text Source #
This is a GUID that you obtain from your Splunk cluster when you create a new HEC endpoint.
splunkDestinationConfiguration_s3Configuration :: Lens' SplunkDestinationConfiguration S3DestinationConfiguration Source #
The configuration for the backup Amazon S3 location.
SplunkDestinationDescription
data SplunkDestinationDescription Source #
Describes a destination in Splunk.
See: newSplunkDestinationDescription smart constructor.
Constructors
| SplunkDestinationDescription' | |
Fields
| |
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:
$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:hECToken:SplunkDestinationDescription', splunkDestinationDescription_hECToken - A GUID you obtain from your Splunk cluster when you create a new HEC
endpoint.
$sel:hECEndpointType:SplunkDestinationDescription', splunkDestinationDescription_hECEndpointType - This type can be either "Raw" or "Event."
$sel:cloudWatchLoggingOptions: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:s3DestinationDescription:SplunkDestinationDescription', splunkDestinationDescription_s3DestinationDescription - The Amazon S3 destination.>
$sel:hECEndpoint:SplunkDestinationDescription', splunkDestinationDescription_hECEndpoint - The HTTP Event Collector (HEC) endpoint to which Kinesis Data Firehose
sends your data.
$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:processingConfiguration:SplunkDestinationDescription', splunkDestinationDescription_processingConfiguration - The data processing configuration.
splunkDestinationDescription_s3BackupMode :: Lens' SplunkDestinationDescription (Maybe SplunkS3BackupMode) Source #
Defines how documents should be delivered to Amazon S3. When set to
FailedDocumentsOnly, Kinesis Data Firehose writes any data that could
not be indexed to the configured Amazon S3 destination. When set to
AllDocuments, Kinesis Data Firehose delivers all incoming records to
Amazon S3, and also writes failed documents to Amazon S3. Default value
is FailedDocumentsOnly.
splunkDestinationDescription_hECToken :: Lens' SplunkDestinationDescription (Maybe Text) Source #
A GUID you obtain from your Splunk cluster when you create a new HEC endpoint.
splunkDestinationDescription_hECEndpointType :: Lens' SplunkDestinationDescription (Maybe HECEndpointType) Source #
This type can be either "Raw" or "Event."
splunkDestinationDescription_cloudWatchLoggingOptions :: Lens' SplunkDestinationDescription (Maybe CloudWatchLoggingOptions) Source #
The Amazon CloudWatch logging options for your delivery stream.
splunkDestinationDescription_hECAcknowledgmentTimeoutInSeconds :: Lens' SplunkDestinationDescription (Maybe Natural) Source #
The amount of time that Kinesis Data Firehose waits to receive an acknowledgment from Splunk after it sends it data. At the end of the timeout period, Kinesis Data Firehose either tries to send the data again or considers it an error, based on your retry settings.
splunkDestinationDescription_s3DestinationDescription :: Lens' SplunkDestinationDescription (Maybe S3DestinationDescription) Source #
The Amazon S3 destination.>
splunkDestinationDescription_hECEndpoint :: Lens' SplunkDestinationDescription (Maybe Text) Source #
The HTTP Event Collector (HEC) endpoint to which Kinesis Data Firehose sends your data.
splunkDestinationDescription_retryOptions :: Lens' SplunkDestinationDescription (Maybe SplunkRetryOptions) Source #
The retry behavior in case Kinesis Data Firehose is unable to deliver data to Splunk or if it doesn't receive an acknowledgment of receipt from Splunk.
splunkDestinationDescription_processingConfiguration :: Lens' SplunkDestinationDescription (Maybe ProcessingConfiguration) Source #
The data processing configuration.
SplunkDestinationUpdate
data SplunkDestinationUpdate Source #
Describes an update for a destination in Splunk.
See: newSplunkDestinationUpdate smart constructor.
Constructors
| SplunkDestinationUpdate' | |
Fields
| |
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:
$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:hECToken:SplunkDestinationUpdate', splunkDestinationUpdate_hECToken - A GUID that you obtain from your Splunk cluster when you create a new
HEC endpoint.
$sel:hECEndpointType:SplunkDestinationUpdate', splunkDestinationUpdate_hECEndpointType - This type can be either "Raw" or "Event."
$sel:cloudWatchLoggingOptions: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:s3Update:SplunkDestinationUpdate', splunkDestinationUpdate_s3Update - Your update to the configuration of the backup Amazon S3 location.
$sel:hECEndpoint:SplunkDestinationUpdate', splunkDestinationUpdate_hECEndpoint - The HTTP Event Collector (HEC) endpoint to which Kinesis Data Firehose
sends your data.
$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:processingConfiguration:SplunkDestinationUpdate', splunkDestinationUpdate_processingConfiguration - The data processing configuration.
splunkDestinationUpdate_s3BackupMode :: Lens' SplunkDestinationUpdate (Maybe SplunkS3BackupMode) Source #
Specifies how you want Kinesis Data Firehose to back up documents to
Amazon S3. When set to FailedDocumentsOnly, Kinesis Data Firehose
writes any data that could not be indexed to the configured Amazon S3
destination. When set to AllEvents, Kinesis Data Firehose delivers all
incoming records to Amazon S3, and also writes failed documents to
Amazon S3. The default value is FailedEventsOnly.
You can update this backup mode from FailedEventsOnly to AllEvents.
You can't update it from AllEvents to FailedEventsOnly.
splunkDestinationUpdate_hECToken :: Lens' SplunkDestinationUpdate (Maybe Text) Source #
A GUID that you obtain from your Splunk cluster when you create a new HEC endpoint.
splunkDestinationUpdate_hECEndpointType :: Lens' SplunkDestinationUpdate (Maybe HECEndpointType) Source #
This type can be either "Raw" or "Event."
splunkDestinationUpdate_cloudWatchLoggingOptions :: Lens' SplunkDestinationUpdate (Maybe CloudWatchLoggingOptions) Source #
The Amazon CloudWatch logging options for your delivery stream.
splunkDestinationUpdate_hECAcknowledgmentTimeoutInSeconds :: Lens' SplunkDestinationUpdate (Maybe Natural) Source #
The amount of time that Kinesis Data Firehose waits to receive an acknowledgment from Splunk after it sends data. At the end of the timeout period, Kinesis Data Firehose either tries to send the data again or considers it an error, based on your retry settings.
splunkDestinationUpdate_s3Update :: Lens' SplunkDestinationUpdate (Maybe S3DestinationUpdate) Source #
Your update to the configuration of the backup Amazon S3 location.
splunkDestinationUpdate_hECEndpoint :: Lens' SplunkDestinationUpdate (Maybe Text) Source #
The HTTP Event Collector (HEC) endpoint to which Kinesis Data Firehose sends your data.
splunkDestinationUpdate_retryOptions :: Lens' SplunkDestinationUpdate (Maybe SplunkRetryOptions) Source #
The retry behavior in case Kinesis Data Firehose is unable to deliver data to Splunk or if it doesn't receive an acknowledgment of receipt from Splunk.
splunkDestinationUpdate_processingConfiguration :: Lens' SplunkDestinationUpdate (Maybe ProcessingConfiguration) Source #
The data processing configuration.
SplunkRetryOptions
data SplunkRetryOptions Source #
Configures retry behavior in case Kinesis Data Firehose is unable to deliver documents to Splunk, or if it doesn't receive an acknowledgment from Splunk.
See: newSplunkRetryOptions smart constructor.
Constructors
| SplunkRetryOptions' | |
Fields
| |
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.
splunkRetryOptions_durationInSeconds :: Lens' SplunkRetryOptions (Maybe Natural) Source #
The total amount of time that Kinesis Data Firehose spends on retries. This duration starts after the initial attempt to send data to Splunk fails. It doesn't include the periods during which Kinesis Data Firehose waits for acknowledgment from Splunk after each attempt.
Tag
Metadata that you can assign to a delivery stream, consisting of a key-value pair.
See: newTag smart constructor.
Constructors
| Tag' | |
Fields
| |
Instances
| Eq Tag Source # | |
| Read Tag Source # | |
| Show Tag Source # | |
| Generic Tag Source # | |
| NFData Tag Source # | |
Defined in Amazonka.Firehose.Types.Tag | |
| Hashable Tag Source # | |
Defined in Amazonka.Firehose.Types.Tag | |
| ToJSON Tag Source # | |
Defined in Amazonka.Firehose.Types.Tag | |
| FromJSON Tag Source # | |
| type Rep Tag Source # | |
Defined in Amazonka.Firehose.Types.Tag type Rep Tag = D1 ('MetaData "Tag" "Amazonka.Firehose.Types.Tag" "libZSservicesZSamazonka-kinesis-firehoseZSamazonka-kinesis-firehose" '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, _ . / = + - % @
tag_value :: Lens' Tag (Maybe Text) Source #
An optional string, which you can use to describe or define the tag. Maximum length: 256 characters. Valid characters: Unicode letters, digits, white space, _ . / = + - % @
tag_key :: Lens' Tag Text Source #
A unique identifier for the tag. Maximum length: 128 characters. Valid characters: Unicode letters, digits, white space, _ . / = + - % @
VpcConfiguration
data VpcConfiguration Source #
The details of the VPC of the Amazon ES destination.
See: newVpcConfiguration smart constructor.
Constructors
| VpcConfiguration' | |
Fields
| |
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.
vpcConfiguration_subnetIds :: Lens' VpcConfiguration (NonEmpty Text) Source #
The IDs of the subnets that you want Kinesis Data Firehose to use to create ENIs in the VPC of the Amazon ES destination. Make sure that the routing tables and inbound and outbound rules allow traffic to flow from the subnets whose IDs are specified here to the subnets that have the destination Amazon ES endpoints. Kinesis Data Firehose creates at least one ENI in each of the subnets that are specified here. Do not delete or modify these ENIs.
The number of ENIs that Kinesis Data Firehose creates in the subnets specified here scales up and down automatically based on throughput. To enable Kinesis Data Firehose to scale up the number of ENIs to match throughput, ensure that you have sufficient quota. To help you calculate the quota you need, assume that Kinesis Data Firehose can create up to three ENIs for this delivery stream for each of the subnets specified here. For more information about ENI quota, see Network Interfaces in the Amazon VPC Quotas topic.
vpcConfiguration_roleARN :: Lens' VpcConfiguration Text Source #
The ARN of the IAM role that you want the delivery stream to use to create endpoints in the destination VPC. You can use your existing Kinesis Data Firehose delivery role or you can specify a new role. In either case, make sure that the role trusts the Kinesis Data Firehose service principal and that it grants the following permissions:
ec2:DescribeVpcs
ec2:DescribeVpcAttribute
ec2:DescribeSubnets
ec2:DescribeSecurityGroups
ec2:DescribeNetworkInterfaces
ec2:CreateNetworkInterface
ec2:CreateNetworkInterfacePermission
ec2:DeleteNetworkInterface
If you revoke these permissions after you create the delivery stream, Kinesis Data Firehose can't scale out by creating more ENIs when necessary. You might therefore see a degradation in performance.
vpcConfiguration_securityGroupIds :: Lens' VpcConfiguration (NonEmpty Text) Source #
The IDs of the security groups that you want Kinesis Data Firehose to use when it creates ENIs in the VPC of the Amazon ES destination. You can use the same security group that the Amazon ES domain uses or different ones. If you specify different security groups here, ensure that they allow outbound HTTPS traffic to the Amazon ES domain's security group. Also ensure that the Amazon ES domain's security group allows HTTPS traffic from the security groups specified here. If you use the same security group for both your delivery stream and the Amazon ES domain, make sure the security group inbound rule allows HTTPS traffic. For more information about security group rules, see Security group rules in the Amazon VPC documentation.
VpcConfigurationDescription
data VpcConfigurationDescription Source #
The details of the VPC of the Amazon ES destination.
See: newVpcConfigurationDescription smart constructor.
Constructors
| VpcConfigurationDescription' | |
Fields
| |
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.
vpcConfigurationDescription_subnetIds :: Lens' VpcConfigurationDescription (NonEmpty Text) Source #
The IDs of the subnets that Kinesis Data Firehose uses to create ENIs in the VPC of the Amazon ES destination. Make sure that the routing tables and inbound and outbound rules allow traffic to flow from the subnets whose IDs are specified here to the subnets that have the destination Amazon ES endpoints. Kinesis Data Firehose creates at least one ENI in each of the subnets that are specified here. Do not delete or modify these ENIs.
The number of ENIs that Kinesis Data Firehose creates in the subnets specified here scales up and down automatically based on throughput. To enable Kinesis Data Firehose to scale up the number of ENIs to match throughput, ensure that you have sufficient quota. To help you calculate the quota you need, assume that Kinesis Data Firehose can create up to three ENIs for this delivery stream for each of the subnets specified here. For more information about ENI quota, see Network Interfaces in the Amazon VPC Quotas topic.
vpcConfigurationDescription_roleARN :: Lens' VpcConfigurationDescription Text Source #
The ARN of the IAM role that the delivery stream uses to create endpoints in the destination VPC. You can use your existing Kinesis Data Firehose delivery role or you can specify a new role. In either case, make sure that the role trusts the Kinesis Data Firehose service principal and that it grants the following permissions:
ec2:DescribeVpcs
ec2:DescribeVpcAttribute
ec2:DescribeSubnets
ec2:DescribeSecurityGroups
ec2:DescribeNetworkInterfaces
ec2:CreateNetworkInterface
ec2:CreateNetworkInterfacePermission
ec2:DeleteNetworkInterface
If you revoke these permissions after you create the delivery stream, Kinesis Data Firehose can't scale out by creating more ENIs when necessary. You might therefore see a degradation in performance.
vpcConfigurationDescription_securityGroupIds :: Lens' VpcConfigurationDescription (NonEmpty Text) Source #
The IDs of the security groups that Kinesis Data Firehose uses when it creates ENIs in the VPC of the Amazon ES destination. You can use the same security group that the Amazon ES domain uses or different ones. If you specify different security groups, ensure that they allow outbound HTTPS traffic to the Amazon ES domain's security group. Also ensure that the Amazon ES domain's security group allows HTTPS traffic from the security groups specified here. If you use the same security group for both your delivery stream and the Amazon ES domain, make sure the security group inbound rule allows HTTPS traffic. For more information about security group rules, see Security group rules in the Amazon VPC documentation.
vpcConfigurationDescription_vpcId :: Lens' VpcConfigurationDescription Text Source #
The ID of the Amazon ES destination's VPC.