interface HttpEndpointProps

Language	Type name
.NET	Amazon.CDK.AWS.KinesisFirehose.HttpEndpointProps
Go	github.com/aws/aws-cdk-go/awscdk/v2/awskinesisfirehose#HttpEndpointProps
Java	software.amazon.awscdk.services.kinesisfirehose.HttpEndpointProps
Python	aws_cdk.aws_kinesisfirehose.HttpEndpointProps
TypeScript (source)	aws-cdk-lib » aws_kinesisfirehose » HttpEndpointProps

Implements CommonDestinationProps

Props for defining an Http destination of a Kinesis Data Firehose delivery stream.

Example

declare const endpointConfig: firehose.HttpEndpointConfig;
const httpDestination = new firehose.HttpEndpoint({
  endpointConfig,
});

Properties

Name	Type	Description
endpointConfig	HttpEndpointConfig	Describes the configuration of the Http endpoint to which Kinesis Firehose delivers data.
attributes?	HttpAttribute[]	Describes the metadata sent to the Http endpoint destination.
backupMode?	HttpBackupMode	Describes the S3 bucket backup options for the data that Kinesis Data Firehose delivers to the Http endpoint destination.
bufferingHints?	HttpBufferingHints	The buffering options that can be used before data is delivered to the specified destination.
loggingConfig?	ILoggingConfig	Configuration that determines whether to log errors during data transformation or delivery failures, and specifies the CloudWatch log group for storing error logs.
processor?⚠️	IDataProcessor	The data transformation that should be performed on the data before writing to the destination.
processors?	IDataProcessor[]	The data transformation that should be performed on the data before writing to the destination.
requestCompression?	HttpCompression	Compress the body of a request before sending the request to the destination.
retryOptions?	HttpRetryOptions	The total amount of time that Kinesis Data Firehose spends on retries.
role?	IRole	The IAM role associated with this destination.
s3Backup?	DestinationS3BackupProps	The configuration for backing up source records to S3.

---

endpointConfig

Type: HttpEndpointConfig

Describes the configuration of the Http endpoint to which Kinesis Firehose delivers data.

---

attributes?

Type: HttpAttribute[] (optional, default: None)

Describes the metadata sent to the Http endpoint destination.

---

backupMode?

Type: HttpBackupMode (optional, default: Failed data only)

Describes the S3 bucket backup options for the data that Kinesis Data Firehose delivers to the Http endpoint destination.

---

bufferingHints?

Type: HttpBufferingHints (optional, default: None)

The buffering options that can be used before data is delivered to the specified destination.

---

loggingConfig?

Type: ILoggingConfig (optional, default: errors will be logged and a log group will be created for you.)

Configuration that determines whether to log errors during data transformation or delivery failures, and specifies the CloudWatch log group for storing error logs.

---

processor?⚠️

⚠️ Deprecated: Use processors instead.

Type: IDataProcessor (optional, default: no data transformation will occur.)

The data transformation that should be performed on the data before writing to the destination.

---

processors?

Type: IDataProcessor[] (optional, default: no data transformation will occur.)

The data transformation that should be performed on the data before writing to the destination.

---

requestCompression?

Type: HttpCompression (optional, default: None)

Compress the body of a request before sending the request to the destination.

---

retryOptions?

Type: HttpRetryOptions (optional, default: None)

The total amount of time that Kinesis Data Firehose spends on retries.

---

role?

Type: IRole (optional, default: a role will be created with default permissions.)

The IAM role associated with this destination.

Assumed by Amazon Data Firehose to invoke processors and write to destinations

---

s3Backup?

Type: DestinationS3BackupProps (optional, default: source records will not be backed up to S3.)

The configuration for backing up source records to S3.