DatadogEndpoint

class aws_cdk.aws_kinesisfirehose.DatadogEndpoint(*args: Any, **kwargs)

Bases: object

A Datadog endpoint URL for use with Kinesis Data Firehose.

Use one of the predefined static members for a known Datadog region, or DatadogEndpoint.of(url) for a custom URL.

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

CONFIGURATION_AP1 = <aws_cdk.aws_kinesisfirehose.DatadogEndpoint object>
CONFIGURATION_EU = <aws_cdk.aws_kinesisfirehose.DatadogEndpoint object>
CONFIGURATION_US1 = <aws_cdk.aws_kinesisfirehose.DatadogEndpoint object>
CONFIGURATION_US3 = <aws_cdk.aws_kinesisfirehose.DatadogEndpoint object>
CONFIGURATION_US5 = <aws_cdk.aws_kinesisfirehose.DatadogEndpoint object>
CONFIGURATION_US_GOV = <aws_cdk.aws_kinesisfirehose.DatadogEndpoint object>
LOGS_AP1 = <aws_cdk.aws_kinesisfirehose.DatadogEndpoint object>
LOGS_EU = <aws_cdk.aws_kinesisfirehose.DatadogEndpoint object>
LOGS_GOV = <aws_cdk.aws_kinesisfirehose.DatadogEndpoint object>
LOGS_US1 = <aws_cdk.aws_kinesisfirehose.DatadogEndpoint object>
LOGS_US3 = <aws_cdk.aws_kinesisfirehose.DatadogEndpoint object>
LOGS_US5 = <aws_cdk.aws_kinesisfirehose.DatadogEndpoint object>
METRICS_AP1 = <aws_cdk.aws_kinesisfirehose.DatadogEndpoint object>
METRICS_EU = <aws_cdk.aws_kinesisfirehose.DatadogEndpoint object>
METRICS_US = <aws_cdk.aws_kinesisfirehose.DatadogEndpoint object>
METRICS_US5 = <aws_cdk.aws_kinesisfirehose.DatadogEndpoint object>
url

The endpoint URL string.

Static Methods

classmethod of(url)

Use a custom Datadog endpoint URL.

This is an escape hatch for endpoints not covered by the predefined members (for example a new region or a proxy in front of Datadog). The value is passed through as-is and is not validated by CDK. It must be a valid HTTPS Datadog intake URL: the Firehose API requires the endpoint URL to match https://, so an invalid value fails at deployment. The caller is responsible for providing a correct URL.

Parameters:

url (str) – The full HTTPS endpoint URL.

Return type:

DatadogEndpoint