Skip to content

Latest commit

 

History

History
108 lines (79 loc) · 3.97 KB

README.md

File metadata and controls

108 lines (79 loc) · 3.97 KB
Raw

AWS Cloud Development Kit (CDK) Datadog Integration

This construct makes it easy to integrate your AWS account with Datadog. It creates nested stacks based on the official Datadog Cloudformation templates using Amazon Cloud Development Kit (CDK).

Warning

⚠️ This construct does not use the newest Datadog CloudFormation template because sensitive parameters must be hard-coded. See DataDog/cloudformation-template#68 for an upstream feature request. ⚠️

This construct will still work, but it cannot be updated to the latest integration template until the upstream issue is fixed. Please add a +1 to DataDog/cloudformation-template#68 to help prioritize it.

Basic Usage

  1. Install the package

    npm i --save cdk-datadog-integration

    Or via pypi, NuGet, or GitHub Packages.

  2. Import the stack and pass the required parameters.

    import * as cdk from "aws-cdk-lib";
import { MonitoringInfrastructureStack } from "../lib/monitoring-infrastructure-stack";

const app = new cdk.App();
new MonitoringInfrastructureStack(app, "MonitoringInfrastructure");
    import * as cdk from "aws-cdk-lib";
import * as secrets from "aws-cdk-lib/aws-secretsmanager";
import { DatadogIntegration } from "cdk-datadog-integration";

export class MonitoringInfrastructureStack extends cdk.Stack {
  constructor(scope: cdk.App, id: string, props?: cdk.StackProps) {
    super(scope, id, props);

    const datadog = new DatadogIntegration(this, "Datadog", {
      // Generate an ID here: https://app.datadoghq.com/account/settings#integrations/amazon-web-services
      externalId: "",

      // Create or lookup a `Secret` that contains your Datadog API Key
      // See https://docs.aws.amazon.com/cdk/api/latest/docs/aws-secretsmanager-readme.html for details on Secrets in CDK
      // Get your API key here: https://app.datadoghq.com/account/settings#api
      apiKey: secrets.Secret.fromSecretNameV2(
        this,
        "DatadogApiKey",
        "<your secret name>"
      ),
    });
  }
}

Configuration

Use DatadogIntegrationConfig to set additional configuration parameters. Check out docs for more details on what's available.

Additionally, a CDK Construct is exposed, should you want to add additional customizations vs. using the out-of-the-box Stack.

CDK Version Compatibility

This package is expected to work with all recent versions of CDK v2. It has been tested with 2.1.0 so almost certainly works will all newer versions, and probably works with some older versions too, but is untested.

If you're still on CDK v1, you can use cdk-datadog-integration@1, but this version is unmaintained. Please upgrade to CDKv2.

How it Works

This module uses the CfnStack CDK Construct to import the three CloudFormation stacks referenced by the main Datadog CloudFormation template. By referencing the Datadog-provided templates, you can be confident that the integration works exactly as Datadog intends.

Author

This package is created and maintained by Ben Limmer, a freelance architect and consultant. I love helping businesses of all sizes solve their hardest technology problems. Let's connect if I can be of help!

Contributing

PRs are welcome!

Releasing

To release, merge your PR to main.