From 6c76596d4bb51fbba20f15549fab2f851d450989 Mon Sep 17 00:00:00 2001 From: kristijaneftimov Date: Wed, 20 Nov 2024 12:55:17 +0100 Subject: [PATCH] Documentation improvement --- README.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 879e715..b29a8e3 100644 --- a/README.md +++ b/README.md @@ -12,10 +12,16 @@ module "cost_notifier" { cron-expression = "cron(0 7 ? * MON *)" // 9:00AM every Monday aws-region = "eu-central-1" sns-endpoint = ["email-me@gmail.com", "email-me-2@gmail.com"] - budget-threshold = 100 // By setting up this value, Budgets will be created in AWS, and alarm will be configured to monitor and notify based on predefined thresholds. The sns-endpoint will be notified(alerted) if cost reaches 80% of this value. + budget-threshold = 100 // By setting this variable to a value greater than 0, Budgets will be created in AWS, and an alarm will be set up to monitor and notify based on predefined thresholds. The SNS endpoint(s) will be alerted if costs reach 80% of the threshold value. } ``` + +## Budget notifications note +

*By configuring a 'budget-threshold', Budgets will be created in AWS, and an alarm will be set up to monitor and notify based on predefined thresholds. The SNS endpoint(s) will be alerted if costs reach 80% of the threshold value.

+
+ + ## Module Input Variables | Name | Type | Default | Description |