Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
- Operations
- Types
- AmazonOpenSearchServerlessBufferingHints
- AmazonOpenSearchServerlessDestinationConfiguration
- AmazonOpenSearchServerlessDestinationDescription
- AmazonOpenSearchServerlessDestinationUpdate
- AmazonOpenSearchServerlessRetryOptions
- AmazonopensearchserviceBufferingHints
- AmazonopensearchserviceDestinationConfiguration
- AmazonopensearchserviceDestinationDescription
- AmazonopensearchserviceDestinationUpdate
- AmazonopensearchserviceRetryOptions
- BufferingHints
- CloudWatchLoggingOptions
- CopyCommand
- DataFormatConversionConfiguration
- DeliveryStreamDescription
- DeliveryStreamEncryptionConfiguration
- DeliveryStreamEncryptionConfigurationInput
- Deserializer
- DestinationDescription
- DynamicPartitioningConfiguration
- ElasticsearchBufferingHints
- ElasticsearchDestinationConfiguration
- ElasticsearchDestinationDescription
- ElasticsearchDestinationUpdate
- ElasticsearchRetryOptions
- EncryptionConfiguration
- ExtendedS3DestinationConfiguration
- ExtendedS3DestinationDescription
- ExtendedS3DestinationUpdate
- FailureDescription
- HiveJsonSerDe
- HttpEndpointBufferingHints
- HttpEndpointCommonAttribute
- HttpEndpointConfiguration
- HttpEndpointDescription
- HttpEndpointDestinationConfiguration
- HttpEndpointDestinationDescription
- HttpEndpointDestinationUpdate
- HttpEndpointRequestConfiguration
- HttpEndpointRetryOptions
- InputFormatConfiguration
- KMSEncryptionConfig
- KinesisStreamSourceConfiguration
- KinesisStreamSourceDescription
- OpenXJsonSerDe
- OrcSerDe
- OutputFormatConfiguration
- ParquetSerDe
- ProcessingConfiguration
- Processor
- ProcessorParameter
- PutRecordBatchResponseEntry
- Record
- RedshiftDestinationConfiguration
- RedshiftDestinationDescription
- RedshiftDestinationUpdate
- RedshiftRetryOptions
- RetryOptions
- S3DestinationConfiguration
- S3DestinationDescription
- S3DestinationUpdate
- SchemaConfiguration
- Serializer
- SourceDescription
- SplunkDestinationConfiguration
- SplunkDestinationDescription
- SplunkDestinationUpdate
- SplunkRetryOptions
- Tag
- VpcConfiguration
- VpcConfigurationDescription
Synopsis
- createDeliveryStream_amazonOpenSearchServerlessDestinationConfiguration :: Lens' CreateDeliveryStream (Maybe AmazonOpenSearchServerlessDestinationConfiguration)
- createDeliveryStream_amazonopensearchserviceDestinationConfiguration :: Lens' CreateDeliveryStream (Maybe AmazonopensearchserviceDestinationConfiguration)
- createDeliveryStream_deliveryStreamEncryptionConfigurationInput :: Lens' CreateDeliveryStream (Maybe DeliveryStreamEncryptionConfigurationInput)
- createDeliveryStream_deliveryStreamType :: Lens' CreateDeliveryStream (Maybe DeliveryStreamType)
- createDeliveryStream_elasticsearchDestinationConfiguration :: Lens' CreateDeliveryStream (Maybe ElasticsearchDestinationConfiguration)
- createDeliveryStream_extendedS3DestinationConfiguration :: Lens' CreateDeliveryStream (Maybe ExtendedS3DestinationConfiguration)
- createDeliveryStream_httpEndpointDestinationConfiguration :: Lens' CreateDeliveryStream (Maybe HttpEndpointDestinationConfiguration)
- createDeliveryStream_kinesisStreamSourceConfiguration :: Lens' CreateDeliveryStream (Maybe KinesisStreamSourceConfiguration)
- createDeliveryStream_redshiftDestinationConfiguration :: Lens' CreateDeliveryStream (Maybe RedshiftDestinationConfiguration)
- createDeliveryStream_s3DestinationConfiguration :: Lens' CreateDeliveryStream (Maybe S3DestinationConfiguration)
- createDeliveryStream_splunkDestinationConfiguration :: Lens' CreateDeliveryStream (Maybe SplunkDestinationConfiguration)
- createDeliveryStream_tags :: Lens' CreateDeliveryStream (Maybe (NonEmpty Tag))
- createDeliveryStream_deliveryStreamName :: Lens' CreateDeliveryStream Text
- createDeliveryStreamResponse_deliveryStreamARN :: Lens' CreateDeliveryStreamResponse (Maybe Text)
- createDeliveryStreamResponse_httpStatus :: Lens' CreateDeliveryStreamResponse Int
- deleteDeliveryStream_allowForceDelete :: Lens' DeleteDeliveryStream (Maybe Bool)
- deleteDeliveryStream_deliveryStreamName :: Lens' DeleteDeliveryStream Text
- deleteDeliveryStreamResponse_httpStatus :: Lens' DeleteDeliveryStreamResponse Int
- describeDeliveryStream_exclusiveStartDestinationId :: Lens' DescribeDeliveryStream (Maybe Text)
- describeDeliveryStream_limit :: Lens' DescribeDeliveryStream (Maybe Natural)
- describeDeliveryStream_deliveryStreamName :: Lens' DescribeDeliveryStream Text
- describeDeliveryStreamResponse_httpStatus :: Lens' DescribeDeliveryStreamResponse Int
- describeDeliveryStreamResponse_deliveryStreamDescription :: Lens' DescribeDeliveryStreamResponse DeliveryStreamDescription
- listDeliveryStreams_deliveryStreamType :: Lens' ListDeliveryStreams (Maybe DeliveryStreamType)
- listDeliveryStreams_exclusiveStartDeliveryStreamName :: Lens' ListDeliveryStreams (Maybe Text)
- listDeliveryStreams_limit :: Lens' ListDeliveryStreams (Maybe Natural)
- listDeliveryStreamsResponse_httpStatus :: Lens' ListDeliveryStreamsResponse Int
- listDeliveryStreamsResponse_deliveryStreamNames :: Lens' ListDeliveryStreamsResponse [Text]
- listDeliveryStreamsResponse_hasMoreDeliveryStreams :: Lens' ListDeliveryStreamsResponse Bool
- listTagsForDeliveryStream_exclusiveStartTagKey :: Lens' ListTagsForDeliveryStream (Maybe Text)
- listTagsForDeliveryStream_limit :: Lens' ListTagsForDeliveryStream (Maybe Natural)
- listTagsForDeliveryStream_deliveryStreamName :: Lens' ListTagsForDeliveryStream Text
- listTagsForDeliveryStreamResponse_httpStatus :: Lens' ListTagsForDeliveryStreamResponse Int
- listTagsForDeliveryStreamResponse_tags :: Lens' ListTagsForDeliveryStreamResponse [Tag]
- listTagsForDeliveryStreamResponse_hasMoreTags :: Lens' ListTagsForDeliveryStreamResponse Bool
- putRecord_deliveryStreamName :: Lens' PutRecord Text
- putRecord_record :: Lens' PutRecord Record
- putRecordResponse_encrypted :: Lens' PutRecordResponse (Maybe Bool)
- putRecordResponse_httpStatus :: Lens' PutRecordResponse Int
- putRecordResponse_recordId :: Lens' PutRecordResponse Text
- putRecordBatch_deliveryStreamName :: Lens' PutRecordBatch Text
- putRecordBatch_records :: Lens' PutRecordBatch (NonEmpty Record)
- putRecordBatchResponse_encrypted :: Lens' PutRecordBatchResponse (Maybe Bool)
- putRecordBatchResponse_httpStatus :: Lens' PutRecordBatchResponse Int
- putRecordBatchResponse_failedPutCount :: Lens' PutRecordBatchResponse Natural
- putRecordBatchResponse_requestResponses :: Lens' PutRecordBatchResponse (NonEmpty PutRecordBatchResponseEntry)
- startDeliveryStreamEncryption_deliveryStreamEncryptionConfigurationInput :: Lens' StartDeliveryStreamEncryption (Maybe DeliveryStreamEncryptionConfigurationInput)
- startDeliveryStreamEncryption_deliveryStreamName :: Lens' StartDeliveryStreamEncryption Text
- startDeliveryStreamEncryptionResponse_httpStatus :: Lens' StartDeliveryStreamEncryptionResponse Int
- stopDeliveryStreamEncryption_deliveryStreamName :: Lens' StopDeliveryStreamEncryption Text
- stopDeliveryStreamEncryptionResponse_httpStatus :: Lens' StopDeliveryStreamEncryptionResponse Int
- tagDeliveryStream_deliveryStreamName :: Lens' TagDeliveryStream Text
- tagDeliveryStream_tags :: Lens' TagDeliveryStream (NonEmpty Tag)
- tagDeliveryStreamResponse_httpStatus :: Lens' TagDeliveryStreamResponse Int
- untagDeliveryStream_deliveryStreamName :: Lens' UntagDeliveryStream Text
- untagDeliveryStream_tagKeys :: Lens' UntagDeliveryStream (NonEmpty Text)
- untagDeliveryStreamResponse_httpStatus :: Lens' UntagDeliveryStreamResponse Int
- updateDestination_amazonOpenSearchServerlessDestinationUpdate :: Lens' UpdateDestination (Maybe AmazonOpenSearchServerlessDestinationUpdate)
- updateDestination_amazonopensearchserviceDestinationUpdate :: Lens' UpdateDestination (Maybe AmazonopensearchserviceDestinationUpdate)
- updateDestination_elasticsearchDestinationUpdate :: Lens' UpdateDestination (Maybe ElasticsearchDestinationUpdate)
- updateDestination_extendedS3DestinationUpdate :: Lens' UpdateDestination (Maybe ExtendedS3DestinationUpdate)
- updateDestination_httpEndpointDestinationUpdate :: Lens' UpdateDestination (Maybe HttpEndpointDestinationUpdate)
- updateDestination_redshiftDestinationUpdate :: Lens' UpdateDestination (Maybe RedshiftDestinationUpdate)
- updateDestination_s3DestinationUpdate :: Lens' UpdateDestination (Maybe S3DestinationUpdate)
- updateDestination_splunkDestinationUpdate :: Lens' UpdateDestination (Maybe SplunkDestinationUpdate)
- updateDestination_deliveryStreamName :: Lens' UpdateDestination Text
- updateDestination_currentDeliveryStreamVersionId :: Lens' UpdateDestination Text
- updateDestination_destinationId :: Lens' UpdateDestination Text
- updateDestinationResponse_httpStatus :: Lens' UpdateDestinationResponse Int
- amazonOpenSearchServerlessBufferingHints_intervalInSeconds :: Lens' AmazonOpenSearchServerlessBufferingHints (Maybe Natural)
- amazonOpenSearchServerlessBufferingHints_sizeInMBs :: Lens' AmazonOpenSearchServerlessBufferingHints (Maybe Natural)
- amazonOpenSearchServerlessDestinationConfiguration_bufferingHints :: Lens' AmazonOpenSearchServerlessDestinationConfiguration (Maybe AmazonOpenSearchServerlessBufferingHints)
- amazonOpenSearchServerlessDestinationConfiguration_cloudWatchLoggingOptions :: Lens' AmazonOpenSearchServerlessDestinationConfiguration (Maybe CloudWatchLoggingOptions)
- amazonOpenSearchServerlessDestinationConfiguration_collectionEndpoint :: Lens' AmazonOpenSearchServerlessDestinationConfiguration (Maybe Text)
- amazonOpenSearchServerlessDestinationConfiguration_processingConfiguration :: Lens' AmazonOpenSearchServerlessDestinationConfiguration (Maybe ProcessingConfiguration)
- amazonOpenSearchServerlessDestinationConfiguration_retryOptions :: Lens' AmazonOpenSearchServerlessDestinationConfiguration (Maybe AmazonOpenSearchServerlessRetryOptions)
- amazonOpenSearchServerlessDestinationConfiguration_s3BackupMode :: Lens' AmazonOpenSearchServerlessDestinationConfiguration (Maybe AmazonOpenSearchServerlessS3BackupMode)
- amazonOpenSearchServerlessDestinationConfiguration_vpcConfiguration :: Lens' AmazonOpenSearchServerlessDestinationConfiguration (Maybe VpcConfiguration)
- amazonOpenSearchServerlessDestinationConfiguration_roleARN :: Lens' AmazonOpenSearchServerlessDestinationConfiguration Text
- amazonOpenSearchServerlessDestinationConfiguration_indexName :: Lens' AmazonOpenSearchServerlessDestinationConfiguration Text
- amazonOpenSearchServerlessDestinationConfiguration_s3Configuration :: Lens' AmazonOpenSearchServerlessDestinationConfiguration S3DestinationConfiguration
- amazonOpenSearchServerlessDestinationDescription_bufferingHints :: Lens' AmazonOpenSearchServerlessDestinationDescription (Maybe AmazonOpenSearchServerlessBufferingHints)
- amazonOpenSearchServerlessDestinationDescription_cloudWatchLoggingOptions :: Lens' AmazonOpenSearchServerlessDestinationDescription (Maybe CloudWatchLoggingOptions)
- amazonOpenSearchServerlessDestinationDescription_collectionEndpoint :: Lens' AmazonOpenSearchServerlessDestinationDescription (Maybe Text)
- amazonOpenSearchServerlessDestinationDescription_indexName :: Lens' AmazonOpenSearchServerlessDestinationDescription (Maybe Text)
- amazonOpenSearchServerlessDestinationDescription_processingConfiguration :: Lens' AmazonOpenSearchServerlessDestinationDescription (Maybe ProcessingConfiguration)
- amazonOpenSearchServerlessDestinationDescription_retryOptions :: Lens' AmazonOpenSearchServerlessDestinationDescription (Maybe AmazonOpenSearchServerlessRetryOptions)
- amazonOpenSearchServerlessDestinationDescription_roleARN :: Lens' AmazonOpenSearchServerlessDestinationDescription (Maybe Text)
- amazonOpenSearchServerlessDestinationDescription_s3BackupMode :: Lens' AmazonOpenSearchServerlessDestinationDescription (Maybe AmazonOpenSearchServerlessS3BackupMode)
- amazonOpenSearchServerlessDestinationDescription_s3DestinationDescription :: Lens' AmazonOpenSearchServerlessDestinationDescription (Maybe S3DestinationDescription)
- amazonOpenSearchServerlessDestinationDescription_vpcConfigurationDescription :: Lens' AmazonOpenSearchServerlessDestinationDescription (Maybe VpcConfigurationDescription)
- amazonOpenSearchServerlessDestinationUpdate_bufferingHints :: Lens' AmazonOpenSearchServerlessDestinationUpdate (Maybe AmazonOpenSearchServerlessBufferingHints)
- amazonOpenSearchServerlessDestinationUpdate_cloudWatchLoggingOptions :: Lens' AmazonOpenSearchServerlessDestinationUpdate (Maybe CloudWatchLoggingOptions)
- amazonOpenSearchServerlessDestinationUpdate_collectionEndpoint :: Lens' AmazonOpenSearchServerlessDestinationUpdate (Maybe Text)
- amazonOpenSearchServerlessDestinationUpdate_indexName :: Lens' AmazonOpenSearchServerlessDestinationUpdate (Maybe Text)
- amazonOpenSearchServerlessDestinationUpdate_processingConfiguration :: Lens' AmazonOpenSearchServerlessDestinationUpdate (Maybe ProcessingConfiguration)
- amazonOpenSearchServerlessDestinationUpdate_retryOptions :: Lens' AmazonOpenSearchServerlessDestinationUpdate (Maybe AmazonOpenSearchServerlessRetryOptions)
- amazonOpenSearchServerlessDestinationUpdate_roleARN :: Lens' AmazonOpenSearchServerlessDestinationUpdate (Maybe Text)
- amazonOpenSearchServerlessDestinationUpdate_s3Update :: Lens' AmazonOpenSearchServerlessDestinationUpdate (Maybe S3DestinationUpdate)
- amazonOpenSearchServerlessRetryOptions_durationInSeconds :: Lens' AmazonOpenSearchServerlessRetryOptions (Maybe Natural)
- amazonopensearchserviceBufferingHints_intervalInSeconds :: Lens' AmazonopensearchserviceBufferingHints (Maybe Natural)
- amazonopensearchserviceBufferingHints_sizeInMBs :: Lens' AmazonopensearchserviceBufferingHints (Maybe Natural)
- amazonopensearchserviceDestinationConfiguration_bufferingHints :: Lens' AmazonopensearchserviceDestinationConfiguration (Maybe AmazonopensearchserviceBufferingHints)
- amazonopensearchserviceDestinationConfiguration_cloudWatchLoggingOptions :: Lens' AmazonopensearchserviceDestinationConfiguration (Maybe CloudWatchLoggingOptions)
- amazonopensearchserviceDestinationConfiguration_clusterEndpoint :: Lens' AmazonopensearchserviceDestinationConfiguration (Maybe Text)
- amazonopensearchserviceDestinationConfiguration_domainARN :: Lens' AmazonopensearchserviceDestinationConfiguration (Maybe Text)
- amazonopensearchserviceDestinationConfiguration_indexRotationPeriod :: Lens' AmazonopensearchserviceDestinationConfiguration (Maybe AmazonopensearchserviceIndexRotationPeriod)
- amazonopensearchserviceDestinationConfiguration_processingConfiguration :: Lens' AmazonopensearchserviceDestinationConfiguration (Maybe ProcessingConfiguration)
- amazonopensearchserviceDestinationConfiguration_retryOptions :: Lens' AmazonopensearchserviceDestinationConfiguration (Maybe AmazonopensearchserviceRetryOptions)
- amazonopensearchserviceDestinationConfiguration_s3BackupMode :: Lens' AmazonopensearchserviceDestinationConfiguration (Maybe AmazonopensearchserviceS3BackupMode)
- amazonopensearchserviceDestinationConfiguration_typeName :: Lens' AmazonopensearchserviceDestinationConfiguration (Maybe Text)
- amazonopensearchserviceDestinationConfiguration_vpcConfiguration :: Lens' AmazonopensearchserviceDestinationConfiguration (Maybe VpcConfiguration)
- amazonopensearchserviceDestinationConfiguration_roleARN :: Lens' AmazonopensearchserviceDestinationConfiguration Text
- amazonopensearchserviceDestinationConfiguration_indexName :: Lens' AmazonopensearchserviceDestinationConfiguration Text
- amazonopensearchserviceDestinationConfiguration_s3Configuration :: Lens' AmazonopensearchserviceDestinationConfiguration S3DestinationConfiguration
- amazonopensearchserviceDestinationDescription_bufferingHints :: Lens' AmazonopensearchserviceDestinationDescription (Maybe AmazonopensearchserviceBufferingHints)
- amazonopensearchserviceDestinationDescription_cloudWatchLoggingOptions :: Lens' AmazonopensearchserviceDestinationDescription (Maybe CloudWatchLoggingOptions)
- amazonopensearchserviceDestinationDescription_clusterEndpoint :: Lens' AmazonopensearchserviceDestinationDescription (Maybe Text)
- amazonopensearchserviceDestinationDescription_domainARN :: Lens' AmazonopensearchserviceDestinationDescription (Maybe Text)
- amazonopensearchserviceDestinationDescription_indexName :: Lens' AmazonopensearchserviceDestinationDescription (Maybe Text)
- amazonopensearchserviceDestinationDescription_indexRotationPeriod :: Lens' AmazonopensearchserviceDestinationDescription (Maybe AmazonopensearchserviceIndexRotationPeriod)
- amazonopensearchserviceDestinationDescription_processingConfiguration :: Lens' AmazonopensearchserviceDestinationDescription (Maybe ProcessingConfiguration)
- amazonopensearchserviceDestinationDescription_retryOptions :: Lens' AmazonopensearchserviceDestinationDescription (Maybe AmazonopensearchserviceRetryOptions)
- amazonopensearchserviceDestinationDescription_roleARN :: Lens' AmazonopensearchserviceDestinationDescription (Maybe Text)
- amazonopensearchserviceDestinationDescription_s3BackupMode :: Lens' AmazonopensearchserviceDestinationDescription (Maybe AmazonopensearchserviceS3BackupMode)
- amazonopensearchserviceDestinationDescription_s3DestinationDescription :: Lens' AmazonopensearchserviceDestinationDescription (Maybe S3DestinationDescription)
- amazonopensearchserviceDestinationDescription_typeName :: Lens' AmazonopensearchserviceDestinationDescription (Maybe Text)
- amazonopensearchserviceDestinationDescription_vpcConfigurationDescription :: Lens' AmazonopensearchserviceDestinationDescription (Maybe VpcConfigurationDescription)
- amazonopensearchserviceDestinationUpdate_bufferingHints :: Lens' AmazonopensearchserviceDestinationUpdate (Maybe AmazonopensearchserviceBufferingHints)
- amazonopensearchserviceDestinationUpdate_cloudWatchLoggingOptions :: Lens' AmazonopensearchserviceDestinationUpdate (Maybe CloudWatchLoggingOptions)
- amazonopensearchserviceDestinationUpdate_clusterEndpoint :: Lens' AmazonopensearchserviceDestinationUpdate (Maybe Text)
- amazonopensearchserviceDestinationUpdate_domainARN :: Lens' AmazonopensearchserviceDestinationUpdate (Maybe Text)
- amazonopensearchserviceDestinationUpdate_indexName :: Lens' AmazonopensearchserviceDestinationUpdate (Maybe Text)
- amazonopensearchserviceDestinationUpdate_indexRotationPeriod :: Lens' AmazonopensearchserviceDestinationUpdate (Maybe AmazonopensearchserviceIndexRotationPeriod)
- amazonopensearchserviceDestinationUpdate_processingConfiguration :: Lens' AmazonopensearchserviceDestinationUpdate (Maybe ProcessingConfiguration)
- amazonopensearchserviceDestinationUpdate_retryOptions :: Lens' AmazonopensearchserviceDestinationUpdate (Maybe AmazonopensearchserviceRetryOptions)
- amazonopensearchserviceDestinationUpdate_roleARN :: Lens' AmazonopensearchserviceDestinationUpdate (Maybe Text)
- amazonopensearchserviceDestinationUpdate_s3Update :: Lens' AmazonopensearchserviceDestinationUpdate (Maybe S3DestinationUpdate)
- amazonopensearchserviceDestinationUpdate_typeName :: Lens' AmazonopensearchserviceDestinationUpdate (Maybe Text)
- amazonopensearchserviceRetryOptions_durationInSeconds :: Lens' AmazonopensearchserviceRetryOptions (Maybe Natural)
- bufferingHints_intervalInSeconds :: Lens' BufferingHints (Maybe Natural)
- bufferingHints_sizeInMBs :: Lens' BufferingHints (Maybe Natural)
- cloudWatchLoggingOptions_enabled :: Lens' CloudWatchLoggingOptions (Maybe Bool)
- cloudWatchLoggingOptions_logGroupName :: Lens' CloudWatchLoggingOptions (Maybe Text)
- cloudWatchLoggingOptions_logStreamName :: Lens' CloudWatchLoggingOptions (Maybe Text)
- copyCommand_copyOptions :: Lens' CopyCommand (Maybe Text)
- copyCommand_dataTableColumns :: Lens' CopyCommand (Maybe Text)
- copyCommand_dataTableName :: Lens' CopyCommand Text
- dataFormatConversionConfiguration_enabled :: Lens' DataFormatConversionConfiguration (Maybe Bool)
- dataFormatConversionConfiguration_inputFormatConfiguration :: Lens' DataFormatConversionConfiguration (Maybe InputFormatConfiguration)
- dataFormatConversionConfiguration_outputFormatConfiguration :: Lens' DataFormatConversionConfiguration (Maybe OutputFormatConfiguration)
- dataFormatConversionConfiguration_schemaConfiguration :: Lens' DataFormatConversionConfiguration (Maybe SchemaConfiguration)
- deliveryStreamDescription_createTimestamp :: Lens' DeliveryStreamDescription (Maybe UTCTime)
- deliveryStreamDescription_deliveryStreamEncryptionConfiguration :: Lens' DeliveryStreamDescription (Maybe DeliveryStreamEncryptionConfiguration)
- deliveryStreamDescription_failureDescription :: Lens' DeliveryStreamDescription (Maybe FailureDescription)
- deliveryStreamDescription_lastUpdateTimestamp :: Lens' DeliveryStreamDescription (Maybe UTCTime)
- deliveryStreamDescription_source :: Lens' DeliveryStreamDescription (Maybe SourceDescription)
- 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
- deliveryStreamEncryptionConfiguration_failureDescription :: Lens' DeliveryStreamEncryptionConfiguration (Maybe FailureDescription)
- deliveryStreamEncryptionConfiguration_keyARN :: Lens' DeliveryStreamEncryptionConfiguration (Maybe Text)
- deliveryStreamEncryptionConfiguration_keyType :: Lens' DeliveryStreamEncryptionConfiguration (Maybe KeyType)
- deliveryStreamEncryptionConfiguration_status :: Lens' DeliveryStreamEncryptionConfiguration (Maybe DeliveryStreamEncryptionStatus)
- deliveryStreamEncryptionConfigurationInput_keyARN :: Lens' DeliveryStreamEncryptionConfigurationInput (Maybe Text)
- deliveryStreamEncryptionConfigurationInput_keyType :: Lens' DeliveryStreamEncryptionConfigurationInput KeyType
- deserializer_hiveJsonSerDe :: Lens' Deserializer (Maybe HiveJsonSerDe)
- deserializer_openXJsonSerDe :: Lens' Deserializer (Maybe OpenXJsonSerDe)
- destinationDescription_amazonOpenSearchServerlessDestinationDescription :: Lens' DestinationDescription (Maybe AmazonOpenSearchServerlessDestinationDescription)
- destinationDescription_amazonopensearchserviceDestinationDescription :: Lens' DestinationDescription (Maybe AmazonopensearchserviceDestinationDescription)
- destinationDescription_elasticsearchDestinationDescription :: Lens' DestinationDescription (Maybe ElasticsearchDestinationDescription)
- destinationDescription_extendedS3DestinationDescription :: Lens' DestinationDescription (Maybe ExtendedS3DestinationDescription)
- destinationDescription_httpEndpointDestinationDescription :: Lens' DestinationDescription (Maybe HttpEndpointDestinationDescription)
- destinationDescription_redshiftDestinationDescription :: Lens' DestinationDescription (Maybe RedshiftDestinationDescription)
- destinationDescription_s3DestinationDescription :: Lens' DestinationDescription (Maybe S3DestinationDescription)
- destinationDescription_splunkDestinationDescription :: Lens' DestinationDescription (Maybe SplunkDestinationDescription)
- destinationDescription_destinationId :: Lens' DestinationDescription Text
- dynamicPartitioningConfiguration_enabled :: Lens' DynamicPartitioningConfiguration (Maybe Bool)
- dynamicPartitioningConfiguration_retryOptions :: Lens' DynamicPartitioningConfiguration (Maybe RetryOptions)
- elasticsearchBufferingHints_intervalInSeconds :: Lens' ElasticsearchBufferingHints (Maybe Natural)
- elasticsearchBufferingHints_sizeInMBs :: Lens' ElasticsearchBufferingHints (Maybe Natural)
- elasticsearchDestinationConfiguration_bufferingHints :: Lens' ElasticsearchDestinationConfiguration (Maybe ElasticsearchBufferingHints)
- elasticsearchDestinationConfiguration_cloudWatchLoggingOptions :: Lens' ElasticsearchDestinationConfiguration (Maybe CloudWatchLoggingOptions)
- elasticsearchDestinationConfiguration_clusterEndpoint :: Lens' ElasticsearchDestinationConfiguration (Maybe Text)
- elasticsearchDestinationConfiguration_domainARN :: Lens' ElasticsearchDestinationConfiguration (Maybe Text)
- elasticsearchDestinationConfiguration_indexRotationPeriod :: Lens' ElasticsearchDestinationConfiguration (Maybe ElasticsearchIndexRotationPeriod)
- elasticsearchDestinationConfiguration_processingConfiguration :: Lens' ElasticsearchDestinationConfiguration (Maybe ProcessingConfiguration)
- elasticsearchDestinationConfiguration_retryOptions :: Lens' ElasticsearchDestinationConfiguration (Maybe ElasticsearchRetryOptions)
- elasticsearchDestinationConfiguration_s3BackupMode :: Lens' ElasticsearchDestinationConfiguration (Maybe ElasticsearchS3BackupMode)
- elasticsearchDestinationConfiguration_typeName :: Lens' ElasticsearchDestinationConfiguration (Maybe Text)
- elasticsearchDestinationConfiguration_vpcConfiguration :: Lens' ElasticsearchDestinationConfiguration (Maybe VpcConfiguration)
- elasticsearchDestinationConfiguration_roleARN :: Lens' ElasticsearchDestinationConfiguration Text
- elasticsearchDestinationConfiguration_indexName :: Lens' ElasticsearchDestinationConfiguration Text
- elasticsearchDestinationConfiguration_s3Configuration :: Lens' ElasticsearchDestinationConfiguration S3DestinationConfiguration
- elasticsearchDestinationDescription_bufferingHints :: Lens' ElasticsearchDestinationDescription (Maybe ElasticsearchBufferingHints)
- elasticsearchDestinationDescription_cloudWatchLoggingOptions :: Lens' ElasticsearchDestinationDescription (Maybe CloudWatchLoggingOptions)
- elasticsearchDestinationDescription_clusterEndpoint :: Lens' ElasticsearchDestinationDescription (Maybe Text)
- elasticsearchDestinationDescription_domainARN :: Lens' ElasticsearchDestinationDescription (Maybe Text)
- elasticsearchDestinationDescription_indexName :: Lens' ElasticsearchDestinationDescription (Maybe Text)
- elasticsearchDestinationDescription_indexRotationPeriod :: Lens' ElasticsearchDestinationDescription (Maybe ElasticsearchIndexRotationPeriod)
- elasticsearchDestinationDescription_processingConfiguration :: Lens' ElasticsearchDestinationDescription (Maybe ProcessingConfiguration)
- elasticsearchDestinationDescription_retryOptions :: Lens' ElasticsearchDestinationDescription (Maybe ElasticsearchRetryOptions)
- elasticsearchDestinationDescription_roleARN :: Lens' ElasticsearchDestinationDescription (Maybe Text)
- elasticsearchDestinationDescription_s3BackupMode :: Lens' ElasticsearchDestinationDescription (Maybe ElasticsearchS3BackupMode)
- elasticsearchDestinationDescription_s3DestinationDescription :: Lens' ElasticsearchDestinationDescription (Maybe S3DestinationDescription)
- elasticsearchDestinationDescription_typeName :: Lens' ElasticsearchDestinationDescription (Maybe Text)
- elasticsearchDestinationDescription_vpcConfigurationDescription :: Lens' ElasticsearchDestinationDescription (Maybe VpcConfigurationDescription)
- elasticsearchDestinationUpdate_bufferingHints :: Lens' ElasticsearchDestinationUpdate (Maybe ElasticsearchBufferingHints)
- elasticsearchDestinationUpdate_cloudWatchLoggingOptions :: Lens' ElasticsearchDestinationUpdate (Maybe CloudWatchLoggingOptions)
- elasticsearchDestinationUpdate_clusterEndpoint :: Lens' ElasticsearchDestinationUpdate (Maybe Text)
- elasticsearchDestinationUpdate_domainARN :: Lens' ElasticsearchDestinationUpdate (Maybe Text)
- elasticsearchDestinationUpdate_indexName :: Lens' ElasticsearchDestinationUpdate (Maybe Text)
- elasticsearchDestinationUpdate_indexRotationPeriod :: Lens' ElasticsearchDestinationUpdate (Maybe ElasticsearchIndexRotationPeriod)
- elasticsearchDestinationUpdate_processingConfiguration :: Lens' ElasticsearchDestinationUpdate (Maybe ProcessingConfiguration)
- elasticsearchDestinationUpdate_retryOptions :: Lens' ElasticsearchDestinationUpdate (Maybe ElasticsearchRetryOptions)
- elasticsearchDestinationUpdate_roleARN :: Lens' ElasticsearchDestinationUpdate (Maybe Text)
- elasticsearchDestinationUpdate_s3Update :: Lens' ElasticsearchDestinationUpdate (Maybe S3DestinationUpdate)
- elasticsearchDestinationUpdate_typeName :: Lens' ElasticsearchDestinationUpdate (Maybe Text)
- elasticsearchRetryOptions_durationInSeconds :: Lens' ElasticsearchRetryOptions (Maybe Natural)
- encryptionConfiguration_kmsEncryptionConfig :: Lens' EncryptionConfiguration (Maybe KMSEncryptionConfig)
- encryptionConfiguration_noEncryptionConfig :: Lens' EncryptionConfiguration (Maybe NoEncryptionConfig)
- extendedS3DestinationConfiguration_bufferingHints :: Lens' ExtendedS3DestinationConfiguration (Maybe BufferingHints)
- extendedS3DestinationConfiguration_cloudWatchLoggingOptions :: Lens' ExtendedS3DestinationConfiguration (Maybe CloudWatchLoggingOptions)
- extendedS3DestinationConfiguration_compressionFormat :: Lens' ExtendedS3DestinationConfiguration (Maybe CompressionFormat)
- extendedS3DestinationConfiguration_dataFormatConversionConfiguration :: Lens' ExtendedS3DestinationConfiguration (Maybe DataFormatConversionConfiguration)
- extendedS3DestinationConfiguration_dynamicPartitioningConfiguration :: Lens' ExtendedS3DestinationConfiguration (Maybe DynamicPartitioningConfiguration)
- extendedS3DestinationConfiguration_encryptionConfiguration :: Lens' ExtendedS3DestinationConfiguration (Maybe EncryptionConfiguration)
- extendedS3DestinationConfiguration_errorOutputPrefix :: Lens' ExtendedS3DestinationConfiguration (Maybe Text)
- extendedS3DestinationConfiguration_prefix :: Lens' ExtendedS3DestinationConfiguration (Maybe Text)
- extendedS3DestinationConfiguration_processingConfiguration :: Lens' ExtendedS3DestinationConfiguration (Maybe ProcessingConfiguration)
- extendedS3DestinationConfiguration_s3BackupConfiguration :: Lens' ExtendedS3DestinationConfiguration (Maybe S3DestinationConfiguration)
- extendedS3DestinationConfiguration_s3BackupMode :: Lens' ExtendedS3DestinationConfiguration (Maybe S3BackupMode)
- extendedS3DestinationConfiguration_roleARN :: Lens' ExtendedS3DestinationConfiguration Text
- extendedS3DestinationConfiguration_bucketARN :: Lens' ExtendedS3DestinationConfiguration Text
- extendedS3DestinationDescription_cloudWatchLoggingOptions :: Lens' ExtendedS3DestinationDescription (Maybe CloudWatchLoggingOptions)
- extendedS3DestinationDescription_dataFormatConversionConfiguration :: Lens' ExtendedS3DestinationDescription (Maybe DataFormatConversionConfiguration)
- extendedS3DestinationDescription_dynamicPartitioningConfiguration :: Lens' ExtendedS3DestinationDescription (Maybe DynamicPartitioningConfiguration)
- extendedS3DestinationDescription_errorOutputPrefix :: Lens' ExtendedS3DestinationDescription (Maybe Text)
- extendedS3DestinationDescription_prefix :: Lens' ExtendedS3DestinationDescription (Maybe Text)
- extendedS3DestinationDescription_processingConfiguration :: Lens' ExtendedS3DestinationDescription (Maybe ProcessingConfiguration)
- extendedS3DestinationDescription_s3BackupDescription :: Lens' ExtendedS3DestinationDescription (Maybe S3DestinationDescription)
- extendedS3DestinationDescription_s3BackupMode :: Lens' ExtendedS3DestinationDescription (Maybe S3BackupMode)
- 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
- extendedS3DestinationUpdate_bucketARN :: Lens' ExtendedS3DestinationUpdate (Maybe Text)
- extendedS3DestinationUpdate_bufferingHints :: Lens' ExtendedS3DestinationUpdate (Maybe BufferingHints)
- extendedS3DestinationUpdate_cloudWatchLoggingOptions :: Lens' ExtendedS3DestinationUpdate (Maybe CloudWatchLoggingOptions)
- extendedS3DestinationUpdate_compressionFormat :: Lens' ExtendedS3DestinationUpdate (Maybe CompressionFormat)
- extendedS3DestinationUpdate_dataFormatConversionConfiguration :: Lens' ExtendedS3DestinationUpdate (Maybe DataFormatConversionConfiguration)
- extendedS3DestinationUpdate_dynamicPartitioningConfiguration :: Lens' ExtendedS3DestinationUpdate (Maybe DynamicPartitioningConfiguration)
- extendedS3DestinationUpdate_encryptionConfiguration :: Lens' ExtendedS3DestinationUpdate (Maybe EncryptionConfiguration)
- extendedS3DestinationUpdate_errorOutputPrefix :: Lens' ExtendedS3DestinationUpdate (Maybe Text)
- extendedS3DestinationUpdate_prefix :: Lens' ExtendedS3DestinationUpdate (Maybe Text)
- extendedS3DestinationUpdate_processingConfiguration :: Lens' ExtendedS3DestinationUpdate (Maybe ProcessingConfiguration)
- extendedS3DestinationUpdate_roleARN :: Lens' ExtendedS3DestinationUpdate (Maybe Text)
- extendedS3DestinationUpdate_s3BackupMode :: Lens' ExtendedS3DestinationUpdate (Maybe S3BackupMode)
- extendedS3DestinationUpdate_s3BackupUpdate :: Lens' ExtendedS3DestinationUpdate (Maybe S3DestinationUpdate)
- failureDescription_type :: Lens' FailureDescription DeliveryStreamFailureType
- failureDescription_details :: Lens' FailureDescription Text
- hiveJsonSerDe_timestampFormats :: Lens' HiveJsonSerDe (Maybe [Text])
- httpEndpointBufferingHints_intervalInSeconds :: Lens' HttpEndpointBufferingHints (Maybe Natural)
- httpEndpointBufferingHints_sizeInMBs :: Lens' HttpEndpointBufferingHints (Maybe Natural)
- httpEndpointCommonAttribute_attributeName :: Lens' HttpEndpointCommonAttribute Text
- httpEndpointCommonAttribute_attributeValue :: Lens' HttpEndpointCommonAttribute Text
- httpEndpointConfiguration_accessKey :: Lens' HttpEndpointConfiguration (Maybe Text)
- httpEndpointConfiguration_name :: Lens' HttpEndpointConfiguration (Maybe Text)
- httpEndpointConfiguration_url :: Lens' HttpEndpointConfiguration Text
- httpEndpointDescription_name :: Lens' HttpEndpointDescription (Maybe Text)
- httpEndpointDescription_url :: Lens' HttpEndpointDescription (Maybe Text)
- httpEndpointDestinationConfiguration_bufferingHints :: Lens' HttpEndpointDestinationConfiguration (Maybe HttpEndpointBufferingHints)
- httpEndpointDestinationConfiguration_cloudWatchLoggingOptions :: Lens' HttpEndpointDestinationConfiguration (Maybe CloudWatchLoggingOptions)
- httpEndpointDestinationConfiguration_processingConfiguration :: Lens' HttpEndpointDestinationConfiguration (Maybe ProcessingConfiguration)
- httpEndpointDestinationConfiguration_requestConfiguration :: Lens' HttpEndpointDestinationConfiguration (Maybe HttpEndpointRequestConfiguration)
- httpEndpointDestinationConfiguration_retryOptions :: Lens' HttpEndpointDestinationConfiguration (Maybe HttpEndpointRetryOptions)
- httpEndpointDestinationConfiguration_roleARN :: Lens' HttpEndpointDestinationConfiguration (Maybe Text)
- httpEndpointDestinationConfiguration_s3BackupMode :: Lens' HttpEndpointDestinationConfiguration (Maybe HttpEndpointS3BackupMode)
- httpEndpointDestinationConfiguration_endpointConfiguration :: Lens' HttpEndpointDestinationConfiguration HttpEndpointConfiguration
- httpEndpointDestinationConfiguration_s3Configuration :: Lens' HttpEndpointDestinationConfiguration S3DestinationConfiguration
- httpEndpointDestinationDescription_bufferingHints :: Lens' HttpEndpointDestinationDescription (Maybe HttpEndpointBufferingHints)
- httpEndpointDestinationDescription_cloudWatchLoggingOptions :: Lens' HttpEndpointDestinationDescription (Maybe CloudWatchLoggingOptions)
- httpEndpointDestinationDescription_endpointConfiguration :: Lens' HttpEndpointDestinationDescription (Maybe HttpEndpointDescription)
- httpEndpointDestinationDescription_processingConfiguration :: Lens' HttpEndpointDestinationDescription (Maybe ProcessingConfiguration)
- httpEndpointDestinationDescription_requestConfiguration :: Lens' HttpEndpointDestinationDescription (Maybe HttpEndpointRequestConfiguration)
- httpEndpointDestinationDescription_retryOptions :: Lens' HttpEndpointDestinationDescription (Maybe HttpEndpointRetryOptions)
- httpEndpointDestinationDescription_roleARN :: Lens' HttpEndpointDestinationDescription (Maybe Text)
- httpEndpointDestinationDescription_s3BackupMode :: Lens' HttpEndpointDestinationDescription (Maybe HttpEndpointS3BackupMode)
- httpEndpointDestinationDescription_s3DestinationDescription :: Lens' HttpEndpointDestinationDescription (Maybe S3DestinationDescription)
- httpEndpointDestinationUpdate_bufferingHints :: Lens' HttpEndpointDestinationUpdate (Maybe HttpEndpointBufferingHints)
- httpEndpointDestinationUpdate_cloudWatchLoggingOptions :: Lens' HttpEndpointDestinationUpdate (Maybe CloudWatchLoggingOptions)
- httpEndpointDestinationUpdate_endpointConfiguration :: Lens' HttpEndpointDestinationUpdate (Maybe HttpEndpointConfiguration)
- httpEndpointDestinationUpdate_processingConfiguration :: Lens' HttpEndpointDestinationUpdate (Maybe ProcessingConfiguration)
- httpEndpointDestinationUpdate_requestConfiguration :: Lens' HttpEndpointDestinationUpdate (Maybe HttpEndpointRequestConfiguration)
- httpEndpointDestinationUpdate_retryOptions :: Lens' HttpEndpointDestinationUpdate (Maybe HttpEndpointRetryOptions)
- httpEndpointDestinationUpdate_roleARN :: Lens' HttpEndpointDestinationUpdate (Maybe Text)
- httpEndpointDestinationUpdate_s3BackupMode :: Lens' HttpEndpointDestinationUpdate (Maybe HttpEndpointS3BackupMode)
- httpEndpointDestinationUpdate_s3Update :: Lens' HttpEndpointDestinationUpdate (Maybe S3DestinationUpdate)
- httpEndpointRequestConfiguration_commonAttributes :: Lens' HttpEndpointRequestConfiguration (Maybe [HttpEndpointCommonAttribute])
- httpEndpointRequestConfiguration_contentEncoding :: Lens' HttpEndpointRequestConfiguration (Maybe ContentEncoding)
- httpEndpointRetryOptions_durationInSeconds :: Lens' HttpEndpointRetryOptions (Maybe Natural)
- inputFormatConfiguration_deserializer :: Lens' InputFormatConfiguration (Maybe Deserializer)
- kmsEncryptionConfig_aWSKMSKeyARN :: Lens' KMSEncryptionConfig Text
- kinesisStreamSourceConfiguration_kinesisStreamARN :: Lens' KinesisStreamSourceConfiguration Text
- kinesisStreamSourceConfiguration_roleARN :: Lens' KinesisStreamSourceConfiguration Text
- kinesisStreamSourceDescription_deliveryStartTimestamp :: Lens' KinesisStreamSourceDescription (Maybe UTCTime)
- kinesisStreamSourceDescription_kinesisStreamARN :: Lens' KinesisStreamSourceDescription (Maybe Text)
- kinesisStreamSourceDescription_roleARN :: Lens' KinesisStreamSourceDescription (Maybe Text)
- openXJsonSerDe_caseInsensitive :: Lens' OpenXJsonSerDe (Maybe Bool)
- openXJsonSerDe_columnToJsonKeyMappings :: Lens' OpenXJsonSerDe (Maybe (HashMap Text Text))
- openXJsonSerDe_convertDotsInJsonKeysToUnderscores :: Lens' OpenXJsonSerDe (Maybe Bool)
- orcSerDe_blockSizeBytes :: Lens' OrcSerDe (Maybe Natural)
- orcSerDe_bloomFilterColumns :: Lens' OrcSerDe (Maybe [Text])
- orcSerDe_bloomFilterFalsePositiveProbability :: Lens' OrcSerDe (Maybe Double)
- orcSerDe_compression :: Lens' OrcSerDe (Maybe OrcCompression)
- orcSerDe_dictionaryKeyThreshold :: Lens' OrcSerDe (Maybe Double)
- orcSerDe_enablePadding :: Lens' OrcSerDe (Maybe Bool)
- orcSerDe_formatVersion :: Lens' OrcSerDe (Maybe OrcFormatVersion)
- orcSerDe_paddingTolerance :: Lens' OrcSerDe (Maybe Double)
- orcSerDe_rowIndexStride :: Lens' OrcSerDe (Maybe Natural)
- orcSerDe_stripeSizeBytes :: Lens' OrcSerDe (Maybe Natural)
- outputFormatConfiguration_serializer :: Lens' OutputFormatConfiguration (Maybe Serializer)
- parquetSerDe_blockSizeBytes :: Lens' ParquetSerDe (Maybe Natural)
- parquetSerDe_compression :: Lens' ParquetSerDe (Maybe ParquetCompression)
- parquetSerDe_enableDictionaryCompression :: Lens' ParquetSerDe (Maybe Bool)
- parquetSerDe_maxPaddingBytes :: Lens' ParquetSerDe (Maybe Natural)
- parquetSerDe_pageSizeBytes :: Lens' ParquetSerDe (Maybe Natural)
- parquetSerDe_writerVersion :: Lens' ParquetSerDe (Maybe ParquetWriterVersion)
- processingConfiguration_enabled :: Lens' ProcessingConfiguration (Maybe Bool)
- processingConfiguration_processors :: Lens' ProcessingConfiguration (Maybe [Processor])
- processor_parameters :: Lens' Processor (Maybe [ProcessorParameter])
- processor_type :: Lens' Processor ProcessorType
- processorParameter_parameterName :: Lens' ProcessorParameter ProcessorParameterName
- processorParameter_parameterValue :: Lens' ProcessorParameter Text
- putRecordBatchResponseEntry_errorCode :: Lens' PutRecordBatchResponseEntry (Maybe Text)
- putRecordBatchResponseEntry_errorMessage :: Lens' PutRecordBatchResponseEntry (Maybe Text)
- putRecordBatchResponseEntry_recordId :: Lens' PutRecordBatchResponseEntry (Maybe Text)
- record_data :: Lens' Record ByteString
- redshiftDestinationConfiguration_cloudWatchLoggingOptions :: Lens' RedshiftDestinationConfiguration (Maybe CloudWatchLoggingOptions)
- redshiftDestinationConfiguration_processingConfiguration :: Lens' RedshiftDestinationConfiguration (Maybe ProcessingConfiguration)
- redshiftDestinationConfiguration_retryOptions :: Lens' RedshiftDestinationConfiguration (Maybe RedshiftRetryOptions)
- redshiftDestinationConfiguration_s3BackupConfiguration :: Lens' RedshiftDestinationConfiguration (Maybe S3DestinationConfiguration)
- redshiftDestinationConfiguration_s3BackupMode :: Lens' RedshiftDestinationConfiguration (Maybe RedshiftS3BackupMode)
- 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
- redshiftDestinationDescription_cloudWatchLoggingOptions :: Lens' RedshiftDestinationDescription (Maybe CloudWatchLoggingOptions)
- redshiftDestinationDescription_processingConfiguration :: Lens' RedshiftDestinationDescription (Maybe ProcessingConfiguration)
- redshiftDestinationDescription_retryOptions :: Lens' RedshiftDestinationDescription (Maybe RedshiftRetryOptions)
- redshiftDestinationDescription_s3BackupDescription :: Lens' RedshiftDestinationDescription (Maybe S3DestinationDescription)
- redshiftDestinationDescription_s3BackupMode :: Lens' RedshiftDestinationDescription (Maybe RedshiftS3BackupMode)
- 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
- redshiftDestinationUpdate_cloudWatchLoggingOptions :: Lens' RedshiftDestinationUpdate (Maybe CloudWatchLoggingOptions)
- redshiftDestinationUpdate_clusterJDBCURL :: Lens' RedshiftDestinationUpdate (Maybe Text)
- redshiftDestinationUpdate_copyCommand :: Lens' RedshiftDestinationUpdate (Maybe CopyCommand)
- redshiftDestinationUpdate_password :: Lens' RedshiftDestinationUpdate (Maybe Text)
- redshiftDestinationUpdate_processingConfiguration :: Lens' RedshiftDestinationUpdate (Maybe ProcessingConfiguration)
- redshiftDestinationUpdate_retryOptions :: Lens' RedshiftDestinationUpdate (Maybe RedshiftRetryOptions)
- redshiftDestinationUpdate_roleARN :: Lens' RedshiftDestinationUpdate (Maybe Text)
- redshiftDestinationUpdate_s3BackupMode :: Lens' RedshiftDestinationUpdate (Maybe RedshiftS3BackupMode)
- redshiftDestinationUpdate_s3BackupUpdate :: Lens' RedshiftDestinationUpdate (Maybe S3DestinationUpdate)
- redshiftDestinationUpdate_s3Update :: Lens' RedshiftDestinationUpdate (Maybe S3DestinationUpdate)
- redshiftDestinationUpdate_username :: Lens' RedshiftDestinationUpdate (Maybe Text)
- redshiftRetryOptions_durationInSeconds :: Lens' RedshiftRetryOptions (Maybe Natural)
- retryOptions_durationInSeconds :: Lens' RetryOptions (Maybe Natural)
- s3DestinationConfiguration_bufferingHints :: Lens' S3DestinationConfiguration (Maybe BufferingHints)
- s3DestinationConfiguration_cloudWatchLoggingOptions :: Lens' S3DestinationConfiguration (Maybe CloudWatchLoggingOptions)
- s3DestinationConfiguration_compressionFormat :: Lens' S3DestinationConfiguration (Maybe CompressionFormat)
- s3DestinationConfiguration_encryptionConfiguration :: Lens' S3DestinationConfiguration (Maybe EncryptionConfiguration)
- s3DestinationConfiguration_errorOutputPrefix :: Lens' S3DestinationConfiguration (Maybe Text)
- s3DestinationConfiguration_prefix :: Lens' S3DestinationConfiguration (Maybe Text)
- s3DestinationConfiguration_roleARN :: Lens' S3DestinationConfiguration Text
- s3DestinationConfiguration_bucketARN :: Lens' S3DestinationConfiguration Text
- s3DestinationDescription_cloudWatchLoggingOptions :: Lens' S3DestinationDescription (Maybe CloudWatchLoggingOptions)
- s3DestinationDescription_errorOutputPrefix :: Lens' S3DestinationDescription (Maybe Text)
- s3DestinationDescription_prefix :: 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
- s3DestinationUpdate_bucketARN :: Lens' S3DestinationUpdate (Maybe Text)
- s3DestinationUpdate_bufferingHints :: Lens' S3DestinationUpdate (Maybe BufferingHints)
- s3DestinationUpdate_cloudWatchLoggingOptions :: Lens' S3DestinationUpdate (Maybe CloudWatchLoggingOptions)
- s3DestinationUpdate_compressionFormat :: Lens' S3DestinationUpdate (Maybe CompressionFormat)
- s3DestinationUpdate_encryptionConfiguration :: Lens' S3DestinationUpdate (Maybe EncryptionConfiguration)
- s3DestinationUpdate_errorOutputPrefix :: Lens' S3DestinationUpdate (Maybe Text)
- s3DestinationUpdate_prefix :: Lens' S3DestinationUpdate (Maybe Text)
- s3DestinationUpdate_roleARN :: Lens' S3DestinationUpdate (Maybe Text)
- schemaConfiguration_catalogId :: Lens' SchemaConfiguration (Maybe Text)
- schemaConfiguration_databaseName :: Lens' SchemaConfiguration (Maybe Text)
- schemaConfiguration_region :: Lens' SchemaConfiguration (Maybe Text)
- schemaConfiguration_roleARN :: Lens' SchemaConfiguration (Maybe Text)
- schemaConfiguration_tableName :: Lens' SchemaConfiguration (Maybe Text)
- schemaConfiguration_versionId :: Lens' SchemaConfiguration (Maybe Text)
- serializer_orcSerDe :: Lens' Serializer (Maybe OrcSerDe)
- serializer_parquetSerDe :: Lens' Serializer (Maybe ParquetSerDe)
- sourceDescription_kinesisStreamSourceDescription :: Lens' SourceDescription (Maybe KinesisStreamSourceDescription)
- splunkDestinationConfiguration_cloudWatchLoggingOptions :: Lens' SplunkDestinationConfiguration (Maybe CloudWatchLoggingOptions)
- splunkDestinationConfiguration_hECAcknowledgmentTimeoutInSeconds :: Lens' SplunkDestinationConfiguration (Maybe Natural)
- splunkDestinationConfiguration_processingConfiguration :: Lens' SplunkDestinationConfiguration (Maybe ProcessingConfiguration)
- splunkDestinationConfiguration_retryOptions :: Lens' SplunkDestinationConfiguration (Maybe SplunkRetryOptions)
- splunkDestinationConfiguration_s3BackupMode :: Lens' SplunkDestinationConfiguration (Maybe SplunkS3BackupMode)
- splunkDestinationConfiguration_hECEndpoint :: Lens' SplunkDestinationConfiguration Text
- splunkDestinationConfiguration_hECEndpointType :: Lens' SplunkDestinationConfiguration HECEndpointType
- splunkDestinationConfiguration_hECToken :: Lens' SplunkDestinationConfiguration Text
- splunkDestinationConfiguration_s3Configuration :: Lens' SplunkDestinationConfiguration S3DestinationConfiguration
- splunkDestinationDescription_cloudWatchLoggingOptions :: Lens' SplunkDestinationDescription (Maybe CloudWatchLoggingOptions)
- splunkDestinationDescription_hECAcknowledgmentTimeoutInSeconds :: Lens' SplunkDestinationDescription (Maybe Natural)
- splunkDestinationDescription_hECEndpoint :: Lens' SplunkDestinationDescription (Maybe Text)
- splunkDestinationDescription_hECEndpointType :: Lens' SplunkDestinationDescription (Maybe HECEndpointType)
- splunkDestinationDescription_hECToken :: Lens' SplunkDestinationDescription (Maybe Text)
- splunkDestinationDescription_processingConfiguration :: Lens' SplunkDestinationDescription (Maybe ProcessingConfiguration)
- splunkDestinationDescription_retryOptions :: Lens' SplunkDestinationDescription (Maybe SplunkRetryOptions)
- splunkDestinationDescription_s3BackupMode :: Lens' SplunkDestinationDescription (Maybe SplunkS3BackupMode)
- splunkDestinationDescription_s3DestinationDescription :: Lens' SplunkDestinationDescription (Maybe S3DestinationDescription)
- splunkDestinationUpdate_cloudWatchLoggingOptions :: Lens' SplunkDestinationUpdate (Maybe CloudWatchLoggingOptions)
- splunkDestinationUpdate_hECAcknowledgmentTimeoutInSeconds :: Lens' SplunkDestinationUpdate (Maybe Natural)
- splunkDestinationUpdate_hECEndpoint :: Lens' SplunkDestinationUpdate (Maybe Text)
- splunkDestinationUpdate_hECEndpointType :: Lens' SplunkDestinationUpdate (Maybe HECEndpointType)
- splunkDestinationUpdate_hECToken :: Lens' SplunkDestinationUpdate (Maybe Text)
- splunkDestinationUpdate_processingConfiguration :: Lens' SplunkDestinationUpdate (Maybe ProcessingConfiguration)
- splunkDestinationUpdate_retryOptions :: Lens' SplunkDestinationUpdate (Maybe SplunkRetryOptions)
- splunkDestinationUpdate_s3BackupMode :: Lens' SplunkDestinationUpdate (Maybe SplunkS3BackupMode)
- splunkDestinationUpdate_s3Update :: Lens' SplunkDestinationUpdate (Maybe S3DestinationUpdate)
- splunkRetryOptions_durationInSeconds :: Lens' SplunkRetryOptions (Maybe Natural)
- tag_value :: Lens' Tag (Maybe Text)
- tag_key :: Lens' Tag Text
- vpcConfiguration_subnetIds :: Lens' VpcConfiguration (NonEmpty Text)
- vpcConfiguration_roleARN :: Lens' VpcConfiguration Text
- vpcConfiguration_securityGroupIds :: Lens' VpcConfiguration (NonEmpty Text)
- vpcConfigurationDescription_subnetIds :: Lens' VpcConfigurationDescription (NonEmpty Text)
- vpcConfigurationDescription_roleARN :: Lens' VpcConfigurationDescription Text
- vpcConfigurationDescription_securityGroupIds :: Lens' VpcConfigurationDescription (NonEmpty Text)
- vpcConfigurationDescription_vpcId :: Lens' VpcConfigurationDescription Text
Operations
CreateDeliveryStream
createDeliveryStream_amazonOpenSearchServerlessDestinationConfiguration :: Lens' CreateDeliveryStream (Maybe AmazonOpenSearchServerlessDestinationConfiguration) Source #
The destination in the Serverless offering for Amazon OpenSearch Service. You can specify only one destination.
createDeliveryStream_amazonopensearchserviceDestinationConfiguration :: Lens' CreateDeliveryStream (Maybe AmazonopensearchserviceDestinationConfiguration) Source #
The destination in Amazon OpenSearch Service. You can specify only one destination.
createDeliveryStream_deliveryStreamEncryptionConfigurationInput :: Lens' CreateDeliveryStream (Maybe DeliveryStreamEncryptionConfigurationInput) Source #
Used to specify the type and Amazon Resource Name (ARN) of the KMS key needed for Server-Side Encryption (SSE).
createDeliveryStream_deliveryStreamType :: Lens' CreateDeliveryStream (Maybe DeliveryStreamType) Source #
The delivery stream type. This parameter can be one of the following values:
DirectPut
: Provider applications access the delivery stream directly.KinesisStreamAsSource
: The delivery stream uses a Kinesis data stream as a source.
createDeliveryStream_elasticsearchDestinationConfiguration :: Lens' CreateDeliveryStream (Maybe ElasticsearchDestinationConfiguration) Source #
The destination in Amazon ES. You can specify only one destination.
createDeliveryStream_extendedS3DestinationConfiguration :: Lens' CreateDeliveryStream (Maybe ExtendedS3DestinationConfiguration) Source #
The destination in Amazon S3. You can specify only one destination.
createDeliveryStream_httpEndpointDestinationConfiguration :: Lens' CreateDeliveryStream (Maybe HttpEndpointDestinationConfiguration) Source #
Enables configuring Kinesis Firehose to deliver data to any HTTP endpoint destination. You can specify only one destination.
createDeliveryStream_kinesisStreamSourceConfiguration :: Lens' CreateDeliveryStream (Maybe KinesisStreamSourceConfiguration) Source #
When a Kinesis data stream is used as the source for the delivery stream, a KinesisStreamSourceConfiguration containing the Kinesis data stream Amazon Resource Name (ARN) and the role ARN for the source stream.
createDeliveryStream_redshiftDestinationConfiguration :: Lens' CreateDeliveryStream (Maybe RedshiftDestinationConfiguration) Source #
The destination in Amazon Redshift. You can specify only one destination.
createDeliveryStream_s3DestinationConfiguration :: Lens' CreateDeliveryStream (Maybe S3DestinationConfiguration) Source #
- Deprecated
- The destination in Amazon S3. You can specify only one destination.
createDeliveryStream_splunkDestinationConfiguration :: Lens' CreateDeliveryStream (Maybe SplunkDestinationConfiguration) Source #
The destination in Splunk. You can specify only one destination.
createDeliveryStream_tags :: Lens' CreateDeliveryStream (Maybe (NonEmpty Tag)) Source #
A set of tags to assign to the delivery stream. A tag is a key-value pair that you can define and assign to Amazon Web Services resources. Tags are metadata. For example, you can add friendly names and descriptions or other types of information that can help you distinguish the delivery stream. For more information about tags, see Using Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User Guide.
You can specify up to 50 tags when creating a delivery stream.
createDeliveryStream_deliveryStreamName :: Lens' CreateDeliveryStream Text Source #
The name of the delivery stream. This name must be unique per Amazon Web Services account in the same Amazon Web Services Region. If the delivery streams are in different accounts or different Regions, you can have multiple delivery streams with the same name.
createDeliveryStreamResponse_deliveryStreamARN :: Lens' CreateDeliveryStreamResponse (Maybe Text) Source #
The ARN of the delivery stream.
createDeliveryStreamResponse_httpStatus :: Lens' CreateDeliveryStreamResponse Int Source #
The response's http status code.
DeleteDeliveryStream
deleteDeliveryStream_allowForceDelete :: Lens' DeleteDeliveryStream (Maybe Bool) Source #
Set this to true if you want to delete the delivery stream even if Kinesis Data Firehose is unable to retire the grant for the CMK. Kinesis Data Firehose might be unable to retire the grant due to a customer error, such as when the CMK or the grant are in an invalid state. If you force deletion, you can then use the RevokeGrant operation to revoke the grant you gave to Kinesis Data Firehose. If a failure to retire the grant happens due to an Amazon Web Services KMS issue, Kinesis Data Firehose keeps retrying the delete operation.
The default value is false.
deleteDeliveryStream_deliveryStreamName :: Lens' DeleteDeliveryStream Text Source #
The name of the delivery stream.
deleteDeliveryStreamResponse_httpStatus :: Lens' DeleteDeliveryStreamResponse Int Source #
The response's http status code.
DescribeDeliveryStream
describeDeliveryStream_exclusiveStartDestinationId :: Lens' DescribeDeliveryStream (Maybe Text) Source #
The ID of the destination to start returning the destination information. Kinesis Data Firehose supports one destination per delivery stream.
describeDeliveryStream_limit :: Lens' DescribeDeliveryStream (Maybe Natural) Source #
The limit on the number of destinations to return. You can have one destination per delivery stream.
describeDeliveryStream_deliveryStreamName :: Lens' DescribeDeliveryStream Text Source #
The name of the delivery stream.
describeDeliveryStreamResponse_httpStatus :: Lens' DescribeDeliveryStreamResponse Int Source #
The response's http status code.
describeDeliveryStreamResponse_deliveryStreamDescription :: Lens' DescribeDeliveryStreamResponse DeliveryStreamDescription Source #
Information about the delivery stream.
ListDeliveryStreams
listDeliveryStreams_deliveryStreamType :: Lens' ListDeliveryStreams (Maybe 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.
This parameter is optional. If this parameter is omitted, delivery streams of all types are returned.
listDeliveryStreams_exclusiveStartDeliveryStreamName :: Lens' ListDeliveryStreams (Maybe Text) Source #
The list of delivery streams returned by this call to
ListDeliveryStreams
will start with the delivery stream whose name
comes alphabetically immediately after the name you specify in
ExclusiveStartDeliveryStreamName
.
listDeliveryStreams_limit :: Lens' ListDeliveryStreams (Maybe Natural) Source #
The maximum number of delivery streams to list. The default value is 10.
listDeliveryStreamsResponse_httpStatus :: Lens' ListDeliveryStreamsResponse Int Source #
The response's http status code.
listDeliveryStreamsResponse_deliveryStreamNames :: Lens' ListDeliveryStreamsResponse [Text] Source #
The names of the delivery streams.
listDeliveryStreamsResponse_hasMoreDeliveryStreams :: Lens' ListDeliveryStreamsResponse Bool Source #
Indicates whether there are more delivery streams available to list.
ListTagsForDeliveryStream
listTagsForDeliveryStream_exclusiveStartTagKey :: Lens' ListTagsForDeliveryStream (Maybe Text) Source #
The key to use as the starting point for the list of tags. If you set
this parameter, ListTagsForDeliveryStream
gets all tags that occur
after ExclusiveStartTagKey
.
listTagsForDeliveryStream_limit :: Lens' ListTagsForDeliveryStream (Maybe Natural) Source #
The number of tags to return. If this number is less than the total
number of tags associated with the delivery stream, HasMoreTags
is set
to true
in the response. To list additional tags, set
ExclusiveStartTagKey
to the last key in the response.
listTagsForDeliveryStream_deliveryStreamName :: Lens' ListTagsForDeliveryStream Text Source #
The name of the delivery stream whose tags you want to list.
listTagsForDeliveryStreamResponse_httpStatus :: Lens' ListTagsForDeliveryStreamResponse Int Source #
The response's http status code.
listTagsForDeliveryStreamResponse_tags :: Lens' ListTagsForDeliveryStreamResponse [Tag] Source #
A list of tags associated with DeliveryStreamName
, starting with the
first tag after ExclusiveStartTagKey
and up to the specified Limit
.
listTagsForDeliveryStreamResponse_hasMoreTags :: Lens' ListTagsForDeliveryStreamResponse Bool Source #
If this is true
in the response, more tags are available. To list the
remaining tags, set ExclusiveStartTagKey
to the key of the last tag
returned and call ListTagsForDeliveryStream
again.
PutRecord
putRecordResponse_encrypted :: Lens' PutRecordResponse (Maybe Bool) Source #
Indicates whether server-side encryption (SSE) was enabled during this operation.
putRecordResponse_httpStatus :: Lens' PutRecordResponse Int Source #
The response's http status code.
putRecordResponse_recordId :: Lens' PutRecordResponse Text Source #
The ID of the record.
PutRecordBatch
putRecordBatch_deliveryStreamName :: Lens' PutRecordBatch Text Source #
The name of the delivery stream.
putRecordBatch_records :: Lens' PutRecordBatch (NonEmpty Record) Source #
One or more records.
putRecordBatchResponse_encrypted :: Lens' PutRecordBatchResponse (Maybe Bool) Source #
Indicates whether server-side encryption (SSE) was enabled during this operation.
putRecordBatchResponse_httpStatus :: Lens' PutRecordBatchResponse Int Source #
The response's http status code.
putRecordBatchResponse_failedPutCount :: Lens' PutRecordBatchResponse Natural Source #
The number of records that might have failed processing. This number
might be greater than 0 even if the PutRecordBatch call succeeds. Check
FailedPutCount
to determine whether there are records that you need to
resend.
putRecordBatchResponse_requestResponses :: Lens' PutRecordBatchResponse (NonEmpty PutRecordBatchResponseEntry) Source #
The results array. For each record, the index of the response element is the same as the index used in the request array.
StartDeliveryStreamEncryption
startDeliveryStreamEncryption_deliveryStreamEncryptionConfigurationInput :: Lens' StartDeliveryStreamEncryption (Maybe DeliveryStreamEncryptionConfigurationInput) Source #
Used to specify the type and Amazon Resource Name (ARN) of the KMS key needed for Server-Side Encryption (SSE).
startDeliveryStreamEncryption_deliveryStreamName :: Lens' StartDeliveryStreamEncryption Text Source #
The name of the delivery stream for which you want to enable server-side encryption (SSE).
startDeliveryStreamEncryptionResponse_httpStatus :: Lens' StartDeliveryStreamEncryptionResponse Int Source #
The response's http status code.
StopDeliveryStreamEncryption
stopDeliveryStreamEncryption_deliveryStreamName :: Lens' StopDeliveryStreamEncryption Text Source #
The name of the delivery stream for which you want to disable server-side encryption (SSE).
stopDeliveryStreamEncryptionResponse_httpStatus :: Lens' StopDeliveryStreamEncryptionResponse Int Source #
The response's http status code.
TagDeliveryStream
tagDeliveryStream_deliveryStreamName :: Lens' TagDeliveryStream Text Source #
The name of the delivery stream to which you want to add the tags.
tagDeliveryStream_tags :: Lens' TagDeliveryStream (NonEmpty Tag) Source #
A set of key-value pairs to use to create the tags.
tagDeliveryStreamResponse_httpStatus :: Lens' TagDeliveryStreamResponse Int Source #
The response's http status code.
UntagDeliveryStream
untagDeliveryStream_deliveryStreamName :: Lens' UntagDeliveryStream Text Source #
The name of the delivery stream.
untagDeliveryStream_tagKeys :: Lens' UntagDeliveryStream (NonEmpty Text) Source #
A list of tag keys. Each corresponding tag is removed from the delivery stream.
untagDeliveryStreamResponse_httpStatus :: Lens' UntagDeliveryStreamResponse Int Source #
The response's http status code.
UpdateDestination
updateDestination_amazonOpenSearchServerlessDestinationUpdate :: Lens' UpdateDestination (Maybe AmazonOpenSearchServerlessDestinationUpdate) Source #
Describes an update for a destination in the Serverless offering for Amazon OpenSearch Service.
updateDestination_amazonopensearchserviceDestinationUpdate :: Lens' UpdateDestination (Maybe AmazonopensearchserviceDestinationUpdate) Source #
Describes an update for a destination in Amazon OpenSearch Service.
updateDestination_elasticsearchDestinationUpdate :: Lens' UpdateDestination (Maybe ElasticsearchDestinationUpdate) Source #
Describes an update for a destination in Amazon ES.
updateDestination_extendedS3DestinationUpdate :: Lens' UpdateDestination (Maybe ExtendedS3DestinationUpdate) Source #
Describes an update for a destination in Amazon S3.
updateDestination_httpEndpointDestinationUpdate :: Lens' UpdateDestination (Maybe HttpEndpointDestinationUpdate) Source #
Describes an update to the specified HTTP endpoint destination.
updateDestination_redshiftDestinationUpdate :: Lens' UpdateDestination (Maybe RedshiftDestinationUpdate) Source #
Describes an update for a destination in Amazon Redshift.
updateDestination_s3DestinationUpdate :: Lens' UpdateDestination (Maybe S3DestinationUpdate) Source #
- Deprecated
- Describes an update for a destination in Amazon S3.
updateDestination_splunkDestinationUpdate :: Lens' UpdateDestination (Maybe SplunkDestinationUpdate) Source #
Describes an update for a destination in Splunk.
updateDestination_deliveryStreamName :: Lens' UpdateDestination Text Source #
The name of the delivery stream.
updateDestination_currentDeliveryStreamVersionId :: Lens' UpdateDestination Text Source #
Obtain this value from the VersionId
result of
DeliveryStreamDescription. This value is required, and helps the service
perform conditional operations. For example, if there is an interleaving
update and this value is null, then the update destination fails. After
the update is successful, the VersionId
value is updated. The service
then performs a merge of the old configuration with the new
configuration.
updateDestination_destinationId :: Lens' UpdateDestination Text Source #
The ID of the destination.
updateDestinationResponse_httpStatus :: Lens' UpdateDestinationResponse Int Source #
The response's http status code.
Types
AmazonOpenSearchServerlessBufferingHints
amazonOpenSearchServerlessBufferingHints_intervalInSeconds :: Lens' AmazonOpenSearchServerlessBufferingHints (Maybe Natural) Source #
Buffer incoming data for the specified period of time, in seconds, before delivering it to the destination. The default value is 300 (5 minutes).
amazonOpenSearchServerlessBufferingHints_sizeInMBs :: Lens' AmazonOpenSearchServerlessBufferingHints (Maybe Natural) Source #
Buffer incoming data to the specified size, in MBs, before delivering it to the destination. The default value is 5.
We recommend setting this parameter to a value greater than the amount of data you typically ingest into the delivery stream in 10 seconds. For example, if you typically ingest data at 1 MB/sec, the value should be 10 MB or higher.
AmazonOpenSearchServerlessDestinationConfiguration
amazonOpenSearchServerlessDestinationConfiguration_bufferingHints :: Lens' AmazonOpenSearchServerlessDestinationConfiguration (Maybe AmazonOpenSearchServerlessBufferingHints) Source #
The buffering options. If no value is specified, the default values for AmazonopensearchserviceBufferingHints are used.
amazonOpenSearchServerlessDestinationConfiguration_cloudWatchLoggingOptions :: Lens' AmazonOpenSearchServerlessDestinationConfiguration (Maybe CloudWatchLoggingOptions) Source #
Undocumented member.
amazonOpenSearchServerlessDestinationConfiguration_collectionEndpoint :: Lens' AmazonOpenSearchServerlessDestinationConfiguration (Maybe Text) Source #
The endpoint to use when communicating with the collection in the Serverless offering for Amazon OpenSearch Service.
amazonOpenSearchServerlessDestinationConfiguration_processingConfiguration :: Lens' AmazonOpenSearchServerlessDestinationConfiguration (Maybe ProcessingConfiguration) Source #
Undocumented member.
amazonOpenSearchServerlessDestinationConfiguration_retryOptions :: Lens' AmazonOpenSearchServerlessDestinationConfiguration (Maybe AmazonOpenSearchServerlessRetryOptions) Source #
The retry behavior in case Kinesis Data Firehose is unable to deliver documents to the Serverless offering for Amazon OpenSearch Service. The default value is 300 (5 minutes).
amazonOpenSearchServerlessDestinationConfiguration_s3BackupMode :: Lens' AmazonOpenSearchServerlessDestinationConfiguration (Maybe AmazonOpenSearchServerlessS3BackupMode) Source #
Defines how documents should be delivered to Amazon S3. When it is set to FailedDocumentsOnly, Kinesis Data Firehose writes any documents that could not be indexed to the configured Amazon S3 destination, with AmazonOpenSearchService-failed/ appended to the key prefix. When set to AllDocuments, Kinesis Data Firehose delivers all incoming records to Amazon S3, and also writes failed documents with AmazonOpenSearchService-failed/ appended to the prefix.
amazonOpenSearchServerlessDestinationConfiguration_vpcConfiguration :: Lens' AmazonOpenSearchServerlessDestinationConfiguration (Maybe VpcConfiguration) Source #
Undocumented member.
amazonOpenSearchServerlessDestinationConfiguration_roleARN :: Lens' AmazonOpenSearchServerlessDestinationConfiguration Text Source #
The Amazon Resource Name (ARN) of the IAM role to be assumed by Kinesis Data Firehose for calling the Serverless offering for Amazon OpenSearch Service Configuration API and for indexing documents.
amazonOpenSearchServerlessDestinationConfiguration_indexName :: Lens' AmazonOpenSearchServerlessDestinationConfiguration Text Source #
The Serverless offering for Amazon OpenSearch Service index name.
amazonOpenSearchServerlessDestinationConfiguration_s3Configuration :: Lens' AmazonOpenSearchServerlessDestinationConfiguration S3DestinationConfiguration Source #
Undocumented member.
AmazonOpenSearchServerlessDestinationDescription
amazonOpenSearchServerlessDestinationDescription_bufferingHints :: Lens' AmazonOpenSearchServerlessDestinationDescription (Maybe AmazonOpenSearchServerlessBufferingHints) Source #
The buffering options.
amazonOpenSearchServerlessDestinationDescription_cloudWatchLoggingOptions :: Lens' AmazonOpenSearchServerlessDestinationDescription (Maybe CloudWatchLoggingOptions) Source #
Undocumented member.
amazonOpenSearchServerlessDestinationDescription_collectionEndpoint :: Lens' AmazonOpenSearchServerlessDestinationDescription (Maybe Text) Source #
The endpoint to use when communicating with the collection in the Serverless offering for Amazon OpenSearch Service.
amazonOpenSearchServerlessDestinationDescription_indexName :: Lens' AmazonOpenSearchServerlessDestinationDescription (Maybe Text) Source #
The Serverless offering for Amazon OpenSearch Service index name.
amazonOpenSearchServerlessDestinationDescription_processingConfiguration :: Lens' AmazonOpenSearchServerlessDestinationDescription (Maybe ProcessingConfiguration) Source #
Undocumented member.
amazonOpenSearchServerlessDestinationDescription_retryOptions :: Lens' AmazonOpenSearchServerlessDestinationDescription (Maybe AmazonOpenSearchServerlessRetryOptions) Source #
The Serverless offering for Amazon OpenSearch Service retry options.
amazonOpenSearchServerlessDestinationDescription_roleARN :: Lens' AmazonOpenSearchServerlessDestinationDescription (Maybe Text) Source #
The Amazon Resource Name (ARN) of the AWS credentials.
amazonOpenSearchServerlessDestinationDescription_s3BackupMode :: Lens' AmazonOpenSearchServerlessDestinationDescription (Maybe AmazonOpenSearchServerlessS3BackupMode) Source #
The Amazon S3 backup mode.
amazonOpenSearchServerlessDestinationDescription_s3DestinationDescription :: Lens' AmazonOpenSearchServerlessDestinationDescription (Maybe S3DestinationDescription) Source #
Undocumented member.
amazonOpenSearchServerlessDestinationDescription_vpcConfigurationDescription :: Lens' AmazonOpenSearchServerlessDestinationDescription (Maybe VpcConfigurationDescription) Source #
Undocumented member.
AmazonOpenSearchServerlessDestinationUpdate
amazonOpenSearchServerlessDestinationUpdate_bufferingHints :: Lens' AmazonOpenSearchServerlessDestinationUpdate (Maybe AmazonOpenSearchServerlessBufferingHints) Source #
The buffering options. If no value is specified, AmazonopensearchBufferingHints object default values are used.
amazonOpenSearchServerlessDestinationUpdate_cloudWatchLoggingOptions :: Lens' AmazonOpenSearchServerlessDestinationUpdate (Maybe CloudWatchLoggingOptions) Source #
Undocumented member.
amazonOpenSearchServerlessDestinationUpdate_collectionEndpoint :: Lens' AmazonOpenSearchServerlessDestinationUpdate (Maybe Text) Source #
The endpoint to use when communicating with the collection in the Serverless offering for Amazon OpenSearch Service.
amazonOpenSearchServerlessDestinationUpdate_indexName :: Lens' AmazonOpenSearchServerlessDestinationUpdate (Maybe Text) Source #
The Serverless offering for Amazon OpenSearch Service index name.
amazonOpenSearchServerlessDestinationUpdate_processingConfiguration :: Lens' AmazonOpenSearchServerlessDestinationUpdate (Maybe ProcessingConfiguration) Source #
Undocumented member.
amazonOpenSearchServerlessDestinationUpdate_retryOptions :: Lens' AmazonOpenSearchServerlessDestinationUpdate (Maybe AmazonOpenSearchServerlessRetryOptions) Source #
The retry behavior in case Kinesis Data Firehose is unable to deliver documents to the Serverless offering for Amazon OpenSearch Service. The default value is 300 (5 minutes).
amazonOpenSearchServerlessDestinationUpdate_roleARN :: Lens' AmazonOpenSearchServerlessDestinationUpdate (Maybe Text) Source #
The Amazon Resource Name (ARN) of the IAM role to be assumed by Kinesis Data Firehose for calling the Serverless offering for Amazon OpenSearch Service Configuration API and for indexing documents.
amazonOpenSearchServerlessDestinationUpdate_s3Update :: Lens' AmazonOpenSearchServerlessDestinationUpdate (Maybe S3DestinationUpdate) Source #
Undocumented member.
AmazonOpenSearchServerlessRetryOptions
amazonOpenSearchServerlessRetryOptions_durationInSeconds :: Lens' AmazonOpenSearchServerlessRetryOptions (Maybe Natural) Source #
After an initial failure to deliver to the Serverless offering for Amazon OpenSearch Service, the total amount of time during which Kinesis Data Firehose retries delivery (including the first attempt). After this time has elapsed, the failed documents are written to Amazon S3. Default value is 300 seconds (5 minutes). A value of 0 (zero) results in no retries.
AmazonopensearchserviceBufferingHints
amazonopensearchserviceBufferingHints_intervalInSeconds :: Lens' AmazonopensearchserviceBufferingHints (Maybe Natural) Source #
Buffer incoming data for the specified period of time, in seconds, before delivering it to the destination. The default value is 300 (5 minutes).
amazonopensearchserviceBufferingHints_sizeInMBs :: Lens' AmazonopensearchserviceBufferingHints (Maybe Natural) Source #
Buffer incoming data to the specified size, in MBs, before delivering it to the destination. The default value is 5.
We recommend setting this parameter to a value greater than the amount of data you typically ingest into the delivery stream in 10 seconds. For example, if you typically ingest data at 1 MB/sec, the value should be 10 MB or higher.
AmazonopensearchserviceDestinationConfiguration
amazonopensearchserviceDestinationConfiguration_bufferingHints :: Lens' AmazonopensearchserviceDestinationConfiguration (Maybe AmazonopensearchserviceBufferingHints) Source #
The buffering options. If no value is specified, the default values for AmazonopensearchserviceBufferingHints are used.
amazonopensearchserviceDestinationConfiguration_cloudWatchLoggingOptions :: Lens' AmazonopensearchserviceDestinationConfiguration (Maybe CloudWatchLoggingOptions) Source #
Undocumented member.
amazonopensearchserviceDestinationConfiguration_clusterEndpoint :: Lens' AmazonopensearchserviceDestinationConfiguration (Maybe Text) Source #
The endpoint to use when communicating with the cluster. Specify either this ClusterEndpoint or the DomainARN field.
amazonopensearchserviceDestinationConfiguration_domainARN :: Lens' AmazonopensearchserviceDestinationConfiguration (Maybe Text) Source #
The ARN of the Amazon OpenSearch Service domain. The IAM role must have permissions for DescribeElasticsearchDomain, DescribeElasticsearchDomains, and DescribeElasticsearchDomainConfig after assuming the role specified in RoleARN.
amazonopensearchserviceDestinationConfiguration_indexRotationPeriod :: Lens' AmazonopensearchserviceDestinationConfiguration (Maybe AmazonopensearchserviceIndexRotationPeriod) Source #
The Amazon OpenSearch Service index rotation period. Index rotation appends a timestamp to the IndexName to facilitate the expiration of old data.
amazonopensearchserviceDestinationConfiguration_processingConfiguration :: Lens' AmazonopensearchserviceDestinationConfiguration (Maybe ProcessingConfiguration) Source #
Undocumented member.
amazonopensearchserviceDestinationConfiguration_retryOptions :: Lens' AmazonopensearchserviceDestinationConfiguration (Maybe AmazonopensearchserviceRetryOptions) Source #
The retry behavior in case Kinesis Data Firehose is unable to deliver documents to Amazon OpenSearch Service. The default value is 300 (5 minutes).
amazonopensearchserviceDestinationConfiguration_s3BackupMode :: Lens' AmazonopensearchserviceDestinationConfiguration (Maybe AmazonopensearchserviceS3BackupMode) Source #
Defines how documents should be delivered to Amazon S3. When it is set to FailedDocumentsOnly, Kinesis Data Firehose writes any documents that could not be indexed to the configured Amazon S3 destination, with AmazonOpenSearchService-failed/ appended to the key prefix. When set to AllDocuments, Kinesis Data Firehose delivers all incoming records to Amazon S3, and also writes failed documents with AmazonOpenSearchService-failed/ appended to the prefix.
amazonopensearchserviceDestinationConfiguration_typeName :: Lens' AmazonopensearchserviceDestinationConfiguration (Maybe Text) Source #
The Amazon OpenSearch Service type name. For Elasticsearch 6.x, there can be only one type per index. If you try to specify a new type for an existing index that already has another type, Kinesis Data Firehose returns an error during run time.
amazonopensearchserviceDestinationConfiguration_vpcConfiguration :: Lens' AmazonopensearchserviceDestinationConfiguration (Maybe VpcConfiguration) Source #
Undocumented member.
amazonopensearchserviceDestinationConfiguration_roleARN :: Lens' AmazonopensearchserviceDestinationConfiguration Text Source #
The Amazon Resource Name (ARN) of the IAM role to be assumed by Kinesis Data Firehose for calling the Amazon OpenSearch Service Configuration API and for indexing documents.
amazonopensearchserviceDestinationConfiguration_indexName :: Lens' AmazonopensearchserviceDestinationConfiguration Text Source #
The ElasticsearAmazon OpenSearch Service index name.
amazonopensearchserviceDestinationConfiguration_s3Configuration :: Lens' AmazonopensearchserviceDestinationConfiguration S3DestinationConfiguration Source #
Undocumented member.
AmazonopensearchserviceDestinationDescription
amazonopensearchserviceDestinationDescription_bufferingHints :: Lens' AmazonopensearchserviceDestinationDescription (Maybe AmazonopensearchserviceBufferingHints) Source #
The buffering options.
amazonopensearchserviceDestinationDescription_cloudWatchLoggingOptions :: Lens' AmazonopensearchserviceDestinationDescription (Maybe CloudWatchLoggingOptions) Source #
Undocumented member.
amazonopensearchserviceDestinationDescription_clusterEndpoint :: Lens' AmazonopensearchserviceDestinationDescription (Maybe Text) Source #
The endpoint to use when communicating with the cluster. Kinesis Data Firehose uses either this ClusterEndpoint or the DomainARN field to send data to Amazon OpenSearch Service.
amazonopensearchserviceDestinationDescription_domainARN :: Lens' AmazonopensearchserviceDestinationDescription (Maybe Text) Source #
The ARN of the Amazon OpenSearch Service domain.
amazonopensearchserviceDestinationDescription_indexName :: Lens' AmazonopensearchserviceDestinationDescription (Maybe Text) Source #
The Amazon OpenSearch Service index name.
amazonopensearchserviceDestinationDescription_indexRotationPeriod :: Lens' AmazonopensearchserviceDestinationDescription (Maybe AmazonopensearchserviceIndexRotationPeriod) Source #
The Amazon OpenSearch Service index rotation period
amazonopensearchserviceDestinationDescription_processingConfiguration :: Lens' AmazonopensearchserviceDestinationDescription (Maybe ProcessingConfiguration) Source #
Undocumented member.
amazonopensearchserviceDestinationDescription_retryOptions :: Lens' AmazonopensearchserviceDestinationDescription (Maybe AmazonopensearchserviceRetryOptions) Source #
The Amazon OpenSearch Service retry options.
amazonopensearchserviceDestinationDescription_roleARN :: Lens' AmazonopensearchserviceDestinationDescription (Maybe Text) Source #
The Amazon Resource Name (ARN) of the Amazon Web Services credentials.
amazonopensearchserviceDestinationDescription_s3BackupMode :: Lens' AmazonopensearchserviceDestinationDescription (Maybe AmazonopensearchserviceS3BackupMode) Source #
The Amazon S3 backup mode.
amazonopensearchserviceDestinationDescription_s3DestinationDescription :: Lens' AmazonopensearchserviceDestinationDescription (Maybe S3DestinationDescription) Source #
Undocumented member.
amazonopensearchserviceDestinationDescription_typeName :: Lens' AmazonopensearchserviceDestinationDescription (Maybe Text) Source #
The Amazon OpenSearch Service type name. This applies to Elasticsearch 6.x and lower versions. For Elasticsearch 7.x and OpenSearch Service 1.x, there's no value for TypeName.
amazonopensearchserviceDestinationDescription_vpcConfigurationDescription :: Lens' AmazonopensearchserviceDestinationDescription (Maybe VpcConfigurationDescription) Source #
Undocumented member.
AmazonopensearchserviceDestinationUpdate
amazonopensearchserviceDestinationUpdate_bufferingHints :: Lens' AmazonopensearchserviceDestinationUpdate (Maybe AmazonopensearchserviceBufferingHints) Source #
The buffering options. If no value is specified, AmazonopensearchBufferingHints object default values are used.
amazonopensearchserviceDestinationUpdate_cloudWatchLoggingOptions :: Lens' AmazonopensearchserviceDestinationUpdate (Maybe CloudWatchLoggingOptions) Source #
Undocumented member.
amazonopensearchserviceDestinationUpdate_clusterEndpoint :: Lens' AmazonopensearchserviceDestinationUpdate (Maybe Text) Source #
The endpoint to use when communicating with the cluster. Specify either this ClusterEndpoint or the DomainARN field.
amazonopensearchserviceDestinationUpdate_domainARN :: Lens' AmazonopensearchserviceDestinationUpdate (Maybe Text) Source #
The ARN of the Amazon OpenSearch Service domain. The IAM role must have permissions for DescribeDomain, DescribeDomains, and DescribeDomainConfig after assuming the IAM role specified in RoleARN.
amazonopensearchserviceDestinationUpdate_indexName :: Lens' AmazonopensearchserviceDestinationUpdate (Maybe Text) Source #
The Amazon OpenSearch Service index name.
amazonopensearchserviceDestinationUpdate_indexRotationPeriod :: Lens' AmazonopensearchserviceDestinationUpdate (Maybe AmazonopensearchserviceIndexRotationPeriod) Source #
The Amazon OpenSearch Service index rotation period. Index rotation appends a timestamp to IndexName to facilitate the expiration of old data.
amazonopensearchserviceDestinationUpdate_processingConfiguration :: Lens' AmazonopensearchserviceDestinationUpdate (Maybe ProcessingConfiguration) Source #
Undocumented member.
amazonopensearchserviceDestinationUpdate_retryOptions :: Lens' AmazonopensearchserviceDestinationUpdate (Maybe AmazonopensearchserviceRetryOptions) Source #
The retry behavior in case Kinesis Data Firehose is unable to deliver documents to Amazon OpenSearch Service. The default value is 300 (5 minutes).
amazonopensearchserviceDestinationUpdate_roleARN :: Lens' AmazonopensearchserviceDestinationUpdate (Maybe Text) Source #
The Amazon Resource Name (ARN) of the IAM role to be assumed by Kinesis Data Firehose for calling the Amazon OpenSearch Service Configuration API and for indexing documents.
amazonopensearchserviceDestinationUpdate_s3Update :: Lens' AmazonopensearchserviceDestinationUpdate (Maybe S3DestinationUpdate) Source #
Undocumented member.
amazonopensearchserviceDestinationUpdate_typeName :: Lens' AmazonopensearchserviceDestinationUpdate (Maybe Text) Source #
The Amazon OpenSearch Service type name. For Elasticsearch 6.x, there can be only one type per index. If you try to specify a new type for an existing index that already has another type, Kinesis Data Firehose returns an error during runtime.
If you upgrade Elasticsearch from 6.x to 7.x and don’t update your delivery stream, Kinesis Data Firehose still delivers data to Elasticsearch with the old index name and type name. If you want to update your delivery stream with a new index name, provide an empty string for TypeName.
AmazonopensearchserviceRetryOptions
amazonopensearchserviceRetryOptions_durationInSeconds :: Lens' AmazonopensearchserviceRetryOptions (Maybe Natural) Source #
After an initial failure to deliver to Amazon OpenSearch Service, the total amount of time during which Kinesis Data Firehose retries delivery (including the first attempt). After this time has elapsed, the failed documents are written to Amazon S3. Default value is 300 seconds (5 minutes). A value of 0 (zero) results in no retries.
BufferingHints
bufferingHints_intervalInSeconds :: Lens' BufferingHints (Maybe Natural) Source #
Buffer incoming data for the specified period of time, in seconds,
before delivering it to the destination. The default value is 300. This
parameter is optional but if you specify a value for it, you must also
specify a value for SizeInMBs
, and vice versa.
bufferingHints_sizeInMBs :: Lens' BufferingHints (Maybe Natural) Source #
Buffer incoming data to the specified size, in MiBs, before delivering
it to the destination. The default value is 5. This parameter is
optional but if you specify a value for it, you must also specify a
value for IntervalInSeconds
, and vice versa.
We recommend setting this parameter to a value greater than the amount of data you typically ingest into the delivery stream in 10 seconds. For example, if you typically ingest data at 1 MiB/sec, the value should be 10 MiB or higher.
CloudWatchLoggingOptions
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
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
dataFormatConversionConfiguration_enabled :: Lens' DataFormatConversionConfiguration (Maybe Bool) Source #
Defaults to true
. Set it to false
if you want to disable format
conversion while preserving the configuration details.
dataFormatConversionConfiguration_inputFormatConfiguration :: Lens' DataFormatConversionConfiguration (Maybe InputFormatConfiguration) Source #
Specifies the deserializer that you want Kinesis Data Firehose to use to
convert the format of your data from JSON. This parameter is required if
Enabled
is set to true.
dataFormatConversionConfiguration_outputFormatConfiguration :: Lens' DataFormatConversionConfiguration (Maybe OutputFormatConfiguration) Source #
Specifies the serializer that you want Kinesis Data Firehose to use to
convert the format of your data to the Parquet or ORC format. This
parameter is required if Enabled
is set to true.
dataFormatConversionConfiguration_schemaConfiguration :: Lens' DataFormatConversionConfiguration (Maybe SchemaConfiguration) Source #
Specifies the Amazon Web Services Glue Data Catalog table that contains
the column information. This parameter is required if Enabled
is set
to true.
DeliveryStreamDescription
deliveryStreamDescription_createTimestamp :: Lens' DeliveryStreamDescription (Maybe UTCTime) Source #
The date and time that the delivery stream was created.
deliveryStreamDescription_deliveryStreamEncryptionConfiguration :: Lens' DeliveryStreamDescription (Maybe DeliveryStreamEncryptionConfiguration) Source #
Indicates the server-side encryption (SSE) status for the delivery stream.
deliveryStreamDescription_failureDescription :: Lens' DeliveryStreamDescription (Maybe FailureDescription) Source #
Provides details in case one of the following operations fails due to an error related to KMS: CreateDeliveryStream, DeleteDeliveryStream, StartDeliveryStreamEncryption, StopDeliveryStreamEncryption.
deliveryStreamDescription_lastUpdateTimestamp :: Lens' DeliveryStreamDescription (Maybe UTCTime) Source #
The date and time that the delivery stream was last updated.
deliveryStreamDescription_source :: Lens' DeliveryStreamDescription (Maybe SourceDescription) Source #
If the DeliveryStreamType
parameter is KinesisStreamAsSource
, a
SourceDescription object describing the source Kinesis data stream.
deliveryStreamDescription_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 Amazon Web Services 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
deliveryStreamEncryptionConfiguration_failureDescription :: Lens' DeliveryStreamEncryptionConfiguration (Maybe FailureDescription) Source #
Provides details in case one of the following operations fails due to an error related to KMS: CreateDeliveryStream, DeleteDeliveryStream, StartDeliveryStreamEncryption, StopDeliveryStreamEncryption.
deliveryStreamEncryptionConfiguration_keyARN :: Lens' DeliveryStreamEncryptionConfiguration (Maybe Text) Source #
If KeyType
is CUSTOMER_MANAGED_CMK
, this field contains the ARN of
the customer managed CMK. If KeyType
is
Amazon Web Services_OWNED_CMK
, DeliveryStreamEncryptionConfiguration
doesn't contain a value for KeyARN
.
deliveryStreamEncryptionConfiguration_keyType :: Lens' DeliveryStreamEncryptionConfiguration (Maybe KeyType) Source #
Indicates the type of customer master key (CMK) that is used for
encryption. The default setting is Amazon Web Services_OWNED_CMK
. For
more information about CMKs, see
Customer Master Keys (CMKs).
deliveryStreamEncryptionConfiguration_status :: Lens' DeliveryStreamEncryptionConfiguration (Maybe DeliveryStreamEncryptionStatus) Source #
This is the server-side encryption (SSE) status for the delivery stream.
For a full description of the different values of this status, see
StartDeliveryStreamEncryption and StopDeliveryStreamEncryption. If this
status is ENABLING_FAILED
or DISABLING_FAILED
, it is the status of
the most recent attempt to enable or disable SSE, respectively.
DeliveryStreamEncryptionConfigurationInput
deliveryStreamEncryptionConfigurationInput_keyARN :: Lens' DeliveryStreamEncryptionConfigurationInput (Maybe Text) Source #
If you set KeyType
to CUSTOMER_MANAGED_CMK
, you must specify the
Amazon Resource Name (ARN) of the CMK. If you set KeyType
to
Amazon Web Services_OWNED_CMK
, Kinesis Data Firehose uses a
service-account CMK.
deliveryStreamEncryptionConfigurationInput_keyType :: Lens' DeliveryStreamEncryptionConfigurationInput KeyType Source #
Indicates the type of customer master key (CMK) to use for encryption.
The default setting is Amazon Web Services_OWNED_CMK
. For more
information about CMKs, see
Customer Master Keys (CMKs).
When you invoke CreateDeliveryStream or StartDeliveryStreamEncryption
with KeyType
set to CUSTOMER_MANAGED_CMK, Kinesis Data Firehose
invokes the Amazon KMS operation
CreateGrant
to create a grant that allows the Kinesis Data Firehose service to use
the customer managed CMK to perform encryption and decryption. Kinesis
Data Firehose manages that grant.
When you invoke StartDeliveryStreamEncryption to change the CMK for a delivery stream that is encrypted with a customer managed CMK, Kinesis Data Firehose schedules the grant it had on the old CMK for retirement.
You can use a CMK of type CUSTOMER_MANAGED_CMK to encrypt up to 500
delivery streams. If a CreateDeliveryStream or
StartDeliveryStreamEncryption operation exceeds this limit, Kinesis Data
Firehose throws a LimitExceededException
.
To encrypt your delivery stream, use symmetric CMKs. Kinesis Data Firehose doesn't support asymmetric CMKs. For information about symmetric and asymmetric CMKs, see About Symmetric and Asymmetric CMKs in the Amazon Web Services Key Management Service developer guide.
Deserializer
deserializer_hiveJsonSerDe :: Lens' Deserializer (Maybe HiveJsonSerDe) Source #
The native Hive / HCatalog JsonSerDe. Used by Kinesis Data Firehose for deserializing data, which means converting it from the JSON format in preparation for serializing it to the Parquet or ORC format. This is one of two deserializers you can choose, depending on which one offers the functionality you need. The other option is the OpenX SerDe.
deserializer_openXJsonSerDe :: Lens' Deserializer (Maybe OpenXJsonSerDe) Source #
The OpenX SerDe. Used by Kinesis Data Firehose for deserializing data, which means converting it from the JSON format in preparation for serializing it to the Parquet or ORC format. This is one of two deserializers you can choose, depending on which one offers the functionality you need. The other option is the native Hive / HCatalog JsonSerDe.
DestinationDescription
destinationDescription_amazonOpenSearchServerlessDestinationDescription :: Lens' DestinationDescription (Maybe AmazonOpenSearchServerlessDestinationDescription) Source #
The destination in the Serverless offering for Amazon OpenSearch Service.
destinationDescription_amazonopensearchserviceDestinationDescription :: Lens' DestinationDescription (Maybe AmazonopensearchserviceDestinationDescription) Source #
The destination in Amazon OpenSearch Service.
destinationDescription_elasticsearchDestinationDescription :: Lens' DestinationDescription (Maybe ElasticsearchDestinationDescription) Source #
The destination in Amazon ES.
destinationDescription_extendedS3DestinationDescription :: Lens' DestinationDescription (Maybe ExtendedS3DestinationDescription) Source #
The destination in Amazon S3.
destinationDescription_httpEndpointDestinationDescription :: Lens' DestinationDescription (Maybe HttpEndpointDestinationDescription) Source #
Describes the specified HTTP endpoint destination.
destinationDescription_redshiftDestinationDescription :: Lens' DestinationDescription (Maybe RedshiftDestinationDescription) Source #
The destination in Amazon Redshift.
destinationDescription_s3DestinationDescription :: Lens' DestinationDescription (Maybe S3DestinationDescription) Source #
- Deprecated
- The destination in Amazon S3.
destinationDescription_splunkDestinationDescription :: Lens' DestinationDescription (Maybe SplunkDestinationDescription) Source #
The destination in Splunk.
destinationDescription_destinationId :: Lens' DestinationDescription Text Source #
The ID of the destination.
DynamicPartitioningConfiguration
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
elasticsearchBufferingHints_intervalInSeconds :: Lens' ElasticsearchBufferingHints (Maybe Natural) Source #
Buffer incoming data for the specified period of time, in seconds, before delivering it to the destination. The default value is 300 (5 minutes).
elasticsearchBufferingHints_sizeInMBs :: Lens' ElasticsearchBufferingHints (Maybe Natural) Source #
Buffer incoming data to the specified size, in MBs, before delivering it to the destination. The default value is 5.
We recommend setting this parameter to a value greater than the amount of data you typically ingest into the delivery stream in 10 seconds. For example, if you typically ingest data at 1 MB/sec, the value should be 10 MB or higher.
ElasticsearchDestinationConfiguration
elasticsearchDestinationConfiguration_bufferingHints :: Lens' ElasticsearchDestinationConfiguration (Maybe ElasticsearchBufferingHints) Source #
The buffering options. If no value is specified, the default values for
ElasticsearchBufferingHints
are used.
elasticsearchDestinationConfiguration_cloudWatchLoggingOptions :: Lens' ElasticsearchDestinationConfiguration (Maybe CloudWatchLoggingOptions) Source #
The Amazon CloudWatch logging options for your delivery stream.
elasticsearchDestinationConfiguration_clusterEndpoint :: Lens' ElasticsearchDestinationConfiguration (Maybe Text) Source #
The endpoint to use when communicating with the cluster. Specify either
this ClusterEndpoint
or the DomainARN
field.
elasticsearchDestinationConfiguration_domainARN :: Lens' ElasticsearchDestinationConfiguration (Maybe Text) Source #
The ARN of the Amazon ES domain. The IAM role must have permissions
for DescribeDomain
, DescribeDomains
, and
DescribeDomainConfig
after assuming the role specified in RoleARN.
For more information, see
Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.
Specify either ClusterEndpoint
or DomainARN
.
elasticsearchDestinationConfiguration_indexRotationPeriod :: Lens' ElasticsearchDestinationConfiguration (Maybe ElasticsearchIndexRotationPeriod) Source #
The Elasticsearch index rotation period. Index rotation appends a
timestamp to the IndexName
to facilitate the expiration of old data.
For more information, see
Index Rotation for the Amazon ES Destination.
The default value is OneDay
.
elasticsearchDestinationConfiguration_processingConfiguration :: Lens' ElasticsearchDestinationConfiguration (Maybe ProcessingConfiguration) Source #
The data processing configuration.
elasticsearchDestinationConfiguration_retryOptions :: Lens' ElasticsearchDestinationConfiguration (Maybe ElasticsearchRetryOptions) Source #
The retry behavior in case Kinesis Data Firehose is unable to deliver documents to Amazon ES. The default value is 300 (5 minutes).
elasticsearchDestinationConfiguration_s3BackupMode :: Lens' ElasticsearchDestinationConfiguration (Maybe ElasticsearchS3BackupMode) Source #
Defines how documents should be delivered to Amazon S3. When it is set
to FailedDocumentsOnly
, Kinesis Data Firehose writes any documents
that could not be indexed to the configured Amazon S3 destination, with
AmazonOpenSearchService-failed/
appended to the key prefix. When set
to AllDocuments
, Kinesis Data Firehose delivers all incoming records
to Amazon S3, and also writes failed documents with
AmazonOpenSearchService-failed/
appended to the prefix. For more
information, see
Amazon S3 Backup for the Amazon ES Destination.
Default value is FailedDocumentsOnly
.
You can't change this backup mode after you create the delivery stream.
elasticsearchDestinationConfiguration_typeName :: Lens' ElasticsearchDestinationConfiguration (Maybe Text) Source #
The Elasticsearch type name. For Elasticsearch 6.x, there can be only one type per index. If you try to specify a new type for an existing index that already has another type, Kinesis Data Firehose returns an error during run time.
For Elasticsearch 7.x, don't specify a TypeName
.
elasticsearchDestinationConfiguration_vpcConfiguration :: Lens' ElasticsearchDestinationConfiguration (Maybe VpcConfiguration) Source #
The details of the VPC of the Amazon ES destination.
elasticsearchDestinationConfiguration_roleARN :: Lens' ElasticsearchDestinationConfiguration Text Source #
The Amazon Resource Name (ARN) of the IAM role to be assumed by Kinesis Data Firehose for calling the Amazon ES Configuration API and for indexing documents. For more information, see Grant Kinesis Data Firehose Access to an Amazon S3 Destination and Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.
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
elasticsearchDestinationDescription_bufferingHints :: Lens' ElasticsearchDestinationDescription (Maybe ElasticsearchBufferingHints) Source #
The buffering options.
elasticsearchDestinationDescription_cloudWatchLoggingOptions :: Lens' ElasticsearchDestinationDescription (Maybe CloudWatchLoggingOptions) Source #
The Amazon CloudWatch logging options.
elasticsearchDestinationDescription_clusterEndpoint :: Lens' ElasticsearchDestinationDescription (Maybe Text) Source #
The endpoint to use when communicating with the cluster. Kinesis Data
Firehose uses either this ClusterEndpoint
or the DomainARN
field to
send data to Amazon ES.
elasticsearchDestinationDescription_domainARN :: Lens' ElasticsearchDestinationDescription (Maybe Text) Source #
The ARN of the Amazon ES domain. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.
Kinesis Data Firehose uses either ClusterEndpoint
or DomainARN
to
send data to Amazon ES.
elasticsearchDestinationDescription_indexName :: Lens' ElasticsearchDestinationDescription (Maybe Text) Source #
The Elasticsearch index name.
elasticsearchDestinationDescription_indexRotationPeriod :: Lens' ElasticsearchDestinationDescription (Maybe ElasticsearchIndexRotationPeriod) Source #
The Elasticsearch index rotation period
elasticsearchDestinationDescription_processingConfiguration :: Lens' ElasticsearchDestinationDescription (Maybe ProcessingConfiguration) Source #
The data processing configuration.
elasticsearchDestinationDescription_retryOptions :: Lens' ElasticsearchDestinationDescription (Maybe ElasticsearchRetryOptions) Source #
The Amazon ES retry options.
elasticsearchDestinationDescription_roleARN :: Lens' ElasticsearchDestinationDescription (Maybe Text) Source #
The Amazon Resource Name (ARN) of the Amazon Web Services credentials. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.
elasticsearchDestinationDescription_s3BackupMode :: Lens' ElasticsearchDestinationDescription (Maybe ElasticsearchS3BackupMode) Source #
The Amazon S3 backup mode.
elasticsearchDestinationDescription_s3DestinationDescription :: Lens' ElasticsearchDestinationDescription (Maybe S3DestinationDescription) Source #
The Amazon S3 destination.
elasticsearchDestinationDescription_typeName :: Lens' ElasticsearchDestinationDescription (Maybe Text) Source #
The Elasticsearch type name. This applies to Elasticsearch 6.x and lower
versions. For Elasticsearch 7.x and OpenSearch Service 1.x, there's no
value for TypeName
.
elasticsearchDestinationDescription_vpcConfigurationDescription :: Lens' ElasticsearchDestinationDescription (Maybe VpcConfigurationDescription) Source #
The details of the VPC of the Amazon ES destination.
ElasticsearchDestinationUpdate
elasticsearchDestinationUpdate_bufferingHints :: Lens' ElasticsearchDestinationUpdate (Maybe ElasticsearchBufferingHints) Source #
The buffering options. If no value is specified,
ElasticsearchBufferingHints
object default values are used.
elasticsearchDestinationUpdate_cloudWatchLoggingOptions :: Lens' ElasticsearchDestinationUpdate (Maybe CloudWatchLoggingOptions) Source #
The CloudWatch logging options for your delivery stream.
elasticsearchDestinationUpdate_clusterEndpoint :: Lens' ElasticsearchDestinationUpdate (Maybe Text) Source #
The endpoint to use when communicating with the cluster. Specify either
this ClusterEndpoint
or the DomainARN
field.
elasticsearchDestinationUpdate_domainARN :: Lens' ElasticsearchDestinationUpdate (Maybe Text) Source #
The ARN of the Amazon ES domain. The IAM role must have permissions
for DescribeDomain
, DescribeDomains
, and
DescribeDomainConfig
after assuming the IAM role specified in
RoleARN
. For more information, see
Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.
Specify either ClusterEndpoint
or DomainARN
.
elasticsearchDestinationUpdate_indexName :: Lens' ElasticsearchDestinationUpdate (Maybe Text) Source #
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_processingConfiguration :: Lens' ElasticsearchDestinationUpdate (Maybe ProcessingConfiguration) Source #
The data processing configuration.
elasticsearchDestinationUpdate_retryOptions :: Lens' ElasticsearchDestinationUpdate (Maybe ElasticsearchRetryOptions) Source #
The retry behavior in case Kinesis Data Firehose is unable to deliver documents to Amazon ES. The default value is 300 (5 minutes).
elasticsearchDestinationUpdate_roleARN :: Lens' ElasticsearchDestinationUpdate (Maybe Text) Source #
The Amazon Resource Name (ARN) of the IAM role to be assumed by Kinesis Data Firehose for calling the Amazon ES Configuration API and for indexing documents. For more information, see Grant Kinesis Data Firehose Access to an Amazon S3 Destination and Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.
elasticsearchDestinationUpdate_s3Update :: Lens' ElasticsearchDestinationUpdate (Maybe S3DestinationUpdate) Source #
The Amazon S3 destination.
elasticsearchDestinationUpdate_typeName :: Lens' ElasticsearchDestinationUpdate (Maybe Text) Source #
The Elasticsearch type name. For Elasticsearch 6.x, there can be only one type per index. If you try to specify a new type for an existing index that already has another type, Kinesis Data Firehose returns an error during runtime.
If you upgrade Elasticsearch from 6.x to 7.x and don’t update your
delivery stream, Kinesis Data Firehose still delivers data to
Elasticsearch with the old index name and type name. If you want to
update your delivery stream with a new index name, provide an empty
string for TypeName
.
ElasticsearchRetryOptions
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
encryptionConfiguration_kmsEncryptionConfig :: Lens' EncryptionConfiguration (Maybe KMSEncryptionConfig) Source #
The encryption key.
encryptionConfiguration_noEncryptionConfig :: Lens' EncryptionConfiguration (Maybe NoEncryptionConfig) Source #
Specifically override existing encryption information to ensure that no encryption is used.
ExtendedS3DestinationConfiguration
extendedS3DestinationConfiguration_bufferingHints :: Lens' ExtendedS3DestinationConfiguration (Maybe BufferingHints) Source #
The buffering option.
extendedS3DestinationConfiguration_cloudWatchLoggingOptions :: Lens' ExtendedS3DestinationConfiguration (Maybe CloudWatchLoggingOptions) Source #
The Amazon CloudWatch logging options for your delivery stream.
extendedS3DestinationConfiguration_compressionFormat :: Lens' ExtendedS3DestinationConfiguration (Maybe CompressionFormat) Source #
The compression format. If no value is specified, the default is UNCOMPRESSED.
extendedS3DestinationConfiguration_dataFormatConversionConfiguration :: Lens' ExtendedS3DestinationConfiguration (Maybe DataFormatConversionConfiguration) Source #
The serializer, deserializer, and schema for converting data from the JSON format to the Parquet or ORC format before writing it to Amazon S3.
extendedS3DestinationConfiguration_dynamicPartitioningConfiguration :: Lens' ExtendedS3DestinationConfiguration (Maybe DynamicPartitioningConfiguration) Source #
The configuration of the dynamic partitioning mechanism that creates smaller data sets from the streaming data by partitioning it based on partition keys. Currently, dynamic partitioning is only supported for Amazon S3 destinations.
extendedS3DestinationConfiguration_encryptionConfiguration :: Lens' ExtendedS3DestinationConfiguration (Maybe EncryptionConfiguration) Source #
The encryption configuration. If no value is specified, the default is no encryption.
extendedS3DestinationConfiguration_errorOutputPrefix :: Lens' ExtendedS3DestinationConfiguration (Maybe Text) Source #
A prefix that Kinesis Data Firehose evaluates and adds to failed records before writing them to S3. This prefix appears immediately following the bucket name. For information about how to specify this prefix, see Custom Prefixes for Amazon S3 Objects.
extendedS3DestinationConfiguration_prefix :: Lens' ExtendedS3DestinationConfiguration (Maybe Text) Source #
The "YYYY/MM/DD/HH" time format prefix is automatically used for delivered Amazon S3 files. You can also specify a custom prefix, as described in Custom Prefixes for Amazon S3 Objects.
extendedS3DestinationConfiguration_processingConfiguration :: Lens' ExtendedS3DestinationConfiguration (Maybe ProcessingConfiguration) Source #
The data processing configuration.
extendedS3DestinationConfiguration_s3BackupConfiguration :: Lens' ExtendedS3DestinationConfiguration (Maybe S3DestinationConfiguration) Source #
The configuration for backup in Amazon S3.
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_roleARN :: Lens' ExtendedS3DestinationConfiguration Text Source #
The Amazon Resource Name (ARN) of the Amazon Web Services credentials. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.
extendedS3DestinationConfiguration_bucketARN :: Lens' ExtendedS3DestinationConfiguration Text Source #
The ARN of the S3 bucket. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.
ExtendedS3DestinationDescription
extendedS3DestinationDescription_cloudWatchLoggingOptions :: Lens' ExtendedS3DestinationDescription (Maybe CloudWatchLoggingOptions) Source #
The Amazon CloudWatch logging options for your delivery stream.
extendedS3DestinationDescription_dataFormatConversionConfiguration :: Lens' ExtendedS3DestinationDescription (Maybe DataFormatConversionConfiguration) Source #
The serializer, deserializer, and schema for converting data from the JSON format to the Parquet or ORC format before writing it to Amazon S3.
extendedS3DestinationDescription_dynamicPartitioningConfiguration :: Lens' ExtendedS3DestinationDescription (Maybe DynamicPartitioningConfiguration) Source #
The configuration of the dynamic partitioning mechanism that creates smaller data sets from the streaming data by partitioning it based on partition keys. Currently, dynamic partitioning is only supported for Amazon S3 destinations.
extendedS3DestinationDescription_errorOutputPrefix :: Lens' ExtendedS3DestinationDescription (Maybe Text) Source #
A prefix that Kinesis Data Firehose evaluates and adds to failed records before writing them to S3. This prefix appears immediately following the bucket name. For information about how to specify this prefix, see Custom Prefixes for Amazon S3 Objects.
extendedS3DestinationDescription_prefix :: Lens' ExtendedS3DestinationDescription (Maybe Text) Source #
The "YYYY/MM/DD/HH" time format prefix is automatically used for delivered Amazon S3 files. You can also specify a custom prefix, as described in Custom Prefixes for Amazon S3 Objects.
extendedS3DestinationDescription_processingConfiguration :: Lens' ExtendedS3DestinationDescription (Maybe ProcessingConfiguration) Source #
The data processing configuration.
extendedS3DestinationDescription_s3BackupDescription :: Lens' ExtendedS3DestinationDescription (Maybe S3DestinationDescription) Source #
The configuration for backup in Amazon S3.
extendedS3DestinationDescription_s3BackupMode :: Lens' ExtendedS3DestinationDescription (Maybe S3BackupMode) Source #
The Amazon S3 backup mode.
extendedS3DestinationDescription_roleARN :: Lens' ExtendedS3DestinationDescription Text Source #
The Amazon Resource Name (ARN) of the Amazon Web Services credentials. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.
extendedS3DestinationDescription_bucketARN :: Lens' ExtendedS3DestinationDescription Text Source #
The ARN of the S3 bucket. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services 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
extendedS3DestinationUpdate_bucketARN :: Lens' ExtendedS3DestinationUpdate (Maybe Text) Source #
The ARN of the S3 bucket. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.
extendedS3DestinationUpdate_bufferingHints :: Lens' ExtendedS3DestinationUpdate (Maybe BufferingHints) Source #
The buffering option.
extendedS3DestinationUpdate_cloudWatchLoggingOptions :: Lens' ExtendedS3DestinationUpdate (Maybe CloudWatchLoggingOptions) Source #
The Amazon CloudWatch logging options for your delivery stream.
extendedS3DestinationUpdate_compressionFormat :: Lens' ExtendedS3DestinationUpdate (Maybe CompressionFormat) Source #
The compression format. If no value is specified, the default is
UNCOMPRESSED
.
extendedS3DestinationUpdate_dataFormatConversionConfiguration :: Lens' ExtendedS3DestinationUpdate (Maybe DataFormatConversionConfiguration) Source #
The serializer, deserializer, and schema for converting data from the JSON format to the Parquet or ORC format before writing it to Amazon S3.
extendedS3DestinationUpdate_dynamicPartitioningConfiguration :: Lens' ExtendedS3DestinationUpdate (Maybe DynamicPartitioningConfiguration) Source #
The configuration of the dynamic partitioning mechanism that creates smaller data sets from the streaming data by partitioning it based on partition keys. Currently, dynamic partitioning is only supported for Amazon S3 destinations.
extendedS3DestinationUpdate_encryptionConfiguration :: Lens' ExtendedS3DestinationUpdate (Maybe EncryptionConfiguration) Source #
The encryption configuration. If no value is specified, the default is no encryption.
extendedS3DestinationUpdate_errorOutputPrefix :: Lens' ExtendedS3DestinationUpdate (Maybe Text) Source #
A prefix that Kinesis Data Firehose evaluates and adds to failed records before writing them to S3. This prefix appears immediately following the bucket name. For information about how to specify this prefix, see Custom Prefixes for Amazon S3 Objects.
extendedS3DestinationUpdate_prefix :: Lens' ExtendedS3DestinationUpdate (Maybe Text) Source #
The "YYYY/MM/DD/HH" time format prefix is automatically used for delivered Amazon S3 files. You can also specify a custom prefix, as described in Custom Prefixes for Amazon S3 Objects.
extendedS3DestinationUpdate_processingConfiguration :: Lens' ExtendedS3DestinationUpdate (Maybe ProcessingConfiguration) Source #
The data processing configuration.
extendedS3DestinationUpdate_roleARN :: Lens' ExtendedS3DestinationUpdate (Maybe Text) Source #
The Amazon Resource Name (ARN) of the Amazon Web Services credentials. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.
extendedS3DestinationUpdate_s3BackupMode :: Lens' ExtendedS3DestinationUpdate (Maybe S3BackupMode) Source #
You can update a delivery stream to enable Amazon S3 backup if it is disabled. If backup is enabled, you can't update the delivery stream to disable it.
extendedS3DestinationUpdate_s3BackupUpdate :: Lens' ExtendedS3DestinationUpdate (Maybe S3DestinationUpdate) Source #
The Amazon S3 destination for backup.
FailureDescription
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
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
httpEndpointBufferingHints_intervalInSeconds :: Lens' HttpEndpointBufferingHints (Maybe Natural) Source #
Buffer incoming data for the specified period of time, in seconds, before delivering it to the destination. The default value is 300 (5 minutes).
httpEndpointBufferingHints_sizeInMBs :: Lens' HttpEndpointBufferingHints (Maybe Natural) Source #
Buffer incoming data to the specified size, in MBs, before delivering it to the destination. The default value is 5.
We recommend setting this parameter to a value greater than the amount of data you typically ingest into the delivery stream in 10 seconds. For example, if you typically ingest data at 1 MB/sec, the value should be 10 MB or higher.
HttpEndpointCommonAttribute
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
httpEndpointConfiguration_accessKey :: Lens' HttpEndpointConfiguration (Maybe Text) Source #
The access key required for Kinesis Firehose to authenticate with the HTTP endpoint selected as the destination.
httpEndpointConfiguration_name :: Lens' HttpEndpointConfiguration (Maybe Text) Source #
The name of the HTTP endpoint selected as the destination.
httpEndpointConfiguration_url :: Lens' HttpEndpointConfiguration Text Source #
The URL of the HTTP endpoint selected as the destination.
If you choose an HTTP endpoint as your destination, review and follow the instructions in the Appendix - HTTP Endpoint Delivery Request and Response Specifications.
HttpEndpointDescription
httpEndpointDescription_name :: Lens' HttpEndpointDescription (Maybe Text) Source #
The name of the HTTP endpoint selected as the destination.
httpEndpointDescription_url :: Lens' HttpEndpointDescription (Maybe Text) Source #
The URL of the HTTP endpoint selected as the destination.
HttpEndpointDestinationConfiguration
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_cloudWatchLoggingOptions :: Lens' HttpEndpointDestinationConfiguration (Maybe CloudWatchLoggingOptions) Source #
Undocumented member.
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_retryOptions :: Lens' HttpEndpointDestinationConfiguration (Maybe HttpEndpointRetryOptions) Source #
Describes the retry behavior in case Kinesis Data Firehose is unable to deliver data to the specified HTTP endpoint destination, or if it doesn't receive a valid acknowledgment of receipt from the specified HTTP endpoint destination.
httpEndpointDestinationConfiguration_roleARN :: Lens' HttpEndpointDestinationConfiguration (Maybe Text) Source #
Kinesis Data Firehose uses this IAM role for all the permissions that the delivery stream needs.
httpEndpointDestinationConfiguration_s3BackupMode :: Lens' HttpEndpointDestinationConfiguration (Maybe HttpEndpointS3BackupMode) Source #
Describes the S3 bucket backup options for the data that Kinesis Data
Firehose delivers to the HTTP endpoint destination. You can back up all
documents (AllData
) or only the documents that Kinesis Data Firehose
could not deliver to the specified HTTP endpoint destination
(FailedDataOnly
).
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
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_cloudWatchLoggingOptions :: Lens' HttpEndpointDestinationDescription (Maybe CloudWatchLoggingOptions) Source #
Undocumented member.
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_retryOptions :: Lens' HttpEndpointDestinationDescription (Maybe HttpEndpointRetryOptions) Source #
Describes the retry behavior in case Kinesis Data Firehose is unable to deliver data to the specified HTTP endpoint destination, or if it doesn't receive a valid acknowledgment of receipt from the specified HTTP endpoint destination.
httpEndpointDestinationDescription_roleARN :: Lens' HttpEndpointDestinationDescription (Maybe Text) Source #
Kinesis Data Firehose uses this IAM role for all the permissions that the delivery stream needs.
httpEndpointDestinationDescription_s3BackupMode :: Lens' HttpEndpointDestinationDescription (Maybe HttpEndpointS3BackupMode) Source #
Describes the S3 bucket backup options for the data that Kinesis
Firehose delivers to the HTTP endpoint destination. You can back up all
documents (AllData
) or only the documents that Kinesis Data Firehose
could not deliver to the specified HTTP endpoint destination
(FailedDataOnly
).
httpEndpointDestinationDescription_s3DestinationDescription :: Lens' HttpEndpointDestinationDescription (Maybe S3DestinationDescription) Source #
Undocumented member.
HttpEndpointDestinationUpdate
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_cloudWatchLoggingOptions :: Lens' HttpEndpointDestinationUpdate (Maybe CloudWatchLoggingOptions) Source #
Undocumented member.
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_retryOptions :: Lens' HttpEndpointDestinationUpdate (Maybe HttpEndpointRetryOptions) Source #
Describes the retry behavior in case Kinesis Data Firehose is unable to deliver data to the specified HTTP endpoint destination, or if it doesn't receive a valid acknowledgment of receipt from the specified HTTP endpoint destination.
httpEndpointDestinationUpdate_roleARN :: Lens' HttpEndpointDestinationUpdate (Maybe Text) Source #
Kinesis Data Firehose uses this IAM role for all the permissions that the delivery stream needs.
httpEndpointDestinationUpdate_s3BackupMode :: Lens' HttpEndpointDestinationUpdate (Maybe HttpEndpointS3BackupMode) Source #
Describes the S3 bucket backup options for the data that Kinesis
Firehose delivers to the HTTP endpoint destination. You can back up all
documents (AllData
) or only the documents that Kinesis Data Firehose
could not deliver to the specified HTTP endpoint destination
(FailedDataOnly
).
httpEndpointDestinationUpdate_s3Update :: Lens' HttpEndpointDestinationUpdate (Maybe S3DestinationUpdate) Source #
Undocumented member.
HttpEndpointRequestConfiguration
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
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
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
kmsEncryptionConfig_aWSKMSKeyARN :: Lens' KMSEncryptionConfig Text Source #
The Amazon Resource Name (ARN) of the encryption key. Must belong to the same Amazon Web Services Region as the destination Amazon S3 bucket. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.
KinesisStreamSourceConfiguration
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 Amazon Web Services Identity and Access Management (IAM) ARN Format.
KinesisStreamSourceDescription
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 Amazon Web Services Identity and Access Management (IAM) ARN Format.
OpenXJsonSerDe
openXJsonSerDe_caseInsensitive :: Lens' OpenXJsonSerDe (Maybe Bool) Source #
When set to true
, which is the default, Kinesis Data Firehose converts
JSON keys to lowercase before deserializing them.
openXJsonSerDe_columnToJsonKeyMappings :: Lens' OpenXJsonSerDe (Maybe (HashMap Text Text)) Source #
Maps column names to JSON keys that aren't identical to the column
names. This is useful when the JSON contains keys that are Hive
keywords. For example, timestamp
is a Hive keyword. If you have a JSON
key named timestamp
, set this parameter to {"ts": "timestamp"}
to map this key to a column named ts
.
openXJsonSerDe_convertDotsInJsonKeysToUnderscores :: Lens' OpenXJsonSerDe (Maybe Bool) Source #
When set to true
, specifies that the names of the keys include dots
and that you want Kinesis Data Firehose to replace them with
underscores. This is useful because Apache Hive does not allow dots in
column names. For example, if the JSON contains a key whose name is
"a.b", you can define the column name to be "a_b" when using this
option.
The default is false
.
OrcSerDe
orcSerDe_blockSizeBytes :: Lens' OrcSerDe (Maybe Natural) Source #
The Hadoop Distributed File System (HDFS) block size. This is useful if you intend to copy the data from Amazon S3 to HDFS before querying. The default is 256 MiB and the minimum is 64 MiB. Kinesis Data Firehose uses this value for padding calculations.
orcSerDe_bloomFilterColumns :: Lens' OrcSerDe (Maybe [Text]) Source #
The column names for which you want Kinesis Data Firehose to create
bloom filters. The default is null
.
orcSerDe_bloomFilterFalsePositiveProbability :: Lens' OrcSerDe (Maybe Double) Source #
The Bloom filter false positive probability (FPP). The lower the FPP, the bigger the Bloom filter. The default value is 0.05, the minimum is 0, and the maximum is 1.
orcSerDe_compression :: Lens' OrcSerDe (Maybe OrcCompression) Source #
The compression code to use over data blocks. The default is SNAPPY
.
orcSerDe_dictionaryKeyThreshold :: Lens' OrcSerDe (Maybe Double) Source #
Represents the fraction of the total number of non-null rows. To turn off dictionary encoding, set this fraction to a number that is less than the number of distinct keys in a dictionary. To always use dictionary encoding, set this threshold to 1.
orcSerDe_enablePadding :: Lens' OrcSerDe (Maybe Bool) Source #
Set this to true
to indicate that you want stripes to be padded to the
HDFS block boundaries. This is useful if you intend to copy the data
from Amazon S3 to HDFS before querying. The default is false
.
orcSerDe_formatVersion :: Lens' OrcSerDe (Maybe OrcFormatVersion) Source #
The version of the file to write. The possible values are V0_11
and
V0_12
. The default is V0_12
.
orcSerDe_paddingTolerance :: Lens' OrcSerDe (Maybe Double) Source #
A number between 0 and 1 that defines the tolerance for block padding as a decimal fraction of stripe size. The default value is 0.05, which means 5 percent of stripe size.
For the default values of 64 MiB ORC stripes and 256 MiB HDFS blocks, the default block padding tolerance of 5 percent reserves a maximum of 3.2 MiB for padding within the 256 MiB block. In such a case, if the available size within the block is more than 3.2 MiB, a new, smaller stripe is inserted to fit within that space. This ensures that no stripe crosses block boundaries and causes remote reads within a node-local task.
Kinesis Data Firehose ignores this parameter when OrcSerDe$EnablePadding
is false
.
orcSerDe_rowIndexStride :: Lens' OrcSerDe (Maybe Natural) Source #
The number of rows between index entries. The default is 10,000 and the minimum is 1,000.
orcSerDe_stripeSizeBytes :: Lens' OrcSerDe (Maybe Natural) Source #
The number of bytes in each stripe. The default is 64 MiB and the minimum is 8 MiB.
OutputFormatConfiguration
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
parquetSerDe_blockSizeBytes :: Lens' ParquetSerDe (Maybe Natural) Source #
The Hadoop Distributed File System (HDFS) block size. This is useful if you intend to copy the data from Amazon S3 to HDFS before querying. The default is 256 MiB and the minimum is 64 MiB. Kinesis Data Firehose uses this value for padding calculations.
parquetSerDe_compression :: Lens' ParquetSerDe (Maybe ParquetCompression) Source #
The compression code to use over data blocks. The possible values are
UNCOMPRESSED
, SNAPPY
, and GZIP
, with the default being SNAPPY
.
Use SNAPPY
for higher decompression speed. Use GZIP
if the
compression ratio is more important than speed.
parquetSerDe_enableDictionaryCompression :: Lens' ParquetSerDe (Maybe Bool) Source #
Indicates whether to enable dictionary compression.
parquetSerDe_maxPaddingBytes :: Lens' ParquetSerDe (Maybe Natural) Source #
The maximum amount of padding to apply. This is useful if you intend to copy the data from Amazon S3 to HDFS before querying. The default is 0.
parquetSerDe_pageSizeBytes :: Lens' ParquetSerDe (Maybe Natural) Source #
The Parquet page size. Column chunks are divided into pages. A page is conceptually an indivisible unit (in terms of compression and encoding). The minimum value is 64 KiB and the default is 1 MiB.
parquetSerDe_writerVersion :: Lens' ParquetSerDe (Maybe ParquetWriterVersion) Source #
Indicates the version of row format to output. The possible values are
V1
and V2
. The default is V1
.
ProcessingConfiguration
processingConfiguration_enabled :: Lens' ProcessingConfiguration (Maybe Bool) Source #
Enables or disables data processing.
processingConfiguration_processors :: Lens' ProcessingConfiguration (Maybe [Processor]) Source #
The data processors.
Processor
processor_parameters :: Lens' Processor (Maybe [ProcessorParameter]) Source #
The processor parameters.
processor_type :: Lens' Processor ProcessorType Source #
The type of processor.
ProcessorParameter
processorParameter_parameterName :: Lens' ProcessorParameter ProcessorParameterName Source #
The name of the parameter. Currently the following default values are
supported: 3 for NumberOfRetries
and 60 for the
BufferIntervalInSeconds
. The BufferSizeInMBs
ranges between 0.2 MB
and up to 3MB. The default buffering hint is 1MB for all destinations,
except Splunk. For Splunk, the default buffering hint is 256 KB.
processorParameter_parameterValue :: Lens' ProcessorParameter Text Source #
The parameter value.
PutRecordBatchResponseEntry
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.
putRecordBatchResponseEntry_recordId :: Lens' PutRecordBatchResponseEntry (Maybe Text) Source #
The ID of the record.
Record
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
redshiftDestinationConfiguration_cloudWatchLoggingOptions :: Lens' RedshiftDestinationConfiguration (Maybe CloudWatchLoggingOptions) Source #
The CloudWatch logging options for your delivery stream.
redshiftDestinationConfiguration_processingConfiguration :: Lens' RedshiftDestinationConfiguration (Maybe ProcessingConfiguration) Source #
The data processing configuration.
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_s3BackupConfiguration :: Lens' RedshiftDestinationConfiguration (Maybe S3DestinationConfiguration) Source #
The configuration for backup in Amazon S3.
redshiftDestinationConfiguration_s3BackupMode :: Lens' RedshiftDestinationConfiguration (Maybe RedshiftS3BackupMode) Source #
The Amazon S3 backup mode. After you create a delivery stream, you can update it to enable Amazon S3 backup if it is disabled. If backup is enabled, you can't update the delivery stream to disable it.
redshiftDestinationConfiguration_roleARN :: Lens' RedshiftDestinationConfiguration Text Source #
The Amazon Resource Name (ARN) of the Amazon Web Services credentials. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.
redshiftDestinationConfiguration_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
redshiftDestinationDescription_cloudWatchLoggingOptions :: Lens' RedshiftDestinationDescription (Maybe CloudWatchLoggingOptions) Source #
The Amazon CloudWatch logging options for your delivery stream.
redshiftDestinationDescription_processingConfiguration :: Lens' RedshiftDestinationDescription (Maybe ProcessingConfiguration) Source #
The data processing configuration.
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_s3BackupDescription :: Lens' RedshiftDestinationDescription (Maybe S3DestinationDescription) Source #
The configuration for backup in Amazon S3.
redshiftDestinationDescription_s3BackupMode :: Lens' RedshiftDestinationDescription (Maybe RedshiftS3BackupMode) Source #
The Amazon S3 backup mode.
redshiftDestinationDescription_roleARN :: Lens' RedshiftDestinationDescription Text Source #
The Amazon Resource Name (ARN) of the Amazon Web Services credentials. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.
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
redshiftDestinationUpdate_cloudWatchLoggingOptions :: Lens' RedshiftDestinationUpdate (Maybe CloudWatchLoggingOptions) Source #
The Amazon CloudWatch logging options for your delivery stream.
redshiftDestinationUpdate_clusterJDBCURL :: Lens' RedshiftDestinationUpdate (Maybe Text) Source #
The database connection string.
redshiftDestinationUpdate_copyCommand :: Lens' RedshiftDestinationUpdate (Maybe CopyCommand) Source #
The COPY
command.
redshiftDestinationUpdate_password :: Lens' RedshiftDestinationUpdate (Maybe Text) Source #
The user password.
redshiftDestinationUpdate_processingConfiguration :: Lens' RedshiftDestinationUpdate (Maybe ProcessingConfiguration) Source #
The data processing configuration.
redshiftDestinationUpdate_retryOptions :: Lens' RedshiftDestinationUpdate (Maybe RedshiftRetryOptions) Source #
The retry behavior in case Kinesis Data Firehose is unable to deliver documents to Amazon Redshift. Default value is 3600 (60 minutes).
redshiftDestinationUpdate_roleARN :: Lens' RedshiftDestinationUpdate (Maybe Text) Source #
The Amazon Resource Name (ARN) of the Amazon Web Services credentials. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.
redshiftDestinationUpdate_s3BackupMode :: Lens' RedshiftDestinationUpdate (Maybe RedshiftS3BackupMode) Source #
You can update a delivery stream to enable Amazon S3 backup if it is disabled. If backup is enabled, you can't update the delivery stream to disable it.
redshiftDestinationUpdate_s3BackupUpdate :: Lens' RedshiftDestinationUpdate (Maybe S3DestinationUpdate) Source #
The Amazon S3 destination for backup.
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_username :: Lens' RedshiftDestinationUpdate (Maybe Text) Source #
The name of the user.
RedshiftRetryOptions
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
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
s3DestinationConfiguration_bufferingHints :: Lens' S3DestinationConfiguration (Maybe BufferingHints) Source #
The buffering option. If no value is specified, BufferingHints
object
default values are used.
s3DestinationConfiguration_cloudWatchLoggingOptions :: Lens' S3DestinationConfiguration (Maybe CloudWatchLoggingOptions) Source #
The CloudWatch logging options for your delivery stream.
s3DestinationConfiguration_compressionFormat :: Lens' S3DestinationConfiguration (Maybe CompressionFormat) Source #
The compression format. If no value is specified, the default is
UNCOMPRESSED
.
The compression formats SNAPPY
or ZIP
cannot be specified for Amazon
Redshift destinations because they are not supported by the Amazon
Redshift COPY
operation that reads from the S3 bucket.
s3DestinationConfiguration_encryptionConfiguration :: Lens' S3DestinationConfiguration (Maybe EncryptionConfiguration) Source #
The encryption configuration. If no value is specified, the default is no encryption.
s3DestinationConfiguration_errorOutputPrefix :: Lens' S3DestinationConfiguration (Maybe Text) Source #
A prefix that Kinesis Data Firehose evaluates and adds to failed records before writing them to S3. This prefix appears immediately following the bucket name. For information about how to specify this prefix, see Custom Prefixes for Amazon S3 Objects.
s3DestinationConfiguration_prefix :: Lens' S3DestinationConfiguration (Maybe Text) Source #
The "YYYY/MM/DD/HH" time format prefix is automatically used for delivered Amazon S3 files. You can also specify a custom prefix, as described in Custom Prefixes for Amazon S3 Objects.
s3DestinationConfiguration_roleARN :: Lens' S3DestinationConfiguration Text Source #
The Amazon Resource Name (ARN) of the Amazon Web Services credentials. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.
s3DestinationConfiguration_bucketARN :: Lens' S3DestinationConfiguration Text Source #
The ARN of the S3 bucket. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.
S3DestinationDescription
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_prefix :: Lens' S3DestinationDescription (Maybe Text) Source #
The "YYYY/MM/DD/HH" time format prefix is automatically used for delivered Amazon S3 files. You can also specify a custom prefix, as described in Custom Prefixes for Amazon S3 Objects.
s3DestinationDescription_roleARN :: Lens' S3DestinationDescription Text Source #
The Amazon Resource Name (ARN) of the Amazon Web Services credentials. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.
s3DestinationDescription_bucketARN :: Lens' S3DestinationDescription Text Source #
The ARN of the S3 bucket. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.
s3DestinationDescription_bufferingHints :: Lens' S3DestinationDescription BufferingHints Source #
The buffering option. If no value is specified, BufferingHints
object
default values are used.
s3DestinationDescription_compressionFormat :: Lens' S3DestinationDescription CompressionFormat Source #
The compression format. If no value is specified, the default is
UNCOMPRESSED
.
s3DestinationDescription_encryptionConfiguration :: Lens' S3DestinationDescription EncryptionConfiguration Source #
The encryption configuration. If no value is specified, the default is no encryption.
S3DestinationUpdate
s3DestinationUpdate_bucketARN :: Lens' S3DestinationUpdate (Maybe Text) Source #
The ARN of the S3 bucket. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.
s3DestinationUpdate_bufferingHints :: Lens' S3DestinationUpdate (Maybe BufferingHints) Source #
The buffering option. If no value is specified, BufferingHints
object
default values are used.
s3DestinationUpdate_cloudWatchLoggingOptions :: Lens' S3DestinationUpdate (Maybe CloudWatchLoggingOptions) Source #
The CloudWatch logging options for your delivery stream.
s3DestinationUpdate_compressionFormat :: Lens' S3DestinationUpdate (Maybe CompressionFormat) Source #
The compression format. If no value is specified, the default is
UNCOMPRESSED
.
The compression formats SNAPPY
or ZIP
cannot be specified for Amazon
Redshift destinations because they are not supported by the Amazon
Redshift COPY
operation that reads from the S3 bucket.
s3DestinationUpdate_encryptionConfiguration :: Lens' S3DestinationUpdate (Maybe EncryptionConfiguration) Source #
The encryption configuration. If no value is specified, the default is no encryption.
s3DestinationUpdate_errorOutputPrefix :: Lens' S3DestinationUpdate (Maybe Text) Source #
A prefix that Kinesis Data Firehose evaluates and adds to failed records before writing them to S3. This prefix appears immediately following the bucket name. For information about how to specify this prefix, see Custom Prefixes for Amazon S3 Objects.
s3DestinationUpdate_prefix :: Lens' S3DestinationUpdate (Maybe Text) Source #
The "YYYY/MM/DD/HH" time format prefix is automatically used for delivered Amazon S3 files. You can also specify a custom prefix, as described in Custom Prefixes for Amazon S3 Objects.
s3DestinationUpdate_roleARN :: Lens' S3DestinationUpdate (Maybe Text) Source #
The Amazon Resource Name (ARN) of the Amazon Web Services credentials. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.
SchemaConfiguration
schemaConfiguration_catalogId :: Lens' SchemaConfiguration (Maybe Text) Source #
The ID of the Amazon Web Services Glue Data Catalog. If you don't supply this, the Amazon Web Services account ID is used by default.
schemaConfiguration_databaseName :: Lens' SchemaConfiguration (Maybe Text) Source #
Specifies the name of the Amazon Web Services Glue database that contains the schema for the output data.
If the SchemaConfiguration
request parameter is used as part of
invoking the CreateDeliveryStream
API, then the DatabaseName
property is required and its value must be specified.
schemaConfiguration_region :: Lens' SchemaConfiguration (Maybe Text) Source #
If you don't specify an Amazon Web Services Region, the default is the current Region.
schemaConfiguration_roleARN :: Lens' SchemaConfiguration (Maybe Text) Source #
The role that Kinesis Data Firehose can use to access Amazon Web Services Glue. This role must be in the same account you use for Kinesis Data Firehose. Cross-account roles aren't allowed.
If the SchemaConfiguration
request parameter is used as part of
invoking the CreateDeliveryStream
API, then the RoleARN
property is
required and its value must be specified.
schemaConfiguration_tableName :: Lens' SchemaConfiguration (Maybe Text) Source #
Specifies the Amazon Web Services Glue table that contains the column information that constitutes your data schema.
If the SchemaConfiguration
request parameter is used as part of
invoking the CreateDeliveryStream
API, then the TableName
property
is required and its value must be specified.
schemaConfiguration_versionId :: Lens' SchemaConfiguration (Maybe Text) Source #
Specifies the table version for the output data schema. If you don't
specify this version ID, or if you set it to LATEST
, Kinesis Data
Firehose uses the most recent version. This means that any updates to
the table are automatically picked up.
Serializer
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
sourceDescription_kinesisStreamSourceDescription :: Lens' SourceDescription (Maybe KinesisStreamSourceDescription) Source #
The KinesisStreamSourceDescription value for the source Kinesis data stream.
SplunkDestinationConfiguration
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_processingConfiguration :: Lens' SplunkDestinationConfiguration (Maybe ProcessingConfiguration) Source #
The data processing configuration.
splunkDestinationConfiguration_retryOptions :: Lens' SplunkDestinationConfiguration (Maybe SplunkRetryOptions) Source #
The retry behavior in case Kinesis Data Firehose is unable to deliver data to Splunk, or if it doesn't receive an acknowledgment of receipt from Splunk.
splunkDestinationConfiguration_s3BackupMode :: Lens' SplunkDestinationConfiguration (Maybe SplunkS3BackupMode) Source #
Defines how documents should be delivered to Amazon S3. When set to
FailedEventsOnly
, Kinesis Data Firehose writes any data that could not
be indexed to the configured Amazon S3 destination. When set to
AllEvents
, Kinesis Data Firehose delivers all incoming records to
Amazon S3, and also writes failed documents to Amazon S3. The default
value is FailedEventsOnly
.
You can update this backup mode from FailedEventsOnly
to AllEvents
.
You can't update it from AllEvents
to FailedEventsOnly
.
splunkDestinationConfiguration_hECEndpoint :: Lens' SplunkDestinationConfiguration Text Source #
The HTTP Event Collector (HEC) endpoint to which Kinesis Data Firehose sends your data.
splunkDestinationConfiguration_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
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_hECEndpoint :: Lens' SplunkDestinationDescription (Maybe Text) Source #
The HTTP Event Collector (HEC) endpoint to which Kinesis Data Firehose sends your data.
splunkDestinationDescription_hECEndpointType :: Lens' SplunkDestinationDescription (Maybe HECEndpointType) Source #
This type can be either "Raw" or "Event."
splunkDestinationDescription_hECToken :: Lens' SplunkDestinationDescription (Maybe Text) Source #
A GUID you obtain from your Splunk cluster when you create a new HEC endpoint.
splunkDestinationDescription_processingConfiguration :: Lens' SplunkDestinationDescription (Maybe ProcessingConfiguration) Source #
The data processing configuration.
splunkDestinationDescription_retryOptions :: Lens' SplunkDestinationDescription (Maybe SplunkRetryOptions) Source #
The retry behavior in case Kinesis Data Firehose is unable to deliver data to Splunk or if it doesn't receive an acknowledgment of receipt from Splunk.
splunkDestinationDescription_s3BackupMode :: Lens' SplunkDestinationDescription (Maybe SplunkS3BackupMode) Source #
Defines how documents should be delivered to Amazon S3. When set to
FailedDocumentsOnly
, Kinesis Data Firehose writes any data that could
not be indexed to the configured Amazon S3 destination. When set to
AllDocuments
, Kinesis Data Firehose delivers all incoming records to
Amazon S3, and also writes failed documents to Amazon S3. Default value
is FailedDocumentsOnly
.
splunkDestinationDescription_s3DestinationDescription :: Lens' SplunkDestinationDescription (Maybe S3DestinationDescription) Source #
The Amazon S3 destination.>
SplunkDestinationUpdate
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_hECEndpoint :: Lens' SplunkDestinationUpdate (Maybe Text) Source #
The HTTP Event Collector (HEC) endpoint to which Kinesis Data Firehose sends your data.
splunkDestinationUpdate_hECEndpointType :: Lens' SplunkDestinationUpdate (Maybe HECEndpointType) Source #
This type can be either "Raw" or "Event."
splunkDestinationUpdate_hECToken :: Lens' SplunkDestinationUpdate (Maybe Text) Source #
A GUID that you obtain from your Splunk cluster when you create a new HEC endpoint.
splunkDestinationUpdate_processingConfiguration :: Lens' SplunkDestinationUpdate (Maybe ProcessingConfiguration) Source #
The data processing configuration.
splunkDestinationUpdate_retryOptions :: Lens' SplunkDestinationUpdate (Maybe SplunkRetryOptions) Source #
The retry behavior in case Kinesis Data Firehose is unable to deliver data to Splunk or if it doesn't receive an acknowledgment of receipt from Splunk.
splunkDestinationUpdate_s3BackupMode :: Lens' SplunkDestinationUpdate (Maybe SplunkS3BackupMode) Source #
Specifies how you want Kinesis Data Firehose to back up documents to
Amazon S3. When set to FailedDocumentsOnly
, Kinesis Data Firehose
writes any data that could not be indexed to the configured Amazon S3
destination. When set to AllEvents
, Kinesis Data Firehose delivers all
incoming records to Amazon S3, and also writes failed documents to
Amazon S3. The default value is FailedEventsOnly
.
You can update this backup mode from FailedEventsOnly
to AllEvents
.
You can't update it from AllEvents
to FailedEventsOnly
.
splunkDestinationUpdate_s3Update :: Lens' SplunkDestinationUpdate (Maybe S3DestinationUpdate) Source #
Your update to the configuration of the backup Amazon S3 location.
SplunkRetryOptions
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
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
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
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.