Skip to content

Latest commit

 

History

History
75 lines (54 loc) · 2.99 KB

README.md

File metadata and controls

75 lines (54 loc) · 2.99 KB
Raw

cdk-budget-slack-notifier

Notify aws billing alert to your own specified slack channel by using AWS Chatbot.

How to use

  1. Check your slack IDs
  2. Setup AWS Chatbot
  3. Setup environment variables
  4. Build & Deploy

Check your slack IDs

Check the workspace ID and channel ID of the slack you want to notify.

Setup AWS Chatbot

  1. Create AWS Chatbot Workspace configuration on the AWS management console.
  2. Invite AWS Chatbot Agent to your slack channel by executing as below.
/invite @aws

Setup environment variables

Setup each environment variables by executing the following command.

$ ./env.sh

Environment variables can be set interactively. Refer to Environment variables for the meaning of each setting value.

Enter your slack workspace ID: xxxxx
Enter your slack channel ID: xxxxx
Enter unit (default 'USD'): USD
Enter amount value (default 10): 10
Enter threshold value (default 100): 100
Choose a threshold type [ABSOLUTE_VALUE | PERCENTAGE] (default 'PERCENTAGE'): PERCENTAGE
Choose a time unit [ANNUALLY | DAILY | MONTHLY | QUARTERLY] (default 'MONTHLY'): MONTHLY

Build & Deploy

Execute the following commands.

$ npm run build
$ cdk deploy

Environment variables

Key Meaning Supplementary info
SLACK_WORKSPACE_ID Your slack workspace ID N/A
SLACK_CHANNEL_ID Your slack channel ID N/A
UNIT The unit of measurement that is used for the budget forecast, actual spend, or budget threshold, such as USD or GB. N/A
AMOUNT The cost or usage amount that is associated with a budget forecast, actual spend, or budget threshold. N/A
THRESHOLD The threshold that is associated with a notification. Thresholds are always a percentage, and many customers find value being alerted between 50% - 200% of the budgeted amount. The maximum limit for your threshold is 1,000,000% above the budgeted amount. N/A
THRESHOLD_TYPE The type of threshold for a notification. For ABSOLUTE_VALUE thresholds, AWS notifies you when you go over or are forecasted to go over your total cost threshold. For PERCENTAGE thresholds, AWS notifies you when you go over or are forecasted to go over a certain percentage of your forecasted spend. For example, if you have a budget for 200 dollars and you have a PERCENTAGE threshold of 80%, AWS notifies you when you go over 160 dollars. Allowed values : ABSOLUTE_VALUE or PERCENTAGE
TIME_UNIT The length of time until a budget resets the actual and forecasted spend. DAILY is available only for RI_UTILIZATION and RI_COVERAGE budgets. Allowed values : ANNUALLY, DAILY, MONTHLY or QUARTERLY

Useful commands

  • npm run build compile typescript to js
  • npm run watch watch for changes and compile
  • npm run test perform the jest unit tests
  • cdk deploy deploy this stack to your default AWS account/region
  • cdk diff compare deployed stack with current state
  • cdk synth emits the synthesized CloudFormation template