aws-cdk-billing-alarm
v1.1.0
Published
[![Build status](https://github.com/alvyn279/aws-cdk-billing-alarm/workflows/build/badge.svg)](https://github.com/alvyn279/aws-cdk-billing-alarm/actions/) [![NPM version](https://badge.fury.io/js/aws-cdk-billing-alarm.svg)](https://www.npmjs.com/package/a
Downloads
31
Maintainers
Readme
aws-cdk-billing-alarm
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.
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.
Billing alerts will allow your AWS account to start collecting billing metrics (EstimatedCharges
) on a periodic 6-hour basis.
Installation
Node documentation
npm install --save aws-cdk-billing-alarm
Python documentation
pip install aws-cdk-billing-alarm
Usage
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.