DatadogProps

class aws_cdk.aws_kinesisfirehose.DatadogProps(*, logging_config=None, processor=None, processors=None, role=None, s3_backup=None, api_key, endpoint, backup_mode=None, buffering_hints=None, request_compression=None, retry_options=None, tags=None)

Bases: CommonDestinationProps

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

Parameters:

  • logging_config (Optional[ILoggingConfig]) – 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.

  • processor (Optional[IDataProcessor]) – (deprecated) The data transformation that should be performed on the data before writing to the destination. Default: - no data transformation will occur.

  • processors (Optional[Sequence[IDataProcessor]]) – The data transformation that should be performed on the data before writing to the destination. Default: - no data transformation will occur.

  • role (Optional[IRole]) – The IAM role associated with this destination. Assumed by Amazon Data Firehose to invoke processors and write to destinations Default: - a role will be created with default permissions.

  • s3_backup (Union[DestinationS3BackupProps, Dict[str, Any], None]) – The configuration for backing up source records to S3. Default: - source records will not be backed up to S3.

  • api_key (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 (DatadogEndpoint) – The Datadog endpoint to send data to.

  • backup_mode (Optional[HttpBackupMode]) – Describes the S3 bucket backup options for the data that Kinesis Data Firehose delivers to Datadog. Default: HttpBackupMode.FAILED

  • buffering_hints (Union[HttpBufferingHints, Dict[str, Any], None]) – Buffering hints for data delivery to the Datadog endpoint. Default: - interval of 60 seconds, size of 4 MiB

  • request_compression (Optional[HttpCompression]) – Content encoding applied to the request body before delivery. Default: HttpCompression.GZIP

  • retry_options (Union[HttpRetryOptions, Dict[str, Any], None]) – Retry behavior when Kinesis Data Firehose cannot deliver data to Datadog. Default: - duration of 60 seconds

  • tags (Optional[Sequence[Union[HttpAttribute, Dict[str, Any]]]]) – Datadog tags to apply for filtering. Default: - No tags.

ExampleMetadata:

infused

Example:

import aws_cdk.aws_secretsmanager as secretsmanager

# api_key: secretsmanager.Secret

datadog_destination = firehose.Datadog(
    api_key=api_key,
    endpoint=firehose.DatadogEndpoint.LOGS_US1
)

Attributes

api_key

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

backup_mode

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

Default:

HttpBackupMode.FAILED

buffering_hints

Buffering hints for data delivery to the Datadog endpoint.

Default:

  • interval of 60 seconds, size of 4 MiB

endpoint

The Datadog endpoint to send data to.

logging_config

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.

processor

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

Default:

  • no data transformation will occur.

Deprecated:

Use processors instead.

Stability:

deprecated

processors

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

Default:

  • no data transformation will occur.

request_compression

Content encoding applied to the request body before delivery.

Default:

HttpCompression.GZIP

retry_options

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

Default:

  • duration of 60 seconds

role

The IAM role associated with this destination.

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

Default:

  • a role will be created with default permissions.

s3_backup

The configuration for backing up source records to S3.

Default:

  • source records will not be backed up to S3.

tags

Datadog tags to apply for filtering.

Default:

  • No tags.