# @beigetech/cdk-alarms

> [![npm version](https://badge.fury.io/js/%40beigetech%2Fcdk-alarms.svg)](https://badge.fury.io/js/%40beigetech%2Fcdk-alarms) [![Coverage Status](https://coveralls.io/repos/github/beigetech/cdk-alarms/badge.svg?branch=guy/deploy)](https://coveralls.io/gith

Latest version **0.1.4** (published 2020-10-13) · Apache-2.0 license · 0 weekly downloads

## Install

```sh
npm install @beigetech/cdk-alarms
pnpm add @beigetech/cdk-alarms
yarn add @beigetech/cdk-alarms
bun add @beigetech/cdk-alarms
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.4 |
| Published | 2020-10-13 |
| First published | 2020-09-25 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 9 |
| Unpacked size | 175.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 2 |
| Maintainers | greximus |

## Links

- npm: https://www.npmjs.com/package/@beigetech/cdk-alarms
- Repository: https://github.com/beigetech/cdk-alarms
- Homepage: https://github.com/beigetech/cdk-alarms#readme
- Issues: https://github.com/beigetech/cdk-alarms/issues
- npm.io page: https://npm.io/package/@beigetech/cdk-alarms

## Dependencies (9)

- [@aws-cdk/core](https://npm.io/package/@aws-cdk/core.md) 1.64.0
- [@aws-cdk/aws-rds](https://npm.io/package/@aws-cdk/aws-rds.md) 1.64.0
- [@aws-cdk/aws-sns](https://npm.io/package/@aws-cdk/aws-sns.md) 1.64.0
- [source-map-support](https://npm.io/package/source-map-support.md) ^0.5.16
- [@aws-cdk/aws-lambda](https://npm.io/package/@aws-cdk/aws-lambda.md) 1.64.0
- [@aws-cdk/aws-cloudwatch](https://npm.io/package/@aws-cdk/aws-cloudwatch.md) 1.64.0
- [@aws-cdk/aws-events-targets](https://npm.io/package/@aws-cdk/aws-events-targets.md) 1.64.0
- [@aws-cdk/aws-cloudwatch-actions](https://npm.io/package/@aws-cdk/aws-cloudwatch-actions.md) 1.64.0
- [@aws-cdk/aws-lambda-event-sources](https://npm.io/package/@aws-cdk/aws-lambda-event-sources.md) 1.64.0

## Recent versions

- 0.1.4 (latest) — 2020-10-13
- 0.1.3 — 2020-09-29
- 0.1.2 — 2020-09-25

## README

## @beigetech/cdk-alarms: Alarms for AWS Resources

[![npm version](https://badge.fury.io/js/%40beigetech%2Fcdk-alarms.svg)](https://badge.fury.io/js/%40beigetech%2Fcdk-alarms)
[![Coverage Status](https://coveralls.io/repos/github/beigetech/cdk-alarms/badge.svg?branch=guy/deploy)](https://coveralls.io/github/beigetech/cdk-alarms?branch=guy/deploy)

Create CloudWatch alarms and event notifications for AWS resources, supported constructs:

 - [DatabaseInstance](#database-instance)
 - [DatabaseCluster](#database-cluster)

#### Database Instance

Either create alarms for the instance all at once, individually or use the builder for full control.

```ts
let stack = new Stack();
let inst = new DatabaseInstance(stack, "test-cluster", {});
```

*Generate alarms for instance:*

```ts
Import {DatabaseAlarms} from '@beigetech/cdk-alarms';
DatabaseAlarm.createInstanceAlarms(stack, cluster);
```

*Generate individual alarms:*

```ts 
DatabaserAlarm.createCpuAlarm(stack, cluster);
```

*Or use a builder for custom alarms*

```ts
DatabaseAlarm.createAlarm(stack, cluster)
   .setMetric(CLUSTER_METRIC.CPU_UTILISATION)
   .setThreshold(90)
   .setOp(ComparisoOperator.GREATER_THAN_THRESHOLD)
   .build()
```

#### Database Cluster 
You can either create alarms for an instance of a cluster all at once, optionally overriding the threshold values or using the defaults.

```ts
let stack = new Stack();
let cluster = new DatabaseCluster(stack, "test-cluster", {
    engine: DatabaseClusterEngine.AURORA_MYSQL,
    masterUser: {
      username: "admin",
    },
    instanceProps: {
      vpc: new Vpc(stack, "test-vpc"),
      instanceType: InstanceType.of(InstanceClass.T3, InstanceSize.MICRO),
    },
});
```

*Generate alarms for instance:*

```ts
Import {DatabaseAlarms} from '@beigetech/cdk-alarms';
DatabaseClusterAlarm.createClusterAlarms(stack, cluster);
```

*Generate individual alarms:*

```ts 
DatabaseClusterAlarm.createCpuAlarm(stack, cluster);
```

*Or use a builder for custom alarms*

```ts
DatabaseClusterAlarm.createAlarm(stack, cluster)
   .setMetric(CLUSTER_METRIC.CPU_UTILISATION)
   .setThreshold(90)
   .setOp(ComparisoOperator.GREATER_THAN_THRESHOLD)
   .build()
```

---
_Source: https://npm.io/package/@beigetech/cdk-alarms · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
