Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/blimmer/cdk-datadog-integration
Amazon Cloud Development Kit (CDK) logic to integrate your AWS account with Datadog
https://github.com/blimmer/cdk-datadog-integration
aws aws-cdk aws-cdk-construct aws-cloudformation aws-integration cloudformation datadog datadog-integration hacktoberfest
Last synced: 4 months ago
JSON representation
Amazon Cloud Development Kit (CDK) logic to integrate your AWS account with Datadog
- Host: GitHub
- URL: https://github.com/blimmer/cdk-datadog-integration
- Owner: blimmer
- License: apache-2.0
- Created: 2020-04-18T14:44:38.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2024-04-05T00:17:57.000Z (11 months ago)
- Last Synced: 2024-08-09T09:37:19.336Z (7 months ago)
- Topics: aws, aws-cdk, aws-cdk-construct, aws-cloudformation, aws-integration, cloudformation, datadog, datadog-integration, hacktoberfest
- Language: TypeScript
- Homepage:
- Size: 557 KB
- Stars: 19
- Watchers: 3
- Forks: 7
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# 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](https://github.com/DataDog/cloudformation-template/blob/master/aws/main.yaml)
using [Amazon Cloud Development Kit (CDK)](https://aws.amazon.com/cdk/).
## Warning
:warning: This construct does not use the newest Datadog CloudFormation template because sensitive
parameters must be hard-coded. See https://github.com/DataDog/cloudformation-template/issues/68 for an upstream
feature request. :warning:
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 https://github.com/DataDog/cloudformation-template/issues/68 to help
prioritize it.
## Basic Usage
1. Install the package
```console
npm i --save cdk-datadog-integration
```
Or via [pypi](https://pypi.org/project/cdk-datadog-integration/),
[NuGet](https://www.nuget.org/packages/BenLimmer.CdkDatadogIntegration/), or
[GitHub Packages](https://github.com/blimmer/cdk-datadog-integration/packages).
1. Import the stack and pass the required parameters.
```ts
import * as cdk from "aws-cdk-lib";
import { MonitoringInfrastructureStack } from "../lib/monitoring-infrastructure-stack";
const app = new cdk.App();
new MonitoringInfrastructureStack(app, "MonitoringInfrastructure");
```
```ts
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",
""
),
});
}
}
```
## Configuration
Use `DatadogIntegrationConfig` to set additional configuration parameters. Check
out
[docs](/API.md#cdk-datadog-integration.DatadogIntegrationConfig)
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](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_cloudformation.CfnStack.html)
to import the three CloudFormation stacks referenced by the
[main Datadog CloudFormation template](https://github.com/DataDog/cloudformation-template/tree/master/aws).
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](https://www.linkedin.com/in/blimmer/), a
[freelance architect and consultant](https://benlimmer.com/freelance/). I love
helping businesses of all sizes solve their hardest technology problems. Let's
[connect](https://benlimmer.com/freelance/contact/) if I can be of help!
## Contributing
PRs are welcome!
### Releasing
To release, merge your PR to `main`.