Skip to content

Commit

Permalink
feat: Add Datadog::Integrations::AWS (#91)
Browse files Browse the repository at this point in the history
* Fix typos in README

* feature: Initial commit of basic Datadog integation resource (#2)

* feature: Initial commit of basic Datadog integation resource

* update README.md with Datadog AWS integration

Co-authored-by: frankwese <frank.wesemann@kreuzwerker.de>

* Tweak

* Fix

Co-authored-by: Kristine Jetzke <kristine.jetzke@kreuzwerker.de>
Co-authored-by: NomadBlacky <nomadblacky@gmail.com>
  • Loading branch information
3 people authored Oct 26, 2021
1 parent 69a6848 commit 86b4df3
Show file tree
Hide file tree
Showing 8 changed files with 12,511 additions and 4 deletions.
41 changes: 41 additions & 0 deletions API.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ Name|Description
[DatadogDashboard](#nomadblacky-cdk-datadog-resources-datadogdashboard)|Datadog Dashboard 1.0.0.
[DatadogDowntime](#nomadblacky-cdk-datadog-resources-datadogdowntime)|Datadog Monitor Downtime 2.0.0.
[DatadogIAMUser](#nomadblacky-cdk-datadog-resources-datadogiamuser)|Datadog Application User 1.2.0.
[DatadogIntegrationAWS](#nomadblacky-cdk-datadog-resources-datadogintegrationaws)|Datadog Integration 1.1.0.
[DatadogMonitor](#nomadblacky-cdk-datadog-resources-datadogmonitor)|Datadog Monitor 3.0.0.


Expand All @@ -18,6 +19,7 @@ Name|Description
[DatadogDashboardProps](#nomadblacky-cdk-datadog-resources-datadogdashboardprops)|*No description*
[DatadogDowntimeProps](#nomadblacky-cdk-datadog-resources-datadogdowntimeprops)|*No description*
[DatadogIAMUserProps](#nomadblacky-cdk-datadog-resources-datadogiamuserprops)|*No description*
[DatadogIntegrationAWSProps](#nomadblacky-cdk-datadog-resources-datadogintegrationawsprops)|*No description*
[DatadogMonitorProps](#nomadblacky-cdk-datadog-resources-datadogmonitorprops)|*No description*
[MonitorOptions](#nomadblacky-cdk-datadog-resources-monitoroptions)|*No description*
[MonitorThresholdWindows](#nomadblacky-cdk-datadog-resources-monitorthresholdwindows)|*No description*
Expand Down Expand Up @@ -120,6 +122,30 @@ new DatadogIAMUser(scope: Construct, id: string, props: DatadogIAMUserProps)



## class DatadogIntegrationAWS <a id="nomadblacky-cdk-datadog-resources-datadogintegrationaws"></a>

Datadog Integration 1.1.0.


### Initializer




```ts
new DatadogIntegrationAWS(scope: Construct, id: string, props: DatadogIntegrationAWSProps)
```

* **scope** (<code>[Construct](#aws-cdk-core-construct)</code>) *No description*
* **id** (<code>string</code>) *No description*
* **props** (<code>[DatadogIntegrationAWSProps](#nomadblacky-cdk-datadog-resources-datadogintegrationawsprops)</code>) *No description*
* **accountId** (<code>string</code>) The id of the account with which to integrate.
* **datadogCredentials** (<code>[DatadogCredentials](#nomadblacky-cdk-datadog-resources-datadogcredentials)</code>) Credentials for the Datadog API.
* **roleName** (<code>string</code>) The name of the created role.




## class DatadogMonitor <a id="nomadblacky-cdk-datadog-resources-datadogmonitor"></a>

Datadog Monitor 3.0.0.
Expand Down Expand Up @@ -225,6 +251,21 @@ Name | Type | Description



## struct DatadogIntegrationAWSProps <a id="nomadblacky-cdk-datadog-resources-datadogintegrationawsprops"></a>






Name | Type | Description
-----|------|-------------
**accountId** | <code>string</code> | The id of the account with which to integrate.
**datadogCredentials** | <code>[DatadogCredentials](#nomadblacky-cdk-datadog-resources-datadogcredentials)</code> | Credentials for the Datadog API.
**roleName** | <code>string</code> | The name of the created role.



## struct DatadogMonitorProps <a id="nomadblacky-cdk-datadog-resources-datadogmonitorprops"></a>


Expand Down
22 changes: 18 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,11 @@

[![npm version](https://badge.fury.io/js/%40nomadblacky%2Fcdk-datadog-resources.svg)](https://badge.fury.io/js/%40nomadblacky%2Fcdk-datadog-resources)

An AWS CDK construct library that wrapped [DataDog/datadog-cloudformation-resources](https://github.com/DataDog/datadog-cloudformation-resources).
An AWS CDK construct library that wraps [DataDog/datadog-cloudformation-resources](https://github.com/DataDog/datadog-cloudformation-resources).

## Requirements

Before use this library, [register datadog-cloudformation-resources to your AWS account.](https://github.com/DataDog/datadog-cloudformation-resources#datadog-aws-cloudformation)
Before using this library, [register datadog-cloudformation-resources to your AWS account.](https://github.com/DataDog/datadog-cloudformation-resources#datadog-aws-cloudformation)

You need to register the correct version listed in `Supported Resources`.

Expand All @@ -21,7 +21,7 @@ You need to register the correct version listed in `Supported Resources`.
| Supported? | Resource | Datadog CF Resource Name | Description | Datadog CF Version |
| :--------: | ----------------------- | -------------------------------- | -------------------------------------------------------- | ------------------ |
|| Dashboards | `Datadog::Dashboards::Dashboard` | [Create, update, and delete Datadog dashboards.][1] | [1.0.0][7] |
| | Datadog-AWS integration | `Datadog::Integrations::AWS` | [Manage your Datadog-Amazon Web Service integration.][2] | N/A |
| | Datadog-AWS integration | `Datadog::Integrations::AWS` | [Manage your Datadog-Amazon Web Service integration.][2] | [1.1.0][10] |
|| Monitors | `Datadog::Monitors::Monitor` | [Create, update, and delete Datadog monitors.][3] | [3.0.0][6] |
|| Downtimes | `Datadog::Monitors::Downtime` | [Enable or disable downtimes for your monitors.][4] | [2.0.0][8] |
|| Users | `Datadog::IAM::User` | [Create and manage Datadog users.][5] | [1.2.0][9] |
Expand All @@ -35,6 +35,7 @@ You need to register the correct version listed in `Supported Resources`.
[7]: https://github.com/DataDog/datadog-cloudformation-resources/blob/master/datadog-dashboards-dashboard-handler/CHANGELOG.md#100--2021-02-16
[8]: https://github.com/DataDog/datadog-cloudformation-resources/blob/master/datadog-monitors-downtime-handler/CHANGELOG.md#200--2021-02-16
[9]: https://github.com/DataDog/datadog-cloudformation-resources/blob/master/datadog-iam-user-handler/CHANGELOG.md#120--2021-02-16
[10]:https://github.com/DataDog/datadog-cloudformation-resources/blob/master/datadog-integrations-aws-handler/CHANGELOG.md#110--2020-08-04

## Installation

Expand Down Expand Up @@ -62,7 +63,7 @@ Java

## Usage

Belows are examples of TypeScript.
Below are examples of TypeScript.

### Dashboards

Expand Down Expand Up @@ -136,3 +137,16 @@ new DatadogIAMUser(stack, 'TestUser', {
disabled: false,
});
```

### DataDog Integration

```typescript
new DatadogIntegration(this, 'DataDogIntegration', {
datadogCredentials: {
apiKey: "DATADOG_API_KEY",
applicationKey: "DATADOG_APP_KEY",
},
accountId: "ACCOUNT_ID",
roleName: "DatadogIntegrationRole",
});
```
Loading

0 comments on commit 86b4df3

Please sign in to comment.