Package software.amazon.awscdk.services.kinesisfirehose

Interface DatadogProps

All Superinterfaces:

CommonDestinationProps, software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

DatadogProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.139.0 (build 26a6b54)",
           date="2026-08-13T16:20:08.522Z")
@Stability(Stable)
public interface DatadogProps
extends software.amazon.jsii.JsiiSerializable, CommonDestinationProps

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

Example:

 import software.amazon.awscdk.services.secretsmanager.*;
 Secret apiKey;
 Datadog datadogDestination = Datadog.Builder.create()
         .apiKey(apiKey)
         .endpoint(DatadogEndpoint.LOGS_US1)
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	DatadogProps.Builder	A builder for DatadogProps
static final class	DatadogProps.Jsii$Proxy	An implementation for DatadogProps

Method Summary

Modifier and Type	Method	Description
static DatadogProps.Builder	builder()
ISecret	getApiKey()	The API key used to authenticate with Datadog.
default HttpBackupMode	getBackupMode()	Describes the S3 bucket backup options for the data that Kinesis Data Firehose delivers to Datadog.
default HttpBufferingHints	getBufferingHints()	Buffering hints for data delivery to the Datadog endpoint.
DatadogEndpoint	getEndpoint()	The Datadog endpoint to send data to.
default HttpCompression	getRequestCompression()	Content encoding applied to the request body before delivery.
default HttpRetryOptions	getRetryOptions()	Retry behavior when Kinesis Data Firehose cannot deliver data to Datadog.
default List<HttpAttribute>	getTags()	Datadog tags to apply for filtering.

Methods inherited from interface software.amazon.awscdk.services.kinesisfirehose.CommonDestinationProps

getLoggingConfig, getProcessor, getProcessors, getRole, getS3Backup

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getApiKey

@Stability(Stable)
@NotNull
ISecret getApiKey()

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).

getEndpoint

@Stability(Stable)
@NotNull
DatadogEndpoint getEndpoint()

The Datadog endpoint to send data to.

getBackupMode

@Stability(Stable)
@Nullable
default HttpBackupMode getBackupMode()

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

Default: HttpBackupMode.FAILED

getBufferingHints

@Stability(Stable)
@Nullable
default HttpBufferingHints getBufferingHints()

Buffering hints for data delivery to the Datadog endpoint.

Default: - interval of 60 seconds, size of 4 MiB

getRequestCompression

@Stability(Stable)
@Nullable
default HttpCompression getRequestCompression()

Content encoding applied to the request body before delivery.

Default: HttpCompression.GZIP

getRetryOptions

@Stability(Stable)
@Nullable
default HttpRetryOptions getRetryOptions()

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

Default: - duration of 60 seconds

getTags

@Stability(Stable)
@Nullable
default List<HttpAttribute> getTags()

Datadog tags to apply for filtering.

Default: - No tags.

builder

@Stability(Stable)
static DatadogProps.Builder builder()

Returns:

a DatadogProps.Builder of DatadogProps