DatadogEndpoint Class
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.
Example
ts
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
CONFIGURATION_AP1DatadogEndpointconfiguration_ap1DatadogEndpointCONFIGURATION_AP1DatadogEndpointCONFIGURATION_AP1DatadogEndpointCONFIGURATION_AP1DatadogEndpointstatic#Configurations — AP1 (Japan).
CONFIGURATION_EUDatadogEndpointconfiguration_euDatadogEndpointCONFIGURATION_EUDatadogEndpointCONFIGURATION_EUDatadogEndpointCONFIGURATION_EUDatadogEndpointstatic#Configurations — EU.
CONFIGURATION_US_GOVDatadogEndpointconfiguration_us_govDatadogEndpointCONFIGURATION_US_GOVDatadogEndpointCONFIGURATION_US_GOVDatadogEndpointCONFIGURATION_US_GOVDatadogEndpointstatic#Configurations — US Government.
CONFIGURATION_US1DatadogEndpointconfiguration_us1DatadogEndpointCONFIGURATION_US1DatadogEndpointCONFIGURATION_US1DatadogEndpointCONFIGURATION_US1DatadogEndpointstatic#Configurations — US1.
CONFIGURATION_US3DatadogEndpointconfiguration_us3DatadogEndpointCONFIGURATION_US3DatadogEndpointCONFIGURATION_US3DatadogEndpointCONFIGURATION_US3DatadogEndpointstatic#Configurations — US3.
CONFIGURATION_US5DatadogEndpointconfiguration_us5DatadogEndpointCONFIGURATION_US5DatadogEndpointCONFIGURATION_US5DatadogEndpointCONFIGURATION_US5DatadogEndpointstatic#Configurations — US5.
LOGS_AP1DatadogEndpointlogs_ap1DatadogEndpointLOGS_AP1DatadogEndpointLOGS_AP1DatadogEndpointLOGS_AP1DatadogEndpointstatic#Logs — AP1 (Japan).
LOGS_EUDatadogEndpointlogs_euDatadogEndpointLOGS_EUDatadogEndpointLOGS_EUDatadogEndpointLOGS_EUDatadogEndpointstatic#Logs — EU.
LOGS_GOVDatadogEndpointlogs_govDatadogEndpointLOGS_GOVDatadogEndpointLOGS_GOVDatadogEndpointLOGS_GOVDatadogEndpointstatic#Logs — US Government.
LOGS_US1DatadogEndpointlogs_us1DatadogEndpointLOGS_US1DatadogEndpointLOGS_US1DatadogEndpointLOGS_US1DatadogEndpointstatic#Logs — US1.
LOGS_US3DatadogEndpointlogs_us3DatadogEndpointLOGS_US3DatadogEndpointLOGS_US3DatadogEndpointLOGS_US3DatadogEndpointstatic#Logs — US3.
LOGS_US5DatadogEndpointlogs_us5DatadogEndpointLOGS_US5DatadogEndpointLOGS_US5DatadogEndpointLOGS_US5DatadogEndpointstatic#Logs — US5.
METRICS_AP1DatadogEndpointmetrics_ap1DatadogEndpointMETRICS_AP1DatadogEndpointMETRICS_AP1DatadogEndpointMETRICS_AP1DatadogEndpointstatic#Metrics — AP1 (Japan).
METRICS_EUDatadogEndpointmetrics_euDatadogEndpointMETRICS_EUDatadogEndpointMETRICS_EUDatadogEndpointMETRICS_EUDatadogEndpointstatic#Metrics — EU.
METRICS_USDatadogEndpointmetrics_usDatadogEndpointMETRICS_USDatadogEndpointMETRICS_USDatadogEndpointMETRICS_USDatadogEndpointstatic#Metrics — US.
METRICS_US5DatadogEndpointmetrics_us5DatadogEndpointMETRICS_US5DatadogEndpointMETRICS_US5DatadogEndpointMETRICS_US5DatadogEndpointstatic#Metrics — US5.
The endpoint URL string.
Methods
of(url: string): DatadogEndpoint // chainable@staticmethod def of(url: str) -> DatadogEndpointpublic static DatadogEndpoint of(String url)public static DatadogEndpoint Of(string url)func Of(Url *string) DatadogEndpointstatic#Use a custom Datadog endpoint URL.
notes · 1 parameter
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
urlurlurlurlUrl— The full HTTPS endpoint URL.