Copyright | (c) 2013-2017 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
- Service Configuration
- Errors
- CompressionFormat
- DeliveryStreamStatus
- DeliveryStreamType
- ElasticsearchIndexRotationPeriod
- ElasticsearchS3BackupMode
- NoEncryptionConfig
- ProcessorParameterName
- ProcessorType
- RedshiftS3BackupMode
- S3BackupMode
- BufferingHints
- CloudWatchLoggingOptions
- CopyCommand
- DeliveryStreamDescription
- DestinationDescription
- ElasticsearchBufferingHints
- ElasticsearchDestinationConfiguration
- ElasticsearchDestinationDescription
- ElasticsearchDestinationUpdate
- ElasticsearchRetryOptions
- EncryptionConfiguration
- ExtendedS3DestinationConfiguration
- ExtendedS3DestinationDescription
- ExtendedS3DestinationUpdate
- KMSEncryptionConfig
- KinesisStreamSourceConfiguration
- KinesisStreamSourceDescription
- ProcessingConfiguration
- Processor
- ProcessorParameter
- PutRecordBatchResponseEntry
- Record
- RedshiftDestinationConfiguration
- RedshiftDestinationDescription
- RedshiftDestinationUpdate
- RedshiftRetryOptions
- S3DestinationConfiguration
- S3DestinationDescription
- S3DestinationUpdate
- SessionCredentials
- SourceDescription
- firehose :: Service
- _InvalidStreamTypeException :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidArgumentException :: AsError a => Getting (First ServiceError) a ServiceError
- _ConcurrentModificationException :: AsError a => Getting (First ServiceError) a ServiceError
- _ServiceUnavailableException :: AsError a => Getting (First ServiceError) a ServiceError
- _ResourceNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError
- _LimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError
- _ResourceInUseException :: AsError a => Getting (First ServiceError) a ServiceError
- data CompressionFormat
- = Gzip
- | Snappy
- | Uncompressed
- | Zip
- data DeliveryStreamStatus
- data DeliveryStreamType
- data ElasticsearchIndexRotationPeriod
- = NoRotation
- | OneDay
- | OneHour
- | OneMonth
- | OneWeek
- data ElasticsearchS3BackupMode
- data NoEncryptionConfig = NoEncryption
- data ProcessorParameterName
- data ProcessorType = Lambda
- data RedshiftS3BackupMode
- data S3BackupMode
- data BufferingHints
- bufferingHints :: BufferingHints
- bhSizeInMBs :: Lens' BufferingHints (Maybe Natural)
- bhIntervalInSeconds :: Lens' BufferingHints (Maybe Natural)
- data CloudWatchLoggingOptions
- cloudWatchLoggingOptions :: CloudWatchLoggingOptions
- cwloEnabled :: Lens' CloudWatchLoggingOptions (Maybe Bool)
- cwloLogGroupName :: Lens' CloudWatchLoggingOptions (Maybe Text)
- cwloLogStreamName :: Lens' CloudWatchLoggingOptions (Maybe Text)
- data CopyCommand
- copyCommand :: Text -> CopyCommand
- ccCopyOptions :: Lens' CopyCommand (Maybe Text)
- ccDataTableColumns :: Lens' CopyCommand (Maybe Text)
- ccDataTableName :: Lens' CopyCommand Text
- data DeliveryStreamDescription
- deliveryStreamDescription :: Text -> Text -> DeliveryStreamStatus -> DeliveryStreamType -> Text -> Bool -> DeliveryStreamDescription
- dsdCreateTimestamp :: Lens' DeliveryStreamDescription (Maybe UTCTime)
- dsdSource :: Lens' DeliveryStreamDescription (Maybe SourceDescription)
- dsdLastUpdateTimestamp :: Lens' DeliveryStreamDescription (Maybe UTCTime)
- dsdDeliveryStreamName :: Lens' DeliveryStreamDescription Text
- dsdDeliveryStreamARN :: Lens' DeliveryStreamDescription Text
- dsdDeliveryStreamStatus :: Lens' DeliveryStreamDescription DeliveryStreamStatus
- dsdDeliveryStreamType :: Lens' DeliveryStreamDescription DeliveryStreamType
- dsdVersionId :: Lens' DeliveryStreamDescription Text
- dsdDestinations :: Lens' DeliveryStreamDescription [DestinationDescription]
- dsdHasMoreDestinations :: Lens' DeliveryStreamDescription Bool
- data DestinationDescription
- destinationDescription :: Text -> DestinationDescription
- ddS3DestinationDescription :: Lens' DestinationDescription (Maybe S3DestinationDescription)
- ddExtendedS3DestinationDescription :: Lens' DestinationDescription (Maybe ExtendedS3DestinationDescription)
- ddElasticsearchDestinationDescription :: Lens' DestinationDescription (Maybe ElasticsearchDestinationDescription)
- ddRedshiftDestinationDescription :: Lens' DestinationDescription (Maybe RedshiftDestinationDescription)
- ddDestinationId :: Lens' DestinationDescription Text
- data ElasticsearchBufferingHints
- elasticsearchBufferingHints :: ElasticsearchBufferingHints
- ebhSizeInMBs :: Lens' ElasticsearchBufferingHints (Maybe Natural)
- ebhIntervalInSeconds :: Lens' ElasticsearchBufferingHints (Maybe Natural)
- data ElasticsearchDestinationConfiguration
- elasticsearchDestinationConfiguration :: Text -> Text -> Text -> Text -> S3DestinationConfiguration -> ElasticsearchDestinationConfiguration
- edcIndexRotationPeriod :: Lens' ElasticsearchDestinationConfiguration (Maybe ElasticsearchIndexRotationPeriod)
- edcS3BackupMode :: Lens' ElasticsearchDestinationConfiguration (Maybe ElasticsearchS3BackupMode)
- edcCloudWatchLoggingOptions :: Lens' ElasticsearchDestinationConfiguration (Maybe CloudWatchLoggingOptions)
- edcBufferingHints :: Lens' ElasticsearchDestinationConfiguration (Maybe ElasticsearchBufferingHints)
- edcRetryOptions :: Lens' ElasticsearchDestinationConfiguration (Maybe ElasticsearchRetryOptions)
- edcProcessingConfiguration :: Lens' ElasticsearchDestinationConfiguration (Maybe ProcessingConfiguration)
- edcRoleARN :: Lens' ElasticsearchDestinationConfiguration Text
- edcDomainARN :: Lens' ElasticsearchDestinationConfiguration Text
- edcIndexName :: Lens' ElasticsearchDestinationConfiguration Text
- edcTypeName :: Lens' ElasticsearchDestinationConfiguration Text
- edcS3Configuration :: Lens' ElasticsearchDestinationConfiguration S3DestinationConfiguration
- data ElasticsearchDestinationDescription
- elasticsearchDestinationDescription :: ElasticsearchDestinationDescription
- eddIndexRotationPeriod :: Lens' ElasticsearchDestinationDescription (Maybe ElasticsearchIndexRotationPeriod)
- eddTypeName :: Lens' ElasticsearchDestinationDescription (Maybe Text)
- eddS3BackupMode :: Lens' ElasticsearchDestinationDescription (Maybe ElasticsearchS3BackupMode)
- eddDomainARN :: Lens' ElasticsearchDestinationDescription (Maybe Text)
- eddCloudWatchLoggingOptions :: Lens' ElasticsearchDestinationDescription (Maybe CloudWatchLoggingOptions)
- eddS3DestinationDescription :: Lens' ElasticsearchDestinationDescription (Maybe S3DestinationDescription)
- eddBufferingHints :: Lens' ElasticsearchDestinationDescription (Maybe ElasticsearchBufferingHints)
- eddRetryOptions :: Lens' ElasticsearchDestinationDescription (Maybe ElasticsearchRetryOptions)
- eddProcessingConfiguration :: Lens' ElasticsearchDestinationDescription (Maybe ProcessingConfiguration)
- eddRoleARN :: Lens' ElasticsearchDestinationDescription (Maybe Text)
- eddIndexName :: Lens' ElasticsearchDestinationDescription (Maybe Text)
- data ElasticsearchDestinationUpdate
- elasticsearchDestinationUpdate :: ElasticsearchDestinationUpdate
- eduIndexRotationPeriod :: Lens' ElasticsearchDestinationUpdate (Maybe ElasticsearchIndexRotationPeriod)
- eduTypeName :: Lens' ElasticsearchDestinationUpdate (Maybe Text)
- eduDomainARN :: Lens' ElasticsearchDestinationUpdate (Maybe Text)
- eduCloudWatchLoggingOptions :: Lens' ElasticsearchDestinationUpdate (Maybe CloudWatchLoggingOptions)
- eduS3Update :: Lens' ElasticsearchDestinationUpdate (Maybe S3DestinationUpdate)
- eduBufferingHints :: Lens' ElasticsearchDestinationUpdate (Maybe ElasticsearchBufferingHints)
- eduRetryOptions :: Lens' ElasticsearchDestinationUpdate (Maybe ElasticsearchRetryOptions)
- eduProcessingConfiguration :: Lens' ElasticsearchDestinationUpdate (Maybe ProcessingConfiguration)
- eduRoleARN :: Lens' ElasticsearchDestinationUpdate (Maybe Text)
- eduIndexName :: Lens' ElasticsearchDestinationUpdate (Maybe Text)
- data ElasticsearchRetryOptions
- elasticsearchRetryOptions :: ElasticsearchRetryOptions
- eroDurationInSeconds :: Lens' ElasticsearchRetryOptions (Maybe Natural)
- data EncryptionConfiguration
- encryptionConfiguration :: EncryptionConfiguration
- ecNoEncryptionConfig :: Lens' EncryptionConfiguration (Maybe NoEncryptionConfig)
- ecKMSEncryptionConfig :: Lens' EncryptionConfiguration (Maybe KMSEncryptionConfig)
- data ExtendedS3DestinationConfiguration
- extendedS3DestinationConfiguration :: Text -> Text -> ExtendedS3DestinationConfiguration
- esdcS3BackupMode :: Lens' ExtendedS3DestinationConfiguration (Maybe S3BackupMode)
- esdcPrefix :: Lens' ExtendedS3DestinationConfiguration (Maybe Text)
- esdcCloudWatchLoggingOptions :: Lens' ExtendedS3DestinationConfiguration (Maybe CloudWatchLoggingOptions)
- esdcS3BackupConfiguration :: Lens' ExtendedS3DestinationConfiguration (Maybe S3DestinationConfiguration)
- esdcEncryptionConfiguration :: Lens' ExtendedS3DestinationConfiguration (Maybe EncryptionConfiguration)
- esdcCompressionFormat :: Lens' ExtendedS3DestinationConfiguration (Maybe CompressionFormat)
- esdcBufferingHints :: Lens' ExtendedS3DestinationConfiguration (Maybe BufferingHints)
- esdcProcessingConfiguration :: Lens' ExtendedS3DestinationConfiguration (Maybe ProcessingConfiguration)
- esdcRoleARN :: Lens' ExtendedS3DestinationConfiguration Text
- esdcBucketARN :: Lens' ExtendedS3DestinationConfiguration Text
- data ExtendedS3DestinationDescription
- extendedS3DestinationDescription :: Text -> Text -> BufferingHints -> CompressionFormat -> EncryptionConfiguration -> ExtendedS3DestinationDescription
- esddS3BackupMode :: Lens' ExtendedS3DestinationDescription (Maybe S3BackupMode)
- esddS3BackupDescription :: Lens' ExtendedS3DestinationDescription (Maybe S3DestinationDescription)
- esddPrefix :: Lens' ExtendedS3DestinationDescription (Maybe Text)
- esddCloudWatchLoggingOptions :: Lens' ExtendedS3DestinationDescription (Maybe CloudWatchLoggingOptions)
- esddProcessingConfiguration :: Lens' ExtendedS3DestinationDescription (Maybe ProcessingConfiguration)
- esddRoleARN :: Lens' ExtendedS3DestinationDescription Text
- esddBucketARN :: Lens' ExtendedS3DestinationDescription Text
- esddBufferingHints :: Lens' ExtendedS3DestinationDescription BufferingHints
- esddCompressionFormat :: Lens' ExtendedS3DestinationDescription CompressionFormat
- esddEncryptionConfiguration :: Lens' ExtendedS3DestinationDescription EncryptionConfiguration
- data ExtendedS3DestinationUpdate
- extendedS3DestinationUpdate :: ExtendedS3DestinationUpdate
- esduS3BackupMode :: Lens' ExtendedS3DestinationUpdate (Maybe S3BackupMode)
- esduPrefix :: Lens' ExtendedS3DestinationUpdate (Maybe Text)
- esduCloudWatchLoggingOptions :: Lens' ExtendedS3DestinationUpdate (Maybe CloudWatchLoggingOptions)
- esduS3BackupUpdate :: Lens' ExtendedS3DestinationUpdate (Maybe S3DestinationUpdate)
- esduEncryptionConfiguration :: Lens' ExtendedS3DestinationUpdate (Maybe EncryptionConfiguration)
- esduCompressionFormat :: Lens' ExtendedS3DestinationUpdate (Maybe CompressionFormat)
- esduBufferingHints :: Lens' ExtendedS3DestinationUpdate (Maybe BufferingHints)
- esduBucketARN :: Lens' ExtendedS3DestinationUpdate (Maybe Text)
- esduProcessingConfiguration :: Lens' ExtendedS3DestinationUpdate (Maybe ProcessingConfiguration)
- esduRoleARN :: Lens' ExtendedS3DestinationUpdate (Maybe Text)
- data KMSEncryptionConfig
- kmsEncryptionConfig :: Text -> KMSEncryptionConfig
- kecAWSKMSKeyARN :: Lens' KMSEncryptionConfig Text
- data KinesisStreamSourceConfiguration
- kinesisStreamSourceConfiguration :: Text -> Text -> KinesisStreamSourceConfiguration
- ksscKinesisStreamARN :: Lens' KinesisStreamSourceConfiguration Text
- ksscRoleARN :: Lens' KinesisStreamSourceConfiguration Text
- data KinesisStreamSourceDescription
- kinesisStreamSourceDescription :: KinesisStreamSourceDescription
- kssdDeliveryStartTimestamp :: Lens' KinesisStreamSourceDescription (Maybe UTCTime)
- kssdKinesisStreamARN :: Lens' KinesisStreamSourceDescription (Maybe Text)
- kssdRoleARN :: Lens' KinesisStreamSourceDescription (Maybe Text)
- data ProcessingConfiguration
- processingConfiguration :: ProcessingConfiguration
- pcEnabled :: Lens' ProcessingConfiguration (Maybe Bool)
- pcProcessors :: Lens' ProcessingConfiguration [Processor]
- data Processor
- processor :: ProcessorType -> Processor
- pParameters :: Lens' Processor [ProcessorParameter]
- pType :: Lens' Processor ProcessorType
- data ProcessorParameter
- processorParameter :: ProcessorParameterName -> Text -> ProcessorParameter
- ppParameterName :: Lens' ProcessorParameter ProcessorParameterName
- ppParameterValue :: Lens' ProcessorParameter Text
- data PutRecordBatchResponseEntry
- putRecordBatchResponseEntry :: PutRecordBatchResponseEntry
- prbreRecordId :: Lens' PutRecordBatchResponseEntry (Maybe Text)
- prbreErrorCode :: Lens' PutRecordBatchResponseEntry (Maybe Text)
- prbreErrorMessage :: Lens' PutRecordBatchResponseEntry (Maybe Text)
- data Record
- record :: ByteString -> Record
- rData :: Lens' Record ByteString
- data RedshiftDestinationConfiguration
- redshiftDestinationConfiguration :: Text -> Text -> CopyCommand -> Text -> Text -> S3DestinationConfiguration -> RedshiftDestinationConfiguration
- rdcS3BackupMode :: Lens' RedshiftDestinationConfiguration (Maybe RedshiftS3BackupMode)
- rdcCloudWatchLoggingOptions :: Lens' RedshiftDestinationConfiguration (Maybe CloudWatchLoggingOptions)
- rdcS3BackupConfiguration :: Lens' RedshiftDestinationConfiguration (Maybe S3DestinationConfiguration)
- rdcRetryOptions :: Lens' RedshiftDestinationConfiguration (Maybe RedshiftRetryOptions)
- rdcProcessingConfiguration :: Lens' RedshiftDestinationConfiguration (Maybe ProcessingConfiguration)
- rdcRoleARN :: Lens' RedshiftDestinationConfiguration Text
- rdcClusterJDBCURL :: Lens' RedshiftDestinationConfiguration Text
- rdcCopyCommand :: Lens' RedshiftDestinationConfiguration CopyCommand
- rdcUsername :: Lens' RedshiftDestinationConfiguration Text
- rdcPassword :: Lens' RedshiftDestinationConfiguration Text
- rdcS3Configuration :: Lens' RedshiftDestinationConfiguration S3DestinationConfiguration
- data RedshiftDestinationDescription
- redshiftDestinationDescription :: Text -> Text -> CopyCommand -> Text -> S3DestinationDescription -> RedshiftDestinationDescription
- rddS3BackupMode :: Lens' RedshiftDestinationDescription (Maybe RedshiftS3BackupMode)
- rddS3BackupDescription :: Lens' RedshiftDestinationDescription (Maybe S3DestinationDescription)
- rddCloudWatchLoggingOptions :: Lens' RedshiftDestinationDescription (Maybe CloudWatchLoggingOptions)
- rddRetryOptions :: Lens' RedshiftDestinationDescription (Maybe RedshiftRetryOptions)
- rddProcessingConfiguration :: Lens' RedshiftDestinationDescription (Maybe ProcessingConfiguration)
- rddRoleARN :: Lens' RedshiftDestinationDescription Text
- rddClusterJDBCURL :: Lens' RedshiftDestinationDescription Text
- rddCopyCommand :: Lens' RedshiftDestinationDescription CopyCommand
- rddUsername :: Lens' RedshiftDestinationDescription Text
- rddS3DestinationDescription :: Lens' RedshiftDestinationDescription S3DestinationDescription
- data RedshiftDestinationUpdate
- redshiftDestinationUpdate :: RedshiftDestinationUpdate
- rduS3BackupMode :: Lens' RedshiftDestinationUpdate (Maybe RedshiftS3BackupMode)
- rduCloudWatchLoggingOptions :: Lens' RedshiftDestinationUpdate (Maybe CloudWatchLoggingOptions)
- rduUsername :: Lens' RedshiftDestinationUpdate (Maybe Text)
- rduS3Update :: Lens' RedshiftDestinationUpdate (Maybe S3DestinationUpdate)
- rduPassword :: Lens' RedshiftDestinationUpdate (Maybe Text)
- rduS3BackupUpdate :: Lens' RedshiftDestinationUpdate (Maybe S3DestinationUpdate)
- rduCopyCommand :: Lens' RedshiftDestinationUpdate (Maybe CopyCommand)
- rduRetryOptions :: Lens' RedshiftDestinationUpdate (Maybe RedshiftRetryOptions)
- rduProcessingConfiguration :: Lens' RedshiftDestinationUpdate (Maybe ProcessingConfiguration)
- rduClusterJDBCURL :: Lens' RedshiftDestinationUpdate (Maybe Text)
- rduRoleARN :: Lens' RedshiftDestinationUpdate (Maybe Text)
- data RedshiftRetryOptions
- redshiftRetryOptions :: RedshiftRetryOptions
- rroDurationInSeconds :: Lens' RedshiftRetryOptions (Maybe Natural)
- data S3DestinationConfiguration
- s3DestinationConfiguration :: Text -> Text -> S3DestinationConfiguration
- sdcPrefix :: Lens' S3DestinationConfiguration (Maybe Text)
- sdcCloudWatchLoggingOptions :: Lens' S3DestinationConfiguration (Maybe CloudWatchLoggingOptions)
- sdcEncryptionConfiguration :: Lens' S3DestinationConfiguration (Maybe EncryptionConfiguration)
- sdcCompressionFormat :: Lens' S3DestinationConfiguration (Maybe CompressionFormat)
- sdcBufferingHints :: Lens' S3DestinationConfiguration (Maybe BufferingHints)
- sdcRoleARN :: Lens' S3DestinationConfiguration Text
- sdcBucketARN :: Lens' S3DestinationConfiguration Text
- data S3DestinationDescription
- s3DestinationDescription :: Text -> Text -> BufferingHints -> CompressionFormat -> EncryptionConfiguration -> S3DestinationDescription
- sddPrefix :: Lens' S3DestinationDescription (Maybe Text)
- sddCloudWatchLoggingOptions :: Lens' S3DestinationDescription (Maybe CloudWatchLoggingOptions)
- sddRoleARN :: Lens' S3DestinationDescription Text
- sddBucketARN :: Lens' S3DestinationDescription Text
- sddBufferingHints :: Lens' S3DestinationDescription BufferingHints
- sddCompressionFormat :: Lens' S3DestinationDescription CompressionFormat
- sddEncryptionConfiguration :: Lens' S3DestinationDescription EncryptionConfiguration
- data S3DestinationUpdate
- s3DestinationUpdate :: S3DestinationUpdate
- sduPrefix :: Lens' S3DestinationUpdate (Maybe Text)
- sduCloudWatchLoggingOptions :: Lens' S3DestinationUpdate (Maybe CloudWatchLoggingOptions)
- sduEncryptionConfiguration :: Lens' S3DestinationUpdate (Maybe EncryptionConfiguration)
- sduCompressionFormat :: Lens' S3DestinationUpdate (Maybe CompressionFormat)
- sduBufferingHints :: Lens' S3DestinationUpdate (Maybe BufferingHints)
- sduBucketARN :: Lens' S3DestinationUpdate (Maybe Text)
- sduRoleARN :: Lens' S3DestinationUpdate (Maybe Text)
- data SessionCredentials
- sessionCredentials :: Text -> Text -> Text -> UTCTime -> SessionCredentials
- scAccessKeyId :: Lens' SessionCredentials Text
- scSecretAccessKey :: Lens' SessionCredentials Text
- scSessionToken :: Lens' SessionCredentials Text
- scExpiration :: Lens' SessionCredentials UTCTime
- data SourceDescription
- sourceDescription :: SourceDescription
- sdKinesisStreamSourceDescription :: Lens' SourceDescription (Maybe KinesisStreamSourceDescription)
Service Configuration
API version 2015-08-04
of the Amazon Kinesis Firehose SDK configuration.
Errors
_InvalidStreamTypeException :: AsError a => Getting (First ServiceError) a ServiceError Source #
Prism for InvalidStreamTypeException' errors.
_InvalidArgumentException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified input parameter has a value that is not valid.
_ConcurrentModificationException :: AsError a => Getting (First ServiceError) a ServiceError Source #
Another modification has already happened. Fetch VersionId again and use it to update the destination.
_ServiceUnavailableException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The service is unavailable, back off and retry the operation. If you continue to see the exception, throughput limits for the delivery stream may have been exceeded. For more information about limits and how to request an increase, see Amazon Kinesis Firehose Limits .
_ResourceNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified resource could not be found.
_LimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError Source #
You have already reached the limit for a requested resource.
_ResourceInUseException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The resource is already in use and not available for this operation.
CompressionFormat
data CompressionFormat Source #
DeliveryStreamStatus
data DeliveryStreamStatus Source #
DeliveryStreamType
data DeliveryStreamType Source #
ElasticsearchIndexRotationPeriod
data ElasticsearchIndexRotationPeriod Source #
ElasticsearchS3BackupMode
data ElasticsearchS3BackupMode Source #
NoEncryptionConfig
data NoEncryptionConfig Source #
ProcessorParameterName
data ProcessorParameterName Source #
ProcessorType
data ProcessorType Source #
RedshiftS3BackupMode
data RedshiftS3BackupMode Source #
S3BackupMode
data S3BackupMode Source #
BufferingHints
data BufferingHints Source #
Describes hints for the buffering to perform before delivering data to the destination. Please note that these options are treated as hints, and therefore Kinesis Firehose may choose to use different values when it is optimal.
See: bufferingHints
smart constructor.
bufferingHints :: BufferingHints Source #
Creates a value of BufferingHints
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
bhSizeInMBs
- Buffer incoming data to the specified size, in MBs, before delivering it to the destination. The default value is 5. We recommend setting this parameter to a value greater than the amount of data you typically ingest into the delivery stream in 10 seconds. For example, if you typically ingest data at 1 MB/sec, the value should be 10 MB or higher.bhIntervalInSeconds
- Buffer incoming data for the specified period of time, in seconds, before delivering it to the destination. The default value is 300.
bhSizeInMBs :: Lens' BufferingHints (Maybe Natural) Source #
Buffer incoming data to the specified size, in MBs, before delivering it to the destination. The default value is 5. We recommend setting this parameter to a value greater than the amount of data you typically ingest into the delivery stream in 10 seconds. For example, if you typically ingest data at 1 MB/sec, the value should be 10 MB or higher.
bhIntervalInSeconds :: Lens' BufferingHints (Maybe Natural) Source #
Buffer incoming data for the specified period of time, in seconds, before delivering it to the destination. The default value is 300.
CloudWatchLoggingOptions
data CloudWatchLoggingOptions Source #
Describes the Amazon CloudWatch logging options for your delivery stream.
See: cloudWatchLoggingOptions
smart constructor.
cloudWatchLoggingOptions :: CloudWatchLoggingOptions Source #
Creates a value of CloudWatchLoggingOptions
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
cwloEnabled
- Enables or disables CloudWatch logging.cwloLogGroupName
- The CloudWatch group name for logging. This value is required if CloudWatch logging is enabled.cwloLogStreamName
- The CloudWatch log stream name for logging. This value is required if CloudWatch logging is enabled.
cwloEnabled :: Lens' CloudWatchLoggingOptions (Maybe Bool) Source #
Enables or disables CloudWatch logging.
cwloLogGroupName :: Lens' CloudWatchLoggingOptions (Maybe Text) Source #
The CloudWatch group name for logging. This value is required if CloudWatch logging is enabled.
cwloLogStreamName :: Lens' CloudWatchLoggingOptions (Maybe Text) Source #
The CloudWatch log stream name for logging. This value is required if CloudWatch logging is enabled.
CopyCommand
data CopyCommand Source #
Describes a COPY
command for Amazon Redshift.
See: copyCommand
smart constructor.
Creates a value of CopyCommand
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ccCopyOptions
- Optional parameters to use with the Amazon RedshiftCOPY
command. For more information, see the "Optional Parameters" section of Amazon Redshift COPY command . Some possible examples that would apply to Kinesis Firehose are as follows:delimiter '\t' lzop;
- fields are delimited with "t" (TAB character) and compressed using lzop.delimiter '|'
- fields are delimited with "|" (this is the default delimiter).delimiter '|' escape
- the delimiter should be escaped.fixedwidth 'venueid:3,venuename:25,venuecity:12,venuestate:2,venueseats:6'
- fields are fixed width in the source, with each width specified after every column in the table.JSON 's3://mybucket/jsonpaths.txt'
- data is in JSON format, and the path specified is the format of the data. For more examples, see Amazon Redshift COPY command examples .ccDataTableColumns
- A comma-separated list of column names.ccDataTableName
- The name of the target table. The table must already exist in the database.
ccCopyOptions :: Lens' CopyCommand (Maybe Text) Source #
Optional parameters to use with the Amazon Redshift COPY
command. For more information, see the "Optional Parameters" section of Amazon Redshift COPY command . Some possible examples that would apply to Kinesis Firehose are as follows: delimiter '\t' lzop;
- fields are delimited with "t" (TAB character) and compressed using lzop. delimiter '|'
- fields are delimited with "|" (this is the default delimiter). delimiter '|' escape
- the delimiter should be escaped. fixedwidth 'venueid:3,venuename:25,venuecity:12,venuestate:2,venueseats:6'
- fields are fixed width in the source, with each width specified after every column in the table. JSON 's3://mybucket/jsonpaths.txt'
- data is in JSON format, and the path specified is the format of the data. For more examples, see Amazon Redshift COPY command examples .
ccDataTableColumns :: Lens' CopyCommand (Maybe Text) Source #
A comma-separated list of column names.
ccDataTableName :: Lens' CopyCommand Text Source #
The name of the target table. The table must already exist in the database.
DeliveryStreamDescription
data DeliveryStreamDescription Source #
Contains information about a delivery stream.
See: deliveryStreamDescription
smart constructor.
deliveryStreamDescription Source #
:: Text | |
-> Text | |
-> DeliveryStreamStatus | |
-> DeliveryStreamType | |
-> Text | |
-> Bool | |
-> DeliveryStreamDescription |
Creates a value of DeliveryStreamDescription
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
dsdCreateTimestamp
- The date and time that the delivery stream was created.dsdSource
- If theDeliveryStreamType
parameter isKinesisStreamAsSource
, aSourceDescription
object describing the source Kinesis stream.dsdLastUpdateTimestamp
- The date and time that the delivery stream was last updated.dsdDeliveryStreamName
- The name of the delivery stream.dsdDeliveryStreamARN
- The Amazon Resource Name (ARN) of the delivery stream.dsdDeliveryStreamStatus
- The status of the delivery stream.dsdDeliveryStreamType
- The delivery stream type. This can be one of the following values: *DirectPut
: Provider applications access the delivery stream directly. *KinesisStreamAsSource
: The delivery stream uses a Kinesis stream as a source.dsdVersionId
- Each time the destination is updated for a delivery stream, the version ID is changed, and the current version ID is required when updating the destination. This is so that the service knows it is applying the changes to the correct version of the delivery stream.dsdDestinations
- The destinations.dsdHasMoreDestinations
- Indicates whether there are more destinations available to list.
dsdCreateTimestamp :: Lens' DeliveryStreamDescription (Maybe UTCTime) Source #
The date and time that the delivery stream was created.
dsdSource :: Lens' DeliveryStreamDescription (Maybe SourceDescription) Source #
If the DeliveryStreamType
parameter is KinesisStreamAsSource
, a SourceDescription
object describing the source Kinesis stream.
dsdLastUpdateTimestamp :: Lens' DeliveryStreamDescription (Maybe UTCTime) Source #
The date and time that the delivery stream was last updated.
dsdDeliveryStreamName :: Lens' DeliveryStreamDescription Text Source #
The name of the delivery stream.
dsdDeliveryStreamARN :: Lens' DeliveryStreamDescription Text Source #
The Amazon Resource Name (ARN) of the delivery stream.
dsdDeliveryStreamStatus :: Lens' DeliveryStreamDescription DeliveryStreamStatus Source #
The status of the delivery stream.
dsdDeliveryStreamType :: Lens' DeliveryStreamDescription DeliveryStreamType Source #
The delivery stream type. This can be one of the following values: * DirectPut
: Provider applications access the delivery stream directly. * KinesisStreamAsSource
: The delivery stream uses a Kinesis stream as a source.
dsdVersionId :: Lens' DeliveryStreamDescription Text Source #
Each time the destination is updated for a delivery stream, the version ID is changed, and the current version ID is required when updating the destination. This is so that the service knows it is applying the changes to the correct version of the delivery stream.
dsdDestinations :: Lens' DeliveryStreamDescription [DestinationDescription] Source #
The destinations.
dsdHasMoreDestinations :: Lens' DeliveryStreamDescription Bool Source #
Indicates whether there are more destinations available to list.
DestinationDescription
data DestinationDescription Source #
Describes the destination for a delivery stream.
See: destinationDescription
smart constructor.
destinationDescription Source #
Creates a value of DestinationDescription
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ddS3DestinationDescription
- [Deprecated] The destination in Amazon S3.ddExtendedS3DestinationDescription
- The destination in Amazon S3.ddElasticsearchDestinationDescription
- The destination in Amazon ES.ddRedshiftDestinationDescription
- The destination in Amazon Redshift.ddDestinationId
- The ID of the destination.
ddS3DestinationDescription :: Lens' DestinationDescription (Maybe S3DestinationDescription) Source #
- Deprecated
- The destination in Amazon S3.
ddExtendedS3DestinationDescription :: Lens' DestinationDescription (Maybe ExtendedS3DestinationDescription) Source #
The destination in Amazon S3.
ddElasticsearchDestinationDescription :: Lens' DestinationDescription (Maybe ElasticsearchDestinationDescription) Source #
The destination in Amazon ES.
ddRedshiftDestinationDescription :: Lens' DestinationDescription (Maybe RedshiftDestinationDescription) Source #
The destination in Amazon Redshift.
ddDestinationId :: Lens' DestinationDescription Text Source #
The ID of the destination.
ElasticsearchBufferingHints
data ElasticsearchBufferingHints Source #
Describes the buffering to perform before delivering data to the Amazon ES destination.
See: elasticsearchBufferingHints
smart constructor.
elasticsearchBufferingHints :: ElasticsearchBufferingHints Source #
Creates a value of ElasticsearchBufferingHints
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ebhSizeInMBs
- Buffer incoming data to the specified size, in MBs, before delivering it to the destination. The default value is 5. We recommend setting this parameter to a value greater than the amount of data you typically ingest into the delivery stream in 10 seconds. For example, if you typically ingest data at 1 MB/sec, the value should be 10 MB or higher.ebhIntervalInSeconds
- Buffer incoming data for the specified period of time, in seconds, before delivering it to the destination. The default value is 300 (5 minutes).
ebhSizeInMBs :: Lens' ElasticsearchBufferingHints (Maybe Natural) Source #
Buffer incoming data to the specified size, in MBs, before delivering it to the destination. The default value is 5. We recommend setting this parameter to a value greater than the amount of data you typically ingest into the delivery stream in 10 seconds. For example, if you typically ingest data at 1 MB/sec, the value should be 10 MB or higher.
ebhIntervalInSeconds :: Lens' ElasticsearchBufferingHints (Maybe Natural) Source #
Buffer incoming data for the specified period of time, in seconds, before delivering it to the destination. The default value is 300 (5 minutes).
ElasticsearchDestinationConfiguration
data ElasticsearchDestinationConfiguration Source #
Describes the configuration of a destination in Amazon ES.
See: elasticsearchDestinationConfiguration
smart constructor.
elasticsearchDestinationConfiguration Source #
Creates a value of ElasticsearchDestinationConfiguration
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
edcIndexRotationPeriod
- The Elasticsearch index rotation period. Index rotation appends a time stamp to the IndexName to facilitate the expiration of old data. For more information, see Index Rotation for Amazon Elasticsearch Service Destination . The default value isOneDay
.edcS3BackupMode
- Defines how documents should be delivered to Amazon S3. When set to FailedDocumentsOnly, Kinesis Firehose writes any documents that could not be indexed to the configured Amazon S3 destination, with elasticsearch-failed appended to the key prefix. When set to AllDocuments, Kinesis Firehose delivers all incoming records to Amazon S3, and also writes failed documents with elasticsearch-failed appended to the prefix. For more information, see Amazon S3 Backup for Amazon Elasticsearch Service Destination . Default value is FailedDocumentsOnly.edcCloudWatchLoggingOptions
- The CloudWatch logging options for your delivery stream.edcBufferingHints
- The buffering options. If no value is specified, the default values for ElasticsearchBufferingHints are used.edcRetryOptions
- The retry behavior in case Kinesis Firehose is unable to deliver documents to Amazon ES. The default value is 300 (5 minutes).edcProcessingConfiguration
- The data processing configuration.edcRoleARN
- The ARN of the IAM role to be assumed by Kinesis Firehose for calling the Amazon ES Configuration API and for indexing documents. For more information, see Amazon S3 Bucket Access .edcDomainARN
- The ARN of the Amazon ES domain. The IAM role must have permissions forDescribeElasticsearchDomain
,DescribeElasticsearchDomains
, andDescribeElasticsearchDomainConfig
after assuming the role specified in RoleARN .edcIndexName
- The Elasticsearch index name.edcTypeName
- The Elasticsearch type name.edcS3Configuration
- The configuration for the backup Amazon S3 location.
edcIndexRotationPeriod :: Lens' ElasticsearchDestinationConfiguration (Maybe ElasticsearchIndexRotationPeriod) Source #
The Elasticsearch index rotation period. Index rotation appends a time stamp to the IndexName to facilitate the expiration of old data. For more information, see Index Rotation for Amazon Elasticsearch Service Destination . The default value is OneDay
.
edcS3BackupMode :: Lens' ElasticsearchDestinationConfiguration (Maybe ElasticsearchS3BackupMode) Source #
Defines how documents should be delivered to Amazon S3. When set to FailedDocumentsOnly, Kinesis Firehose writes any documents that could not be indexed to the configured Amazon S3 destination, with elasticsearch-failed appended to the key prefix. When set to AllDocuments, Kinesis Firehose delivers all incoming records to Amazon S3, and also writes failed documents with elasticsearch-failed appended to the prefix. For more information, see Amazon S3 Backup for Amazon Elasticsearch Service Destination . Default value is FailedDocumentsOnly.
edcCloudWatchLoggingOptions :: Lens' ElasticsearchDestinationConfiguration (Maybe CloudWatchLoggingOptions) Source #
The CloudWatch logging options for your delivery stream.
edcBufferingHints :: Lens' ElasticsearchDestinationConfiguration (Maybe ElasticsearchBufferingHints) Source #
The buffering options. If no value is specified, the default values for ElasticsearchBufferingHints are used.
edcRetryOptions :: Lens' ElasticsearchDestinationConfiguration (Maybe ElasticsearchRetryOptions) Source #
The retry behavior in case Kinesis Firehose is unable to deliver documents to Amazon ES. The default value is 300 (5 minutes).
edcProcessingConfiguration :: Lens' ElasticsearchDestinationConfiguration (Maybe ProcessingConfiguration) Source #
The data processing configuration.
edcRoleARN :: Lens' ElasticsearchDestinationConfiguration Text Source #
The ARN of the IAM role to be assumed by Kinesis Firehose for calling the Amazon ES Configuration API and for indexing documents. For more information, see Amazon S3 Bucket Access .
edcDomainARN :: Lens' ElasticsearchDestinationConfiguration Text Source #
The ARN of the Amazon ES domain. The IAM role must have permissions for DescribeElasticsearchDomain
, DescribeElasticsearchDomains
, and DescribeElasticsearchDomainConfig
after assuming the role specified in RoleARN .
edcIndexName :: Lens' ElasticsearchDestinationConfiguration Text Source #
The Elasticsearch index name.
edcTypeName :: Lens' ElasticsearchDestinationConfiguration Text Source #
The Elasticsearch type name.
edcS3Configuration :: Lens' ElasticsearchDestinationConfiguration S3DestinationConfiguration Source #
The configuration for the backup Amazon S3 location.
ElasticsearchDestinationDescription
data ElasticsearchDestinationDescription Source #
The destination description in Amazon ES.
See: elasticsearchDestinationDescription
smart constructor.
elasticsearchDestinationDescription :: ElasticsearchDestinationDescription Source #
Creates a value of ElasticsearchDestinationDescription
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
eddIndexRotationPeriod
- The Elasticsearch index rotation periodeddTypeName
- The Elasticsearch type name.eddS3BackupMode
- The Amazon S3 backup mode.eddDomainARN
- The ARN of the Amazon ES domain.eddCloudWatchLoggingOptions
- The CloudWatch logging options.eddS3DestinationDescription
- The Amazon S3 destination.eddBufferingHints
- The buffering options.eddRetryOptions
- The Amazon ES retry options.eddProcessingConfiguration
- The data processing configuration.eddRoleARN
- The ARN of the AWS credentials.eddIndexName
- The Elasticsearch index name.
eddIndexRotationPeriod :: Lens' ElasticsearchDestinationDescription (Maybe ElasticsearchIndexRotationPeriod) Source #
The Elasticsearch index rotation period
eddTypeName :: Lens' ElasticsearchDestinationDescription (Maybe Text) Source #
The Elasticsearch type name.
eddS3BackupMode :: Lens' ElasticsearchDestinationDescription (Maybe ElasticsearchS3BackupMode) Source #
The Amazon S3 backup mode.
eddDomainARN :: Lens' ElasticsearchDestinationDescription (Maybe Text) Source #
The ARN of the Amazon ES domain.
eddCloudWatchLoggingOptions :: Lens' ElasticsearchDestinationDescription (Maybe CloudWatchLoggingOptions) Source #
The CloudWatch logging options.
eddS3DestinationDescription :: Lens' ElasticsearchDestinationDescription (Maybe S3DestinationDescription) Source #
The Amazon S3 destination.
eddBufferingHints :: Lens' ElasticsearchDestinationDescription (Maybe ElasticsearchBufferingHints) Source #
The buffering options.
eddRetryOptions :: Lens' ElasticsearchDestinationDescription (Maybe ElasticsearchRetryOptions) Source #
The Amazon ES retry options.
eddProcessingConfiguration :: Lens' ElasticsearchDestinationDescription (Maybe ProcessingConfiguration) Source #
The data processing configuration.
eddRoleARN :: Lens' ElasticsearchDestinationDescription (Maybe Text) Source #
The ARN of the AWS credentials.
eddIndexName :: Lens' ElasticsearchDestinationDescription (Maybe Text) Source #
The Elasticsearch index name.
ElasticsearchDestinationUpdate
data ElasticsearchDestinationUpdate Source #
Describes an update for a destination in Amazon ES.
See: elasticsearchDestinationUpdate
smart constructor.
elasticsearchDestinationUpdate :: ElasticsearchDestinationUpdate Source #
Creates a value of ElasticsearchDestinationUpdate
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
eduIndexRotationPeriod
- The Elasticsearch index rotation period. Index rotation appends a time stamp to IndexName to facilitate the expiration of old data. For more information, see Index Rotation for Amazon Elasticsearch Service Destination . Default value isOneDay
.eduTypeName
- The Elasticsearch type name.eduDomainARN
- The ARN of the Amazon ES domain. The IAM role must have permissions forDescribeElasticsearchDomain
,DescribeElasticsearchDomains
, andDescribeElasticsearchDomainConfig
after assuming the IAM role specified in RoleARN .eduCloudWatchLoggingOptions
- The CloudWatch logging options for your delivery stream.eduS3Update
- The Amazon S3 destination.eduBufferingHints
- The buffering options. If no value is specified, ElasticsearchBufferingHints object default values are used.eduRetryOptions
- The retry behavior in case Kinesis Firehose is unable to deliver documents to Amazon ES. The default value is 300 (5 minutes).eduProcessingConfiguration
- The data processing configuration.eduRoleARN
- The ARN of the IAM role to be assumed by Kinesis Firehose for calling the Amazon ES Configuration API and for indexing documents. For more information, see Amazon S3 Bucket Access .eduIndexName
- The Elasticsearch index name.
eduIndexRotationPeriod :: Lens' ElasticsearchDestinationUpdate (Maybe ElasticsearchIndexRotationPeriod) Source #
The Elasticsearch index rotation period. Index rotation appends a time stamp to IndexName to facilitate the expiration of old data. For more information, see Index Rotation for Amazon Elasticsearch Service Destination . Default value is OneDay
.
eduTypeName :: Lens' ElasticsearchDestinationUpdate (Maybe Text) Source #
The Elasticsearch type name.
eduDomainARN :: Lens' ElasticsearchDestinationUpdate (Maybe Text) Source #
The ARN of the Amazon ES domain. The IAM role must have permissions for DescribeElasticsearchDomain
, DescribeElasticsearchDomains
, and DescribeElasticsearchDomainConfig
after assuming the IAM role specified in RoleARN .
eduCloudWatchLoggingOptions :: Lens' ElasticsearchDestinationUpdate (Maybe CloudWatchLoggingOptions) Source #
The CloudWatch logging options for your delivery stream.
eduS3Update :: Lens' ElasticsearchDestinationUpdate (Maybe S3DestinationUpdate) Source #
The Amazon S3 destination.
eduBufferingHints :: Lens' ElasticsearchDestinationUpdate (Maybe ElasticsearchBufferingHints) Source #
The buffering options. If no value is specified, ElasticsearchBufferingHints object default values are used.
eduRetryOptions :: Lens' ElasticsearchDestinationUpdate (Maybe ElasticsearchRetryOptions) Source #
The retry behavior in case Kinesis Firehose is unable to deliver documents to Amazon ES. The default value is 300 (5 minutes).
eduProcessingConfiguration :: Lens' ElasticsearchDestinationUpdate (Maybe ProcessingConfiguration) Source #
The data processing configuration.
eduRoleARN :: Lens' ElasticsearchDestinationUpdate (Maybe Text) Source #
The ARN of the IAM role to be assumed by Kinesis Firehose for calling the Amazon ES Configuration API and for indexing documents. For more information, see Amazon S3 Bucket Access .
eduIndexName :: Lens' ElasticsearchDestinationUpdate (Maybe Text) Source #
The Elasticsearch index name.
ElasticsearchRetryOptions
data ElasticsearchRetryOptions Source #
Configures retry behavior in case Kinesis Firehose is unable to deliver documents to Amazon ES.
See: elasticsearchRetryOptions
smart constructor.
elasticsearchRetryOptions :: ElasticsearchRetryOptions Source #
Creates a value of ElasticsearchRetryOptions
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
eroDurationInSeconds
- After an initial failure to deliver to Amazon ES, the total amount of time during which Kinesis Firehose re-attempts delivery (including the first attempt). After this time has elapsed, the failed documents are written to Amazon S3. Default value is 300 seconds (5 minutes). A value of 0 (zero) results in no retries.
eroDurationInSeconds :: Lens' ElasticsearchRetryOptions (Maybe Natural) Source #
After an initial failure to deliver to Amazon ES, the total amount of time during which Kinesis Firehose re-attempts delivery (including the first attempt). After this time has elapsed, the failed documents are written to Amazon S3. Default value is 300 seconds (5 minutes). A value of 0 (zero) results in no retries.
EncryptionConfiguration
data EncryptionConfiguration Source #
Describes the encryption for a destination in Amazon S3.
See: encryptionConfiguration
smart constructor.
encryptionConfiguration :: EncryptionConfiguration Source #
Creates a value of EncryptionConfiguration
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ecNoEncryptionConfig
- Specifically override existing encryption information to ensure that no encryption is used.ecKMSEncryptionConfig
- The encryption key.
ecNoEncryptionConfig :: Lens' EncryptionConfiguration (Maybe NoEncryptionConfig) Source #
Specifically override existing encryption information to ensure that no encryption is used.
ecKMSEncryptionConfig :: Lens' EncryptionConfiguration (Maybe KMSEncryptionConfig) Source #
The encryption key.
ExtendedS3DestinationConfiguration
data ExtendedS3DestinationConfiguration Source #
Describes the configuration of a destination in Amazon S3.
See: extendedS3DestinationConfiguration
smart constructor.
extendedS3DestinationConfiguration Source #
Creates a value of ExtendedS3DestinationConfiguration
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
esdcS3BackupMode
- The Amazon S3 backup mode.esdcPrefix
- The "YYYYMMDDHH" time format prefix is automatically used for delivered S3 files. You can specify an extra prefix to be added in front of the time format prefix. If the prefix ends with a slash, it appears as a folder in the S3 bucket. For more information, see <http:docs.aws.amazon.comfirehoselatestdevbasic-deliver.html Amazon S3 Object Name Format> in the Amazon Kinesis Firehose Developer Guide/ .esdcCloudWatchLoggingOptions
- The CloudWatch logging options for your delivery stream.esdcS3BackupConfiguration
- The configuration for backup in Amazon S3.esdcEncryptionConfiguration
- The encryption configuration. If no value is specified, the default is no encryption.esdcCompressionFormat
- The compression format. If no value is specified, the default is UNCOMPRESSED.esdcBufferingHints
- The buffering option.esdcProcessingConfiguration
- The data processing configuration.esdcRoleARN
- The ARN of the AWS credentials.esdcBucketARN
- The ARN of the S3 bucket.
esdcS3BackupMode :: Lens' ExtendedS3DestinationConfiguration (Maybe S3BackupMode) Source #
The Amazon S3 backup mode.
esdcPrefix :: Lens' ExtendedS3DestinationConfiguration (Maybe Text) Source #
The "YYYYMMDDHH" time format prefix is automatically used for delivered S3 files. You can specify an extra prefix to be added in front of the time format prefix. If the prefix ends with a slash, it appears as a folder in the S3 bucket. For more information, see <http:docs.aws.amazon.comfirehoselatestdevbasic-deliver.html Amazon S3 Object Name Format> in the Amazon Kinesis Firehose Developer Guide/ .
esdcCloudWatchLoggingOptions :: Lens' ExtendedS3DestinationConfiguration (Maybe CloudWatchLoggingOptions) Source #
The CloudWatch logging options for your delivery stream.
esdcS3BackupConfiguration :: Lens' ExtendedS3DestinationConfiguration (Maybe S3DestinationConfiguration) Source #
The configuration for backup in Amazon S3.
esdcEncryptionConfiguration :: Lens' ExtendedS3DestinationConfiguration (Maybe EncryptionConfiguration) Source #
The encryption configuration. If no value is specified, the default is no encryption.
esdcCompressionFormat :: Lens' ExtendedS3DestinationConfiguration (Maybe CompressionFormat) Source #
The compression format. If no value is specified, the default is UNCOMPRESSED.
esdcBufferingHints :: Lens' ExtendedS3DestinationConfiguration (Maybe BufferingHints) Source #
The buffering option.
esdcProcessingConfiguration :: Lens' ExtendedS3DestinationConfiguration (Maybe ProcessingConfiguration) Source #
The data processing configuration.
esdcRoleARN :: Lens' ExtendedS3DestinationConfiguration Text Source #
The ARN of the AWS credentials.
esdcBucketARN :: Lens' ExtendedS3DestinationConfiguration Text Source #
The ARN of the S3 bucket.
ExtendedS3DestinationDescription
data ExtendedS3DestinationDescription Source #
Describes a destination in Amazon S3.
See: extendedS3DestinationDescription
smart constructor.
extendedS3DestinationDescription Source #
:: Text | |
-> Text | |
-> BufferingHints | |
-> CompressionFormat | |
-> EncryptionConfiguration | |
-> ExtendedS3DestinationDescription |
Creates a value of ExtendedS3DestinationDescription
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
esddS3BackupMode
- The Amazon S3 backup mode.esddS3BackupDescription
- The configuration for backup in Amazon S3.esddPrefix
- The "YYYYMMDDHH" time format prefix is automatically used for delivered S3 files. You can specify an extra prefix to be added in front of the time format prefix. If the prefix ends with a slash, it appears as a folder in the S3 bucket. For more information, see <http:docs.aws.amazon.comfirehoselatestdevbasic-deliver.html Amazon S3 Object Name Format> in the Amazon Kinesis Firehose Developer Guide/ .esddCloudWatchLoggingOptions
- The CloudWatch logging options for your delivery stream.esddProcessingConfiguration
- The data processing configuration.esddRoleARN
- The ARN of the AWS credentials.esddBucketARN
- The ARN of the S3 bucket.esddBufferingHints
- The buffering option.esddCompressionFormat
- The compression format. If no value is specified, the default isUNCOMPRESSED
.esddEncryptionConfiguration
- The encryption configuration. If no value is specified, the default is no encryption.
esddS3BackupMode :: Lens' ExtendedS3DestinationDescription (Maybe S3BackupMode) Source #
The Amazon S3 backup mode.
esddS3BackupDescription :: Lens' ExtendedS3DestinationDescription (Maybe S3DestinationDescription) Source #
The configuration for backup in Amazon S3.
esddPrefix :: Lens' ExtendedS3DestinationDescription (Maybe Text) Source #
The "YYYYMMDDHH" time format prefix is automatically used for delivered S3 files. You can specify an extra prefix to be added in front of the time format prefix. If the prefix ends with a slash, it appears as a folder in the S3 bucket. For more information, see <http:docs.aws.amazon.comfirehoselatestdevbasic-deliver.html Amazon S3 Object Name Format> in the Amazon Kinesis Firehose Developer Guide/ .
esddCloudWatchLoggingOptions :: Lens' ExtendedS3DestinationDescription (Maybe CloudWatchLoggingOptions) Source #
The CloudWatch logging options for your delivery stream.
esddProcessingConfiguration :: Lens' ExtendedS3DestinationDescription (Maybe ProcessingConfiguration) Source #
The data processing configuration.
esddRoleARN :: Lens' ExtendedS3DestinationDescription Text Source #
The ARN of the AWS credentials.
esddBucketARN :: Lens' ExtendedS3DestinationDescription Text Source #
The ARN of the S3 bucket.
esddBufferingHints :: Lens' ExtendedS3DestinationDescription BufferingHints Source #
The buffering option.
esddCompressionFormat :: Lens' ExtendedS3DestinationDescription CompressionFormat Source #
The compression format. If no value is specified, the default is UNCOMPRESSED
.
esddEncryptionConfiguration :: Lens' ExtendedS3DestinationDescription EncryptionConfiguration Source #
The encryption configuration. If no value is specified, the default is no encryption.
ExtendedS3DestinationUpdate
data ExtendedS3DestinationUpdate Source #
Describes an update for a destination in Amazon S3.
See: extendedS3DestinationUpdate
smart constructor.
extendedS3DestinationUpdate :: ExtendedS3DestinationUpdate Source #
Creates a value of ExtendedS3DestinationUpdate
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
esduS3BackupMode
- Enables or disables Amazon S3 backup mode.esduPrefix
- The "YYYYMMDDHH" time format prefix is automatically used for delivered S3 files. You can specify an extra prefix to be added in front of the time format prefix. If the prefix ends with a slash, it appears as a folder in the S3 bucket. For more information, see <http:docs.aws.amazon.comfirehoselatestdevbasic-deliver.html Amazon S3 Object Name Format> in the Amazon Kinesis Firehose Developer Guide/ .esduCloudWatchLoggingOptions
- The CloudWatch logging options for your delivery stream.esduS3BackupUpdate
- The Amazon S3 destination for backup.esduEncryptionConfiguration
- The encryption configuration. If no value is specified, the default is no encryption.esduCompressionFormat
- The compression format. If no value is specified, the default isUNCOMPRESSED
.esduBufferingHints
- The buffering option.esduBucketARN
- The ARN of the S3 bucket.esduProcessingConfiguration
- The data processing configuration.esduRoleARN
- The ARN of the AWS credentials.
esduS3BackupMode :: Lens' ExtendedS3DestinationUpdate (Maybe S3BackupMode) Source #
Enables or disables Amazon S3 backup mode.
esduPrefix :: Lens' ExtendedS3DestinationUpdate (Maybe Text) Source #
The "YYYYMMDDHH" time format prefix is automatically used for delivered S3 files. You can specify an extra prefix to be added in front of the time format prefix. If the prefix ends with a slash, it appears as a folder in the S3 bucket. For more information, see <http:docs.aws.amazon.comfirehoselatestdevbasic-deliver.html Amazon S3 Object Name Format> in the Amazon Kinesis Firehose Developer Guide/ .
esduCloudWatchLoggingOptions :: Lens' ExtendedS3DestinationUpdate (Maybe CloudWatchLoggingOptions) Source #
The CloudWatch logging options for your delivery stream.
esduS3BackupUpdate :: Lens' ExtendedS3DestinationUpdate (Maybe S3DestinationUpdate) Source #
The Amazon S3 destination for backup.
esduEncryptionConfiguration :: Lens' ExtendedS3DestinationUpdate (Maybe EncryptionConfiguration) Source #
The encryption configuration. If no value is specified, the default is no encryption.
esduCompressionFormat :: Lens' ExtendedS3DestinationUpdate (Maybe CompressionFormat) Source #
The compression format. If no value is specified, the default is UNCOMPRESSED
.
esduBufferingHints :: Lens' ExtendedS3DestinationUpdate (Maybe BufferingHints) Source #
The buffering option.
esduBucketARN :: Lens' ExtendedS3DestinationUpdate (Maybe Text) Source #
The ARN of the S3 bucket.
esduProcessingConfiguration :: Lens' ExtendedS3DestinationUpdate (Maybe ProcessingConfiguration) Source #
The data processing configuration.
esduRoleARN :: Lens' ExtendedS3DestinationUpdate (Maybe Text) Source #
The ARN of the AWS credentials.
KMSEncryptionConfig
data KMSEncryptionConfig Source #
Describes an encryption key for a destination in Amazon S3.
See: kmsEncryptionConfig
smart constructor.
Creates a value of KMSEncryptionConfig
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
kecAWSKMSKeyARN
- The ARN of the encryption key. Must belong to the same region as the destination Amazon S3 bucket.
kecAWSKMSKeyARN :: Lens' KMSEncryptionConfig Text Source #
The ARN of the encryption key. Must belong to the same region as the destination Amazon S3 bucket.
KinesisStreamSourceConfiguration
data KinesisStreamSourceConfiguration Source #
The stream and role ARNs for a Kinesis stream used as the source for a delivery stream.
See: kinesisStreamSourceConfiguration
smart constructor.
kinesisStreamSourceConfiguration Source #
Creates a value of KinesisStreamSourceConfiguration
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ksscKinesisStreamARN
- The ARN of the source Kinesis stream.ksscRoleARN
- The ARN of the role that provides access to the source Kinesis stream.
ksscKinesisStreamARN :: Lens' KinesisStreamSourceConfiguration Text Source #
The ARN of the source Kinesis stream.
ksscRoleARN :: Lens' KinesisStreamSourceConfiguration Text Source #
The ARN of the role that provides access to the source Kinesis stream.
KinesisStreamSourceDescription
data KinesisStreamSourceDescription Source #
Details about a Kinesis stream used as the source for a Kinesis Firehose delivery stream.
See: kinesisStreamSourceDescription
smart constructor.
kinesisStreamSourceDescription :: KinesisStreamSourceDescription Source #
Creates a value of KinesisStreamSourceDescription
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
kssdDeliveryStartTimestamp
- Kinesis Firehose starts retrieving records from the Kinesis stream starting with this time stamp.kssdKinesisStreamARN
- The ARN of the source Kinesis stream.kssdRoleARN
- The ARN of the role used by the source Kinesis stream.
kssdDeliveryStartTimestamp :: Lens' KinesisStreamSourceDescription (Maybe UTCTime) Source #
Kinesis Firehose starts retrieving records from the Kinesis stream starting with this time stamp.
kssdKinesisStreamARN :: Lens' KinesisStreamSourceDescription (Maybe Text) Source #
The ARN of the source Kinesis stream.
kssdRoleARN :: Lens' KinesisStreamSourceDescription (Maybe Text) Source #
The ARN of the role used by the source Kinesis stream.
ProcessingConfiguration
data ProcessingConfiguration Source #
Describes a data processing configuration.
See: processingConfiguration
smart constructor.
processingConfiguration :: ProcessingConfiguration Source #
Creates a value of ProcessingConfiguration
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
pcEnabled
- Enables or disables data processing.pcProcessors
- The data processors.
pcEnabled :: Lens' ProcessingConfiguration (Maybe Bool) Source #
Enables or disables data processing.
pcProcessors :: Lens' ProcessingConfiguration [Processor] Source #
The data processors.
Processor
Describes a data processor.
See: processor
smart constructor.
Creates a value of Processor
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
pParameters
- The processor parameters.pType
- The type of processor.
pParameters :: Lens' Processor [ProcessorParameter] Source #
The processor parameters.
ProcessorParameter
data ProcessorParameter Source #
Describes the processor parameter.
See: processorParameter
smart constructor.
Creates a value of ProcessorParameter
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ppParameterName
- The name of the parameter.ppParameterValue
- The parameter value.
ppParameterName :: Lens' ProcessorParameter ProcessorParameterName Source #
The name of the parameter.
ppParameterValue :: Lens' ProcessorParameter Text Source #
The parameter value.
PutRecordBatchResponseEntry
data PutRecordBatchResponseEntry Source #
Contains the result for an individual record from a PutRecordBatch
request. If the record is successfully added to your delivery stream, it receives a record ID. If the record fails to be added to your delivery stream, the result includes an error code and an error message.
See: putRecordBatchResponseEntry
smart constructor.
putRecordBatchResponseEntry :: PutRecordBatchResponseEntry Source #
Creates a value of PutRecordBatchResponseEntry
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
prbreRecordId
- The ID of the record.prbreErrorCode
- The error code for an individual record result.prbreErrorMessage
- The error message for an individual record result.
prbreRecordId :: Lens' PutRecordBatchResponseEntry (Maybe Text) Source #
The ID of the record.
prbreErrorCode :: Lens' PutRecordBatchResponseEntry (Maybe Text) Source #
The error code for an individual record result.
prbreErrorMessage :: Lens' PutRecordBatchResponseEntry (Maybe Text) Source #
The error message for an individual record result.
Record
The unit of data in a delivery stream.
See: record
smart constructor.
:: ByteString | |
-> Record |
Creates a value of Record
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
rData
- The data blob, which is base64-encoded when the blob is serialized. The maximum size of the data blob, before base64-encoding, is 1,000 KB.-- Note: ThisLens
automatically encodes and decodes Base64 data. The underlying isomorphism will encode to Base64 representation during serialisation, and decode from Base64 representation during deserialisation. ThisLens
accepts and returns only raw unencoded data.
rData :: Lens' Record ByteString Source #
The data blob, which is base64-encoded when the blob is serialized. The maximum size of the data blob, before base64-encoding, is 1,000 KB.-- Note: This Lens
automatically encodes and decodes Base64 data. The underlying isomorphism will encode to Base64 representation during serialisation, and decode from Base64 representation during deserialisation. This Lens
accepts and returns only raw unencoded data.
RedshiftDestinationConfiguration
data RedshiftDestinationConfiguration Source #
Describes the configuration of a destination in Amazon Redshift.
See: redshiftDestinationConfiguration
smart constructor.
redshiftDestinationConfiguration Source #
:: Text | |
-> Text | |
-> CopyCommand | |
-> Text | |
-> Text | |
-> S3DestinationConfiguration | |
-> RedshiftDestinationConfiguration |
Creates a value of RedshiftDestinationConfiguration
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
rdcS3BackupMode
- The Amazon S3 backup mode.rdcCloudWatchLoggingOptions
- The CloudWatch logging options for your delivery stream.rdcS3BackupConfiguration
- The configuration for backup in Amazon S3.rdcRetryOptions
- The retry behavior in case Kinesis Firehose is unable to deliver documents to Amazon Redshift. Default value is 3600 (60 minutes).rdcProcessingConfiguration
- The data processing configuration.rdcRoleARN
- The ARN of the AWS credentials.rdcClusterJDBCURL
- The database connection string.rdcCopyCommand
- TheCOPY
command.rdcUsername
- The name of the user.rdcPassword
- The user password.rdcS3Configuration
- The configuration for the intermediate Amazon S3 location from which Amazon Redshift obtains data. Restrictions are described in the topic forCreateDeliveryStream
. The compression formatsSNAPPY
orZIP
cannot be specified in RedshiftDestinationConfiguration.S3Configuration because the Amazon RedshiftCOPY
operation that reads from the S3 bucket doesn't support these compression formats.
rdcS3BackupMode :: Lens' RedshiftDestinationConfiguration (Maybe RedshiftS3BackupMode) Source #
The Amazon S3 backup mode.
rdcCloudWatchLoggingOptions :: Lens' RedshiftDestinationConfiguration (Maybe CloudWatchLoggingOptions) Source #
The CloudWatch logging options for your delivery stream.
rdcS3BackupConfiguration :: Lens' RedshiftDestinationConfiguration (Maybe S3DestinationConfiguration) Source #
The configuration for backup in Amazon S3.
rdcRetryOptions :: Lens' RedshiftDestinationConfiguration (Maybe RedshiftRetryOptions) Source #
The retry behavior in case Kinesis Firehose is unable to deliver documents to Amazon Redshift. Default value is 3600 (60 minutes).
rdcProcessingConfiguration :: Lens' RedshiftDestinationConfiguration (Maybe ProcessingConfiguration) Source #
The data processing configuration.
rdcRoleARN :: Lens' RedshiftDestinationConfiguration Text Source #
The ARN of the AWS credentials.
rdcClusterJDBCURL :: Lens' RedshiftDestinationConfiguration Text Source #
The database connection string.
rdcCopyCommand :: Lens' RedshiftDestinationConfiguration CopyCommand Source #
The COPY
command.
rdcUsername :: Lens' RedshiftDestinationConfiguration Text Source #
The name of the user.
rdcPassword :: Lens' RedshiftDestinationConfiguration Text Source #
The user password.
rdcS3Configuration :: Lens' RedshiftDestinationConfiguration S3DestinationConfiguration Source #
The configuration for the intermediate Amazon S3 location from which Amazon Redshift obtains data. Restrictions are described in the topic for CreateDeliveryStream
. The compression formats SNAPPY
or ZIP
cannot be specified in RedshiftDestinationConfiguration.S3Configuration because the Amazon Redshift COPY
operation that reads from the S3 bucket doesn't support these compression formats.
RedshiftDestinationDescription
data RedshiftDestinationDescription Source #
Describes a destination in Amazon Redshift.
See: redshiftDestinationDescription
smart constructor.
redshiftDestinationDescription Source #
Creates a value of RedshiftDestinationDescription
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
rddS3BackupMode
- The Amazon S3 backup mode.rddS3BackupDescription
- The configuration for backup in Amazon S3.rddCloudWatchLoggingOptions
- The CloudWatch logging options for your delivery stream.rddRetryOptions
- The retry behavior in case Kinesis Firehose is unable to deliver documents to Amazon Redshift. Default value is 3600 (60 minutes).rddProcessingConfiguration
- The data processing configuration.rddRoleARN
- The ARN of the AWS credentials.rddClusterJDBCURL
- The database connection string.rddCopyCommand
- TheCOPY
command.rddUsername
- The name of the user.rddS3DestinationDescription
- The Amazon S3 destination.
rddS3BackupMode :: Lens' RedshiftDestinationDescription (Maybe RedshiftS3BackupMode) Source #
The Amazon S3 backup mode.
rddS3BackupDescription :: Lens' RedshiftDestinationDescription (Maybe S3DestinationDescription) Source #
The configuration for backup in Amazon S3.
rddCloudWatchLoggingOptions :: Lens' RedshiftDestinationDescription (Maybe CloudWatchLoggingOptions) Source #
The CloudWatch logging options for your delivery stream.
rddRetryOptions :: Lens' RedshiftDestinationDescription (Maybe RedshiftRetryOptions) Source #
The retry behavior in case Kinesis Firehose is unable to deliver documents to Amazon Redshift. Default value is 3600 (60 minutes).
rddProcessingConfiguration :: Lens' RedshiftDestinationDescription (Maybe ProcessingConfiguration) Source #
The data processing configuration.
rddRoleARN :: Lens' RedshiftDestinationDescription Text Source #
The ARN of the AWS credentials.
rddClusterJDBCURL :: Lens' RedshiftDestinationDescription Text Source #
The database connection string.
rddCopyCommand :: Lens' RedshiftDestinationDescription CopyCommand Source #
The COPY
command.
rddUsername :: Lens' RedshiftDestinationDescription Text Source #
The name of the user.
rddS3DestinationDescription :: Lens' RedshiftDestinationDescription S3DestinationDescription Source #
The Amazon S3 destination.
RedshiftDestinationUpdate
data RedshiftDestinationUpdate Source #
Describes an update for a destination in Amazon Redshift.
See: redshiftDestinationUpdate
smart constructor.
redshiftDestinationUpdate :: RedshiftDestinationUpdate Source #
Creates a value of RedshiftDestinationUpdate
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
rduS3BackupMode
- The Amazon S3 backup mode.rduCloudWatchLoggingOptions
- The CloudWatch logging options for your delivery stream.rduUsername
- The name of the user.rduS3Update
- The Amazon S3 destination. The compression formatsSNAPPY
orZIP
cannot be specified in RedshiftDestinationUpdate.S3Update because the Amazon RedshiftCOPY
operation that reads from the S3 bucket doesn't support these compression formats.rduPassword
- The user password.rduS3BackupUpdate
- The Amazon S3 destination for backup.rduCopyCommand
- TheCOPY
command.rduRetryOptions
- The retry behavior in case Kinesis Firehose is unable to deliver documents to Amazon Redshift. Default value is 3600 (60 minutes).rduProcessingConfiguration
- The data processing configuration.rduClusterJDBCURL
- The database connection string.rduRoleARN
- The ARN of the AWS credentials.
rduS3BackupMode :: Lens' RedshiftDestinationUpdate (Maybe RedshiftS3BackupMode) Source #
The Amazon S3 backup mode.
rduCloudWatchLoggingOptions :: Lens' RedshiftDestinationUpdate (Maybe CloudWatchLoggingOptions) Source #
The CloudWatch logging options for your delivery stream.
rduUsername :: Lens' RedshiftDestinationUpdate (Maybe Text) Source #
The name of the user.
rduS3Update :: Lens' RedshiftDestinationUpdate (Maybe S3DestinationUpdate) Source #
The Amazon S3 destination. The compression formats SNAPPY
or ZIP
cannot be specified in RedshiftDestinationUpdate.S3Update because the Amazon Redshift COPY
operation that reads from the S3 bucket doesn't support these compression formats.
rduPassword :: Lens' RedshiftDestinationUpdate (Maybe Text) Source #
The user password.
rduS3BackupUpdate :: Lens' RedshiftDestinationUpdate (Maybe S3DestinationUpdate) Source #
The Amazon S3 destination for backup.
rduCopyCommand :: Lens' RedshiftDestinationUpdate (Maybe CopyCommand) Source #
The COPY
command.
rduRetryOptions :: Lens' RedshiftDestinationUpdate (Maybe RedshiftRetryOptions) Source #
The retry behavior in case Kinesis Firehose is unable to deliver documents to Amazon Redshift. Default value is 3600 (60 minutes).
rduProcessingConfiguration :: Lens' RedshiftDestinationUpdate (Maybe ProcessingConfiguration) Source #
The data processing configuration.
rduClusterJDBCURL :: Lens' RedshiftDestinationUpdate (Maybe Text) Source #
The database connection string.
rduRoleARN :: Lens' RedshiftDestinationUpdate (Maybe Text) Source #
The ARN of the AWS credentials.
RedshiftRetryOptions
data RedshiftRetryOptions Source #
Configures retry behavior in case Kinesis Firehose is unable to deliver documents to Amazon Redshift.
See: redshiftRetryOptions
smart constructor.
redshiftRetryOptions :: RedshiftRetryOptions Source #
Creates a value of RedshiftRetryOptions
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
rroDurationInSeconds
- The length of time during which Kinesis 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 Firehose does not retry if the value ofDurationInSeconds
is 0 (zero) or if the first delivery attempt takes longer than the current value.
rroDurationInSeconds :: Lens' RedshiftRetryOptions (Maybe Natural) Source #
The length of time during which Kinesis 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 Firehose does not retry if the value of DurationInSeconds
is 0 (zero) or if the first delivery attempt takes longer than the current value.
S3DestinationConfiguration
data S3DestinationConfiguration Source #
Describes the configuration of a destination in Amazon S3.
See: s3DestinationConfiguration
smart constructor.
s3DestinationConfiguration Source #
Creates a value of S3DestinationConfiguration
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
sdcPrefix
- The "YYYYMMDDHH" time format prefix is automatically used for delivered S3 files. You can specify an extra prefix to be added in front of the time format prefix. If the prefix ends with a slash, it appears as a folder in the S3 bucket. For more information, see <http:docs.aws.amazon.comfirehoselatestdevbasic-deliver.html Amazon S3 Object Name Format> in the Amazon Kinesis Firehose Developer Guide/ .sdcCloudWatchLoggingOptions
- The CloudWatch logging options for your delivery stream.sdcEncryptionConfiguration
- The encryption configuration. If no value is specified, the default is no encryption.sdcCompressionFormat
- The compression format. If no value is specified, the default isUNCOMPRESSED
. The compression formatsSNAPPY
orZIP
cannot be specified for Amazon Redshift destinations because they are not supported by the Amazon RedshiftCOPY
operation that reads from the S3 bucket.sdcBufferingHints
- The buffering option. If no value is specified, BufferingHints object default values are used.sdcRoleARN
- The ARN of the AWS credentials.sdcBucketARN
- The ARN of the S3 bucket.
sdcPrefix :: Lens' S3DestinationConfiguration (Maybe Text) Source #
The "YYYYMMDDHH" time format prefix is automatically used for delivered S3 files. You can specify an extra prefix to be added in front of the time format prefix. If the prefix ends with a slash, it appears as a folder in the S3 bucket. For more information, see <http:docs.aws.amazon.comfirehoselatestdevbasic-deliver.html Amazon S3 Object Name Format> in the Amazon Kinesis Firehose Developer Guide/ .
sdcCloudWatchLoggingOptions :: Lens' S3DestinationConfiguration (Maybe CloudWatchLoggingOptions) Source #
The CloudWatch logging options for your delivery stream.
sdcEncryptionConfiguration :: Lens' S3DestinationConfiguration (Maybe EncryptionConfiguration) Source #
The encryption configuration. If no value is specified, the default is no encryption.
sdcCompressionFormat :: Lens' S3DestinationConfiguration (Maybe CompressionFormat) Source #
The compression format. If no value is specified, the default is UNCOMPRESSED
. The compression formats SNAPPY
or ZIP
cannot be specified for Amazon Redshift destinations because they are not supported by the Amazon Redshift COPY
operation that reads from the S3 bucket.
sdcBufferingHints :: Lens' S3DestinationConfiguration (Maybe BufferingHints) Source #
The buffering option. If no value is specified, BufferingHints object default values are used.
sdcRoleARN :: Lens' S3DestinationConfiguration Text Source #
The ARN of the AWS credentials.
sdcBucketARN :: Lens' S3DestinationConfiguration Text Source #
The ARN of the S3 bucket.
S3DestinationDescription
data S3DestinationDescription Source #
Describes a destination in Amazon S3.
See: s3DestinationDescription
smart constructor.
s3DestinationDescription Source #
:: Text | |
-> Text | |
-> BufferingHints | |
-> CompressionFormat | |
-> EncryptionConfiguration | |
-> S3DestinationDescription |
Creates a value of S3DestinationDescription
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
sddPrefix
- The "YYYYMMDDHH" time format prefix is automatically used for delivered S3 files. You can specify an extra prefix to be added in front of the time format prefix. If the prefix ends with a slash, it appears as a folder in the S3 bucket. For more information, see <http:docs.aws.amazon.comfirehoselatestdevbasic-deliver.html Amazon S3 Object Name Format> in the Amazon Kinesis Firehose Developer Guide/ .sddCloudWatchLoggingOptions
- The CloudWatch logging options for your delivery stream.sddRoleARN
- The ARN of the AWS credentials.sddBucketARN
- The ARN of the S3 bucket.sddBufferingHints
- The buffering option. If no value is specified, BufferingHints object default values are used.sddCompressionFormat
- The compression format. If no value is specified, the default isUNCOMPRESSED
.sddEncryptionConfiguration
- The encryption configuration. If no value is specified, the default is no encryption.
sddPrefix :: Lens' S3DestinationDescription (Maybe Text) Source #
The "YYYYMMDDHH" time format prefix is automatically used for delivered S3 files. You can specify an extra prefix to be added in front of the time format prefix. If the prefix ends with a slash, it appears as a folder in the S3 bucket. For more information, see <http:docs.aws.amazon.comfirehoselatestdevbasic-deliver.html Amazon S3 Object Name Format> in the Amazon Kinesis Firehose Developer Guide/ .
sddCloudWatchLoggingOptions :: Lens' S3DestinationDescription (Maybe CloudWatchLoggingOptions) Source #
The CloudWatch logging options for your delivery stream.
sddRoleARN :: Lens' S3DestinationDescription Text Source #
The ARN of the AWS credentials.
sddBucketARN :: Lens' S3DestinationDescription Text Source #
The ARN of the S3 bucket.
sddBufferingHints :: Lens' S3DestinationDescription BufferingHints Source #
The buffering option. If no value is specified, BufferingHints object default values are used.
sddCompressionFormat :: Lens' S3DestinationDescription CompressionFormat Source #
The compression format. If no value is specified, the default is UNCOMPRESSED
.
sddEncryptionConfiguration :: Lens' S3DestinationDescription EncryptionConfiguration Source #
The encryption configuration. If no value is specified, the default is no encryption.
S3DestinationUpdate
data S3DestinationUpdate Source #
Describes an update for a destination in Amazon S3.
See: s3DestinationUpdate
smart constructor.
s3DestinationUpdate :: S3DestinationUpdate Source #
Creates a value of S3DestinationUpdate
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
sduPrefix
- The "YYYYMMDDHH" time format prefix is automatically used for delivered S3 files. You can specify an extra prefix to be added in front of the time format prefix. If the prefix ends with a slash, it appears as a folder in the S3 bucket. For more information, see <http:docs.aws.amazon.comfirehoselatestdevbasic-deliver.html Amazon S3 Object Name Format> in the Amazon Kinesis Firehose Developer Guide/ .sduCloudWatchLoggingOptions
- The CloudWatch logging options for your delivery stream.sduEncryptionConfiguration
- The encryption configuration. If no value is specified, the default is no encryption.sduCompressionFormat
- The compression format. If no value is specified, the default isUNCOMPRESSED
. The compression formatsSNAPPY
orZIP
cannot be specified for Amazon Redshift destinations because they are not supported by the Amazon RedshiftCOPY
operation that reads from the S3 bucket.sduBufferingHints
- The buffering option. If no value is specified, BufferingHints object default values are used.sduBucketARN
- The ARN of the S3 bucket.sduRoleARN
- The ARN of the AWS credentials.
sduPrefix :: Lens' S3DestinationUpdate (Maybe Text) Source #
The "YYYYMMDDHH" time format prefix is automatically used for delivered S3 files. You can specify an extra prefix to be added in front of the time format prefix. If the prefix ends with a slash, it appears as a folder in the S3 bucket. For more information, see <http:docs.aws.amazon.comfirehoselatestdevbasic-deliver.html Amazon S3 Object Name Format> in the Amazon Kinesis Firehose Developer Guide/ .
sduCloudWatchLoggingOptions :: Lens' S3DestinationUpdate (Maybe CloudWatchLoggingOptions) Source #
The CloudWatch logging options for your delivery stream.
sduEncryptionConfiguration :: Lens' S3DestinationUpdate (Maybe EncryptionConfiguration) Source #
The encryption configuration. If no value is specified, the default is no encryption.
sduCompressionFormat :: 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.
sduBufferingHints :: Lens' S3DestinationUpdate (Maybe BufferingHints) Source #
The buffering option. If no value is specified, BufferingHints object default values are used.
sduBucketARN :: Lens' S3DestinationUpdate (Maybe Text) Source #
The ARN of the S3 bucket.
sduRoleARN :: Lens' S3DestinationUpdate (Maybe Text) Source #
The ARN of the AWS credentials.
SessionCredentials
data SessionCredentials Source #
See: sessionCredentials
smart constructor.
:: Text | |
-> Text | |
-> Text | |
-> UTCTime | |
-> SessionCredentials |
Creates a value of SessionCredentials
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
scAccessKeyId
- Undocumented member.scSecretAccessKey
- Undocumented member.scSessionToken
- Undocumented member.scExpiration
- Undocumented member.
scAccessKeyId :: Lens' SessionCredentials Text Source #
Undocumented member.
scSecretAccessKey :: Lens' SessionCredentials Text Source #
Undocumented member.
scSessionToken :: Lens' SessionCredentials Text Source #
Undocumented member.
scExpiration :: Lens' SessionCredentials UTCTime Source #
Undocumented member.
SourceDescription
data SourceDescription Source #
Details about a Kinesis stream used as the source for a Kinesis Firehose delivery stream.
See: sourceDescription
smart constructor.
sourceDescription :: SourceDescription Source #
Creates a value of SourceDescription
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
sdKinesisStreamSourceDescription
- TheKinesisStreamSourceDescription
value for the source Kinesis stream.
sdKinesisStreamSourceDescription :: Lens' SourceDescription (Maybe KinesisStreamSourceDescription) Source #
The KinesisStreamSourceDescription
value for the source Kinesis stream.