Skip to main content

cdk-datadog-integration

Project description

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

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.

    # Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826
    import aws_cdk.core as cdk
    from ...lib.monitoring_infrastructure_stack import MonitoringInfrastructureStack
    
    app = cdk.App()
    MonitoringInfrastructureStack(app, "MonitoringInfrastructure")
    
    # Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826
    import aws_cdk.core as cdk
    import aws_cdk.aws_secretsmanager as secrets
    from cdk_datadog_integration import DatadogIntegrationStack
    
    class MonitoringInfrastructureStack(cdk.Stack):
        def __init__(self, scope, id, *, description=None, env=None, stackName=None, tags=None, synthesizer=None, terminationProtection=None):
            super().__init__(scope, id, description=description, env=env, stackName=stackName, tags=tags, synthesizer=synthesizer, terminationProtection=terminationProtection)
    
            datadog = DatadogIntegrationStack(self, "Datadog",
                # Generate an ID here: https://app.datadoghq.com/account/settings#integrations/amazon-web-services
                external_id="",
    
                # 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
                api_key=secrets.Secret.from_secret_name_v2(self, "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 v1. It has been tested with 1.55.0 so almost certainly works will all newer versions, and probably works with some older versions too, but is untested.

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, use npm version and push the tag.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

cdk-datadog-integration-1.3.2.tar.gz (78.0 kB view hashes)

Uploaded source

Built Distribution

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page