interface DatadogProps

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

Implements CommonDestinationProps

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

Example

import * as secretsmanager from 'aws-cdk-lib/aws-secretsmanager';

declare const apiKey: secretsmanager.Secret;
const datadogDestination = new firehose.Datadog({
  apiKey,
  endpoint: firehose.DatadogEndpoint.LOGS_US1,
});

Properties

Name	Type	Description
apiKey	ISecret	The API key used to authenticate with Datadog.
endpoint	DatadogEndpoint	The Datadog endpoint to send data to.
backupMode?	HttpBackupMode	Describes the S3 bucket backup options for the data that Kinesis Data Firehose delivers to Datadog.
bufferingHints?	HttpBufferingHints	Buffering hints for data delivery to the Datadog endpoint.
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	Content encoding applied to the request body before delivery.
retryOptions?	HttpRetryOptions	Retry behavior when Kinesis Data Firehose cannot deliver data to Datadog.
role?	IRole	The IAM role associated with this destination.
s3Backup?	DestinationS3BackupProps	The configuration for backing up source records to S3.
tags?	HttpAttribute[]	Datadog tags to apply for filtering.

---

apiKey

Type: ISecret

The API key used to authenticate with Datadog.

Delivered to Firehose through AWS Secrets Manager (Firehose retrieves it at runtime rather than embedding it in the template).

---

endpoint

Type: DatadogEndpoint

The Datadog endpoint to send data to.

---

backupMode?

Type: HttpBackupMode (optional, default: HttpBackupMode.FAILED)

Describes the S3 bucket backup options for the data that Kinesis Data Firehose delivers to Datadog.

---

bufferingHints?

Type: HttpBufferingHints (optional, default: interval of 60 seconds, size of 4 MiB)

Buffering hints for data delivery to the Datadog endpoint.

---

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: HttpCompression.GZIP)

Content encoding applied to the request body before delivery.

---

retryOptions?

Type: HttpRetryOptions (optional, default: duration of 60 seconds)

Retry behavior when Kinesis Data Firehose cannot deliver data to Datadog.

---

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.

---

tags?

Type: HttpAttribute[] (optional, default: No tags.)

Datadog tags to apply for filtering.