HttpEndpointProps Struct
Props for defining an Http destination of a Kinesis Data Firehose delivery stream.
Example
ts
declare const endpointConfig: firehose.HttpEndpointConfig;
const httpDestination = new firehose.HttpEndpoint({
endpointConfig,
});
Properties
attributesoptionalHttpAttribute[]attributesoptionaltyping.List[HttpAttribute]attributesoptionalList<HttpAttribute>AttributesoptionalHttpAttribute[]Attributesoptional*[]HttpAttribute= None#Describes the metadata sent to the Http endpoint destination.
backupModeoptionalHttpBackupModebackup_modeoptionalHttpBackupModebackupModeoptionalHttpBackupModeBackupModeoptionalHttpBackupModeBackupModeoptionalHttpBackupMode#Describes the S3 bucket backup options for the data that Kinesis Data Firehose delivers to the Http endpoint destination.
Default: Failed data only
bufferingHintsoptionalHttpBufferingHintsbuffering_hintsoptionalHttpBufferingHintsbufferingHintsoptionalHttpBufferingHintsBufferingHintsoptionalHttpBufferingHintsBufferingHintsoptionalHttpBufferingHints= None#The buffering options that can be used before data is delivered to the specified destination.
endpointConfigHttpEndpointConfigendpoint_configHttpEndpointConfigendpointConfigHttpEndpointConfigEndpointConfigHttpEndpointConfigEndpointConfigHttpEndpointConfigrequired#Describes the configuration of the Http endpoint to which Kinesis Firehose delivers data.
loggingConfigoptionalILoggingConfiglogging_configoptionalILoggingConfigloggingConfigoptionalILoggingConfigLoggingConfigoptionalILoggingConfigLoggingConfigoptionalILoggingConfig#Configuration that determines whether to log errors during data transformation or delivery failures, and specifies the CloudWatch log group for storing error logs.
Default: errors will be logged and a log group will be created for you.
processoroptionalIDataProcessorprocessoroptionalIDataProcessorprocessoroptionalIDataProcessorProcessoroptionalIDataProcessorProcessoroptionalIDataProcessordeprecated#Use `processors` instead.
Default: no data transformation will occur.
processorsoptionalIDataProcessor[]processorsoptionaltyping.List[IDataProcessor]processorsoptionalList<IDataProcessor>ProcessorsoptionalIDataProcessor[]Processorsoptional*[]IDataProcessor#The data transformation that should be performed on the data before writing to the destination.
Default: no data transformation will occur.
requestCompressionoptionalHttpCompressionrequest_compressionoptionalHttpCompressionrequestCompressionoptionalHttpCompressionRequestCompressionoptionalHttpCompressionRequestCompressionoptionalHttpCompression= None#Compress the body of a request before sending the request to the destination.
retryOptionsoptionalHttpRetryOptionsretry_optionsoptionalHttpRetryOptionsretryOptionsoptionalHttpRetryOptionsRetryOptionsoptionalHttpRetryOptionsRetryOptionsoptionalHttpRetryOptions= None#The total amount of time that Kinesis Data Firehose spends on retries.
The IAM role associated with this destination.
Default: a role will be created with default permissions.
Assumed by Amazon Data Firehose to invoke processors and write to destinations
s3BackupoptionalDestinationS3BackupPropss3_backupoptionalDestinationS3BackupPropss3BackupoptionalDestinationS3BackupPropsS3BackupoptionalDestinationS3BackupPropsS3BackupoptionalDestinationS3BackupProps#The configuration for backing up source records to S3.
Default: source records will not be backed up to S3.