Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/alvyn279/aws-cdk-billing-alarm
CDK construct that sets up email alerts for AWS monthly bill
https://github.com/alvyn279/aws-cdk-billing-alarm
aws-billing aws-cdk aws-cloudwatch aws-sns cdk-construct
Last synced: 7 days ago
JSON representation
CDK construct that sets up email alerts for AWS monthly bill
- Host: GitHub
- URL: https://github.com/alvyn279/aws-cdk-billing-alarm
- Owner: alvyn279
- License: mit
- Created: 2020-12-15T19:21:37.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2023-03-05T17:53:20.000Z (over 1 year ago)
- Last Synced: 2024-10-01T06:56:42.535Z (about 1 month ago)
- Topics: aws-billing, aws-cdk, aws-cloudwatch, aws-sns, cdk-construct
- Language: TypeScript
- Homepage:
- Size: 653 KB
- Stars: 26
- Watchers: 1
- Forks: 2
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-cdk - aws-cdk-billing-alarm - Construct that sets up email alerts for exceeding an amount on your AWS bill. (Construct Libraries / Monitoring)
- awesome-cdk - aws-cdk-billing-alarm - Construct that sets up email alerts for exceeding an amount on your AWS bill. (Construct Libraries / Monitoring)
README
# aws-cdk-billing-alarm
[](https://github.com/alvyn279/aws-cdk-billing-alarm/actions/)
[](https://www.npmjs.com/package/aws-cdk-billing-alarm)
[](https://pypi.org/project/aws-cdk-billing-alarm/)
[](https://github.com/kolomied/awesome-cdk)
A CDK construct that sets up email notification for when you exceed a given AWS estimated charges amount.
Create this construct in any stack you find appropriate **with only a few lines**. This construct is an implementation of the manual
setup described on [AWS Estimated Charges Monitoring](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/gs_monitor_estimated_charges_with_cloudwatch.html).
## Get Started
### Pre-Requisites
> **IMPORTANT!** Only complete **_Step 1: Enable Billing Alerts_** of the following documentation link. This construct will take
care of creating the rest of the resources for you.
You must first enable billing alerts from the AWS Console as per [documentation](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/gs_monitor_estimated_charges_with_cloudwatch.html#gs_turning_on_billing_metrics).
Billing alerts will allow your AWS account to start collecting billing metrics (`EstimatedCharges`) on a periodic 6-hour basis.
### Installation
#### [Node documentation](https://www.npmjs.com/package/aws-cdk-billing-alarm)
```shell
npm install --save aws-cdk-billing-alarm
```
#### [Python documentation](https://pypi.org/project/aws-cdk-billing-alarm/)
```shell
pip install aws-cdk-billing-alarm
```
### Usage
```typescript
import { Stack, StackProps } from 'aws-cdk-lib';
import { Construct } from 'constructs';
import { BillingAlarm } from 'aws-cdk-billing-alarm';
class CdkStack extends Stack {
constructor(scope: Construct, id: string, props?: StackProps) {
super(scope, id, props);
// Create an alarm that emails `[email protected]`
// if estimated charges exceed 50 USD
new BillingAlarm(this, 'AWSAccountBillingAlarm', {
monthlyThreshold: 50,
emails: ['[email protected]'],
});
}
}
```
### Post-Deployment
Confirm the subscription to the newly created topic for the emails you specified as endpoints in `BillingAlarmProps`.
You can do so by clicking on the `SubscribeURL` of the JSON email you received.
> **Note**: If you did not receive the email, you can fire a **Request confirmation** for the subscription from the AWS SNS Console.
## Limitations
- [USD currency](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/monitor_estimated_charges_with_cloudwatch.html#creating_billing_alarm_with_wizard)